Fix Strong mode, docs and other fixes

Pacane · Pacane · commit a76ffe1712ca · 2016-10-06T12:52:07.000-04:00
diff --git a/lib/src/common/git_service.dart b/lib/src/common/git_service.dart
@@ -12,7 +12,8 @@ class GitService extends Service {
   /// API docs: https://developer.github.com/v3/git/blobs/#get-a-blob
   Future<GitBlob> getBlob(RepositorySlug slug, String sha) {
     return _github.getJSON('/repos/${slug.fullName}/git/blobs/${sha}',
-        convert: GitBlob.fromJSON, statusCode: StatusCodes.OK);
+        convert: GitBlob.fromJSON,
+        statusCode: StatusCodes.OK) as Future<GitBlob>;
   }
 
   /// Creates a blob with specified [blob] content.
@@ -22,15 +23,16 @@ class GitService extends Service {
     return _github.postJSON('/repos/${slug.fullName}/git/blobs',
         convert: GitBlob.fromJSON,
         statusCode: StatusCodes.CREATED,
-        body: blob.toJSON());
+        body: blob.toJSON()) as Future<GitBlob>;
   }
 
   /// Fetches a commit from [slug] for a given [sha].
   ///
   /// API docs: https://developer.github.com/v3/git/commits/#get-a-commit
   Future<GitCommit> getCommit(RepositorySlug slug, String sha) {
     return _github.getJSON('/repos/${slug.fullName}/git/commits/${sha}',
-        convert: GitCommit.fromJSON, statusCode: StatusCodes.OK);
+        convert: GitCommit.fromJSON,
+        statusCode: StatusCodes.OK) as Future<GitCommit>;
   }
 
   /// Creates a new commit in a repository.
@@ -40,7 +42,7 @@ class GitService extends Service {
     return _github.postJSON('/repos/${slug.fullName}/git/commits',
         convert: GitCommit.fromJSON,
         statusCode: StatusCodes.CREATED,
-        body: commit.toJSON());
+        body: commit.toJSON()) as Future<GitCommit>;
   }
 
   /// Fetches a reference from a repository for the given [ref].
@@ -50,7 +52,8 @@ class GitService extends Service {
   /// API docs: https://developer.github.com/v3/git/refs/#get-a-reference
   Future<GitReference> getReference(RepositorySlug slug, String ref) {
     return _github.getJSON('/repos/${slug.fullName}/git/refs/${ref}',
-        convert: GitReference.fromJSON, statusCode: StatusCodes.OK);
+        convert: GitReference.fromJSON,
+        statusCode: StatusCodes.OK) as Future<GitReference>;
   }
 
   /// Lists the references in a repository.
@@ -67,7 +70,7 @@ class GitService extends Service {
     }
 
     return new PaginationHelper(_github)
-        .objects('GET', path, GitReference.fromJSON);
+        .objects('GET', path, GitReference.fromJSON) as Stream<GitReference>;
   }
 
   /// Creates a new reference in a repository.
@@ -81,7 +84,7 @@ class GitService extends Service {
     return _github.postJSON('/repos/${slug.fullName}/git/refs',
         convert: GitReference.fromJSON,
         statusCode: StatusCodes.CREATED,
-        body: JSON.encode({'ref': ref, 'sha': sha}));
+        body: JSON.encode({'ref': ref, 'sha': sha})) as Future<GitReference>;
   }
 
   /// Updates a reference in a repository.
@@ -98,7 +101,9 @@ class GitService extends Service {
         .request('PATCH', '/repos/${slug.fullName}/git/refs/${ref}',
             body: body, headers: headers)
         .then((response) {
-      return GitReference.fromJSON(JSON.decode(response.body));
+      return GitReference
+              .fromJSON(JSON.decode(response.body) as Map<String, dynamic>)
+          as Future<GitReference>;
     });
   }
 
@@ -116,7 +121,7 @@ class GitService extends Service {
   /// API docs: https://developer.github.com/v3/git/tags/#get-a-tag
   Future<GitTag> getTag(RepositorySlug slug, String sha) {
     return _github.getJSON('/repos/${slug.fullName}/git/tags/${sha}',
-        convert: GitTag.fromJSON, statusCode: StatusCodes.OK);
+        convert: GitTag.fromJSON, statusCode: StatusCodes.OK) as Future<GitTag>;
   }
 
   /// Creates a new tag in a repository.
@@ -126,10 +131,10 @@ class GitService extends Service {
     return _github.postJSON('/repos/${slug.fullName}/git/tags',
         convert: GitTag.fromJSON,
         statusCode: StatusCodes.CREATED,
-        body: tag.toJSON());
+        body: tag.toJSON()) as Future<GitTag>;
   }
 
-  /// Fetches a tree from a repository for the given [ref].
+  /// Fetches a tree from a repository for the given ref [sha].
   ///
   /// If [recursive] is set to true, the tree is fetched recursively.
   ///
@@ -143,7 +148,8 @@ class GitService extends Service {
     }
 
     return _github.getJSON(path,
-        convert: GitTree.fromJSON, statusCode: StatusCodes.OK);
+        convert: GitTree.fromJSON,
+        statusCode: StatusCodes.OK) as Future<GitTree>;
   }
 
   /// Creates a new tree in a repository.
@@ -153,6 +159,6 @@ class GitService extends Service {
     return _github.postJSON('/repos/${slug.fullName}/git/trees',
         convert: GitTree.fromJSON,
         statusCode: StatusCodes.CREATED,
-        body: tree.toJSON());
+        body: tree.toJSON()) as Future<GitTree>;
   }
 }
diff --git a/lib/src/common/github.dart b/lib/src/common/github.dart
@@ -2,32 +2,25 @@ part of github.common;
 
 typedef http.Client ClientCreator();
 
-/**
- * The Main GitHub Client
- *
- * ## Example
- *
- *      var github = new GitHub(auth: new Authentication.withToken("SomeToken"));
- *      // Use the Client
- */
+///  The Main GitHub Client
+///
+///  ## Example
+///
+///       var github = new GitHub(auth: new Authentication.withToken("SomeToken"));
+///       // Use the Client
+///
 class GitHub {
   static const _ratelimitLimitHeader = 'x-ratelimit-limit';
   static const _ratelimitResetHeader = 'x-ratelimit-reset';
   static const _ratelimitRemainingHeader = 'x-ratelimit-remaining';
 
-  /**
-   * Authentication Information
-   */
+  /// Authentication Information
   Authentication auth;
 
-  /**
-   * API Endpoint
-   */
+  /// API Endpoint
   final String endpoint;
 
-  /**
-   * HTTP Client
-   */
+  /// HTTP Client
   final http.Client client;
 
   ActivityService _activity;
@@ -45,6 +38,17 @@ class GitHub {
   UrlShortenerService _urlShortener;
   UsersService _users;
 
+  /// Creates a new [GitHub] instance.
+  ///
+  /// [endpoint] is the api endpoint to use
+  /// [auth] is the authentication information
+  GitHub(
+      {Authentication auth,
+      this.endpoint: "https://api.github.com",
+      http.Client client})
+      : this.auth = auth == null ? new Authentication.anonymous() : auth,
+        this.client = client == null ? new http.Client() : client;
+
   /// The maximum number of requests that the consumer is permitted to make per
   /// hour.
   ///
@@ -72,20 +76,6 @@ class GitHub {
 
   int _rateLimitReset, _rateLimitLimit, _rateLimitRemaining;
 
-  /**
-   * Creates a new [GitHub] instance.
-   *
-   * [fetcher] is the HTTP Transporter to use
-   * [endpoint] is the api endpoint to use
-   * [auth] is the authentication information
-   */
-  GitHub(
-      {Authentication auth,
-      this.endpoint: "https://api.github.com",
-      http.Client client})
-      : this.auth = auth == null ? new Authentication.anonymous() : auth,
-        this.client = client == null ? new http.Client() : client;
-
   /// Service for activity related methods of the GitHub API.
   ActivityService get activity {
     if (_activity == null) {
@@ -201,26 +191,19 @@ class GitHub {
     return _users;
   }
 
-  /**
-   * Handles Get Requests that respond with JSON
-   *
-   * [path] can either be a path like '/repos' or a full url.
-   *
-   * [statusCode] is the expected status code. If it is null, it is ignored.
-   * If the status code that the response returns is not the status code you provide
-   * then the [fail] function will be called with the HTTP Response.
-   * If you don't throw an error or break out somehow, it will go into some error checking
-   * that throws exceptions when it finds a 404 or 401. If it doesn't find a general HTTP Status Code
-   * for errors, it throws an Unknown Error.
-   *
-   * [headers] are HTTP Headers. If it doesn't exist, the 'Accept' and 'Authorization' headers are added.
-   *
-   * [params] are query string parameters.
-   *
-   * [convert] is a simple function that is passed this [GitHub] instance and a JSON object.
-   * The future will pass the object returned from this function to the then method.
-   * The default [convert] function returns the input object.
-   */
+  /// Handles Get Requests that respond with JSON
+  /// [path] can either be a path like '/repos' or a full url.
+  /// [statusCode] is the expected status code. If it is null, it is ignored.
+  /// If the status code that the response returns is not the status code you provide
+  /// then the [fail] function will be called with the HTTP Response.
+  /// If you don't throw an error or break out somehow, it will go into some error checking
+  /// that throws exceptions when it finds a 404 or 401. If it doesn't find a general HTTP Status Code
+  /// for errors, it throws an Unknown Error.
+  /// [headers] are HTTP Headers. If it doesn't exist, the 'Accept' and 'Authorization' headers are added.
+  /// [params] are query string parameters.
+  /// [convert] is a simple function that is passed this [GitHub] instance and a JSON object.
+  /// The future will pass the object returned from this function to the then method.
+  /// The default [convert] function returns the input object.
   Future<dynamic> getJSON(String path,
       {int statusCode,
       void fail(http.Response response),
@@ -252,35 +235,31 @@ class GitHub {
     return convert(json);
   }
 
-  /**
-   * Handles Post Requests that respond with JSON
-   *
-   * [path] can either be a path like '/repos' or a full url.
-   *
-   * [statusCode] is the expected status code. If it is null, it is ignored.
-   * If the status code that the response returns is not the status code you provide
-   * then the [fail] function will be called with the HTTP Response.
-   * If you don't throw an error or break out somehow, it will go into some error checking
-   * that throws exceptions when it finds a 404 or 401. If it doesn't find a general HTTP Status Code
-   * for errors, it throws an Unknown Error.
-   *
-   * [headers] are HTTP Headers. If it doesn't exist, the 'Accept' and 'Authorization' headers are added.
-   *
-   * [params] are query string parameters.
-   *
-   * [convert] is a simple function that is passed this [GitHub] instance and a JSON object.
-   * The future will pass the object returned from this function to the then method.
-   * The default [convert] function returns the input object.
-   *
-   * [body] is the data to send to the server.
-   */
+  /// Handles Post Requests that respond with JSO
+  ///
+  /// [path] can either be a path like '/repos' or a full url.
+  /// [statusCode] is the expected status code. If it is null, it is ignored.
+  /// If the status code that the response returns is not the status code you provide
+  /// then the [fail] function will be called with the HTTP Response.
+  ///
+  /// If you don't throw an error or break out somehow, it will go into some error checking
+  /// that throws exceptions when it finds a 404 or 401. If it doesn't find a general HTTP Status Code
+  /// for errors, it throws an Unknown Error.
+  ///
+  /// [headers] are HTTP Headers. If it doesn't exist, the 'Accept' and 'Authorization' headers are added.
+  /// [params] are query string parameters.
+  /// [convert] is a simple function that is passed this [GitHub] instance and a JSON object.
+  ///
+  /// The future will pass the object returned from this function to the then method.
+  /// The default [convert] function returns the input object.
+  /// [body] is the data to send to the server.
   Future<dynamic> postJSON(String path,
       {int statusCode,
       void fail(http.Response response),
       Map<String, String> headers,
       Map<String, String> params,
       JSONConverter convert,
-      body,
+      String body,
       String preview}) async {
     if (headers == null) headers = {};
 
@@ -303,16 +282,16 @@ class GitHub {
     return convert(JSON.decode(response.body));
   }
 
-  /**
-   * Internal method to handle status codes
-   */
+  ///
+  /// Internal method to handle status codes
+  ///
   void handleStatusCode(http.Response response) {
     String message;
     List<Map<String, String>> errors;
     if (response.headers['content-type'].contains('application/json')) {
       var json = JSON.decode(response.body);
       message = json['message'];
-      errors = json['errors'];
+      errors = json['errors'] as List<Map<String, String>>;
     }
     switch (response.statusCode) {
       case 404:
@@ -349,15 +328,14 @@ class GitHub {
     throw new UnknownError(this, message);
   }
 
-  /**
-   * Handles Authenticated Requests in an easy to understand way.
-   *
-   * [method] is the HTTP method.
-   * [path] can either be a path like '/repos' or a full url.
-   * [headers] are HTTP Headers. If it doesn't exist, the 'Accept' and 'Authorization' headers are added.
-   * [params] are query string parameters.
-   * [body] is the body content of requests that take content.
-   */
+  /// Handles Authenticated Requests in an easy to understand way.
+  ///
+  /// [method] is the HTTP method.
+  /// [path] can either be a path like '/repos' or a full url.
+  /// [headers] are HTTP Headers. If it doesn't exist, the 'Accept' and 'Authorization' headers are added.
+  /// [params] are query string parameters.
+  /// [body] is the body content of requests that take content.
+  ///
   Future<http.Response> request(String method, String path,
       {Map<String, String> headers,
       Map<String, dynamic> params,
@@ -422,11 +400,8 @@ class GitHub {
       return response;
   }
 
-  /**
-   * Disposes of this GitHub Instance.
-   *
-   * No other methods on this instance should be called after this method is called.
-   */
+  /// Disposes of this GitHub Instance.
+  /// No other methods on this instance should be called after this method is called.
   void dispose() {
     // Destroy the Authentication Information
     // This is needed for security reasons.
