nlm/lib/github/client.js

Lifecycle manager for node projects

/*
 * Copyright (c) 2015, Groupon, Inc.
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions
 * are met:
 *
 * Redistributions of source code must retain the above copyright notice,
 * this list of conditions and the following disclaimer.
 *
 * Redistributions in binary form must reproduce the above copyright
 * notice, this list of conditions and the following disclaimer in the
 * documentation and/or other materials provided with the distribution.
 *
 * Neither the name of GROUPON nor the names of its contributors may be
 * used to endorse or promote products derived from this software without
 * specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
 * IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
 * TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
 * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
 * HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED
 * TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
 * PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
 * LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */

'use strict';

const Gofer = require('gofer');

const pkg = require('../../package');

const parseRepository = require('./parse-repository');

class Github extends Gofer {
  constructor(config) {
    super(config, 'github', pkg.version, pkg.name);
  }

  get pull() {
    return {
      /**
       * @param {string} pullId
       * @return {Promise<any>}
       */
      get: pullId =>
        this.get('/repos/{owner}/{repo}/pulls/{pullId}', {
          pathParams: { pullId },
          endpointName: 'pull.get',
        }).json(),
      /**
       * @param {string} pullId
       * @return {Promise<any>}
       */
      commits: pullId =>
        this.get('/repos/{owner}/{repo}/pulls/{pullId}/commits', {
          pathParams: { pullId },
          endpointName: 'pull.commits',
        }).json(),
    };
  }

  get labels() {
    return {
      /**
       *
       * @param {string} label
       * @return {Promise<any>}
       */
      create: label =>
        this.post('/repos/{owner}/{repo}/labels', {
          json: label,
          endpointName: 'labels.create',
        }).json(),

      /**
       * @return {Promise<any>}
       */
      list: () => this.get('/repos/{owner}/{repo}/labels', {}).json(),

      /**
       * @param {string} issueId
       * @return {Promise<any>}
       */
      listByIssue: issueId =>
        this.get('/repos/{owner}/{repo}/issues/{issueId}/labels', {
          pathParams: { issueId },
          endpointName: 'labels.listByIssue',
        }).json(),

      /**
       * @param {string} issueId
       * @param {string[]} labels
       * @return {FetchResponse}
       */
      setForIssue: (issueId, labels) =>
        this.put('/repos/{owner}/{repo}/issues/{issueId}/labels', {
          pathParams: { issueId },
          json: labels,
          endpointName: 'labels.setForIssue',
        }),
    };
  }

  get releases() {
    return {
      /**
       * @param release
       * @return {Promise<any>}
       */
      create: release =>
        this.post('/repos/{owner}/{repo}/releases', {
          json: release,
          endpointName: 'releases.create',
        }).json(),
    };
  }

  get tags() {
    return {
      /**
       * @param {string} tag
       * @return {Promise<any>}
       */
      get: tag =>
        this.get('/repos/{owner}/{repo}/git/refs/tags/{tag}', {
          pathParams: { tag },
          endpointName: 'tags.get',
        }).json(),
    };
  }
}

Github.forRepository = function forRepository(repository) {
  const repoInfo = parseRepository(repository);
  return new Github({
    github: {
      baseUrl: repoInfo.baseUrl,
      connectTimeout: 5000,
      timeout: 20000,
      pathParams: {
        owner: repoInfo.username,
        repo: repoInfo.repository,
      },
      headers: {
        Authorization: `token ${process.env.GH_TOKEN}`,
      },
    },
  });
};

module.exports = Github;