3scale_toolbox 0.15.0 → 0.16.0

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

@@ -1,4 +1,4 @@
-require '3scale_toolbox/commands/copy_command/copy_service'
+require '3scale_toolbox/commands/copy_command/service_command'
 
 module ThreeScaleToolbox
   module Commands
@@ -16,7 +16,7 @@ module ThreeScaleToolbox
           end
         end
       end
-      add_subcommand(CopyServiceSubcommand)
+      add_subcommand(ServiceSubcommand)
     end
   end
 end

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

@@ -0,0 +1,40 @@
+module ThreeScaleToolbox
+  module Commands
+    module CopyCommand
+      class ServiceSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+
+        def self.command
+          Cri::Command.define do
+            name        'service'
+            usage       'service [opts] -s <src> -d <dst> <source-service>'
+            summary     'copy service'
+            description <<-HEREDOC
+            This command makes a copy of the referenced service.
+            Target service will be searched by source service system name. System name can be overriden with `--target_system_name` option.
+            If a service with the selected `system_name` is not found, it will be created.
+            \n Components of the service being copied:
+            \nservice settings
+            \nproxy settings
+            \npricing rules
+            \nactivedocs
+            \nmetrics
+            \nmethods
+            \napplication plans
+            \nmapping rules
+            HEREDOC
+
+            option  :s, :source, '3scale source instance. Url or remote name', argument: :required
+            option  :d, :destination, '3scale target instance. Url or remote name', argument: :required
+            option  :t, 'target_system_name', 'Target system name. Default to source system name', argument: :required
+            flag    :f, :force, 'Overwrites the mapping rules by deleting all rules from target service first'
+            flag    :r, 'rules-only', 'Only mapping rules are copied'
+            param   :source_service
+
+            runner Commands::ServiceCommand::CopySubcommand
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/import_command/openapi.rb

@@ -51,7 +51,7 @@ module ThreeScaleToolbox
             # other tasks might read proxy settings (CreateActiveDocsStep does)
             tasks << UpdateServiceProxyStep.new(context)
             tasks << CreateMethodsStep.new(context)
-            tasks << Tasks::DestroyMappingRulesTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::DestroyMappingRulesTask.new(context)
             tasks << CreateMappingRulesStep.new(context)
             tasks << CreateActiveDocsStep.new(context)
             tasks << UpdateServiceOidcConfStep.new(context)
@@ -61,7 +61,7 @@ module ThreeScaleToolbox
             tasks.each(&:call)
 
             # This should be the last step
-            Tasks::BumpProxyVersionTask.new(service: context[:target]).call
+            ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::BumpProxyVersionTask.new(service: context[:target]).call
           end
 
           private
@@ -88,6 +88,7 @@ module ThreeScaleToolbox
               backend_api_secret_token: options[:'backend-api-secret-token'],
               backend_api_host_header: options[:'backend-api-host-header'],
               prefix_matching: options[:'prefix-matching'],
+              delete_mapping_rules: true,
             }
           end
 

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

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module MethodsCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_disabled, :option_enabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+            @option_enabled = options[:enabled]
+          end
+
+          def print_record(method)
+            output_msg_array = ["Applied method id: #{method['id']}"]
+            output_msg_array << 'Disabled' if option_disabled
+            output_msg_array << 'Enabled' if option_enabled
+            puts output_msg_array.join('; ')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -16,6 +34,8 @@ module ThreeScaleToolbox
               flag        nil, :disabled, 'Disables this method in all application plans'
               flag        nil, :enabled, 'Enables this method in all application plans'
               option      nil, :description, 'Method description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :method_ref
@@ -39,10 +59,7 @@ module ThreeScaleToolbox
             method.disable if option_disabled
             method.enable if option_enabled
 
-            output_msg_array = ["Applied method id: #{method.id}"]
-            output_msg_array << 'Disabled' if option_disabled
-            output_msg_array << 'Enabled' if option_enabled
-            puts output_msg_array.join('; ')
+            printer.print_record method.attrs
           end
 
           private
@@ -94,6 +111,11 @@ module ThreeScaleToolbox
           def method_ref
             arguments[:method_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled, enabled: option_enabled))
+          end
         end
       end
     end

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

@@ -2,6 +2,20 @@ module ThreeScaleToolbox
   module Commands
     module MethodsCommand
       module Create
+        class CustomPrinter
+          attr_reader :option_disabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+          end
+
+          def print_record(method)
+            puts "Created method id: #{method['id']}. Disabled: #{option_disabled}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -15,6 +29,8 @@ module ThreeScaleToolbox
               option      :t, 'system-name', 'Method system name', argument: :required
               flag        nil, :disabled, 'Disables this method in all application plans'
               option      nil, :description, 'Method description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :method_name
@@ -31,7 +47,8 @@ module ThreeScaleToolbox
               attrs: method_attrs
             )
             method.disable if option_disabled
-            puts "Created method id: #{method.id}. Disabled: #{option_disabled}"
+
+            printer.print_record method.attrs
           end
 
           private
@@ -66,6 +83,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled))
+          end
         end
       end
     end

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

@@ -14,6 +14,7 @@ module ThreeScaleToolbox
               summary     'list methods'
               description 'List methods'
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param       :remote
               param       :service_ref
 
@@ -22,21 +23,17 @@ module ThreeScaleToolbox
           end
 
           def run
-            print_header
-            print_data
+            printer.print_collection service_methods
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
+          def service_methods
+            @service_methods ||= service.methods service_hits_id
           end
 
-          def print_data
-            hits = service.hits
-            service.methods(hits.fetch('id')).each do |method|
-              puts FIELDS_TO_SHOW.map { |field| method.fetch(field, '(empty)') }.join("\t")
-            end
+          def service_hits_id
+            @service_hits_id ||= service.hits.fetch('id')
           end
 
           def service
@@ -57,6 +54,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS_TO_SHOW))
+          end
         end
       end
     end

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

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module MetricsCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_disabled, :option_enabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+            @option_enabled = options[:enabled]
+          end
+
+          def print_record(metric)
+            output_msg_array = ["Applied metric id: #{metric['id']}"]
+            output_msg_array << 'Disabled' if option_disabled
+            output_msg_array << 'Enabled' if option_enabled
+            puts output_msg_array.join('; ')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -17,6 +35,8 @@ module ThreeScaleToolbox
               flag        nil, :enabled, 'Enables this metric in all application plans'
               option      nil, :unit, 'Metric unit. Default hit', argument: :required
               option      nil, :description, 'Metric description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :metric_ref
@@ -38,10 +58,7 @@ module ThreeScaleToolbox
             metric.disable if option_disabled
             metric.enable if option_enabled
 
-            output_msg_array = ["Applied metric id: #{metric.id}"]
-            output_msg_array << 'Disabled' if option_disabled
-            output_msg_array << 'Enabled' if option_enabled
-            puts output_msg_array.join('; ')
+            printer.print_record metric.attrs
           end
 
           private
@@ -95,6 +112,11 @@ module ThreeScaleToolbox
           def metric_ref
             arguments[:metric_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled, enabled: option_enabled))
+          end
         end
       end
     end

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

@@ -2,6 +2,20 @@ module ThreeScaleToolbox
   module Commands
     module MetricsCommand
       module Create
+        class CustomPrinter
+          attr_reader :option_disabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+          end
+
+          def print_record(metric)
+            puts "Created metric id: #{metric['id']}. Disabled: #{option_disabled}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -16,6 +30,8 @@ module ThreeScaleToolbox
               flag        nil, :disabled, 'Disables this metric in all application plans'
               option      nil, :unit, 'Metric unit. Default hit', argument: :required
               option      nil, :description, 'Metric description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :metric_name
@@ -30,7 +46,8 @@ module ThreeScaleToolbox
               attrs: metric_attrs
             )
             metric.disable if option_disabled
-            puts "Created metric id: #{metric.id}. Disabled: #{option_disabled}"
+
+            printer.print_record metric.attrs
           end
 
           private
@@ -70,6 +87,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled))
+          end
         end
       end
     end

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

@@ -14,6 +14,7 @@ module ThreeScaleToolbox
               summary     'list metrics'
               description 'List metrics'
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param       :remote
               param       :service_ref
 
@@ -22,22 +23,11 @@ module ThreeScaleToolbox
           end
 
           def run
-            print_header
-            print_data
+            printer.print_collection service.metrics
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
-          end
-
-          def print_data
-            service.metrics.each do |metric|
-              puts FIELDS_TO_SHOW.map { |field| metric.fetch(field, '(empty)') }.join("\t")
-            end
-          end
-
           def service
             @service ||= find_service
           end
@@ -56,6 +46,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS_TO_SHOW))
+          end
         end
       end
     end

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

@@ -2,6 +2,31 @@ module ThreeScaleToolbox
   module Commands
     module PlansCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_default, :option_disabled, :option_enabled,
+                      :option_publish, :option_hide
+
+          def initialize(options)
+            @option_default = options[:default]
+            @option_disabled = options[:disabled]
+            @option_enabled = options[:enabled]
+            @option_publish = options[:publish]
+            @option_hide = options[:hide]
+          end
+
+          def print_record(plan)
+            output_msg_array = ["Applied application plan id: #{plan['id']}"]
+            output_msg_array << "Default: #{option_default}"
+            output_msg_array << 'Disabled' if option_disabled
+            output_msg_array << 'Enabled' if option_enabled
+            output_msg_array << 'Published' if option_publish
+            output_msg_array << 'Hidden' if option_hide
+            puts output_msg_array.join('; ')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -22,6 +47,8 @@ module ThreeScaleToolbox
               option      nil, 'cost-per-month', 'Cost per month', argument: :required, transform: method(:Float)
               option      nil, 'setup-fee', 'Setup fee', argument: :required, transform: method(:Float)
               option      nil, 'trial-period-days', 'Trial period days', argument: :required, transform: method(:Integer)
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :plan_ref
@@ -44,13 +71,7 @@ module ThreeScaleToolbox
             plan.disable if option_disabled
             plan.enable if option_enabled
 
-            output_msg_array = ["Applied application plan id: #{plan.id}"]
-            output_msg_array << "Default: #{option_default}"
-            output_msg_array << 'Disabled' if option_disabled
-            output_msg_array << 'Enabled' if option_enabled
-            output_msg_array << 'Published' if option_publish
-            output_msg_array << 'Hidden' if option_hide
-            puts output_msg_array.join('; ')
+            printer.print_record plan.attrs
           end
 
           private
@@ -130,6 +151,14 @@ module ThreeScaleToolbox
           def plan_ref
             arguments[:plan_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output,
+                          CustomPrinter.new(default: option_default, disabled: option_disabled,
+                                            enabled: option_enabled, publish: option_publish,
+                                            hide: option_hide))
+          end
         end
       end
     end