3scale_toolbox 0.9.0 → 0.10.0

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

@@ -0,0 +1,64 @@
+module ThreeScaleToolbox
+  module Commands
+    module MethodsCommand
+      module List
+        class ListSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          FIELDS_TO_SHOW = %w[id friendly_name system_name description].freeze
+
+          def self.command
+            Cri::Command.define do
+              name        'list'
+              usage       'list [opts] <remote> <service>'
+              summary     'list methods'
+              description 'List methods'
+
+              param       :remote
+              param       :service_ref
+
+              runner ListSubcommand
+            end
+          end
+
+          def run
+            print_header
+            print_data
+          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
+
+          def find_service
+            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
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,28 @@
+require '3scale_toolbox/commands/metrics_command/create_command'
+require '3scale_toolbox/commands/metrics_command/list_command'
+require '3scale_toolbox/commands/metrics_command/apply_command'
+require '3scale_toolbox/commands/metrics_command/delete_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module MetricsCommand
+      include ThreeScaleToolbox::Command
+      def self.command
+        Cri::Command.define do
+          name        'metrics'
+          usage       'metrics <sub-command> [options]'
+          summary     'metrics super command'
+          description 'Metrics commands'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+      add_subcommand(Create::CreateSubcommand)
+      add_subcommand(List::ListSubcommand)
+      add_subcommand(Apply::ApplySubcommand)
+      add_subcommand(Delete::DeleteSubcommand)
+    end
+  end
+end

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

@@ -0,0 +1,102 @@
+module ThreeScaleToolbox
+  module Commands
+    module MetricsCommand
+      module Apply
+        class ApplySubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'apply'
+              usage       'apply [opts] <remote> <service> <metric>'
+              summary     'Update metric'
+              description 'Update (create if it does not exist) metric'
+
+              option      :n, :name, 'Metric name', argument: :required
+              flag        nil, :disabled, 'Disables this metric in all application plans'
+              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
+              param       :remote
+              param       :service_ref
+              param       :metric_ref
+
+              runner ApplySubcommand
+            end
+          end
+
+          def run
+            validate_option_params
+            metric = Entities::Metric.find(service: service, ref: metric_ref)
+            if metric.nil?
+              metric = Entities::Metric.create(service: service,
+                                               attrs: create_metric_attrs)
+            else
+              metric.update(metric_attrs) unless metric_attrs.empty?
+            end
+
+            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('; ')
+          end
+
+          private
+
+          def validate_option_params
+            raise ThreeScaleToolbox::Error, '--disabled and --enabled are mutually exclusive' \
+              if option_enabled && option_disabled
+          end
+
+          def create_metric_attrs
+            metric_attrs.merge('system_name' => metric_ref,
+                               'unit' => 'hit',
+                               'friendly_name' => metric_ref) { |_key, oldval, _newval| oldval }
+          end
+
+          def metric_attrs
+            {
+              'friendly_name' => options[:name],
+              'unit' => options[:unit],
+              'description' => options[:description]
+            }.compact
+          end
+
+          def option_enabled
+            !options[:enabled].nil?
+          end
+
+          def option_disabled
+            !options[:disabled].nil?
+          end
+
+          def service
+            @service ||= find_service
+          end
+
+          def find_service
+            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
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+
+          def metric_ref
+            arguments[:metric_ref]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,77 @@
+module ThreeScaleToolbox
+  module Commands
+    module MetricsCommand
+      module Create
+        class CreateSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'create'
+              usage       'create [opts] <remote> <service> <metric-name>'
+              summary     'create metric'
+              description 'Create metric'
+
+              option      :t, 'system-name', 'Metric system name', argument: :required
+              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
+              param       :remote
+              param       :service_ref
+              param       :metric_name
+
+              runner CreateSubcommand
+            end
+          end
+
+          def run
+            metric = ThreeScaleToolbox::Entities::Metric.create(
+              service: service,
+              attrs: metric_attrs
+            )
+            metric.disable if option_disabled
+            puts "Created metric id: #{metric.id}. Disabled: #{option_disabled}"
+          end
+
+          private
+
+          def metric_attrs
+            {
+              'system_name' => options[:'system-name'],
+              'unit' => unit,
+              'friendly_name' => arguments[:metric_name],
+              'description' => options[:description]
+            }.compact
+          end
+
+          def unit
+            options[:unit] || 'hit'
+          end
+
+          def option_disabled
+            !options[:disabled].nil?
+          end
+
+          def service
+            @service ||= find_service
+          end
+
+          def find_service
+            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
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,66 @@
+module ThreeScaleToolbox
+  module Commands
+    module MetricsCommand
+      module Delete
+        class DeleteSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'delete'
+              usage       'delete [opts] <remote> <service> <metric>'
+              summary     'delete metric'
+              description 'Delete metric'
+
+              param       :remote
+              param       :service_ref
+              param       :metric_ref
+
+              runner DeleteSubcommand
+            end
+          end
+
+          def run
+            metric.delete
+            puts "Metric id: #{metric.id} deleted"
+          end
+
+          private
+
+          def service
+            @service ||= find_service
+          end
+
+          def metric
+            @metric ||= find_metric
+          end
+
+          def find_service
+            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
+
+          def find_metric
+            Entities::Metric.find(service: service, ref: metric_ref).tap do |p|
+              raise ThreeScaleToolbox::Error, "Metric #{metric_ref} does not exist" if p.nil?
+            end
+          end
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+
+          def metric_ref
+            arguments[:metric_ref]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,70 @@
+module ThreeScaleToolbox
+  module Commands
+    module MetricsCommand
+      module List
+        class ListSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          FIELDS_TO_SHOW = %w[id friendly_name system_name unit description].freeze
+
+          def self.command
+            Cri::Command.define do
+              name        'list'
+              usage       'list [opts] <remote> <service>'
+              summary     'list metrics'
+              description 'List metrics'
+
+              param       :remote
+              param       :service_ref
+
+              runner ListSubcommand
+            end
+          end
+
+          def run
+            print_header
+            print_data
+          end
+
+          private
+
+          def print_header
+            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
+          end
+
+          def print_data
+            metrics.each do |metric|
+              puts FIELDS_TO_SHOW.map { |field| metric.fetch(field, '(empty)') }.join("\t")
+            end
+          end
+
+          def metrics
+            hits_id = service.hits['id']
+            ThreeScaleToolbox::Helper.array_difference(service.metrics, service.methods(hits_id)) do |metric, method|
+              ThreeScaleToolbox::Helper.compare_hashes(metric, method, %w[id])
+            end
+          end
+
+          def service
+            @service ||= find_service
+          end
+
+          def find_service
+            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
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,7 +8,7 @@ module ThreeScaleToolbox
           def self.command
             Cri::Command.define do
               name        'create'
-              usage       'create [opts] <remote> <service> <plan_name>'
+              usage       'create [opts] <remote> <service> <plan-name>'
               summary     'create application plan'
               description 'Create application plan'
 

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

@@ -7,7 +7,7 @@ module ThreeScaleToolbox
           ##
           # Reads Application plan
           def call
-            result[:plan] = plan.show
+            result[:plan] = plan.attrs
           end
         end
       end

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

@@ -50,7 +50,7 @@ module ThreeScaleToolbox
           end
 
           def service_methods
-            context[:service_methods] ||= service.methods
+            context[:service_methods] ||= service.methods(service_hits['id'])
           end
 
           def metric_info(elem, elem_name)
@@ -88,6 +88,10 @@ module ThreeScaleToolbox
           def find_method(id)
             service_methods.find { |method| method['id'] == id }
           end
+
+          def service_hits
+            context[:service_hits] ||= service.hits
+          end
         end
       end
     end