kinvey-cli/lib/project.coffee

Utility for deploying and managing FlexServices on Kinvey's FlexService Runtime

###
Copyright 2016 Kinvey, Inc.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
###

# Package modules.
async  = require 'async'
chalk  = require 'chalk'
config = require 'config'

# Local modules.
KinveyError = require './error.coffee'
logger = require './logger.coffee'
prompt = require './prompt.coffee'
user   = require './user.coffee'
util   = require './util.coffee'

# Define the project class.
class Project

  # App, service, and schema.
  app           : null
  org           : null
  service       : null
  serviceName   : null
  schemaVersion : null
  lastJobId     : null

  # Constructor.
  constructor: (path) ->
    this.projectPath = path

  # Configures the project.
  config: (options, cb) =>
    this.select cb

  # Returns whether the project is configured.
  isConfigured: () =>
    return this.service? and this.schemaVersion?

  # Lists all Kinvey datalinks.
  list: (cb) =>
    this._execKinveyServices (err, services) =>
      if err? then cb err # Continue with error.
      else # Log info.
        logger.info 'You have %s Kinvey service connectors:', chalk.cyan services.length
        services.forEach (service) =>
          # Highlight the active service.
          bullet = if service.id is this.service then chalk.green '* ' else ''
          logger.info '%s%s', bullet, chalk.cyan(service.name)
        logger.info 'The service used in this project is marked with *'
        cb() # Continue.

  logout: (cb) =>
    logger.debug 'Clearing project configuration from file %s', chalk.cyan this.projectPath
    logger.info 'Session and project data cleared. Run %s to get started.', chalk.green 'kinvey config', chalk.cyan '[instance]'
    util.writeJSON this.projectPath, '', cb

  # Restores the project from file.
  restore: (cb) =>
    logger.debug 'Restoring project from file %s', chalk.cyan this.projectPath
    util.readJSON this.projectPath, (err, data) =>
      if err? then return cb new KinveyError 'ProjectRestoreError'
      if data?.service? # Save ids.
        logger.debug 'Restored project from file %s', chalk.cyan this.projectPath
        this.service       = data.service
        this.serviceName   = data.serviceName
        this.schemaVersion = data.schemaVersion
        this.lastJobId     = data.lastJobId
        return cb()
      logger.debug 'Failed to restore project from file %s', chalk.cyan this.projectPath
      cb new KinveyError 'ProjectNotConfigured' # Continue with error.

  # Saves the project details to file.
  save: (cb) =>
    logger.debug 'Saving project to file %s', chalk.cyan this.projectPath
    util.writeJSON this.projectPath, {
      service       : this.service
      serviceName   : this.serviceName
      schemaVersion : this.schemaVersion
      lastJobId     : this.lastJobId
    }, cb

  # Selects and save app, and service.
  select: (cb) =>
    async.series [
      this._selectAppOrOrg
      this._selectService
      this.save
    ], cb

  # Sets up the project.
  setup: (options, cb) =>
    # Attempt to restore the project from file.
    this.restore (err) =>
      if !this.isConfigured() # Not configured, prompt for details.
        this.select cb
      else cb err # Continue.

  # Executes a GET /apps request.
  _execApps: (cb) ->
    util.makeRequest { url: '/apps' }, (err, response) ->
      cb err, response?.body

  # Returns eligible Kinvey datalinks.
  _execKinveyServices: (cb) =>
    this._execServices (err, body) ->
      if err? then cb err # Continue with error.
      else # Filter and sort by name.
        body = body.filter (el) -> 'internal' is el.type
        body.sort (x, y) -> # Sort.
          if x.name.toLowerCase() < y.name.toLowerCase() then -1 else 1
        cb null, body

  # Executes a GET /apps request.
  _execOrgs: (cb) ->
    util.makeRequest { url: '/organizations' }, (err, response) ->
      cb err, response?.body

  # Executes a GET /apps/:app/datalinks request.
  _execServices: (cb) ->
    if this.org?
      resourceType = 'organizations'
      entity = this.org
    else
      resourceType = 'apps'
      entity = this.app

    util.makeRequest {
      url: "/v#{this.schemaVersion}/#{resourceType}/#{entity}/data-links"
    }, (err, response) ->
      cb err, response?.body

  # Attempts to select an app.
  _selectApp: (cb) =>
    async.waterfall [
      this._execApps
      (apps, next) ->
        if 0 is apps.length then next new KinveyError 'NoAppsFound'
        else prompt.getApp apps, next
    ], (err, app) =>
      if app? # Save.
        this.org           = null
        this.app           = app.id
        this.schemaVersion = app.schemaVersion or config.defaultSchemaVersion
      cb err # Continue.

  # Prompts user to select an app or organization.
  _selectAppOrOrg: (cb) =>
    options = [{
      name: 'App'
    }, {
      name: 'Organization'
    }]
    prompt.getAppOrOrg options, (err, choice) =>
      if choice.name is 'App' then this._selectApp cb
      else this._selectOrg cb

  # Attempts to select an org.
  _selectOrg: (cb) =>
    async.waterfall [
      this._execOrgs
      (orgs, next) ->
        if 0 is orgs.length then next new KinveyError 'NoOrgsFound'
        else prompt.getOrg orgs, next
    ], (err, org) =>
      if org? # Save.
        this.app           = null
        this.org           = org.id
        this.schemaVersion = 2 # TODO fix this
      cb err # Continue.

  # Attempts to select the service
  _selectService: (cb) =>
    async.waterfall [
      this._execKinveyServices
      (services, next) ->
        if 0 is services.length then next new KinveyError 'NoFlexServicesFound'
        else prompt.getService services, next
    ], (err, service) =>
      if service?
        this.service = service.id
        this.serviceName = service.name
      cb err # Continue.

# Exports.
module.exports = new Project config.paths.project