Gist.js

  1. /**
  2.  * @file
  3.  * @copyright  2013 Michael Aufreiter (Development Seed) and 2016 Yahoo Inc.
  4.  * @license    Licensed under {@link https://spdx.org/licenses/BSD-3-Clause-Clear.html BSD-3-Clause-Clear}.
  5.  *             Github.js is freely distributable.
  6.  */
  8. import Requestable from './Requestable';
  10. /**
  11.  * A Gist can retrieve and modify gists.
  12.  */
  13. class Gist extends Requestable {
  14.    /**
  15.     * Create a Gist.
  16.     * @param {string} id - the id of the gist (not required when creating a gist)
  17.     * @param {Requestable.auth} [auth] - information required to authenticate to Github
  18.     * @param {string} [apiBase=https://api.github.com] - the base Github API URL
  19.     */
  20.    constructor(id, auth, apiBase) {
  21.       super(auth, apiBase);
  22.       this.__id = id;
  23.    }
  25.    /**
  26.     * Fetch a gist.
  27.     * @see https://developer.github.com/v3/gists/#get-a-single-gist
  28.     * @param {Requestable.callback} [cb] - will receive the gist
  29.     * @return {Promise} - the Promise for the http request
  30.     */
  31.    read(cb) {
  32.       return this._request('GET', `/gists/${this.__id}`, null, cb);
  33.    }
  35.    /**
  36.     * Create a new gist.
  37.     * @see https://developer.github.com/v3/gists/#create-a-gist
  38.     * @param {Object} gist - the data for the new gist
  39.     * @param {Requestable.callback} [cb] - will receive the new gist upon creation
  40.     * @return {Promise} - the Promise for the http request
  41.     */
  42.    create(gist, cb) {
  43.       return this._request('POST', '/gists', gist, cb)
  44.          .then((response) => {
  45.             this.__id = response.data.id;
  46.             return response;
  47.          });
  48.    }
  50.    /**
  51.     * Delete a gist.
  52.     * @see https://developer.github.com/v3/gists/#delete-a-gist
  53.     * @param {Requestable.callback} [cb] - will receive true if the request succeeds
  54.     * @return {Promise} - the Promise for the http request
  55.     */
  56.    delete(cb) {
  57.       return this._request('DELETE', `/gists/${this.__id}`, null, cb);
  58.    }
  60.    /**
  61.     * Fork a gist.
  62.     * @see https://developer.github.com/v3/gists/#fork-a-gist
  63.     * @param {Requestable.callback} [cb] - the function that will receive the gist
  64.     * @return {Promise} - the Promise for the http request
  65.     */
  66.    fork(cb) {
  67.       return this._request('POST', `/gists/${this.__id}/forks`, null, cb);
  68.    }
  70.    /**
  71.     * Update a gist.
  72.     * @see https://developer.github.com/v3/gists/#edit-a-gist
  73.     * @param {Object} gist - the new data for the gist
  74.     * @param {Requestable.callback} [cb] - the function that receives the API result
  75.     * @return {Promise} - the Promise for the http request
  76.     */
  77.    update(gist, cb) {
  78.       return this._request('PATCH', `/gists/${this.__id}`, gist, cb);
  79.    }
  81.    /**
  82.     * Star a gist.
  83.     * @see https://developer.github.com/v3/gists/#star-a-gist
  84.     * @param {Requestable.callback} [cb] - will receive true if the request is successful
  85.     * @return {Promise} - the Promise for the http request
  86.     */
  87.    star(cb) {
  88.       return this._request('PUT', `/gists/${this.__id}/star`, null, cb);
  89.    }
  91.    /**
  92.     * Unstar a gist.
  93.     * @see https://developer.github.com/v3/gists/#unstar-a-gist
  94.     * @param {Requestable.callback} [cb] - will receive true if the request is successful
  95.     * @return {Promise} - the Promise for the http request
  96.     */
  97.    unstar(cb) {
  98.       return this._request('DELETE', `/gists/${this.__id}/star`, null, cb);
  99.    }
  101.    /**
  102.     * Check if a gist is starred by the user.
  103.     * @see https://developer.github.com/v3/gists/#check-if-a-gist-is-starred
  104.     * @param {Requestable.callback} [cb] - will receive true if the gist is starred and false if the gist is not starred
  105.     * @return {Promise} - the Promise for the http request
  106.     */
  107.    isStarred(cb) {
  108.       return this._request204or404(`/gists/${this.__id}/star`, null, cb);
  109.    }
  110. }
  112. module.exports = Gist;