3scale_toolbox 0.15.0 → 0.16.0

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

@@ -2,6 +2,21 @@ module ThreeScaleToolbox
   module Commands
     module PlansCommand
       module Create
+        class CustomPrinter
+          attr_reader :option_default, :option_disabled
+
+          def initialize(option_default, option_disabled)
+            @option_default = option_default
+            @option_disabled = option_disabled
+          end
+
+          def print_record(plan)
+            puts "Created application plan id: #{plan['id']}. Default: #{option_default}; Disabled: #{option_disabled}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -20,6 +35,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_name
@@ -32,7 +49,7 @@ module ThreeScaleToolbox
             plan = create_application_plan
             plan.make_default if option_default
             plan.disable if option_disabled
-            puts "Created application plan id: #{plan.id}. Default: #{option_default}; Disabled: #{option_disabled}"
+            printer.print_record plan.attrs
           end
 
           private
@@ -91,6 +108,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(option_default, option_disabled))
+          end
         end
       end
     end

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

@@ -5,7 +5,7 @@ module ThreeScaleToolbox
         class ListSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
-          FIELDS_TO_SHOW = %w[id name system_name].freeze
+          FIELDS = %w[id name system_name].freeze
 
           def self.command
             Cri::Command.define do
@@ -14,6 +14,7 @@ module ThreeScaleToolbox
               summary     'list application plans'
               description 'List application plans'
 
+              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.plans
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
-          end
-
-          def print_data
-            service.plans.each do |plan|
-              puts FIELDS_TO_SHOW.map { |field| plan.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))
+          end
         end
       end
     end

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

@@ -15,6 +15,7 @@ module ThreeScaleToolbox
               summary     'show application plan'
               description 'show application plan'
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param       :remote
               param       :service_ref
               param       :plan_ref
@@ -24,28 +25,15 @@ module ThreeScaleToolbox
           end
 
           def run
-            print_header
-            print_data
+            printer.print_record plan.attrs
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
-          end
-
-          def print_data
-            puts FIELDS_TO_SHOW.map { |field| plan_attrs.fetch(field, '(empty)') }.join("\t")
-          end
-
           def service
             @service ||= find_service
           end
 
-          def plan_attrs
-            @plan_attrs ||= plan.attrs
-          end
-
           def plan
             @plan ||= find_plan
           end
@@ -74,6 +62,10 @@ module ThreeScaleToolbox
           def plan_ref
             arguments[:plan_ref]
           end
+
+          def printer
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS_TO_SHOW))
+          end
         end
       end
     end

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

@@ -0,0 +1,22 @@
+require '3scale_toolbox/commands/product_command/copy_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module ProductCommand
+      include ThreeScaleToolbox::Command
+      def self.command
+        Cri::Command.define do
+          name        'product'
+          usage       'product <sub-command> [options]'
+          summary     'product super command'
+          description 'Product commands'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+      add_subcommand(CopySubcommand)
+    end
+  end
+end

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

@@ -0,0 +1,78 @@
+require '3scale_toolbox/commands/product_command/copy_command/delete_target_backend_usages_task'
+require '3scale_toolbox/commands/product_command/copy_command/copy_backends_task'
+
+module ThreeScaleToolbox
+  module Commands
+    module ProductCommand
+      class CopySubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+
+        def self.command
+          Cri::Command.define do
+            name        'copy'
+            usage       'copy [opts] -s <source-remote> -d <target-remote> <source-product>'
+            summary     'Copy product'
+            description <<-HEREDOC
+            This command makes a copy of the referenced product.
+            Target product will be searched by source product system name. System name can be overriden with `--target-system-name` option.
+            If a product with the selected `system_name` is not found, it will be created.
+            \n Components of the product being copied:
+            \nproduct configuration
+            \nproduct settings
+            \nproduct methods&metrics: Only missing metrics&methods will be created.
+            \nproduct mapping rules: Only missing mapping rules will be created.
+            \nproduct application plans & pricing rules & limits: Only missing application plans & pricing rules & limits will be created.
+            \nproduct application usage rules 
+            \nproduct policies 
+            \nproduct backends: Only missing backends will be created.
+            \nproduct activedocs: Only missing activedocs will be created.
+            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
+            param   :source_product
+
+            runner CopySubcommand
+          end
+        end
+
+        def run
+          tasks = []
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CreateOrUpdateTargetServiceTask.new(context)
+          tasks << CopyCommand::DeleteExistingTargetBackendUsagesTask.new(context)
+          tasks << CopyCommand::CopyBackendsTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyServiceProxyTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMethodsTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMetricsTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::DestroyMappingRulesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMappingRulesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyApplicationPlansTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyLimitsTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyPoliciesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyPricingRulesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyActiveDocsTask.new(context)
+          tasks.each(&:call)
+
+          # This should be the last step
+          ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::BumpProxyVersionTask.new(service: context[:target]).call
+        end
+
+        private
+
+        def context
+          @context ||= create_context
+        end
+
+        def create_context
+          {
+            source_remote: threescale_client(fetch_required_option(:source)),
+            target_remote: threescale_client(fetch_required_option(:destination)),
+            source_service_ref: arguments[:source_product],
+            option_target_system_name: options[:'target-system-name']
+          }
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,71 @@
+module ThreeScaleToolbox
+  module Commands
+    module ProductCommand
+      module CopyCommand
+        class CopyBackendsTask
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          # entrypoint
+          def call
+            backend_list = source.backend_usage_list
+            backend_list.each(&method(:create_backend))
+            puts "created/upated #{backend_list.size} backends"
+          end
+
+          private
+
+          def create_backend(backend_usage)
+            source_backend = Entities::Backend.new(id: backend_usage.backend_id, remote: source_remote)
+            backend_context = create_backend_context(source_backend.system_name)
+
+            tasks = []
+            tasks << Commands::BackendCommand::CopyCommand::CreateOrUpdateTargetBackendTask.new(backend_context)
+            # First metrics as methods need 'hits' metric in target backend
+            tasks << Commands::BackendCommand::CopyCommand::CopyMetricsTask.new(backend_context)
+            tasks << Commands::BackendCommand::CopyCommand::CopyMethodsTask.new(backend_context)
+            tasks << Commands::BackendCommand::CopyCommand::CopyMappingRulesTask.new(backend_context)
+            tasks.each(&:call)
+
+            # CreateOrUpdate task will keep reference of the target backend in
+            # backend_context[:target_backend]
+            attrs = {
+              'backend_api_id' => backend_context[:target_backend].id,
+              'path' => backend_usage.path
+            }
+            # It is assumed there is no target backend usage with this backend_source's path
+            # DeleteExistingTargetBackendUsagesTask should provide that
+            Entities::BackendUsage.create(product: target, attrs: attrs)
+          end
+
+          def source
+            context[:source]
+          end
+
+          def target
+            context[:target]
+          end
+
+          def source_remote
+            context[:source_remote]
+          end
+
+          def target_remote
+            context[:target_remote]
+          end
+
+          def create_backend_context(source_backend_system_name)
+            {
+              source_remote: source_remote,
+              target_remote: target_remote,
+              source_backend_ref: source_backend_system_name
+            }
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,48 @@
+module ThreeScaleToolbox
+  module Commands
+    module ProductCommand
+      module CopyCommand
+        class DeleteExistingTargetBackendUsagesTask
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          # entrypoint
+          def call
+            conflicting_target_backend_usage_list.each(&:delete)
+          end
+
+          private
+
+          # List of target backend usage items that match source backend usage paths
+          def conflicting_target_backend_usage_list
+            # Compute array intersection
+            target_backend_usage_list.select do |target_usage|
+              source_backend_usage_list.find do |source_usage|
+                target_usage.path == source_usage.path
+              end
+            end
+          end
+
+          def source_backend_usage_list
+            @source_backend_usage_list ||= source.backend_usage_list
+          end
+
+          def target_backend_usage_list
+            @target_backend_usage_list ||= target.backend_usage_list
+          end
+
+          def target
+            context[:target]
+          end
+
+          def source
+            context[:source]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -5,30 +5,30 @@ module ThreeScaleToolbox
         class ListSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
+          FIELDS = %w[id version environment]
+
           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
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param   :remote
               param   :service_ref
               param   :environment
+
+              runner ListSubcommand
             end
           end
 
           def run
-            print_proxy_config_data(proxy_configs, PROXYCONFIG_FIELDS_TO_SHOW)
+            printer.print_collection service.proxy_configs(proxy_config_environment).map(&:attrs)
           end
 
           private
 
-          PROXYCONFIG_FIELDS_TO_SHOW = %w[
-            id version environment
-          ]
-
           def remote
             @remote ||= threescale_client(arguments[:remote])
           end
@@ -41,29 +41,8 @@ module ThreeScaleToolbox
             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|
+            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
@@ -71,8 +50,13 @@ module ThreeScaleToolbox
           def service
             @service ||= find_service
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS))
+          end
         end
       end
     end
   end
-end
+end