github-api-promise - npm Package Compare versions

Comparing version 1.8.1 to 1.9.0

package.json

 {
   "name": "github-api-promise",
-  "version": "1.8.1",
+  "version": "1.9.0",
   "description": "A node module for interfacing with the Github API using promises",
@@ -5,0 +5,0 @@ "main": "src/app.js",

src/repositories/commits.js

@@ -6,4 +6,4 @@ const config = require('../config');
 /**
- * Pull Requests module
- * @module pullRequests/pullRequests
+ * Commits module
+ * @module repositories/commits
  */
@@ -13,19 +13,93 @@ module.exports = {
 	/**
-	 * List comments on a pull request
-	 * By default, review comments are ordered by ascending ID.
+	 * List commits on a repository
 	 * 
-	 * @see {@link https://developer.github.com/v3/pulls/comments/#list-comments-on-a-pull-request}
+	 * @see {@link https://developer.github.com/v3/repos/commits/#list-commits-on-a-repository}
 	 * 
-	 * @param {string} owner            - The repo's owner
-	 * @param {string} repo             - The repo's name
-	 * @param {string} number           - The pull request number
-	 * @param {object} params           - An object of parameters for the request
-	 * @param {int}    params.page      - The page of results to retrieve
+	 * @param {string} owner         - The repo's owner
+	 * @param {string} repo          - The repo's name
+	 * @param {object} params        - An object of parameters for the request
+	 * @param {string} params.sha    - SHA or branch to start listing commits from. Default: the repository’s default branch (usually master).
+	 * @param {string} params.path   - Only commits containing this file path will be returned.
+	 * @param {string} params.author - GitHub login or email address by which to filter by commit author.
+	 * @param {string} params.since  - Only commits after this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+	 * @param {string} params.until  - Only commits before this date will be returned. This is a timestamp in ISO 8601 format: YYYY-MM-DDTHH:MM:SSZ.
+	 * @param {int}    params.page   - The page of results to retrieve
 	 *
 	 * @return {object} Commit data
 	 */
-	getPullRequestComments: function(owner, repo, number, params) {
+	getCommits: function(owner, repo, params) {
 		return req.standardRequest(`${config.host}/repos/${owner}/${repo}/commits?${req.assembleQueryParams(params,
-			['page'])}`);
+			['sha', 'path', 'author', 'since', 'until', 'page'])}`);
+	},
+
+	/**
+	 * Get a single commit
+	 * 
+	 * @see {@link https://developer.github.com/v3/repos/commits/#get-a-single-commit}
+	 * 
+	 * @param {string} owner - The repo's owner
+	 * @param {string} repo  - The repo's name
+	 * @param {string} sha   - The commit's sha
+	 *
+	 * @return {object} Commit data
+	 */
+	getCommit: function(owner, repo, sha) {
+		return req.standardRequest(`${config.host}/repos/${owner}/${repo}/commits/${sha}`);
+	},
+
+	/**
+	 * ***NOT IMPLEMENTED***
+	 * Get the SHA-1 of a commit reference
+	 * Users with read access can get the SHA-1 of a commit reference
+	 * 
+	 * @see {@link https://developer.github.com/v3/repos/commits/#get-the-sha-1-of-a-commit-reference}
+	 * 
+	 * @param {string} owner - The repo's owner
+	 * @param {string} repo  - The repo's name
+	 * @param {string} ref   - The commit's reference
+	 *
+	 * @return {string} SHA-1 value
+	 */
+	getSha1: function(owner, repo, ref) {
+		throw new Error('Operation not implemented');
+
+		/* To access the API you must provide a custom media type in the Accept header:
+		 * application/vnd.github.VERSION.sha
+		 */
+
+		//TODO: ability to pass custom headers to the request
+		//return req.standardRequest(`${config.host}/repos/${owner}/${repo}/commits/${ref}`);
+	},
+
+	/**
+	 * Compare two commits
+	 * Both :base and :head must be branch names in :repo. To compare branches across other repositories in the same network as :repo, use the format <USERNAME>:branch. For example: base=hubot:branchname, head=octocat:branchname
+	 * 
+	 * @see {@link https://developer.github.com/v3/repos/commits/#compare-two-commits}
+	 * 
+	 * @param {string} owner - The repo's owner
+	 * @param {string} repo  - The repo's name
+	 * @param {string} base  - The branch to be used as the basis for comparison
+	 * @param {string} head  - The branch to compare against :base
+	 *
+	 * @return {object} comparison data
+	 */
+	compareCommits: function(owner, repo, base, head) {
+		return req.standardRequest(`${config.host}/repos/${owner}/${repo}/compare/${base}...${head}`);
+	},
+
+	/**
+	 * Commit signature verification
+	 * 
+	 * @see {@link https://developer.github.com/v3/repos/commits/#commit-signature-verification}
+	 * 
+	 * @param {string} owner - The repo's owner
+	 * @param {string} repo  - The repo's name
+	 * @param {string} sha   - The commit's sha
+	 *
+	 * @return {object} Commit data
+	 */
+	verifySignature: function(owner, repo, sha) {
+		return req.standardRequest(`${config.host}/repos/${owner}/${repo}/commits/${sha}`);
 	}
 };

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

73605

increased by4.19%

Lines of code

1578

increased by4.5%

No dependency changes