3scale_toolbox 0.10.0 → 0.11.0

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

@@ -0,0 +1,50 @@
+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
+
+          def run
+            print_header
+            print_data
+          end
+
+          private
+
+          SERVICE_FIELDS_TO_SHOW = %w[id name system_name]
+
+          def services
+            @services ||= remote.list_services()
+          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 print_data
+            services.each do |service|
+              puts SERVICE_FIELDS_TO_SHOW.map { |field| service.fetch(field, '(empty)') }.join("\t")
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,63 @@
+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
+
+          def run
+            print_header
+            print_data
+          end
+
+          private
+
+          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
+          ]
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def ref
+            @ref ||= arguments[:service_id_or_system_name]
+          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
+          end
+
+          def print_header
+            puts SERVICE_FIELDS_TO_SHOW.map { |e| e.upcase }.join("\t")
+          end
+
+          def print_data
+            puts SERVICE_FIELDS_TO_SHOW.map { |field| service.attrs.fetch(field, '(empty)') }.join("\t")
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -8,8 +8,11 @@ module ThreeScaleToolbox
           Cri::Command.define do
             name        'service'
             usage       'service [opts] -s <src> -d <dst> <src_service_id> <dst_service_id>'
-            summary     'update service'
-            description 'Update existing service, update proxy settings, metrics, methods, application plans and mapping rules.'
+            summary     '[DEPRECTATED] update service'
+            description <<-HEREDOC
+            This command has been deprecated. Use '3scale copy service' instead.
+            \n Update existing service, update proxy settings, metrics, methods, application plans and mapping rules.'
+            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
@@ -37,7 +40,7 @@ module ThreeScaleToolbox
 
           tasks = []
           unless options[:'rules-only']
-            tasks << Tasks::UpdateServiceSettingsTask.new(context.merge(target_name: system_name))
+            tasks << Tasks::CopyServiceSettingsTask.new(context)
             tasks << Tasks::CopyMethodsTask.new(context)
             tasks << Tasks::CopyMetricsTask.new(context)
             tasks << Tasks::CopyApplicationPlansTask.new(context)

data/lib/3scale_toolbox/entities.rb

@@ -2,3 +2,7 @@ require '3scale_toolbox/entities/service'
 require '3scale_toolbox/entities/application_plan'
 require '3scale_toolbox/entities/metric'
 require '3scale_toolbox/entities/method'
+require '3scale_toolbox/entities/activedocs'
+require '3scale_toolbox/entities/account'
+require '3scale_toolbox/entities/proxy_config'
+require '3scale_toolbox/entities/application'

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

@@ -0,0 +1,63 @@
+require '3scale_toolbox/entities/base_entity'
+
+module ThreeScaleToolbox
+  module Entities
+    class Account
+      include ThreeScaleToolbox::Entities::Entity
+      PRINTABLE_VARS = %w[id org_name].freeze
+      VERBOSE_PRINTABLE_VARS = %w[
+        id org_name created_at updated_at admin_domain domain from_email
+        support_email finance_support_email monthly_billing_enabled
+        monthly_charging_enabled
+      ].freeze
+      public_constant :PRINTABLE_VARS
+      public_constant :VERBOSE_PRINTABLE_VARS
+
+      class << self
+        def find(remote:, ref:)
+          new(id: ref, remote: remote).tap(&:attrs)
+        rescue ThreeScale::API::HttpClient::NotFoundError
+          find_by_text(ref, remote)
+        end
+
+        def find_by_text(text, client)
+          account = client.find_account(email: text, buyer_provider_key: text,
+                                        buyer_service_token: text)
+          if (errors = account['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new(
+              'Account find returned errors', errors
+            )
+          end
+          new(id: account['id'], remote: client, attrs: account)
+        rescue ThreeScale::API::HttpClient::NotFoundError
+          nil
+        end
+      end
+
+      def attrs
+        @attrs ||= account_attrs
+      end
+
+      def applications
+        app_attrs_list = remote.list_account_applications(id)
+        if app_attrs_list.respond_to?(:has_key?) && (errors = app_attrs_list['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Account applications not read', errors)
+        end
+
+        app_attrs_list.map do |app_attrs|
+          Entities::Application.new(id: app_attrs.fetch('id'), remote: remote, attrs: app_attrs)
+        end
+      end
+
+      private
+
+      def account_attrs
+        remote.show_account(id).tap do |account|
+          if (errors = account['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('Account attrs not read', errors)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,88 @@
+module ThreeScaleToolbox
+  module Entities
+    class ActiveDocs
+      class << self
+        def create(remote:, attrs:)
+          activedocs_res = create_activedocs(remote: remote, attrs: attrs)
+          new(id: activedocs_res.fetch('id'), remote: remote, attrs: activedocs_res)
+        end
+
+        # ref can be system_name or activedocs_id
+        def find(remote:, ref:)
+          new(id: ref, remote: remote).tap(&:attrs)
+        rescue ThreeScaleToolbox::ActiveDocsNotFoundError
+          find_by_system_name(remote: remote, system_name: ref)
+        end
+
+        def find_by_system_name(remote:, system_name:)
+          activedocs_list = remote.list_activedocs
+
+          if activedocs_list.respond_to?(:has_key?) && (errors = activedocs_list['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('ActiveDocs list not read', errors)
+          end
+
+          res_attrs = activedocs_list.find { |svc| svc['system_name'] == system_name }
+          return if res_attrs.nil?
+
+          new(id: res_attrs.fetch('id'), remote: remote, attrs: res_attrs)
+        end
+
+        private
+
+        def create_activedocs(remote:, attrs:)
+          activedocs_res = remote.create_activedocs(attrs)
+          if (errors = activedocs_res['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('ActiveDocs has not been created', errors)
+          end
+
+          activedocs_res
+        end
+      end
+
+      attr_reader :id, :remote
+
+      def initialize(id:, remote:, attrs: nil)
+        @id = id
+        @remote = remote
+        @attrs = attrs
+      end
+
+      def attrs
+        @attrs ||= activedoc_attrs
+      end
+
+      def delete
+        remote.delete_activedocs id
+      end
+
+      def update(a_attrs)
+        new_attrs = remote.update_activedocs(id, a_attrs)
+        if (errors = new_attrs['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('ActiveDocs has not been updated', errors)
+        end
+
+        # update current attrs
+        @attrs = new_attrs
+
+        new_attrs
+      end
+
+      private
+
+      def activedoc_attrs
+        activedocs_list = remote.list_activedocs
+
+        if activedocs_list.respond_to?(:has_key?) && (errors = activedocs_list['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('ActiveDocs list not read', errors)
+        end
+
+        res_attrs = activedocs_list.find { |adocs| adocs.fetch('id') == id }
+        if res_attrs.nil?
+          raise ThreeScaleToolbox::ActiveDocsNotFoundError.new(id)
+        end
+
+        res_attrs
+      end
+    end
+  end
+end

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

@@ -0,0 +1,124 @@
+module ThreeScaleToolbox
+  module Entities
+    class Application
+      class << self
+        def create(remote:, account_id:, plan_id:, app_attrs: nil)
+          attrs = remote.create_application(account_id, app_attrs, plan_id: plan_id)
+          if (errors = attrs['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('Application has not been created', errors)
+          end
+
+          new(id: attrs.fetch('id'), remote: remote, attrs: attrs)
+        end
+
+        # ref can be
+        # * Application internal id
+        # * User_key (API key)
+        # * App_id (from app_id/app_key pair)
+        # * Client ID (for OAuth and OpenID Connect authentication modes)
+        def find(remote:, ref:)
+          app = find_by_user_key(remote, ref)
+          return app unless app.nil?
+
+          app = find_by_app_id(remote, ref)
+          return app unless app.nil?
+
+          app = find_by_id(remote, ref)
+          return app unless app.nil?
+
+          nil
+        end
+
+        def find_by_id(remote, id)
+          generic_find(remote, :id, id)
+        end
+
+        def find_by_user_key(remote, user_key)
+          generic_find(remote, :user_key, user_key)
+        end
+
+        def find_by_app_id(remote, app_id)
+          generic_find(remote, :application_id, app_id)
+        end
+
+        private
+
+        def generic_find(remote, type, ref)
+          # find_application criteria only accepts one parameter.
+          # Otherwise unexpected behavior
+          attrs = remote.find_application(type => ref)
+          if (errors = attrs['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('Application find error', errors)
+          end
+
+          new(id: attrs.fetch('id'), remote: remote, attrs: attrs)
+        rescue ThreeScale::API::HttpClient::NotFoundError
+          nil
+        end
+      end
+
+      attr_reader :id, :remote
+
+      def initialize(id:, remote:, attrs: nil)
+        @id = id
+        @remote = remote
+        @attrs = attrs
+      end
+
+      def attrs
+        @attrs ||= application_attrs
+      end
+
+      def update(app_attrs)
+        new_attrs = remote.update_application(account_id, id, app_attrs)
+        if (errors = new_attrs['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Application has not been updated', errors)
+        end
+
+        @attrs = new_attrs
+
+        new_attrs
+      end
+
+      def resume
+        new_attrs = remote.resume_application(account_id, id)
+        if (errors = new_attrs['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Application has not been resumed', errors)
+        end
+
+        @attrs = new_attrs
+
+        new_attrs
+      end
+
+      def suspend
+        new_attrs = remote.suspend_application(account_id, id)
+        if (errors = new_attrs['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Application has not been suspended', errors)
+        end
+
+        @attrs = new_attrs
+
+        new_attrs
+      end
+
+      def delete
+        remote.delete_application account_id, id
+      end
+
+      private
+
+      def account_id
+        attrs.fetch('account_id')
+      end
+
+      def application_attrs
+        remote.show_application(id).tap do |application|
+          if (errors = application['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('Application attrs not read', errors)
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -3,7 +3,7 @@ module ThreeScaleToolbox
     class ApplicationPlan
       class << self
         def create(service:, plan_attrs:)
-          plan = service.remote.create_application_plan service.id, build_plan_attrs(plan_attrs)
+          plan = service.remote.create_application_plan service.id, create_plan_attrs(plan_attrs)
           if (errors = plan['errors'])
             raise ThreeScaleToolbox::ThreeScaleApiError.new('Application plan has not been created', errors)
           end
@@ -25,14 +25,13 @@ module ThreeScaleToolbox
           new(id: plan.fetch('id'), service: service, attrs: plan)
         end
 
-        def build_plan_attrs(source_attrs)
+        def create_plan_attrs(source_attrs)
           # shallow copy is enough
           source_attrs.clone.tap do |new_plan_attrs|
             # plans are created by default in hidden state
             # If published is required, 'state_event' attr has to be added
             state = new_plan_attrs.delete('state')
             new_plan_attrs['state_event'] = 'publish' if state == 'published'
-            new_plan_attrs['state_event'] = 'hide' if state == 'hidden'
           end
         end
       end
@@ -52,7 +51,7 @@ module ThreeScaleToolbox
 
       def update(plan_attrs)
         new_attrs = remote.update_application_plan(service.id, id,
-                                                   self.class.build_plan_attrs(plan_attrs))
+                                                   update_plan_attrs(plan_attrs))
         if (errors = new_attrs['errors'])
           raise ThreeScaleToolbox::ThreeScaleApiError.new('Application plan has not been updated', errors)
         end
@@ -160,6 +159,17 @@ module ThreeScaleToolbox
         remote.delete_application_plan service.id, id
       end
 
+      def applications
+        app_attrs_list = remote.list_applications(service_id: service.id, plan_id: id)
+        if app_attrs_list.respond_to?(:has_key?) && (errors = app_attrs_list['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Plan applications not read', errors)
+        end
+
+        app_attrs_list.map do |app_attrs|
+          Entities::Application.new(id: app_attrs.fetch('id'), remote: remote, attrs: app_attrs)
+        end
+      end
+
       private
 
       def read_plan_attrs
@@ -171,6 +181,20 @@ module ThreeScaleToolbox
         plan_attrs
       end
 
+      def update_plan_attrs(source_attrs)
+        # shallow copy is enough
+        source_attrs.clone.tap do |new_plan_attrs|
+          new_plan_attrs.delete('id')
+          new_plan_attrs.delete('links')
+          new_plan_attrs.delete('system_name')
+          # plans are created by default in hidden state
+          # If published is required, 'state_event' attr has to be added
+          state = new_plan_attrs.delete('state')
+          new_plan_attrs['state_event'] = 'publish' if state == 'published'
+          new_plan_attrs['state_event'] = 'hide' if state == 'hidden'
+        end
+      end
+
       def eternity_zero_limits
         limits.select { |limit| zero_eternity_limit_attrs < limit }
       end