Merge pull request #610 from ParsePlatform/nlutsenko.pushDate

nlutsenko · nlutsenko · commit 692415d3f05b · 2015-11-30T13:32:38.000-08:00
Add ability to specify scheduled delivery time when sending push notifications.
diff --git a/Parse/Internal/Commands/PFRESTPushCommand.m b/Parse/Internal/Commands/PFRESTPushCommand.m
@@ -43,6 +43,10 @@ + (instancetype)sendPushCommandWithPushState:(PFPushState *)state
         parameters[@"expiration_interval"] = state.expirationTimeInterval;
     }
 
+    if (state.pushDate) {
+        parameters[@"push_time"] = [[PFDateFormatter sharedFormatter] preciseStringFromDate:state.pushDate];
+    }
+
     // TODO (nlutsenko): Probably we need an assert here, as there is no reason to send push without message
     if (state.payload) {
         parameters[@"data"] = state.payload;
diff --git a/Parse/Internal/Push/State/PFMutablePushState.h b/Parse/Internal/Push/State/PFMutablePushState.h
@@ -20,7 +20,8 @@ PF_TV_UNAVAILABLE PF_WATCH_UNAVAILABLE @interface PFMutablePushState : PFPushSta
 @property (nullable, nonatomic, copy, readwrite) PFQueryState *queryState;
 
 @property (nullable, nonatomic, strong, readwrite) NSDate *expirationDate;
-@property (nullable, nonatomic, copy, readwrite) NSNumber *expirationTimeInterval;
+@property (nullable, nonatomic, strong, readwrite) NSNumber *expirationTimeInterval;
+@property (nullable, nonatomic, strong, readwrite) NSDate *pushDate;
 
 @property (nullable, nonatomic, copy, readwrite) NSDictionary *payload;
 
diff --git a/Parse/Internal/Push/State/PFMutablePushState.m b/Parse/Internal/Push/State/PFMutablePushState.m
@@ -17,6 +17,7 @@ @implementation PFMutablePushState
 @dynamic queryState;
 @dynamic expirationDate;
 @dynamic expirationTimeInterval;
+@dynamic pushDate;
 @dynamic payload;
 
 ///--------------------------------------
diff --git a/Parse/Internal/Push/State/PFPushState.h b/Parse/Internal/Push/State/PFPushState.h
@@ -26,7 +26,8 @@ PF_TV_UNAVAILABLE PF_WATCH_UNAVAILABLE @interface PFPushState : PFBaseState <NSC
 @property (nullable, nonatomic, copy, readonly) PFQueryState *queryState;
 
 @property (nullable, nonatomic, strong, readonly) NSDate *expirationDate;
-@property (nullable, nonatomic, copy, readonly) NSNumber *expirationTimeInterval;
+@property (nullable, nonatomic, strong, readonly) NSNumber *expirationTimeInterval;
+@property (nullable, nonatomic, strong, readonly) NSDate *pushDate;
 
 @property (nullable, nonatomic, copy, readonly) NSDictionary *payload;
 
diff --git a/Parse/Internal/Push/State/PFPushState.m b/Parse/Internal/Push/State/PFPushState.m
@@ -12,6 +12,7 @@
 
 #import "PFMutablePushState.h"
 #import "PFQueryState.h"
+#import "PFAssert.h"
 
 @implementation PFPushState
 
@@ -20,13 +21,12 @@ @implementation PFPushState
 ///--------------------------------------
 
 + (NSDictionary *)propertyAttributes {
-    return @{
-        @"channels": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeCopy],
-        @"queryState": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeCopy],
-        @"expirationDate": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeStrong],
-        @"expirationTimeInterval": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeStrong],
-        @"payload": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeCopy]
-    };
+    return @{ @"channels": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeCopy],
+              @"queryState": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeCopy],
+              @"expirationDate": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeStrong],
+              @"expirationTimeInterval": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeStrong],
+              @"pushDate": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeStrong],
+              @"payload": [PFPropertyAttributes attributesWithAssociationType:PFPropertyInfoAssociationTypeCopy] };
 }
 
 ///--------------------------------------
@@ -45,6 +45,19 @@ + (instancetype)stateWithState:(PFPushState *)state {
 #pragma mark - NSCopying
 ///--------------------------------------
 
+- (void)setPushDate:(NSDate *)pushDate {
+    if (self.pushDate != pushDate) {
+        NSTimeInterval interval = [pushDate timeIntervalSinceNow];
+        PFParameterAssert(interval > 0, @"Can't set the scheduled push time in the past.");
+        PFParameterAssert(interval <= 60 * 24 * 14, @"Can't set the schedule push time more than two weeks from now.");
+        _pushDate = pushDate;
+    }
+}
+
+///--------------------------------------
+#pragma mark - NSCopying
+///--------------------------------------
+
 - (id)copyWithZone:(NSZone *)zone {
     return [[PFPushState allocWithZone:zone] initWithState:self];
 }
diff --git a/Parse/Internal/Push/State/PFPushState_Private.h b/Parse/Internal/Push/State/PFPushState_Private.h
@@ -17,7 +17,8 @@ NS_ASSUME_NONNULL_BEGIN
 @property (nullable, nonatomic, copy, readwrite) PFQueryState *queryState;
 
 @property (nullable, nonatomic, strong, readwrite) NSDate *expirationDate;
-@property (nullable, nonatomic, copy, readwrite) NSNumber *expirationTimeInterval;
+@property (nullable, nonatomic, strong, readwrite) NSNumber *expirationTimeInterval;
+@property (nullable, nonatomic, strong, readwrite) NSDate *pushDate;
 
 @property (nullable, nonatomic, copy, readwrite) NSDictionary *payload;
 
diff --git a/Parse/PFPush.h b/Parse/PFPush.h
@@ -134,6 +134,15 @@ PF_TV_UNAVAILABLE PF_WATCH_UNAVAILABLE @interface PFPush : NSObject <NSCopying>
  */
 - (void)clearExpiration;
 
+/*!
+ @abstract Date at which to send this push notification. 
+ 
+ @discussion Push notificaitons with this date will be delivered at the local time matching the <PFInstallation.timeZone>.
+ 
+ @warning The date cannot be in the past, and can be up to two weeks in the future.
+ */
+@property (nullable, nonatomic, strong) NSDate *pushDate;
+
 ///--------------------------------------
 /// @name Sending Push Notifications
 ///--------------------------------------
diff --git a/Parse/PFPush.m b/Parse/PFPush.m
@@ -114,6 +114,14 @@ - (void)clearExpiration {
     self.state.expirationTimeInterval = nil;
 }
 
+- (void)setPushDate:(NSDate *)pushDate {
+    self.state.pushDate = pushDate;
+}
+
+- (NSDate *)pushDate {
+    return self.state.pushDate;
+}
+
 - (void)setData:(NSDictionary *)data {
     self.state.payload = data;
 }
diff --git a/Tests/Unit/PushCommandTests.m b/Tests/Unit/PushCommandTests.m
@@ -85,6 +85,20 @@ - (void)testPushCommandExpirationTimeInterval {
     XCTAssertEqualObjects(command.sessionToken, @"yarr");
 }
 
+- (void)testPushCommandPushDate {
+    PFMutablePushState *state = [[PFMutablePushState alloc] init];
+    state.pushDate = [NSDate dateWithTimeIntervalSinceNow:1.0];
+
+    PFRESTPushCommand *command = [PFRESTPushCommand sendPushCommandWithPushState:state sessionToken:@"yarr"];
+    XCTAssertNotNil(command);
+    XCTAssertEqualObjects(command.httpPath, @"push");
+    XCTAssertEqualObjects(command.httpMethod, PFHTTPRequestMethodPOST);
+    XCTAssertNil(command.parameters[@"expiration_time"]);
+    XCTAssertNil(command.parameters[@"expiration_interval"]);
+    XCTAssertNotNil(command.parameters[@"push_time"]);
+    XCTAssertEqualObjects(command.sessionToken, @"yarr");
+}
+
 - (void)testPushCommandPayload {
     PFMutablePushState *state = [[PFMutablePushState alloc] init];
     state.payload = @{ @"alert" : @"yolo" };
diff --git a/Tests/Unit/PushStateTests.m b/Tests/Unit/PushStateTests.m
@@ -10,6 +10,7 @@
 #import "PFMutablePushState.h"
 #import "PFQueryState.h"
 #import "PFTestCase.h"
+#import "PFAssert.h"
 
 @interface PushStateTests : PFTestCase
 
@@ -27,6 +28,7 @@ - (PFPushState *)samplePushState {
     state.queryState = [[PFQueryState alloc] init];
     state.expirationDate = [NSDate date];
     state.expirationTimeInterval = @1.0;
+    state.pushDate = [NSDate dateWithTimeIntervalSinceNow:120];
     state.payload = @{ @"alert" : @"yarr" };
     return [state copy];
 }
@@ -36,6 +38,7 @@ - (void)assertPushState:(PFPushState *)state equalToState:(PFPushState *)differe
     XCTAssertEqualObjects(state.queryState, differentState.queryState);
     XCTAssertEqualObjects(state.expirationDate, differentState.expirationDate);
     XCTAssertEqualObjects(state.expirationTimeInterval, differentState.expirationTimeInterval);
+    XCTAssertEqualObjects(state.pushDate, differentState.pushDate);
     XCTAssertEqualObjects(state.payload, differentState.payload);
 }
 
@@ -50,15 +53,15 @@ - (void)testInit {
     XCTAssertNil(state.queryState);
     XCTAssertNil(state.expirationDate);
     XCTAssertNil(state.expirationTimeInterval);
-    XCTAssertNil(state.expirationTimeInterval);
+    XCTAssertNil(state.pushDate);
 
     state = [[PFMutablePushState alloc] init];
     XCTAssertNotNil(state);
     XCTAssertNil(state.channels);
     XCTAssertNil(state.queryState);
     XCTAssertNil(state.expirationDate);
     XCTAssertNil(state.expirationTimeInterval);
-    XCTAssertNil(state.expirationTimeInterval);
+    XCTAssertNil(state.pushDate);
 }
 
 - (void)testInitWithState {
@@ -125,4 +128,10 @@ - (void)testSetPayloadWithMessage {
     XCTAssertNil(state.payload);
 }
 
+- (void)testSetPushTimeValidation {
+    PFMutablePushState *state = [[PFMutablePushState alloc] init];
+    PFAssertThrowsInvalidArgumentException(state.pushDate = [NSDate distantPast]);
+    PFAssertThrowsInvalidArgumentException(state.pushDate = [NSDate distantFuture]);
+}
+
 @end

Original file line number	Diff line number	Diff line change
`@@ -114,6 +114,14 @@ - (void)clearExpiration {`
`114`	`114`	`self.state.expirationTimeInterval = nil;`
`115`	`115`	`}`
`116`	`116`
	`117`	`+- (void)setPushDate:(NSDate *)pushDate {`
	`118`	`+ self.state.pushDate = pushDate;`
	`119`	`+}`
	`120`	`+`
	`121`	`+- (NSDate *)pushDate {`
	`122`	`+ return self.state.pushDate;`
	`123`	`+}`
	`124`	`+`
`117`	`125`	`- (void)setData:(NSDictionary *)data {`
`118`	`126`	`self.state.payload = data;`
`119`	`127`	`}`