3scale_toolbox 0.15.0 → 0.18.2

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,23 +23,11 @@ module ThreeScaleToolbox
           end
 
           def run
-            print_header
-            print_data
+            printer.print_collection service.methods.map(&:attrs)
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
-          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
-          end
-
           def service
             @service ||= find_service
           end
@@ -57,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/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.map(&:attrs)
           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

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/export/read_plan_limits_step.rb

@@ -9,7 +9,7 @@ module ThreeScaleToolbox
           # add metric system_name out of metric_id
           def call
             result[:limits] = plan.limits.map do |limit|
-              limit.tap { |l| l['metric'] = metric_info(l, 'Limit') }
+              limit.attrs.merge('metric' => metric_info(limit, 'Limit'))
             end
           end
         end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_methods_step.rb

@@ -21,7 +21,7 @@ module ThreeScaleToolbox
             filtered_limit_methods.each_with_object({}) do |elem, acc|
               # find_method should not return nil.
               # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_method(elem['metric_id'])
+              acc[elem['metric_id']] = find_method(elem['metric_id']).attrs
             end
           end
 
@@ -33,7 +33,7 @@ module ThreeScaleToolbox
             filtered_pricing_rule_methods.each_with_object({}) do |elem, acc|
               # find_method should not return nil.
               # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_method(elem['metric_id'])
+              acc[elem['metric_id']] = find_method(elem['metric_id']).attrs
             end
           end
 

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_metrics_step.rb

@@ -21,7 +21,7 @@ module ThreeScaleToolbox
             filtered_limit_metrics.each_with_object({}) do |elem, acc|
               # find_metric should not return nil.
               # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_metric(elem['metric_id'])
+              acc[elem['metric_id']] = find_metric(elem['metric_id']).attrs
             end
           end
 
@@ -33,7 +33,7 @@ module ThreeScaleToolbox
             filtered_pricing_rule_metrics.each_with_object({}) do |elem, acc|
               # find_metric should not return nil.
               # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_metric(elem['metric_id'])
+              acc[elem['metric_id']] = find_metric(elem['metric_id']).attrs
             end
           end
 

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_pricing_rules_step.rb

@@ -9,8 +9,7 @@ module ThreeScaleToolbox
           # add metric system_name out of metric_id
           def call
             result[:pricingrules] = plan.pricing_rules.map do |pr|
-              pr.merge('metric' => metric_info(pr, 'PricingRule'),
-                       'cost_per_unit' => pr.fetch('cost_per_unit').to_f)
+              pr.attrs.merge('metric' => metric_info(pr, 'PricingRule'), 'cost_per_unit' => pr.cost_per_unit.to_f)
             end
           end
         end

data/lib/3scale_toolbox/commands/plans_command/export/step.rb

@@ -45,22 +45,14 @@ module ThreeScaleToolbox
             context[:plan] ||= find_plan
           end
 
-          def service_metrics
-            context[:service_metrics] ||= service.metrics
-          end
-
-          def service_methods
-            context[:service_methods] ||= service.methods(service_hits['id'])
-          end
-
           def metric_info(elem, elem_name)
-            if (method = find_method(elem.fetch('metric_id')))
-              { 'type' => 'method', 'system_name' => method.fetch('system_name') }
-            elsif (metric = find_metric(elem.fetch('metric_id')))
-              { 'type' => 'metric', 'system_name' => metric.fetch('system_name') }
+            if (method = find_method(elem.metric_id))
+              { 'type' => 'method', 'system_name' => method.system_name }
+            elsif (metric = find_metric(elem.metric_id))
+              { 'type' => 'metric', 'system_name' => metric.system_name }
             else
-              raise ThreeScaleToolbox::Error, "Unexpected error. #{elem_name} #{elem['id']} " \
-                "referencing to metric id #{elem.fetch('metric_id')} which has not been found"
+              raise ThreeScaleToolbox::Error, "Unexpected error. #{elem_name} #{elem.id} " \
+                "referencing to metric id #{elem.metric_id} which has not been found"
             end
           end
 
@@ -80,15 +72,11 @@ module ThreeScaleToolbox
           end
 
           def find_metric(id)
-            service_metrics.find { |metric| metric['id'] == id }
+            service.metrics.find { |metric| metric.id == id }
           end
 
           def find_method(id)
-            service_methods.find { |method| method['id'] == id }
-          end
-
-          def service_hits
-            context[:service_hits] ||= service.hits
+            service.methods.find { |method| method.id == id }
           end
         end
       end

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

@@ -7,31 +7,29 @@ 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|
+              limit.delete()
+              puts "Deleted existing plan limit: [metric: #{limit.metric_id}, #{limit.attrs}]"
+            end
 
-              puts "Created plan limit: [metric: #{metric_id}, #{limit}]"
+            resource_limits_processed.each do |limit_attrs|
+              metric_id = limit_attrs.delete('metric_id')
+              plan.create_limit(metric_id, limit_attrs)
+              puts "Created plan limit: [metric: #{metric_id}, #{limit_attrs}]"
             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'))
               # this ImportMetricLimitsStep step is assuming all metrics/methods have been created
               # in previous step, so finding metric should always succeed.
-              limit.merge('metric_id' => metric.fetch('id'))
+              limit.merge('metric_id' => metric.id)
             end
           end
         end