3scale_toolbox 0.18.3 → 0.19.3

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

@@ -14,13 +14,13 @@ module ThreeScaleToolbox
             summary     'Copy product'
             description <<-HEREDOC
             This command makes a copy of the referenced product.
-            Target product will be searched by source product system name. System name can be overriden with `--target-system-name` option.
+            Target product will be searched by the source product system name. System name can be overridden with `--target-system-name` option.
             If a product with the selected `system_name` is not found, it will be created.
             \n Components of the product being copied:
             \nproduct configuration
             \nproduct settings
             \nproduct methods&metrics: Only missing metrics&methods will be created.
-            \nproduct mapping rules: Only missing mapping rules will be created.
+            \nproduct mapping rules: mapping rules will be replaced. Existing mapping rules will be removed.
             \nproduct application plans & pricing rules & limits: Only missing application plans & pricing rules & limits will be created.
             \nproduct application usage rules
             \nproduct policies
@@ -73,6 +73,7 @@ module ThreeScaleToolbox
             source_remote: threescale_client(fetch_required_option(:source)),
             target_remote: threescale_client(fetch_required_option(:destination)),
             source_service_ref: arguments[:source_product],
+            delete_mapping_rules: true,
             option_target_system_name: options[:'target-system-name']
           }
         end

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

@@ -28,6 +28,7 @@ module ThreeScaleToolbox
                 target_remote: remote,
                 source_remote: crd_remote,
                 source_service_ref: product.system_name,
+                delete_mapping_rules: true,
                 logger: Logger.new(File::NULL)
             }
 

data/lib/3scale_toolbox/crds/limit_dump.rb

@@ -18,7 +18,7 @@ module ThreeScaleToolbox
           { 'systemName' => method.system_name }
         elsif (metric = plan.service.metrics.find { |m| m.id == metric_id })
           { 'systemName' => metric.system_name }
-        elsif (backend = backend_from_metric)
+        elsif (backend = backend_from_metric_link)
           if (backend_metric = backend.metrics.find { |m| m.id == metric_id })
             { 'systemName' => backend_metric.system_name, 'backend' => backend.system_name }
           elsif (backend_method = backend.methods.find { |m| m.id == metric_id })

data/lib/3scale_toolbox/crds/pricing_rule_dump.rb

@@ -19,7 +19,7 @@ module ThreeScaleToolbox
           { 'systemName' => method.system_name }
         elsif (metric = plan.service.metrics.find { |m| m.id == metric_id })
           { 'systemName' => metric.system_name }
-        elsif (backend = backend_from_metric)
+        elsif (backend = backend_from_metric_link)
           if (backend_metric = backend.metrics.find { |m| m.id == metric_id })
             { 'systemName' => backend_metric.system_name, 'backend' => backend.system_name }
           elsif (backend_method = backend.methods.find { |m| m.id == metric_id })

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

@@ -3,6 +3,9 @@ module ThreeScaleToolbox
     class ApplicationPlan
       include CRD::ApplicationPlanSerializer
 
+      APP_PLANS_BLACKLIST = %w[id links default custom created_at updated_at].freeze
+      PLAN_FEATURE_BLACKLIST = %w[id links created_at updated_at].freeze
+
       class << self
         def create(service:, plan_attrs:)
           plan = service.remote.create_application_plan service.id, create_plan_attrs(plan_attrs)
@@ -209,8 +212,69 @@ module ThreeScaleToolbox
         attrs.fetch('cost_per_month', 0.0)
       end
 
+      def to_hash
+        {
+          'plan' => attrs.reject { |key, _| APP_PLANS_BLACKLIST.include? key },
+          'limits' => limits.map(&:to_hash),
+          'pricingrules' => pricing_rules.map(&:to_hash),
+          'plan_features' => features.map do |feature|
+              feature.reject { |key, _| PLAN_FEATURE_BLACKLIST.include? key }
+          end,
+          'metrics' => uniq_metrics_to_hash,
+          'methods' => uniq_methods_to_hash,
+        }
+      end
+
       private
 
+      def uniq_metrics_to_hash
+        limit_metrics = limits.flat_map do |limit|
+          # one of them (or both) could be nil
+          [
+            limit.product_metric, limit.backend_metric
+          ]
+        end.compact
+
+        pr_metrics = pricing_rules.flat_map do |pr|
+          # one of them (or both) could be nil
+          [
+            pr.product_metric, pr.backend_metric
+          ]
+        end.compact
+
+        # multiple limits can reference the same metric
+        # multiple pricing rules can reference the same metric
+        uniq_metrics = limit_metrics.concat(pr_metrics).each_with_object({}) do |metric, acc|
+          acc[metric.enriched_key] = metric
+        end.values
+
+        uniq_metrics.map { |metric| metric.to_hash }
+      end
+
+      def uniq_methods_to_hash
+        limit_methods = limits.flat_map do |limit|
+          # one of them (or both) could be nil
+          [
+            limit.product_method, limit.backend_method
+          ]
+        end.compact
+
+        pr_methods = pricing_rules.flat_map do |pr|
+          # one of them (or both) could be nil
+          [
+            pr.product_method, pr.backend_method
+          ]
+        end.compact
+
+        # multiple limits can reference the same method
+        # multiple pricing rules can reference the same method
+        uniq_methods = limit_methods.concat(pr_methods).each_with_object({}) do |method, acc|
+          acc[method.enriched_key] = method
+        end.values
+
+        uniq_methods.map { |method| method.to_hash }
+      end
+
       def read_plan_attrs
         raise ThreeScaleToolbox::InvalidIdError if id.zero?
 

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

@@ -161,6 +161,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 metrics_and_methods

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

@@ -6,6 +6,8 @@ module ThreeScaleToolbox
       VALID_PARAMS = %w[friendly_name system_name description].freeze
       public_constant :VALID_PARAMS
 
+      METHOD_BLACKLIST = %w[id links created_at updated_at parent_id].freeze
+
       class << self
         def create(backend:, attrs:)
           method = backend.remote.create_backend_method(backend.id, backend.hits.id,
@@ -71,6 +73,20 @@ module ThreeScaleToolbox
         remote.delete_backend_method backend.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
+        "backend.#{backend.id}.#{id}"
+      end
+
+      def to_hash
+        extra_attrs = {
+          'backend_system_name' => backend.system_name
+        }
+
+        attrs.merge(extra_attrs).reject { |key, _| METHOD_BLACKLIST.include? key }
+      end
+
       private
 
       def hits_id

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

@@ -6,6 +6,8 @@ module ThreeScaleToolbox
       VALID_PARAMS = %w[friendly_name system_name unit description].freeze
       public_constant :VALID_PARAMS
 
+      METRIC_BLACKLIST = %w[id links created_at updated_at].freeze
+
       class << self
         def create(backend:, attrs:)
           metric = backend.remote.create_backend_metric(backend.id,
@@ -74,6 +76,20 @@ module ThreeScaleToolbox
         remote.delete_backend_metric backend.id, id
       end
 
+      # enriched_key returns a metric key that will be unique for all
+      # metrics from products and backends
+      def enriched_key
+        "backend.#{backend.id}.#{id}"
+      end
+
+      def to_hash
+        extra_attrs = {
+          'backend_system_name' => backend.system_name
+        }
+
+        attrs.merge(extra_attrs).reject { |key, _| METRIC_BLACKLIST.include? key }
+      end
+
       private
 
       def process_attrs(metric_attrs)

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/proxy_logger.rb

@@ -5,6 +5,7 @@ module ThreeScaleToolbox
     end
 
     def method_missing(name, *args)
+      # Correct delegation https://eregon.me/blog/2021/02/13/correct-delegation-in-ruby-2-27-3.html
       start_time = ::Process.clock_gettime(::Process::CLOCK_MONOTONIC)
       result = @subject.public_send(name, *args)
     ensure
@@ -12,6 +13,7 @@ module ThreeScaleToolbox
       ::Kernel.warn "-- call #{name} args |#{args.inspect[0..2000]}| response |#{result.inspect[0..2000]}| - (#{end_time}s)"
       result
     end
+    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
 
     def public_send(name, *args)
       method_missing(name, *args)

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,12 +141,54 @@ 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
     ###
 
     def method_missing(name, *args)
-      subject.public_send(name, *args)
+      # Correct delegation https://eregon.me/blog/2021/02/13/correct-delegation-in-ruby-2-27-3.html
+      @subject.public_send(name, *args)
+    end
+    ruby2_keywords :method_missing if respond_to?(:ruby2_keywords, true)
+
+    def public_send(name, *args)
+      method_missing(name, *args)
     end
 
     def respond_to_missing?(method_name, include_private = false)

data/lib/3scale_toolbox/version.rb

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

data/licenses.xml

@@ -13,7 +13,7 @@
       </dependency>
           <dependency>
         <packageName>3scale_toolbox</packageName>
-        <version>0.18.3</version>
+        <version>0.19.3</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -23,7 +23,7 @@
       </dependency>
           <dependency>
         <packageName>activesupport</packageName>
-        <version>6.1.3.2</version>
+        <version>6.1.4.1</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -33,7 +33,7 @@
       </dependency>
           <dependency>
         <packageName>addressable</packageName>
-        <version>2.7.0</version>
+        <version>2.8.0</version>
         <licenses>
                       <license>
               <name>Apache 2.0</name>
@@ -53,7 +53,7 @@
       </dependency>
           <dependency>
         <packageName>bundler</packageName>
-        <version>2.1.4</version>
+        <version>2.2.21</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -63,7 +63,7 @@
       </dependency>
           <dependency>
         <packageName>codecov</packageName>
-        <version>0.5.1</version>
+        <version>0.5.2</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -141,7 +141,7 @@
       </dependency>
           <dependency>
         <packageName>docile</packageName>
-        <version>1.3.5</version>
+        <version>1.4.0</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -228,16 +228,6 @@
               <url>http://opensource.org/licenses/mit-license</url>
             </license>
                   </licenses>
-      </dependency>
-          <dependency>
-        <packageName>mini_portile2</packageName>
-        <version>2.5.3</version>
-        <licenses>
-                      <license>
-              <name>MIT</name>
-              <url>http://opensource.org/licenses/mit-license</url>
-            </license>
-                  </licenses>
       </dependency>
           <dependency>
         <packageName>minitest</packageName>
@@ -271,7 +261,7 @@
       </dependency>
           <dependency>
         <packageName>nokogiri</packageName>
-        <version>1.11.7</version>
+        <version>1.12.5</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -301,7 +291,7 @@
       </dependency>
           <dependency>
         <packageName>pry</packageName>
-        <version>0.13.1</version>
+        <version>0.14.1</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -321,7 +311,7 @@
       </dependency>
           <dependency>
         <packageName>racc</packageName>
-        <version>1.5.2</version>
+        <version>1.6.0</version>
         <licenses>
                       <license>
               <name>ruby</name>
@@ -385,7 +375,7 @@
       </dependency>
           <dependency>
         <packageName>rspec-mocks</packageName>
-        <version>3.10.1</version>
+        <version>3.10.2</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -395,7 +385,7 @@
       </dependency>
           <dependency>
         <packageName>rspec-support</packageName>
-        <version>3.10.1</version>
+        <version>3.10.2</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -405,7 +395,7 @@
       </dependency>
           <dependency>
         <packageName>ruby2_keywords</packageName>
-        <version>0.0.4</version>
+        <version>0.0.5</version>
         <licenses>
                       <license>
               <name>ruby</name>
@@ -449,7 +439,7 @@
       </dependency>
           <dependency>
         <packageName>simplecov_json_formatter</packageName>
-        <version>0.1.2</version>
+        <version>0.1.3</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -489,7 +479,7 @@
       </dependency>
           <dependency>
         <packageName>webmock</packageName>
-        <version>3.11.1</version>
+        <version>3.13.0</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -519,7 +509,7 @@
       </dependency>
           <dependency>
         <packageName>zeitwerk</packageName>
-        <version>2.4.2</version>
+        <version>2.5.1</version>
         <licenses>
                       <license>
               <name>MIT</name>