invoke failure handler on invalid cases, don't enforce token size (#21)

* invoke failure handler in regsterToken when provided PushServicePlatform is invalid
* don't enforce token to be 32 bytes

Author: dontgitit

CHANGELOG.md

@@ -10,10 +10,10 @@ This project adheres to [Semantic Versioning](http://semver.org/).
 - nothing yet
 
 #### Changed
-- nothing yet
+- `registerToken` no longer checks the token to be 32 bytes/64 hex chars
 
 #### Fixed
-- nothing yet
+- `registerToken` now calls the failure handler if an invalid `PushServicePlatform` is passed in
 
 
 ## [2.1.0](https://github.com/Iterable/iterable-ios-sdk/releases/tag/2.1.0)

Iterable-iOS-SDK/IterableAPI.m

@@ -312,38 +312,37 @@ - (void)registerToken:(NSData *)token appName:(NSString *)appName pushServicePla
 {
     NSString *hexToken = [token hexadecimalString];
 
-    if ([hexToken length] != 64) {
-        LogError(@"registerToken: invalid token");
-    } else {
-        UIDevice *device = [UIDevice currentDevice];
-        NSString *psp = [IterableAPI pushServicePlatformToString:pushServicePlatform];
-
-        if (!psp) {
-            LogError(@"registerToken: invalid pushServicePlatform");
-            return;
+    UIDevice *device = [UIDevice currentDevice];
+    NSString *psp = [IterableAPI pushServicePlatformToString:pushServicePlatform];
+    
+    if (!psp) {
+        LogError(@"registerToken: invalid pushServicePlatform");
+        if (onFailure) {
+            onFailure(@"Not registering device token - the specified PushServicePlatform is invalid", [[NSData alloc] init]);
         }
-
-        NSDictionary *args = @{
-                               @"email": self.email,
-                               @"device": @{
-                                       @"token": hexToken,
-                                       @"platform": psp,
-                                       @"applicationName": appName,
-                                       @"dataFields": @{
-                                               @"name": [device name],
-                                               @"localizedModel": [device localizedModel],
-                                               @"userInterfaceIdiom": [IterableAPI userInterfaceIdiomEnumToString:[device userInterfaceIdiom]],
-                                               @"identifierForVendor": [[device identifierForVendor] UUIDString],
-                                               @"systemName": [device systemName],
-                                               @"systemVersion": [device systemVersion],
-                                               @"model": [device model]
-                                               }
-                                       }
-                               };
-        LogDebug(@"sending registerToken request with args %@", args);
-        NSURLRequest *request = [self createRequestForAction:@"users/registerDeviceToken" withArgs:args];
-        [self sendRequest:request onSuccess:onSuccess onFailure:onFailure];
+        return;
     }
+    
+    NSDictionary *args = @{
+                           @"email": self.email,
+                           @"device": @{
+                                   @"token": hexToken,
+                                   @"platform": psp,
+                                   @"applicationName": appName,
+                                   @"dataFields": @{
+                                           @"name": [device name],
+                                           @"localizedModel": [device localizedModel],
+                                           @"userInterfaceIdiom": [IterableAPI userInterfaceIdiomEnumToString:[device userInterfaceIdiom]],
+                                           @"identifierForVendor": [[device identifierForVendor] UUIDString],
+                                           @"systemName": [device systemName],
+                                           @"systemVersion": [device systemVersion],
+                                           @"model": [device model]
+                                           }
+                                   }
+                           };
+    LogDebug(@"sending registerToken request with args %@", args);
+    NSURLRequest *request = [self createRequestForAction:@"users/registerDeviceToken" withArgs:args];
+    [self sendRequest:request onSuccess:onSuccess onFailure:onFailure];
 }
 
 // documented in IterableAPI.h
@@ -473,6 +472,7 @@ - (void)trackPurchase:(NSNumber *)total items:(NSArray<CommerceItem> *)items dat
                  };
     }
     NSURLRequest *request = [self createRequestForAction:@"commerce/trackPurchase" withArgs:args];
-    [self sendRequest:request onSuccess:onSuccess onFailure:onFailure];}
+    [self sendRequest:request onSuccess:onSuccess onFailure:onFailure];
+}
 
 @end

README.md

@@ -53,7 +53,7 @@ $ pod install
 
 Congratulations! You have now imported the Iterable SDK into your project! 
 
-> If your project is built with `Swift`, you will need a `bridging header`. See [here](https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html) for more information on how to create one.
+> ℹ If your project is built with `Swift`, you will need a `bridging header`. See [here](https://developer.apple.com/library/ios/documentation/Swift/Conceptual/BuildingCocoaApps/MixandMatch.html) for more information on how to create one.
 
 # Using the SDK
 
@@ -72,6 +72,11 @@ Congratulations! You have now imported the Iterable SDK into your project!
 3. **Send the token to Iterable**  
    Use the SDK's `- (void)registerToken:(NSData *)token appName:(NSString *)appName pushServicePlatform:(PushServicePlatform)pushServicePlatform` to send the token to Iterable   
    ***Device tokens can change, so your app needs to reregister every time it is launched and pass the received token back to your server***. Don't cache your token on the device; send it every time you receive one. 
+   This is the practice recommended by Apple; see the documentation [here](https://developer.apple.com/library/ios/documentation/NetworkingInternet/Conceptual/RemoteNotificationsPG/Chapters/IPhoneOSClientImp.html#//apple_ref/doc/uid/TP40008194-CH103-SW25). Specifically,
+   
+   > ⚠ Device tokens can change, so your app needs to reregister every time it is launched and pass the received token back to your server. If you fail to update the device token, remote notifications might not make their way to the user’s device. Device tokens always change when the user restores backup data to a new device or computer or reinstalls the operating system. When migrating data to a new device or computer, the user must launch your app once before remote notifications can be delivered to that device.
+   
+   > ⚠ Never cache a device token; always get the token from the system whenever you need it. If your app previously registered for remote notifications, calling the registerForRemoteNotifications method again does not incur any additional overhead, and iOS returns the existing device token to your app delegate immediately. In addition, iOS calls your delegate method any time the device token changes, not just in response to your app registering or re-registering.
 
 #### Putting it all together: