3scale_toolbox 0.6.0 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ae4791c3e86318f973f54abefb9df823abc7efe7ede820ca736697b23cd10653
-  data.tar.gz: 68cb54b32c6286593464dc1d7302343684cd4d2df043e18a5b3ff777e61f2920
+  metadata.gz: 3f412bd1eba1df7d510acff344fc72fca45f7aa94c9317e10fe2425b611276f5
+  data.tar.gz: a2bd5e4bfc83e1be12abdecbb636a18a43de81ed86594d590109e8734a59f6db
 SHA512:
-  metadata.gz: f36923df1c9961cb9a209a6228ecc50cd5e00b8b1d853384e561b3280d59550125c1793124a95cc7a9553cc42bea4453e898de2135496858d11b200333811242
-  data.tar.gz: 955e042f2a2b8cc62c56ce8bcedaa4de8a7800a16f39dbb83e37a6969a178b13ff4fdf94104d8240d2b402ab488ce7eb44400fceba0d58c8c7af5ef94a310ef3
+  metadata.gz: 8a72ea781cf845c49aeb2a6b45f3576bcd76d534b086f377afcedcab0ed956bdb74cfb01a24b7697f39b6fbeaad12290b362b75796feb9cf259ac4d14cc9fee9
+  data.tar.gz: 55c946b9199edaea9dcb0583d8b06ac5769641ab25ba646ca79c3cbb138f744177c4d2d75239d2daa482aaadf735f1906f71056c56bef91916bcade642529109

data/README.md

@@ -52,7 +52,7 @@ OPTIONS
 ```
 
 ### Copy a service
-Will create a new service, copy existing proxy settings, metrics, methods, application plans and mapping rules.
+Will create a new service, copy existing proxy settings, pricing rules, activedocs, metrics, methods, application plans and mapping rules.
 
 3scale instances can be either a [URL](docs/remotes.md#remote-urls) or the name of a [remote](docs/remotes.md).
 
@@ -69,14 +69,15 @@ USAGE
 
 DESCRIPTION
     Will create a new services, copy existing proxy settings, metrics,
-    methods, application plans and mapping rules.
+    methods, policies, application plans and mapping rules.
 
 OPTIONS
     -d --destination=<value>             3scale target instance. Url or
                                          remote name
     -s --source=<value>                  3scale source instance. Url or
                                          remote name
-    -t --target_system_name=<value>      Target system name
+    -t --target_system_name=<value>      Target system name. Default to 
+                                         source system name
 
 OPTIONS FOR COPY
     -h --help                            show help for this command
@@ -92,7 +93,7 @@ OPTIONS FOR COPY
 
 ### Update a service
 
-Will update existing service, update proxy settings, metrics, methods, application plans and mapping rules.
+Will update existing service, update proxy settings, pricing rules, activedocs, metrics, methods, application plans and mapping rules.
 
 3scale instances can be either a [URL](docs/remotes.md#remote-urls) or the name of a [remote](docs/remotes.md).
 
@@ -108,7 +109,7 @@ USAGE
 
 DESCRIPTION
     Will update existing service, update proxy settings, metrics, methods,
-    application plans and mapping rules.
+    application plans, policies and mapping rules.
 
 OPTIONS
     -d --destination=<value>      3scale target instance. Url or

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

@@ -16,7 +16,7 @@ module ThreeScaleToolbox
 
             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', argument: :required
+            option  :t, 'target_system_name', 'Target system name. Default to source system name', argument: :required
             param   :service_id
 
             runner CopyServiceSubcommand
@@ -26,11 +26,10 @@ module ThreeScaleToolbox
         def run
           source      = fetch_required_option(:source)
           destination = fetch_required_option(:destination)
-          system_name = fetch_required_option(:target_system_name)
 
           source_service = Entities::Service.new(id: arguments[:service_id],
                                                  remote: threescale_client(source))
-          target_service = create_new_service(source_service.show_service, destination, system_name)
+          target_service = create_new_service(source_service.show_service, destination)
           puts "new service id #{target_service.id}"
           context = create_context(source_service, target_service)
           tasks = [
@@ -40,7 +39,10 @@ module ThreeScaleToolbox
             Tasks::CopyApplicationPlansTask.new(context),
             Tasks::CopyLimitsTask.new(context),
             Tasks::DestroyMappingRulesTask.new(context),
-            Tasks::CopyMappingRulesTask.new(context)
+            Tasks::CopyMappingRulesTask.new(context),
+            Tasks::CopyPoliciesTask.new(context),
+            Tasks::CopyPricingRulesTask.new(context),
+            Tasks::CopyActiveDocsTask.new(context),
           ]
           tasks.each(&:call)
         end
@@ -54,10 +56,10 @@ module ThreeScaleToolbox
           }
         end
 
-        def create_new_service(service, destination, system_name)
+        def create_new_service(service, destination)
           Entities::Service.create(remote: threescale_client(destination),
                                    service: service,
-                                   system_name: system_name)
+                                   system_name: options[:target_system_name] || service['system_name'])
         end
       end
     end

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

@@ -8,6 +8,7 @@ require '3scale_toolbox/commands/import_command/openapi/threescale_api_spec'
 require '3scale_toolbox/commands/import_command/openapi/create_method_step'
 require '3scale_toolbox/commands/import_command/openapi/create_mapping_rule_step'
 require '3scale_toolbox/commands/import_command/openapi/create_service_step'
+require '3scale_toolbox/commands/import_command/openapi/create_activedocs_step'
 
 module ThreeScaleToolbox
   module Commands
@@ -33,13 +34,15 @@ module ThreeScaleToolbox
           end
 
           def run
-            context = create_context
+            openapi_resource = load_resource(arguments[:openapi_resource])
+            context = create_context(openapi_resource)
 
             tasks = []
             tasks << CreateServiceStep.new(context)
             tasks << CreateMethodsStep.new(context)
             tasks << ThreeScaleToolbox::Tasks::DestroyMappingRulesTask.new(context)
             tasks << CreateMappingRulesStep.new(context)
+            tasks << CreateActiveDocsStep.new(context)
 
             # run tasks
             tasks.each(&:call)
@@ -47,16 +50,17 @@ module ThreeScaleToolbox
 
           private
 
-          def create_context
+          def create_context(openapi_resource)
             {
-              api_spec: ThreeScaleApiSpec.new(load_openapi),
+              api_spec_resource: openapi_resource,
+              api_spec: ThreeScaleApiSpec.new(load_openapi(openapi_resource)),
               threescale_client: threescale_client(fetch_required_option(:destination)),
               target_system_name: options[:target_system_name]
             }
           end
 
-          def load_openapi
-            Swagger.build(load_resource(arguments[:openapi_resource]))
+          def load_openapi(openapi_resource)
+            Swagger.build(openapi_resource)
             # Disable validation step because https://petstore.swagger.io/v2/swagger.json
             # does not pass validation. Maybe library's schema is outdated?
             # openapi.tap(&:validate)

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

@@ -0,0 +1,52 @@
+module ThreeScaleToolbox
+  module Commands
+    module ImportCommand
+      module OpenAPI
+        class CreateActiveDocsStep
+          include Step
+
+          def call
+            active_doc = {
+              name: api_spec.title,
+              system_name: activedocs_system_name,
+              service_id: service.id,
+              body: resource.to_json,
+              description: api_spec.description
+            }
+
+            res = threescale_client.create_activedocs(active_doc)
+            # Make operation indempotent
+            if (errors = res['errors'])
+              raise ThreeScaleToolbox::Error, "ActiveDocs has not been created. #{errors}" \
+                unless system_name_already_taken_error? errors
+
+              # if activedocs system_name exists, ignore error, update activedocs
+              puts 'Activedocs exists, update!'
+              update_res = threescale_client.update_activedocs(find_activedocs_id, active_doc)
+              raise ThreeScaleToolbox::Error, "ActiveDocs has not been updated. #{update_res['errors']}" unless update_res['errors'].nil?
+            end
+          end
+
+          private
+
+          def activedocs_system_name
+            @activedocs_system_name ||= service.show_service['system_name']
+          end
+
+          def find_activedocs_id
+            activedocs = get_current_service_activedocs
+            raise ThreeScaleToolbox::Error, "Could not find activedocs with system_name: #{activedocs_system_name}" if activedocs.empty?
+
+            activedocs.dig(0, 'id')
+          end
+
+          def get_current_service_activedocs
+            threescale_client.list_activedocs.select do |activedoc|
+              activedoc['system_name'] == activedocs_system_name
+            end
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -12,13 +12,11 @@ module ThreeScaleToolbox
               metric_id = res['id']
               # if method system_name exists, ignore error and get metric_id
               # Make operation indempotent
-              unless res['errors'].nil?
-                if !res['errors']['system_name'].nil? \
-                  && res['errors']['system_name'][0] =~ /has already been taken/
-                  metric_id = method_id_by_system_name[op.method['system_name']]
-                else
-                  raise Error, "Metohd has not been saved. Errors: #{res['errors']}"
-                end
+              if (errors = res['errors'])
+                raise ThreeScaleToolbox::Error, "Metohd has not been saved. #{errors}" \
+                  unless system_name_already_taken_error? errors
+
+                metric_id = method_id_by_system_name[op.method['system_name']]
               end
 
               op.set(:metric_id, metric_id)

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

@@ -12,12 +12,16 @@ module ThreeScaleToolbox
           end
 
           def friendly_name
-            operation[:operationId]
+            operation[:operationId] || operation_id
           end
 
           def system_name
             friendly_name.downcase
           end
+
+          def operation_id
+            "#{operation[:verb]}#{operation[:path].gsub(/[^\w]/, '')}"
+          end
         end
       end
     end

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

@@ -38,6 +38,14 @@ module ThreeScaleToolbox
             # could be nil
             context[:target_system_name]
           end
+
+          def resource
+            context[:api_spec_resource]
+          end
+
+          def system_name_already_taken_error?(error)
+            Array(Hash(error)['system_name']).any? { |msg| msg.match(/has already been taken/) }
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/update_command/update_service.rb

@@ -46,6 +46,10 @@ module ThreeScaleToolbox
             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::DeleteActiveDocsTask.new(context)
+            tasks << Tasks::CopyActiveDocsTask.new(context)
           end
           tasks << Tasks::DestroyMappingRulesTask.new(context) if options[:force]
           tasks << Tasks::CopyMappingRulesTask.new(context)

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

@@ -108,6 +108,22 @@ module ThreeScaleToolbox
       def delete_service
         remote.delete_service id
       end
+
+      def policies
+        remote.show_policies id
+      end
+
+      def update_policies(params)
+        remote.update_policies(id, params)
+      end
+
+      def list_activedocs
+        remote.list_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
+        end
+      end
     end
   end
 end

data/lib/3scale_toolbox/tasks.rb

@@ -8,3 +8,7 @@ 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/update_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'

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

@@ -0,0 +1,24 @@
+module ThreeScaleToolbox
+  module Tasks
+    class CopyActiveDocsTask
+      include CopyTask
+
+      def call
+        puts 'copying all service ActiveDocs'
+
+        target_activedocs = source.list_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
+        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?
+        end
+      end
+    end
+  end
+end

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

@@ -19,8 +19,8 @@ module ThreeScaleToolbox
               limit
             )
           end
-          puts "target application plan #{target_plan['id']} is missing" \
-            " #{missing_limits.size} from the original plan #{plan_id}"
+          puts "Missing #{missing_limits.size} plan limits from target application plan " \
+            "#{target_plan['id']}. Source plan #{plan_id}"
         end
       end
 

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

@@ -0,0 +1,13 @@
+module ThreeScaleToolbox
+  module Tasks
+    class CopyPoliciesTask
+      include CopyTask
+
+      def call
+        puts 'copy proxy policies'
+        source_policies = source.policies
+        target.update_policies('policies_config' => source_policies)
+      end
+    end
+  end
+end

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

@@ -0,0 +1,36 @@
+module ThreeScaleToolbox
+  module Tasks
+    class CopyPricingRulesTask
+      include CopyTask
+      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|
+          pricing_rules_source = source.remote.list_pricingrules_per_application_plan(plan_id)
+          pricing_rules_target = target.remote.list_pricingrules_per_application_plan(target_plan['id'])
+          missing_pricing_rules = missing_pricing_rules(pricing_rules_source, pricing_rules_target)
+          missing_pricing_rules.each do |pricing_rule|
+            pricing_rule.delete('links')
+            target.remote.create_pricingrule(
+              target_plan['id'],
+              metrics_map.fetch(pricing_rule['metric_id']),
+              pricing_rule
+            )
+          end
+          puts "Missing #{missing_pricing_rules.size} pricing rules from target application plan " \
+            "#{target_plan['id']}. Source plan #{plan_id}"
+        end
+      end
+
+      private
+
+      def missing_pricing_rules(source_pricing_rules, target_pricing_rules)
+        ThreeScaleToolbox::Helper.array_difference(source_pricing_rules, target_pricing_rules) do |src, target|
+          ThreeScaleToolbox::Helper.compare_hashes(src, target, ['system_name'])
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,22 @@
+module ThreeScaleToolbox
+  module Tasks
+    class DeleteActiveDocsTask
+      attr_reader :context
+
+      def initialize(context)
+        @context = context
+      end
+
+      def call
+        puts 'deleting all target service ActiveDocs'
+        target.list_activedocs.each do |activedoc|
+          target.remote.delete_activedocs(activedoc['id'])
+        end
+      end
+
+      def target
+        context[:target]
+      end
+    end
+  end
+end

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

@@ -12,7 +12,7 @@ module ThreeScaleToolbox
       def call
         source_obj = source.show_service
         response = target.update_service(target_service_params(source_obj))
-        raise Error, "Service has not been saved. Errors: #{response['errors']}" unless response['errors'].nil?
+        raise ThreeScaleToolbox::Error, "Service has not been saved. Errors: #{response['errors']}" unless response['errors'].nil?
 
         puts "updated service settings for service id #{source.id}..."
       end

data/lib/3scale_toolbox/version.rb

@@ -1,3 +1,3 @@
 module ThreeScaleToolbox
-  VERSION = '0.6.0'
+  VERSION = '0.7.0'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.6.0
+  version: 0.7.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-02-05 00:00:00.000000000 Z
+date: 2019-03-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -87,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.7
+        version: 0.1.8
 - !ruby/object:Gem::Dependency
   name: cri
   requirement: !ruby/object:Gem::Requirement
@@ -147,6 +147,7 @@ files:
 - lib/3scale_toolbox/commands/import_command.rb
 - lib/3scale_toolbox/commands/import_command/import_csv.rb
 - lib/3scale_toolbox/commands/import_command/openapi.rb
+- lib/3scale_toolbox/commands/import_command/openapi/create_activedocs_step.rb
 - lib/3scale_toolbox/commands/import_command/openapi/create_mapping_rule_step.rb
 - lib/3scale_toolbox/commands/import_command/openapi/create_method_step.rb
 - lib/3scale_toolbox/commands/import_command/openapi/create_service_step.rb
@@ -170,13 +171,17 @@ files:
 - lib/3scale_toolbox/helper.rb
 - lib/3scale_toolbox/remotes.rb
 - lib/3scale_toolbox/tasks.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_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/tasks/update_service_settings_task.rb