3scale_toolbox 0.13.0 → 0.17.1

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

@@ -33,7 +33,7 @@ module ThreeScaleToolbox
 
           def add_anonymous_access_policy(policies)
             # only on 'open api' security req
-            return unless security.nil?
+            return unless api_spec.security.nil?
 
             return if policies.any? { |policy| policy['name'] == 'default_credentials' }
 
@@ -60,10 +60,13 @@ module ThreeScaleToolbox
 
           def add_rh_sso_keycloak_role_check_policy(policies)
             # only applies to oauth2 sec type
-            return if security.nil? || security.type != 'oauth2'
+            return if api_spec.security.nil? || api_spec.security[:type] != 'oauth2'
 
             return if policies.any? { |policy| policy['name'] == 'keycloak_role_check' }
 
+            # only when there are scopes defined
+            return if api_spec.security[:scopes].empty?
+
             policies << keycloak_policy
           end
 
@@ -76,7 +79,7 @@ module ThreeScaleToolbox
                 scopes: [
                   {
                     realm_roles: [],
-                    client_roles: security.scopes.map { |scope| { 'name': scope } }
+                    client_roles: api_spec.security[:scopes].map { |scope| { 'name': scope } }
                   }
                 ]
               },
@@ -85,7 +88,7 @@ module ThreeScaleToolbox
           end
 
           def add_url_rewritting_policy(policies)
-            return if private_base_path == api_spec.public_base_path
+            return if private_base_path == public_base_path
 
             url_rewritting_policy_idx = policies.find_index do |policy|
               policy['name'] == 'url_rewriting'
@@ -98,10 +101,6 @@ module ThreeScaleToolbox
             end
           end
 
-          def private_base_path
-            override_private_basepath || api_spec.base_path
-          end
-
           def url_rewritting_policy
             regex = url_rewritting_policy_regex
             replace = url_rewritting_policy_replace
@@ -125,11 +124,11 @@ module ThreeScaleToolbox
           end
 
           def url_rewritting_policy_regex
-            "^#{api_spec.public_base_path}"
+            "^#{public_base_path}"
           end
 
           def url_rewritting_policy_replace
-            "#{private_base_path}"
+            private_base_path
           end
         end
       end

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

@@ -27,31 +27,16 @@ module ThreeScaleToolbox
 
           def add_flow_settings(settings)
             # only applies to oauth2 sec type
-            return if security.nil? || security.type != 'oauth2'
+            return if api_spec.security.nil? || api_spec.security[:type] != 'oauth2'
 
             oidc_configuration = {
               standard_flow_enabled: false,
               implicit_flow_enabled: false,
               service_accounts_enabled: false,
               direct_access_grants_enabled: false
-            }.merge(flow => true)
+            }.merge(api_spec.security[:flow] => true)
             settings.merge!(oidc_configuration)
           end
-
-          def flow
-            case (flow_f = security.flow)
-            when 'implicit'
-              :implicit_flow_enabled
-            when 'password'
-              :direct_access_grants_enabled
-            when 'application'
-              :service_accounts_enabled
-            when 'accessCode'
-              :standard_flow_enabled
-            else
-              raise ThreeScaleToolbox::Error, "Unexpected security flow field #{flow_f}"
-            end
-          end
         end
       end
     end

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

@@ -40,29 +40,29 @@ module ThreeScaleToolbox
           end
 
           def add_api_backend_settings(settings)
-            return if private_base_url.nil?
-
-            settings[:api_backend] = private_base_url
+            settings[:api_backend] = private_base_url unless private_base_url.nil?
+            settings[:secret_token] = backend_api_secret_token unless backend_api_secret_token.nil?
+            settings[:hostname_rewrite] = backend_api_host_header unless backend_api_host_header.nil?
           end
 
           def add_security_proxy_settings(settings)
             # nothing to add on proxy settings when no security required in openapi
-            return if security.nil?
+            return if api_spec.security.nil?
 
-            case security.type
+            case (type = api_spec.security[:type])
             when 'oauth2'
               settings[:credentials_location] = 'headers'
               settings[:oidc_issuer_endpoint] = oidc_issuer_endpoint unless oidc_issuer_endpoint.nil?
             when 'apiKey'
               settings[:credentials_location] = credentials_location
-              settings[:auth_user_key] = security.name
+              settings[:auth_user_key] = api_spec.security[:name]
             else
-              raise ThreeScaleToolbox::Error, "Unexpected security scheme type #{security.type}"
+              raise ThreeScaleToolbox::Error, "Unexpected security scheme type #{type}"
             end
           end
 
           def credentials_location
-            case (in_f = security.in_f)
+            case (in_f = api_spec.security[:in_f])
             when 'query'
               'query'
             when 'header'
@@ -73,13 +73,13 @@ module ThreeScaleToolbox
           end
 
           def private_base_url
-              override_private_base_url || private_base_url_from_openapi
+            override_private_base_url || private_base_url_from_openapi
           end
 
           def private_base_url_from_openapi
             return if api_spec.host.nil?
 
-            "#{api_spec.schemes.first || 'https'}://#{api_spec.host}"
+            "#{api_spec.scheme || 'https'}://#{api_spec.host}"
           end
         end
       end

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

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module MethodsCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_disabled, :option_enabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+            @option_enabled = options[:enabled]
+          end
+
+          def print_record(method)
+            output_msg_array = ["Applied method id: #{method['id']}"]
+            output_msg_array << 'Disabled' if option_disabled
+            output_msg_array << 'Enabled' if option_enabled
+            puts output_msg_array.join('; ')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -16,6 +34,8 @@ module ThreeScaleToolbox
               flag        nil, :disabled, 'Disables this method in all application plans'
               flag        nil, :enabled, 'Enables this method in all application plans'
               option      nil, :description, 'Method description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :method_ref
@@ -39,10 +59,7 @@ module ThreeScaleToolbox
             method.disable if option_disabled
             method.enable if option_enabled
 
-            output_msg_array = ["Applied method id: #{method.id}"]
-            output_msg_array << 'Disabled' if option_disabled
-            output_msg_array << 'Enabled' if option_enabled
-            puts output_msg_array.join('; ')
+            printer.print_record method.attrs
           end
 
           private
@@ -94,6 +111,11 @@ module ThreeScaleToolbox
           def method_ref
             arguments[:method_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled, enabled: option_enabled))
+          end
         end
       end
     end

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

@@ -2,6 +2,20 @@ module ThreeScaleToolbox
   module Commands
     module MethodsCommand
       module Create
+        class CustomPrinter
+          attr_reader :option_disabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+          end
+
+          def print_record(method)
+            puts "Created method id: #{method['id']}. Disabled: #{option_disabled}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -15,6 +29,8 @@ module ThreeScaleToolbox
               option      :t, 'system-name', 'Method system name', argument: :required
               flag        nil, :disabled, 'Disables this method in all application plans'
               option      nil, :description, 'Method description', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :method_name
@@ -31,7 +47,8 @@ module ThreeScaleToolbox
               attrs: method_attrs
             )
             method.disable if option_disabled
-            puts "Created method id: #{method.id}. Disabled: #{option_disabled}"
+
+            printer.print_record method.attrs
           end
 
           private
@@ -66,6 +83,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled))
+          end
         end
       end
     end

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

@@ -14,6 +14,7 @@ module ThreeScaleToolbox
               summary     'list methods'
               description 'List methods'
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param       :remote
               param       :service_ref
 
@@ -22,21 +23,17 @@ module ThreeScaleToolbox
           end
 
           def run
-            print_header
-            print_data
+            printer.print_collection service_methods
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
+          def service_methods
+            @service_methods ||= service.methods service_hits_id
           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
+          def service_hits_id
+            @service_hits_id ||= service.hits.fetch('id')
           end
 
           def service
@@ -57,6 +54,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS_TO_SHOW))
+          end
         end
       end
     end

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

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module MetricsCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_disabled, :option_enabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+            @option_enabled = options[:enabled]
+          end
+
+          def print_record(metric)
+            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
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -17,6 +35,8 @@ module ThreeScaleToolbox
               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
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :metric_ref
@@ -38,10 +58,7 @@ module ThreeScaleToolbox
             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('; ')
+            printer.print_record metric.attrs
           end
 
           private
@@ -95,6 +112,11 @@ module ThreeScaleToolbox
           def metric_ref
             arguments[:metric_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled, enabled: option_enabled))
+          end
         end
       end
     end

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

@@ -2,6 +2,20 @@ module ThreeScaleToolbox
   module Commands
     module MetricsCommand
       module Create
+        class CustomPrinter
+          attr_reader :option_disabled
+
+          def initialize(options)
+            @option_disabled = options[:disabled]
+          end
+
+          def print_record(metric)
+            puts "Created metric id: #{metric['id']}. Disabled: #{option_disabled}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -16,6 +30,8 @@ module ThreeScaleToolbox
               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
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :service_ref
               param       :metric_name
@@ -30,7 +46,8 @@ module ThreeScaleToolbox
               attrs: metric_attrs
             )
             metric.disable if option_disabled
-            puts "Created metric id: #{metric.id}. Disabled: #{option_disabled}"
+
+            printer.print_record metric.attrs
           end
 
           private
@@ -70,6 +87,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(disabled: option_disabled))
+          end
         end
       end
     end

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

@@ -14,6 +14,7 @@ module ThreeScaleToolbox
               summary     'list metrics'
               description 'List metrics'
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param       :remote
               param       :service_ref
 
@@ -22,22 +23,11 @@ module ThreeScaleToolbox
           end
 
           def run
-            print_header
-            print_data
+            printer.print_collection service.metrics
           end
 
           private
 
-          def print_header
-            puts FIELDS_TO_SHOW.map(&:upcase).join("\t")
-          end
-
-          def print_data
-            service.metrics.each do |metric|
-              puts FIELDS_TO_SHOW.map { |field| metric.fetch(field, '(empty)') }.join("\t")
-            end
-          end
-
           def service
             @service ||= find_service
           end
@@ -56,6 +46,11 @@ module ThreeScaleToolbox
           def service_ref
             arguments[:service_ref]
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(FIELDS_TO_SHOW))
+          end
         end
       end
     end