3scale_toolbox 0.15.0 → 0.18.2

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

@@ -9,36 +9,29 @@ module ThreeScaleToolbox
           def call
             missing_metrics.each(&method(:create_metric))
             missing_methods.each(&method(:create_method))
-
-            # invalidate memoized methods and metrics
-            invalidate_service_methods
-            invalidate_service_metrics
           end
 
           private
 
           def missing_metrics
-            ThreeScaleToolbox::Helper.array_difference(resource_metrics, service_metrics) do |a, b|
-              ThreeScaleToolbox::Helper.compare_hashes(a, b, ['system_name'])
+            ThreeScaleToolbox::Helper.array_difference(resource_metrics, service.metrics) do |a, b|
+              a['system_name'] == b.system_name
             end
           end
 
           def missing_methods
-            ThreeScaleToolbox::Helper.array_difference(resource_methods, service_methods) do |a, b|
-              ThreeScaleToolbox::Helper.compare_hashes(a, b, ['system_name'])
+            ThreeScaleToolbox::Helper.array_difference(resource_methods, service.methods) do |a, b|
+              a['system_name'] == b.system_name
             end
           end
 
           def create_metric(metric_attrs)
-            metric = ThreeScaleToolbox::Entities::Metric.create(service: service,
-                                                                attrs: metric_attrs)
+            metric = ThreeScaleToolbox::Entities::Metric.create(service: service, attrs: metric_attrs)
             puts "Created metric: #{metric.attrs['system_name']}"
           end
 
           def create_method(method_attrs)
-            method = ThreeScaleToolbox::Entities::Method.create(service: service,
-                                                                parent_id: service_hits['id'],
-                                                                attrs: method_attrs)
+            method = ThreeScaleToolbox::Entities::Method.create(service: service, attrs: method_attrs)
             puts "Created method: #{method.attrs['system_name']}"
           end
         end

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

@@ -7,35 +7,27 @@ 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
-
-              puts "Created plan pricing rule: [metric: #{metric_id}, #{pr}]"
+            # SET semantics
+            # First, delete existing pricing rules
+            # Second, add new pricing rules
+            plan.pricing_rules.each do |pr|
+              pr.delete()
+              puts "Deleted existing plan pricing rule: [metric: #{pr.metric_id}, #{pr.attrs}]"
             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])
+            resource_pr_processed.each do |pr_attrs|
+              metric_id = pr_attrs.delete('metric_id')
+              plan.create_pricing_rule(metric_id, pr_attrs)
+              puts "Created plan pricing rule: [metric: #{metric_id}, #{pr_attrs}]"
             end
           end
 
-          def remote_pr_processed
-            plan.pricing_rules.map do |pr|
-              pr.merge('cost_per_unit' => pr.fetch('cost_per_unit').to_f)
-            end
-          end
+          private
 
           def resource_pr_processed
             resource_pricing_rules.map do |pr|
               metric = find_metric_by_system_name(pr.delete('metric_system_name'))
-              pr.merge('metric_id' => metric.fetch('id'),
+              pr.merge('metric_id' => metric.id,
                        'cost_per_unit' => pr.fetch('cost_per_unit').to_f)
             end
           end

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

@@ -65,28 +65,8 @@ module ThreeScaleToolbox
             artifacts_resource['plan_features'] || []
           end
 
-          def service_metrics
-            context[:service_metrics] ||= service.metrics
-          end
-
-          def invalidate_service_metrics
-            context[:service_metrics] = nil
-          end
-
-          def service_hits
-            context[:service_hits] ||= service.hits
-          end
-
-          def service_methods
-            context[:service_methods] ||= service.methods(service_hits['id'])
-          end
-
           def service_metrics_and_methods
-            service_metrics + service_methods
-          end
-
-          def invalidate_service_methods
-            context[:service_methods] = nil
+            service.metrics + service.methods
           end
 
           def service_features
@@ -103,7 +83,7 @@ module ThreeScaleToolbox
           end
 
           def find_metric_by_system_name(system_name)
-            service_metrics_and_methods.find { |metric| metric['system_name'] == system_name }
+            service_metrics_and_methods.find { |metric| metric.system_name == system_name }
           end
 
           private

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.map(&:attrs)
           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

@@ -5,7 +5,7 @@ module ThreeScaleToolbox
         class ShowSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
-          FIELDS_TO_SHOW = %w[id name system_name approval_required end_user_required
+          FIELDS_TO_SHOW = %w[id name system_name approval_required
                               cost_per_month setup_fee trial_period_days].freeze
 
           def self.command
@@ -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/policies_command.rb

@@ -0,0 +1,24 @@
+require '3scale_toolbox/commands/policies_command/export_command'
+require '3scale_toolbox/commands/policies_command/import_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module PoliciesCommand
+      include ThreeScaleToolbox::Command
+      def self.command
+        Cri::Command.define do
+          name        'policies'
+          usage       'policies <sub-command> [options]'
+          summary     'policies super command'
+          description 'Policies commands'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+      add_subcommand(ExportSubcommand)
+      add_subcommand(ImportSubcommand)
+    end
+  end
+end

data/lib/3scale_toolbox/commands/policies_command/export_command.rb

@@ -0,0 +1,98 @@
+module ThreeScaleToolbox
+  module Commands
+    module PoliciesCommand
+      class ExportSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+
+        class JSONSerializer
+          def call(object)
+            JSON.pretty_generate(object)
+          end
+        end
+
+        class YAMLSerializer
+          def call(object)
+            YAML.dump(object)
+          end
+        end
+
+        class SerializerTransformer
+          def call(output_format)
+            raise unless %w[yaml json].include?(output_format)
+
+            case output_format
+            when 'yaml'
+              YAMLSerializer.new
+            when 'json'
+              JSONSerializer.new
+            end
+          end
+        end
+
+        def self.command
+          Cri::Command.define do
+            name        'export'
+            usage       'export [opts] <remote> <product>'
+            summary     'export product policy chain'
+            description 'export product policy chain'
+
+            option      :f, :file, 'Write to file instead of stdout', argument: :required
+            option      :o, :output, 'Output format. One of: json|yaml', argument: :required, transform: SerializerTransformer.new
+            param       :remote
+            param       :service_ref
+
+            runner ExportSubcommand
+          end
+        end
+
+        def run
+          select_output do |output|
+            output.write(serializer.call(product.policies))
+          end
+        end
+
+        private
+
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
+
+        def product
+          @product ||= find_product
+        end
+
+        def service_ref
+          arguments[:service_ref]
+        end
+
+        def find_product
+          Entities::Service.find(remote: remote,
+                                 ref: service_ref).tap do |svc|
+            raise ThreeScaleToolbox::Error, "Product #{service_ref} does not exist" if svc.nil?
+          end
+        end
+
+        def file
+          options[:file]
+        end
+
+        def select_output
+          ios = if file
+                  File.open(file, 'w')
+                else
+                  $stdout
+                end
+          begin
+            yield(ios)
+          ensure
+            ios.close
+          end
+        end
+
+        def serializer
+          options.fetch(:output, YAMLSerializer.new)
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,61 @@
+module ThreeScaleToolbox
+  module Commands
+    module PoliciesCommand
+      class ImportSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+        include ThreeScaleToolbox::ResourceReader
+
+        def self.command
+          Cri::Command.define do
+            name        'import'
+            usage       'import [opts] <remote> <product>'
+            summary     'import product policy chain'
+            description 'import product policy chain'
+
+            option      :f, :file, 'Read from file', argument: :required
+            option      :u, :url, 'Read from url', argument: :required
+            param       :remote
+            param       :service_ref
+
+            runner ImportSubcommand
+          end
+        end
+
+        def run
+          res = product.update_policies('policies_config' => policies)
+          if res.is_a?(Hash) && (errors = res['errors'])
+            raise ThreeScaleToolbox::Error, "Product policies have not been imported. #{errors}"
+          end
+          if res.is_a?(Array) && (error_item = res.find { |i| i.key?('errors') })
+            raise ThreeScaleToolbox::Error, "Product policies have not been imported. #{error_item['errors']}"
+          end
+        end
+
+        private
+
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
+
+        def service_ref
+          arguments[:service_ref]
+        end
+
+        def product
+          @product ||= find_product
+        end
+
+        def find_product
+          Entities::Service.find(remote: remote,
+                                 ref: service_ref).tap do |svc|
+            raise ThreeScaleToolbox::Error, "Product #{service_ref} does not exist" if svc.nil?
+          end
+        end
+
+        def policies
+          @policies ||= load_resource(options[:file] || options[:url] || '-')
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,26 @@
+require '3scale_toolbox/commands/product_command/copy_command'
+require '3scale_toolbox/commands/product_command/export_command'
+require '3scale_toolbox/commands/product_command/import_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)
+      add_subcommand(ExportSubcommand)
+      add_subcommand(ImportSubcommand)
+    end
+  end
+end