Remove 'Auth' prefix from TokenDetails, TokenRequest, TokenParams.

ably · Feb 8, 2016 · 239630d · 239630d
1 parent 493c0f3
commit 239630d
Show file tree

Hide file tree

Showing 25 changed files with 175 additions and 175 deletions.
diff --git a/ably-ios/ARTAuth+Private.h b/ably-ios/ARTAuth+Private.h
@@ -13,13 +13,13 @@ ART_ASSUME_NONNULL_BEGIN
 @interface ARTAuth (Private)
 
 - (ARTAuthOptions *)mergeOptions:(ARTAuthOptions *)customOptions;
-- (ARTAuthTokenParams *)mergeParams:(ARTAuthTokenParams *)customParams;
+- (ARTTokenParams *)mergeParams:(ARTTokenParams *)customParams;
 
-- (NSURL *)buildURL:(ARTAuthOptions *)options withParams:(ARTAuthTokenParams *)params;
-- (NSMutableURLRequest *)buildRequest:(ARTAuthOptions *)options withParams:(ARTAuthTokenParams *)params;
+- (NSURL *)buildURL:(ARTAuthOptions *)options withParams:(ARTTokenParams *)params;
+- (NSMutableURLRequest *)buildRequest:(ARTAuthOptions *)options withParams:(ARTTokenParams *)params;
 
-// Execute the received ARTAuthTokenRequest
-- (void)executeTokenRequest:(ARTAuthTokenRequest *)tokenRequest callback:(void (^)(ARTAuthTokenDetails *__art_nullable tokenDetails, NSError *__art_nullable error))callback;
+// Execute the received ARTTokenRequest
+- (void)executeTokenRequest:(ARTTokenRequest *)tokenRequest callback:(void (^)(ARTTokenDetails *__art_nullable tokenDetails, NSError *__art_nullable error))callback;
 
 // CONNECTED ProtocolMessage may contain a clientId
 - (void)setProtocolClientId:(NSString *)clientId;

diff --git a/ably-ios/ARTAuth.h b/ably-ios/ARTAuth.h
@@ -14,9 +14,9 @@
 @class ARTLog;
 @class ARTClientOptions;
 @class ARTAuthOptions;
-@class ARTAuthTokenParams;
-@class ARTAuthTokenDetails;
-@class ARTAuthTokenRequest;
+@class ARTTokenParams;
+@class ARTTokenDetails;
+@class ARTTokenRequest;
 
 ART_ASSUME_NONNULL_BEGIN
 
@@ -30,7 +30,7 @@ ART_ASSUME_NONNULL_BEGIN
 @property (nonatomic, weak) ARTLog *logger;
 
 @property (art_nullable, readonly, getter=getClientId) NSString *clientId;
-@property (art_nullable, nonatomic, readonly, strong) ARTAuthTokenDetails *tokenDetails;
+@property (art_nullable, nonatomic, readonly, strong) ARTTokenDetails *tokenDetails;
 
 // FIXME: review (Why rest?)
 - (instancetype)init:(ARTRest *)rest withOptions:(ARTClientOptions *)options;
@@ -45,15 +45,15 @@ ART_ASSUME_NONNULL_BEGIN
  
  - Parameter tokenParams: Token params (optional).
  - Parameter authOptions: Authentication options (optional).
- - Parameter callback: Completion callback (ARTAuthTokenDetails, NSError).
+ - Parameter callback: Completion callback (ARTTokenDetails, NSError).
  */
-- (void)requestToken:(art_nullable ARTAuthTokenParams *)tokenParams withOptions:(art_nullable ARTAuthOptions *)authOptions
+- (void)requestToken:(art_nullable ARTTokenParams *)tokenParams withOptions:(art_nullable ARTAuthOptions *)authOptions
             callback:(ARTTokenCallback)callback;
 
-- (void)authorise:(art_nullable ARTAuthTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)authOptions callback:(ARTTokenCallback)callback;
+- (void)authorise:(art_nullable ARTTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)authOptions callback:(ARTTokenCallback)callback;
 
-- (void)createTokenRequest:(art_nullable ARTAuthTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)options
-                  callback:(void (^)(ARTAuthTokenRequest *__art_nullable tokenRequest, NSError *__art_nullable error))callback;
+- (void)createTokenRequest:(art_nullable ARTTokenParams *)tokenParams options:(art_nullable ARTAuthOptions *)options
+                  callback:(void (^)(ARTTokenRequest *__art_nullable tokenRequest, NSError *__art_nullable error))callback;
 
 @end
 

diff --git a/ably-ios/ARTAuth.m b/ably-ios/ARTAuth.m
@@ -13,15 +13,15 @@
 #import "ARTHttp.h"
 #import "ARTClientOptions.h"
 #import "ARTAuthOptions.h"
-#import "ARTAuthTokenDetails.h"
-#import "ARTAuthTokenParams.h"
-#import "ARTAuthTokenRequest.h"
+#import "ARTTokenDetails.h"
+#import "ARTTokenParams.h"
+#import "ARTTokenRequest.h"
 #import "ARTEncoder.h"
 #import "ARTStatus.h"
 
 @implementation ARTAuth {
     __weak ARTRest *_rest;
-    ARTAuthTokenParams *_tokenParams;
+    ARTTokenParams *_tokenParams;
     // Dedicated to Protocol Message
     NSString *_protocolClientId;
 }
@@ -30,7 +30,7 @@ - (instancetype)init:(ARTRest *)rest withOptions:(ARTClientOptions *)options {
     if (self = [super init]) {
         _rest = rest;
         _tokenDetails = options.tokenDetails;
-        _tokenParams = [[ARTAuthTokenParams alloc] initWithClientId:options.clientId];
+        _tokenParams = [[ARTTokenParams alloc] initWithClientId:options.clientId];
         _options = options;
         _logger = rest.logger;
         _protocolClientId = nil;
@@ -58,7 +58,7 @@ - (void)validate:(ARTClientOptions *)options {
         // Token
         [self.logger debug:__FILE__ line:__LINE__ message:@"setting up auth method Token with supplied token only"];
         _method = ARTAuthMethodToken;
-        options.tokenDetails = [[ARTAuthTokenDetails alloc] initWithToken:options.token];
+        options.tokenDetails = [[ARTTokenDetails alloc] initWithToken:options.token];
     } else if (options.authUrl && options.authCallback) {
         [NSException raise:@"ARTAuthException" format:@"Incompatible authentication configuration: please specify either authCallback and authUrl."];
     } else if (options.authUrl) {
@@ -98,17 +98,17 @@ - (void)storeOptions:(ARTAuthOptions *)customOptions {
     self.options.queryTime = customOptions.queryTime;
 }
 
-- (ARTAuthTokenParams *)mergeParams:(ARTAuthTokenParams *)customParams {
+- (ARTTokenParams *)mergeParams:(ARTTokenParams *)customParams {
     return customParams ? customParams : _tokenParams;
 }
 
-- (void)storeParams:(ARTAuthTokenParams *)customOptions {
+- (void)storeParams:(ARTTokenParams *)customOptions {
     _tokenParams.clientId = customOptions.clientId;
     _tokenParams.ttl = customOptions.ttl;
     _tokenParams.capability = customOptions.capability;
 }
 
-- (NSURL *)buildURL:(ARTAuthOptions *)options withParams:(ARTAuthTokenParams *)params {
+- (NSURL *)buildURL:(ARTAuthOptions *)options withParams:(ARTTokenParams *)params {
     NSURLComponents *urlComponents = [NSURLComponents componentsWithURL:options.authUrl resolvingAgainstBaseURL:YES];
 
     if ([options isMethodGET]) {
@@ -122,7 +122,7 @@ - (NSURL *)buildURL:(ARTAuthOptions *)options withParams:(ARTAuthTokenParams *)p
     return urlComponents.URL;
 }
 
-- (NSMutableURLRequest *)buildRequest:(ARTAuthOptions *)options withParams:(ARTAuthTokenParams *)params {
+- (NSMutableURLRequest *)buildRequest:(ARTAuthOptions *)options withParams:(ARTTokenParams *)params {
     NSURL *url = [self buildURL:options withParams:params];
     NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:url];
     request.HTTPMethod = options.authMethod;
@@ -148,12 +148,12 @@ - (NSMutableURLRequest *)buildRequest:(ARTAuthOptions *)options withParams:(ARTA
     return request;
 }
 
-- (void)requestToken:(ARTAuthTokenParams *)tokenParams withOptions:(ARTAuthOptions *)authOptions
-            callback:(void (^)(ARTAuthTokenDetails *, NSError *))callback {
+- (void)requestToken:(ARTTokenParams *)tokenParams withOptions:(ARTAuthOptions *)authOptions
+            callback:(void (^)(ARTTokenDetails *, NSError *))callback {
 
     // The values supersede matching client library configured params and options.
     ARTAuthOptions *mergedOptions = [self mergeOptions:authOptions];
-    ARTAuthTokenParams *currentTokenParams = [self mergeParams:tokenParams];
+    ARTTokenParams *currentTokenParams = [self mergeParams:tokenParams];
     tokenParams.timestamp = [NSDate date];
 
     if (mergedOptions.authUrl) {
@@ -170,9 +170,9 @@ - (void)requestToken:(ARTAuthTokenParams *)tokenParams withOptions:(ARTAuthOptio
             }
         }];
     } else {
-        ARTAuthCallback tokenRequestFactory = mergedOptions.authCallback? : ^(ARTAuthTokenParams *tokenParams, void(^callback)(ARTAuthTokenDetails *tokenDetails, NSError *error)) {
+        ARTAuthCallback tokenRequestFactory = mergedOptions.authCallback? : ^(ARTTokenParams *tokenParams, void(^callback)(ARTTokenDetails *tokenDetails, NSError *error)) {
             // Create a TokenRequest and execute it
-            [self createTokenRequest:currentTokenParams options:mergedOptions callback:^(ARTAuthTokenRequest *tokenRequest, NSError *error) {
+            [self createTokenRequest:currentTokenParams options:mergedOptions callback:^(ARTTokenRequest *tokenRequest, NSError *error) {
                 if (error) {
                     callback(nil, error);
                 } else {
@@ -189,11 +189,11 @@ - (void)requestToken:(ARTAuthTokenParams *)tokenParams withOptions:(ARTAuthOptio
     }
 }
 
-- (void)handleAuthUrlResponse:(NSHTTPURLResponse *)response withData:(NSData *)data completion:(void (^)(ARTAuthTokenDetails *, NSError *))callback {
+- (void)handleAuthUrlResponse:(NSHTTPURLResponse *)response withData:(NSData *)data completion:(void (^)(ARTTokenDetails *, NSError *))callback {
     // The token retrieved is assumed by the library to be a token string if the response has Content-Type "text/plain", or taken to be a TokenRequest or TokenDetails object if the response has Content-Type "application/json"
     if ([response.MIMEType isEqualToString:@"application/json"]) {
         NSError *decodeError = nil;
-        ARTAuthTokenDetails *tokenDetails = [_rest.defaultEncoder decodeAccessToken:data error:&decodeError];
+        ARTTokenDetails *tokenDetails = [_rest.defaultEncoder decodeAccessToken:data error:&decodeError];
         if (decodeError) {
             callback(nil, decodeError);
         } else {
@@ -206,15 +206,15 @@ - (void)handleAuthUrlResponse:(NSHTTPURLResponse *)response withData:(NSData *)d
             callback(nil, [NSError errorWithDomain:ARTAblyErrorDomain code:NSURLErrorCancelled userInfo:@{NSLocalizedDescriptionKey:@"authUrl: token is empty"}]);
             return;
         }
-        ARTAuthTokenDetails *tokenDetails = [[ARTAuthTokenDetails alloc] initWithToken:token];
+        ARTTokenDetails *tokenDetails = [[ARTTokenDetails alloc] initWithToken:token];
         callback(tokenDetails, nil);
     }
     else {
         callback(nil, [NSError errorWithDomain:ARTAblyErrorDomain code:NSURLErrorCancelled userInfo:@{NSLocalizedDescriptionKey:@"authUrl: invalid MIME type"}]);
     }
 }
 
-- (void)executeTokenRequest:(ARTAuthTokenRequest *)tokenRequest callback:(void (^)(ARTAuthTokenDetails *, NSError *))callback {
+- (void)executeTokenRequest:(ARTTokenRequest *)tokenRequest callback:(void (^)(ARTTokenDetails *, NSError *))callback {
     NSURL *requestUrl = [NSURL URLWithString:[NSString stringWithFormat:@"/keys/%@/requestToken", tokenRequest.keyName]
                                relativeToURL:_rest.baseUrl];
 
@@ -232,7 +232,7 @@ - (void)executeTokenRequest:(ARTAuthTokenRequest *)tokenRequest callback:(void (
             callback(nil, error);
         } else {
             NSError *decodeError = nil;
-            ARTAuthTokenDetails *tokenDetails = [defaultEncoder decodeAccessToken:data error:&decodeError];
+            ARTTokenDetails *tokenDetails = [defaultEncoder decodeAccessToken:data error:&decodeError];
             if (decodeError) {
                 callback(nil, decodeError);
             } else {
@@ -242,11 +242,11 @@ - (void)executeTokenRequest:(ARTAuthTokenRequest *)tokenRequest callback:(void (
     }];
 }
 
-- (void)authorise:(ARTAuthTokenParams *)tokenParams options:(ARTAuthOptions *)authOptions callback:(void (^)(ARTAuthTokenDetails *, NSError *))callback {
+- (void)authorise:(ARTTokenParams *)tokenParams options:(ARTAuthOptions *)authOptions callback:(void (^)(ARTTokenDetails *, NSError *))callback {
     BOOL requestNewToken = NO;
     ARTAuthOptions *mergedOptions = [self mergeOptions:authOptions];
     [self storeOptions:mergedOptions];
-    ARTAuthTokenParams *currentTokenParams = [self mergeParams:tokenParams];
+    ARTTokenParams *currentTokenParams = [self mergeParams:tokenParams];
     [self storeParams:currentTokenParams];
 
     // Reuse or not reuse the current token
@@ -273,7 +273,7 @@ - (void)authorise:(ARTAuthTokenParams *)tokenParams options:(ARTAuthOptions *)au
     }
 
     if (requestNewToken) {
-        [self requestToken:currentTokenParams withOptions:mergedOptions callback:^(ARTAuthTokenDetails *tokenDetails, NSError *error) {
+        [self requestToken:currentTokenParams withOptions:mergedOptions callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
             if (error) {
                 if (callback) {
                     callback(nil, error);
@@ -292,9 +292,9 @@ - (void)authorise:(ARTAuthTokenParams *)tokenParams options:(ARTAuthOptions *)au
     }
 }
 
-- (void)createTokenRequest:(ARTAuthTokenParams *)tokenParams options:(ARTAuthOptions *)options callback:(void (^)(ARTAuthTokenRequest *, NSError *))callback {
+- (void)createTokenRequest:(ARTTokenParams *)tokenParams options:(ARTAuthOptions *)options callback:(void (^)(ARTTokenRequest *, NSError *))callback {
     ARTAuthOptions *mergedOptions = [self mergeOptions:options];
-    ARTAuthTokenParams *mergedTokenParams = [self mergeParams:tokenParams];
+    ARTTokenParams *mergedTokenParams = [self mergeParams:tokenParams];
 
     // Validate: Capability JSON text
     NSError *errorCapability;

diff --git a/ably-ios/ARTAuthOptions.h b/ably-ios/ARTAuthOptions.h
@@ -9,7 +9,7 @@
 #import <Foundation/Foundation.h>
 #import <Ably/ARTTypes.h>
 
-@class ARTAuthTokenDetails;
+@class ARTTokenDetails;
 
 ART_ASSUME_NONNULL_BEGIN
 
@@ -28,7 +28,7 @@ ART_ASSUME_NONNULL_BEGIN
 /**
  An authentication token issued for this application against a specific key and `TokenParams`.
  */
-@property (nonatomic, strong, art_nullable) ARTAuthTokenDetails *tokenDetails;
+@property (nonatomic, strong, art_nullable) ARTTokenDetails *tokenDetails;
 
 /**
  A callback to call to obtain a signed token request.

diff --git a/ably-ios/ARTAuthOptions.m b/ably-ios/ARTAuthOptions.m
@@ -8,7 +8,7 @@
 
 #import "ARTAuthOptions.h"
 
-#import "ARTAuthTokenDetails.h"
+#import "ARTTokenDetails.h"
 
 @implementation ARTAuthOptions
 
@@ -82,7 +82,7 @@ - (NSString *)token {
 
 - (void)setToken:(NSString *)token {
     if (token && ![token isEqualToString:@""]) {
-        self.tokenDetails = [[ARTAuthTokenDetails alloc] initWithToken:token];
+        self.tokenDetails = [[ARTTokenDetails alloc] initWithToken:token];
     }
 }
 

diff --git a/ably-ios/ARTEncoder.h b/ably-ios/ARTEncoder.h
@@ -12,8 +12,8 @@
 @class ARTMessage;
 @class ARTPresenceMessage;
 @class ARTProtocolMessage;
-@class ARTAuthTokenDetails;
-@class ARTAuthTokenRequest;
+@class ARTTokenDetails;
+@class ARTTokenRequest;
 
 typedef NS_ENUM(NSUInteger, ARTEncoderFormat) {
     ARTEncoderFormatJson,
@@ -28,10 +28,10 @@ ART_ASSUME_NONNULL_BEGIN
 - (ARTEncoderFormat)format;
 - (NSString *)formatAsString;
 
-- (art_nullable NSData *)encodeTokenRequest:(ARTAuthTokenRequest *)request;
-- (art_nullable NSData *)encodeTokenDetails:(ARTAuthTokenDetails *)tokenDetails;
+- (art_nullable NSData *)encodeTokenRequest:(ARTTokenRequest *)request;
+- (art_nullable NSData *)encodeTokenDetails:(ARTTokenDetails *)tokenDetails;
 
-- (art_nullable ARTAuthTokenDetails *)decodeAccessToken:(NSData *)data error:(NSError * __autoreleasing *)error;
+- (art_nullable ARTTokenDetails *)decodeAccessToken:(NSData *)data error:(NSError * __autoreleasing *)error;
 - (art_nullable ARTMessage *)decodeMessage:(NSData *)data;
 - (art_nullable NSArray *)decodeMessages:(NSData *)data;
 - (art_nullable NSData *)encodeMessage:(ARTMessage *)message;

diff --git a/ably-ios/ARTJsonEncoder.m b/ably-ios/ARTJsonEncoder.m
@@ -19,8 +19,8 @@
 #import "ARTLog.h"
 #import "ARTHttp.h"
 #import "ARTStatus.h"
-#import "ARTAuthTokenDetails.h"
-#import "ARTAuthTokenRequest.h"
+#import "ARTTokenDetails.h"
+#import "ARTTokenRequest.h"
 #import "ARTConnectionDetails.h"
 
 @interface ARTJsonEncoder ()
@@ -40,7 +40,7 @@ - (NSArray *)presenceMessagesToArray:(NSArray *)messages;
 - (NSDictionary *)protocolMessageToDictionary:(ARTProtocolMessage *)message;
 - (ARTProtocolMessage *)protocolMessageFromDictionary:(NSDictionary *)input;
 
-- (NSDictionary *)tokenRequestToDictionary:(ARTAuthTokenRequest *)tokenRequest;
+- (NSDictionary *)tokenRequestToDictionary:(ARTTokenRequest *)tokenRequest;
 
 - (NSArray *)statsFromArray:(NSArray *)input;
 - (ARTStats *)statsFromDictionary:(NSDictionary *)input;
@@ -122,15 +122,15 @@ - (ARTProtocolMessage *)decodeProtocolMessage:(NSData *)data {
     return [self protocolMessageFromDictionary:[self decodeDictionary:data]];
 }
 
-- (ARTAuthTokenDetails *)decodeAccessToken:(NSData *)data error:(NSError * __autoreleasing *)error {
+- (ARTTokenDetails *)decodeAccessToken:(NSData *)data error:(NSError * __autoreleasing *)error {
     return [self tokenFromDictionary:[self decodeDictionary:data] error:error];
 }
 
-- (NSData *)encodeTokenRequest:(ARTAuthTokenRequest *)request {
+- (NSData *)encodeTokenRequest:(ARTTokenRequest *)request {
     return [self encode:[self tokenRequestToDictionary:request]];
 }
 
-- (NSData *)encodeTokenDetails:(ARTAuthTokenDetails *)tokenDetails {
+- (NSData *)encodeTokenDetails:(ARTTokenDetails *)tokenDetails {
     return [self encode:[self tokenDetailsToDictionary:tokenDetails]];
 }
 
@@ -352,7 +352,7 @@ - (NSDictionary *)protocolMessageToDictionary:(ARTProtocolMessage *)message {
     return output;
 }
 
-- (ARTAuthTokenDetails *)tokenFromDictionary:(NSDictionary *)input error:(NSError * __autoreleasing *)error {
+- (ARTTokenDetails *)tokenFromDictionary:(NSDictionary *)input error:(NSError * __autoreleasing *)error {
     [self.logger verbose:@"ARTJsonEncoder: tokenFromDictionary %@", input];
 
     if (![input isKindOfClass:[NSDictionary class]]) {
@@ -379,15 +379,15 @@ - (ARTAuthTokenDetails *)tokenFromDictionary:(NSDictionary *)input error:(NSErro
     NSNumber *issuedInterval = [input artNumber:@"issued"];
     NSDate *issued = issuedInterval ? [NSDate dateWithTimeIntervalSince1970:issuedInterval.longLongValue / 1000] : nil;
 
-    return [[ARTAuthTokenDetails alloc] initWithToken:token
+    return [[ARTTokenDetails alloc] initWithToken:token
                                               expires:expires
                                                issued:issued
                                            capability:[input artString:@"capability"]
                                              clientId:[input artString:@"clientId"]];
 
 }
 
-- (NSDictionary *)tokenRequestToDictionary:(ARTAuthTokenRequest *)tokenRequest {
+- (NSDictionary *)tokenRequestToDictionary:(ARTTokenRequest *)tokenRequest {
     [self.logger verbose:@"ARTJsonEncoder: tokenRequestToDictionary %@", tokenRequest];
 
     NSNumber *timestamp;
@@ -412,7 +412,7 @@ - (NSDictionary *)tokenRequestToDictionary:(ARTAuthTokenRequest *)tokenRequest {
     return dictionary;
 }
 
-- (NSDictionary *)tokenDetailsToDictionary:(ARTAuthTokenDetails *)tokenDetails {
+- (NSDictionary *)tokenDetailsToDictionary:(ARTTokenDetails *)tokenDetails {
     NSMutableDictionary *dictionary = [NSMutableDictionary dictionary];
 
     dictionary[@"token"] = tokenDetails.token;

diff --git a/ably-ios/ARTRest.m b/ably-ios/ARTRest.m
@@ -27,8 +27,8 @@
 #import "ARTNSDictionary+ARTDictionaryUtil.h"
 #import "ARTNSArray+ARTFunctional.h"
 #import "ARTRestChannel.h"
-#import "ARTAuthTokenParams.h"
-#import "ARTAuthTokenDetails.h"
+#import "ARTTokenParams.h"
+#import "ARTTokenDetails.h"
 
 @interface ARTRest ()
 
@@ -179,7 +179,7 @@ - (void)calculateAuthorization:(ARTAuthMethod)method force:(BOOL)force completio
     }
     else {
         self.options.force = force;
-        [self.auth authorise:nil options:self.options callback:^(ARTAuthTokenDetails *tokenDetails, NSError *error) {
+        [self.auth authorise:nil options:self.options callback:^(ARTTokenDetails *tokenDetails, NSError *error) {
             if (error) {
                 if (callback) callback(nil, error);
                 return;

diff --git a/ably-ios/ARTRestChannel.m b/ably-ios/ARTRestChannel.m
@@ -18,7 +18,7 @@
 #import "ARTDataQuery+Private.h"
 #import "ARTJsonEncoder.h"
 #import "ARTAuth.h"
-#import "ARTAuthTokenDetails.h"
+#import "ARTTokenDetails.h"
 #import "ARTNSArray+ARTFunctional.h"
 
 @implementation ARTRestChannel {