Merge pull request #284 from octokit/fetch-issues

Add issue fetching

OctoKit/OCTClient+Issues.h

@@ -8,6 +8,12 @@
 
 #import <OctoKit/OctoKit.h>
 
+typedef NS_ENUM(NSInteger, OCTClientIssueState) {
+	OCTClientIssueStateOpen,
+	OCTClientIssueStateClosed,
+	OCTClientIssueStateAll,
+};
+
 @interface OCTClient (Issues)
 
 /// Creates an issue.
@@ -28,4 +34,17 @@
 /// Returns a signal which will send the created `OCTIssue` then complete, or error.
 - (RACSignal *)createIssueWithTitle:(NSString *)title body:(NSString *)body assignee:(NSString *)assignee milestone:(NSNumber *)milestone labels:(NSArray *)labels inRepository:(OCTRepository *)repository;
 
+/// Fetch the issues with the given state from the repository.
+///
+/// repository - The repository whose issues should be fetched. Cannot be nil.
+/// state      - The state of issues to return.
+/// etag       - An Etag from a previous request, used to avoid downloading
+//               unnecessary data. May be nil.
+/// since      - Only issues updated or created after this date will be fetched.
+///              May be nil.
+///
+/// Returns a signal which will send each `OCTResponse`-wrapped `OCTIssue`s and
+/// complete or error.
+- (RACSignal *)fetchIssuesForRepository:(OCTRepository *)repository state:(OCTClientIssueState)state notMatchingEtag:(NSString *)etag since:(NSDate *)since;
+
 @end

OctoKit/OCTClient+Issues.m

@@ -7,6 +7,7 @@
 //
 
 #import "OCTClient+Issues.h"
+#import "NSDateFormatter+OCTFormattingAdditions.h"
 
 @implementation OCTClient (Issues)
 
@@ -28,4 +29,25 @@ - (RACSignal *)createIssueWithTitle:(NSString *)title body:(NSString *)body assi
 	return [[self enqueueRequest:request resultClass:OCTIssue.class] oct_parsedResults];
 }
 
+- (RACSignal *)fetchIssuesForRepository:(OCTRepository *)repository state:(OCTClientIssueState)state notMatchingEtag:(NSString *)etag since:(NSDate *)since {
+	NSParameterAssert(repository != nil);
+
+	NSMutableDictionary *parameters = [NSMutableDictionary dictionary];
+
+	NSDictionary *stateToStateString = @{
+		@(OCTClientIssueStateOpen): @"open",
+		@(OCTClientIssueStateClosed): @"closed",
+		@(OCTClientIssueStateAll): @"all",
+	};
+	NSString *stateString = stateToStateString[@(state)];
+	NSAssert(stateString != nil, @"Unknown state: %@", @(state));
+
+	parameters[@"state"] = stateString;
+	if (since != nil) parameters[@"since"] = [NSDateFormatter oct_stringFromDate:since];
+
+	NSString *path = [NSString stringWithFormat:@"repos/%@/%@/issues", repository.ownerLogin, repository.name];
+	NSURLRequest *request = [self requestWithMethod:@"GET" path:path parameters:parameters notMatchingEtag:etag];
+	return [self enqueueRequest:request resultClass:OCTIssue.class];
+}
+
 @end

OctoKit/OCTIssue.h

@@ -8,6 +8,11 @@
 
 #import "OCTObject.h"
 
+typedef NS_ENUM(NSInteger, OCTIssueState) {
+	OCTIssueStateOpen,
+	OCTIssueStateClosed,
+};
+
 @class OCTPullRequest;
 
 // An issue on a repository.
@@ -26,4 +31,10 @@
 // if this issue does not have code attached.
 @property (nonatomic, copy, readonly) OCTPullRequest *pullRequest;
 
+/// The state of the issue.
+@property (nonatomic, assign, readonly) OCTIssueState state;
+
+/// The issue number.
+@property (nonatomic, copy, readonly) NSString *number;
+
 @end

OctoKit/OCTIssue.m

@@ -39,7 +39,6 @@ + (NSDictionary *)JSONKeyPathsByPropertyKey {
 	return [super.JSONKeyPathsByPropertyKey mtl_dictionaryByAddingEntriesFromDictionary:@{
 		@"URL": @"url",
 		@"HTMLURL": @"html_url",
-		@"objectID": @"number",
 		@"pullRequestHTMLURL": @"pull_request.html_url",
 	}];
 }
@@ -56,4 +55,30 @@ + (NSValueTransformer *)pullRequestHTMLURLJSONTransformer {
 	return [NSValueTransformer valueTransformerForName:MTLURLValueTransformerName];
 }
 
++ (NSValueTransformer *)numberJSONTransformer {
+	return [MTLValueTransformer
+		reversibleTransformerWithForwardBlock:^(NSNumber *num) {
+			return num.stringValue;
+		} reverseBlock:^ id (NSString *str) {
+			if (str == nil) return nil;
+
+			return [NSDecimalNumber decimalNumberWithString:str];
+		}];
+}
+
++ (NSValueTransformer *)stateJSONTransformer {
+	NSDictionary *statesByName = @{
+		@"open": @(OCTIssueStateOpen),
+		@"closed": @(OCTIssueStateClosed),
+	};
+
+	return [MTLValueTransformer
+		reversibleTransformerWithForwardBlock:^(NSString *stateName) {
+			return statesByName[stateName];
+		}
+		reverseBlock:^(NSNumber *state) {
+			return [statesByName allKeysForObject:state].lastObject;
+		}];
+}
+
 @end

OctoKitTests/OCTIssueSpec.m

@@ -18,6 +18,7 @@
 	@"url": @"https://api.github.com/repos/octocat/Hello-World/issues/1",
 	@"html_url": @"https://github.com/octocat/Hello-World/issues/1",
 	@"number": @1347,
+	@"id": @1,
 	@"state": @"open",
 	@"title": @"Found a bug",
 	@"body": @"I'm having a problem with this.",
@@ -83,10 +84,12 @@
 });
 
 it(@"should initialize", ^{
-	expect(issue.objectID).to(equal(@"1347"));
+	expect(issue.objectID).to(equal(@"1"));
 	expect(issue.URL).to(equal([NSURL URLWithString:@"https://api.github.com/repos/octocat/Hello-World/issues/1"]));
 	expect(issue.HTMLURL).to(equal([NSURL URLWithString:@"https://github.com/octocat/Hello-World/issues/1"]));
 	expect(issue.title).to(equal(@"Found a bug"));
+	expect(@(issue.state)).to(equal(@(OCTIssueStateOpen)));
+	expect(issue.number).to(equal(@"1347"));
 
 	expect(issue.pullRequest).to(beAKindOf(OCTPullRequest.class));
 	expect(issue.pullRequest.objectID).to(equal(issue.objectID));