Merge pull request #48 from superleap/gils43-update-labels-method

feat(github): added update label/s method and examples, changed long …

Author: TED Vortex (Teodor Eugen Dutulescu)

.eslintrc

@@ -101,7 +101,7 @@
     "lines-around-comment": [2, { "beforeBlockComment": true, "allowObjectStart": true }],
     "max-depth": 2,
     "max-len": [2, 120],
-    "max-lines": [2, 500],
+    "max-lines": [2, 1500],
     "max-nested-callbacks": 2,
     "max-params": [2, 5],
     "max-statements": [2, { "max": 15 }],

examples/updateLabel.js

@@ -0,0 +1,29 @@
+let config = require('./config/config');
+let labels = require('./config/labels');
+let {user, repo, token, options} = config.github;
+let githubIssuesLabelSync = new (require('./../lib/LabelSync'))(options, user, repo, token);
+
+let label = labels[0];
+label.color = '000';
+
+githubIssuesLabelSync.updateLabel(label).then((response) => {
+    /**
+     * @example
+     * [ { name: 'TEST GH Review: accepted',
+     *     color: '000',
+     *     status: 'success' } ]
+     */
+    console.log(response);
+}).catch((error) => {
+    /**
+     * @example
+     * { code: 401,
+     *   status: 'Unauthorized',
+     *   message: '{"message":"Bad credentials","documentation_url":"https://developer.github.com/v3"}' }
+     * @example
+     * { code: 404,
+     *   status: 'Not Found',
+     *   message: '{"message":"Not Found","documentation_url":"https://developer.github.com/v3/issues/labels/#update-a-label"}' }
+     */
+    console.log(error.toJSON());
+});

examples/updateLabels.js

@@ -0,0 +1,35 @@
+let config = require('./config/config');
+let labels = require('./config/labels');
+let {user, repo, token, options} = config.github;
+let githubIssuesLabelSync = new (require('./../lib/LabelSync'))(options, user, repo, token);
+
+labels.map((label) => {
+    label.color = '000';
+    return label;
+});
+
+githubIssuesLabelSync.updateLabels(labels).then((response) => {
+    /**
+     * @example
+     * [ { url: 'https://api.github.com/repos/superleap/github-issues-label-sync/labels/Semver:%20premajor',
+     *     name: 'Semver: premajor',
+     *     color: 'e99695' },
+     *     ...
+     *   { url: 'https://api.github.com/repos/superleap/github-issues-label-sync/labels/Type:%20feature-request',
+     *     name: 'Type: feature-request',
+     *     color: 'c7def8' } ]
+     */
+    console.log(response);
+}).catch((error) => {
+    /**
+     * @example
+     * { code: 401,
+     *   status: 'Unauthorized',
+     *   message: '{"message":"Bad credentials","documentation_url":"https://developer.github.com/v3"}' }
+     * @example
+     * { code: 404,
+     *   status: 'Not Found',
+     *   message: '{"message":"Not Found","documentation_url":"https://developer.github.com/v3/issues/labels/#update-a-label"}' }
+     */
+    console.log(error.toJSON());
+});

src/LabelSync.js

@@ -95,6 +95,7 @@ export default class GithubIssuesLabelSync {
         this._labels = [];
         this._deletedLabels = [];
         this._createdLabels = [];
+        this._updatedLabels = [];
 
         this.authenticate();
     }
@@ -163,6 +164,14 @@ export default class GithubIssuesLabelSync {
         return this._createdLabels;
     }
 
+    /**
+     * Get github API repository updated labels
+     * @type {Array<GithubIssuesLabelSync.Label>}
+     */
+    get updatedLabels() {
+        return this._updatedLabels;
+    }
+
     /**
      * Set github API Client options
      * @type {Object} Options we instantiate the github api package with
@@ -232,6 +241,14 @@ export default class GithubIssuesLabelSync {
         this._createdLabels.push(label);
     }
 
+    /**
+     * Push github API repository updated label
+     * @type {GithubIssuesLabelSync.Label}
+     */
+    set updatedLabel(label) {
+        this._updatedLabels.push(label);
+    }
+
     /**
      * We only do this once
      * @access private
@@ -400,6 +417,58 @@ export default class GithubIssuesLabelSync {
         });
     }
 
+    /**
+     * Update github API repository label on remote
+     * @example
+     * githubIssuesLabelSync.updateLabel(label).then((response) => {
+     *   console.log(response);
+     * }).catch((error) => {
+     *   console.log(error.toJSON());
+     * });
+     * @async
+     * @param {GithubIssuesLabelSync.Label} label - The label we want to update
+     * @param {String} label.name - The label's name
+     * @param {String} label.color - The label's colour
+     * @param {String} label.status - Promise status of operation
+     * @return {Promise<GithubIssuesLabelSync.createdLabels, Error>} Updated label
+     */
+    updateLabel(label) {
+        return new Promise((resolve, reject) => {
+            return this.github.issues.updateLabel({
+                "user": this.user,
+                "repo": this.repo,
+                "name": label.name,
+                "color": label.color
+            }, (error) => {
+                if (error) {
+                    reject(error);
+                } else {
+                    label.status = 'success';
+                    this.updatedLabel = label;
+                    resolve(this.updatedLabels);
+                }
+            });
+        });
+    }
+
+    /**
+     * Update github API repository labels on remote
+     * @example
+     * githubIssuesLabelSync.updateLabels(labels).then((response) => {
+     *   console.log(response);
+     * }).catch((error) => {
+     *   console.log(error.toJSON());
+     * });
+     * @async
+     * @param {Array<GithubIssuesLabelSync.Label>} labels - The labels we want to update
+     * @return {Promise<GithubIssuesLabelSync.createdLabels, Error>} Array of updated labels
+     */
+    updateLabels(labels) {
+        return Promise.all(labels).map((label) => {
+            return this.updateLabel(label);
+        });
+    }
+
     /**
      * Delete all github API repository labels on remote
      * @example