feat: add ParsePush notifications

.spi.yml

@@ -3,9 +3,9 @@ builder:
   configs:
   - platform: ios
     scheme: "ParseSwift (iOS)"
-    documentation_targets: ["ParseSwift (iOS)"]
   - platform: macos-xcodebuild
     scheme: "ParseSwift (macOS)"
+    documentation_targets: ["ParseSwift (iOS)", "ParseSwift (macOS)", "ParseSwift (tvOS)", "ParseSwift (watchOS)"]
   - platform: macos-xcodebuild-arm
     scheme: "ParseSwift (macOS)"
   - platform: tvos

CHANGELOG.md

@@ -6,6 +6,7 @@
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
 __New features__
+- Add the ability to send APN and FCM push notifications. Also adds the ability to query _PushStatus ([#371](https://github.com/parse-community/Parse-Swift/pull/371)), thanks to [Corey Baker](https://github.com/cbaker6).
 - Add ParseSchema, ParseCLP, and ParseFieldOptions. Should only be used when using the Swift SDK on a secured server ([#370](https://github.com/parse-community/Parse-Swift/pull/370)), thanks to [Corey Baker](https://github.com/cbaker6).
 
 ### 4.5.0

ParseSwift.playground/Pages/20 - Schema.xcplaygroundpage/Contents.swift

@@ -251,4 +251,5 @@ gameScoreSchema.purge { result in
     }
 }
 
+PlaygroundPage.current.finishExecution()
 //: [Next](@next)

ParseSwift.playground/Pages/21 - Push Notifications.xcplaygroundpage/Contents.swift

@@ -0,0 +1,179 @@
+//: [Previous](@previous)
+
+import PlaygroundSupport
+import Foundation
+import ParseSwift
+
+PlaygroundPage.current.needsIndefiniteExecution = true
+initializeParse()
+
+struct Installation: ParseInstallation {
+    //: These are required by `ParseObject`.
+    var objectId: String?
+    var createdAt: Date?
+    var updatedAt: Date?
+    var ACL: ParseACL?
+    var originalData: Data?
+
+    //: These are required by `ParseInstallation`.
+    var installationId: String?
+    var deviceType: String?
+    var deviceToken: String?
+    var badge: Int?
+    var timeZone: String?
+    var channels: [String]?
+    var appName: String?
+    var appIdentifier: String?
+    var appVersion: String?
+    var parseVersion: String?
+    var localeIdentifier: String?
+
+    //: Your custom keys
+    var customKey: String?
+
+    //: Implement your own version of merge
+    func merge(with object: Self) throws -> Self {
+        var updated = try mergeParse(with: object)
+        if updated.shouldRestoreKey(\.customKey,
+                                     original: object) {
+            updated.customKey = object.customKey
+        }
+        return updated
+    }
+}
+
+/**
+ We will begin by creating the payload information we want to
+ send in the push notification.
+ */
+let helloAlert = ParsePushAppleAlert(body: "Hello from ParseSwift!")
+let applePayload = ParsePushPayloadApple(alert: helloAlert)
+    .setBadge(1)
+
+/*:
+ We now crate a query where the `objectId`
+ is not null or undefined.
+*/
+let installationQuery = Installation.query(isNotNull(key: "objectId"))
+
+//: Now create a new push notification using the payload and query.
+let push = ParsePush(payload: applePayload, query: installationQuery)
+
+//: Creating this property to use later in the playground.
+var pushStatusId = ""
+
+//: You can send the push notification whenever you are ready.
+push.send { result in
+    switch result {
+    case .success(let statusId):
+        print("The push was created with id: \"\(statusId)\"")
+        //: Update the stored property with the lastest status id.
+        pushStatusId = statusId
+    case .failure(let error):
+        print("Couldn't create push: \(error)")
+    }
+}
+
+//: You can fetch the status of notificaiton if you know it's id.
+push.fetchStatus(pushStatusId) { result in
+    switch result {
+    case .success(let pushStatus):
+        print("The push status is: \"\(pushStatus)\"")
+    case .failure(let error):
+        print("Couldn't fetch push status: \(error)")
+    }
+}
+
+/*:
+ Lets create another Push, this time by incrementing the badge
+ and using channels instead of a query.
+ */
+let helloAgainAlert = ParsePushAppleAlert(body: "Hello from ParseSwift again!")
+let applePayload2 = ParsePushPayloadApple(alert: helloAgainAlert)
+    .incrementBadge()
+
+var push2 = ParsePush(payload: applePayload2)
+//: Set all channels the notificatioin should be published to.
+push2.channels = Set(["newDevices"])
+
+//: You can send the push notification whenever you are ready.
+push2.send { result in
+    switch result {
+    case .success(let statusId):
+        print("The push was created with id: \"\(statusId)\"")
+        //: Update the stored property with the lastest status id.
+        pushStatusId = statusId
+    case .failure(let error):
+        print("Couldn't create push: \(error)")
+    }
+}
+
+/*:
+ Similar to before, you can fetch the status of notificaiton
+ if you know the id.
+ */
+push2.fetchStatus(pushStatusId) { result in
+    switch result {
+    case .success(let pushStatus):
+        print("The push status is: \"\(pushStatus)\"")
+    case .failure(let error):
+        print("Couldn't fetch push status: \(error)")
+    }
+}
+
+/*:
+ You can also send push notifications using Firebase Cloud Messanger.
+ */
+let helloNotification = ParsePushFirebaseNotification(body: "Hello from ParseSwift using FCM!")
+let firebasePayload = ParsePushPayloadFirebase(notification: helloNotification)
+
+let push3 = ParsePush(payload: firebasePayload, query: installationQuery)
+
+//: You can send the push notification whenever you are ready.
+push3.send { result in
+    switch result {
+    case .success(let statusId):
+        print("The Firebase push was created with id: \"\(statusId)\"")
+        //: Update the stored property with the lastest status id.
+        pushStatusId = statusId
+    case .failure(let error):
+        print("Couldn't create push: \(error)")
+    }
+}
+
+/*:
+ Similar to before, you can fetch the status of notificaiton
+ if you know the id.
+ */
+push3.fetchStatus(pushStatusId) { result in
+    switch result {
+    case .success(let pushStatus):
+        print("The Firebase push status is: \"\(pushStatus)\"")
+    case .failure(let error):
+        print("Couldn't fetch push status: \(error)")
+    }
+}
+
+/*:
+ If you have a mixed push environment and are querying
+ multiple ParsePushStatus's you will can use the any
+ payload, `ParsePushPayloadAny`.
+ */
+let query = ParsePushStatus<ParsePushPayloadAny>
+    .query(isNotNull(key: "objectId"))
+
+/*:
+ Be sure to add the `.userMasterKey option when doing
+ anything with `ParsePushStatus` directly.
+*/
+query.findAll(options: [.useMasterKey]) { result in
+    switch result {
+    case .success(let pushStatus):
+        print("All matching statuses: \"\(pushStatus)\"")
+    case .failure(let error):
+        print("Couldn't perform query: \(error)")
+    }
+}
+
+PlaygroundPage.current.finishExecution()
+//: [Next](@next)

ParseSwift.playground/Pages/6 - Installation.xcplaygroundpage/Contents.swift

@@ -65,13 +65,14 @@ currentInstallation?.save { results in
     }
 }
 
-/*: Update your `ParseInstallation` `customKey` value.
+/*: Update your `ParseInstallation` `customKey` and `channels` values.
     Performs work on background queue and returns to designated on
     designated callbackQueue. If no callbackQueue is specified it
     returns to main queue.
  */
 var installationToUpdate = Installation.current?.mergeable
 installationToUpdate?.customKey = "myCustomInstallationKey2"
+installationToUpdate?.channels = ["newDevices"]
 installationToUpdate?.save { results in
 
     switch results {

ParseSwift.playground/contents.xcplayground

@@ -20,5 +20,7 @@
         <page name='17 - SwiftUI - Finding Objects'/>
         <page name='18 - SwiftUI - Finding Objects With Custom ViewModel'/>
         <page name='19 - SwiftUI - LiveQuery'/>
+        <page name='20 - Schema'/>
+        <page name='21 - Push Notifications'/>
     </pages>
 </playground>