3scale_toolbox 0.11.0 → 0.12.2

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

@@ -42,7 +42,7 @@ module ThreeScaleToolbox
       attr_reader :id, :remote
 
       def initialize(id:, remote:, attrs: nil)
-        @id = id
+        @id = id.to_i
         @remote = remote
         @attrs = attrs
       end

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

@@ -16,37 +16,37 @@ module ThreeScaleToolbox
         # * User_key (API key)
         # * App_id (from app_id/app_key pair)
         # * Client ID (for OAuth and OpenID Connect authentication modes)
-        def find(remote:, ref:)
-          app = find_by_user_key(remote, ref)
+        def find(remote:, service_id: nil, ref:)
+          app = find_by_user_key(remote, service_id, ref)
           return app unless app.nil?
 
-          app = find_by_app_id(remote, ref)
+          app = find_by_app_id(remote, service_id, ref)
           return app unless app.nil?
 
-          app = find_by_id(remote, ref)
+          app = find_by_id(remote, service_id, ref)
           return app unless app.nil?
 
           nil
         end
 
-        def find_by_id(remote, id)
-          generic_find(remote, :id, id)
+        def find_by_id(remote, service_id, id)
+          generic_find(remote, service_id, :id, id)
         end
 
-        def find_by_user_key(remote, user_key)
-          generic_find(remote, :user_key, user_key)
+        def find_by_user_key(remote, service_id, user_key)
+          generic_find(remote, service_id, :user_key, user_key)
         end
 
-        def find_by_app_id(remote, app_id)
-          generic_find(remote, :application_id, app_id)
+        def find_by_app_id(remote, service_id, app_id)
+          generic_find(remote, service_id, :application_id, app_id)
         end
 
         private
 
-        def generic_find(remote, type, ref)
+        def generic_find(remote, service_id, type, ref)
           # find_application criteria only accepts one parameter.
           # Otherwise unexpected behavior
-          attrs = remote.find_application(type => ref)
+          attrs = remote.find_application(service_id: service_id, type => ref)
           if (errors = attrs['errors'])
             raise ThreeScaleToolbox::ThreeScaleApiError.new('Application find error', errors)
           end
@@ -60,7 +60,7 @@ module ThreeScaleToolbox
       attr_reader :id, :remote
 
       def initialize(id:, remote:, attrs: nil)
-        @id = id
+        @id = id.to_i
         @remote = remote
         @attrs = attrs
       end
@@ -81,6 +81,8 @@ module ThreeScaleToolbox
       end
 
       def resume
+        return attrs if live?
+
         new_attrs = remote.resume_application(account_id, id)
         if (errors = new_attrs['errors'])
           raise ThreeScaleToolbox::ThreeScaleApiError.new('Application has not been resumed', errors)
@@ -92,6 +94,8 @@ module ThreeScaleToolbox
       end
 
       def suspend
+        return attrs unless live?
+
         new_attrs = remote.suspend_application(account_id, id)
         if (errors = new_attrs['errors'])
           raise ThreeScaleToolbox::ThreeScaleApiError.new('Application has not been suspended', errors)
@@ -106,6 +110,10 @@ module ThreeScaleToolbox
         remote.delete_application account_id, id
       end
 
+      def live?
+        attrs.fetch('state') == 'live'
+      end
+
       private
 
       def account_id

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

@@ -39,7 +39,7 @@ module ThreeScaleToolbox
       attr_reader :id, :service, :remote
 
       def initialize(id:, service:, attrs: nil)
-        @id = id
+        @id = id.to_i
         @service = service
         @remote = service.remote
         @attrs = attrs
@@ -50,6 +50,8 @@ module ThreeScaleToolbox
       end
 
       def update(plan_attrs)
+        return attrs if update_plan_attrs(plan_attrs).empty?
+
         new_attrs = remote.update_application_plan(service.id, id,
                                                    update_plan_attrs(plan_attrs))
         if (errors = new_attrs['errors'])
@@ -170,6 +172,10 @@ module ThreeScaleToolbox
         end
       end
 
+      def published?
+        attrs.fetch('state') == 'published'
+      end
+
       private
 
       def read_plan_attrs
@@ -181,17 +187,12 @@ module ThreeScaleToolbox
         plan_attrs
       end
 
-      def update_plan_attrs(source_attrs)
-        # shallow copy is enough
-        source_attrs.clone.tap do |new_plan_attrs|
-          new_plan_attrs.delete('id')
-          new_plan_attrs.delete('links')
-          new_plan_attrs.delete('system_name')
-          # plans are created by default in hidden state
-          # If published is required, 'state_event' attr has to be added
-          state = new_plan_attrs.delete('state')
-          new_plan_attrs['state_event'] = 'publish' if state == 'published'
-          new_plan_attrs['state_event'] = 'hide' if state == 'hidden'
+      def update_plan_attrs(update_attrs)
+        new_attrs = update_attrs.reject { |key, _| %w[id links system_name].include? key }
+        new_attrs.tap do |params|
+          state = params.delete('state')
+          params['state_event'] = 'publish' if state == 'published' && !published?
+          params['state_event'] = 'hide' if state == 'hidden' && published?
         end
       end
 

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

@@ -16,7 +16,7 @@ module ThreeScaleToolbox
       attr_reader :id, :attrs, :remote
 
       def initialize(id:, remote:, attrs: nil, verbose: false)
-        @id = id
+        @id = id.to_i
         @remote = remote
         @attrs = attrs
         @verbose = verbose

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

@@ -30,7 +30,7 @@ module ThreeScaleToolbox
       attr_reader :id, :parent_id, :service, :remote
 
       def initialize(id:, parent_id:, service:, attrs: nil)
-        @id = id
+        @id = id.to_i
         @service = service
         @parent_id = parent_id
         @remote = service.remote

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

@@ -29,7 +29,7 @@ module ThreeScaleToolbox
       attr_reader :id, :service, :remote
 
       def initialize(id:, service:, attrs: nil)
-        @id = id
+        @id = id.to_i
         @service = service
         @remote = service.remote
         @attrs = attrs

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

@@ -66,7 +66,7 @@ module ThreeScaleToolbox
       attr_reader :id, :remote
 
       def initialize(id:, remote:, attrs: nil)
-        @id = id
+        @id = id.to_i
         @remote = remote
         @attrs = attrs
       end
@@ -95,21 +95,18 @@ module ThreeScaleToolbox
       end
 
       def metrics
-        service_metrics = remote.list_metrics id
-        if service_metrics.respond_to?(:has_key?) && (errors = service_metrics['errors'])
-          raise ThreeScaleToolbox::ThreeScaleApiError.new('Service metrics not read', errors)
-        end
+        # cache result to reuse
+        metric_and_method_list = metrics_and_methods
+        hits_metric_obj = hits_metric(metric_and_method_list)
+        hits_id = hits_metric_obj.fetch('id')
 
-        service_metrics
+        ThreeScaleToolbox::Helper.array_difference(metric_and_method_list, methods(hits_id)) do |metric, method|
+          ThreeScaleToolbox::Helper.compare_hashes(metric, method, %w[id])
+        end
       end
 
       def hits
-        hits_metric = metrics.find do |metric|
-          metric['system_name'] == 'hits'
-        end
-        raise ThreeScaleToolbox::Error, 'missing hits metric' if hits_metric.nil?
-
-        hits_metric
+        hits_metric(metrics_and_methods)
       end
 
       def methods(parent_metric_id)
@@ -121,6 +118,15 @@ module ThreeScaleToolbox
         service_methods
       end
 
+      def metrics_and_methods
+        m_m = remote.list_metrics id
+        if m_m.respond_to?(:has_key?) && (errors = m_m['errors'])
+          raise ThreeScaleToolbox::ThreeScaleApiError.new('Service metrics not read', errors)
+        end
+
+        m_m
+      end
+
       def plans
         service_plans = remote.list_service_application_plans id
         if service_plans.respond_to?(:has_key?) && (errors = service_plans['errors'])
@@ -174,9 +180,7 @@ module ThreeScaleToolbox
         end
 
         tenant_activedocs.select do |activedoc|
-          # service_id is optional attr. It would return nil and would not match
-          # activedocs endpoints return service_id as integers
-          activedoc['service_id'] == id.to_i
+          activedoc['service_id'] == id
         end
       end
 
@@ -245,8 +249,19 @@ module ThreeScaleToolbox
         end
       end
 
+      def ==(other)
+        remote.http_client.endpoint == other.remote.http_client.endpoint && id == other.id
+      end
+
       private
 
+      def hits_metric(metric_list)
+        hits_metric = metric_list.find { |metric| metric['system_name'] == 'hits' }
+        raise ThreeScaleToolbox::Error, 'missing hits metric' if hits_metric.nil?
+
+        hits_metric
+      end
+
       def service_attrs
         svc = remote.show_service id
         if (errors = svc['errors'])

data/lib/3scale_toolbox/remotes.rb

@@ -52,7 +52,7 @@ module ThreeScaleToolbox
     end
 
     def fetch(name)
-      all.fetch name
+      all.fetch(name) { raise_not_found(name) }
     end
 
     private

data/lib/3scale_toolbox/resource_reader.rb

@@ -27,8 +27,11 @@ module ThreeScaleToolbox
     end
 
     # Detect format from file extension
-    def read_file(resource)
-      File.read(resource)
+    def read_file(filename)
+      raise ThreeScaleToolbox::Error, "File not found: #{filename} " unless File.file?(filename)
+      raise ThreeScaleToolbox::Error, "File not readable: #{filename} " unless File.readable?(filename)
+
+      File.read(filename)
     end
 
     def read_stdin(_resource)

data/lib/3scale_toolbox/swagger/swagger.rb

@@ -23,12 +23,13 @@ module ThreeScaleToolbox
     end
 
     class Operation
-      attr_reader :verb, :operation_id, :path
+      attr_reader :verb, :operation_id, :path, :description
 
-      def initialize(verb:, operation_id:, path:)
+      def initialize(verb:, operation_id:, path:, description:)
         @verb = verb
         @operation_id = operation_id
         @path = path
+        @description = description
       end
     end
 
@@ -83,7 +84,8 @@ module ThreeScaleToolbox
           path_obj.flat_map do |method, operation|
             next unless %w[get head post put patch delete trace options].include? method
 
-            Operation.new(verb: method, path: path, operation_id: operation['operationId'])
+            Operation.new(verb: method, path: path, description: operation['description'],
+                          operation_id: operation['operationId'])
           end.compact
         end
       end

data/lib/3scale_toolbox/tasks/copy_activedocs_task.rb

@@ -6,17 +6,35 @@ module ThreeScaleToolbox
       def call
         puts 'copying all service ActiveDocs'
 
-        target_activedocs = source.activedocs.map do |source_activedoc|
-          source_activedoc.clone.tap do |target_activedoc|
-            target_activedoc.delete('id')
-            target_activedoc['service_id'] = target.id
-            target_activedoc['system_name'] = "#{target_activedoc['system_name']}#{target.id}"
-          end
+        source.activedocs.each(&method(:apply_target_activedoc))
+      end
+
+      private
+
+      def apply_target_activedoc(attrs)
+        activedocs = Entities::ActiveDocs.find_by_system_name(remote: target.remote,
+                                                              system_name: attrs['system_name'])
+        if activedocs.nil?
+          Entities::ActiveDocs.create(remote: target.remote, attrs: create_attrs(attrs))
+        elsif activedocs.attrs.fetch('service_id') == target.id
+          activedocs.update(update_attrs(attrs))
+        else
+          # activedocs with same system_name exists, but now owned by target service
+          new_attrs = create_attrs(attrs)
+          new_attrs['system_name'] = "#{attrs['system_name']}#{target.id}"
+          Entities::ActiveDocs.create(remote: target.remote, attrs: new_attrs)
         end
+      end
+
+      def update_attrs(old_attrs)
+        create_attrs(old_attrs)
+      end
 
-        target_activedocs.each do |ad|
-          res = target.remote.create_activedocs(ad)
-          raise ThreeScaleToolbox::Error, "ActiveDocs has not been created. Errors: #{res['errors']}" unless res['errors'].nil?
+      def create_attrs(old_attrs)
+        # keep same system_name
+        new_attrs = old_attrs.reject { |key, _| %w[id created_at updated_at].include? key }
+        new_attrs.tap do |attrs|
+          attrs['service_id'] = target.id
         end
       end
     end

data/lib/3scale_toolbox/tasks/copy_limits_task.rb

@@ -5,7 +5,6 @@ module ThreeScaleToolbox
       include Helper
 
       def call
-        metrics_map = metrics_mapping(source.metrics, target.metrics)
         plan_mapping = application_plan_mapping(source.plans, target.plans)
         plan_mapping.each do |plan_id, target_plan|
           source_plan = ThreeScaleToolbox::Entities::ApplicationPlan.new(id: plan_id, service: source)
@@ -22,6 +21,10 @@ module ThreeScaleToolbox
 
       private
 
+      def metrics_map
+        @metrics_map ||= metrics_mapping(source_metrics_and_methods, target_metrics_and_methods)
+      end
+
       def missing_limits(source_limits, target_limits, metrics_map)
         ThreeScaleToolbox::Helper.array_difference(source_limits, target_limits) do |limit, target|
           ThreeScaleToolbox::Helper.compare_hashes(limit, target, ['period']) &&

data/lib/3scale_toolbox/tasks/copy_mapping_rules_task.rb

@@ -5,7 +5,6 @@ module ThreeScaleToolbox
       include Helper
 
       def call
-        metrics_map = metrics_mapping(source.metrics, target.metrics)
         missing_rules = missing_mapping_rules(source.mapping_rules,
                                               target.mapping_rules, metrics_map)
         missing_rules.each do |mapping_rule|
@@ -18,6 +17,10 @@ module ThreeScaleToolbox
 
       private
 
+      def metrics_map
+        @metrics_map ||= metrics_mapping(source_metrics_and_methods, target_metrics_and_methods)
+      end
+
       def missing_mapping_rules(source_rules, target_rules, metrics_map)
         ThreeScaleToolbox::Helper.array_difference(source_rules, target_rules) do |source_rule, target_rule|
           ThreeScaleToolbox::Helper.compare_hashes(source_rule, target_rule, %w[pattern http_method delta]) &&

data/lib/3scale_toolbox/tasks/copy_methods_task.rb

@@ -4,26 +4,30 @@ module ThreeScaleToolbox
       include CopyTask
 
       def call
-        source_hits_id = source.hits['id']
-        target_hits_id = target.hits['id']
-        source_methods = source.methods source_hits_id
-        target_methods = target.methods target_hits_id
-        puts "original service hits metric #{source_hits_id} has #{source_methods.size} methods"
-        puts "target service hits metric #{target_hits_id} has #{target_methods.size} methods"
-        missing = missing_methods(source_methods, target_methods).each do |method|
-          Entities::Method.create(
-            service: target,
-            parent_id: target_hits_id,
-            attrs: ThreeScaleToolbox::Helper.filter_params(%w[friendly_name system_name], method)
-          )
-        end
-        puts "created #{missing.size} missing methods on target service"
+        puts "original service hits metric #{source_hits.fetch('id')} has #{source_methods.size} methods"
+        puts "target service hits metric #{target_hits.fetch('id')} has #{target_methods.size} methods"
+        missing_methods.each(&method(:create_method))
+        puts "created #{missing_methods.size} missing methods on target service"
+        invalidate_target_methods if missing_methods.size.positive?
       end
 
       private
 
-      def missing_methods(source_methods, target_methods)
-        ThreeScaleToolbox::Helper.array_difference(source_methods, target_methods) do |method, target|
+      def create_method(method)
+        Entities::Method.create(
+          service: target,
+          parent_id: target_hits.fetch('id'),
+          attrs: ThreeScaleToolbox::Helper.filter_params(%w[friendly_name system_name], method)
+        )
+      rescue ThreeScaleToolbox::ThreeScaleApiError => e
+        raise e unless ThreeScaleToolbox::Helper.system_name_already_taken_error?(e.apierrors)
+
+        warn "[WARN] method #{method.fetch('system_name')} not created. " \
+          'Metric with the same system_name exists.'
+      end
+
+      def missing_methods
+        @missing_methods ||= ThreeScaleToolbox::Helper.array_difference(source_methods, target_methods) do |method, target|
           ThreeScaleToolbox::Helper.compare_hashes(method, target, ['system_name'])
         end
       end