Skip to main content
Code Review

Return to Question

added 4487 characters in body; edited tags
Source Link
Logan
Logan
  • 303
  • 1
  • 2
  • 9

###Usage

Step 1: Create suiteManager and assign URL / CurrentUser

FireSuite * fireSuite = [FireSuite suiteManager];
fireSuite.firebaseURL = @"https://someFirebase.firebaseIO.com/";
fireSuite.currentUserId = @"currentUserId";

Step 2: Monitor Our Connection / Other User's Connection

FSPresenceManager * presenceManager = fireSuite.presenceManager;

// Start Monitor
[presenceManager startPresenceManager];

// Monitor Current User's Connection
[presenceManager registerConnectionStatusObserver:self withSelector:@selector(isConnected:)];

// Monitor Other Users (for instance, a chat opponent)
[presenceManager registerUserStatusObserver:self
                               withSelector:@selector(userStatusDidUpdateWithId:andStatus:)
                                  forUserId:@"userId1"];
[presenceManager registerUserStatusObserver:self
                               withSelector:@selector(userStatusDidUpdateWithId:andStatus:)
                                  forUserId:@"userId2"];

// Receive Presence Manager Notifications
- (void) isConnected:(BOOL)isConnected {
    NSLog(@"Current User %@ firebase", isConnected ? @"Connected To": @"Disconnected From");
}

// Use this to monitor chat partners or whoever to see if they're online

- (void) userStatusDidUpdateWithId:(NSString *)userId andStatus:(BOOL)isOnline {
    NSLog(@"%@ is currently: %@", userId, isOnline ? @"Online": @"Offline");
}

Step 3: Channel Manager

// Get Channel Manager
FSChannelManager * channelManager = fireSuite.channelManager;

// Observe Current User's Alert's Channel
[channelManager registerUserAlertsObserver:self withSelector:@selector(receivedAlert:)];

// To Send An Alert
NSMutableDictionary * alertData = [NSMutableDictionary new];
alertData[@"some"] = @"random";
alertData[@"data"] = @"here";

// Received Via
- (void) receivedAlert:(NSDictionary *)alert {
    NSString * alertType = alert[kAlertType];
    id alertData = alert[kAlertData];
    double timestamp = [alert[kAlertTimestamp] doubleValue] / 1000;
    NSDate * sentAt = [NSDate dateWithTimeIntervalSince1970:timestamp];

    NSLog(@"Received alert sentAt: %@ alertType: %@ withData: %@", sentAt, alertType, alertData);
}

// alertData can be any %@ object
[channelManager sendAlertToUserId:@"currentUserId" withAlertType:@"someAlertType" andData:alertData withCompletion:^(NSError * error) {
    if (!error) {
        NSLog(@"Alert Sent");
    }
    else {
        NSLog(@"ERROR: %@", error);
    }
}];

Step 4: Use Chat Manager

FSChatManager * chatManager = fireSuite.chatManager;

// Create A New Chat

// Set CustomId to nil for AutoId
[chatManager createNewChatForUsers:@[@"user1id", @"user2id"] withCustomId:nil andCompletionBlock:^(NSString *newChatId, NSError *error) {
    NSLog(@"Created New Chat With Id: %@", newChatId);
    [self launchNewChatSessionForChatId:newChatId];
}];

// Launch New Session
- (void) launchNewChatSessionForChatId:(NSString *)chatId {
    FireSuite * fireSuite = [FireSuite suiteManager];
    FSChatManager * chatManager = fireSuite.chatManager;
    chatManager.chatId = chatId; // chat id of new session
    chatManager.delegate = self; // who to send the messages
    chatManager.maxCount = [NSNumber numberWithInt:50]; // number of initial recent messages to receive
    [chatManager loadChatSessionWithCompletionBlock:^(NSArray *messages, NSError *error) {
        if (!error) {

            // Will receive the 50 most recent messages from firebase (maxCount)
            NSLog(@"Open with recent messages: %@", messages);
            // receivedNewMessage: will begin running now.
        }
        else {
            NSLog(@"Error: %@", error);
        }
    }];
}

// Chat Session Delegate Call
- (void) newMessageReceived:(NSMutableDictionary *)newMessage {
    NSLog(@"Received new message: %@", newMessage);
}

// To Send Message:
[chatManager sendNewMessage:@"Some message to send to the chat!"];

// To End Chat Session
- (void) endChat {
    [[FireSuite suiteManager].chatManager endChatSessionWithCompletionBlock:^{
        NSLog(@"Closed Current Chat Session");
    }];
}

Full Code Here: GitHub

Full Code Here: GitHub

###Usage

Step 1: Create suiteManager and assign URL / CurrentUser

FireSuite * fireSuite = [FireSuite suiteManager];
fireSuite.firebaseURL = @"https://someFirebase.firebaseIO.com/";
fireSuite.currentUserId = @"currentUserId";

Step 2: Monitor Our Connection / Other User's Connection

FSPresenceManager * presenceManager = fireSuite.presenceManager;

// Start Monitor
[presenceManager startPresenceManager];

// Monitor Current User's Connection
[presenceManager registerConnectionStatusObserver:self withSelector:@selector(isConnected:)];

// Monitor Other Users (for instance, a chat opponent)
[presenceManager registerUserStatusObserver:self
                               withSelector:@selector(userStatusDidUpdateWithId:andStatus:)
                                  forUserId:@"userId1"];
[presenceManager registerUserStatusObserver:self
                               withSelector:@selector(userStatusDidUpdateWithId:andStatus:)
                                  forUserId:@"userId2"];

// Receive Presence Manager Notifications
- (void) isConnected:(BOOL)isConnected {
    NSLog(@"Current User %@ firebase", isConnected ? @"Connected To": @"Disconnected From");
}

// Use this to monitor chat partners or whoever to see if they're online

- (void) userStatusDidUpdateWithId:(NSString *)userId andStatus:(BOOL)isOnline {
    NSLog(@"%@ is currently: %@", userId, isOnline ? @"Online": @"Offline");
}

Step 3: Channel Manager

// Get Channel Manager
FSChannelManager * channelManager = fireSuite.channelManager;

// Observe Current User's Alert's Channel
[channelManager registerUserAlertsObserver:self withSelector:@selector(receivedAlert:)];

// To Send An Alert
NSMutableDictionary * alertData = [NSMutableDictionary new];
alertData[@"some"] = @"random";
alertData[@"data"] = @"here";

// Received Via
- (void) receivedAlert:(NSDictionary *)alert {
    NSString * alertType = alert[kAlertType];
    id alertData = alert[kAlertData];
    double timestamp = [alert[kAlertTimestamp] doubleValue] / 1000;
    NSDate * sentAt = [NSDate dateWithTimeIntervalSince1970:timestamp];

    NSLog(@"Received alert sentAt: %@ alertType: %@ withData: %@", sentAt, alertType, alertData);
}

// alertData can be any %@ object
[channelManager sendAlertToUserId:@"currentUserId" withAlertType:@"someAlertType" andData:alertData withCompletion:^(NSError * error) {
    if (!error) {
        NSLog(@"Alert Sent");
    }
    else {
        NSLog(@"ERROR: %@", error);
    }
}];

Step 4: Use Chat Manager

FSChatManager * chatManager = fireSuite.chatManager;

// Create A New Chat

// Set CustomId to nil for AutoId
[chatManager createNewChatForUsers:@[@"user1id", @"user2id"] withCustomId:nil andCompletionBlock:^(NSString *newChatId, NSError *error) {
    NSLog(@"Created New Chat With Id: %@", newChatId);
    [self launchNewChatSessionForChatId:newChatId];
}];

// Launch New Session
- (void) launchNewChatSessionForChatId:(NSString *)chatId {
    FireSuite * fireSuite = [FireSuite suiteManager];
    FSChatManager * chatManager = fireSuite.chatManager;
    chatManager.chatId = chatId; // chat id of new session
    chatManager.delegate = self; // who to send the messages
    chatManager.maxCount = [NSNumber numberWithInt:50]; // number of initial recent messages to receive
    [chatManager loadChatSessionWithCompletionBlock:^(NSArray *messages, NSError *error) {
        if (!error) {

            // Will receive the 50 most recent messages from firebase (maxCount)
            NSLog(@"Open with recent messages: %@", messages);
            // receivedNewMessage: will begin running now.
        }
        else {
            NSLog(@"Error: %@", error);
        }
    }];
}

// Chat Session Delegate Call
- (void) newMessageReceived:(NSMutableDictionary *)newMessage {
    NSLog(@"Received new message: %@", newMessage);
}

// To Send Message:
[chatManager sendNewMessage:@"Some message to send to the chat!"];

// To End Chat Session
- (void) endChat {
    [[FireSuite suiteManager].chatManager endChatSessionWithCompletionBlock:^{
        NSLog(@"Closed Current Chat Session");
    }];
}

Full Code Here: GitHub

edited tags
Link
200_success
200_success
  • 145.6k
  • 22
  • 191
  • 481
Source Link
Logan
Logan
  • 303
  • 1
  • 2
  • 9

Singleton With Sub-Singletons

I've found myself wanting an easy way to implement chat into various apps, so I developed a set of classes for the firebase.com backend that make it easy for me to quickly set up the nuts and bolts of a chat system. To implement this, I have three classes:

###FSPresenceManager

Current Connection / Other User's Connection

###FSChannelManager

Send / Receive Alerts From users

###FSChatManager

Create Chat / Send & Receive Messages / Light "Queries" (hoping to improve)

These classes act as sort of a notification center where you can register observers for callbacks and the class distributes the information when it comes in from firebase. For this reason, I used singletons in all cases. I decided to wrap all of these classes into a greater class, which is also a Singleton that I called FireSuite.

This allows me to set things like URL, and CurrentUserId for all managers at once in a few lines.

###FireSuite.h

#import "FSChatManager.h"
#import "FSPresenceManager.h"
#import "FSChannelManager.h"

@interface FireSuite : NSObject

+ (FireSuite *) suiteManager; // Singleton

@property (strong, nonatomic) NSString * firebaseURL;
@property (strong, nonatomic) NSString * currentUserId;

@property (strong, nonatomic) FSChatManager * chatManager;
@property (strong, nonatomic) FSPresenceManager * presenceManager;
@property (strong, nonatomic) FSChannelManager * channelManager;

@end

###FireSuite.m

#import "FireSuite.h"

@implementation FireSuite

@synthesize firebaseURL, currentUserId, presenceManager, chatManager, channelManager;

+ (FireSuite *) suiteManager {
    static dispatch_once_t pred;
    static FireSuite *shared = nil;

    dispatch_once(&pred, ^{
        shared = [[FireSuite alloc] init];
    });
    return shared;
}

#pragma mark SETTERS

- (void) setFirebaseURL:(NSString *)firebaseURLsetter {

    if (![firebaseURLsetter hasSuffix:@"/"]) {
        firebaseURLsetter = [NSString stringWithFormat:@"%@/", firebaseURLsetter];
    }

    // Set Our Tools
    [FSChatManager singleton].urlRefString = firebaseURLsetter;
    [FSPresenceManager singleton].urlRefString = firebaseURLsetter;
    [FSChannelManager singleton].urlRefString = firebaseURLsetter;

    firebaseURL = firebaseURLsetter;
}

- (void) setCurrentUserId:(NSString *)currentUserIdToSet {

    // Set Our Tools
    [FSChatManager singleton].currentUserId = currentUserIdToSet;
    [FSPresenceManager singleton].currentUserId = currentUserIdToSet;
    [FSChannelManager singleton].currentUserId = currentUserIdToSet;

    currentUserId = currentUserIdToSet;
}

#pragma mark GETTERS

- (FSPresenceManager *) presenceManager {
    FSPresenceManager * manager = [FSPresenceManager singleton];
    return manager;
}

- (FSChatManager *) chatManager {
    FSChatManager * manager = [FSChatManager singleton];
    return manager;
}

- (FSChannelManager *) channelManager {
    FSChannelManager * manager = [FSChannelManager singleton];
    return manager;
}

@end

Everything is still fairly "Stream Of Thought Programming" so there's a bit of inconsistency and things I'd prefer to implement differently, but before I proceed I wanted to get a second opinion on this.

The main reason is that it allows me to easily update firebaseURL / currentUserId one time without having to worry about it being up to date everywhere.

Aside from general preferences, is this going to create unforeseen problems?

Second opinions and alternative strategies are also welcome! Also, if there's problems with something about my post, please elaborate when downvoting. This is my first codeReview post and I might just not understand something!

Full Code Here: GitHub