WLAnalyticsManager.m 6.51 KB
/*
 Copyright 2010-2016 Warply Inc. All rights reserved.
 
 Redistribution and use in source and binary forms, without modification, 
 are permitted provided that the following conditions are met:
 
 1. Redistributions of source code must retain the above copyright notice, this
 list of conditions and the following disclaimer.
 
 2. Redistributions in binaryform must reproduce the above copyright notice,
 this list of conditions and the following disclaimer in the documentation
 and/or other materials provided with the distribution.
 
 THIS SOFTWARE IS PROVIDED BY THE WARPLY LTD ``AS IS'' AND ANY EXPRESS OR
 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO
 EVENT SHALL WARPLY LTD OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT,
 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
 BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE
 OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

#import "WLAnalyticsManager.h"
#import "Warply.h"

@implementation WLAnalyticsManager

#pragma mark - Static Public Methods
///////////////////////////////////////////////////////////////////////////////
+ (void)logEventWithEventId:(NSString *)eventId
                     pageId:(NSString *)pageId
             actionMetadata:(NSDictionary *)actionMetadata
{
    if (WL_FEATURE_IS_DISABLED_WITH_KEY(WL_CUSTOM_ANALYTICS_ENABLED))
        return;
    
    [self internalLogEventWithEventId:eventId
                               pageId:pageId
                       actionMetadata:actionMetadata];
}

///////////////////////////////////////////////////////////////////////////////
+ (void)logUrgentEventWithEventId:(NSString *)eventId
                                       pageId:(NSString *)pageId
                               actionMetadata:(NSDictionary *)actionMetadata
{
    if (WL_FEATURE_IS_DISABLED_WITH_KEY(WL_CUSTOM_ANALYTICS_ENABLED))
        return;
    
    [self internalLogUrgentEventWithEventId:eventId
                                     pageId:pageId
                             actionMetadata:actionMetadata];
}

///////////////////////////////////////////////////////////////////////////////
+ (void)logAppDidFinishLauchingEvent
{
    if (WL_FEATURE_IS_DISABLED_WITH_KEY(WL_LIFECYCLE_ANALYTICS_ENABLED))
        return;
    
    [WLAnalyticsManager internalLogEventWithEventId:@"NB_DidFinishLaunching"
                                             pageId:@"NB_APP"
                                     actionMetadata:nil];
}

///////////////////////////////////////////////////////////////////////////////
+ (void)logAppWillEnterForegroundEvent
{
    if (WL_FEATURE_IS_DISABLED_WITH_KEY(WL_LIFECYCLE_ANALYTICS_ENABLED))
        return;
    if([[NSUserDefaults standardUserDefaults] boolForKey:WL_LIFECYCLE_ANALYTICS_ENABLED]) {
        [WLAnalyticsManager internalLogEventWithEventId:@"session"
                                             pageId:@"NB_APP"
                                     actionMetadata:nil];
    }
}

///////////////////////////////////////////////////////////////////////////////
+ (void)logAppWillTerminateEvent
{
    if (WL_FEATURE_IS_DISABLED_WITH_KEY(WL_LIFECYCLE_ANALYTICS_ENABLED))
        return;
    
    [WLAnalyticsManager internalLogEventWithEventId:@"NB_WillTerminate"
                                             pageId:@"NB_APP"
                                     actionMetadata:nil];
}

///////////////////////////////////////////////////////////////////////////////
+ (void)logAppDidEnterBackgroundEvent
{
    if (WL_FEATURE_IS_DISABLED_WITH_KEY(WL_LIFECYCLE_ANALYTICS_ENABLED))
        return;
    
    [WLAnalyticsManager internalLogEventWithEventId:@"session"
                                         pageId:@"NB_APP"
                                 actionMetadata:nil];
}

#pragma mark - Static Private Methods
///////////////////////////////////////////////////////////////////////////////
+ (void)internalLogEventWithEventId:(NSString *)eventId
                     pageId:(NSString *)pageId
             actionMetadata:(NSDictionary *)actionMetadata
{    
    NSNumber *time_submitted = [NSNumber numberWithDouble:[[NSDate date] timeIntervalSince1970]];
    NSDictionary *inapp_event = [NSDictionary dictionaryWithObjectsAndKeys:eventId, @"event_id", pageId, @"page_id", time_submitted, @"time_submitted", actionMetadata, @"action_metadata", nil];
    NSDictionary *eventContext = [NSDictionary dictionaryWithObject:inapp_event forKey:@"inapp_analytics"];
    WLEventSimple *event = [[WLEventSimple alloc] initWithType:@"inapp_analytics" andContext:eventContext];
    [[Warply sharedService] addEvent:event priority:NO];
}

///////////////////////////////////////////////////////////////////////////////
+ (void)internalLogUrgentEventWithEventId:(NSString *)eventId
                           pageId:(NSString *)pageId
                   actionMetadata:(NSDictionary *)actionMetadata
{    
    NSNumber *time_submitted = [NSNumber numberWithDouble:[[NSDate date] timeIntervalSince1970]];
    NSDictionary *inapp_event = [NSDictionary dictionaryWithObjectsAndKeys:eventId, @"event_id", pageId, @"page_id", time_submitted, @"time_submitted", actionMetadata, @"action_metadata", nil];
    NSDictionary *eventContext = [NSDictionary dictionaryWithObject:inapp_event forKey:@"inapp_analytics"];
    WLEventSimple *event = [[WLEventSimple alloc] initWithType:@"inapp_analytics" andContext:eventContext];
    [[Warply sharedService] addEvent:event priority:YES];
}

#pragma mark - Push Analytics
///////////////////////////////////////////////////////////////////////////////
+ (void)logUserEngagedPush:(WLBaseItem *)item
{
    [WLAnalyticsManager internalLogUrgentEventWithEventId:@"NB_PushAck"
                                           pageId:@"NB_APP"
                                   actionMetadata:[NSDictionary dictionaryWithObjectsAndKeys:item.session_uuid, @"session_uuid",  nil]];
}

///////////////////////////////////////////////////////////////////////////////
+ (void)logUserReceivedPush:(WLBaseItem *)item
{
    [WLAnalyticsManager internalLogUrgentEventWithEventId:@"NB_PushReceived"
                                                   pageId:@"NB_APP"
                                           actionMetadata:[NSDictionary dictionaryWithObjectsAndKeys:item.session_uuid, @"session_uuid",  nil]];
}

@end