RubyGems - envoy-cli - Versions diffs - 1.0.0rc1 - Mend

envoy-cli 1.0.0rc1

Files changed (51) hide show

checksums.yaml +7 -0
data/.gitignore +3 -0
data/.rspec +2 -0
data/.rubocop.yml +95 -0
data/.ruby-version +1 -0
data/Gemfile +4 -0
data/bin/envoy +12 -0
data/bin/envoy.bak +485 -0
data/bootstrap/base/.envoyrc +1 -0
data/bootstrap/base/.jshintrc +91 -0
data/bootstrap/base/.nvmrc +1 -0
data/bootstrap/base/config/.gitkeep +0 -0
data/bootstrap/base/docs/.gitkeep +0 -0
data/bootstrap/base/gulpfile.js +0 -0
data/bootstrap/base/i18n/.gitkeep +0 -0
data/bootstrap/base/index.js +5 -0
data/bootstrap/base/lib/.gitkeep +0 -0
data/bootstrap/base/routes/.gitkeep +0 -0
data/bootstrap/base/views/.gitkeep +0 -0
data/bootstrap/base/workers/.gitkeep +0 -0
data/bootstrap/events/generic.json +6 -0
data/bootstrap/events/host_notification.json +27 -0
data/bootstrap/events/route.json +6 -0
data/bootstrap/events/sms_host_notification.json +158 -0
data/bootstrap/templates/docs/about.md.erb +3 -0
data/bootstrap/templates/gitignore.erb +8 -0
data/bootstrap/templates/index.js.erb +5 -0
data/bootstrap/templates/license.md.erb +1 -0
data/bootstrap/templates/npmignore.erb +0 -0
data/bootstrap/templates/package.json +24 -0
data/bootstrap/templates/readme.md.erb +9 -0
data/bootstrap/templates/routes/callback.js.erb +10 -0
data/bootstrap/templates/routes/html.js.erb +9 -0
data/bootstrap/templates/routes/json.js.erb +9 -0
data/bootstrap/templates/routes/other.js.erb +9 -0
data/bootstrap/templates/views/hello.html.erb +91 -0
data/bootstrap/templates/views/starter.html.erb +10 -0
data/bootstrap/templates/worker.js.erb +10 -0
data/envoy-cli.gemspec +29 -0
data/lib/envoy.rb +70 -0
data/lib/envoy/version.rb +3 -0
data/lib/inc/commands.rb +74 -0
data/lib/inc/generator.rb +159 -0
data/lib/inc/mixins.rb +347 -0
data/lib/inc/runner.rb +21 -0
data/lib/tasks/plugin.rb +181 -0
data/lib/tasks/routes.rb +39 -0
data/lib/tasks/test.rb +68 -0
data/lib/tasks/workers.rb +39 -0
data/readme.md +0 -0
metadata +276 -0

data/bootstrap/templates/views/starter.html.erb ADDED Viewed

@@ -0,0 +1,10 @@
+<!DOCTYPE html>
+<html>
+  <head>
+    <meta charset="utf-8">
+    <title>Hello World</title>
+  </head>
+  <body>
+    Hello World
+  </body>
+</html>

data/bootstrap/templates/worker.js.erb ADDED Viewed

@@ -0,0 +1,10 @@
+/**
+ * Handle the <%=@job_name%> job
+ *
+ * @param  EnvoyRequest req
+ * @param  EnvoyResponse res
+ */
+module.exports = function(req, res) {
+  var data = {};
+  res.job_complete('status message', data);
+}

data/envoy-cli.gemspec ADDED Viewed

@@ -0,0 +1,29 @@
+$LOAD_PATH.push File.expand_path("../lib", __FILE__)
+require 'envoy/version'
+Gem::Specification.new do |spec|
+  spec.name        = 'envoy-cli'
+  spec.version     = Envoy::VERSION
+  spec.authors     = ["David Boskovic"]
+  spec.email       = ["david@envoy.com"]
+  spec.date        = '2016-03-18'
+  spec.summary     = 'Envoy platform command line interface.'
+  spec.description = 'The Envoy command line interface handles almost all the heavy lifting for you during '\
+                     'development of platform plugins.'
+  spec.files       = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.homepage    = 'http://rubygemspec.org/gems/envoy-cli'
+  spec.license     = 'MIT'
+  spec.add_runtime_dependency "thor",                    "~> 0.19", ">= 0.19.1"
+  spec.add_runtime_dependency "terminal-table",          "~> 1.5", ">= 1.5.2"
+  spec.add_runtime_dependency "colorize",                "~> 0.7", ">= 0.7.7"
+  spec.add_runtime_dependency "unirest",                 "~> 1.1", ">= 1.1.2"
+  spec.add_runtime_dependency "parseconfig",             "~> 1.0", ">= 1.0.8"
+  spec.add_runtime_dependency "coderay",                 "~> 1.1", ">= 1.1.1"
+  spec.add_runtime_dependency "launchy",                 "~> 2.4", ">= 2.4.3"
+  spec.add_runtime_dependency "tty",                     "~> 0.5", ">= 0.5.0"
+  spec.add_runtime_dependency "net-http-uploadprogress", "~> 2.0", ">= 2.0.0"
+  spec.bindir      = 'bin'
+  spec.executables << 'envoy'
+end

data/lib/envoy.rb ADDED Viewed

@@ -0,0 +1,70 @@
+require 'envoy/version'
+require 'thor'
+require 'inc/runner'
+require 'inc/commands'
+require 'inc/mixins'
+require 'inc/generator'
+require 'unirest'
+require 'colorize'
+project_root = File.dirname(File.absolute_path(__FILE__))
+Dir.glob("#{project_root}/tasks/**/*.rb", &method(:require))
+module Envoy
+  class Main < Commands
+    include Mixins
+    namespace :envoy
+    # Authenticates the user by storing their auth_token in ~/.envoy-cfg
+    # @param --local [String] will use localhost:3000 as the API url
+    # @param --path [String] can be used to override the endpoint for this profile
+    # @param --profile NAME [String] will save the login information for that profile, in order
+    #   to use that info, you must specify the same profile name on other requests
+    desc "login", "Login to your account"
+    option :path, type: :string
+    def login
+      # collect login information
+      email    = prompt.ask "Email:"
+      password = prompt.mask "Password:"
+      # attempt to obtain a working token
+      res = post('Authenticating', base_url!('oauth/token'), {
+        grant_type: 'password',
+        username:   email,
+        password:   password
+      })
+      # make sure the user has a developer account
+      post('Fetching developer profile', base_url!('./platform/developers'), {
+        access_token: res['access_token']
+      })
+      # save user to config
+      if options.profile && !config.groups.include?(options.profile)
+        config.groups.push options.profile
+      end
+      # setup data to save
+      conf = {
+        'email'        => email,
+        'access_token' => res['access_token']
+      }
+      conf['local']    = true         if options.local
+      conf['api_path'] = options.path if options.path
+      config.params[profile(options)] = conf
+      write_config!
+      say_status "Success", "You are now logged in.", :green
+    end
+  end
+end
+Runner.setup Envoy
+Runner.start

data/lib/envoy/version.rb ADDED Viewed

@@ -0,0 +1,3 @@
+module Envoy
+  VERSION = "1.0.0rc1".freeze
+end

data/lib/inc/commands.rb ADDED Viewed

@@ -0,0 +1,74 @@
+require 'thor'
+class Commands < Thor
+  include Thor::Actions
+  class_option :profile, type: :string
+  class_option :local, type: :boolean
+  class_option :debug, type: :boolean
+  class << self
+    def source_root
+      File.expand_path('../../bootstrap', File.dirname(__FILE__))
+    end
+    def setup(mod)
+      @mod = mod
+    end
+    # Override Thor#help so it can give information about any class and any method.
+    #
+    def help(shell, subcommand = false)
+      list = printable_commands(true, subcommand)
+      # puts Thor::Base.subclasses
+      thor_classes_in(@mod).each do |klass|
+        # puts klass.name
+        list += klass.printable_commands(false)
+      end
+      list.map! do |x|
+        x[0].sub!(basenamespace, '')
+        x
+      end
+      list.sort! do |a, b|
+        if a[0].include?(':') == false && b[0].include?(':') == true
+          out = -1
+        elsif a[0].include?(':') == true && b[0].include?(':') == false
+          out = +1
+        else
+          out = a[0] <=> b[0]
+        end
+        out
+      end
+      if defined?(@package_name) && @package_name
+        shell.say "#{@package_name} commands:"
+      else
+        shell.say "Commands:"
+      end
+      shell.print_table(list, indent: 2, truncate: true)
+      shell.say
+      class_options_help(shell)
+    end
+    def thor_classes_in(klass)
+      stringfied_constants = klass.constants.map &:to_s
+      out = Thor::Base.subclasses.select do |subclass|
+        next unless subclass.name
+        !stringfied_constants.select do |const|
+          subclass.name.gsub("#{klass.name}::", "").start_with?(const)
+        end.empty?
+      end
+      # puts out.inspect
+      out
+    end
+    def basenamespace
+      "#{basename}:"
+    end
+    def banner(command, _namespace = nil, subcommand = false)
+      "#{basename} #{command.formatted_usage(self, $thor_runner, subcommand).sub!(basenamespace, '')}"
+    end
+  end
+end

data/lib/inc/generator.rb ADDED Viewed

@@ -0,0 +1,159 @@
+require 'yaml'
+module Envoy
+  module Generator
+    def setup_directories
+      directory 'base', '.'
+    end
+    def setup_config
+      create_file 'config/default.json' do
+        JSON.pretty_generate({
+          'permissions'    => nil,
+          'installable_on' => ['location'],
+          'oauth2'         => {},
+          'schema'         => {},
+          'setup'          => [],
+          'routes'         => [],
+          'jobs_handled'   => {}
+        })
+      end
+    end
+    def setup_docs
+      template 'templates/docs/about.md.erb', 'docs/about.md'
+    end
+    def setup_i18n
+      create_file 'i18n/en.yaml' do
+        {
+          'welcome' => 'Welcome'
+        }.to_yaml
+      end
+    end
+    def setup_route(name, cfg = {})
+      @route_name = name
+      cfg[:type] ||= prompt.select("Choose route type:", ["html", "json", "callback", "other"])
+      template "templates/routes/#{cfg[:type]}.js.erb", "routes/#{name}.js"
+      if cfg[:type] == 'html'
+        cfg[:view] ||= 'starter'
+        template "templates/views/#{cfg[:view]}.html.erb", "views/#{name}.html"
+      end
+      # get profiles, if more than one show select with default
+      profiles = Dir.entries("#{destination_root}/config")
+                    .select { |file| file.end_with? '.json' }
+                    .map { |file| file.chomp('.json') }
+      if profiles.length > 1
+        profiles = prompt.multi_select("Select profiles to add route to:", profiles)
+      end
+      profiles.each do |profile|
+        data = read_data("config/#{profile}.json")
+        index = data['routes'].index { |x| x['handler'] == name }
+        route_data = {
+          "path"    => name,
+          "handler" => name
+        }
+        if index
+          data['routes'][index] = route_data
+        else
+          data['routes'].push route_data
+        end
+        write_data("config/#{profile}.json", data)
+      end
+    end
+    def teardown_route(name)
+      profiles = Dir.entries("#{destination_root}/config")
+                    .select { |file| file.end_with? '.json' }
+                    .map { |file| file.chomp('.json') }
+      if File.exist? "#{destination_root}/routes/#{name}.js"
+        remove_file "routes/#{name}.js"
+      else
+        say_status :info, "No route handler found for #{name}", :yellow
+      end
+      if File.exist? "#{destination_root}/views/#{name}.html"
+        remove_file "views/#{name}.html"
+      end
+      profiles.each do |profile|
+        data = read_data("config/#{profile}.json")
+        index = data['routes'].index { |x| x['handler'] == name }
+        if index
+          data['routes'].delete_at index
+          write_data("config/#{profile}.json", data)
+        else
+          say_status :info, "Route not in profile: #{profile}", :yellow
+        end
+      end
+    end
+    def get_profiles(choose = true)
+      profiles = Dir.entries("#{destination_root}/config")
+                    .select { |file| file.end_with? '.json' }
+                    .map { |file| file.chomp('.json') }
+      if choose && profiles.length > 1
+        profiles = prompt.multi_select("Select profiles to add configuration to:", profiles)
+      end
+      profiles
+    end
+    def setup_worker(name)
+      @job_name = name
+      template "templates/worker.js.erb", "workers/#{name}.js"
+      profiles = get_profiles
+      profiles.each do |profile|
+        data = read_data("config/#{profile}.json")
+        unless data['jobs_handled'][name]
+          data['jobs_handled'][name] = {}
+        end
+        write_data("config/#{profile}.json", data)
+      end
+    end
+    def teardown_worker(name)
+      profiles = Dir.entries("#{destination_root}/config")
+                    .select { |file| file.end_with? '.json' }
+                    .map { |file| file.chomp('.json') }
+      if File.exist? "#{destination_root}/workers/#{name}.js"
+        remove_file "workers/#{name}.js"
+      else
+        say_status :info, "No worker found for #{name}", :yellow
+      end
+      profiles.each do |profile|
+        data = read_data("config/#{profile}.json")
+        if data['jobs_handled'][name]
+          data['jobs_handled'].delete name
+          write_data("config/#{profile}.json", data)
+        else
+          say_status :info, "Worker not in profile: #{profile}", :yellow
+        end
+      end
+    end
+    def setup_license
+      template 'templates/license.md.erb', 'license.md'
+    end
+    def setup_dotfiles
+      template 'templates/gitignore.erb', '.gitignore'
+      template 'templates/npmignore.erb', '.npmignore'
+    end
+    def setup_npm
+      copy_file 'templates/package.json', 'package.json', force: true
+      data = read_data 'package.json'
+      data['name'] = @key
+      data['description'] = @description
+      data['version'] = @version
+      write_data 'package.json', data
+    end
+    def setup_readme
+      template 'templates/readme.md.erb', 'readme.md'
+    end
+    def setup_tests
+      say_status '@todo', 'bootstrap tests', :yellow
+      # template 'templates/tests/readme.md.erb', 'readme.md'
+    end
+  end
+end

data/lib/inc/mixins.rb ADDED Viewed

@@ -0,0 +1,347 @@
+require 'tty-prompt'
+require 'parseconfig'
+require 'json'
+require 'coderay'
+require 'unirest'
+require 'yaml'
+require "stringio"
+module Envoy
+  module Mixins
+    def post!(path, body = {}, headers = {})
+      debug('Start', "POST #{base_url(path)}")
+      debug('Request', CodeRay.scan(JSON.pretty_generate(body.is_a?(Hash) && body || JSON.parse(body)), :json).terminal)
+      res = Unirest.post(base_url(path), parameters: body, headers: headers)
+      debug("End", res.code.to_s)
+      if res.body.instance_of?(Hash)
+        debug("Body", CodeRay.scan(JSON.pretty_generate(res.body), :json).terminal)
+      else
+        debug("Body", res.body.to_s)
+      end
+      res
+    rescue => e
+      # puts e.message
+      error(e.message)
+      exit
+    end
+    def post(info, *args)
+      spin("Network: #{info}")
+      res = post!(*args)
+      if res.code.between?(200, 299)
+        spin_success
+      else
+        handle_errors(res)
+      end
+      res.body
+    end
+    def jsonapi_post(info, path, body = {}, headers = {})
+      headers[:'Content-Type'] = 'application/json'
+      headers[:Authorization] = "Bearer #{config[profile]['access_token']}"
+      post(info, path, { data: body }.to_json, headers)
+    end
+    def error(msg)
+      if spinner
+        spin_error msg
+      else
+        say_status 'Error', msg, :red
+      end
+    end
+    def handle_errors(res)
+      if res.body.instance_of?(Hash) && (res.body['errors'].nil? || res.body['errors'].empty?)
+        if res.body.dig('meta', 'message')
+          error(res.body.dig('meta', 'message'))
+        elsif res.body.dig('error_description')
+          error(res.body.dig('error_description'))
+        else
+          error('Unkown error occured')
+          say CodeRay.scan(JSON.pretty_generate(res.body), :json).terminal
+        end
+        exit
+      elsif res.body.instance_of? String
+        error 'Unkown error occured'
+        if agree("View full response body? (y/n)")
+          ask_editor res.body
+        end
+      elsif res.body.instance_of?(Hash)
+        res.body['errors'].each do |err|
+          error err['detail']
+        end
+      else
+        error 'Unkown error occured'
+        say res.body
+      end
+      spin_error
+      exit
+    end
+    def base_url!(path)
+      base_url(path, true)
+    end
+    def base_url(path, ignore_profile = false)
+      return path if path.start_with?('http://', 'https://')
+      local = false
+      cfg = config[profile]
+      if !ignore_profile && cfg['local']
+        local = true
+      end
+      if options.local
+        local = true
+      end
+      if local
+        if cfg && cfg['api_path_local']
+          base = cfg['api_path_local']
+        else
+          base = 'http://localhost:3000'
+        end
+      elsif ignore_profile && options.path
+        base = options.path
+      elsif cfg && cfg['api_path']
+        base = cfg['api_path']
+      else
+        base = 'https://app.envoy.com'
+      end
+      if path.start_with?('./')
+        path = 'api/v2/' + path[2..-1]
+      end
+      if path.start_with?('/')
+        path = path[1..-1]
+      end
+      if options.trace
+        debug 'URL', "#{base}/#{path}"
+      end
+      "#{base}/#{path}"
+    end
+    def debug(df, text, type = nil)
+      return unless options.trace || options.debug
+      say_status df, text, type
+    end
+    def debug_val(val, label)
+      debug label, val
+      val
+    end
+    def plugin_uuid
+      uuid = local_config["ENVOY_#{profile.upcase}_PLUGIN_UUID"]
+      unless uuid
+        error "No ENVOY_#{profile.upcase}_PLUGIN_UUID configuration"
+        exit
+      end
+      uuid
+    end
+    def profile(_ = false)
+      return debug_val(options.profile, 'Profile') if options.profile
+      cf = local_config
+      return debug_val(cf['ENVOY_PROFILE'], 'Profile') if cf['ENVOY_PROFILE']
+      debug_val('default', 'Profile')
+    end
+    def manifest
+      @manifest ||= JSON.parse(File.read(manifest_file)) || {}
+    end
+    def manifest_file(_ = false)
+      file = Dir.pwd + '/config/' + profile.downcase + '.json'
+      unless File.exist? file
+        file = Dir.pwd + '/config/default.json'
+        unless File.exist? file
+          error "Must have config/default.json or config/" + profile.downcase + '.json'
+          exit
+        end
+      end
+      debug_val file, 'Manifest'
+    end
+    def local_config
+      return @local_config if @local_config
+      unless File.exist? Dir.pwd + '/.envoyrc'
+        FileUtils.touch(Dir.pwd + '/.envoyrc')
+      end
+      @local_config = ParseConfig.new Dir.pwd + '/.envoyrc'
+    end
+    def print_event(event)
+      say "------------------------------------------------------------------------"
+      data = event['attributes']
+      say "Event UUID         => #{event['id']}".green
+      say "Timestamp          =>".yellow + " #{data['created-at']}"
+      say "Task Time          =>".yellow + " #{data['task-time']}ms"
+      say "Execution Time     =>".yellow + " #{data['process-time']}ms"
+      say "\n"
+      say "REQUEST META"
+      req_h = JSON.pretty_generate Envoy.min_json(data['request-meta'] || {})
+      say CodeRay.scan(req_h, :json).terminal(line_numbers: :table)
+      say "\n"
+      say "REQUEST BODY"
+      req_h = JSON.pretty_generate Envoy.min_json(data['request-body'] || {})
+      say CodeRay.scan(req_h, :json).terminal(line_numbers: :table)
+      say "\n"
+      say "REPONSE META"
+      req_h = JSON.pretty_generate Envoy.min_json(data['response-meta'] || {})
+      say CodeRay.scan(req_h, :json).terminal(line_numbers: :table)
+      say "\n"
+      say "RESPONSE BODY"
+      req_h = JSON.pretty_generate Envoy.min_json(data['response-body'] || {})
+      say CodeRay.scan(req_h, :json).terminal(line_numbers: :table)
+      say "\n"
+      say "LOG ENTRIES"
+      say data['tail']
+      # say data
+    end
+    def prompt
+      @prompt ||= TTY::Prompt.new
+    end
+    def config
+      @config ||= config!
+    end
+    def write_config!
+      file = File.open(Dir.home + '/.envoy-cfg', 'w')
+      config.write(file)
+      file.close
+    end
+    def write_local_config!
+      file = File.open(Dir.pwd + '/.envoyrc', 'w')
+      local_config.write(file)
+      file.close
+    end
+    def config!
+      if !File.exist?(Dir.home + '/.envoy-cfg')
+        file = File.open(Dir.home + '/.envoy-cfg', 'w')
+        cfg = ParseConfig.new
+        cfg.groups = ['default']
+        cfg.params = { 'default' => { 'access_token' => '', 'email' => '' } }
+        cfg.write(file)
+        file.close
+      else
+        cfg = ParseConfig.new Dir.home + '/.envoy-cfg'
+      end
+      cfg
+    end
+    def min_json(h)
+      out = {}
+      h.each do |key, val|
+        if val.instance_of?(String) && val.length > 500
+          val = '[long string, view specific record for full text]'
+        end
+        if val.instance_of?(Hash) && val.length > 20
+          if val['id']
+            out[key] = { id: val['id'], "[#{val.length} keys]": "..." }
+          else
+            out[key] = "{...#{val.length} keys}"
+          end
+        elsif val.instance_of?(Hash)
+          out[key] = min_json val
+        else
+          out[key] = val
+        end
+      end
+      out
+    end
+    attr_reader :spinner
+    def spin(task)
+      return if options.debug
+      if @spinner
+        @spinner.stop
+      end
+      spinner = TTY::Spinner.new(":spinner #{task}...", format: :spin_2, interval: 10)
+      spinner.start
+      @spinner = spinner
+    end
+    def spin_success(msg = nil)
+      return if options.debug
+      return unless @spinner
+      @spinner.success msg ? '> ' + msg : ''
+      @spinner = nil
+    end
+    def spin_error(msg = nil)
+      return if options.debug
+      return unless @spinner
+      @spinner.error msg ? '> ' + msg : ''
+      @spinner = nil
+    end
+    def read_data(file)
+      rfile = file
+      unless file.start_with? '/'
+        rfile = "#{destination_root}/#{file}"
+      end
+      unless File.exist? rfile
+        return {}
+      end
+      src = File.read rfile
+      return JSON.parse(src) if file.end_with? '.json'
+      return YAML.load(src) if file.end_with? '.yaml'
+      raise "Can only read data from json or yaml files."
+    end
+    def write_data(file, data)
+      rfile = file
+      unless file.start_with? '/'
+        rfile = "#{destination_root}/#{file}"
+      end
+      if file.end_with? '.json'
+        out = JSON.pretty_generate(data)
+      elsif file.end_with? '.yaml'
+        out = YAML.dump(data)
+      else
+        raise "Can only write data from json or yaml files."
+      end
+      File.write(rfile, out)
+      say_status :updated, file, :green
+    end
+    def indent(depth = 7)
+      start_indent depth
+      yield
+    ensure
+      stop_indent
+    end
+    def file_exist?(file)
+      File.exist?(Dir.pwd + '/' + file)
+    end
+    def start_indent(depth = 7)
+      $real_stdout = $stdout
+      $stdout_depth = depth
+      $stdout = StringIO.new
+      closure = lambda do |*args|
+        args.each do |line|
+          $real_stdout.puts(("  " * $stdout_depth) + line)
+        end
+      end
+      $stdout.define_singleton_method(:print, closure)
+      $stdout.define_singleton_method(:puts, closure)
+    end
+    def stop_indent
+      $stdout = $real_stdout
+    end
+    def pretty_json(body)
+      CodeRay.scan(JSON.pretty_generate(body.is_a?(Hash) && body || JSON.parse(body)), :json).terminal
+    end
+    def indent_lines(str, pad = 7)
+      str.each_line.map { |l| ('  ' * pad) + l }.join
+    end
+  end
+end