nex_client 0.17.0 → 0.18.0.pre1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 08b088941d2119c0e8b7e1e61bdcf74dd622ba60
-  data.tar.gz: acf4d046a21edeb0e95873c7dfbeda06e25df751
+  metadata.gz: 66bd6974504b943354286cb011099b8253e2556b
+  data.tar.gz: 35dccc4896e4a3b77903803fcde4f828b4254d88
 SHA512:
-  metadata.gz: e39b32c047894a572757b5b90317ad1d0dfc9f78f27a4ffe3db123266539ae0924ee5632b0a88c223f778fd4b0c8e97efcf6a64abedd40a3f8434f9982cddcf6
-  data.tar.gz: bad64e27e601910f2445c6247f63aa7bddd669bb5409fbc592262e901908dc71030b313c613ad10047d2b1d5e523ddf5f679aee67a9c1c3d22e8300a630aa208
+  metadata.gz: cec6f39591d8d9fcdc00b5f5c6c263c488daefa1cd537a15f7cefbaac547fd9e0c617f77e7a460c4eab26c7f755e7ba2062742b25903ce340eb38f18fbb52e61
+  data.tar.gz: 41b075642837ce12f28bb4da41695b327fe68c6e02429cd29cc9401d9486c01ee91db32a051ccb65d8a31ff2a259e794e6b7ae23802b750cbd8e0bfd0b9414d4

data/lib/nex_client.rb

@@ -2,6 +2,7 @@
 require 'json_api_client'
 require 'active_support/all'
 require 'nex_client/version'
+require 'nex_client/faraday_middleware'
 require 'launchy'
 
 module NexClient
@@ -13,6 +14,7 @@ module NexClient
   autoload :CubeTemplate, 'nex_client/cube_template'
   autoload :Domain, 'nex_client/domain'
   autoload :Event, 'nex_client/event'
+  autoload :ExecCmd, 'nex_client/exec_cmd'
   autoload :ExecTask, 'nex_client/exec_task'
   autoload :GatewayRack, 'nex_client/gateway_rack'
   autoload :Me, 'nex_client/me'
@@ -21,4 +23,8 @@ module NexClient
   autoload :SslCertificate, 'nex_client/ssl_certificate'
   autoload :StorageRack, 'nex_client/storage_rack'
   autoload :User, 'nex_client/user'
+
+  def self.interactive?
+     defined?(NexClient::Cli) && ENV['NEX_ENV'] != 'test'
+  end
 end

data/lib/nex_client/addon.rb

@@ -15,5 +15,20 @@ module NexClient
 
     # PATCH <api_root>/addons/:id/scale_down
     custom_endpoint :scale_down, on: :member, request_method: :patch
+
+    def self.main_key
+      :name
+    end
+
+    def preferred_region
+      super
+    rescue
+      NexClient::Addon.includes(:app)
+        .with_params(fields: { apps: :preferred_region })
+        .find(id)
+        .first
+        .app
+        .preferred_region
+    end
   end
 end

data/lib/nex_client/app.rb

@@ -24,6 +24,10 @@ module NexClient
     # GET <api_root>/apps/:id/logs
     custom_endpoint :logs, on: :member, request_method: :get
 
+    def self.main_key
+      :name
+    end
+
     def preferred_url
       domain = self.domains.first rescue NexClient::Domain.find('origin.name' => self.name).first
       if domain

data/lib/nex_client/base_resource.rb

@@ -12,10 +12,25 @@ module NexClient
     API_HOST = ENV['NEX_ENDPOINT'] || HOST_MAPPING[ENVIRONMENT]
 
     self.site = "#{API_HOST}#{API_ROOT_PATH}"
+
+    def self.entities_name
+      entity_name.pluralize
+    end
+
+    def self.entity_name
+      to_s.split('::').last.parameterize
+    end
+
+    def self.main_key
+      :id
+    end
   end
 end
 
 NexClient::BaseResource.connection do |connection|
   # Set Auth
   connection.use Faraday::Request::BasicAuthentication, ENV['NEX_API_KEY'], ''
+
+  # Handle Response Errors including MFA authentication errors
+  connection.use NexClient::FaradayMiddleware::HandleNexApiErrors
 end

data/lib/nex_client/cli.rb

@@ -38,7 +38,6 @@ module NexClient
         c.example 'create redis addon for myapp', 'nex-cli addons:create redis myapp'
         c.option '--size SIZE', Integer, 'specify container size (default: 2, min: 1, max: 20). Container will have N shares of CPU and N*128M of memory.'
         c.option '--http-log-drain DRAIN_URL', String, 'specify the URL of a remote log drain'
-        c.option '--region-balancing REGIONS', String, 'specify how the addon should be proportionally distributed geographically. E.g. "all" or "ap-southeast-1,us-west-2" or "ap-southeast-1=1,us-west-2=2".'
         c.action do |args, options|
           NexClient::Commands::Addons.create(args,options)
         end
@@ -68,16 +67,7 @@ module NexClient
       end
 
       command :'addons:events' do |c|
-        c.syntax = 'nex-cli addons:events APP_NAME [options]'
-        c.summary = 'Gather system events'
-        c.description = 'Gather system events for a given addon'
-        c.example 'display events for myaddon', 'nex-cli addons:events myaddon'
-        c.example 'display 100 events for myaddon', 'nex-cli addons:events --tail 100 myaddon'
-        c.option '--tail NUMBER', String, 'number of events to retrieve (default: 50)'
-        c.option '--type TYPE', String, 'filter events on type (e.g. status, container)'
-        c.action do |args, options|
-          NexClient::Commands::Addons.events(args,options)
-        end
+        NexClient::Commands::Events.configure(c, NexClient::Addon)
       end
 
       command :'addons:info' do |c|
@@ -92,15 +82,7 @@ module NexClient
       end
 
       command :'addons:logs' do |c|
-        c.syntax = 'nex-cli addons:logs ADDON_NAME [options]'
-        c.summary = 'Gather addon logs'
-        c.description = 'Gather container logs for a given addon'
-        c.example 'gather logs for myaddon', 'nex-cli addons:logs myaddon'
-        c.example 'gather logs for myapp with a tail of 50', 'nex-cli addons:logs --tail 50 myaddon'
-        c.option '--tail NUMBER', String, 'number of lines to retrieve for each container'
-        c.action do |args, options|
-          NexClient::Commands::Addons.logs(args,options)
-        end
+        NexClient::Commands::Logs.configure(c, NexClient::Addon)
       end
 
       command :'addons:restart' do |c|
@@ -136,17 +118,17 @@ module NexClient
         end
       end
 
+      command :'addons:policies' do |c|
+        NexClient::Commands::Policies.configure(c, NexClient::Addon)
+      end
+
       command :'addons:update' do |c|
         c.syntax = 'nex-cli addons:update ADDON_NAME [options]'
         c.summary = 'Update addon settings'
         c.description = 'Update addon settings'
         c.example 'change container size to 4', 'nex-cli addons:update myaddon --size 4'
-        c.example 'balance containers equally between regions', 'nex-cli apps:update myapp --region-balancing="ap-southeast-1,us-west-2"'
-        c.example 'deploy more containers in one region', 'nex-cli apps:update myapp --region-balancing="ap-southeast-1=1,us-west-2=2"'
-        c.example 'scale containers across all regions', 'nex-cli apps:update myapp --region-balancing=all'
         c.option '--size SIZE', Integer, 'change container size (default: 2, min: 1, max: 20). Container will have N shares of CPU and N*128M of memory. [restart required]'
         c.option '--http-log-drain DRAIN_URL', String, 'specify the URL of a remote log drain. [restart required]'
-        c.option '--region-balancing REGIONS', String, 'specify how scalability should be handled per region. E.g. "all" or "ap-southeast-1,us-west-2" or "ap-southeast-1=1,us-west-2=2".'
         c.action do |args, options|
           NexClient::Commands::Addons.update(args,options)
         end
@@ -189,7 +171,6 @@ module NexClient
         c.option '--desc DESCRIPTION', String, 'description for this application (140 characters max)'
         c.option '--tags TAG_LIST', Array, 'comma separated list of tags describing this app'
         c.option '--region REGION', String, 'default region to use deploy/scale this application'
-        c.option '--region-balancing REGIONS', String, 'specify how scalability should be handled per region. E.g. "all" or "ap-southeast-1,us-west-2" or "ap-southeast-1=1,us-west-2=2".'
         c.action do |args, options|
           NexClient::Commands::Apps.create(args,options)
         end
@@ -219,16 +200,7 @@ module NexClient
       end
 
       command :'apps:events' do |c|
-        c.syntax = 'nex-cli apps:events APP_NAME [options]'
-        c.summary = 'Gather system events'
-        c.description = 'Gather system events for a given app'
-        c.example 'display events for myapp', 'nex-cli apps:events myapp'
-        c.example 'display 100 events for myapp', 'nex-cli apps:events --tail 100 myapp'
-        c.option '--tail NUMBER', String, 'number of events to retrieve (default: 50)'
-        c.option '--type TYPE', String, 'filter events on type (e.g. status, container)'
-        c.action do |args, options|
-          NexClient::Commands::Apps.events(args,options)
-        end
+        NexClient::Commands::Events.configure(c, NexClient::App)
       end
 
       command :'apps:info' do |c|
@@ -242,16 +214,12 @@ module NexClient
         end
       end
 
+      command :'apps:ip-rules' do |c|
+        NexClient::Commands::IpWhitelisting.configure(c)
+      end
+
       command :'apps:logs' do |c|
-        c.syntax = 'nex-cli apps:logs APP_NAME [options]'
-        c.summary = 'Gather app logs'
-        c.description = 'Gather container logs for a given app'
-        c.example 'gather logs for myapp', 'nex-cli apps:logs myapp'
-        c.example 'gather logs for myapp with a tail of 50', 'nex-cli apps:logs --tail 50 myapp'
-        c.option '--tail NUMBER', String, 'number of lines to retrieve for each container'
-        c.action do |args, options|
-          NexClient::Commands::Apps.logs(args,options)
-        end
+        NexClient::Commands::Logs.configure(c, NexClient::App)
       end
 
       command :'apps:restart' do |c|
@@ -316,6 +284,20 @@ module NexClient
         end
       end
 
+      command :'apps:open' do |c|
+        c.syntax = 'nex-cli apps:open APP_NAME'
+        c.summary = 'Open app url'
+        c.description = 'Open app in your browser'
+        c.example 'open app for myapp', 'nex-cli apps:open myapp'
+        c.action do |args, options|
+          NexClient::Commands::Apps.open(args,options)
+        end
+      end
+
+      command :'apps:policies' do |c|
+        NexClient::Commands::Policies.configure(c, NexClient::App)
+      end
+
       command :'apps:up' do |c|
         c.syntax = 'nex-cli apps:up APP_NAME [options]'
         c.summary = 'Scale applications up'
@@ -337,71 +319,23 @@ module NexClient
 
           Log drain:
           ----------
-          Use: --http-log-drain DRAIN_URL
-          The log drain is a HTTP(s) URL where application logs will be POSTed.
+            Use: --http-log-drain DRAIN_URL
+            The log drain is a HTTP(s) URL where application logs will be POSTed.
 
           Default region:
           ---------------
-          Use: --region REGION
-          Containers will be deployed in the specified region by default if no region-balancing
-          policies have been specified. This is only relevant when the Nex!™ platform has been deployed in multiple regions.
-
-          Geo-Balancing:
-          ---------------
-          Use: --region-balancing REGIONS
-          Specify how your containers should be distributed across the available Nex!™ regions. This is only relevant when the Nex!™ platform has been deployed
-          in multiple regions.
-
-          Options are the following:
-            - evenly distribute across all regions: --region-balancing=all
-            - eventy distribute across specified regions: --region-balancing="ap-southeast-1,us-west-2"
-            - distribute with relative weights: --region-balancing="ap-southeast-1=1,us-west-2=2"
-
-          Web Application Firewall (WAF)
-          ------------------------------
-          Use: --waf-rules [PATH]
-          Specify a JSON (.json) or YAML (.yml) file describing the security rules to apply/ignore. If no files are specified you will be prompted to
-          paste rules in JSON format in the terminal.
-          The WAF always runs in SIMULATE mode by default - this means security events will be logged but no requests will be blocked.
-
-          The list of base rules applied by default is available here: https://github.com/p0pr0ck5/lua-resty-waf/tree/master/rules
-
-          The base WAF behaviour can be extended by passing a JSON (or YAML) manifest to '--waf-rules' with the following format:
-            {
-              // Whether the WAF should be enabled, disabled or do log-only
-              // 'ACTIVE', 'INACTIVE' or 'SIMULATE'
-              "mode": "SIMULATE",
-
-              // Array of rule IDs to ignore
-              "ignore_rule": [],
-
-              // Array of rulesets to ignore
-              "ignore_ruleset": [],
-
-              // Array of ['rulename','rule'] objects
-              "add_ruleset_string": [],
-
-              // Rules sieves allow you to apply/ignore rules based on a
-              // specific context such as request parameters
-              // Array of ['rule_id', [{ sieve_cond }, { sieve_cond }] ] objects
-              "sieve_rule": []
-            }
-          See this for more info: https://github.com/p0pr0ck5/lua-resty-waf
-          See this for rule sieves: https://github.com/p0pr0ck5/lua-resty-waf/wiki/Rule-Sieves
+            Use: --region REGION
+            Containers will be deployed in the specified region by default if no region-balancing
+            policies have been specified. This is only relevant when the Nex!™ platform has been deployed in multiple regions.
 
         HEREDOC
         c.example 'change container size to 4', 'nex-cli apps:update myapp --size 4'
-        c.example 'balance containers equally between regions', 'nex-cli apps:update myapp --region-balancing="ap-southeast-1,us-west-2"'
-        c.example 'deploy more containers in one region', 'nex-cli apps:update myapp --region-balancing="ap-southeast-1=1,us-west-2=2"'
-        c.example 'scale containers across all regions', 'nex-cli apps:update myapp --region-balancing=all'
         c.option '--desc DESCRIPTION', String, 'update the application description'
         c.option '--http-log-drain DRAIN_URL', String, 'specify the URL of a remote log drain. [restart required]'
         c.option '--image-tag IMAGE_TAG', String, 'update the docker image tag [restart required]'
         c.option '--size SIZE', Integer, 'change container size (default: 2, min: 1, max: 20). Container will have N shares of CPU and N*128M of memory. [restart required]'
         c.option '--tags TAG_LIST', String, 'comma separated list of tags to use to describe the app'
         c.option '--region REGION', String, 'default region to use deploy/scale this application'
-        c.option '--region-balancing REGIONS', String, 'specify how the app should be proportionally distributed geographically. E.g. "all" or "ap-southeast-1,us-west-2" or "ap-southeast-1=1,us-west-2=2". [restart required]'
-        c.option '--waf-rules [PATH]', String, 'specify web application firewall rules using JSON or YAML file (prompt will appear otherwise). [restart required]'
         c.action do |args, options|
           NexClient::Commands::Apps.update(args,options)
         end
@@ -429,14 +363,8 @@ module NexClient
         end
       end
 
-      command :'apps:open' do |c|
-        c.syntax = 'nex-cli apps:open APP_NAME'
-        c.summary = 'Open app url'
-        c.description = 'Open app in your browser'
-        c.example 'open app for myapp', 'nex-cli apps:open myapp'
-        c.action do |args, options|
-          NexClient::Commands::Apps.open(args,options)
-        end
+      command :'apps:waf' do |c|
+        NexClient::Commands::Waf.configure(c)
       end
 
       command :certs do |c|
@@ -509,16 +437,7 @@ module NexClient
       end
 
       command :'cubes:events' do |c|
-        c.syntax = 'nex-cli cubes:events CUBE_ID [options]'
-        c.summary = 'Gather system events'
-        c.description = 'Gather system events for a given cube'
-        c.example 'display events for mycube', 'nex-cli cubes:events mycube'
-        c.example 'display 100 events for mycube', 'nex-cli cubes:events --tail 100 mycube'
-        c.option '--tail NUMBER', String, 'number of events to retrieve (default: 50)'
-        c.option '--type TYPE', String, 'filter events on type (e.g. status, container)'
-        c.action do |args, options|
-          NexClient::Commands::CubeInstances.events(args,options)
-        end
+        NexClient::Commands::Events.configure(c, NexClient::CubeInstance)
       end
 
       command :'cubes:info' do |c|
@@ -532,15 +451,7 @@ module NexClient
       end
 
       command :'cubes:logs' do |c|
-        c.syntax = 'nex-cli cubes:logs CUBE_ID [options]'
-        c.summary = 'Gather cube logs'
-        c.description = 'Gather container logs for a given cube'
-        c.example 'gather logs for mycube', 'nex-cli cubes:logs mycube'
-        c.example 'gather logs for mycube with a tail of 50', 'nex-cli cubes:logs --tail 50 mycube'
-        c.option '--tail NUMBER', String, 'number of lines to retrieve (default: 30)'
-        c.action do |args, options|
-          NexClient::Commands::CubeInstances.logs(args,options)
-        end
+        NexClient::Commands::Logs.configure(c, NexClient::CubeInstance)
       end
 
       command :'cubes:restart' do |c|

data/lib/nex_client/commands.rb

@@ -8,11 +8,16 @@ module NexClient
     autoload :CubeInstances, 'nex_client/commands/cube_instances'
     autoload :CubeTemplates, 'nex_client/commands/cube_templates'
     autoload :Domains, 'nex_client/commands/domains'
+    autoload :Events, 'nex_client/commands/events'
     autoload :ExecTasks, 'nex_client/commands/exec_tasks'
     autoload :Helpers, 'nex_client/commands/helpers'
+    autoload :IpWhitelisting, 'nex_client/commands/ip_whitelisting'
+    autoload :Logs, 'nex_client/commands/logs'
     autoload :Organizations, 'nex_client/commands/organizations'
+    autoload :Policies, 'nex_client/commands/policies'
     autoload :Racks, 'nex_client/commands/racks'
     autoload :SslCertificates, 'nex_client/commands/ssl_certificates'
     autoload :Users, 'nex_client/commands/users'
+    autoload :Waf, 'nex_client/commands/waf'
   end
 end

data/lib/nex_client/commands/addons.rb

@@ -60,21 +60,6 @@ module NexClient
         Apps.display_apps(e.app)
       end
 
-      def self.logs(args,opts)
-        name = args.first
-        e = NexClient::Addon.find(name: name).first
-
-        # Display error
-        unless e
-          error("Error! Could not find addon: #{name}")
-          return false
-        end
-
-        # Retrieve logs and display them
-        logs = e.logs(tail: opts.tail).first
-        self.display_logs(logs.log_ret)
-      end
-
       # SSH to the addon
       def self.ssh(args,opts)
         name = args.first
@@ -105,8 +90,8 @@ module NexClient
         attrs[:service] = svc_name
         attrs[:container_size] = opts.size if opts.size.present?
 
-        # Additional options (log drain, region balancing)
-        attrs[:opts] = self.extract_config_options(opts)
+        # Option: http_log_drain
+        attrs[:opts] = { 'http_log_drain' => opts.http_log_drain } if opts.http_log_drain.present?
 
         addon = NexClient::Addon.new(attrs)
         addon.relationships.attributes = { app: { data: { type: 'apps', id: app.id } } }
@@ -136,9 +121,11 @@ module NexClient
         attrs = {}
         attrs[:container_size] = opts.size if opts.size.present?
 
-        # Additional options (log drain, region balancing)
-        # Hash#dup is required for the resource to detect changes
-        attrs[:opts] = (e.opts || {}).dup.merge(self.extract_config_options(opts))
+        # Option: http_log_drain
+        if opts.http_log_drain.present?
+          attrs[:opts] = (e.opts || {}).dup
+          attrs[:opts]['http_log_drain'] = opts.http_log_drain
+        end
 
         # Update
         e.update_attributes(attrs)
@@ -240,7 +227,10 @@ module NexClient
       def self.display_options(list)
         table = Terminal::Table.new title: OPTS_TITLE, headings: OPTS_HEADERS do |t|
           [list].flatten.compact.each do |e|
-            e.each { |k,v| t.add_row([k,v]) }
+            e.each do |k,v|
+              val = v.is_a?(Hash) || v.is_a?(Array) ? JSON.pretty_generate(v) : v
+              t.add_row([k,val])
+            end
           end
         end
         puts table
@@ -269,16 +259,6 @@ module NexClient
         return '-' unless record.node_count && record.max_node_count
         "#{record.node_count}/#{record.max_node_count}"
       end
-
-      def self.extract_config_options(cli_opts)
-        hash = {}
-        %w(http_log_drain region_balancing).each do |opt_name|
-          if cli_opts.method_missing(opt_name.to_sym).present?
-            hash[opt_name.to_s] = cli_opts.method_missing(opt_name.to_sym)
-          end
-        end
-        return hash
-      end
     end
   end
 end

data/lib/nex_client/commands/apps.rb

@@ -92,22 +92,6 @@ module NexClient
         Launchy.open(url)
       end
 
-      # Retrieve application logs from all containers
-      def self.logs(args,opts)
-        name = args.first
-        e = NexClient::App.find(name: name).first
-
-        # Display error
-        unless e
-          error("Error! Could not find app: #{name}")
-          return false
-        end
-
-        # Retrieve logs and display them
-        logs = e.logs(tail: opts.tail).first
-        self.display_logs(logs.log_ret)
-      end
-
       # SSH to the app
       def self.ssh(args,opts)
         name = args.first
@@ -135,8 +119,8 @@ module NexClient
         attrs[:tag_list] = opts.tags if opts.tags.present?
         attrs[:preferred_region] = opts.region if opts.region.present?
 
-        # Additional options (log drain, region balancing)
-        attrs[:opts] = self.extract_config_options(opts)
+        # Option: http_log_drain
+        attrs[:opts] = { 'http_log_drain' => opts.http_log_drain } if opts.http_log_drain.present?
 
         # Env variables via command line
         if opts.env.present?
@@ -199,20 +183,10 @@ module NexClient
         attrs[:image_tag] = opts.image_tag if opts.image_tag.present?
         attrs[:preferred_region] = opts.region if opts.region.present?
 
-        # Additional options (log drain, region balancing)
-        # Hash#dup is required for the resource to detect changes
-        attrs[:opts] = (e.opts || {}).dup.merge(self.extract_config_options(opts))
-
-        if opts.waf_rules
-          waf_rules = begin
-            if opts.waf_rules.is_a?(String)
-              hash_from_file(opts.waf_rules)
-            else
-              val = ask("Copy/paste your WAF configuration below in JSON format:") { |q| q.gather = "" }
-              JSON.parse(val.join(""))
-            end
-          end
-          attrs[:opts]['waf_rules'] = waf_rules
+        # Option: http_log_drain
+        if opts.http_log_drain.present?
+          attrs[:opts] = (e.opts || {}).dup
+          attrs[:opts]['http_log_drain'] = opts.http_log_drain
         end
 
         # Update
@@ -445,7 +419,7 @@ module NexClient
         table = Terminal::Table.new title: OPTS_TITLE, headings: OPTS_HEADERS, style: { all_separators: true} do |t|
           [list].flatten.compact.each do |e|
             e.each do |k,v|
-              val = v.is_a?(Hash) ? JSON.pretty_generate(v) : v
+              val = v.is_a?(Hash) || v.is_a?(Array) ? JSON.pretty_generate(v) : v
               t.add_row([k,val])
             end
           end
@@ -453,7 +427,7 @@ module NexClient
         puts table
         puts "\n"
       end
-      
+
       def self.display_scm(list)
         table = Terminal::Table.new title: SCM_TITLE, headings: SCM_HEADERS do |t|
           [list].flatten.compact.each do |e|
@@ -495,16 +469,6 @@ module NexClient
         return '-' unless record.node_count && record.max_node_count
         "#{record.node_count}/#{record.max_node_count}"
       end
-
-      def self.extract_config_options(cli_opts)
-        hash = {}
-        %w(http_log_drain region_balancing).each do |opt_name|
-          if cli_opts.method_missing(opt_name.to_sym).present?
-            hash[opt_name.to_s] = cli_opts.method_missing(opt_name.to_sym)
-          end
-        end
-        return hash
-      end
     end
   end
 end