buildRequest function to avoid duplication while preparing rest requests.

Author: maratal

Source/ARTAuth.m

@@ -493,21 +493,19 @@ - (void)handleAuthUrlResponse:(NSHTTPURLResponse *)response
 - (NSObject<ARTCancellable> *)executeTokenRequest:(ARTTokenRequest *)tokenRequest
                                          callback:(ARTTokenDetailsCallback)callback {
     id<ARTEncoder> encoder = _rest.defaultEncoder;
-
-    NSURL *requestUrl = [NSURL URLWithString:[NSString stringWithFormat:@"/keys/%@/requestToken?format=%@", tokenRequest.keyName, [encoder formatAsString]]
-                               relativeToURL:_rest.baseUrl];
-    
-    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:requestUrl];
-    request.HTTPMethod = @"POST";
-
     NSError *encodeError = nil;
-    request.HTTPBody = [encoder encodeTokenRequest:tokenRequest error:&encodeError];
+    NSData *bodyData = [encoder encodeTokenRequest:tokenRequest error:&encodeError];
     if (encodeError) {
         callback(nil, encodeError);
         return nil;
     }
-    [request setValue:[encoder mimeType] forHTTPHeaderField:@"Accept"];
-    [request setValue:[encoder mimeType] forHTTPHeaderField:@"Content-Type"];
+    
+    NSMutableURLRequest *request = [_rest buildRequest:@"POST"
+                                                  path:[NSString stringWithFormat:@"/keys/%@/requestToken", tokenRequest.keyName]
+                                               baseUrl:nil
+                                                params:@{ @"format": encoder.formatAsString }
+                                                  body:bodyData
+                                               headers:nil];
 
     return [_rest executeAblyRequest:request withAuthOption:ARTAuthenticationOff wrapperSDKAgents:nil completion:^(NSHTTPURLResponse *response, NSData *data, NSError *error) {
         if (error) {

Source/ARTDataQuery.m

@@ -38,6 +38,22 @@ - (NSMutableArray *)asQueryItems:(NSError *_Nullable*)error {
     return items;
 }
 
+- (NSStringDictionary *)asQueryParams {
+    NSMutableDictionary *items = [NSMutableDictionary dictionary];
+
+    if (self.start) {
+        items[@"start"] = [NSString stringWithFormat:@"%llu", dateToMilliseconds(self.start)];
+    }
+    if (self.end) {
+        items[@"end"] = [NSString stringWithFormat:@"%llu", dateToMilliseconds(self.end)];
+    }
+    
+    items[@"limit"] = [NSString stringWithFormat:@"%hu", self.limit];
+    items[@"direction"] = queryDirectionToString(self.direction);
+
+    return items;
+}
+
 @end
 
 @implementation ARTRealtimeHistoryQuery

Source/ARTNSString+ARTUtil.m

@@ -17,4 +17,18 @@ - (BOOL)isNotEmptyString {
     return ![self isEmptyString];
 }
 
+- (NSString *)encodePathSegment {
+    // Source: https://datatracker.ietf.org/doc/html/rfc3986#section-3.3
+    // i.e. segment = unreserved / pct-encoded / sub-delims / ":" / "@", where
+    //  unreserved = ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~
+    //  pct-encoded = %XX
+    //  sub-delims = !$&'()*+,;=
+    NSCharacterSet *allowedSet = [NSCharacterSet characterSetWithCharactersInString:@"ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz0123456789-._~!$&'()*+,;=:@"];
+    NSString *escaped = [self stringByAddingPercentEncodingWithAllowedCharacters:allowedSet];
+    if (!escaped) {
+        [NSException raise:NSInternalInconsistencyException format:@"String '%@' can't be percent encoded.", self];
+    }
+    return escaped;
+}
+
 @end

Source/ARTRest.m

@@ -495,7 +495,9 @@ - (NSString *)agentIdentifierWithWrapperSDKAgents:(nullable NSDictionary<NSStrin
         if (![mutableRequest valueForHTTPHeaderField:@"X-Ably-Version"]) {
             [mutableRequest setValue:[ARTDefault apiVersion] forHTTPHeaderField:@"X-Ably-Version"];
         }
+        
         [mutableRequest setValue:[self agentIdentifierWithWrapperSDKAgents:wrapperSDKAgents] forHTTPHeaderField:@"Ably-Agent"];
+        
         if (_options.clientId && !self.auth.isTokenAuth) {
             [mutableRequest setValue:encodeBase64(_options.clientId) forHTTPHeaderField:@"X-Ably-ClientId"];
         }
@@ -607,11 +609,12 @@ - (void)timeWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
 
 - (NSObject<ARTCancellable> *)_timeWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
                                              completion:(ARTDateTimeCallback)callback {
-    NSURL *requestUrl = [NSURL URLWithString:@"/time" relativeToURL:self.baseUrl];
-    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:requestUrl];
-    request.HTTPMethod = @"GET";
-    NSString *accept = [[_encoders.allValues valueForKeyPath:@"mimeType"] componentsJoinedByString:@","];
-    [request setValue:accept forHTTPHeaderField:@"Accept"];
+    NSMutableURLRequest *request = [self buildRequest:@"GET"
+                                                 path:@"/time"
+                                              baseUrl:self.baseUrl
+                                               params:nil
+                                                 body:nil
+                                              headers:nil];
 
     return [self executeAblyRequest:request withAuthOption:ARTAuthenticationOff wrapperSDKAgents:wrapperSDKAgents completion:^(NSHTTPURLResponse *response, NSData *data, NSError *error) {
         if (error) {
@@ -631,67 +634,41 @@ - (void)timeWithWrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
     }];
 }
 
-- (BOOL)request:(NSString *)method
-           path:(NSString *)path
-         params:(nullable NSStringDictionary *)params
-           body:(nullable id)body
-        headers:(nullable NSStringDictionary *)headers
-wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
-       callback:(ARTHTTPPaginatedCallback)callback
-          error:(NSError **)errorPtr {
-    
-    if (callback) {
-        void (^userCallback)(ARTHTTPPaginatedResponse *, ARTErrorInfo *) = callback;
-        callback = ^(ARTHTTPPaginatedResponse *r, ARTErrorInfo *e) {
-            art_dispatch_async(self->_userQueue, ^{
-                userCallback(r, e);
-            });
-        };
+- (NSMutableURLRequest *)buildRequest:(NSString *)method
+                                 path:(NSString *)path
+                              baseUrl:(nullable NSURL *)baseUrl
+                               params:(nullable NSStringDictionary *)params
+                                 body:(nullable id)body
+                              headers:(nullable NSStringDictionary *)headers {
+    if (![@[@"get", @"post", @"patch", @"put", @"delete"] containsObject:method.lowercaseString]) {
+        @throw [NSException exceptionWithName:NSInternalInconsistencyException
+                                       reason:[NSString stringWithFormat:@"Method %@ isn't valid.", method]
+                                     userInfo:nil];
     }
 
-    if (![[method lowercaseString] isEqualToString:@"get"] &&
-        ![[method lowercaseString] isEqualToString:@"post"] &&
-        ![[method lowercaseString] isEqualToString:@"patch"] &&
-        ![[method lowercaseString] isEqualToString:@"put"] &&
-        ![[method lowercaseString] isEqualToString:@"delete"]) {
-        if (errorPtr) {
-            *errorPtr = [NSError errorWithDomain:ARTAblyErrorDomain
-                                            code:ARTCustomRequestErrorInvalidMethod
-                                        userInfo:@{NSLocalizedDescriptionKey:@"Method isn't valid."}];
-        }
-        return NO;
+    if (body && ![body isKindOfClass:[NSDictionary class]] && ![body isKindOfClass:[NSArray class]]) {
+        @throw [NSException exceptionWithName:NSInternalInconsistencyException
+                                       reason:@"Body should be a Dictionary or an Array."
+                                     userInfo:nil];
     }
 
-    if (body &&
-        ![body isKindOfClass:[NSDictionary class]] &&
-        ![body isKindOfClass:[NSArray class]]) {
-        if (errorPtr) {
-            *errorPtr = [NSError errorWithDomain:ARTAblyErrorDomain
-                                            code:ARTCustomRequestErrorInvalidBody
-                                        userInfo:@{NSLocalizedDescriptionKey:@"Body should be a Dictionary or an Array."}];
-        }
-        return NO;
+    if ([[path stringByTrimmingCharactersInSet:NSCharacterSet.whitespaceAndNewlineCharacterSet] isEqualToString:@""]) {
+        @throw [NSException exceptionWithName:NSInternalInconsistencyException
+                                       reason:@"Path cannot be empty."
+                                     userInfo:nil];
     }
-
-    if ([[path stringByTrimmingCharactersInSet:[NSCharacterSet whitespaceAndNewlineCharacterSet]] isEqualToString:@""]) {
-        if (errorPtr) {
-            *errorPtr = [NSError errorWithDomain:ARTAblyErrorDomain
-                                            code:ARTCustomRequestErrorInvalidPath
-                                        userInfo:@{NSLocalizedDescriptionKey:@"Path cannot be empty."}];
-        }
-        return NO;
+    
+    if (baseUrl == nil) {
+        baseUrl = self.baseUrl;
     }
 
-    NSURL *url = [NSURL URLWithString:path relativeToURL:self.baseUrl];
+    NSURL *url = [NSURL URLWithString:path relativeToURL:baseUrl];
     // Should not happen in iOS 17 and above. See explanation in the "Important" section here:
     // https://developer.apple.com/documentation/foundation/nsurl/1572047-urlwithstring
     if (!url) {
-        if (errorPtr) {
-            *errorPtr = [NSError errorWithDomain:ARTAblyErrorDomain
-                                            code:ARTCustomRequestErrorInvalidPath
-                                        userInfo:@{NSLocalizedDescriptionKey:@"Path isn't valid for an URL."}];
-        }
-        return NO;
+        @throw [NSException exceptionWithName:NSInternalInconsistencyException
+                                       reason:@"Path isn't valid for an URL."
+                                     userInfo:nil];
     }
 
     NSURLComponents *components = [[NSURLComponents alloc] initWithURL:url resolvingAgainstBaseURL:YES];
@@ -705,7 +682,7 @@ - (BOOL)request:(NSString *)method
     components.queryItems = queryItems;
 
     NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[components URL]];
-    request.HTTPMethod = method;
+    request.HTTPMethod = method.uppercaseString;
 
     [headers enumerateKeysAndObjectsUsingBlock:^(NSString *key, NSString *value, BOOL *stop) {
         [request addValue:value forHTTPHeaderField:key];
@@ -717,13 +694,42 @@ - (BOOL)request:(NSString *)method
 
         request.HTTPBody = bodyData;
         [request setValue:[self.defaultEncoder mimeType] forHTTPHeaderField:@"Content-Type"];
-        if ([[method lowercaseString] isEqualToString:@"post"]) {
+        if ([@[@"post", @"patch", @"put"] containsObject:method.lowercaseString]) {
             [request setValue:[NSString stringWithFormat:@"%d", (unsigned int)bodyData.length] forHTTPHeaderField:@"Content-Length"];
         }
     }
 
+    [request setTimeoutInterval:_options.httpRequestTimeout];
     [request setAcceptHeader:self.defaultEncoder encoders:self.encoders];
 
+    return request;
+}
+
+- (BOOL)request:(NSString *)method
+           path:(NSString *)path
+         params:(nullable NSStringDictionary *)params
+           body:(nullable id)body
+        headers:(nullable NSStringDictionary *)headers
+wrapperSDKAgents:(nullable NSStringDictionary *)wrapperSDKAgents
+       callback:(ARTHTTPPaginatedCallback)callback
+          error:(NSError **)errorPtr {
+    
+    if (callback) {
+        void (^userCallback)(ARTHTTPPaginatedResponse *, ARTErrorInfo *) = callback;
+        callback = ^(ARTHTTPPaginatedResponse *r, ARTErrorInfo *e) {
+            art_dispatch_async(self->_userQueue, ^{
+                userCallback(r, e);
+            });
+        };
+    }
+
+    NSMutableURLRequest *request = [self buildRequest:method
+                                                 path:path
+                                              baseUrl:self.baseUrl
+                                               params:params
+                                                 body:body
+                                              headers:headers];
+
     ARTLogDebug(self.logger, @"request %@ %@", method, path);
     art_dispatch_async(_queue, ^{
         [ARTHTTPPaginatedResponse executePaginated:self withRequest:request wrapperSDKAgents:wrapperSDKAgents logger:self.logger callback:callback];
@@ -778,16 +784,12 @@ - (BOOL)stats:(ARTStatsQuery *)query wrapperSDKAgents:(nullable NSStringDictiona
         return NO;
     }
 
-    NSURLComponents *requestUrl = [NSURLComponents componentsWithString:@"/stats"];
-    NSError *error = nil;
-    requestUrl.queryItems = [query asQueryItems:&error];
-    if (error) {
-        if (errorPtr) {
-            *errorPtr = error;
-        }
-        return NO;
-    }
-    NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[requestUrl URLRelativeToURL:self.baseUrl]];
+    NSMutableURLRequest *request = [self buildRequest:@"GET"
+                                                 path:@"/stats"
+                                              baseUrl:self.baseUrl
+                                               params:query.asQueryParams
+                                                 body:nil
+                                              headers:nil];
 
     // Override X-Ably-Version header to use protocol version 2 for stats
     [request setValue:@"2" forHTTPHeaderField:@"X-Ably-Version"];