feat: Adding repository.compare() (#30)

* tests for repository.compare() * forgot to expose new methods!
repo-utils · Jan 10, 2017 · 9d5c1d0 · 9d5c1d0
1 parent 7b1fff8
commit 9d5c1d0
Show file tree

Hide file tree

Showing 3 changed files with 30 additions and 1 deletion.
diff --git a/lib/properties.js b/lib/properties.js
@@ -44,7 +44,9 @@ var properties = {
     'getTags',
     'getCommits',
     'getTree',
-    'getBlob'
+    'getBlob',
+    'archive',
+    'compare'
   ],
   issues: [
     'listNotes',

diff --git a/lib/resources/repository.js b/lib/resources/repository.js
@@ -179,4 +179,18 @@ Repository.prototype.archive = function (params, callback) {
   this.client.request('get', this.path, params, callback);
 };
 
+/**
+ * Compare branches, tags or commits.
+ *
+ * @param {Object} params
+ *  - {String} id (required) The ID of a project
+ *  - {String} from (required) - the commit SHA or branch name
+ *  - {String} to (required) - the commit SHA or branch name
+ * @param {Function} callback
+ */
+Repository.prototype.compare = function (params, callback) {
+  params.type = 'compare';
+  this.client.request('get', this.path, params, callback);
+};
+
 
diff --git a/test/repository.test.js b/test/repository.test.js
@@ -248,4 +248,17 @@ describe.skip('repository.test.js', function () {
       });
     });
   });
+
+  describe('client.repository.compare()', function () {
+    it('should return diffs', function (done) {
+      client.repository.compare({id: 55045, to: 'master', from: '946579807281bd26b75b91986c78f15ad0bd40f7'}, function (err, diffs) {
+        should.not.exists(err);
+        should.exists(diffs);
+        diffs.should.have.keys('commit', 'commits', 'diffs', 'compare_timeout', 'compare_same_ref');
+        diffs.commits.should.be.instanceof(Array);
+        diffs.diffs.should.be.instanceof(Array);
+        done();
+      });
+    });
+  });   
 });