Require an expected status code for every request

lib/src/common/activity_service.dart

@@ -149,7 +149,7 @@ class ActivityService extends Service {
 
   /// Marks all notifications up to [lastRead] as read.
   ///
-  /// API docs: https://developer.github.com/v3/activity/notifications/#mark-as-read
+  /// API docs: https://developer.github.com/v3/activity/notifications/#mark-notifications-as-read
   Future<bool> markNotificationsRead({DateTime lastRead}) {
     final data = {};
 
@@ -158,7 +158,9 @@ class ActivityService extends Service {
     }
 
     return github
-        .request('PUT', '/notifications', body: GitHubJson.encode(data))
+        .request('PUT', '/notifications',
+            body: GitHubJson.encode(data),
+            statusCode: StatusCodes.RESET_CONTENT)
         .then((response) {
       return response.statusCode == 205;
     });
@@ -180,7 +182,8 @@ class ActivityService extends Service {
 
     return github
         .request('PUT', '/repos/${slug.fullName}/notifications',
-            body: GitHubJson.encode(data))
+            body: GitHubJson.encode(data),
+            statusCode: StatusCodes.RESET_CONTENT)
         .then((response) {
       return response.statusCode == 205;
     });
@@ -198,7 +201,8 @@ class ActivityService extends Service {
   /// API docs: https://developer.github.com/v3/activity/notifications/#mark-a-thread-as-read
   Future<bool> markThreadRead(String threadId) {
     return github
-        .request('PATCH', '/notifications/threads/$threadId')
+        .request('PATCH', '/notifications/threads/$threadId',
+            statusCode: StatusCodes.RESET_CONTENT)
         .then((response) {
       return response.statusCode == StatusCodes.RESET_CONTENT;
     });
@@ -234,33 +238,42 @@ class ActivityService extends Service {
 
   /// Checks if the currently authenticated user has starred the specified repository.
   ///
-  /// API docs: https://developer.github.com/v3/activity/starring/#check-if-you-are-starring-a-repository
-  Future<bool> isStarred(RepositorySlug slug) {
-    return github
-        .request('GET', '/user/starred/${slug.fullName}')
-        .then((response) {
-      return response.statusCode == 204;
-    });
+  /// API docs: https://developer.github.com/v3/activity/starring/#check-if-a-repository-is-starred-by-the-authenticated-user
+  Future<bool> isStarred(RepositorySlug slug) async {
+    try {
+      await github.request(
+        'GET',
+        '/user/starred/${slug.fullName}',
+        statusCode: StatusCodes.NO_CONTENT,
+      );
+      return true;
+    } on NotFound {
+      return false;
+    }
   }
 
   /// Stars the specified repository for the currently authenticated user.
   ///
-  /// API docs: https://developer.github.com/v3/activity/starring/#star-a-repository
-  Future star(RepositorySlug slug) {
-    return github.request('PUT', '/user/starred/${slug.fullName}',
-        headers: {'Content-Length': '0'}).then((response) {
-      return null;
-    });
+  /// API docs: https://developer.github.com/v3/activity/starring/#star-a-repository-for-the-authenticated-user
+  Future<void> star(RepositorySlug slug) async {
+    await github.request(
+      'PUT',
+      '/user/starred/${slug.fullName}',
+      headers: {'Content-Length': '0'},
+      statusCode: StatusCodes.NO_CONTENT,
+    );
   }
 
   /// Unstars the specified repository for the currently authenticated user.
   ///
-  /// API docs: https://developer.github.com/v3/activity/starring/#unstar-a-repository
-  Future unstar(RepositorySlug slug) {
-    return github.request('DELETE', '/user/starred/${slug.fullName}',
-        headers: {'Content-Length': '0'}).then((response) {
-      return null;
-    });
+  /// API docs: https://developer.github.com/v3/activity/starring/#unstar-a-repository-for-the-authenticated-user
+  Future<void> unstar(RepositorySlug slug) async {
+    await github.request(
+      'DELETE',
+      '/user/starred/${slug.fullName}',
+      headers: {'Content-Length': '0'},
+      statusCode: StatusCodes.NO_CONTENT,
+    );
   }
 
   /// Lists the watchers of the specified repository.
@@ -318,11 +331,13 @@ class ActivityService extends Service {
   /// Deletes a Repository Subscription
   ///
   /// API docs: https://developer.github.com/v3/activity/watching/#delete-a-repository-subscription
-  Future deleteRepositorySubscription(RepositorySlug slug) {
-    return github.request('DELETE', '/repos/${slug.fullName}/subscription',
-        headers: {'Content-Length': '0'}).then((response) {
-      return null;
-    });
+  Future<void> deleteRepositorySubscription(RepositorySlug slug) async {
+    await github.request(
+      'DELETE',
+      '/repos/${slug.fullName}/subscription',
+      headers: {'Content-Length': '0'},
+      statusCode: StatusCodes.NO_CONTENT,
+    );
   }
 }
 
@@ -385,7 +400,9 @@ class EventPoller {
           headers['If-None-Match'] = _lastFetched;
         }
 
-        github.request('GET', path, headers: headers).then(handleEvent);
+        github
+            .request('GET', path, headers: headers, statusCode: null)
+            .then(handleEvent);
       });
     }
 
@@ -395,7 +412,9 @@ class EventPoller {
       headers['If-None-Match'] = _lastFetched;
     }
 
-    github.request('GET', path, headers: headers).then(handleEvent);
+    github
+        .request('GET', path, headers: headers, statusCode: null)
+        .then(handleEvent);
 
     return _controller.stream;
   }

lib/src/common/gists_service.dart

@@ -84,10 +84,13 @@ class GistsService extends Service {
   /// Deletes the specified Gist.
   ///
   /// API docs: https://developer.github.com/v3/gists/#delete-a-gist
-  Future<bool> deleteGist(String id) {
-    return github.request('DELETE', '/gists/$id').then((response) {
-      return response.statusCode == 204;
-    });
+  Future<bool> deleteGist(String id) async {
+    await github.request(
+      'DELETE',
+      '/gists/$id',
+      statusCode: StatusCodes.NO_CONTENT,
+    );
+    return true;
   }
 
   /// Edits a Gist.
@@ -125,28 +128,41 @@ class GistsService extends Service {
   /// Star the specified Gist.
   ///
   /// API docs: https://developer.github.com/v3/gists/#star-a-gist
-  Future<bool> starGist(String id) {
-    return github.request('POST', '/gists/$id/star').then((response) {
-      return response.statusCode == 204;
-    });
+  Future<bool> starGist(String id) async {
+    await github.request(
+      'POST',
+      '/gists/$id/star',
+      statusCode: StatusCodes.NO_CONTENT,
+    );
+    return true;
   }
 
   /// Unstar the specified Gist.
   ///
   /// API docs: https://developer.github.com/v3/gists/#star-a-gist
-  Future<bool> unstarGist(String id) {
-    return github.request('DELETE', '/gists/$id/star').then((response) {
-      return response.statusCode == 204;
-    });
+  Future<bool> unstarGist(String id) async {
+    await github.request(
+      'DELETE',
+      '/gists/$id/star',
+      statusCode: StatusCodes.NO_CONTENT,
+    );
+    return true;
   }
 
   /// Checks if the specified Gist is starred.
   ///
   /// API docs: https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
-  Future<bool> isGistStarred(String id) {
-    return github.request('GET', '/gists/$id/star').then((response) {
-      return response.statusCode == 204;
-    });
+  Future<bool> isGistStarred(String id) async {
+    try {
+      await github.request(
+        'GET',
+        '/gists/$id/star',
+        statusCode: StatusCodes.NO_CONTENT,
+      );
+      return true;
+    } on NotFound {
+      return false;
+    }
   }
 
   /// Forks the specified Gist.
@@ -176,9 +192,12 @@ class GistsService extends Service {
   ///
   /// API docs: https://developer.github.com/v3/gists/comments/#create-a-comment
   Future<GistComment> createComment(String gistId, CreateGistComment request) {
-    return github.postJSON('/gists/$gistId/comments',
-        body: GitHubJson.encode(request),
-        convert: (i) => GistComment.fromJson(i));
+    return github.postJSON(
+      '/gists/$gistId/comments',
+      body: GitHubJson.encode(request),
+      statusCode: StatusCodes.CREATED,
+      convert: (i) => GistComment.fromJson(i),
+    );
   }
 
   // TODO: Implement editComment: https://developer.github.com/v3/gists/comments/#edit-a-comment

lib/src/common/git_service.dart

@@ -98,21 +98,27 @@ class GitService extends Service {
     final headers = {'content-length': body.length.toString()};
 
     return github
-        .request('PATCH', '/repos/${slug.fullName}/git/refs/$ref',
-            body: body, headers: headers)
-        .then((response) {
-      return GitReference.fromJson(
-          jsonDecode(response.body) as Map<String, dynamic>);
-    });
+        .request(
+          'PATCH',
+          '/repos/${slug.fullName}/git/refs/$ref',
+          body: body,
+          headers: headers,
+          statusCode: StatusCodes.OK,
+        )
+        .then((response) => GitReference.fromJson(
+            jsonDecode(response.body) as Map<String, dynamic>));
   }
 
   /// Deletes a reference.
   ///
   /// API docs: https://developer.github.com/v3/git/refs/#delete-a-reference
-  Future<bool> deleteReference(RepositorySlug slug, String ref) {
-    return github
-        .request('DELETE', '/repos/${slug.fullName}/git/refs/$ref')
-        .then((response) => response.statusCode == StatusCodes.NO_CONTENT);
+  Future<bool> deleteReference(RepositorySlug slug, String ref) async {
+    await github.request(
+      'DELETE',
+      '/repos/${slug.fullName}/git/refs/$ref',
+      statusCode: StatusCodes.NO_CONTENT,
+    );
+    return true;
   }
 
   /// Fetches a tag from the repo given a SHA.

lib/src/common/github.dart

@@ -143,7 +143,7 @@ class GitHub {
   /// The default [convert] function returns the input object.
   Future<T> getJSON<S, T>(
     String path, {
-    int statusCode,
+    @required int statusCode,
     void Function(http.Response response) fail,
     Map<String, String> headers,
     Map<String, String> params,
@@ -183,7 +183,7 @@ class GitHub {
   /// [T] represents the type return from this function after conversion
   Future<T> postJSON<S, T>(
     String path, {
-    int statusCode,
+    @required int statusCode,
     void Function(http.Response response) fail,
     Map<String, String> headers,
     Map<String, dynamic> params,
@@ -225,7 +225,7 @@ class GitHub {
   /// [T] represents the type return from this function after conversion
   Future<T> putJSON<S, T>(
     String path, {
-    int statusCode,
+    @required int statusCode,
     void Function(http.Response response) fail,
     Map<String, String> headers,
     Map<String, dynamic> params,
@@ -248,7 +248,7 @@ class GitHub {
   Future<T> requestJson<S, T>(
     String method,
     String path, {
-    int statusCode,
+    @required int statusCode,
     void Function(http.Response response) fail,
     Map<String, String> headers,
     Map<String, dynamic> params,
@@ -298,10 +298,10 @@ class GitHub {
   Future<http.Response> request(
     String method,
     String path, {
+    @required int statusCode,
     Map<String, String> headers,
     Map<String, dynamic> params,
     dynamic body,
-    int statusCode,
     void Function(http.Response response) fail,
     String preview,
   }) async {