RSA10l (#524)

* Auth: deprecate `authorise` in favor of `authorize`. * RSA10l * Use `authorize` instead of `authorise` (close #496)
ably · Oct 19, 2016 · ceae327 · ceae327
1 parent 069e81c
commit ceae327
Show file tree

Hide file tree

Showing 8 changed files with 66 additions and 52 deletions.
diff --git a/Source/ARTAuth.h b/Source/ARTAuth.h
@@ -44,7 +44,9 @@ ART_ASSUME_NONNULL_BEGIN
 - (void)requestToken:(art_nullable ARTTokenParams *)tokenParams withOptions:(art_nullable ARTAuthOptions *)authOptions
             callback:(void (^)(ARTTokenDetails *__art_nullable, NSError *__art_nullable))callback;
 
-- (void)authorise:(art_nullable ARTTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)authOptions callback:(void (^)(ARTTokenDetails *__art_nullable, NSError *__art_nullable))callback;
+- (void)authorise:(art_nullable ARTTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)authOptions callback:(void (^)(ARTTokenDetails *__art_nullable, NSError *__art_nullable))callback DEPRECATED_MSG_ATTRIBUTE("method will be removed in v1.0. Use authorize: method instead.");
+
+- (void)authorize:(art_nullable ARTTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)authOptions callback:(void (^)(ARTTokenDetails *__art_nullable, NSError *__art_nullable))callback;
 
 - (void)createTokenRequest:(art_nullable ARTTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)options
                   callback:(void (^)(ARTTokenRequest *__art_nullable tokenRequest, NSError *__art_nullable error))callback;

diff --git a/Source/ARTAuth.m b/Source/ARTAuth.m
@@ -311,6 +311,10 @@ - (void)executeTokenRequest:(ARTTokenRequest *)tokenRequest callback:(void (^)(A
 }
 
 - (void)authorise:(ARTTokenParams *)tokenParams options:(ARTAuthOptions *)authOptions callback:(void (^)(ARTTokenDetails *, NSError *))callback {
+    [self authorize:tokenParams options:authOptions callback:callback];
+}
+
+- (void)authorize:(ARTTokenParams *)tokenParams options:(ARTAuthOptions *)authOptions callback:(void (^)(ARTTokenDetails *, NSError *))callback {
     BOOL requestNewToken = NO;
 
     ARTAuthOptions *replacedOptions;

diff --git a/Source/ARTRest.m b/Source/ARTRest.m
@@ -212,7 +212,7 @@ - (void)prepareAuthorisationHeader:(ARTAuthMethod)method force:(BOOL)force compl
     }
     else {
         self.options.force = force;
-        [self.auth authorise:nil options:self.options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
+        [self.auth authorize:nil options:self.options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
             if (error) {
                 if (callback) callback(nil, error);
                 return;

diff --git a/Source/ARTWebSocketTransport.m b/Source/ARTWebSocketTransport.m
@@ -105,7 +105,7 @@ - (void)connectForcingNewToken:(BOOL)forceNewToken {
         [self.logger debug:__FILE__ line:__LINE__ message:@"R:%p WS:%p connecting with token auth; authorising", _delegate, self];
         __weak ARTWebSocketTransport *selfWeak = self;
         // Token
-        [self.auth authorise:nil options:options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
+        [self.auth authorize:nil options:options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
             [self.logger debug:__FILE__ line:__LINE__ message:@"R:%p WS:%p authorised: %@ error: %@", _delegate, self, tokenDetails, error];
             ARTWebSocketTransport *selfStrong = selfWeak;
             if (!selfStrong) return;

diff --git a/Spec/Auth.swift b/Spec/Auth.swift
diff --git a/Spec/RestClient.swift b/Spec/RestClient.swift
@@ -374,7 +374,7 @@ class RestClient: QuickSpec {
                 options.tokenDetails = getTestTokenDetails()
 
                 waitUntil(timeout: testTimeout) { done in
-                    ARTRest(options: options).auth.authorise(nil, options: nil) { tokenDetails, error in
+                    ARTRest(options: options).auth.authorize(nil, options: nil) { tokenDetails, error in
                         if let e = error {
                             XCTFail(e.description)
                             done()

diff --git a/Tests/ARTRealtimeAttachTest.m b/Tests/ARTRealtimeAttachTest.m
@@ -342,7 +342,7 @@ - (void)testPresenceEnterRestricted {
     ARTTokenParams *tokenParams = [[ARTTokenParams alloc] initWithClientId:options.clientId];
     tokenParams.capability = @"{\"canpublish:*\":[\"publish\"],\"canpublish:andpresence\":[\"presence\",\"publish\"],\"cansubscribe:*\":[\"subscribe\"]}";
 
-    [realtime.auth authorise:tokenParams options:options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
+    [realtime.auth authorize:tokenParams options:options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
         options.token = tokenDetails.token;
         [realtime connect];
     }];

diff --git a/Tests/ARTRestCapabilityTest.m b/Tests/ARTRestCapabilityTest.m
@@ -45,7 +45,7 @@ - (void)testPublishRestricted {
     ARTTokenParams *tokenParams = [[ARTTokenParams alloc] initWithClientId:options.clientId];
     tokenParams.capability = @"{\"canpublish:*\":[\"publish\"],\"canpublish:andpresence\":[\"presence\",\"publish\"],\"cansubscribe:*\":[\"subscribe\"]}";
 
-    [[[ARTRest alloc] initWithOptions:options].auth authorise:tokenParams options:options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
+    [[[ARTRest alloc] initWithOptions:options].auth authorize:tokenParams options:options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
         options.token = tokenDetails.token;
         ARTRest *rest = [[ARTRest alloc] initWithOptions:options];
         ARTRestChannel *channel = [rest.channels get:@"canpublish:test"];