evrythng/src/scope/Scope.js

Official Javascript SDK for the EVRYTHNG API.

import isString from 'lodash-es/isString'
import api from '../api'
import symbols from '../symbols'

/**
 * Scope defines the context in which API calls are made. A scope is defined
 * by its API Key. That key is sent in each request's Authorization header that
 * uses this scope.
 */
export default class Scope {
  /**
   * Creates an instance of Scope.
   *
   * @param {string} apiKey API Key of scope
   * @param {Object} [data={}] Optional scope data
   */
  constructor (apiKey, data = {}) {
    if (!isString(apiKey)) {
      throw new Error('Scope constructor should be called with an API Key')
    }

    this.apiKey = apiKey

    // Extend scope with any given details.
    Object.assign(this, data)
  }

  /**
   * Read the scope's access data asynchronously.
   *
   * @returns {Promise}
   */
  readAccess () {
    return api({
      url: '/access',
      apiKey: this.apiKey
    })
  }

  /**
   * Read itself and extend scope document.
   *
   * @param {Settings} [options={}] - Optional API request options
   * @returns {Promise} - Updated operator scope
   */
  read (options = {}) {
    const opts = Object.assign(options, {
      method: 'get',
      url: this[symbols.path],
      apiKey: this.apiKey
    })

    return this._request(opts)
  }

  /**
   * Update self and extend scope document.
   *
   * @param {Object} data - Operator data
   * @param {Settings} [options={}] - Optional API request options
   * @returns {Promise} - Updated operator scope
   */
  update (data, options = {}) {
    const opts = Object.assign(options, {
      method: 'put',
      url: this[symbols.path],
      apiKey: this.apiKey,
      data
    })

    return this._request(opts)
  }

  // Private

  /**
   *
   * @param {Settings} options - Request options
   * @returns {Promise} - Updated operator scope
   * @private
   */
  _request (options) {
    return api(options).then((data) => Object.assign(this, data))
  }
}