feature(issue): allow users to fetch an issue's events

clayreimann · clayreimann · commit 2d102be55af8 · 2016-05-27T14:13:00.000-05:00
closes github-tools#180
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,11 @@
 # Change Log
 
+## master
+### Features
+* add `Issue.listIssueEvents`
+
+### Fixes
+
 ## 2.1.0
 ### Features
 Team API
diff --git a/lib/Issue.js b/lib/Issue.js
@@ -44,6 +44,17 @@ class Issue extends Requestable {
       return this._requestAllPages(`/repos/${this.__repository}/issues`, options, cb);
    }
 
+   /**
+    * List the events for an issue
+    * @see https://developer.github.com/v3/issues/events/#list-events-for-an-issue
+    * @param {number} issue - the issue to get events for
+    * @param {Requestable.callback} [cb] - will receive the list of events
+    * @return {Promise} - the promise for the http request
+    */
+   listIssueEvents(issue, cb) {
+      return this._request('GET', `/repos/${this.__repository}/issues/${issue}/events`, null, cb);
+   }
+
    /**
     * List comments on an issue
     * @see https://developer.github.com/v3/issues/comments/#list-comments-on-an-issue
diff --git a/test/issue.spec.js b/test/issue.spec.js
@@ -39,6 +39,13 @@ describe('Issue', function() {
          }));
       });
 
+      it('should get issue events', function() {
+         return remoteIssues.listIssueEvents(remoteIssueId)
+            .then(function({data: events}) {
+               expect(events).to.be.an.array();
+            });
+      });
+
       it('should get all milestones', function(done) {
          remoteIssues.listMilestones()
             .then(({data: milestones}) => {
