Merge pull request octokit#43 from octokit/octclient-enqueuerequest-cleanup

Clean up the NSURLRequest creation and enqueueing methods.

Author: jspahrsummers

OctoKit.xcodeproj/project.pbxproj

@@ -224,6 +224,12 @@
 		D0D8C09E16DFF1540070399E /* rate_limit.json in Resources */ = {isa = PBXBuildFile; fileRef = D0D8C09416DFF1540070399E /* rate_limit.json */; };
 		D0E41B8716DFF37E00E321CF /* notifications.json in Resources */ = {isa = PBXBuildFile; fileRef = D0E41B8616DFF37E00E321CF /* notifications.json */; };
 		D0E41B8816DFF37E00E321CF /* notifications.json in Resources */ = {isa = PBXBuildFile; fileRef = D0E41B8616DFF37E00E321CF /* notifications.json */; };
+		F6CF78D416E993A500A75F63 /* RACSignal+OCTClientAdditions.h in Headers */ = {isa = PBXBuildFile; fileRef = F6CF78D216E993A500A75F63 /* RACSignal+OCTClientAdditions.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		F6CF78D516E993A500A75F63 /* RACSignal+OCTClientAdditions.h in Headers */ = {isa = PBXBuildFile; fileRef = F6CF78D216E993A500A75F63 /* RACSignal+OCTClientAdditions.h */; settings = {ATTRIBUTES = (Public, ); }; };
+		F6CF78D616E993A500A75F63 /* RACSignal+OCTClientAdditions.m in Sources */ = {isa = PBXBuildFile; fileRef = F6CF78D316E993A500A75F63 /* RACSignal+OCTClientAdditions.m */; };
+		F6CF78D816E993A500A75F63 /* RACSignal+OCTClientAdditions.m in Sources */ = {isa = PBXBuildFile; fileRef = F6CF78D316E993A500A75F63 /* RACSignal+OCTClientAdditions.m */; };
+		F6E2EC4016EB04C60096C268 /* RACSignalAdditionsSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = F6E2EC3F16EB04C50096C268 /* RACSignalAdditionsSpec.m */; };
+		F6E2EC4116EB04C60096C268 /* RACSignalAdditionsSpec.m in Sources */ = {isa = PBXBuildFile; fileRef = F6E2EC3F16EB04C50096C268 /* RACSignalAdditionsSpec.m */; };
 /* End PBXBuildFile section */
 
 /* Begin PBXContainerItemProxy section */
@@ -461,7 +467,7 @@
 		D0872109169E35DE00016ACA /* Specta.xcodeproj */ = {isa = PBXFileReference; lastKnownFileType = "wrapper.pb-project"; name = Specta.xcodeproj; path = External/Mantle/MantleTests/specta/Specta.xcodeproj; sourceTree = "<group>"; };
 		D0872124169E365A00016ACA /* OctoKitTests-Prefix.pch */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "OctoKitTests-Prefix.pch"; sourceTree = "<group>"; };
 		D0872127169E395F00016ACA /* OCTClient.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OCTClient.h; sourceTree = "<group>"; };
-		D0872128169E395F00016ACA /* OCTClient.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OCTClient.m; sourceTree = "<group>"; };
+		D0872128169E395F00016ACA /* OCTClient.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OCTClient.m; sourceTree = "<group>"; usesTabs = 1; };
 		D0872129169E395F00016ACA /* OCTCommitComment.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OCTCommitComment.h; sourceTree = "<group>"; };
 		D087212A169E395F00016ACA /* OCTCommitComment.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = OCTCommitComment.m; sourceTree = "<group>"; };
 		D087212B169E395F00016ACA /* OCTCommitCommentEvent.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = OCTCommitCommentEvent.h; sourceTree = "<group>"; };
@@ -537,6 +543,9 @@
 		D0D8C09316DFF1540070399E /* page3.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = page3.json; sourceTree = "<group>"; };
 		D0D8C09416DFF1540070399E /* rate_limit.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = rate_limit.json; sourceTree = "<group>"; };
 		D0E41B8616DFF37E00E321CF /* notifications.json */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = text.json; path = notifications.json; sourceTree = "<group>"; };
+		F6CF78D216E993A500A75F63 /* RACSignal+OCTClientAdditions.h */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.h; path = "RACSignal+OCTClientAdditions.h"; sourceTree = "<group>"; };
+		F6CF78D316E993A500A75F63 /* RACSignal+OCTClientAdditions.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = "RACSignal+OCTClientAdditions.m"; sourceTree = "<group>"; };
+		F6E2EC3F16EB04C50096C268 /* RACSignalAdditionsSpec.m */ = {isa = PBXFileReference; fileEncoding = 4; lastKnownFileType = sourcecode.c.objc; path = RACSignalAdditionsSpec.m; sourceTree = "<group>"; };
 /* End PBXFileReference section */
 
 /* Begin PBXFrameworksBuildPhase section */
@@ -626,6 +635,7 @@
 				D0871EA9169E2EFC00016ACA /* Products */,
 			);
 			sourceTree = "<group>";
+			usesTabs = 1;
 		};
 		D0871EA9169E2EFC00016ACA /* Products */ = {
 			isa = PBXGroup;
@@ -851,6 +861,7 @@
 			children = (
 				D0B9C8FC16BC7A260029C5B4 /* NSDateFormatterAdditionsSpec.m */,
 				D0772E7B16BD2AD5009DFF72 /* NSValueTransformerAdditionsSpec.m */,
+				F6E2EC3F16EB04C50096C268 /* RACSignalAdditionsSpec.m */,
 				D05E751F16D35886001AA17B /* OCTClientSpec.m */,
 				D08721BD169E396F00016ACA /* OCTCommitCommentSpec.m */,
 				D08721BE169E396F00016ACA /* OCTEventSpec.m */,
@@ -988,6 +999,8 @@
 				D0B9C8F116BC78970029C5B4 /* NSDateFormatter+OCTFormattingAdditions.m */,
 				D0772E7516BD2A05009DFF72 /* NSValueTransformer+OCTPredefinedTransformerAdditions.h */,
 				D0772E7616BD2A06009DFF72 /* NSValueTransformer+OCTPredefinedTransformerAdditions.m */,
+				F6CF78D216E993A500A75F63 /* RACSignal+OCTClientAdditions.h */,
+				F6CF78D316E993A500A75F63 /* RACSignal+OCTClientAdditions.m */,
 			);
 			name = Extensions;
 			sourceTree = "<group>";
@@ -1050,6 +1063,7 @@
 				8848E19D16AF630B005449AB /* OCTNotification.h in Headers */,
 				D0772E7316BD27B5009DFF72 /* NSDateFormatter+OCTFormattingAdditions.h in Headers */,
 				D0772E7716BD2A06009DFF72 /* NSValueTransformer+OCTPredefinedTransformerAdditions.h in Headers */,
+				F6CF78D416E993A500A75F63 /* RACSignal+OCTClientAdditions.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -1095,6 +1109,7 @@
 				8848E19E16AF630B005449AB /* OCTNotification.h in Headers */,
 				D0772E7416BD27B6009DFF72 /* NSDateFormatter+OCTFormattingAdditions.h in Headers */,
 				D0772E7816BD2A06009DFF72 /* NSValueTransformer+OCTPredefinedTransformerAdditions.h in Headers */,
+				F6CF78D516E993A500A75F63 /* RACSignal+OCTClientAdditions.h in Headers */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -1439,6 +1454,7 @@
 				8848E19F16AF630B005449AB /* OCTNotification.m in Sources */,
 				D0B9C8F416BC78970029C5B4 /* NSDateFormatter+OCTFormattingAdditions.m in Sources */,
 				D0772E7916BD2A06009DFF72 /* NSValueTransformer+OCTPredefinedTransformerAdditions.m in Sources */,
+				F6CF78D616E993A500A75F63 /* RACSignal+OCTClientAdditions.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -1459,6 +1475,7 @@
 				D0B9C8FD16BC7A260029C5B4 /* NSDateFormatterAdditionsSpec.m in Sources */,
 				D0772E7C16BD2AD5009DFF72 /* NSValueTransformerAdditionsSpec.m in Sources */,
 				D05E752016D35886001AA17B /* OCTClientSpec.m in Sources */,
+				F6E2EC4016EB04C60096C268 /* RACSignalAdditionsSpec.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -1503,6 +1520,7 @@
 				8848E1A016AF630B005449AB /* OCTNotification.m in Sources */,
 				D0B9C8F516BC78970029C5B4 /* NSDateFormatter+OCTFormattingAdditions.m in Sources */,
 				D0772E7A16BD2A06009DFF72 /* NSValueTransformer+OCTPredefinedTransformerAdditions.m in Sources */,
+				F6CF78D816E993A500A75F63 /* RACSignal+OCTClientAdditions.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};
@@ -1523,6 +1541,7 @@
 				D0B9C8FE16BC7A260029C5B4 /* NSDateFormatterAdditionsSpec.m in Sources */,
 				D0772E7D16BD2AD5009DFF72 /* NSValueTransformerAdditionsSpec.m in Sources */,
 				D05E752116D35886001AA17B /* OCTClientSpec.m in Sources */,
+				F6E2EC4116EB04C60096C268 /* RACSignalAdditionsSpec.m in Sources */,
 			);
 			runOnlyForDeploymentPostprocessing = 0;
 		};

OctoKit/OCTClient.h

@@ -108,61 +108,41 @@ extern NSString * const OCTClientErrorHTTPStatusCodeKey;
 // Returns a new client.
 + (instancetype)unauthenticatedClientWithUser:(OCTUser *)user;
 
-// Enqueues a request that always fetches the latest data from the server.
+// Creates a mutable URL request, which when sent will conditionally fetch the
+// latest data from the server. If the latest data matches `etag`, nothing is
+// downloaded and the call does not count toward the API rate limit.
+//
+// method          - The HTTP method to use in the request
+//                   (e.g., "GET" or "POST").
+// path            - The path to request, relative to the base API endpoint.
+//                   This path should _not_ begin with a forward slash.
+// parameters      - HTTP parameters to encode and send with the request.
+// notMatchingEtag - An ETag to compare the server data against, previously
+//                   retrieved from an instance of OCTResponse. If the content
+//                   has not changed since, no new data will be fetched when
+//                   this request is sent. This argument may be nil to always
+//                   fetch the latest data.
+//
+// Returns an NSMutableURLRequest that you can enqueue using
+// -enqueueRequest:resultClass:.
+- (NSMutableURLRequest *)requestWithMethod:(NSString *)method path:(NSString *)path parameters:(NSDictionary *)parameters notMatchingEtag:(NSString *)etag;
+
+// Enqueues a request to be sent to the server.
 //
 // This will automatically fetch all pages of the given endpoint. Each object
 // from each page will be sent independently on the returned signal, so
 // subscribers don't have to know or care about this pagination behavior.
 //
-// To stop fetching pages, simply dispose of all subscriptions to the signal.
+// request       - The previously constructed URL request for the endpoint.
+// resultClass   - A subclass of OCTObject that the response data should be
+//                 returned as, and will be accessible from the parsedResult
+//                 property on each OCTResponse. If this is nil, NSDictionary
+//                 will be used for each object in the JSON received.
 //
-// method      - The HTTP method to use in the request (e.g., "GET" or "POST").
-// path        - The path to request, relative to the base API endpoint. This
-//               path should _not_ begin with a forward slash.
-// parameters  - HTTP parameters to encode and send with the request.
-// resultClass - A subclass of OCTObject that the response data should be
-//               returned as. If this is nil, the returned signal will send an
-//               NSDictionary for each object in the JSON received.
-//
-// Returns a signal which will send an instance of `resultClass` for each parsed
+// Returns a signal which will send an instance of `OCTResponse` for each parsed
 // JSON object, then complete. If an error occurs at any point, the returned
 // signal will send it immediately, then terminate.
-- (RACSignal *)enqueueRequestWithMethod:(NSString *)method path:(NSString *)path parameters:(NSDictionary *)parameters resultClass:(Class)resultClass;
-
-// Enqueues a request which will conditionally fetch the latest data from the
-// server. If the latest data matches `etag`, nothing is downloaded and the call
-// does not count toward the API rate limit.
-//
-// If the latest data does not match `etag`, this will automatically fetch all
-// pages of the given endpoint. Each object from each page will be sent as
-// independent OCTResponse objects on the returned signal, so subscribers don't
-// have to know or care about this pagination behavior.
-//
-// To stop fetching pages, simply dispose of all subscriptions to the signal.
-//
-// method          - The HTTP method to use in the request (e.g., "GET" or
-//                   "POST").
-// path            - The path to request, relative to the base API endpoint.
-//                   This path should _not_ begin with a forward slash.
-// parameters      - HTTP parameters to encode and send with the request.
-// notMatchingEtag - An ETag to compare the server data against, previously
-//                   retrieved from an instance of OCTResponse. If the content
-//                   has not changed since, no new data will be fetched. This
-//                   argument may be nil to always fetch the latest data.
-// resultClass     - A subclass of OCTObject to use for each
-//                   OCTResponse.parsedResult. If this is nil, the
-//                   `parsedResult` will be an NSDictionary.
-//
-// Returns a signal which will send an instance of OCTResponse for each JSON
-// object _if new data was retrieved_. On success, the signal will send
-// completed regardless of whether there was new data. If an error occurs at any
-// point, the returned signal will send it immediately, then terminate.
-- (RACSignal *)enqueueConditionalRequestWithMethod:(NSString *)method path:(NSString *)path parameters:(NSDictionary *)parameters notMatchingEtag:(NSString *)etag resultClass:(Class)resultClass;
-
-// Behaves like
-// -enqueueConditionalRequestWithMethod:path:parameters:notMatchingEtag:resultClass:,
-// but allows a full URL to be passed in.
-- (RACSignal *)enqueueConditionalRequestWithMethod:(NSString *)method URL:(NSURL *)URL parameters:(NSDictionary *)parameters notMatchingEtag:(NSString *)etag resultClass:(Class)resultClass;
+- (RACSignal *)enqueueRequest:(NSURLRequest *)request resultClass:(Class)resultClass;
 
 @end