3scale_toolbox 0.10.0 → 0.11.0

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

@@ -0,0 +1,44 @@
+module ThreeScaleToolbox
+  module Entities
+    module Entity
+      PRINTABLE_VARS = %w[
+        id
+      ].freeze
+
+      VERBOSE_PRINTABLE_VARS = %w[
+        id
+      ].freeze
+
+      public_constant :PRINTABLE_VARS
+      public_constant :VERBOSE_PRINTABLE_VARS
+
+      attr_accessor :verbose
+      attr_reader :id, :attrs, :remote
+
+      def initialize(id:, remote:, attrs: nil, verbose: false)
+        @id = id
+        @remote = remote
+        @attrs = attrs
+        @verbose = verbose
+      end
+
+      def to_s
+        if @verbose
+          format_vars(printable_attrs: self.class.const_get(:VERBOSE_PRINTABLE_VARS, inherit: true))
+        else
+          format_vars(printable_attrs: self.class.const_get(:PRINTABLE_VARS, inherit: true))
+        end
+      end
+
+      private
+
+      def format_vars(printable_attrs: nil)
+        print_attrs = attrs.merge({ ":id" => @id })
+        formatted_vars = printable_attrs.map do |attr|
+          "#{attr} => #{attrs[attr]}"
+        end
+        formatted_vars.join("\n")
+      end
+    end
+  end
+end

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

@@ -0,0 +1,58 @@
+module ThreeScaleToolbox
+  module Entities
+    class ProxyConfig
+      class << self
+        def find(service:, environment:, version:)
+          new(service: service, environment: environment, version: version).tap(&:attrs)
+        rescue ThreeScale::API::HttpClient::NotFoundError
+          nil
+        end
+
+        def find_latest(service:, environment:)
+          proxy_cfg = service.remote.proxy_config_latest(service.id, environment)
+          if (errors = proxy_cfg['errors'])
+            raise ThreeScaleToolbox::ThreeScaleApiError.new('ProxyConfig find_latest not read', errors)
+          end
+          new(service: service, environment: environment, version: proxy_cfg["version"], attrs: proxy_cfg)
+        rescue ThreeScale::API::HttpClient::NotFoundError
+          nil
+        end
+      end
+
+      attr_reader :remote, :service, :environment, :version
+
+      def initialize(environment:, service:, version:, attrs: nil)
+        @remote = service.remote
+        @service = service
+        @environment = environment
+        @version = version
+        @attrs = attrs
+      end
+
+      def attrs
+        @attrs ||= proxy_config_attrs
+      end
+
+      def promote(to:)
+        res = remote.promote_proxy_config(service.id, environment, version, to)
+
+        if (errors = res['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('ProxyConfig not promoted', errors)
+        end
+        res
+      end
+
+      private
+
+      def proxy_config_attrs
+        proxy_cfg = remote.show_proxy_config(service.id, environment, version)
+
+        if (errors = proxy_cfg['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('ProxyConfig not read', errors)
+        end
+        proxy_cfg
+      end
+
+    end
+  end
+end

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

@@ -9,10 +9,10 @@ module ThreeScaleToolbox
       public_constant :VALID_PARAMS
 
       class << self
-        def create(remote:, service:, system_name:)
+        def create(remote:, service_params:)
           svc_attrs = create_service(
             remote: remote,
-            service: copy_service_params(service, system_name)
+            service: filtered_service_params(service_params)
           )
           if (errors = svc_attrs['errors'])
             raise ThreeScaleToolbox::ThreeScaleApiError.new('Service has not been created', errors)
@@ -58,11 +58,8 @@ module ThreeScaleToolbox
           svc_obj
         end
 
-        def copy_service_params(original, system_name)
-          service_params = Helper.filter_params(VALID_PARAMS, original)
-          service_params.tap do |hash|
-            hash['system_name'] = system_name if system_name
-          end
+        def filtered_service_params(original_params)
+          Helper.filter_params(VALID_PARAMS, original_params)
         end
       end
 
@@ -146,7 +143,7 @@ module ThreeScaleToolbox
       end
 
       def update(svc_attrs)
-        new_attrs = remote.update_service id, svc_attrs
+        new_attrs = safe_update(svc_attrs)
         if (errors = new_attrs['errors'])
           raise ThreeScaleToolbox::ThreeScaleApiError.new('Service not updated', errors)
         end
@@ -226,6 +223,28 @@ module ThreeScaleToolbox
         new_feature
       end
 
+      def proxy_configs(environment)
+        proxy_configs_attrs = remote.proxy_config_list(id, environment)
+        if proxy_configs_attrs.respond_to?(:has_key?) && (errors = proxy_configs_attrs['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('ProxyConfigs not read', errors)
+        end
+
+        proxy_configs_attrs.map do |proxy_config_attrs|
+          Entities::ProxyConfig.new(environment: environment, service: self, version: proxy_config_attrs.fetch("version"), attrs: proxy_config_attrs)
+        end
+      end
+
+      def applications
+        app_attrs_list = remote.list_applications(service_id: id)
+        if app_attrs_list.respond_to?(:has_key?) && (errors = app_attrs_list['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Service 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 service_attrs
@@ -236,6 +255,21 @@ module ThreeScaleToolbox
 
         svc
       end
+
+      def safe_update(svc_attrs)
+        new_attrs = remote.update_service id, svc_attrs
+
+        # Source and target remotes might not allow same set of deployment options
+        # Invalid deployment option check
+        # use default deployment_option
+        if (errors = new_attrs['errors']) &&
+           ThreeScaleToolbox::Helper.service_invalid_deployment_option?(errors)
+          svc_attrs.delete('deployment_option')
+          new_attrs = remote.update_service id, svc_attrs
+        end
+
+        new_attrs
+      end
     end
   end
 end

data/lib/3scale_toolbox/error.rb

@@ -6,6 +6,14 @@ module ThreeScaleToolbox
   class InvalidUrlError < Error
   end
 
+  class ActiveDocsNotFoundError < Error
+    attr_reader :id
+
+    def initialize(id)
+      super("ActiveDocs with ID #{id} not found")
+    end
+  end
+
   class ThreeScaleApiError < Error
     attr_reader :apierrors
 

data/lib/3scale_toolbox/tasks.rb

@@ -7,8 +7,9 @@ require '3scale_toolbox/tasks/copy_app_plans_task'
 require '3scale_toolbox/tasks/copy_limits_task'
 require '3scale_toolbox/tasks/destroy_mapping_rules_task'
 require '3scale_toolbox/tasks/copy_mapping_rules_task'
-require '3scale_toolbox/tasks/update_service_settings_task'
+require '3scale_toolbox/tasks/copy_service_settings_task'
 require '3scale_toolbox/tasks/copy_policies_task'
 require '3scale_toolbox/tasks/copy_pricingrules_task'
 require '3scale_toolbox/tasks/delete_activedocs_task'
 require '3scale_toolbox/tasks/copy_activedocs_task'
+require '3scale_toolbox/tasks/bump_proxy_version_task'

data/lib/3scale_toolbox/tasks/bump_proxy_version_task.rb

@@ -0,0 +1,32 @@
+module ThreeScaleToolbox
+  module Tasks
+    class BumpProxyVersionTask
+      attr_reader :service
+
+      def initialize(service:)
+        @service = service
+      end
+
+      ##
+      # bumps proxy config version to propagate proxy settings updates
+      def call
+        # 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.
+
+        # Currently it is done always because mapping rules, at least, are always created
+        # So they need to be propagated
+        proxy_settings = {
+          # Adding harmless attribute to avoid empty body
+          # update_proxy cannot be done with empty body
+          # and must be done to increase proxy version
+          # If proxy settings have not been changed since last update,
+          # this request will not have effect and proxy config version will not be bumped.
+          service_id: service.id
+        }
+
+        service.update_proxy proxy_settings
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/tasks/copy_service_settings_task.rb

@@ -0,0 +1,38 @@
+module ThreeScaleToolbox
+  module Tasks
+    class CopyServiceSettingsTask
+      include CopyTask
+      PARAMS_FILTER = %w[system_name id links]
+
+      def call
+        svc_obj = update_service source_service_settings
+        if (errors = svc_obj['errors'])
+          raise ThreeScaleToolbox::Error, "Service has not been saved. Errors: #{errors}" \
+        end
+
+        puts "updated service settings for service id #{source.id}..."
+      end
+
+      private
+
+      def source_service_settings
+        source.attrs.reject { |k, _| PARAMS_FILTER.include? k }
+      end
+
+      def update_service(service_attrs)
+        svc_obj = target.update service_attrs
+
+        # Source and target remotes might not allow same set of deployment options
+        # Invalid deployment option check
+        # use default deployment_option
+        if (errors = svc_obj['errors']) &&
+           ThreeScaleToolbox::Helper.service_invalid_deployment_option?(errors)
+          service_attrs.delete('deployment_option')
+          svc_obj = target.update service_attrs
+        end
+
+        svc_obj
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/version.rb

@@ -1,3 +1,3 @@
 module ThreeScaleToolbox
-  VERSION = '0.10.0'
+  VERSION = '0.11.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.10.0
+  version: 0.11.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-05-14 00:00:00.000000000 Z
+date: 2019-06-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.4.0
+        version: 0.5.0
 - !ruby/object:Gem::Dependency
   name: cri
   requirement: !ruby/object:Gem::Requirement
@@ -141,6 +141,19 @@ files:
 - lib/3scale_toolbox/cli/error_handler.rb
 - lib/3scale_toolbox/commands.rb
 - lib/3scale_toolbox/commands/3scale_command.rb
+- lib/3scale_toolbox/commands/account_command.rb
+- lib/3scale_toolbox/commands/account_command/find_command.rb
+- lib/3scale_toolbox/commands/activedocs_command.rb
+- lib/3scale_toolbox/commands/activedocs_command/apply_command.rb
+- lib/3scale_toolbox/commands/activedocs_command/create_command.rb
+- lib/3scale_toolbox/commands/activedocs_command/delete_command.rb
+- lib/3scale_toolbox/commands/activedocs_command/list_command.rb
+- lib/3scale_toolbox/commands/application_command.rb
+- lib/3scale_toolbox/commands/application_command/apply_command.rb
+- lib/3scale_toolbox/commands/application_command/create_command.rb
+- lib/3scale_toolbox/commands/application_command/delete_command.rb
+- lib/3scale_toolbox/commands/application_command/list_command.rb
+- lib/3scale_toolbox/commands/application_command/show_command.rb
 - lib/3scale_toolbox/commands/copy_command.rb
 - lib/3scale_toolbox/commands/copy_command/copy_service.rb
 - lib/3scale_toolbox/commands/help_command.rb
@@ -191,18 +204,35 @@ files:
 - lib/3scale_toolbox/commands/plans_command/import_command.rb
 - lib/3scale_toolbox/commands/plans_command/list_command.rb
 - lib/3scale_toolbox/commands/plans_command/show_command.rb
+- lib/3scale_toolbox/commands/policy_registry_command.rb
+- lib/3scale_toolbox/commands/policy_registry_command/copy_command.rb
+- lib/3scale_toolbox/commands/proxy_config_command.rb
+- lib/3scale_toolbox/commands/proxy_config_command/list_command.rb
+- lib/3scale_toolbox/commands/proxy_config_command/promote_command.rb
+- lib/3scale_toolbox/commands/proxy_config_command/show_command.rb
 - lib/3scale_toolbox/commands/remote_command.rb
 - lib/3scale_toolbox/commands/remote_command/remote_add.rb
 - lib/3scale_toolbox/commands/remote_command/remote_list.rb
 - lib/3scale_toolbox/commands/remote_command/remote_remove.rb
 - lib/3scale_toolbox/commands/remote_command/remote_rename.rb
+- lib/3scale_toolbox/commands/service_command.rb
+- lib/3scale_toolbox/commands/service_command/apply_command.rb
+- lib/3scale_toolbox/commands/service_command/create_command.rb
+- lib/3scale_toolbox/commands/service_command/delete_command.rb
+- lib/3scale_toolbox/commands/service_command/list_command.rb
+- lib/3scale_toolbox/commands/service_command/show_command.rb
 - lib/3scale_toolbox/commands/update_command.rb
 - lib/3scale_toolbox/commands/update_command/update_service.rb
 - lib/3scale_toolbox/configuration.rb
 - lib/3scale_toolbox/entities.rb
+- lib/3scale_toolbox/entities/account.rb
+- lib/3scale_toolbox/entities/activedocs.rb
+- lib/3scale_toolbox/entities/application.rb
 - lib/3scale_toolbox/entities/application_plan.rb
+- lib/3scale_toolbox/entities/base_entity.rb
 - lib/3scale_toolbox/entities/method.rb
 - lib/3scale_toolbox/entities/metric.rb
+- lib/3scale_toolbox/entities/proxy_config.rb
 - lib/3scale_toolbox/entities/service.rb
 - lib/3scale_toolbox/error.rb
 - lib/3scale_toolbox/helper.rb
@@ -212,6 +242,7 @@ files:
 - lib/3scale_toolbox/swagger.rb
 - lib/3scale_toolbox/swagger/swagger.rb
 - lib/3scale_toolbox/tasks.rb
+- lib/3scale_toolbox/tasks/bump_proxy_version_task.rb
 - lib/3scale_toolbox/tasks/copy_activedocs_task.rb
 - lib/3scale_toolbox/tasks/copy_app_plans_task.rb
 - lib/3scale_toolbox/tasks/copy_limits_task.rb
@@ -221,11 +252,11 @@ files:
 - lib/3scale_toolbox/tasks/copy_policies_task.rb
 - lib/3scale_toolbox/tasks/copy_pricingrules_task.rb
 - lib/3scale_toolbox/tasks/copy_service_proxy_task.rb
+- lib/3scale_toolbox/tasks/copy_service_settings_task.rb
 - lib/3scale_toolbox/tasks/copy_task.rb
 - lib/3scale_toolbox/tasks/delete_activedocs_task.rb
 - lib/3scale_toolbox/tasks/destroy_mapping_rules_task.rb
 - lib/3scale_toolbox/tasks/helper_task.rb
-- lib/3scale_toolbox/tasks/update_service_settings_task.rb
 - lib/3scale_toolbox/version.rb
 - resources/swagger_meta_schema.json
 homepage: https://github.com/3scale/3scale_toolbox

data/lib/3scale_toolbox/tasks/update_service_settings_task.rb

@@ -1,49 +0,0 @@
-module ThreeScaleToolbox
-  module Tasks
-    class UpdateServiceSettingsTask
-      attr_reader :source, :target, :target_system_name
-
-      def initialize(source:, target:, target_name:)
-        @source = source
-        @target = target
-        @target_system_name = target_name
-      end
-
-      def call
-        source_obj = source.attrs
-        svc_obj = update_service target_service_params(source_obj)
-        if (errors = svc_obj['errors'])
-          raise ThreeScaleToolbox::Error, "Service has not been saved. Errors: #{errors}" \
-        end
-
-        puts "updated service settings for service id #{source.id}..."
-      end
-
-      private
-
-      def update_service(service)
-        svc_obj = target.update service
-
-        # Source and target remotes might not allow same set of deployment options
-        # Invalid deployment option check
-        # use default deployment_option
-        if (errors = svc_obj['errors']) &&
-           ThreeScaleToolbox::Helper.service_invalid_deployment_option?(errors)
-          service.delete('deployment_option')
-          svc_obj = target.update service
-        end
-
-        svc_obj
-      end
-
-      # system name only included when specified from options
-      def target_service_params(source)
-        target_svc_obj = ThreeScaleToolbox::Helper.filter_params(Entities::Service::VALID_PARAMS, source)
-        target_svc_obj.delete('system_name')
-        target_svc_obj.tap do |hash|
-          hash['system_name'] = target_system_name unless target_system_name.nil?
-        end
-      end
-    end
-  end
-end