3scale_toolbox 0.12.4 → 0.17.0

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

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/import/import_plan_limits_step.rb

@@ -7,25 +7,24 @@ module ThreeScaleToolbox
           ##
           # Writes Plan limits
           def call
-            missing_limits.each do |limit|
-              metric_id = limit.delete('metric_id')
-              limit_obj = plan.create_limit(metric_id, limit)
-              if (errors = limit_obj['errors'])
-                raise ThreeScaleToolbox::Error, "Plan limit has not been created. #{errors}"
-              end
+            # SET semantics
+            # First, delete existing limits
+            # Second, add new limits
+            plan.limits.each do |limit|
+              metric_id = limit.fetch('metric_id')
+              plan.delete_limit metric_id, limit.fetch('id')
+              puts "Deleted existing plan limit: [metric: #{metric_id}, #{limit}]"
+            end
 
+            resource_limits_processed.each do |limit|
+              metric_id = limit.delete('metric_id')
+              plan.create_limit(metric_id, limit)
               puts "Created plan limit: [metric: #{metric_id}, #{limit}]"
             end
           end
 
           private
 
-          def missing_limits
-            ThreeScaleToolbox::Helper.array_difference(resource_limits_processed, plan.limits) do |a, b|
-              ThreeScaleToolbox::Helper.compare_hashes(a, b, %w[metric_id period])
-            end
-          end
-
           def resource_limits_processed
             resource_limits.map do |limit|
               metric = find_metric_by_system_name(limit.delete('metric_system_name'))

data/lib/3scale_toolbox/commands/plans_command/import/import_plan_pricing_rules_step.rb

@@ -7,25 +7,24 @@ module ThreeScaleToolbox
           ##
           # Writes Plan pricing rules
           def call
-            missing_pricing_rules.each do |pr|
-              metric_id = pr.delete('metric_id')
-              resp = plan.create_pricing_rule(metric_id, pr)
-              if (errors = resp['errors'])
-                raise ThreeScaleToolbox::Error, "Plan pricing rule has not been created. #{errors}"
-              end
+            # SET semantics
+            # First, delete existing pricing rules
+            # Second, add new pricing rules
+            remote_pr_processed.each do |pr|
+              metric_id = pr.fetch('metric_id')
+              plan.delete_pricing_rule metric_id, pr.fetch('id')
+              puts "Deleted existing plan pricing rule: [metric: #{metric_id}, #{pr}]"
+            end
 
+            resource_pr_processed.each do |pr|
+              metric_id = pr.delete('metric_id')
+              plan.create_pricing_rule(metric_id, pr)
               puts "Created plan pricing rule: [metric: #{metric_id}, #{pr}]"
             end
           end
 
           private
 
-          def missing_pricing_rules
-            ThreeScaleToolbox::Helper.array_difference(resource_pr_processed, remote_pr_processed) do |a, b|
-              ThreeScaleToolbox::Helper.compare_hashes(a, b, %w[metric_id cost_per_unit min max])
-            end
-          end
-
           def remote_pr_processed
             plan.pricing_rules.map do |pr|
               pr.merge('cost_per_unit' => pr.fetch('cost_per_unit').to_f)

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