3scale_toolbox 0.11.0 → 0.12.2

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

@@ -13,7 +13,14 @@ module ThreeScaleToolbox
             end
 
             existing_operations.each do |op|
-              op.set(:metric_id, service_methods_index.fetch(op.method['system_name']))
+              method_attrs = methods_index.fetch(op.method['system_name'])
+              method = Entities::Method.new(
+                id: method_attrs.fetch('id'),
+                parent_id: hits_metric_id,
+                service: service
+              )
+              method.update(op.method)
+              op.set(:metric_id, method.id)
             end
           end
 
@@ -23,18 +30,18 @@ module ThreeScaleToolbox
             @hits_metric_id ||= service.hits['id']
           end
 
-          def service_methods_index
-            @service_methods_index ||= service.methods(hits_metric_id).each_with_object({}) do |method, acc|
-              acc[method['system_name']] = method['id']
+          def methods_index
+            @methods_index ||= service.methods(hits_metric_id).each_with_object({}) do |method, acc|
+              acc[method['system_name']] = method
             end
           end
 
           def missing_operations
-            operations.reject { |op| service_methods_index.key? op.method['system_name'] }
+            operations.reject { |op| methods_index.key? op.method['system_name'] }
           end
 
           def existing_operations
-            operations.select { |op| service_methods_index.key? op.method['system_name'] }
+            operations.select { |op| methods_index.key? op.method['system_name'] }
           end
         end
       end

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

@@ -6,6 +6,7 @@ module ThreeScaleToolbox
           def method
             {
               'friendly_name' => friendly_name,
+              'description' => description,
               'system_name' => system_name
             }
           end
@@ -21,6 +22,10 @@ module ThreeScaleToolbox
           def operation_id
             "#{operation[:verb]}#{operation[:path].gsub(/[^\w]/, '')}"
           end
+
+          def description
+            String(operation[:description])
+          end
         end
       end
     end

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

@@ -66,6 +66,10 @@ module ThreeScaleToolbox
           def staging_public_base_url
             context[:staging_public_base_url]
           end
+
+          def override_private_base_url
+            context[:override_private_base_url]
+          end
         end
       end
     end

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

@@ -51,7 +51,8 @@ module ThreeScaleToolbox
                 public_base_path: public_base_path,
                 path: op.path,
                 verb: op.verb,
-                operationId: op.operation_id
+                operationId: op.operation_id,
+                description: op.description,
               )
             end
           end

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

@@ -40,12 +40,9 @@ module ThreeScaleToolbox
           end
 
           def add_api_backend_settings(settings)
-            return if api_spec.host.nil?
-
-            scheme = api_spec.schemes.first || 'https'
-            host = api_spec.host
+            return if private_base_url.nil?
 
-            settings[:api_backend] = "#{scheme}://#{host}"
+            settings[:api_backend] = private_base_url
           end
 
           def add_security_proxy_settings(settings)
@@ -74,6 +71,16 @@ module ThreeScaleToolbox
               raise ThreeScaleToolbox::Error, "Unexpected security in_f field #{in_f}"
             end
           end
+
+          def private_base_url
+              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}"
+          end
         end
       end
     end

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

@@ -33,18 +33,11 @@ module ThreeScaleToolbox
           end
 
           def print_data
-            metrics.each do |metric|
+            service.metrics.each do |metric|
               puts FIELDS_TO_SHOW.map { |field| metric.fetch(field, '(empty)') }.join("\t")
             end
           end
 
-          def metrics
-            hits_id = service.hits['id']
-            ThreeScaleToolbox::Helper.array_difference(service.metrics, service.methods(hits_id)) do |metric, method|
-              ThreeScaleToolbox::Helper.compare_hashes(metric, method, %w[id])
-            end
-          end
-
           def service
             @service ||= find_service
           end

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

@@ -22,7 +22,6 @@ module ThreeScaleToolbox
               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
               param       :service_ref
               param       :plan_ref
@@ -38,7 +37,7 @@ module ThreeScaleToolbox
               plan = Entities::ApplicationPlan.create(service: service,
                                                       plan_attrs: create_plan_attrs)
             else
-              plan.update(plan_attrs) unless plan_attrs.empty?
+              plan.update(new_plan_attrs) unless new_plan_attrs.empty?
             end
 
             plan.make_default if option_default
@@ -65,12 +64,15 @@ module ThreeScaleToolbox
           end
 
           def create_plan_attrs
-            plan_attrs.merge('system_name' => plan_ref,
-                             'name' => plan_ref) { |_key, oldval, _newval| oldval }
+            new_attrs = plan_basic_attrs.merge('name' => plan_ref) { |_key, oldval, _newval| oldval }
+            new_attrs.tap do |params|
+              params['system_name'] = plan_ref
+              params['state'] = 'published' if option_publish
+            end
           end
 
-          def plan_attrs
-            plan_basic_attrs.tap do |params|
+          def new_plan_attrs
+            plan_basic_attrs.clone.tap do |params|
               params['state'] = 'published' if option_publish
               params['state'] = 'hidden' if option_hide
             end
@@ -80,7 +82,6 @@ module ThreeScaleToolbox
             {
               'name' => options[:name],
               'approval_required' => options[:'approval-required'],
-              'end_user_required' => options[:'end-user-required'],
               'cost_per_month' => options[:'cost-per-month'],
               'setup_fee' => options[:'setup-fee'],
               'trial_period_days' => options[:'trial-period-days']

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

@@ -20,7 +20,6 @@ module ThreeScaleToolbox
               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
               param       :service_ref
               param       :plan_name
@@ -56,7 +55,6 @@ module ThreeScaleToolbox
               'name' => arguments[:plan_name],
               'system_name' => options[:'system-name'],
               'approval_required' => options[:'approval-required'],
-              'end_user_required' => options[:'end-user-required'],
               'cost_per_month' => options[:'cost-per-month'],
               'setup_fee' => options[:'setup-fee'],
               'trial_period_days' => options[:'trial-period-days']

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_methods_step.rb

@@ -26,8 +26,6 @@ module ThreeScaleToolbox
           end
 
           def filtered_limit_methods
-            # has to be filtered this way
-            # looking up in metrics list does not work. Metric list includes methods and metrics
             result[:limits].select { |limit| limit.dig('metric', 'type') == 'method' }
           end
 
@@ -40,7 +38,6 @@ module ThreeScaleToolbox
           end
 
           def filtered_pricing_rule_methods
-            # looking up in metrics list does not work. Metric list includes methods and metrics
             result[:pricingrules].select { |limit| limit.dig('metric', 'type') == 'method' }
           end
         end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_metrics_step.rb

@@ -26,7 +26,6 @@ module ThreeScaleToolbox
           end
 
           def filtered_limit_metrics
-            # looking up in metrics list does not work. Metric list includes methods and metrics
             result[:limits].select { |limit| limit.dig('metric', 'type') == 'metric' }
           end
 
@@ -39,7 +38,6 @@ module ThreeScaleToolbox
           end
 
           def filtered_pricing_rule_metrics
-            # looking up in metrics list does not work. Metric list includes methods and metrics
             result[:pricingrules].select { |limit| limit.dig('metric', 'type') == 'metric' }
           end
         end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_pricing_rules_step.rb

@@ -9,7 +9,8 @@ module ThreeScaleToolbox
           # add metric system_name out of metric_id
           def call
             result[:pricingrules] = plan.pricing_rules.map do |pr|
-              pr.tap { |e| e['metric'] = metric_info(e, 'PricingRule') }
+              pr.merge('metric' => metric_info(pr, 'PricingRule'),
+                       'cost_per_unit' => pr.fetch('cost_per_unit').to_f)
             end
           end
         end

data/lib/3scale_toolbox/commands/plans_command/export/step.rb

@@ -54,8 +54,6 @@ module ThreeScaleToolbox
           end
 
           def metric_info(elem, elem_name)
-            # Methods are included in metrics.
-            # First methods must be checked, otherwise it could be considered as a false metric
             if (method = find_method(elem.fetch('metric_id')))
               { 'type' => 'method', 'system_name' => method.fetch('system_name') }
             elsif (metric = find_metric(elem.fetch('metric_id')))

data/lib/3scale_toolbox/commands/plans_command/import/create_or_update_app_plan_step.rb

@@ -9,10 +9,11 @@ module ThreeScaleToolbox
           def call
             plan_obj = Entities::ApplicationPlan.find(service: service, ref: plan_system_name)
             if plan_obj.nil?
-              plan_obj = Entities::ApplicationPlan.create(service: service, plan_attrs: plan_attrs)
+              plan_obj = Entities::ApplicationPlan.create(service: service,
+                                                          plan_attrs: create_plan_attrs)
               puts "Application plan created: #{plan_obj.id}"
             else
-              res = plan_obj.update(plan_attrs)
+              res = plan_obj.update(update_plan_attrs)
               if (errors = res['errors'])
                 raise ThreeScaleToolbox::Error, "Could not update application plan #{plan_system_name}. Errors: #{errors}"
               end
@@ -23,9 +24,13 @@ module ThreeScaleToolbox
 
           private
 
-          def plan_attrs
+          def create_plan_attrs
             resource_plan.merge('system_name' => plan_system_name)
           end
+
+          def update_plan_attrs
+            resource_plan.reject { |key, _| %w[system_name].include? key }
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/plans_command/import/import_plan_metrics_step.rb

@@ -18,9 +18,6 @@ module ThreeScaleToolbox
           private
 
           def missing_metrics
-            # service metrics list includes methods
-            # this array_difference method computes elements in resource_metrics not included in service_metrics
-            # So methods will not be in the "missing_metrics" list, as long as array diff semantics are kept.
             ThreeScaleToolbox::Helper.array_difference(resource_metrics, service_metrics) do |a, b|
               ThreeScaleToolbox::Helper.compare_hashes(a, b, ['system_name'])
             end

data/lib/3scale_toolbox/commands/plans_command/import/import_plan_pricing_rules_step.rb

@@ -21,15 +21,22 @@ module ThreeScaleToolbox
           private
 
           def missing_pricing_rules
-            ThreeScaleToolbox::Helper.array_difference(resource_pr_processed, plan.pricing_rules) do |a, b|
+            ThreeScaleToolbox::Helper.array_difference(resource_pr_processed, remote_pr_processed) do |a, b|
               ThreeScaleToolbox::Helper.compare_hashes(a, b, %w[metric_id cost_per_unit min max])
             end
           end
 
+          def remote_pr_processed
+            plan.pricing_rules.map do |pr|
+              pr.merge('cost_per_unit' => pr.fetch('cost_per_unit').to_f)
+            end
+          end
+
           def resource_pr_processed
             resource_pricing_rules.map do |pr|
               metric = find_metric_by_system_name(pr.delete('metric_system_name'))
-              pr.merge('metric_id' => metric.fetch('id'))
+              pr.merge('metric_id' => metric.fetch('id'),
+                       'cost_per_unit' => pr.fetch('cost_per_unit').to_f)
             end
           end
         end

data/lib/3scale_toolbox/commands/plans_command/import/step.rb

@@ -81,6 +81,10 @@ module ThreeScaleToolbox
             context[:service_methods] ||= service.methods(service_hits['id'])
           end
 
+          def service_metrics_and_methods
+            service_metrics + service_methods
+          end
+
           def invalidate_service_methods
             context[:service_methods] = nil
           end
@@ -99,7 +103,7 @@ module ThreeScaleToolbox
           end
 
           def find_metric_by_system_name(system_name)
-            service_metrics.find { |metric| metric['system_name'] == system_name }
+            service_metrics_and_methods.find { |metric| metric['system_name'] == system_name }
           end
 
           private

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

@@ -19,8 +19,12 @@ module ThreeScaleToolbox
           end
 
           def run
-            latest_proxy_config.promote(to: to_env)
-            puts "Proxy Configuration promoted to '#{to_env}'"
+            if promotable?
+              latest_proxy_config_from.promote(to: to_env)
+              puts "Proxy Configuration version #{latest_proxy_config_from.version} promoted to '#{to_env}'"
+            else
+              warn "warning: Nothing to promote. Proxy Configuration version #{latest_proxy_config_from.version} already promoted to production"
+            end
           end
 
           private
@@ -29,16 +33,28 @@ module ThreeScaleToolbox
             @remote ||= threescale_client(arguments[:remote])
           end
 
-          def latest_proxy_config
-            @proxy_config ||= find_proxy_config_latest
+          def latest_proxy_config_from
+            @proxy_config_from ||= find_proxy_config_latest_from
+          end
+
+          def latest_proxy_config_to
+            @proxy_config_to ||= find_proxy_config_latest_to
           end
 
-          def find_proxy_config_latest
+          def promotable?
+            return latest_proxy_config_to.nil? || latest_proxy_config_from.version != latest_proxy_config_to.version
+          end
+
+          def find_proxy_config_latest_from
             Entities::ProxyConfig.find_latest(service: service, environment: from_env).tap do |pc|
               raise ThreeScaleToolbox::Error, "ProxyConfig #{from_env} in service #{service.id} does not exist" if pc.nil?
             end
           end
 
+          def find_proxy_config_latest_to
+            Entities::ProxyConfig.find_latest(service: service, environment: to_env)
+          end
+
           def service_ref
             arguments[:service_ref]
           end

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

@@ -20,15 +20,55 @@ module ThreeScaleToolbox
           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)
+        # ref can be
+        # * Email of the account user.
+        # * Username of the account user.
+        # * ID of the account user.
+        # * [Master API] Provider key of the account
+        # * [Master API] Service token of the account service.
+        #
+        # email, username or user_id fields search with AND logic. Therefore separate requests.
+        # buyer_provider_key, buyer_service_token fields search with OR logic. Same request.
+        def find_by_text(ref, remote)
+          account = find_by_email(remote, ref)
+          return account unless account.nil?
+
+          account = find_by_username(remote, ref)
+          return account unless account.nil?
+
+          account = find_by_user_id(remote, ref)
+          return account unless account.nil?
+
+          account = find_by_provider_or_service_token(remote, ref)
+          return account unless account.nil?
+
+          nil
+        end
+
+        def find_by_email(remote, email)
+          generic_find(remote, email: email)
+        end
+
+        def find_by_username(remote, username)
+          generic_find(remote, username: username)
+        end
+
+        def find_by_user_id(remote, user_id)
+          generic_find(remote, user_id: user_id)
+        end
+
+        def find_by_provider_or_service_token(remote, text)
+          generic_find(remote, buyer_provider_key: text, buyer_service_token: text)
+        end
+
+        def generic_find(remote, criteria)
+          account = remote.find_account(criteria)
           if (errors = account['errors'])
             raise ThreeScaleToolbox::ThreeScaleApiError.new(
               'Account find returned errors', errors
             )
           end
-          new(id: account['id'], remote: client, attrs: account)
+          new(id: account['id'], remote: remote, attrs: account)
         rescue ThreeScale::API::HttpClient::NotFoundError
           nil
         end