Let ParseFacebook accept expiresIn parameter (#104)

* Let ParseFacebook accept expiresIn parameter * Accept expiresIn as optional * Remove expiresIn from being required in publishers. * Fully test verifyMandatoryKeys
parse-community · Mar 28, 2021 · f3f2244 · f3f2244
1 parent a233682
commit f3f2244
Show file tree

Hide file tree

Showing 8 changed files with 131 additions and 118 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,9 +1,15 @@
 # Parse-Swift Changelog
 
 ### main
-[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.2.4...main)
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.2.5...main)
 * _Contributing to this repo? Add info about your change here to be included in the next release_
 
+### 1.2.5
+[Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.2.4...1.2.5)
+
+__Fixes__
+- Let ParseFacebook accept expiresIn parameter instead of converting to date ([#104](https://github.com/parse-community/Parse-Swift/pull/104)), thanks to [Corey Baker](https://github.com/cbaker6).
+
 ### 1.2.4
 [Full Changelog](https://github.com/parse-community/Parse-Swift/compare/1.2.3...1.2.4)
 

diff --git a/ParseSwift.podspec b/ParseSwift.podspec
@@ -1,6 +1,6 @@
 Pod::Spec.new do |s|
   s.name     = "ParseSwift"
-  s.version  = "1.2.4"
+  s.version  = "1.2.5"
   s.summary  = "Parse Pure Swift SDK"
   s.homepage = "https://github.com/parse-community/Parse-Swift"
   s.authors = {

diff --git a/ParseSwift.xcodeproj/project.pbxproj b/ParseSwift.xcodeproj/project.pbxproj
@@ -2321,7 +2321,7 @@
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				PRODUCT_BUNDLE_IDENTIFIER = com.parse.ParseSwift;
 				PRODUCT_NAME = ParseSwift;
 				SKIP_INSTALL = YES;
@@ -2345,7 +2345,7 @@
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				IPHONEOS_DEPLOYMENT_TARGET = 12.0;
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				PRODUCT_BUNDLE_IDENTIFIER = com.parse.ParseSwift;
 				PRODUCT_NAME = ParseSwift;
 				SKIP_INSTALL = YES;
@@ -2411,7 +2411,7 @@
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/Frameworks";
 				MACOSX_DEPLOYMENT_TARGET = 10.13;
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				PRODUCT_BUNDLE_IDENTIFIER = com.parse.ParseSwift;
 				PRODUCT_NAME = ParseSwift;
 				SDKROOT = macosx;
@@ -2437,7 +2437,7 @@
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/../Frameworks @loader_path/Frameworks";
 				MACOSX_DEPLOYMENT_TARGET = 10.13;
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				PRODUCT_BUNDLE_IDENTIFIER = com.parse.ParseSwift;
 				PRODUCT_NAME = ParseSwift;
 				SDKROOT = macosx;
@@ -2584,7 +2584,7 @@
 				INFOPLIST_FILE = "ParseSwift-watchOS/Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
 				MTL_FAST_MATH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.parse.ParseSwift-watchOS";
@@ -2613,7 +2613,7 @@
 				INFOPLIST_FILE = "ParseSwift-watchOS/Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				MTL_FAST_MATH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.parse.ParseSwift-watchOS";
 				PRODUCT_NAME = ParseSwift;
@@ -2640,7 +2640,7 @@
 				INFOPLIST_FILE = "ParseSwift-tvOS/Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				MTL_ENABLE_DEBUG_INFO = INCLUDE_SOURCE;
 				MTL_FAST_MATH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.parse.ParseSwift-tvOS";
@@ -2668,7 +2668,7 @@
 				INFOPLIST_FILE = "ParseSwift-tvOS/Info.plist";
 				INSTALL_PATH = "$(LOCAL_LIBRARY_DIR)/Frameworks";
 				LD_RUNPATH_SEARCH_PATHS = "$(inherited) @executable_path/Frameworks @loader_path/Frameworks";
-				MARKETING_VERSION = 1.2.4;
+				MARKETING_VERSION = 1.2.5;
 				MTL_FAST_MATH = YES;
 				PRODUCT_BUNDLE_IDENTIFIER = "com.parse.ParseSwift-tvOS";
 				PRODUCT_NAME = ParseSwift;

diff --git a/Scripts/jazzy.sh b/Scripts/jazzy.sh
@@ -5,7 +5,7 @@ bundle exec jazzy \
   --author_url http://parseplatform.org \
   --github_url https://github.com/parse-community/Parse-Swift \
   --root-url http://parseplatform.org/Parse-Swift/api/ \
-  --module-version 1.2.4 \
+  --module-version 1.2.5 \
   --theme fullwidth \
   --skip-undocumented \
   --output ./docs/api \

diff --git a/Sources/ParseSwift/Authentication/3rd Party/ParseFacebook.swift b/Sources/ParseSwift/Authentication/3rd Party/ParseFacebook.swift
@@ -28,7 +28,7 @@ public struct ParseFacebook<AuthenticatedUser: ParseUser>: ParseAuthentication {
 
         enum CodingKeys: String, CodingKey { // swiftlint:disable:this nesting
           case id // swiftlint:disable:this identifier_name
-          case token
+          case authenticationToken = "token"
           case accessToken = "access_token"
           case expirationDate = "expiration_date"
         }
@@ -37,16 +37,21 @@ public struct ParseFacebook<AuthenticatedUser: ParseUser>: ParseAuthentication {
         /// - parameter userId: Required id for the user.
         /// - parameter authenticationToken: Required identity token for Facebook limited login.
         /// - parameter accessToken: Required identity token for Facebook graph API.
-        /// - parameter expirationDate: Required expiration data for Facebook login.
+        /// - parameter expiresIn: Optional expiration in seconds for Facebook login.
         /// - returns: authData dictionary.
         func makeDictionary(userId: String,
                             accessToken: String?,
                             authenticationToken: String?,
-                            expirationDate: Date) -> [String: String] {
-
-            let dateString = ParseCoding.dateFormatter.string(from: expirationDate)
-            var returnDictionary = [AuthenticationKeys.id.rawValue: userId,
-                                    AuthenticationKeys.expirationDate.rawValue: dateString]
+                            expiresIn: Int? = nil) -> [String: String] {
+
+            var returnDictionary = [AuthenticationKeys.id.rawValue: userId]
+            if let expiresIn = expiresIn,
+                let expirationDate = Calendar.current.date(byAdding: .second,
+                                                             value: expiresIn,
+                                                             to: Date()) {
+                let dateString = ParseCoding.dateFormatter.string(from: expirationDate)
+                returnDictionary[AuthenticationKeys.expirationDate.rawValue] = dateString
+            }
 
             if let accessToken = accessToken {
               returnDictionary[AuthenticationKeys.accessToken.rawValue] = accessToken
@@ -60,8 +65,7 @@ public struct ParseFacebook<AuthenticatedUser: ParseUser>: ParseAuthentication {
         /// - parameter authData: Dictionary containing key/values.
         /// - returns: `true` if all the mandatory keys are present, `false` otherwise.
         func verifyMandatoryKeys(authData: [String: String]) -> Bool {
-            guard authData[AuthenticationKeys.id.rawValue] != nil,
-                  authData[AuthenticationKeys.expirationDate.rawValue] != nil else {
+            guard authData[AuthenticationKeys.id.rawValue] != nil else {
                 return false
             }
 
@@ -87,22 +91,22 @@ public extension ParseFacebook {
      Login a `ParseUser` *asynchronously* using Facebook authentication for limited login.
      - parameter userId: The `Facebook userId` from `FacebookSDK`.
      - parameter authenticationToken: The `authenticationToken` from `FacebookSDK`.
-     - parameter expirationDate: Required expiration data for Facebook login.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - parameter callbackQueue: The queue to return to after completion. Default value of .main.
      - parameter completion: The block to execute.
      */
     func login(userId: String,
                authenticationToken: String,
-               expirationDate: Date,
+               expiresIn: Int? = nil,
                options: API.Options = [],
                callbackQueue: DispatchQueue = .main,
                completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
 
         let facebookAuthData = AuthenticationKeys.id
                 .makeDictionary(userId: userId, accessToken: nil,
                                 authenticationToken: authenticationToken,
-                                expirationDate: expirationDate)
+                                expiresIn: expiresIn)
         login(authData: facebookAuthData,
               options: options,
               callbackQueue: callbackQueue,
@@ -113,14 +117,14 @@ public extension ParseFacebook {
      Login a `ParseUser` *asynchronously* using Facebook authentication for graph API login.
      - parameter userId: The `Facebook userId` from `FacebookSDK`.
      - parameter accessToken: The `accessToken` from `FacebookSDK`.
-     - parameter expirationDate: Required expiration data for Facebook login.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - parameter callbackQueue: The queue to return to after completion. Default value of .main.
      - parameter completion: The block to execute.
      */
     func login(userId: String,
                accessToken: String,
-               expirationDate: Date,
+               expiresIn: Int? = nil,
                options: API.Options = [],
                callbackQueue: DispatchQueue = .main,
                completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
@@ -129,7 +133,7 @@ public extension ParseFacebook {
                 .makeDictionary(userId: userId,
                                 accessToken: accessToken,
                                 authenticationToken: nil,
-                                expirationDate: expirationDate)
+                                expiresIn: expiresIn)
         login(authData: facebookAuthData,
               options: options,
               callbackQueue: callbackQueue,
@@ -159,19 +163,19 @@ public extension ParseFacebook {
      Login a `ParseUser` *asynchronously* using Facebook authentication for limited login. Publishes when complete.
      - parameter userId: The `userId` from `FacebookSDK`.
      - parameter authenticationToken: The `authenticationToken` from `FacebookSDK`.
-     - parameter expirationDate: Required expiration data for Facebook login.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - returns: A publisher that eventually produces a single value and then finishes or fails.
      */
     @available(macOS 10.15, iOS 13.0, macCatalyst 13.0, watchOS 6.0, tvOS 13.0, *)
     func loginPublisher(userId: String,
                         authenticationToken: String,
-                        expirationDate: Date,
+                        expiresIn: Int? = nil,
                         options: API.Options = []) -> Future<AuthenticatedUser, ParseError> {
         Future { promise in
             self.login(userId: userId,
                        authenticationToken: authenticationToken,
-                       expirationDate: expirationDate,
+                       expiresIn: expiresIn,
                        options: options,
                        completion: promise)
         }
@@ -181,19 +185,19 @@ public extension ParseFacebook {
      Login a `ParseUser` *asynchronously* using Facebook authentication for graph API login. Publishes when complete.
      - parameter userId: The `userId` from `FacebookSDK`.
      - parameter accessToken: The `accessToken` from `FacebookSDK`.
-     - parameter expirationDate: Required expiration data for Facebook login.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - returns: A publisher that eventually produces a single value and then finishes or fails.
      */
     @available(macOS 10.15, iOS 13.0, macCatalyst 13.0, watchOS 6.0, tvOS 13.0, *)
     func loginPublisher(userId: String,
                         accessToken: String,
-                        expirationDate: Date,
+                        expiresIn: Int? = nil,
                         options: API.Options = []) -> Future<AuthenticatedUser, ParseError> {
         Future { promise in
             self.login(userId: userId,
                        accessToken: accessToken,
-                       expirationDate: expirationDate,
+                       expiresIn: expiresIn,
                        options: options,
                        completion: promise)
         }
@@ -218,22 +222,22 @@ public extension ParseFacebook {
      Link the *current* `ParseUser` *asynchronously* using Facebook authentication for limited login.
      - parameter userId: The `userId` from `FacebookSDK`.
      - parameter authenticationToken: The `authenticationToken` from `FacebookSDK`.
-     - parameter expirationDate: Required expiration data for Facebook login.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - parameter callbackQueue: The queue to return to after completion. Default value of .main.
      - parameter completion: The block to execute.
      */
     func link(userId: String,
               authenticationToken: String,
-              expirationDate: Date,
+              expiresIn: Int? = nil,
               options: API.Options = [],
               callbackQueue: DispatchQueue = .main,
               completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         let facebookAuthData = AuthenticationKeys.id
             .makeDictionary(userId: userId,
                             accessToken: nil,
                             authenticationToken: authenticationToken,
-                            expirationDate: expirationDate)
+                            expiresIn: expiresIn)
         link(authData: facebookAuthData,
              options: options,
              callbackQueue: callbackQueue,
@@ -244,22 +248,22 @@ public extension ParseFacebook {
      Link the *current* `ParseUser` *asynchronously* using Facebook authentication for graph API login.
      - parameter userId: The `userId` from `FacebookSDK`.
      - parameter accessToken: The `accessToken` from `FacebookSDK`.
-     - parameter expirationDate: the `expirationDate` from `FacebookSDK`.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - parameter callbackQueue: The queue to return to after completion. Default value of .main.
      - parameter completion: The block to execute.
      */
     func link(userId: String,
               accessToken: String,
-              expirationDate: Date,
+              expiresIn: Int? = nil,
               options: API.Options = [],
               callbackQueue: DispatchQueue = .main,
               completion: @escaping (Result<AuthenticatedUser, ParseError>) -> Void) {
         let facebookAuthData = AuthenticationKeys.id
             .makeDictionary(userId: userId,
                             accessToken: accessToken,
                             authenticationToken: nil,
-                            expirationDate: expirationDate)
+                            expiresIn: expiresIn)
         link(authData: facebookAuthData,
              options: options,
              callbackQueue: callbackQueue,
@@ -290,19 +294,19 @@ public extension ParseFacebook {
      Link the *current* `ParseUser` *asynchronously* using Facebook authentication for limited login. Publishes when complete.
      - parameter userId: The `userId` from `FacebookSDK`.
      - parameter authenticationToken: The `authenticationToken` from `FacebookSDK`.
-     - parameter expirationDate: the `expirationDate` from `FacebookSDK`.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - returns: A publisher that eventually produces a single value and then finishes or fails.
      */
     @available(macOS 10.15, iOS 13.0, macCatalyst 13.0, watchOS 6.0, tvOS 13.0, *)
     func linkPublisher(userId: String,
                        authenticationToken: String,
-                       expirationDate: Date,
+                       expiresIn: Int? = nil,
                        options: API.Options = []) -> Future<AuthenticatedUser, ParseError> {
         Future { promise in
             self.link(userId: userId,
                       authenticationToken: authenticationToken,
-                      expirationDate: expirationDate,
+                      expiresIn: expiresIn,
                       options: options,
                       completion: promise)
         }
@@ -312,19 +316,19 @@ public extension ParseFacebook {
      Link the *current* `ParseUser` *asynchronously* using Facebook authentication for graph API login. Publishes when complete.
      - parameter userId: The `userId` from `FacebookSDK`.
      - parameter accessToken: The `accessToken` from `FacebookSDK`.
-     - parameter expirationDate: the `expirationDate` from `FacebookSDK`.
+     - parameter expiresIn: Optional expiration in seconds for Facebook login.
      - parameter options: A set of header options sent to the server. Defaults to an empty set.
      - returns: A publisher that eventually produces a single value and then finishes or fails.
      */
     @available(macOS 10.15, iOS 13.0, macCatalyst 13.0, watchOS 6.0, tvOS 13.0, *)
     func linkPublisher(userId: String,
                        accessToken: String,
-                       expirationDate: Date,
+                       expiresIn: Int? = nil,
                        options: API.Options = []) -> Future<AuthenticatedUser, ParseError> {
         Future { promise in
             self.link(userId: userId,
                       accessToken: accessToken,
-                      expirationDate: expirationDate,
+                      expiresIn: expiresIn,
                       options: options,
                       completion: promise)
         }

diff --git a/Sources/ParseSwift/ParseConstants.swift b/Sources/ParseSwift/ParseConstants.swift
@@ -9,7 +9,7 @@
 import Foundation
 
 enum ParseConstants {
-    static let parseVersion = "1.2.3"
+    static let parseVersion = "1.2.5"
     static let hashingKey = "parseSwift"
     static let fileManagementDirectory = "parse/"
     static let fileManagementPrivateDocumentsDirectory = "Private Documents/"