Remove deprecated callbacks

Author: p2

CHANGELOG.md

@@ -10,6 +10,7 @@ You can also refer to commit logs to get details on what was implemented, fixed
 - Move `secretInBody` and `customParameters` from `authConfig` to `clientConfig`, where they belong
 - Allow to override default UTF-8 encoding of the _Basic_ authorization header
 - Improvements to embedded authorization
+- Remove `onAuthorize` and `onFailure` callbacks, which have been deprecated with 3.0 (now handled in the callback to `authorize()`)
 
 
 ### 3.0.1

README.md

@@ -169,7 +169,7 @@ You only need to inspect the _authParameters_ dictionary if you wish to extract
 
 For advanced use outlined below, there is the `afterAuthorizeOrFail` block that you can use on your OAuth2 instance.
 The `internalAfterAuthorizeOrFail` closure is, as its name suggests, provided for internal purposes – it is exposed for subclassing and compilation reasons and you should not mess with it.
-Additionally, as of version 3.0, there are deprecated callback properties `onAuthorize` and `onFailure` that you should no longer use.
+As of version 3.0.2, you can no longer use the `onAuthorize` and `onFailure` callback properties, they have been removed entirely.
 
 ### 6. Make Requests
 

Sources/Base/OAuth2Base.swift

@@ -129,14 +129,6 @@ open class OAuth2Base: OAuth2Securable {
 		return nil != didAuthorizeOrFail
 	}
 
-	/// Closure called on successful authorization on the main thread.
-	@available(*, deprecated: 3.0, message: "Use the `authorize(params:callback:)` method and variants")
-	public final var onAuthorize: ((_ parameters: OAuth2JSON) -> Void)?
-	
-	/// When authorization fails (if error is not nil) or is cancelled, this block is executed on the main thread.
-	@available(*, deprecated: 3.0, message: "Use the `authorize(params:callback:)` method and variants")
-	public final var onFailure: ((OAuth2Error?) -> Void)?
-	
 	/**
 	Closure called after the regular authorization callback, on the main thread. You can use this callback when you're performing
 	authorization manually and/or for cleanup operations.
@@ -267,7 +259,6 @@ open class OAuth2Base: OAuth2Securable {
 			storeTokensToKeychain()
 		}
 		callOnMainThread() {
-			self.onAuthorize?(parameters)
 			self.didAuthorizeOrFail?(parameters, nil)
 			self.didAuthorizeOrFail = nil
 			self.internalAfterAuthorizeOrFail?(false, nil)
@@ -292,7 +283,6 @@ open class OAuth2Base: OAuth2Securable {
 			finalError = OAuth2Error.requestCancelled
 		}
 		callOnMainThread() {
-			self.onFailure?(finalError)
 			self.didAuthorizeOrFail?(nil, finalError)
 			self.didAuthorizeOrFail = nil
 			self.internalAfterAuthorizeOrFail?(true, finalError)

Sources/Flows/OAuth2.swift

@@ -86,8 +86,8 @@ open class OAuth2: OAuth2Base {
 	This method will first check if the client already has an unexpired access token (possibly from the keychain), if not and it's able to
 	use a refresh token it will try to use the refresh token. If this fails it will check whether the client has a client_id and show the
 	authorize screen if you have `authConfig` set up sufficiently. If `authConfig` is not set up sufficiently this method will end up
-	calling the `onFailure` callback. If client_id is not set but a "registration_uri" has been provided, a dynamic client registration will
-	be attempted and if it success, an access token will be requested.
+	calling the callback with a failure. If client_id is not set but a "registration_uri" has been provided, a dynamic client registration
+	will be attempted and if it success, an access token will be requested.
 
 	- parameter params:   Optional key/value pairs to pass during authorization and token refresh
 	- parameter callback: The callback to call when authorization finishes (parameters will be non-nil but may be an empty dict), fails or

Tests/BaseTests/OAuth2Tests.swift

@@ -89,35 +89,6 @@ class OAuth2Tests: XCTestCase {
 		XCTAssertNil(params["state"], "Expecting no `state` in query")
 	}
 
-	func testDeprecatedAuthorizeCall() {
-		let oa = genericOAuth2()
-		oa.verbose = false
-		XCTAssertFalse(oa.authConfig.authorizeEmbedded)
-		oa.onAuthorize = { params in
-			XCTAssertTrue(false, "Should not call success callback")
-		}
-		oa.onFailure = { error in
-			XCTAssertNotNil(error)
-			XCTAssertEqual(error, OAuth2Error.noRedirectURL)
-		}
-		oa.authorize()
-		XCTAssertFalse(oa.authConfig.authorizeEmbedded)
-		
-		// embedded
-		oa.redirect = "myapp://oauth"
-		oa.onFailure = { error in
-			XCTAssertNotNil(error)
-			XCTAssertEqual(error, OAuth2Error.invalidAuthorizationContext)
-		}
-		oa.afterAuthorizeOrFail = { params, error in
-			XCTAssertNil(params)
-			XCTAssertNotNil(error)
-			XCTAssertEqual(error, OAuth2Error.invalidAuthorizationContext)
-		}
-		oa.authorizeEmbedded(from: NSString())
-		XCTAssertTrue(oa.authConfig.authorizeEmbedded)
-	}
-	
 	func testAuthorizeCall() {
 		let oa = genericOAuth2()
 		oa.verbose = false

Tests/FlowTests/OAuth2ImplicitGrantTests.swift

@@ -45,108 +45,6 @@ class OAuth2ImplicitGrantTests: XCTestCase
 		XCTAssertEqual(oauth.authURL, URL(string: "https://auth.ful.io")!, "Must init `authorize_uri`")
 	}
 
-	func testDeprecatedReturnURLHandling() {
-		let oauth = OAuth2ImplicitGrant(settings: [
-			"client_id": "abc",
-			"authorize_uri": "https://auth.ful.io",
-			"keychain": false,
-		])
-		
-		// Empty redirect URL
-		oauth.onFailure = { error in
-			XCTAssertNotNil(error, "Error message expected")
-			XCTAssertEqual(error, OAuth2Error.invalidRedirectURL("file:///"))
-		}
-		oauth.afterAuthorizeOrFail = { authParameters, error in
-			XCTAssertNil(authParameters)
-			XCTAssertNotNil(error, "Error message expected")
-		}
-		oauth.context._state = "ONSTUH"
-		oauth.handleRedirectURL(URL(string: "file:///")!)
-		XCTAssertNil(oauth.accessToken, "Must not have an access token")
-		
-		// No params in redirect URL
-		oauth.onFailure = { error in
-			XCTAssertNotNil(error, "Error message expected")
-			XCTAssertEqual(error, OAuth2Error.invalidRedirectURL("https://auth.ful.io"))
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io")!)
-		XCTAssertNil(oauth.accessToken, "Must not have an access token")
-		
-		// standard error
-		oauth.context._state = "ONSTUH"		// because it has been reset
-		oauth.onFailure = { error in
-			XCTAssertNotNil(error, "Error message expected")
-			XCTAssertEqual(error, OAuth2Error.accessDenied)
-			XCTAssertEqual(error?.description, "The resource owner or authorization server denied the request.")
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io#error=access_denied")!)
-		XCTAssertNil(oauth.accessToken, "Must not have an access token")
-		
-		// explicit error
-		oauth.context._state = "ONSTUH"		// because it has been reset
-		oauth.onFailure = { error in
-			XCTAssertNotNil(error, "Error message expected")
-			XCTAssertNotEqual(error, OAuth2Error.generic("Not good"))
-			XCTAssertEqual(error, OAuth2Error.responseError("Not good"))
-			XCTAssertEqual(error?.description, "Not good")
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io#error_description=Not+good")!)
-		XCTAssertNil(oauth.accessToken, "Must not have an access token")
-		
-		// no token type
-		oauth.context._state = "ONSTUH"		// because it has been reset
-		oauth.onFailure = { error in
-			XCTAssertNotNil(error, "Error message expected")
-			XCTAssertEqual(error, OAuth2Error.noTokenType)
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io#access_token=abc&state=\(oauth.context.state)")!)
-		XCTAssertNil(oauth.accessToken, "Must not have an access token")
-		
-		// unsupported token type
-		oauth.context._state = "ONSTUH"		// because it has been reset
-		oauth.onFailure = { error in
-			XCTAssertNotNil(error, "Error message expected")
-			XCTAssertEqual(error, OAuth2Error.unsupportedTokenType("Only “bearer” token is supported, but received “helicopter”"))
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io#token_type=helicopter&access_token=abc&state=\(oauth.context.state)")!)
-		XCTAssertNil(oauth.accessToken, "Must not have an access token")
-		
-		// Invalid state
-		oauth.context._state = "ONSTUH"		// because it has been reset
-		oauth.onFailure = { error in
-			XCTAssertNotNil(error, "Error message expected")
-			XCTAssertEqual(error, OAuth2Error.invalidState)
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io#token_type=bearer&access_token=abc&state=ONSTOH")!)
-		XCTAssertNil(oauth.accessToken, "Must not have an access token")
-		
-		// success 1
-		oauth.onFailure = { error in
-			XCTAssertTrue(false, "Should not call this")
-		}
-		oauth.afterAuthorizeOrFail = { authParameters, error in
-			XCTAssertNotNil(authParameters, "Expecting non-nil auth dict")
-			XCTAssertTrue((authParameters?.count ?? 0) > 2, "Expecting non-empty auth dict")
-			XCTAssertNil(error, "No error message expected")
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io#token_type=bearer&access_token=abc&state=\(oauth.context.state)&expires_in=3599")!)
-		XCTAssertNotNil(oauth.accessToken, "Must have an access token")
-		XCTAssertEqual(oauth.accessToken!, "abc")
-		XCTAssertNotNil(oauth.accessTokenExpiry)
-		XCTAssertTrue(oauth.hasUnexpiredAccessToken())
-		
-		// success 2
-		oauth.onFailure = { error in
-			XCTAssertTrue(false, "Should not call this")
-		}
-		oauth.handleRedirectURL(URL(string: "https://auth.ful.io#token_type=bearer&access_token=abc&state=\(oauth.context.state)")!)
-		XCTAssertNotNil(oauth.accessToken, "Must have an access token")
-		XCTAssertEqual(oauth.accessToken!, "abc")
-		XCTAssertNil(oauth.accessTokenExpiry)
-		XCTAssertTrue(oauth.hasUnexpiredAccessToken())
-	}
-	
 	func testReturnURLHandling() {
 		let oauth = OAuth2ImplicitGrant(settings: [
 			"client_id": "abc",