All files / src/instagram index.js

100% Statements 20/20
100% Branches 10/10
100% Functions 5/5
100% Lines 20/20
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134                                                                        13x 13x 13x 11x       11x 11x 11x                           14x 1x 1x   14x                                     4x 1x 1x   4x                                     4x 1x 1x   4x                                     1x          
import isFunction from 'lodash.isfunction';
import Core from '../core/core';
import Stream from './stream';
 
/**
 * @class Instagram
 * @description Instagram class
 * @example
 * const instagram = new Instagram({
 *  clientId: 'your-client-id',
 *  accessToken: 'your-access-token',
 * });
 *
 * instagram.get('some-instagram-route').then((data) => {
 *  console.log(data);
 * });
 *
 * // Streaming can be used on all endpoints taking MIN_TAG_ID as parameter
 * const stream = instagram.stream('tags/:tag-name/media/recent');
 *
 * stream.on('message', (message) => {
 *  console.log(message);
 * });
 */
class Instagram extends Core {
  /**
   * @constructs Instagram
   * @description Constructs an instance of Instagram.
   *
   * @param {object} config - Config of class.
   * @param {string} config.clientId - clientId of Instagram app.
   * @param {string} config.accessToken - appSecret of Instagram app.
   * @param {object} [options] - Options of class.
   *
   */
  constructor(config = {}, options = {}) {
    super(options);
    this.name = 'instagram';
    this.checkValidConfig(['clientId', 'accessToken'], config);
    this.options = {
      client_id: config.clientId,
      access_token: config.accessToken,
    };
    this.url = 'https://api.instagram.com';
    this.version = options.version || 'v1';
    this.baseApiUrl = `${this.url}/${this.version}`;
  }
 
  /**
   * @memberof Instagram
   * @function get
   * @description Make a get request to instagram api.
   *
   * @param {string} url - Url of route.
   * @param {object} [options] - Options to pass in request.
   * @param {function} [callback] - Callback to call when the request finish.
   * @return {promise}
   */
  get(url, options, callback) {
    if (isFunction(options)) {
      callback = options;
      options = {};
    }
    return this.request({
      method: 'GET',
      json: true,
      uri: `${this.baseApiUrl}/${url}`,
      qs: Object.assign({}, this.options, options),
    }, callback);
  }
 
  /**
   * @memberof Instagram
   * @function post
   * @description Make a post request to instagram api.
   *
   * @param {string} url - Url of route.
   * @param {object} [options] - Options to pass in request.
   * @param {function} [callback] - Callback to call when the request finish.
   * @return {promise}
   */
  post(url, options, callback) {
    if (isFunction(options)) {
      callback = options;
      options = {};
    }
    return this.request({
      method: 'POST',
      json: true,
      uri: `${this.baseApiUrl}/${url}`,
      form: Object.assign({}, this.options, options),
    }, callback);
  }
 
  /**
   * @memberof Instagram
   * @function delete
   * @description Make a delete request to instagram api.
   *
   * @param {string} url - Url of route.
   * @param {object} [options] - Options to pass in request.
   * @param {function} [callback] - Callback to call when the request finish.
   * @return {promise}
   */
  delete(url, options, callback) {
    if (isFunction(options)) {
      callback = options;
      options = {};
    }
    return this.request({
      method: 'DELETE',
      json: true,
      uri: `${this.baseApiUrl}/${url}`,
      qs: Object.assign({}, this.options, options),
    }, callback);
  }
 
  /**
   * @memberof Instagram
   * @function stream
   * @description Create a new instagram stream.<br />
   * Streaming can be used on all endpoints taking MIN_TAG_ID as parameter.
   *
   * @param  {string} url
   * @param  {Object} [options]
   * @return {InstagramStream} A new instagram stream.
   */
  stream(url, options) {
    return new Stream(this, url, options);
  }
}
 
export default Instagram;