3scale_toolbox 0.8.0 → 0.9.0

data/lib/3scale_toolbox/commands/plans_command/create_command.rb

@@ -0,0 +1,100 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Create
+        class CreateSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'create'
+              usage       'create [opts] <remote> <service> <plan_name>'
+              summary     'create application plan'
+              description 'Create application plan'
+
+              option      :t, 'system-name', 'Application plan system name', argument: :required
+              flag        nil, :default, 'Make default application plan'
+              flag        nil, :disabled, 'Disables all methods and metrics in this application plan'
+              flag        :p, :publish, 'Publish application plan'
+              option      nil, 'approval-required', 'Applications require approval. true or false', argument: :required, transform: ThreeScaleToolbox::Helper::BooleanTransformer.new
+              option      nil, 'cost-per-month', 'Cost per month', argument: :required, transform: method(:Integer)
+              option      nil, 'setup-fee', 'Setup fee', argument: :required, transform: method(:Integer)
+              option      nil, 'trial-period-days', 'Trial period days', argument: :required, transform: method(:Integer)
+              option      nil, 'end-user-required', 'End user required. true or false', argument: :required, transform: ThreeScaleToolbox::Helper::BooleanTransformer.new
+              param       :remote
+              param       :service_ref
+              param       :plan_name
+
+              runner CreateSubcommand
+            end
+          end
+
+          def run
+            plan = create_application_plan
+            plan.make_default if option_default
+            plan.disable if option_disabled
+            puts "Created application plan id: #{plan.id}. Default: #{option_default}; Disabled: #{option_disabled}"
+          end
+
+          private
+
+          def create_application_plan
+            ThreeScaleToolbox::Entities::ApplicationPlan.create(
+              service: service,
+              plan_attrs: plan_attrs
+            )
+          end
+
+          def plan_attrs
+            plan_basic_attrs.tap do |params|
+              params['state'] = 'published' if option_publish
+            end
+          end
+
+          def plan_basic_attrs
+            {
+              'name' => arguments[:plan_name],
+              'system_name' => options[:'system-name'],
+              'approval_required' => options[:'approval-required'],
+              'end_user_required' => options[:'end-user-required'],
+              'cost_per_month' => options[:'cost-per-month'],
+              'setup_fee' => options[:'setup-fee'],
+              'trial_period_days' => options[:'trial-period-days']
+            }.compact
+          end
+
+          def option_default
+            !options[:default].nil?
+          end
+
+          def option_disabled
+            !options[:disabled].nil?
+          end
+
+          def option_publish
+            !options[:publish].nil?
+          end
+
+          def service
+            @service ||= find_service
+          end
+
+          def find_service
+            Entities::Service.find(remote: remote,
+                                   ref: service_ref).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{service_ref} does not exist" if svc.nil?
+            end
+          end
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/delete_command.rb

@@ -0,0 +1,66 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Delete
+        class DeleteSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'delete'
+              usage       'delete [opts] <remote> <service> <plan>'
+              summary     'delete application plan'
+              description 'Delete application plan'
+
+              param       :remote
+              param       :service_ref
+              param       :plan_ref
+
+              runner DeleteSubcommand
+            end
+          end
+
+          def run
+            plan.delete
+            puts "Application plan id: #{plan.id} deleted"
+          end
+
+          private
+
+          def service
+            @service ||= find_service
+          end
+
+          def plan
+            @plan ||= find_plan
+          end
+
+          def find_service
+            Entities::Service.find(remote: remote,
+                                   ref: service_ref).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{service_ref} does not exist" if svc.nil?
+            end
+          end
+
+          def find_plan
+            Entities::ApplicationPlan.find(service: service, ref: plan_ref).tap do |p|
+              raise ThreeScaleToolbox::Error, "Application plan #{plan_ref} does not exist" if p.nil?
+            end
+          end
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def service_ref
+            arguments[:service_ref]
+          end
+
+          def plan_ref
+            arguments[:plan_ref]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/read_app_plan_step.rb

@@ -0,0 +1,16 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class ReadAppPlanStep
+          include Step
+          ##
+          # Reads Application plan
+          def call
+            result[:plan] = plan.show
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_features_step.rb

@@ -0,0 +1,16 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class ReadPlanFeaturesStep
+          include Step
+          ##
+          # Reads Application Plan features
+          def call
+            result[:plan_features] = plan.features
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_limits_step.rb

@@ -0,0 +1,19 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class ReadPlanLimitsStep
+          include Step
+          ##
+          # Reads Application Plan limits
+          # add metric system_name out of metric_id
+          def call
+            result[:limits] = plan.limits.map do |limit|
+              limit.tap { |l| l['metric'] = metric_info(l, 'Limit') }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_methods_step.rb

@@ -0,0 +1,50 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class ReadPlanMethods
+          include Step
+          ##
+          # Compute unique list of methods from limits and pricingrules
+          def call
+            methods = [
+              limit_methods,
+              pricingrule_methods
+            ]
+            result[:plan_methods] = methods.each_with_object({}) { |elem, acc| acc.merge!(elem) }
+          end
+
+          private
+
+          def limit_methods
+            # multiple limits can reference the same method
+            filtered_limit_methods.each_with_object({}) do |elem, acc|
+              # find_method should not return nil.
+              # It is assumed that metric_id refers to existing element from previous steps
+              acc[elem['metric_id']] = find_method(elem['metric_id'])
+            end
+          end
+
+          def filtered_limit_methods
+            # has to be filtered this way
+            # looking up in metrics list does not work. Metric list includes methods and metrics
+            result[:limits].select { |limit| limit.dig('metric', 'type') == 'method' }
+          end
+
+          def pricingrule_methods
+            filtered_pricing_rule_methods.each_with_object({}) do |elem, acc|
+              # find_method should not return nil.
+              # It is assumed that metric_id refers to existing element from previous steps
+              acc[elem['metric_id']] = find_method(elem['metric_id'])
+            end
+          end
+
+          def filtered_pricing_rule_methods
+            # looking up in metrics list does not work. Metric list includes methods and metrics
+            result[:pricingrules].select { |limit| limit.dig('metric', 'type') == 'method' }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_metrics_step.rb

@@ -0,0 +1,49 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class ReadPlanMetrics
+          include Step
+          ##
+          # Compute unique list of metrics limits and pricingrules
+          def call
+            all_metrics = [
+              limit_metrics,
+              pricingrule_metrics
+            ]
+            result[:plan_metrics] = all_metrics.each_with_object({}) { |elem, acc| acc.merge!(elem) }
+          end
+
+          private
+
+          def limit_metrics
+            # multiple limits can reference the same metric
+            filtered_limit_metrics.each_with_object({}) do |elem, acc|
+              # find_metric should not return nil.
+              # It is assumed that metric_id refers to existing element from previous steps
+              acc[elem['metric_id']] = find_metric(elem['metric_id'])
+            end
+          end
+
+          def filtered_limit_metrics
+            # looking up in metrics list does not work. Metric list includes methods and metrics
+            result[:limits].select { |limit| limit.dig('metric', 'type') == 'metric' }
+          end
+
+          def pricingrule_metrics
+            filtered_pricing_rule_metrics.each_with_object({}) do |elem, acc|
+              # find_metric should not return nil.
+              # It is assumed that metric_id refers to existing element from previous steps
+              acc[elem['metric_id']] = find_metric(elem['metric_id'])
+            end
+          end
+
+          def filtered_pricing_rule_metrics
+            # looking up in metrics list does not work. Metric list includes methods and metrics
+            result[:pricingrules].select { |limit| limit.dig('metric', 'type') == 'metric' }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/read_plan_pricing_rules_step.rb

@@ -0,0 +1,19 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class ReadPlanPricingRulesStep
+          include Step
+          ##
+          # Reads Application Plan pricing rules
+          # add metric system_name out of metric_id
+          def call
+            result[:pricingrules] = plan.pricing_rules.map do |pr|
+              pr.tap { |e| e['metric'] = metric_info(e, 'PricingRule') }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/step.rb

@@ -0,0 +1,95 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        APP_PLANS_BLACKLIST = %w[id links default custom created_at updated_at].freeze
+        LIMITS_BLACKLIST = %w[id metric_id links created_at updated_at].freeze
+        PRICINGRULES_BLACKLIST = %w[id metric_id links created_at updated_at].freeze
+        PLAN_FEATURE_BLACKLIST = %w[id links created_at updated_at].freeze
+        METRIC_BLACKLIST = %w[id links created_at updated_at].freeze
+
+        module Step
+          attr_reader :context
+
+          def initialize(context)
+            @context = context
+          end
+
+          def service
+            context[:service] ||= find_service
+          end
+
+          def file
+            context[:file]
+          end
+
+          def threescale_client
+            context[:threescale_client]
+          end
+
+          # can be id or system_name
+          def service_system_name
+            context[:service_system_name]
+          end
+
+          # can be id or system_name
+          def plan_system_name
+            context[:plan_system_name]
+          end
+
+          def result
+            context[:result] ||= {}
+          end
+
+          def plan
+            context[:plan] ||= find_plan
+          end
+
+          def service_metrics
+            context[:service_metrics] ||= service.metrics
+          end
+
+          def service_methods
+            context[:service_methods] ||= service.methods
+          end
+
+          def metric_info(elem, elem_name)
+            # Methods are included in metrics.
+            # First methods must be checked, otherwise it could be considered as a false metric
+            if (method = find_method(elem.fetch('metric_id')))
+              { 'type' => 'method', 'system_name' => method.fetch('system_name') }
+            elsif (metric = find_metric(elem.fetch('metric_id')))
+              { 'type' => 'metric', 'system_name' => metric.fetch('system_name') }
+            else
+              raise ThreeScaleToolbox::Error, "Unexpected error. #{elem_name} #{elem['id']} " \
+                "referencing to metric id #{elem.fetch('metric_id')} which has not been found"
+            end
+          end
+
+          private
+
+          def find_service
+            Entities::Service.find(remote: threescale_client,
+                                   ref: service_system_name).tap do |svc|
+              raise ThreeScaleToolbox::Error, "Service #{service_system_name} does not exist" if svc.nil?
+            end
+          end
+
+          def find_plan
+            Entities::ApplicationPlan.find(service: service, ref: plan_system_name).tap do |p|
+              raise ThreeScaleToolbox::Error, "Application plan #{plan_system_name} does not exist" if p.nil?
+            end
+          end
+
+          def find_metric(id)
+            service_metrics.find { |metric| metric['id'] == id }
+          end
+
+          def find_method(id)
+            service_methods.find { |method| method['id'] == id }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export/write_artifacts_file_step.rb

@@ -0,0 +1,84 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class WriteArtifactsStep
+          include Step
+          ##
+          # Serialization of Application Plan objects
+          def call
+            select_output do |output|
+              output.write(serialized_object.to_yaml)
+            end
+          end
+
+          private
+
+          def select_output
+            ios = if file
+                    File.open(file, 'w')
+                  else
+                    $stdout
+                  end
+            begin
+              yield(ios)
+            ensure
+              ios.close
+            end
+          end
+
+          def serialized_object
+            {
+              'plan' => serialized_plan,
+              'limits' => serialized_limits,
+              'pricingrules' => serialized_pricing_rules,
+              'plan_features' => serialized_plan_features,
+              'metrics' => serialized_metrics,
+              'methods' => serialized_methods,
+              'created_at' => Time.now.utc.iso8601,
+              'toolbox_version' => ThreeScaleToolbox::VERSION
+            }
+          end
+
+          def serialized_plan
+            result[:plan].reject { |key, _| APP_PLANS_BLACKLIST.include? key }
+          end
+
+          def serialized_limits
+            result[:limits].map do |limit|
+              metric = limit.delete('metric')
+              limit['metric_system_name'] = metric['system_name']
+              limit.reject { |key, _| LIMITS_BLACKLIST.include? key }
+            end
+          end
+
+          def serialized_pricing_rules
+            result[:pricingrules].map do |pr|
+              metric = pr.delete('metric')
+              pr['metric_system_name'] = metric['system_name']
+              pr.reject { |key, _| PRICINGRULES_BLACKLIST.include? key }
+            end
+          end
+
+          def serialized_plan_features
+            result[:plan_features].map do |pr|
+              pr.reject { |key, _| PLAN_FEATURE_BLACKLIST.include? key }
+            end
+          end
+
+          def serialized_metrics
+            result[:plan_metrics].values.map do |metric|
+              metric.reject { |key, _| METRIC_BLACKLIST.include? key }
+            end
+          end
+
+          def serialized_methods
+            result[:plan_methods].values.map do |method|
+              method.reject { |key, _| METRIC_BLACKLIST.include? key }
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/export_command.rb

@@ -0,0 +1,65 @@
+require '3scale_toolbox/commands/plans_command/export/step'
+require '3scale_toolbox/commands/plans_command/export/read_app_plan_step'
+require '3scale_toolbox/commands/plans_command/export/read_plan_features_step'
+require '3scale_toolbox/commands/plans_command/export/read_plan_limits_step'
+require '3scale_toolbox/commands/plans_command/export/read_plan_pricing_rules_step'
+require '3scale_toolbox/commands/plans_command/export/read_plan_methods_step'
+require '3scale_toolbox/commands/plans_command/export/read_plan_metrics_step'
+require '3scale_toolbox/commands/plans_command/export/write_artifacts_file_step'
+
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Export
+        class ExportSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'export'
+              usage       'export [opts] <remote> <service_system_name> <plan_system_name>'
+              summary     'export application plan'
+              description 'Export application plan, limits, pricing rules and features'
+
+              option      :f, :file, 'Write to file instead of stdout', argument: :required
+              param       :remote
+              param       :service_system_name
+              param       :plan_system_name
+
+              runner ExportSubcommand
+            end
+          end
+
+          def run
+            tasks = []
+            tasks << ReadAppPlanStep.new(context)
+            tasks << ReadPlanLimitsStep.new(context)
+            tasks << ReadPlanPricingRulesStep.new(context)
+            tasks << ReadPlanFeaturesStep.new(context)
+            tasks << ReadPlanMethods.new(context)
+            tasks << ReadPlanMetrics.new(context)
+            tasks << WriteArtifactsStep.new(context)
+
+            # run tasks
+            tasks.each(&:call)
+          end
+
+          private
+
+          def context
+            @context ||= create_context
+          end
+
+          def create_context
+            {
+              file: options[:file],
+              threescale_client: threescale_client(arguments[:remote]),
+              service_system_name: arguments[:service_system_name],
+              plan_system_name: arguments[:plan_system_name],
+            }
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/import/create_or_update_app_plan_step.rb

@@ -0,0 +1,33 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Import
+        class CreateOrUpdateAppPlanStep
+          include Step
+          ##
+          # Creates if it does not exist, updates otherwise
+          def call
+            plan_obj = Entities::ApplicationPlan.find(service: service, ref: plan_system_name)
+            if plan_obj.nil?
+              plan_obj = Entities::ApplicationPlan.create(service: service, plan_attrs: plan_attrs)
+              puts "Application plan created: #{plan_obj.id}"
+            else
+              res = plan_obj.update(plan_attrs)
+              if (errors = res['errors'])
+                raise ThreeScaleToolbox::Error, "Could not update application plan #{plan_system_name}. Errors: #{errors}"
+              end
+
+              puts "Application plan updated: #{plan_obj.id}"
+            end
+          end
+
+          private
+
+          def plan_attrs
+            resource_plan.merge('system_name' => plan_system_name)
+          end
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands/plans_command/import/import_plan_features_step.rb

@@ -0,0 +1,45 @@
+module ThreeScaleToolbox
+  module Commands
+    module PlansCommand
+      module Import
+        class ImportPlanFeaturesStep
+          include Step
+          ##
+          # Writes Plan features
+          def call
+            missing_features.each do |feature|
+              create_plan_feature(feature)
+              puts "Created plan feature: #{feature}"
+            end
+          end
+
+          private
+
+          def missing_features
+            ThreeScaleToolbox::Helper.array_difference(resource_features, plan.features) do |a, b|
+              ThreeScaleToolbox::Helper.compare_hashes(a, b, ['system_name'])
+            end
+          end
+
+          def create_plan_feature(feature_attrs)
+            feature = find_feature_by_system_name(feature_attrs['system_name']) || create_service_feature(feature_attrs)
+
+            plan.create_feature(feature['id']).tap do |resp|
+              if (errors = resp['errors'])
+                raise ThreeScaleToolbox::Error, "Plan feature has not been created. #{errors}"
+              end
+            end
+          end
+
+          def create_service_feature(feature_attrs)
+            service.create_feature(feature_attrs).tap do |resp|
+              if (errors = resp['errors'])
+                raise ThreeScaleToolbox::Error, "Service feature has not been created. #{errors}"
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end