3scale_toolbox 0.15.0 → 0.16.0

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

@@ -1,46 +1,44 @@
 module ThreeScaleToolbox
   module Commands
     module ServiceCommand
-      module Delete
-        class DeleteSubcommand < Cri::CommandRunner
-          include ThreeScaleToolbox::Command
-
-          def self.command
-            Cri::Command.define do
-              name        'delete'
-              usage       'delete <remote> <service-id_or_system-name>'
-              summary     'Delete a service'
-              description 'Delete a service'
-              runner DeleteSubcommand
-
-              param   :remote
-              param   :service_id_or_system_name
-            end
+      class DeleteSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
+
+        def self.command
+          Cri::Command.define do
+            name        'delete'
+            usage       'delete <remote> <service-id_or_system-name>'
+            summary     'Delete a service'
+            description 'Delete a service'
+            runner DeleteSubcommand
+
+            param   :remote
+            param   :service_id_or_system_name
           end
+        end
 
-          def run
-            service.delete
-            puts "Service with id: #{service.id} deleted"
-          end
+        def run
+          service.delete
+          puts "Service with id: #{service.id} deleted"
+        end
 
-          private
+        private
 
-          def remote
-            @remote ||= threescale_client(arguments[:remote])
-          end
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
 
-          def ref
-            @ref ||= arguments[:service_id_or_system_name]
-          end
+        def ref
+          @ref ||= arguments[:service_id_or_system_name]
+        end
 
-          def service
-            @service ||= find_service
-          end
+        def service
+          @service ||= find_service
+        end
 
-          def find_service
-            Entities::Service::find(remote: remote, ref: ref).tap do |svc|
-              raise ThreeScaleToolbox::Error, "Service #{ref} does not exist" if svc.nil?
-            end
+        def find_service
+          Entities::Service::find(remote: remote, ref: ref).tap do |svc|
+            raise ThreeScaleToolbox::Error, "Service #{ref} does not exist" if svc.nil?
           end
         end
       end

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

@@ -1,48 +1,38 @@
 module ThreeScaleToolbox
   module Commands
     module ServiceCommand
-      module List
-        class ListSubcommand < Cri::CommandRunner
-          include ThreeScaleToolbox::Command
-
-          def self.command
-            Cri::Command.define do
-              name        'list'
-              usage       'list <remote>'
-              summary     'List all services'
-              description 'List all services'
-              runner ListSubcommand
-
-              param :remote
-            end
-          end
+      class ListSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
 
-          def run
-            print_header
-            print_data
-          end
+        FIELDS = %w[id name system_name]
 
-          private
+        def self.command
+          Cri::Command.define do
+            name        'list'
+            usage       'list <remote>'
+            summary     'List all services'
+            description 'List all services'
 
-          SERVICE_FIELDS_TO_SHOW = %w[id name system_name]
+            ThreeScaleToolbox::CLI.output_flag(self)
+            param :remote
 
-          def services
-            @services ||= remote.list_services()
+            runner ListSubcommand
           end
+        end
 
-          def remote
-            @remote ||= threescale_client(arguments[:remote])
-          end
+        def run
+          printer.print_collection remote.list_services
+        end
 
-          def print_header
-            puts SERVICE_FIELDS_TO_SHOW.map { |e| e.upcase }.join("\t")
-          end
+        private
 
-          def print_data
-            services.each do |service|
-              puts SERVICE_FIELDS_TO_SHOW.map { |field| service.fetch(field, '(empty)') }.join("\t")
-            end
-          end
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
+
+        def printer
+          # keep backwards compatibility
+          options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS))
         end
       end
     end

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

@@ -1,62 +1,57 @@
 module ThreeScaleToolbox
   module Commands
     module ServiceCommand
-      module Show
-        class ShowSubcommand < Cri::CommandRunner
-          include ThreeScaleToolbox::Command
-
-          def self.command
-            Cri::Command.define do
-              name        'show'
-              usage       'show <remote> <service-id_or_system-name>'
-              summary     'Show the information of a service'
-              description "Show the information of a service"
-              runner ShowSubcommand
-
-              param   :remote
-              param   :service_id_or_system_name
-            end
-          end
+      class ShowSubcommand < Cri::CommandRunner
+        include ThreeScaleToolbox::Command
 
-          def run
-            print_header
-            print_data
-          end
+        FIELDS = %w[
+          id name state system_name end_user_registration_required
+          backend_version deployment_option support_email description
+          created_at updated_at
+        ]
 
-          private
+        def self.command
+          Cri::Command.define do
+            name        'show'
+            usage       'show <remote> <service-id_or_system-name>'
+            summary     'Show the information of a service'
+            description "Show the information of a service"
 
-          SERVICE_FIELDS_TO_SHOW = %w[
-            id name state system_name end_user_registration_required
-            backend_version deployment_option support_email description
-            created_at updated_at
-          ]
+            ThreeScaleToolbox::CLI.output_flag(self)
+            param   :remote
+            param   :service_id_or_system_name
 
-          def remote
-            @remote ||= threescale_client(arguments[:remote])
+            runner ShowSubcommand
           end
+        end
 
-          def ref
-            @ref ||= arguments[:service_id_or_system_name]
-          end
+        def run
+          printer.print_record service.attrs
+        end
 
-          def service
-            @service ||= find_service
-          end
+        private
 
-          def find_service
-            Entities::Service::find(remote: remote, ref: ref).tap do |svc|
-              raise ThreeScaleToolbox::Error, "Service #{ref} does not exist" if svc.nil?
-            end
-          end
+        def remote
+          @remote ||= threescale_client(arguments[:remote])
+        end
 
-          def print_header
-            puts SERVICE_FIELDS_TO_SHOW.map { |e| e.upcase }.join("\t")
-          end
+        def ref
+          @ref ||= arguments[:service_id_or_system_name]
+        end
 
-          def print_data
-            puts SERVICE_FIELDS_TO_SHOW.map { |field| service.attrs.fetch(field, '(empty)') }.join("\t")
+        def service
+          @service ||= find_service
+        end
+
+        def find_service
+          Entities::Service::find(remote: remote, ref: ref).tap do |svc|
+            raise ThreeScaleToolbox::Error, "Service #{ref} does not exist" if svc.nil?
           end
         end
+
+        def printer
+          options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS))
+        end
       end
     end
   end

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

@@ -1,4 +1,4 @@
-require '3scale_toolbox/commands/update_command/update_service'
+require '3scale_toolbox/commands/update_command/service_command'
 
 module ThreeScaleToolbox
   module Commands
@@ -16,7 +16,7 @@ module ThreeScaleToolbox
           end
         end
       end
-      add_subcommand(UpdateServiceSubcommand)
+      add_subcommand(ServiceSubcommand)
     end
   end
 end

data/lib/3scale_toolbox/commands/update_command/{update_service.rb → service_command.rb}

@@ -1,7 +1,10 @@
+require '3scale_toolbox/commands/update_command/service_command/delete_activedocs_task'
+require '3scale_toolbox/commands/update_command/service_command/copy_service_settings_task'
+
 module ThreeScaleToolbox
   module Commands
     module UpdateCommand
-      class UpdateServiceSubcommand < Cri::CommandRunner
+      class ServiceSubcommand < Cri::CommandRunner
         include ThreeScaleToolbox::Command
 
         def self.command
@@ -22,7 +25,7 @@ module ThreeScaleToolbox
             param   :src_service_id
             param   :dst_service_id
 
-            runner UpdateServiceSubcommand
+            runner ServiceSubcommand
           end
         end
 
@@ -35,28 +38,27 @@ module ThreeScaleToolbox
             id: arguments[:dst_service_id],
             remote: threescale_client(fetch_required_option(:destination))
           )
-          system_name = options[:target_system_name]
           context = create_context(source_service, update_service)
 
           tasks = []
           unless options[:'rules-only']
-            tasks << Tasks::CopyServiceSettingsTask.new(context)
-            tasks << Tasks::CopyMethodsTask.new(context)
-            tasks << Tasks::CopyMetricsTask.new(context)
-            tasks << Tasks::CopyApplicationPlansTask.new(context)
-            tasks << Tasks::CopyLimitsTask.new(context)
-            tasks << Tasks::CopyPoliciesTask.new(context)
-            tasks << Tasks::CopyPricingRulesTask.new(context)
-            tasks << Tasks::DeleteActiveDocsTask.new(context)
-            tasks << Tasks::CopyActiveDocsTask.new(context)
+            tasks << ServiceCommand::CopyServiceSettingsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMethodsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMetricsTask.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 << ServiceCommand::DeleteActiveDocsTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyActiveDocsTask.new(context)
             # Copy proxy must be the last task
             # Proxy update is the mechanism to increase version of the proxy,
             # Hence propagating (mapping rules, poicies, oidc, auth) update to
             # latest proxy config, making available to gateway.
-            tasks << Tasks::CopyServiceProxyTask.new(context)
+            tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyServiceProxyTask.new(context)
           end
-          tasks << Tasks::DestroyMappingRulesTask.new(context) if options[:force]
-          tasks << Tasks::CopyMappingRulesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::DestroyMappingRulesTask.new(context)
+          tasks << ThreeScaleToolbox::Commands::ServiceCommand::CopyCommand::CopyMappingRulesTask.new(context)
 
           # run tasks
           tasks.each(&:call)
@@ -67,7 +69,8 @@ module ThreeScaleToolbox
         def create_context(source, target)
           {
             source: source,
-            target: target
+            target: target,
+            delete_mapping_rules: options[:force]
           }
         end
       end

data/lib/3scale_toolbox/commands/update_command/service_command/copy_service_settings_task.rb

@@ -0,0 +1,35 @@
+module ThreeScaleToolbox
+  module Commands
+    module UpdateCommand
+      module ServiceCommand
+        class CopyServiceSettingsTask
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def call
+            target.update source_attrs
+
+            puts "updated service settings for service id #{source.id}..."
+          end
+
+          private
+
+          def source
+            context[:source]
+          end
+
+          def target
+            context[:target]
+          end
+
+          def source_attrs
+            source.attrs.reject { |k, _| %w[system_name id links].include? k }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/update_command/service_command/delete_activedocs_task.rb

@@ -0,0 +1,26 @@
+module ThreeScaleToolbox
+  module Commands
+    module UpdateCommand
+      module ServiceCommand
+        class DeleteActiveDocsTask
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def call
+            puts 'deleting all target service ActiveDocs'
+            target.activedocs.each do |activedoc|
+              target.remote.delete_activedocs(activedoc['id'])
+            end
+          end
+
+          def target
+            context[:target]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/entities.rb

@@ -6,3 +6,8 @@ require '3scale_toolbox/entities/activedocs'
 require '3scale_toolbox/entities/account'
 require '3scale_toolbox/entities/proxy_config'
 require '3scale_toolbox/entities/application'
+require '3scale_toolbox/entities/backend'
+require '3scale_toolbox/entities/backend_method'
+require '3scale_toolbox/entities/backend_metric'
+require '3scale_toolbox/entities/backend_mapping_rule'
+require '3scale_toolbox/entities/backend_usage'

data/lib/3scale_toolbox/entities/backend.rb

@@ -0,0 +1,152 @@
+module ThreeScaleToolbox
+  module Entities
+    class Backend
+      VALID_PARAMS = %w[name description system_name private_endpoint].freeze
+      public_constant :VALID_PARAMS
+
+      class << self
+        def create(remote:, attrs:)
+          b_attrs = remote.create_backend Helper.filter_params(VALID_PARAMS, attrs)
+          if (errors = b_attrs['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend has not been created', errors)
+          end
+
+          new(id: b_attrs.fetch('id'), remote: remote, attrs: b_attrs)
+        end
+
+        # ref can be system_name or backend_id
+        def find(remote:, ref:)
+          new(id: ref, remote: remote).tap(&:attrs)
+        rescue ThreeScaleToolbox::InvalidIdError, ThreeScale::API::HttpClient::NotFoundError
+          find_by_system_name(remote: remote, system_name: ref)
+        end
+
+        def find_by_system_name(remote:, system_name:)
+          list = remote.list_backends
+
+          if list.respond_to?(:has_key?) && (errors = list['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend list not read', errors)
+          end
+
+          attrs = list.find { |backend| backend['system_name'] == system_name }
+          return if attrs.nil?
+
+          new(id: attrs.fetch('id'), remote: remote, attrs: attrs)
+        end
+      end
+
+      attr_reader :id, :remote
+
+      def initialize(id:, remote:, attrs: nil)
+        @id = id.to_i
+        @remote = remote
+        @attrs = attrs
+      end
+
+      def attrs
+        @attrs ||= fetch_backend_attrs
+      end
+
+      def system_name
+        attrs['system_name']
+      end
+
+      def metrics
+        # cache result to reuse
+        metric_and_method_list = metrics_and_methods
+        hits_metric_obj = hits_metric(metric_and_method_list)
+
+        metric_attr_list = ThreeScaleToolbox::Helper.array_difference(metric_and_method_list, methods(hits_metric_obj)) do |item, method|
+          method.id == item.fetch('id', nil)
+        end
+
+        metric_attr_list.map do |metric_attrs|
+          BackendMetric.new(id: metric_attrs.fetch('id'), backend: self, attrs: metric_attrs)
+        end
+      end
+
+      def hits
+        hits_metric(metrics_and_methods)
+      end
+
+      # @api public
+      # @param [Object] parent_metric_id BackendMetric hits object
+      # @return [List]
+      def methods(parent_metric_id)
+        return [] if parent_metric_id.nil?
+
+        method_attr_list = remote.list_backend_methods id, parent_metric_id.id
+        if method_attr_list.respond_to?(:has_key?) && (errors = method_attr_list['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend methods not read', errors)
+        end
+
+        method_attr_list.map do |method_attrs|
+          BackendMethod.new(id: method_attrs.fetch('id'),
+                            backend: self,
+                            parent_id: parent_metric_id.id,
+                            attrs: method_attrs)
+        end
+      end
+
+      def mapping_rules
+        m_r = remote.list_backend_mapping_rules id
+        if m_r.respond_to?(:has_key?) && (errors = m_r['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend mapping rules not read', errors)
+        end
+
+        m_r.map do |mr_attrs|
+          BackendMappingRule.new(id: mr_attrs.fetch('id'), backend: self, attrs: mr_attrs)
+        end
+      end
+
+      def update(b_attrs)
+        new_attrs = remote.update_backend id, Helper.filter_params(VALID_PARAMS, b_attrs)
+        if (errors = new_attrs['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend not updated', errors)
+        end
+
+        # update current attrs
+        @attrs = new_attrs
+
+        new_attrs
+      end
+
+      def delete
+        remote.delete_backend id
+      end
+
+      def ==(other)
+        remote.http_client.endpoint == other.remote.http_client.endpoint && id == other.id
+      end
+
+      private
+
+      def metrics_and_methods
+        m_m = remote.list_backend_metrics id
+        if m_m.respond_to?(:has_key?) && (errors = m_m['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend metrics not read', errors)
+        end
+
+        m_m
+      end
+
+      def hits_metric(metric_attr_list)
+        metric_list = metric_attr_list.map do |metric_attrs|
+          BackendMetric.new(id: metric_attrs.fetch('id'), backend: self, attrs: metric_attrs)
+        end
+        metric_list.find { |metric| metric.system_name == 'hits' }
+      end
+
+      def fetch_backend_attrs
+        raise ThreeScaleToolbox::InvalidIdError if id.zero?
+
+        backend = remote.backend id
+        if (errors = backend['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Backend attrs not read', errors)
+        end
+
+        backend
+      end
+    end
+  end
+end