3scale_toolbox 0.8.0 → 0.9.0

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

@@ -0,0 +1,150 @@
+module ThreeScaleToolbox
+  module Entities
+    class ApplicationPlan
+      class << self
+        def create(service:, plan_attrs:)
+          plan = service.remote.create_application_plan service.id, build_plan_attrs(plan_attrs)
+          if (errors = plan['errors'])
+            raise ThreeScaleToolbox::Error, "Application plan has not been saved. Errors: #{errors}"
+          end
+
+          new(id: plan.fetch('id'), service: service)
+        end
+
+        # ref can be system_name or service_id
+        def find(service:, ref:)
+          new(id: ref, service: service).tap(&:show)
+        rescue ThreeScale::API::HttpClient::NotFoundError
+          find_by_system_name(service: service, system_name: ref)
+        end
+
+        def find_by_system_name(service:, system_name:)
+          plan = service.plans.find { |p| p['system_name'] == system_name }
+          return if plan.nil?
+
+          new(id: plan.fetch('id'), service: service)
+        end
+
+        def build_plan_attrs(source_attrs)
+          # shallow copy is enough
+          source_attrs.clone.tap do |new_plan_attrs|
+            # plans are created by default in hidden state
+            # If published is required, 'state_event' attr has to be added
+            new_plan_attrs['state_event'] = 'publish' if new_plan_attrs['state'] == 'published'
+            new_plan_attrs['state_event'] = 'hide' if new_plan_attrs['state'] == 'hidden'
+          end
+        end
+      end
+
+      attr_reader :id, :service, :remote
+
+      def initialize(id:, service:)
+        @id = id
+        @service = service
+        @remote = service.remote
+      end
+
+      def show
+        remote.show_application_plan service.id, id
+      end
+
+      def update(plan_attrs)
+        remote.update_application_plan(service.id, id, self.class.build_plan_attrs(plan_attrs))
+      end
+
+      def make_default
+        plan = remote.application_plan_as_default service.id, id
+        if (errors = plan['errors'])
+          raise ThreeScaleToolbox::Error, "Application plan has not been set to default. Errors: #{errors}"
+        end
+
+        plan
+      end
+
+      def disable
+        # Split metrics into three groups:
+        # a) metrics having limits set with eternity period and zero value, nothing to do.
+        # b) metrics having limits set with eternity period, but not zero value, must be updated
+        # c) metrics not having limits set with eternity period, must be created
+
+        eternity_limits = limits.select { |limit| limit.fetch('period') == 'eternity' }
+        eternity_metric_ids = eternity_limits.map { |limit| limit.fetch('metric_id') }
+        service_metric_ids = service.metrics.map { |metric| metric.fetch('id') }
+        metric_ids_without_eternity = service_metric_ids - eternity_metric_ids
+
+        # create eternity zero limit for each metric without eternity limit set
+        metric_ids_without_eternity.each do |metric_id|
+          create_limit(metric_id, zero_eternity_limit_attrs)
+        end
+
+        # update eternity zero limit those metrics already having eternity limit set
+        not_zero_eternity_limits = eternity_limits.reject { |limit| limit.fetch('value').zero? }
+        not_zero_eternity_limits.each do |limit|
+          update_limit(limit.fetch('metric_id'), limit.fetch('id'), zero_eternity_limit_attrs)
+        end
+      end
+
+      def enable
+        eternity_zero_limits.each do |limit|
+          delete_limit(limit.fetch('metric_id'), limit.fetch('id'))
+        end
+      end
+
+      def limits
+        remote.list_application_plan_limits id
+      end
+
+      def create_limit(metric_id, limit_attrs)
+        limit = remote.create_application_plan_limit id, metric_id, limit_attrs
+        if (errors = limit['errors'])
+          raise ThreeScaleToolbox::Error, "Limit has not been created. Errors: #{errors}"
+        end
+
+        limit
+      end
+
+      def update_limit(metric_id, limit_id, limit_attrs)
+        limit = remote.update_application_plan_limit id, metric_id, limit_id, limit_attrs
+        if (errors = limit['errors'])
+          raise ThreeScaleToolbox::Error, "Limit #{limit_id} has not been updated. Errors: #{errors}"
+        end
+
+        limit
+      end
+
+      def delete_limit(metric_id, limit_id)
+        remote.delete_application_plan_limit id, metric_id, limit_id
+      end
+
+      def create_pricing_rule(metric_id, pr_attrs)
+        remote.create_pricingrule id, metric_id, pr_attrs
+      end
+
+      def pricing_rules
+        remote.list_pricingrules_per_application_plan id
+      end
+
+      def features
+        remote.list_features_per_application_plan id
+      end
+
+      def create_feature(feature_id)
+        remote.create_application_plan_feature id, feature_id
+      end
+
+      def delete
+        remote.delete_application_plan service.id, id
+      end
+
+      private
+
+      def eternity_zero_limits
+        limits.select { |limit| zero_eternity_limit_attrs < limit }
+      end
+
+      def zero_eternity_limit_attrs
+        { 'period' => 'eternity', 'value' => 0 }
+      end
+    end
+  end
+end

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

@@ -21,6 +21,20 @@ module ThreeScaleToolbox
           new(id: svc_obj.fetch('id'), remote: remote)
         end
 
+        # ref can be system_name or service_id
+        def find(remote:, ref:)
+          new(id: ref, remote: remote).tap(&:show_service)
+        rescue ThreeScale::API::HttpClient::NotFoundError
+          find_by_system_name(remote: remote, system_name: ref)
+        end
+
+        def find_by_system_name(remote:, system_name:)
+          service = remote.list_services.find { |svc| svc['system_name'] == system_name }
+          return if service.nil?
+
+          new(id: service.fetch('id'), remote: remote)
+        end
+
         private
 
         def create_service(remote:, service:)
@@ -94,18 +108,6 @@ module ThreeScaleToolbox
         remote.list_service_application_plans id
       end
 
-      def create_application_plan(plan)
-        remote.create_application_plan id, plan
-      end
-
-      def plan_limits(plan_id)
-        remote.list_application_plan_limits(plan_id)
-      end
-
-      def create_application_plan_limit(plan_id, metric_id, limit)
-        remote.create_application_plan_limit plan_id, metric_id, limit
-      end
-
       def mapping_rules
         remote.list_mapping_rules id
       end
@@ -149,6 +151,17 @@ module ThreeScaleToolbox
       def update_oidc(oidc_settings)
         remote.update_oidc(id, oidc_settings)
       end
+
+      def features
+        remote.list_service_features id
+      end
+
+      def create_feature(attrs)
+        # Workaround until issue is fixed: https://github.com/3scale/porta/issues/774
+        attrs['scope'] = 'ApplicationPlan' if attrs['scope'] == 'application_plan'
+        attrs['scope'] = 'ServicePlan' if attrs['scope'] == 'service_plan'
+        remote.create_service_feature id, attrs
+      end
     end
   end
 end

data/lib/3scale_toolbox/entities.rb

@@ -1 +1,2 @@
 require '3scale_toolbox/entities/service'
+require '3scale_toolbox/entities/application_plan'

data/lib/3scale_toolbox/helper.rb

@@ -33,11 +33,52 @@ module ThreeScaleToolbox
         uri_obj
       end
 
+      def hash_deep_dup(hash)
+        JSON.parse(JSON.generate(hash))
+      end
+
       def service_invalid_deployment_option?(error)
         Array(Hash(error)['deployment_option']).any? do |msg|
           msg.match(/is not included in the list/)
         end
       end
+
+      def system_name_already_taken_error?(error)
+        Array(Hash(error)['system_name']).any? { |msg| msg.match(/has already been taken/) }
+      end
+
+      def period_already_taken_error?(error)
+        Array(Hash(error)['period']).any? { |msg| msg.match(/has already been taken/) }
+      end
+    end
+
+    class BooleanTransformer
+      def call(param_str)
+        raise ArgumentError unless param_str.is_a?(String)
+
+        return true if true?(param_str)
+        return false if false?(param_str)
+
+        raise ArgumentError
+      end
+
+      def true?(param_str)
+        case param_str
+        when 'true', '1'
+          true
+        else
+          false
+        end
+      end
+
+      def false?(param_str)
+        case param_str
+        when 'false', '0'
+          true
+        else
+          false
+        end
+      end
     end
   end
 end

data/lib/3scale_toolbox/resource_reader.rb

@@ -0,0 +1,42 @@
+module ThreeScaleToolbox
+  module ResourceReader
+    ##
+    # Load resource from different types of sources.
+    # Supported types are: file, URL, stdin
+    # Loaded content is returned
+    def load_resource(resource)
+      # Json format is parsed as well
+      YAML.safe_load(read_content(resource))
+    rescue Psych::SyntaxError => e
+      raise ThreeScaleToolbox::Error, "JSON/YAML validation failed: #{e.message}"
+    end
+
+    ##
+    # Reads resources from different types of sources.
+    # Supported types are: file, URL, stdin
+    # Resource raw content is returned
+    def read_content(resource)
+      case resource
+      when '-'
+        method(:read_stdin)
+      when /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
+        method(:read_url)
+      else
+        method(:read_file)
+      end.call(resource)
+    end
+
+    # Detect format from file extension
+    def read_file(resource)
+      File.read(resource)
+    end
+
+    def read_stdin(_resource)
+      STDIN.read
+    end
+
+    def read_url(resource)
+      Net::HTTP.get(URI.parse(resource))
+    end
+  end
+end

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

@@ -13,7 +13,7 @@ module ThreeScaleToolbox
           if plan.delete('custom') # TODO: what to do with custom plans?
             puts "skipping custom plan #{plan}"
           else
-            target.create_application_plan(plan)
+            ThreeScaleToolbox::Entities::ApplicationPlan.create(service: target, plan_attrs: plan)
           end
         end
         puts "target service missing #{missing_plans.size} application plans"

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

@@ -8,27 +8,24 @@ module ThreeScaleToolbox
         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|
-          limits = source.plan_limits(plan_id)
-          limits_target = target.plan_limits(target_plan['id'])
-          missing_limits = missing_limits(limits, limits_target)
+          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.create_application_plan_limit(
-              target_plan['id'],
-              metrics_map.fetch(limit.fetch('metric_id')),
-              limit
-            )
+            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}"
+            "#{target_plan.id}. Source plan #{plan_id}"
         end
       end
 
       private
 
-      def missing_limits(source_limits, target_limits)
+      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'])
+          ThreeScaleToolbox::Helper.compare_hashes(limit, target, ['period']) &&
+            metrics_map.fetch(limit.fetch('metric_id')) == target.fetch('metric_id')
         end
       end
     end

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

@@ -10,7 +10,8 @@ module ThreeScaleToolbox
         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 = missing_pricing_rules(pricing_rules_source, pricing_rules_target,
+                                                        metrics_map)
           missing_pricing_rules.each do |pricing_rule|
             pricing_rule.delete('links')
             target.remote.create_pricingrule(
@@ -26,9 +27,10 @@ module ThreeScaleToolbox
 
       private
 
-      def missing_pricing_rules(source_pricing_rules, target_pricing_rules)
+      def missing_pricing_rules(source_pricing_rules, target_pricing_rules, metrics_map)
         ThreeScaleToolbox::Helper.array_difference(source_pricing_rules, target_pricing_rules) do |src, target|
-          ThreeScaleToolbox::Helper.compare_hashes(src, target, ['system_name'])
+          ThreeScaleToolbox::Helper.compare_hashes(src, target, %w[cost_per_unit min max]) &&
+            metrics_map.fetch(src.fetch('metric_id')) == target.fetch('metric_id')
         end
       end
     end

data/lib/3scale_toolbox/version.rb

@@ -1,3 +1,3 @@
 module ThreeScaleToolbox
-  VERSION = '0.8.0'
+  VERSION = '0.9.0'
 end

data/lib/3scale_toolbox.rb

@@ -1,7 +1,17 @@
+require 'json'
+require 'cri'
+require 'yaml'
+require 'uri'
+require 'time'
+require 'csv'
+require 'net/http'
+require '3scale/api'
+
 require '3scale_toolbox/version'
 require '3scale_toolbox/helper'
 require '3scale_toolbox/error'
 require '3scale_toolbox/proxy_logger'
+require '3scale_toolbox/resource_reader'
 require '3scale_toolbox/swagger'
 require '3scale_toolbox/configuration'
 require '3scale_toolbox/remotes'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: 3scale_toolbox
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Michal Cichra
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-04-12 00:00:00.000000000 Z
+date: 2019-05-07 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.9
+        version: 0.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.1.9
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: cri
   requirement: !ruby/object:Gem::Requirement
@@ -154,12 +154,33 @@ files:
 - lib/3scale_toolbox/commands/import_command/openapi/mapping_rule.rb
 - lib/3scale_toolbox/commands/import_command/openapi/method.rb
 - lib/3scale_toolbox/commands/import_command/openapi/operation.rb
-- lib/3scale_toolbox/commands/import_command/openapi/resource_reader.rb
 - lib/3scale_toolbox/commands/import_command/openapi/step.rb
 - lib/3scale_toolbox/commands/import_command/openapi/threescale_api_spec.rb
 - lib/3scale_toolbox/commands/import_command/openapi/update_policies_step.rb
 - lib/3scale_toolbox/commands/import_command/openapi/update_service_oidc_conf_step.rb
 - lib/3scale_toolbox/commands/import_command/openapi/update_service_proxy_step.rb
+- lib/3scale_toolbox/commands/plans_command.rb
+- 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_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_command.rb
+- lib/3scale_toolbox/commands/plans_command/list_command.rb
+- lib/3scale_toolbox/commands/plans_command/show_command.rb
 - lib/3scale_toolbox/commands/remote_command.rb
 - lib/3scale_toolbox/commands/remote_command/remote_add.rb
 - lib/3scale_toolbox/commands/remote_command/remote_list.rb
@@ -169,11 +190,13 @@ files:
 - lib/3scale_toolbox/commands/update_command/update_service.rb
 - lib/3scale_toolbox/configuration.rb
 - lib/3scale_toolbox/entities.rb
+- lib/3scale_toolbox/entities/application_plan.rb
 - lib/3scale_toolbox/entities/service.rb
 - lib/3scale_toolbox/error.rb
 - lib/3scale_toolbox/helper.rb
 - lib/3scale_toolbox/proxy_logger.rb
 - lib/3scale_toolbox/remotes.rb
+- lib/3scale_toolbox/resource_reader.rb
 - lib/3scale_toolbox/swagger.rb
 - lib/3scale_toolbox/swagger/swagger.rb
 - lib/3scale_toolbox/tasks.rb

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

@@ -1,51 +0,0 @@
-require 'uri'
-require 'net/http'
-
-module ThreeScaleToolbox
-  module Commands
-    module ImportCommand
-      module OpenAPI
-        module ResourceReader
-          ##
-          # Load resource from different types of sources.
-          # Supported types are: file, URL, stdin
-          # Loaded content is returned
-          def load_resource(resource)
-            # Json format is parsed as well
-            YAML.safe_load(read_content(resource))
-          rescue Psych::SyntaxError => e
-            raise ThreeScaleToolbox::Error, "JSON/YAML validation failed: #{e.message}"
-          end
-
-          ##
-          # Reads resources from different types of sources.
-          # Supported types are: file, URL, stdin
-          # Resource raw content is returned
-          def read_content(resource)
-            case resource
-            when '-'
-              method(:read_stdin)
-            when /\A#{URI::DEFAULT_PARSER.make_regexp}\z/
-              method(:read_url)
-            else
-              method(:read_file)
-            end.call(resource)
-          end
-
-          # Detect format from file extension
-          def read_file(resource)
-            File.read(resource)
-          end
-
-          def read_stdin(_resource)
-            STDIN.read
-          end
-
-          def read_url(resource)
-            Net::HTTP.get(URI.parse(resource))
-          end
-        end
-      end
-    end
-  end
-end