3scale_toolbox 0.19.2 → 0.19.3

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

@@ -3,6 +3,8 @@ module ThreeScaleToolbox
     class Limit
       include CRD::Limit
 
+      LIMITS_BLACKLIST = %w[id metric_id plan_id links created_at updated_at].freeze
+
       class << self
         def create(plan:, metric_id:, attrs:)
           resp_attrs = plan.remote.create_application_plan_limit plan.id, metric_id, attrs
@@ -37,7 +39,7 @@ module ThreeScaleToolbox
       end
 
       def metric_link
-        links.find { |link| link['rel'] == 'metric' }
+        links.find { |link| link['rel'] == 'metric' } || {}
       end
 
       def update(new_limit_attrs)
@@ -56,15 +58,58 @@ module ThreeScaleToolbox
         remote.delete_application_plan_limit plan.id, metric_id, id
       end
 
+      def product_metric
+        plan.service.metrics.find { |m| m.id == metric_id }
+      end
+
+      def product_method
+        plan.service.methods.find { |m| m.id == metric_id }
+      end
+
+      def backend_metric
+        if (backend = backend_from_metric_link)
+          return backend.metrics.find { |m| m.id == metric_id }
+        end
+      end
+
+      def backend_method
+        if (backend = backend_from_metric_link)
+          return backend.methods.find { |m| m.id == metric_id }
+        end
+      end
+
+      def to_hash
+        extra_attrs = {}
+
+        if (metric = product_metric)
+          extra_attrs['metric_system_name'] = metric.system_name
+        elsif (method = product_method)
+          extra_attrs['metric_system_name'] = method.system_name
+        elsif (metric = backend_metric)
+          extra_attrs['metric_system_name'] = metric.system_name
+          extra_attrs['metric_backend_system_name'] = metric.backend.system_name
+        elsif (method = backend_method)
+          extra_attrs['metric_system_name'] = method.system_name
+          extra_attrs['metric_backend_system_name'] = method.backend.system_name
+        else
+          raise_metric_not_found
+        end
+
+        attrs.merge(extra_attrs).reject { |key, _| LIMITS_BLACKLIST.include? key }
+      end
+
       private
 
-      # Used by CRD::Limit
-      # Returns the backend hosting the metric
-      def backend_from_metric
-        backend_id = Helper.backend_metric_link_parser(metric_link['href'] || '')
-        return if backend_id.nil?
+      def raise_metric_not_found
+        raise ThreeScaleToolbox::Error, "Unexpected error. Limit #{id} " \
+          "referencing to metric id #{metric_id} which has not been found"
+      end
 
-        Backend.new(id: backend_id.to_i, remote: remote)
+      # Returns the backend hosting the metric
+      def backend_from_metric_link
+        if (backend_id = Helper.backend_metric_link_parser(metric_link['href'] || ''))
+          return Backend.new(id: backend_id.to_i, remote: remote)
+        end
       end
     end
   end

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

@@ -3,6 +3,8 @@ module ThreeScaleToolbox
     class Method
       include CRD::MethodSerializer
 
+      METHOD_BLACKLIST = %w[id links created_at updated_at parent_id].freeze
+
       class << self
         def create(service:, attrs:)
           method_attrs = service.remote.create_method service.id, service.hits.id, attrs
@@ -74,6 +76,15 @@ module ThreeScaleToolbox
         remote.delete_method service.id, hits_id, id
       end
 
+      # enriched_key returns a metric key that will be unique for all
+      # metrics/methods from products and backends
+      def enriched_key
+        "product.#{service.id}.#{id}"
+      end
+
+      def to_hash
+        attrs.reject { |key, _| METHOD_BLACKLIST.include? key }
+      end
 
       private
 

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

@@ -3,6 +3,8 @@ module ThreeScaleToolbox
     class Metric
       include CRD::MetricSerializer
 
+      METRIC_BLACKLIST = %w[id links created_at updated_at].freeze
+
       class << self
         def create(service:, attrs:)
           metric = service.remote.create_metric service.id, attrs
@@ -92,6 +94,16 @@ module ThreeScaleToolbox
         remote.delete_metric service.id, id
       end
 
+      # enriched_key returns a metric key that will be unique for all
+      # metrics from products and backends
+      def enriched_key
+        "product.#{service.id}.#{id}"
+      end
+
+      def to_hash
+        attrs.reject { |key, _| METRIC_BLACKLIST.include? key }
+      end
+
       private
 
       def metric_attrs

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

@@ -3,6 +3,8 @@ module ThreeScaleToolbox
     class PricingRule
       include CRD::PricingRuleSerializer
 
+      PRICINGRULES_BLACKLIST = %w[id metric_id plan_id links created_at updated_at].freeze
+
       class << self
         def create(plan:, metric_id:, attrs:)
           resp_attrs = plan.remote.create_pricingrule plan.id, metric_id, attrs
@@ -41,22 +43,65 @@ module ThreeScaleToolbox
       end
 
       def metric_link
-        links.find { |link| link['rel'] == 'metric' }
+        links.find { |link| link['rel'] == 'metric' } || {}
       end
 
       def delete
         remote.delete_application_plan_pricingrule plan.id, metric_id, id
       end
 
+      def product_metric
+        plan.service.metrics.find { |m| m.id == metric_id }
+      end
+
+      def product_method
+        plan.service.methods.find { |m| m.id == metric_id }
+      end
+
+      def backend_metric
+        if (backend = backend_from_metric_link)
+          return backend.metrics.find { |m| m.id == metric_id }
+        end
+      end
+
+      def backend_method
+        if (backend = backend_from_metric_link)
+          return backend.methods.find { |m| m.id == metric_id }
+        end
+      end
+
+      def to_hash
+        extra_attrs = {}
+
+        if (metric = product_metric)
+          extra_attrs['metric_system_name'] = metric.system_name
+        elsif (method = product_method)
+          extra_attrs['metric_system_name'] = method.system_name
+        elsif (metric = backend_metric)
+          extra_attrs['metric_system_name'] = metric.system_name
+          extra_attrs['metric_backend_system_name'] = metric.backend.system_name
+        elsif (method = backend_method)
+          extra_attrs['metric_system_name'] = method.system_name
+          extra_attrs['metric_backend_system_name'] = method.backend.system_name
+        else
+          raise_method_not_found
+        end
+
+        attrs.merge(extra_attrs).reject { |key, _| PRICINGRULES_BLACKLIST.include? key }
+      end
+
       private
 
-      # Used by CRD::PricingRule
-      # Returns the backend hosting the metric
-      def backend_from_metric
-        backend_id = Helper.backend_metric_link_parser(metric_link['href'] || '')
-        return if backend_id.nil?
+      def raise_method_not_found
+        raise ThreeScaleToolbox::Error, "Unexpected error. Pricing Rule #{id} " \
+          "referencing to metric id #{metric_id} which has not been found"
+      end
 
-        Backend.new(id: backend_id.to_i, remote: remote)
+      # Returns the backend hosting the metric
+      def backend_from_metric_link
+        if (backend_id = Helper.backend_metric_link_parser(metric_link['href'] || ''))
+          return Backend.new(id: backend_id.to_i, remote: remote)
+        end
       end
     end
   end

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

@@ -367,6 +367,10 @@ module ThreeScaleToolbox
         remote.http_client.endpoint == other.remote.http_client.endpoint && id == other.id
       end
 
+      def find_metric_or_method(system_name)
+        (metrics + methods).find { |m| m.system_name == system_name }
+      end
+
       private
 
       def fetch_attrs

data/lib/3scale_toolbox/remote_cache.rb

@@ -1,7 +1,10 @@
 module ThreeScaleToolbox
   class RemoteCache < BasicObject
 
-    attr_reader :metrics_cache, :methods_cache, :backend_metrics_cache, :backend_methods_cache, :subject
+    attr_reader :metrics_cache, :methods_cache,
+      :backend_metrics_cache, :backend_methods_cache,
+      :backends_cache,
+      :subject
 
     def initialize(subject)
       @subject = subject
@@ -13,6 +16,8 @@ module ThreeScaleToolbox
       @backend_metrics_cache = {}
       # Backend methods cache data
       @backend_methods_cache = {}
+      # Backends cache data
+      @backends_cache = {}
     end
 
     def list_metrics(service_id)
@@ -136,6 +141,42 @@ module ThreeScaleToolbox
       end
     end
 
+    def list_backends(params = nil)
+      return backends_cache[params] if backends_cache.has_key? params
+
+      subject.list_backends(params).tap do |backends|
+        backends_cache[params] = backends unless backends.respond_to?(:has_key?) && !backends['errors'].nil?
+      end
+    end
+
+    def create_backend(attributes)
+      subject.create_backend(attributes).tap do |backend_attrs|
+        backends_cache.clear unless backend_attrs.respond_to?(:has_key?) && !backend_attrs['errors'].nil?
+      end
+    end
+
+    def update_backend(id, attributes)
+      subject.update_backend(id, attributes).tap do |backend_attrs|
+        backends_cache.clear unless backend_attrs.respond_to?(:has_key?) && !backend_attrs['errors'].nil?
+      end
+    end
+
+    def delete_backend(id)
+      subject.delete_backend(id).tap do |resp| 
+        backends_cache.clear unless resp.respond_to?(:has_key?) && !resp['errors'].nil?
+      end
+    end
+
+    def backend(id)
+      # if exist in the cache, return it.
+      # But if not, it is not populated because cache is paginated and page is unknown.
+      if (backend_attrs = backends_cache.values.reduce([], :concat).find { |attrs| attrs['id'] == id })
+        return backend_attrs
+      end
+
+      subject.backend(id)
+    end
+
     ###
     # Generic methods
     ###

data/lib/3scale_toolbox/version.rb

@@ -1,3 +1,3 @@
 module ThreeScaleToolbox
-  VERSION = '0.19.2'
+  VERSION = '0.19.3'
 end

data/licenses.xml

@@ -13,7 +13,7 @@
       </dependency>
           <dependency>
         <packageName>3scale_toolbox</packageName>
-        <version>0.19.2</version>
+        <version>0.19.3</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -261,7 +261,7 @@
       </dependency>
           <dependency>
         <packageName>nokogiri</packageName>
-        <version>1.12.4</version>
+        <version>1.12.5</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -311,7 +311,7 @@
       </dependency>
           <dependency>
         <packageName>racc</packageName>
-        <version>1.5.2</version>
+        <version>1.6.0</version>
         <licenses>
                       <license>
               <name>ruby</name>
@@ -509,7 +509,7 @@
       </dependency>
           <dependency>
         <packageName>zeitwerk</packageName>
-        <version>2.4.2</version>
+        <version>2.5.1</version>
         <licenses>
                       <license>
               <name>MIT</name>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.19.2
+  version: 0.19.3
 platform: ruby
 authors:
 - Miguel Soriano
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-09-16 00:00:00.000000000 Z
+date: 2021-10-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -218,21 +218,15 @@ files:
 - lib/3scale_toolbox/commands/plans_command/apply_command.rb
 - lib/3scale_toolbox/commands/plans_command/create_command.rb
 - lib/3scale_toolbox/commands/plans_command/delete_command.rb
-- lib/3scale_toolbox/commands/plans_command/export/read_app_plan_step.rb
-- lib/3scale_toolbox/commands/plans_command/export/read_plan_features_step.rb
-- lib/3scale_toolbox/commands/plans_command/export/read_plan_limits_step.rb
-- lib/3scale_toolbox/commands/plans_command/export/read_plan_methods_step.rb
-- lib/3scale_toolbox/commands/plans_command/export/read_plan_metrics_step.rb
-- lib/3scale_toolbox/commands/plans_command/export/read_plan_pricing_rules_step.rb
-- lib/3scale_toolbox/commands/plans_command/export/step.rb
-- lib/3scale_toolbox/commands/plans_command/export/write_artifacts_file_step.rb
 - lib/3scale_toolbox/commands/plans_command/export_command.rb
 - lib/3scale_toolbox/commands/plans_command/import/create_or_update_app_plan_step.rb
+- lib/3scale_toolbox/commands/plans_command/import/import_backend_metrics_step.rb
 - lib/3scale_toolbox/commands/plans_command/import/import_plan_features_step.rb
 - lib/3scale_toolbox/commands/plans_command/import/import_plan_limits_step.rb
 - lib/3scale_toolbox/commands/plans_command/import/import_plan_metrics_step.rb
 - lib/3scale_toolbox/commands/plans_command/import/import_plan_pricing_rules_step.rb
 - lib/3scale_toolbox/commands/plans_command/import/step.rb
+- lib/3scale_toolbox/commands/plans_command/import/validate_plan_step.rb
 - 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

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

@@ -1,16 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module PlansCommand
-      module Export
-        class ReadAppPlanStep
-          include Step
-          ##
-          # Reads Application plan
-          def call
-            result[:plan] = plan.attrs
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,16 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module PlansCommand
-      module Export
-        class ReadPlanFeaturesStep
-          include Step
-          ##
-          # Reads Application Plan features
-          def call
-            result[:plan_features] = plan.features
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module PlansCommand
-      module Export
-        class ReadPlanLimitsStep
-          include Step
-          ##
-          # Reads Application Plan limits
-          # add metric system_name out of metric_id
-          def call
-            result[:limits] = plan.limits.map do |limit|
-              limit.attrs.merge('metric' => metric_info(limit, 'Limit'))
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module PlansCommand
-      module Export
-        class ReadPlanMethods
-          include Step
-          ##
-          # Compute unique list of methods from limits and pricingrules
-          def call
-            methods = [
-              limit_methods,
-              pricingrule_methods
-            ]
-            result[:plan_methods] = methods.each_with_object({}) { |elem, acc| acc.merge!(elem) }
-          end
-
-          private
-
-          def limit_methods
-            # multiple limits can reference the same method
-            filtered_limit_methods.each_with_object({}) do |elem, acc|
-              # find_method should not return nil.
-              # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_method(elem['metric_id']).attrs
-            end
-          end
-
-          def filtered_limit_methods
-            result[:limits].select { |limit| limit.dig('metric', 'type') == 'method' }
-          end
-
-          def pricingrule_methods
-            filtered_pricing_rule_methods.each_with_object({}) do |elem, acc|
-              # find_method should not return nil.
-              # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_method(elem['metric_id']).attrs
-            end
-          end
-
-          def filtered_pricing_rule_methods
-            result[:pricingrules].select { |limit| limit.dig('metric', 'type') == 'method' }
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,47 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module PlansCommand
-      module Export
-        class ReadPlanMetrics
-          include Step
-          ##
-          # Compute unique list of metrics limits and pricingrules
-          def call
-            all_metrics = [
-              limit_metrics,
-              pricingrule_metrics
-            ]
-            result[:plan_metrics] = all_metrics.each_with_object({}) { |elem, acc| acc.merge!(elem) }
-          end
-
-          private
-
-          def limit_metrics
-            # multiple limits can reference the same metric
-            filtered_limit_metrics.each_with_object({}) do |elem, acc|
-              # find_metric should not return nil.
-              # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_metric(elem['metric_id']).attrs
-            end
-          end
-
-          def filtered_limit_metrics
-            result[:limits].select { |limit| limit.dig('metric', 'type') == 'metric' }
-          end
-
-          def pricingrule_metrics
-            filtered_pricing_rule_metrics.each_with_object({}) do |elem, acc|
-              # find_metric should not return nil.
-              # It is assumed that metric_id refers to existing element from previous steps
-              acc[elem['metric_id']] = find_metric(elem['metric_id']).attrs
-            end
-          end
-
-          def filtered_pricing_rule_metrics
-            result[:pricingrules].select { |limit| limit.dig('metric', 'type') == 'metric' }
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,19 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module PlansCommand
-      module Export
-        class ReadPlanPricingRulesStep
-          include Step
-          ##
-          # Reads Application Plan pricing rules
-          # add metric system_name out of metric_id
-          def call
-            result[:pricingrules] = plan.pricing_rules.map do |pr|
-              pr.attrs.merge('metric' => metric_info(pr, 'PricingRule'), 'cost_per_unit' => pr.cost_per_unit.to_f)
-            end
-          end
-        end
-      end
-    end
-  end
-end

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

@@ -1,85 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module PlansCommand
-      module Export
-        APP_PLANS_BLACKLIST = %w[id links default custom created_at updated_at].freeze
-        LIMITS_BLACKLIST = %w[id metric_id links created_at updated_at].freeze
-        PRICINGRULES_BLACKLIST = %w[id metric_id links created_at updated_at].freeze
-        PLAN_FEATURE_BLACKLIST = %w[id links created_at updated_at].freeze
-        METRIC_BLACKLIST = %w[id links created_at updated_at].freeze
-
-        module Step
-          attr_reader :context
-
-          def initialize(context)
-            @context = context
-          end
-
-          def service
-            context[:service] ||= find_service
-          end
-
-          def file
-            context[:file]
-          end
-
-          def threescale_client
-            context[:threescale_client]
-          end
-
-          # can be id or system_name
-          def service_system_name
-            context[:service_system_name]
-          end
-
-          # can be id or system_name
-          def plan_system_name
-            context[:plan_system_name]
-          end
-
-          def result
-            context[:result] ||= {}
-          end
-
-          def plan
-            context[:plan] ||= find_plan
-          end
-
-          def metric_info(elem, elem_name)
-            if (method = find_method(elem.metric_id))
-              { 'type' => 'method', 'system_name' => method.system_name }
-            elsif (metric = find_metric(elem.metric_id))
-              { 'type' => 'metric', 'system_name' => metric.system_name }
-            else
-              raise ThreeScaleToolbox::Error, "Unexpected error. #{elem_name} #{elem.id} " \
-                "referencing to metric id #{elem.metric_id} which has not been found"
-            end
-          end
-
-          private
-
-          def find_service
-            Entities::Service.find(remote: threescale_client,
-                                   ref: service_system_name).tap do |svc|
-              raise ThreeScaleToolbox::Error, "Service #{service_system_name} does not exist" if svc.nil?
-            end
-          end
-
-          def find_plan
-            Entities::ApplicationPlan.find(service: service, ref: plan_system_name).tap do |p|
-              raise ThreeScaleToolbox::Error, "Application plan #{plan_system_name} does not exist" if p.nil?
-            end
-          end
-
-          def find_metric(id)
-            service.metrics.find { |metric| metric.id == id }
-          end
-
-          def find_method(id)
-            service.methods.find { |method| method.id == id }
-          end
-        end
-      end
-    end
-  end
-end