3scale_toolbox 0.10.0 → 0.11.0

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

@@ -22,9 +22,9 @@ module ThreeScaleToolbox
           def self.command
             Cri::Command.define do
               name        'openapi'
-              usage       'openapi [opts] -d <dst> <spec>'
-              summary     'Import API defintion in OpenAPI specification'
-              description 'Using an API definition format like OpenAPI, import to your 3scale API'
+              usage       'openapi [opts] -d <destination> <spec> (/path/to/your/spec/file.[json|yaml|yml] OR http[s]://domain/resource/path.[json|yaml|yml])'
+              summary     'Import API defintion in OpenAPI specification from a local file or URL'
+              description 'Using an API definition format like OpenAPI, import to your 3scale API directly from a local OpenAPI spec compliant file or a remote URL'
 
               option  :d, :destination, '3scale target instance. Format: "http[s]://<authentication>@3scale_domain"', argument: :required
               option  :t, 'target_system_name', 'Target system name', argument: :required
@@ -34,6 +34,8 @@ module ThreeScaleToolbox
               option  nil, 'default-credentials-userkey', 'Default credentials policy userkey', argument: :required
               option  nil, 'override-private-basepath', 'Override the basepath for the public URLs', argument: :required
               option  nil, 'override-public-basepath', 'Override the basepath for the private URLs', argument: :required
+              option  nil, 'staging-public-base-url', 'Custom public staging URL', argument: :required
+              option  nil, 'production-public-base-url', 'Custom public production URL', argument: :required
               param   :openapi_resource
 
               runner OpenAPISubcommand
@@ -43,20 +45,20 @@ module ThreeScaleToolbox
           def run
             tasks = []
             tasks << CreateServiceStep.new(context)
+            # other tasks might read proxy settings (CreateActiveDocsStep does)
+            tasks << UpdateServiceProxyStep.new(context)
             tasks << CreateMethodsStep.new(context)
-            tasks << ThreeScaleToolbox::Tasks::DestroyMappingRulesTask.new(context)
+            tasks << Tasks::DestroyMappingRulesTask.new(context)
             tasks << CreateMappingRulesStep.new(context)
             tasks << CreateActiveDocsStep.new(context)
             tasks << UpdateServiceOidcConfStep.new(context)
             tasks << UpdatePoliciesStep.new(context)
-            # Update proxy must be the last step
-            # 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 << UpdateServiceProxyStep.new(context)
 
             # run tasks
             tasks.each(&:call)
+
+            # This should be the last step
+            Tasks::BumpProxyVersionTask.new(service: context[:target]).call
           end
 
           private
@@ -76,7 +78,9 @@ module ThreeScaleToolbox
               oidc_issuer_endpoint: options[:'oidc-issuer-endpoint'],
               default_credentials_userkey: options[:'default-credentials-userkey'],
               skip_openapi_validation: options[:'skip-openapi-validation'],
-              override_private_basepath: options[:'override-private-basepath']
+              override_private_basepath: options[:'override-private-basepath'],
+              production_public_base_url: options[:'production-public-base-url'],
+              staging_public_base_url: options[:'staging-public-base-url']
             }
           end
 

data/lib/3scale_toolbox/commands/import_command/openapi/create_service_step.rb

@@ -15,8 +15,7 @@ module ThreeScaleToolbox
             if service.nil?
               # Create service and update context
               self.service = Entities::Service.create(remote: threescale_client,
-                                                      service: service_settings,
-                                                      system_name: service_system_name)
+                                                      service_params: service_settings)
               puts "Created service id: #{service.id}, name: #{service_name}"
             else
               service.update(service_settings)
@@ -35,6 +34,8 @@ module ThreeScaleToolbox
               svc['name'] = service_name
               svc['description'] = service_description
               svc['backend_version'] = backend_version
+              svc['system_name'] = service_system_name
+              svc['deployment_option'] = 'self_managed' if !production_public_base_url.nil? || !staging_public_base_url.nil?
             end
           end
 

data/lib/3scale_toolbox/commands/import_command/openapi/method.rb

@@ -3,7 +3,6 @@ module ThreeScaleToolbox
     module ImportCommand
       module OpenAPI
         module Method
-
           def method
             {
               'friendly_name' => friendly_name,

data/lib/3scale_toolbox/commands/import_command/openapi/step.rb

@@ -43,7 +43,6 @@ module ThreeScaleToolbox
             context[:api_spec_resource]
           end
 
-
           def security
             api_spec.security
           end
@@ -59,6 +58,14 @@ module ThreeScaleToolbox
           def override_private_basepath
             context[:override_private_basepath]
           end
+
+          def production_public_base_url
+            context[:production_public_base_url]
+          end
+
+          def staging_public_base_url
+            context[:staging_public_base_url]
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/import_command/openapi/update_service_proxy_step.rb

@@ -8,17 +8,15 @@ module ThreeScaleToolbox
           ##
           # Updates Proxy config
           def call
-            # setting required attrs, operation is idempotent
-            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
-              service_id: service.id
-            }
+            proxy_settings = {}
 
+            add_endpoint_settings(proxy_settings)
+            add_sandbox_endpoint_settings(proxy_settings)
             add_api_backend_settings(proxy_settings)
             add_security_proxy_settings(proxy_settings)
 
+            return unless proxy_settings.size.positive?
+
             res = service.update_proxy proxy_settings
             if (errors = res['errors'])
               raise ThreeScaleToolbox::Error, "Service proxy has not been updated. #{errors}"
@@ -29,6 +27,18 @@ module ThreeScaleToolbox
 
           private
 
+          def add_endpoint_settings(settings)
+            return if production_public_base_url.nil?
+
+            settings[:endpoint] = production_public_base_url
+          end
+
+          def add_sandbox_endpoint_settings(settings)
+            return if staging_public_base_url.nil?
+
+            settings[:sandbox_endpoint] = staging_public_base_url
+          end
+
           def add_api_backend_settings(settings)
             return if api_spec.host.nil?
 

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

@@ -9,10 +9,10 @@ module ThreeScaleToolbox
       include ThreeScaleToolbox::Command
       def self.command
         Cri::Command.define do
-          name        'methods'
-          usage       'methods <sub-command> [options]'
-          summary     'methods super command'
-          description 'Methods commands'
+          name        'method'
+          usage       'method <sub-command> [options]'
+          summary     'method super command'
+          description 'Method commands'
 
           run do |_opts, _args, cmd|
             puts cmd.help

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

@@ -65,11 +65,11 @@ module ThreeScaleToolbox
           end
 
           def option_enabled
-            !options[:enabled].nil?
+            options.fetch(:enabled, false)
           end
 
           def option_disabled
-            !options[:disabled].nil?
+            options.fetch(:disabled, false)
           end
 
           def service

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

@@ -45,7 +45,7 @@ module ThreeScaleToolbox
           end
 
           def option_disabled
-            !options[:disabled].nil?
+            options.fetch(:disabled, false)
           end
 
           def service

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

@@ -9,10 +9,10 @@ module ThreeScaleToolbox
       include ThreeScaleToolbox::Command
       def self.command
         Cri::Command.define do
-          name        'metrics'
-          usage       'metrics <sub-command> [options]'
-          summary     'metrics super command'
-          description 'Metrics commands'
+          name        'metric'
+          usage       'metric <sub-command> [options]'
+          summary     'metric super command'
+          description 'Metric commands'
 
           run do |_opts, _args, cmd|
             puts cmd.help

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

@@ -66,11 +66,11 @@ module ThreeScaleToolbox
           end
 
           def option_enabled
-            !options[:enabled].nil?
+            options.fetch(:enabled, false)
           end
 
           def option_disabled
-            !options[:disabled].nil?
+            options.fetch(:disabled, false)
           end
 
           def service

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

@@ -49,7 +49,7 @@ module ThreeScaleToolbox
           end
 
           def option_disabled
-            !options[:disabled].nil?
+            options.fetch(:disabled, false)
           end
 
           def service

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

@@ -19,8 +19,8 @@ module ThreeScaleToolbox
               flag        :p, :publish, 'Publish application plan'
               flag        nil, :hide, 'Hide application plan'
               option      nil, 'approval-required', 'Applications require approval. true or false', argument: :required, transform: ThreeScaleToolbox::Helper::BooleanTransformer.new
-              option      nil, 'cost-per-month', 'Cost per month', argument: :required, transform: method(:Integer)
-              option      nil, 'setup-fee', 'Setup fee', argument: :required, transform: method(:Integer)
+              option      nil, 'cost-per-month', 'Cost per month', argument: :required, transform: method(:Float)
+              option      nil, 'setup-fee', 'Setup fee', argument: :required, transform: method(:Float)
               option      nil, 'trial-period-days', 'Trial period days', argument: :required, transform: method(:Integer)
               option      nil, 'end-user-required', 'End user required. true or false', argument: :required, transform: ThreeScaleToolbox::Helper::BooleanTransformer.new
               param       :remote
@@ -88,23 +88,23 @@ module ThreeScaleToolbox
           end
 
           def option_default
-            !options[:default].nil?
+            options.fetch(:default, false)
           end
 
           def option_enabled
-            !options[:enabled].nil?
+            options.fetch(:enabled, false)
           end
 
           def option_disabled
-            !options[:disabled].nil?
+            options.fetch(:disabled, false)
           end
 
           def option_publish
-            !options[:publish].nil?
+            options.fetch(:publish, false)
           end
 
           def option_hide
-            !options[:hide].nil?
+            options.fetch(:hide, false)
           end
 
           def service

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

@@ -17,8 +17,8 @@ module ThreeScaleToolbox
               flag        nil, :disabled, 'Disables all methods and metrics in this application plan'
               flag        :p, :publish, 'Publish application plan'
               option      nil, 'approval-required', 'Applications require approval. true or false', argument: :required, transform: ThreeScaleToolbox::Helper::BooleanTransformer.new
-              option      nil, 'cost-per-month', 'Cost per month', argument: :required, transform: method(:Integer)
-              option      nil, 'setup-fee', 'Setup fee', argument: :required, transform: method(:Integer)
+              option      nil, 'cost-per-month', 'Cost per month', argument: :required, transform: method(:Float)
+              option      nil, 'setup-fee', 'Setup fee', argument: :required, transform: method(:Float)
               option      nil, 'trial-period-days', 'Trial period days', argument: :required, transform: method(:Integer)
               option      nil, 'end-user-required', 'End user required. true or false', argument: :required, transform: ThreeScaleToolbox::Helper::BooleanTransformer.new
               param       :remote
@@ -64,15 +64,15 @@ module ThreeScaleToolbox
           end
 
           def option_default
-            !options[:default].nil?
+            options.fetch(:default, false)
           end
 
           def option_disabled
-            !options[:disabled].nil?
+            options.fetch(:disabled, false)
           end
 
           def option_publish
-            !options[:publish].nil?
+            options.fetch(:publish, false)
           end
 
           def service

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

@@ -0,0 +1,22 @@
+require '3scale_toolbox/commands/policy_registry_command/copy_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module PolicyRegistryCommand
+      include ThreeScaleToolbox::Command
+      def self.command
+        Cri::Command.define do
+          name        'policy-registry'
+          usage       'policy-registry <sub-command> [options]'
+          summary     'policy-registry super command'
+          description 'Pôlicy Registry commands'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+      add_subcommand(Copy::CopySubcommand)
+    end
+  end
+end

data/lib/3scale_toolbox/commands/policy_registry_command/copy_command.rb

@@ -0,0 +1,85 @@
+module ThreeScaleToolbox
+  module Commands
+    module PolicyRegistryCommand
+      module Copy
+        class CopySubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'copy'
+              usage       'copy [opts] <source_remote> <target_remote>'
+              summary     'Copy policy registry'
+              description 'Copy policy registry'
+
+              param       :source_remote
+              param       :target_remote
+
+              runner CopySubcommand
+            end
+          end
+
+          def run
+            source_policies = source_remote.list_policy_registry
+            if source_policies.respond_to?(:has_key?) && (errors = source_policies['errors'])
+              raise ThreeScaleToolbox::ThreeScaleApiError.new('Could not list source policy registry', errors)
+            end
+
+            target_policies = target_remote.list_policy_registry
+            if target_policies.respond_to?(:has_key?) && (errors = target_policies['errors'])
+              raise ThreeScaleToolbox::ThreeScaleApiError.new('Could not list target policy registry', errors)
+            end
+
+            # Create missing
+            missing = missing_policies(source_policies, target_policies)
+            missing.each do |policy|
+              new_policy_registry = target_remote.create_policy_registry(policy)
+              if (errors = new_policy_registry['errors'])
+                raise ThreeScaleToolbox::ThreeScaleApiError.new('Could not create target policy registry', errors)
+              end
+            end
+
+            # Update those matching
+            matching = matching_policies(source_policies, target_policies)
+            matching.each do |policy|
+              updated_policy = target_remote.update_policy_registry(
+                "#{policy['name']}-#{policy['version']}", policy
+              )
+              if (errors = updated_policy['errors'])
+                raise ThreeScaleToolbox::ThreeScaleApiError.new('Could not update target policy registry', errors)
+              end
+            end
+
+            puts "Created #{missing.size} missing policies on target tenant"
+            puts "Updated #{matching.size} matching policies on target tenant"
+          end
+
+          private
+
+          def missing_policies(source_policies, target_policies)
+            ThreeScaleToolbox::Helper.array_difference(source_policies,
+                                                       target_policies) do |source, target|
+              ThreeScaleToolbox::Helper.compare_hashes(source, target, %w[name version])
+            end
+          end
+
+          def matching_policies(source_policies, target_policies)
+            source_policies.select do |source|
+              target_policies.find do |target|
+                ThreeScaleToolbox::Helper.compare_hashes(source, target, %w[name version])
+              end
+            end
+          end
+
+          def source_remote
+            @source_remote ||= threescale_client(arguments[:source_remote])
+          end
+
+          def target_remote
+            @target_remote ||= threescale_client(arguments[:target_remote])
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,30 @@
+require 'cri'
+require '3scale_toolbox/base_command'
+require '3scale_toolbox/commands/proxy_config_command/list_command'
+require '3scale_toolbox/commands/proxy_config_command/show_command'
+require '3scale_toolbox/commands/proxy_config_command/promote_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module ProxyConfigCommand
+      include ThreeScaleToolbox::Command
+
+      def self.command
+        Cri::Command.define do
+          name        'proxy-config'
+          usage       'proxy-config <sub-command> [options]'
+          summary     'proxy-config super command'
+          description 'Manage your Proxy Configurations'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+
+      add_subcommand(List::ListSubcommand)
+      add_subcommand(Show::ShowSubcommand)
+      add_subcommand(Promote::PromoteSubcommand)
+    end
+  end
+end