evrythng/src/entity/Redirection.js

Official Javascript SDK for the EVRYTHNG API.

import Entity from './Entity'
import Resource from '../resource/Resource'
import Scope from '../scope/Scope'
import settings from '../settings'

/**
 * Represents a Redirection entity.
 *
 * @extends Entity
 */
export default class Redirection extends Entity {
  /**
   * Return simple resource factory for Redirections.
   *
   * @static
   * @return {{redirection: Function}}
   */
  static resourceFactory () {
    return {
      redirection (shortDomain = settings.defaultShortDomain) {
        // Only allowed on Entities and Resources.
        if (this instanceof Scope) {
          throw new Error('Redirection is not a top-level resource.')
        }

        const _this = this

        /**
         * Helper for repetitive shortDomain focussed requests.
         *
         * @param {object} changes - Additional options.
         * @returns {Promise<object>} API response.
         */
        const shortDomainRequest = async (changes) =>
          Resource.prototype._request.call(
            _this,
            Object.assign(
              {
                apiUrl: `https://${shortDomain}`,
                url: '/redirections',
                headers: {
                  Accept: 'application/json'
                }
              },
              changes
            )
          )

        // Special case: use the shortDomain API instead of the /redirector API.
        return {
          /**
           * Create the redirection.
           *
           * @param {object} payload - Redirection payload.
           */
          async create (payload) {
            payload.evrythngId = _this.id
            payload.type = _this.typeName

            return shortDomainRequest({
              method: 'post',
              body: JSON.stringify(payload)
            })
          },

          /**
           * Read the redirection.
           */
          async read () {
            const [first] = await shortDomainRequest({
              params: { evrythngId: _this.id }
            })
            return first
          },

          /**
           * Update the redirection. If it doesn't exist, it is created.
           *
           * @param {object} payload - Redirection update payload.
           */
          async update (payload) {
            const existing = await this.read()
            if (!existing) {
              return this.create(payload)
            }

            // Else update it
            return shortDomainRequest({
              url: `/redirections/${existing.shortId}`,
              method: 'put',
              body: JSON.stringify(payload)
            })
          },

          /**
           * Delete the redirection, if it exists.
           */
          async delete () {
            const existing = await this.read()
            if (!existing) {
              return Promise.resolve()
            }

            // Else delete it
            return shortDomainRequest({
              url: `/redirections/${existing.shortId}`,
              method: 'delete'
            })
          }
        }
      }
    }
  }
}