3scale_toolbox 0.15.0 → 0.18.2

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

@@ -0,0 +1,49 @@
+module ThreeScaleToolbox
+  module Commands
+    module ServiceCommand
+      module CopyCommand
+        class CreateOrUpdateTargetServiceTask
+          include Task
+
+          def call
+            service = Entities::Service.find(remote: target_remote,
+                                             ref: target_service_ref)
+            if service == source
+              raise ThreeScaleToolbox::Error, 'Source and destination services are the same: ' \
+                "ID: #{source.id} system_name: #{source.attrs['system_name']}"
+            end
+
+            if service.nil?
+              service = Entities::Service.create(remote: target_remote,
+                                                 service_params: create_attrs)
+              # Notify that mapping rules should be deleted before being copied
+              force_delete_mapping_rules
+            else
+              service.update update_attrs
+            end
+
+            # assign target service for other tasks to have it available
+            self.target = service
+
+            logger.info "new service id #{service.id}"
+            report['product_id'] = service.id
+          end
+
+          private
+
+          def target_service_ref
+            option_target_system_name || source.attrs.fetch('system_name')
+          end
+
+          def create_attrs
+            source.attrs.merge('system_name' => target_service_ref)
+          end
+
+          def update_attrs
+            source.attrs.merge('system_name' => target_service_ref)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,38 @@
+module ThreeScaleToolbox
+  module Commands
+    module ServiceCommand
+      module CopyCommand
+        class DestroyMappingRulesTask
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def call
+            return unless delete_mapping_rules
+
+            logger.info 'destroying all mapping rules'
+            target.mapping_rules.each(&:delete)
+          end
+
+          private
+
+          def delete_mapping_rules
+            context.fetch(:delete_mapping_rules, false)
+          end
+
+          def target
+            context.fetch(:target)
+          end
+
+          def logger
+            context[:logger] ||= Logger.new($stdout).tap do |logger|
+              logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,85 @@
+module ThreeScaleToolbox
+  module Commands
+    module ServiceCommand
+      module CopyCommand
+        module Task
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def source
+            context[:source] ||= find_source_service
+          end
+
+          def find_source_service
+            Entities::Service.find(remote: source_remote, ref: source_service_ref).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{source_service_ref} does not exist" if svc.nil?
+            end
+          end
+
+          def target
+            context[:target] ||= raise ThreeScaleToolbox::Error, 'Unexpected error. ' \
+              'Target service should have been created or updated'
+          end
+
+          def target=(target)
+            context[:target] = target
+          end
+
+          def delete_mapping_rules
+            context.fetch(:delete_mapping_rules, false)
+          end
+
+          def force_delete_mapping_rules
+            context[:delete_mapping_rules] = true
+          end
+
+          def source_metrics_and_methods
+            source.metrics + source.methods
+          end
+
+          def target_metrics_and_methods
+            target.metrics + target.methods
+          end
+
+          def source_remote
+            context[:source_remote]
+          end
+
+          def target_remote
+            context[:target_remote]
+          end
+
+          def source_service_ref
+            context[:source_service_ref] ||= raise ThreeScaleToolbox::Error, 'Unexpected error. ' \
+              'source_service_ref not found'
+          end
+
+          def option_target_system_name
+            context[:option_target_system_name]
+          end
+
+          def logger
+            context[:logger] ||= Logger.new($stdout).tap do |logger|
+              logger.formatter = proc { |severity, datetime, progname, msg| "#{msg}\n" }
+            end
+          end
+
+          def plans_report
+            report['application_plans'] ||= {}
+          end
+
+          def activedocs_report
+            report['activedocs'] ||= {}
+          end
+
+          def report
+            context[:report] ||= {}
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -1,58 +1,72 @@
 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
+      class CreateSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+
+        class CustomPrinter
+          attr_reader :option_default, :option_disabled
 
-          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}"
+          def print_record(service)
+            puts "Service '#{service['name']}' has been created with ID: #{service['id']}"
           end
 
-          private
+          def print_collection(collection) end
+        end
 
-          def remote
-            @remote ||= threescale_client(arguments[:remote])
-          end
+        def self.command
+          Cri::Command.define do
+            name        'create'
+            usage       'create [options] <remote> <service-name>'
+            summary     'Create a service'
+            description 'Create a service'
 
-          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
+            param   :remote
+            param   :service_name
 
-          def service_attrs
-            service_name = arguments[:service_name]
-            create_service_attrs = parse_options
-            create_service_attrs["name"] = service_name
-            create_service_attrs
+            ThreeScaleToolbox::CLI.output_flag(self)
+            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
+
+            runner CreateSubcommand
           end
         end
+
+        def run
+          service = Entities::Service.create(remote: remote, service_params: create_params)
+          printer.print_record service.attrs
+        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 create_params
+          service_name = arguments[:service_name]
+          create_service_attrs = parse_options
+          create_service_attrs['name'] = service_name
+          create_service_attrs
+        end
+
+        def printer
+          # keep backwards compatibility
+          options.fetch(:output, CustomPrinter.new)
+        end
       end
     end
   end

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

@@ -1,46 +1,44 @@
 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
+      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
+        def run
+          service.delete
+          puts "Service with id: #{service.id} deleted"
+        end
 
-          private
+        private
 
-          def remote
-            @remote ||= threescale_client(arguments[:remote])
-          end
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
 
-          def ref
-            @ref ||= arguments[:service_id_or_system_name]
-          end
+        def ref
+          @ref ||= arguments[:service_id_or_system_name]
+        end
 
-          def service
-            @service ||= find_service
-          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
+        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

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

@@ -1,48 +1,38 @@
 module ThreeScaleToolbox
   module Commands
     module ServiceCommand
-      module List
-        class ListSubcommand < Cri::CommandRunner
-          include ThreeScaleToolbox::Command
-
-          def self.command
-            Cri::Command.define do
-              name        'list'
-              usage       'list <remote>'
-              summary     'List all services'
-              description 'List all services'
-              runner ListSubcommand
-
-              param :remote
-            end
-          end
+      class ListSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
 
-          def run
-            print_header
-            print_data
-          end
+        FIELDS = %w[id name system_name]
 
-          private
+        def self.command
+          Cri::Command.define do
+            name        'list'
+            usage       'list <remote>'
+            summary     'List all services'
+            description 'List all services'
 
-          SERVICE_FIELDS_TO_SHOW = %w[id name system_name]
+            ThreeScaleToolbox::CLI.output_flag(self)
+            param :remote
 
-          def services
-            @services ||= remote.list_services()
+            runner ListSubcommand
           end
+        end
 
-          def remote
-            @remote ||= threescale_client(arguments[:remote])
-          end
+        def run
+          printer.print_collection remote.list_services
+        end
 
-          def print_header
-            puts SERVICE_FIELDS_TO_SHOW.map { |e| e.upcase }.join("\t")
-          end
+        private
 
-          def print_data
-            services.each do |service|
-              puts SERVICE_FIELDS_TO_SHOW.map { |field| service.fetch(field, '(empty)') }.join("\t")
-            end
-          end
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
+
+        def printer
+          # keep backwards compatibility
+          options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS))
         end
       end
     end

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

@@ -1,62 +1,57 @@
 module ThreeScaleToolbox
   module Commands
     module ServiceCommand
-      module Show
-        class ShowSubcommand < Cri::CommandRunner
-          include ThreeScaleToolbox::Command
-
-          def self.command
-            Cri::Command.define do
-              name        'show'
-              usage       'show <remote> <service-id_or_system-name>'
-              summary     'Show the information of a service'
-              description "Show the information of a service"
-              runner ShowSubcommand
-
-              param   :remote
-              param   :service_id_or_system_name
-            end
-          end
+      class ShowSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
 
-          def run
-            print_header
-            print_data
-          end
+        FIELDS = %w[
+          id name state system_name end_user_registration_required
+          backend_version deployment_option support_email description
+          created_at updated_at
+        ]
 
-          private
+        def self.command
+          Cri::Command.define do
+            name        'show'
+            usage       'show <remote> <service-id_or_system-name>'
+            summary     'Show the information of a service'
+            description "Show the information of a service"
 
-          SERVICE_FIELDS_TO_SHOW = %w[
-            id name state system_name end_user_registration_required
-            backend_version deployment_option support_email description
-            created_at updated_at
-          ]
+            ThreeScaleToolbox::CLI.output_flag(self)
+            param   :remote
+            param   :service_id_or_system_name
 
-          def remote
-            @remote ||= threescale_client(arguments[:remote])
+            runner ShowSubcommand
           end
+        end
 
-          def ref
-            @ref ||= arguments[:service_id_or_system_name]
-          end
+        def run
+          printer.print_record service.attrs
+        end
 
-          def service
-            @service ||= find_service
-          end
+        private
 
-          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
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
 
-          def print_header
-            puts SERVICE_FIELDS_TO_SHOW.map { |e| e.upcase }.join("\t")
-          end
+        def ref
+          @ref ||= arguments[:service_id_or_system_name]
+        end
 
-          def print_data
-            puts SERVICE_FIELDS_TO_SHOW.map { |field| service.attrs.fetch(field, '(empty)') }.join("\t")
+        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
+
+        def printer
+          options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS))
+        end
       end
     end
   end