3scale_toolbox 0.15.0 → 0.16.0

data/lib/3scale_toolbox/version.rb

@@ -1,3 +1,3 @@
 module ThreeScaleToolbox
-  VERSION = '0.15.0'
+  VERSION = '0.16.0'
 end

data/licenses.xml

@@ -3,7 +3,7 @@
   <dependencies>
           <dependency>
         <packageName>3scale-api</packageName>
-        <version>0.6.0</version>
+        <version>1.0.0</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -13,7 +13,7 @@
       </dependency>
           <dependency>
         <packageName>3scale_toolbox</packageName>
-        <version>0.15.0</version>
+        <version>0.16.0</version>
         <licenses>
                       <license>
               <name>MIT</name>
@@ -93,7 +93,7 @@
       </dependency>
           <dependency>
         <packageName>cri</packageName>
-        <version>2.15.9</version>
+        <version>2.15.10</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.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-01-14 00:00:00.000000000 Z
+date: 2020-02-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.6.0
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: cri
   requirement: !ruby/object:Gem::Requirement
@@ -158,7 +158,11 @@ files:
 - lib/3scale_toolbox/attribute_filters/service_id_from_ref_filter.rb
 - lib/3scale_toolbox/base_command.rb
 - lib/3scale_toolbox/cli.rb
+- lib/3scale_toolbox/cli/custom_table_printer.rb
 - lib/3scale_toolbox/cli/error_handler.rb
+- lib/3scale_toolbox/cli/json_printer.rb
+- lib/3scale_toolbox/cli/output_flag.rb
+- lib/3scale_toolbox/cli/yaml_printer.rb
 - lib/3scale_toolbox/commands.rb
 - lib/3scale_toolbox/commands/3scale_command.rb
 - lib/3scale_toolbox/commands/account_command.rb
@@ -174,8 +178,15 @@ files:
 - lib/3scale_toolbox/commands/application_command/delete_command.rb
 - lib/3scale_toolbox/commands/application_command/list_command.rb
 - lib/3scale_toolbox/commands/application_command/show_command.rb
+- lib/3scale_toolbox/commands/backend_command.rb
+- lib/3scale_toolbox/commands/backend_command/copy_command.rb
+- lib/3scale_toolbox/commands/backend_command/copy_command/copy_mapping_rules_task.rb
+- lib/3scale_toolbox/commands/backend_command/copy_command/copy_methods_task.rb
+- lib/3scale_toolbox/commands/backend_command/copy_command/copy_metrics_task.rb
+- lib/3scale_toolbox/commands/backend_command/copy_command/create_or_update_target_backend_task.rb
+- lib/3scale_toolbox/commands/backend_command/copy_command/task.rb
 - lib/3scale_toolbox/commands/copy_command.rb
-- lib/3scale_toolbox/commands/copy_command/copy_service.rb
+- lib/3scale_toolbox/commands/copy_command/service_command.rb
 - lib/3scale_toolbox/commands/help_command.rb
 - lib/3scale_toolbox/commands/import_command.rb
 - lib/3scale_toolbox/commands/import_command/import_csv.rb
@@ -225,6 +236,10 @@ files:
 - lib/3scale_toolbox/commands/plans_command/show_command.rb
 - lib/3scale_toolbox/commands/policy_registry_command.rb
 - lib/3scale_toolbox/commands/policy_registry_command/copy_command.rb
+- lib/3scale_toolbox/commands/product_command.rb
+- lib/3scale_toolbox/commands/product_command/copy_command.rb
+- lib/3scale_toolbox/commands/product_command/copy_command/copy_backends_task.rb
+- lib/3scale_toolbox/commands/product_command/copy_command/delete_target_backend_usages_task.rb
 - lib/3scale_toolbox/commands/proxy_config_command.rb
 - lib/3scale_toolbox/commands/proxy_config_command/list_command.rb
 - lib/3scale_toolbox/commands/proxy_config_command/promote_command.rb
@@ -236,18 +251,39 @@ files:
 - lib/3scale_toolbox/commands/remote_command/remote_rename.rb
 - lib/3scale_toolbox/commands/service_command.rb
 - lib/3scale_toolbox/commands/service_command/apply_command.rb
+- lib/3scale_toolbox/commands/service_command/copy_command.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/bump_proxy_version_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_activedocs_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_app_plans_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_limits_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_mapping_rules_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_methods_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_metrics_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_policies_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_pricingrules_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/copy_service_proxy_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/create_or_update_service_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/destroy_mapping_rules_task.rb
+- lib/3scale_toolbox/commands/service_command/copy_command/task.rb
 - lib/3scale_toolbox/commands/service_command/create_command.rb
 - lib/3scale_toolbox/commands/service_command/delete_command.rb
 - lib/3scale_toolbox/commands/service_command/list_command.rb
 - lib/3scale_toolbox/commands/service_command/show_command.rb
 - lib/3scale_toolbox/commands/update_command.rb
-- lib/3scale_toolbox/commands/update_command/update_service.rb
+- lib/3scale_toolbox/commands/update_command/service_command.rb
+- lib/3scale_toolbox/commands/update_command/service_command/copy_service_settings_task.rb
+- lib/3scale_toolbox/commands/update_command/service_command/delete_activedocs_task.rb
 - lib/3scale_toolbox/configuration.rb
 - lib/3scale_toolbox/entities.rb
 - lib/3scale_toolbox/entities/account.rb
 - lib/3scale_toolbox/entities/activedocs.rb
 - lib/3scale_toolbox/entities/application.rb
 - lib/3scale_toolbox/entities/application_plan.rb
+- lib/3scale_toolbox/entities/backend.rb
+- lib/3scale_toolbox/entities/backend_mapping_rule.rb
+- lib/3scale_toolbox/entities/backend_method.rb
+- lib/3scale_toolbox/entities/backend_metric.rb
+- lib/3scale_toolbox/entities/backend_usage.rb
 - lib/3scale_toolbox/entities/base_entity.rb
 - lib/3scale_toolbox/entities/method.rb
 - lib/3scale_toolbox/entities/metric.rb
@@ -261,22 +297,6 @@ files:
 - lib/3scale_toolbox/proxy_logger.rb
 - lib/3scale_toolbox/remotes.rb
 - lib/3scale_toolbox/resource_reader.rb
-- lib/3scale_toolbox/tasks.rb
-- lib/3scale_toolbox/tasks/bump_proxy_version_task.rb
-- lib/3scale_toolbox/tasks/copy_activedocs_task.rb
-- lib/3scale_toolbox/tasks/copy_app_plans_task.rb
-- lib/3scale_toolbox/tasks/copy_limits_task.rb
-- lib/3scale_toolbox/tasks/copy_mapping_rules_task.rb
-- lib/3scale_toolbox/tasks/copy_methods_task.rb
-- lib/3scale_toolbox/tasks/copy_metrics_task.rb
-- lib/3scale_toolbox/tasks/copy_policies_task.rb
-- lib/3scale_toolbox/tasks/copy_pricingrules_task.rb
-- lib/3scale_toolbox/tasks/copy_service_proxy_task.rb
-- lib/3scale_toolbox/tasks/copy_service_settings_task.rb
-- lib/3scale_toolbox/tasks/copy_task.rb
-- lib/3scale_toolbox/tasks/delete_activedocs_task.rb
-- lib/3scale_toolbox/tasks/destroy_mapping_rules_task.rb
-- lib/3scale_toolbox/tasks/helper_task.rb
 - lib/3scale_toolbox/version.rb
 - licenses.xml
 - resources/oas3_meta_schema.json

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

@@ -1,144 +0,0 @@
-module ThreeScaleToolbox
-  module Commands
-    module CopyCommand
-      class CopyServiceSubcommand < Cri::CommandRunner
-        include ThreeScaleToolbox::Command
-
-        def self.command
-          Cri::Command.define do
-            name        'service'
-            usage       'service [opts] -s <src> -d <dst> <source-service>'
-            summary     'copy service'
-            description <<-HEREDOC
-            This command makes a copy of the referenced service.
-            Target service will be searched by source service system name. System name can be overriden with `--target_system_name` option.
-            If a service with the selected `system_name` is not found, it will be created.
-            \n Components of the service being copied:
-            \nservice settings
-            \nproxy settings
-            \npricing rules
-            \nactivedocs
-            \nmetrics
-            \nmethods
-            \napplication plans
-            \nmapping rules
-            HEREDOC
-
-            option  :s, :source, '3scale source instance. Url or remote name', argument: :required
-            option  :d, :destination, '3scale target instance. Url or remote name', argument: :required
-            option  :t, 'target_system_name', 'Target system name. Default to source system name', argument: :required
-            flag    :f, :force, 'Overwrites the mapping rules by deleting all rules from target service first'
-            flag    :r, 'rules-only', 'Only mapping rules are copied'
-            param   :source_service
-
-            runner CopyServiceSubcommand
-          end
-        end
-
-        def run
-          target_service = Entities::Service.find(remote: target_remote,
-                                                  ref: target_service_ref)
-
-          target_service_new = target_service.nil?
-          if target_service_new
-            target_service = Entities::Service.create(remote: target_remote,
-                                                      service_params: create_service_attrs)
-          end
-
-          if target_service == source_service
-            raise ThreeScaleToolbox::Error, 'Source and destination services are the same: ' \
-              "ID: #{source_service.id} system_name: #{source_service.attrs['system_name']}"
-          end
-
-          puts "new service id #{target_service.id}"
-
-          context = create_context(source_service, target_service)
-
-          tasks = []
-          unless option_rules_only
-            tasks << Tasks::CopyServiceSettingsTask.new(context)
-            tasks << Tasks::CopyServiceProxyTask.new(context)
-            tasks << Tasks::CopyMethodsTask.new(context)
-            tasks << Tasks::CopyMetricsTask.new(context)
-            tasks << Tasks::CopyApplicationPlansTask.new(context)
-            tasks << Tasks::CopyLimitsTask.new(context)
-            tasks << Tasks::CopyPoliciesTask.new(context)
-            tasks << Tasks::CopyPricingRulesTask.new(context)
-            tasks << Tasks::CopyActiveDocsTask.new(context)
-          end
-          tasks << Tasks::DestroyMappingRulesTask.new(context) if option_force || target_service_new
-          tasks << Tasks::CopyMappingRulesTask.new(context)
-          tasks.each(&:call)
-
-          # This should be the last step
-          Tasks::BumpProxyVersionTask.new(service: target_service).call
-        end
-
-        private
-
-        def create_context(source, target)
-          {
-            source: source,
-            target: target
-          }
-        end
-
-        def option_rules_only
-          options[:'rules-only']
-        end
-
-        def option_force
-          options[:force]
-        end
-
-        def option_target_system_name
-          options[:target_system_name]
-        end
-
-        def create_service_attrs
-          # minimum required attrs.
-          # Service settings will be updated in later task
-          # These attrs are only when service is created
-          {
-            'name' => source_service.attrs.fetch('name'),
-            'system_name' => target_service_ref
-          }.compact
-        end
-
-        def source_service
-          @source_service ||= find_source_service
-        end
-
-        def find_source_service
-          Entities::Service.find(remote: source_remote, ref: source_service_ref).tap do |svc|
-            raise ThreeScaleToolbox::Error, "Service #{source_service_ref} does not exist" if svc.nil?
-          end
-        end
-
-        def source_remote
-          @source_remote ||= threescale_client(source)
-        end
-
-        def target_remote
-          @target_remote ||= threescale_client(target)
-        end
-
-        def source_service_ref
-          arguments[:source_service]
-        end
-
-        def target_service_ref
-          option_target_system_name || source_service.attrs.fetch('system_name')
-        end
-
-        def source
-          fetch_required_option(:source)
-        end
-
-        def target
-          fetch_required_option(:destination)
-        end
-      end
-    end
-  end
-end

data/lib/3scale_toolbox/tasks.rb

@@ -1,15 +0,0 @@
-require '3scale_toolbox/tasks/copy_task'
-require '3scale_toolbox/tasks/helper_task'
-require '3scale_toolbox/tasks/copy_service_proxy_task'
-require '3scale_toolbox/tasks/copy_metrics_task'
-require '3scale_toolbox/tasks/copy_methods_task'
-require '3scale_toolbox/tasks/copy_app_plans_task'
-require '3scale_toolbox/tasks/copy_limits_task'
-require '3scale_toolbox/tasks/destroy_mapping_rules_task'
-require '3scale_toolbox/tasks/copy_mapping_rules_task'
-require '3scale_toolbox/tasks/copy_service_settings_task'
-require '3scale_toolbox/tasks/copy_policies_task'
-require '3scale_toolbox/tasks/copy_pricingrules_task'
-require '3scale_toolbox/tasks/delete_activedocs_task'
-require '3scale_toolbox/tasks/copy_activedocs_task'
-require '3scale_toolbox/tasks/bump_proxy_version_task'

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

@@ -1,32 +0,0 @@
-module ThreeScaleToolbox
-  module Tasks
-    class BumpProxyVersionTask
-      attr_reader :service
-
-      def initialize(service:)
-        @service = service
-      end
-
-      ##
-      # bumps proxy config version to propagate proxy settings updates
-      def call
-        # Proxy update is the mechanism to increase version of the proxy,
-        # Hence propagating (mapping rules, poicies, oidc, auth) update to
-        # latest proxy config, making available to gateway.
-
-        # Currently it is done always because mapping rules, at least, are always created
-        # So they need to be propagated
-        proxy_settings = {
-          # Adding harmless attribute to avoid empty body
-          # update_proxy cannot be done with empty body
-          # and must be done to increase proxy version
-          # If proxy settings have not been changed since last update,
-          # this request will not have effect and proxy config version will not be bumped.
-          service_id: service.id
-        }
-
-        service.update_proxy proxy_settings
-      end
-    end
-  end
-end

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

@@ -1,42 +0,0 @@
-module ThreeScaleToolbox
-  module Tasks
-    class CopyActiveDocsTask
-      include CopyTask
-
-      def call
-        puts 'copying all service ActiveDocs'
-
-        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
-
-      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
-  end
-end

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

@@ -1,31 +0,0 @@
-module ThreeScaleToolbox
-  module Tasks
-    class CopyApplicationPlansTask
-      include CopyTask
-
-      def call
-        source_plans = source.plans
-        target_plans = target.plans
-        missing_plans = missing_app_plans(source_plans, target_plans)
-        missing_plans.each do |plan|
-          plan.delete('links')
-          plan.delete('default') # TODO: handle default plan
-          if plan.delete('custom') # TODO: what to do with custom plans?
-            puts "skipping custom plan #{plan}"
-          else
-            ThreeScaleToolbox::Entities::ApplicationPlan.create(service: target, plan_attrs: plan)
-          end
-        end
-        puts "target service missing #{missing_plans.size} application plans"
-      end
-
-      private
-
-      def missing_app_plans(source_plans, target_plans)
-        ThreeScaleToolbox::Helper.array_difference(source_plans, target_plans) do |src, target|
-          ThreeScaleToolbox::Helper.compare_hashes(src, target, ['system_name'])
-        end
-      end
-    end
-  end
-end

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

@@ -1,36 +0,0 @@
-module ThreeScaleToolbox
-  module Tasks
-    class CopyLimitsTask
-      include CopyTask
-      include Helper
-
-      def call
-        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)
-          target_plan = ThreeScaleToolbox::Entities::ApplicationPlan.new(id: target_plan['id'], service: target)
-          missing_limits = missing_limits(source_plan.limits, target_plan.limits, metrics_map)
-          missing_limits.each do |limit|
-            limit.delete('links')
-            target_plan.create_limit(metrics_map.fetch(limit.fetch('metric_id')), limit)
-          end
-          puts "Missing #{missing_limits.size} plan limits from target application plan " \
-            "#{target_plan.id}. Source plan #{plan_id}"
-        end
-      end
-
-      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']) &&
-            metrics_map.fetch(limit.fetch('metric_id')) == target.fetch('metric_id')
-        end
-      end
-    end
-  end
-end