3scale_toolbox 0.10.0 → 0.11.0

data/lib/3scale_toolbox/commands/proxy_config_command/list_command.rb

@@ -0,0 +1,78 @@
+module ThreeScaleToolbox
+  module Commands
+    module ProxyConfigCommand
+      module List
+        class ListSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'list'
+              usage       'list <remote> <service> <environment>'
+              summary     'List Proxy Configurations'
+              description 'List all defined Proxy Configurations'
+              runner ListSubcommand
+
+              param   :remote
+              param   :service_ref
+              param   :environment
+            end
+          end
+
+          def run
+            print_proxy_config_data(proxy_configs, PROXYCONFIG_FIELDS_TO_SHOW)
+          end
+
+          private
+
+          PROXYCONFIG_FIELDS_TO_SHOW = %w[
+            id version environment
+          ]
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def proxy_config_environment
+            arguments[:environment]
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+
+          def proxy_configs
+            @proxyconfigs ||= service.proxy_configs(proxy_config_environment)
+          end
+
+          def print_proxy_config_data(proxyconfigs, fields_to_show)
+            print_header(fields_to_show)
+            print_results(proxyconfigs, fields_to_show)
+          end
+
+          def print_header(fields_to_show)
+            puts fields_to_show.map{ |e| e.upcase}.join("\t")
+          end
+
+          def print_results(proxyconfigs, fields_to_show)
+            proxyconfigs.each do |proxyconfig|
+              proxy_config_attrs = proxyconfig.attrs
+              puts fields_to_show.map { |field| proxy_config_attrs.fetch(field, '(empty)') }.join("\t")
+            end
+          end
+
+          def find_service
+            Entities::Service.find(remote: remote,
+                                   ref: service_ref).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{service_ref} does not exist" if svc.nil?
+            end
+          end
+
+          def service
+            @service ||= find_service
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/proxy_config_command/promote_command.rb

@@ -0,0 +1,68 @@
+module ThreeScaleToolbox
+  module Commands
+    module ProxyConfigCommand
+      module Promote
+        class PromoteSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'promote'
+              usage       'promote <remote> <service>'
+              summary     'Promote latest staging Proxy Configuration to the production environment'
+              description 'Promote latest staging Proxy Configuration to the production environment'
+              runner PromoteSubcommand
+
+              param   :remote
+              param   :service_ref
+            end
+          end
+
+          def run
+            latest_proxy_config.promote(to: to_env)
+            puts "Proxy Configuration promoted to '#{to_env}'"
+          end
+
+          private
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def latest_proxy_config
+            @proxy_config ||= find_proxy_config_latest
+          end
+
+          def find_proxy_config_latest
+            Entities::ProxyConfig.find_latest(service: service, environment: from_env).tap do |pc|
+              raise ThreeScaleToolbox::Error, "ProxyConfig #{from_env} in service #{service.id} does not exist" if pc.nil?
+            end
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+
+          def find_service
+            Entities::Service.find(remote: remote,
+                                   ref: service_ref).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{service_ref} does not exist" if svc.nil?
+            end
+          end
+
+          def service
+            @service ||= find_service
+          end
+
+          def to_env
+            "production"
+          end
+
+          def from_env
+            "sandbox"
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/proxy_config_command/show_command.rb

@@ -0,0 +1,88 @@
+module ThreeScaleToolbox
+  module Commands
+    module ProxyConfigCommand
+      module Show
+        class ShowSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'show'
+              usage       'show <remote> <service> <environment>'
+              summary     'Show Proxy Configuration'
+              description 'Show a Proxy Configuration'
+              runner ShowSubcommand
+
+              param   :remote
+              param   :service_ref
+              param   :environment
+
+              option nil, :'config-version', "Specify the Proxy Configuration version. If not specified it gets the latest version", argument: :required
+            end
+          end
+
+          def run      
+            print_proxy_config
+          end
+
+          private
+
+          def proxy_config
+            @proxy_config ||= find_proxy_config 
+          end
+
+          def find_proxy_config
+            if proxy_config_version == "latest"
+              find_proxy_config_latest
+            else
+              find_proxy_config_version
+            end
+          end
+
+          def find_proxy_config_version
+            Entities::ProxyConfig.find(service: service, environment: proxy_config_environment, version: proxy_config_version).tap do |pc|
+              raise ThreeScaleToolbox::Error, "ProxyConfig #{proxy_config_environment} in service #{service.id} does not exist" if pc.nil?
+            end
+          end
+
+          def find_proxy_config_latest
+            Entities::ProxyConfig.find_latest(service: service, environment: proxy_config_environment).tap do |pc|
+              raise ThreeScaleToolbox::Error, "ProxyConfig #{proxy_config_environment} in service #{service.id} does not exist" if pc.nil?
+            end
+          end
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def proxy_config_version
+            options[:'config-version'] || "latest"
+          end
+
+          def proxy_config_environment
+            arguments[:environment]
+          end
+
+          def print_proxy_config
+            puts JSON.pretty_generate(proxy_config.attrs)    
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+
+          def find_service
+            Entities::Service.find(remote: remote,
+                                   ref: service_ref).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{service_ref} does not exist" if svc.nil?
+            end
+          end
+
+          def service
+            @service ||= find_service
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/service_command.rb

@@ -0,0 +1,34 @@
+require 'cri'
+require '3scale_toolbox/base_command'
+require '3scale_toolbox/commands/service_command/list_command'
+require '3scale_toolbox/commands/service_command/show_command'
+require '3scale_toolbox/commands/service_command/delete_command'
+require '3scale_toolbox/commands/service_command/create_command'
+require '3scale_toolbox/commands/service_command/apply_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module ServiceCommand
+      include ThreeScaleToolbox::Command
+
+      def self.command
+        Cri::Command.define do
+          name        'service'
+          usage       'service <sub-command> [options]'
+          summary     'services super command'
+          description 'Manage your services'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+
+      add_subcommand(List::ListSubcommand)
+      add_subcommand(Show::ShowSubcommand)
+      add_subcommand(Delete::DeleteSubcommand)
+      add_subcommand(Create::CreateSubcommand)
+      add_subcommand(Apply::ApplySubcommand)
+    end
+  end
+end

data/lib/3scale_toolbox/commands/service_command/apply_command.rb

@@ -0,0 +1,77 @@
+module ThreeScaleToolbox
+  module Commands
+    module ServiceCommand
+      module Apply
+        class ApplySubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'apply'
+              usage       'apply <remote> <service-id_or_system-name>'
+              summary     'Update service'
+              description "Update (create if it does not exist) service"
+              runner ApplySubcommand
+
+              param   :remote
+              param   :service_id_or_system_name
+
+              option :d, :'deployment-mode', "Specify the deployment mode of the service", argument: :required
+              option :n, :name, "Specify the name of the metric", argument: :required
+              option :a, :'authentication-mode', "Specify authentication mode of the service ('1' for API key, '2' for App Id / App Key, 'oauth' for OAuth mode, 'oidc' for OpenID Connect)", argument: :required
+              option nil, :description, "Specify the description of the service", argument: :required
+              option nil, :'support-email', "Specify the support email of the service", argument: :required
+            end
+          end
+
+          def run
+            res = service
+            if res.nil?
+              res = Entities::Service.create(remote: remote, service_params: create_service_attrs)
+            else
+              res.update(service_attrs) unless service_attrs.empty?
+            end
+
+            output_msg_array = ["Applied Service id: #{res.id}"]
+            puts output_msg_array
+          end
+
+          private
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def ref
+            @ref ||= arguments[:service_id_or_system_name]
+          end
+
+          def service
+            @service ||= find_service
+          end
+
+          def find_service
+            Entities::Service::find(remote: remote, ref: ref)
+          end
+
+          def service_attrs
+            {
+              "deployment_option" => options[:'deployment-mode'],
+              "backend_version" => options[:'authentication-mode'],
+              "description" => options[:description],
+              "support_email" => options[:'support-email'],
+              "name" => options[:name],
+            }.compact
+          end
+
+          def create_service_attrs
+            service_attrs.merge(
+              "system_name" => ref,
+              "name" => ref
+            ) { |_key, oldval, _newval| oldval } # receiver of the merge message has key priority
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/service_command/create_command.rb

@@ -0,0 +1,59 @@
+module ThreeScaleToolbox
+  module Commands
+    module ServiceCommand
+      module Create
+        class CreateSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'create'
+              usage       'create [options] <remote> <service-name>'
+              summary     'Create a service'
+              description 'Create a service'
+              runner CreateSubcommand
+
+              param   :remote
+              param   :service_name
+
+              option :d, :'deployment-mode', "Specify the deployment mode of the service", argument: :required
+              option :s, :'system-name', "Specify the system-name of the service", argument: :required
+              option :a, :'authentication-mode', "Specify authentication mode of the service ('1' for API key, '2' for App Id / App Key, 'oauth' for OAuth mode, 'oidc' for OpenID Connect)", argument: :required
+              option nil, :description, "Specify the description of the service", argument: :required
+              option nil, :'support-email', "Specify the support email of the service", argument: :required
+            end
+          end
+
+          def run
+            create_service_params = service_attrs
+            result = Entities::Service.create(remote: remote, service_params: create_service_params)
+            puts "Service '#{arguments[:service_name]}' has been created with ID: #{result.id}"
+          end
+
+          private
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def parse_options
+            {
+              "deployment_option" => options[:'deployment-mode'],
+              "system_name" => options[:'system-name'],
+              "backend_version" => options[:'authentication-mode'],
+              "description" => options[:description],
+              "support_email" => options[:'support-email'],
+            }.compact
+          end
+
+          def service_attrs
+            service_name = arguments[:service_name]
+            create_service_attrs = parse_options
+            create_service_attrs["name"] = service_name
+            create_service_attrs
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/service_command/delete_command.rb

@@ -0,0 +1,49 @@
+module ThreeScaleToolbox
+  module Commands
+    module ServiceCommand
+      module Delete
+        class DeleteSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'delete'
+              usage       'delete <remote> <service-id_or_system-name>'
+              summary     'Delete a service'
+              description 'Delete a service'
+              runner DeleteSubcommand
+
+              param   :remote
+              param   :service_id_or_system_name
+            end
+          end
+
+          def run
+            service.delete
+            puts "Service with id: #{service.id} deleted"
+          end
+
+          private
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def ref
+            @ref ||= arguments[:service_id_or_system_name]
+          end
+
+          def service
+            @service ||= find_service
+          end
+
+          def find_service
+            Entities::Service::find(remote: remote, ref: ref).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{ref} does not exist" if svc.nil?
+            end
+          end
+        end
+      end
+    end
+  end
+end