3scale_toolbox 0.9.0 → 0.10.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f2de44dc4f50140aaa326b714441c8590eb728f520835905091048911e2cd210
-  data.tar.gz: '008edc2978180ab0bda597b545b2c25f09712be036f1b372e6ae6f5c1c83df3e'
+  metadata.gz: a7b198d2a14662823d04de18bf2cc15b4e08b8b18e9900c888e54d2f7a72a3bb
+  data.tar.gz: fcda8a6926e72cd0a44485f912fc89debd59369e3296420c172f1a899546688b
 SHA512:
-  metadata.gz: 6db32b4a58ba23a8c0a1902ccf9002812effdefa6946e98883e748406e05c905a075ac13798fbed58461df834c419a4ad66b4c836edf02b510eb61cd8c7770fd
-  data.tar.gz: 3eba10df0a824a07d9edd63a88fa7896c1c5fcce7a43dc9e5aefcdb71d955053e858ef6f100319aea53c5a197b38ad0c047232e48c0e993b756ebca280894f08
+  metadata.gz: 95cbd6fb8d874ea31120d282d67ba5c61d3c5ef0a1d5df844844b7b0dfb8fd266dc0b62d486c2152896a692ff2243ee132a1617fc0ec07a94b21a13fab4251f9
+  data.tar.gz: 93a97483feb149fd5fc27049d75a883f8cae1bf95787e0b80cae14585db37396f46d55b7ef8614a016fd73c25e552a2bc82ea625c48ec6c502e07709fd12458c

data/README.md

@@ -14,10 +14,12 @@ See the LICENSE and NOTICE files that should have been provided along with this
    * [Copy a service](#copy-a-service)
    * [Update a service](#update-a-service)
    * [Import from CSV](#import-from-csv)
-   * [Import from OpenAPI definition](#import-openapi)
-   * [Export/Import Application Plan](#export-import-application-plan)
+   * [Import from OpenAPI definition](docs/openapi.md)
+   * [Export/Import Application Plan](docs/export-import-app-plan.md)
    * Create, Apply, List, Show, Delete [Application plan](docs/app-plan.md)
-   * [Remotes](#remotes)
+   * Create, Apply, List, Delete [Metric](docs/metric.md)
+   * Create, Apply, List, Delete [Method](docs/method.md)
+   * [Remotes](docs/remotes.md)
 * [Development](#development)
    * [Testing](#testing)
    * [Develop your own core command](#develop-core-command)
@@ -196,26 +198,6 @@ Example:
 3scale import csv --destination=https://provider_key@user-admin.3scale.net --file=examples/import_example.csv
 ```
 
-### Import OpenAPI
-
-Using an API definition format like OpenAPI, import to your 3scale API
-
-Currently, only OpenAPI __2.0__ specification (f.k.a. __swagger__) is supported.
-
-[Import from OpenAPI](docs/openapi.md)
-
-### Export Import Application Plan
-
-A single application plan can be exported/imported as `yaml` format.
-
-[Export/Import Application Plan](docs/export-import-app-plan.md)
-
-### Remotes
-
-Manage set of 3scale instances.
-
-[Howto](docs/remotes.md)
-
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. You can also run `bin/console` for an interactive prompt that will allow you to experiment. Run `bundle exec 3scale` to use the gem in this directory, ignoring other installed copies of this gem.

data/lib/3scale_toolbox/base_command.rb

@@ -1,4 +1,3 @@
-
 module ThreeScaleToolbox
   module Command
     def self.included(base)

data/lib/3scale_toolbox/commands.rb

@@ -5,6 +5,8 @@ require '3scale_toolbox/commands/import_command'
 require '3scale_toolbox/commands/update_command'
 require '3scale_toolbox/commands/remote_command'
 require '3scale_toolbox/commands/plans_command'
+require '3scale_toolbox/commands/metrics_command'
+require '3scale_toolbox/commands/methods_command'
 
 module ThreeScaleToolbox
   module Commands
@@ -15,6 +17,8 @@ module ThreeScaleToolbox
       ThreeScaleToolbox::Commands::UpdateCommand,
       ThreeScaleToolbox::Commands::RemoteCommand::RemoteCommand,
       ThreeScaleToolbox::Commands::PlansCommand,
+      ThreeScaleToolbox::Commands::MetricsCommand,
+      ThreeScaleToolbox::Commands::MethodsCommand,
     ].freeze
   end
 end

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

@@ -26,7 +26,7 @@ module ThreeScaleToolbox
 
           source_service = Entities::Service.new(id: arguments[:service_id],
                                                  remote: threescale_client(source))
-          target_service = create_new_service(source_service.show_service, destination)
+          target_service = create_new_service(source_service.attrs, destination)
           puts "new service id #{target_service.id}"
           context = create_context(source_service, target_service)
           tasks = [

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

@@ -32,7 +32,7 @@ module ThreeScaleToolbox
           private
 
           def activedocs_system_name
-            @activedocs_system_name ||= service.show_service['system_name']
+            @activedocs_system_name ||= service.attrs['system_name']
           end
 
           def find_activedocs_id
@@ -53,7 +53,7 @@ module ThreeScaleToolbox
             # Other processing steps can work with original openapi spec
             Helper.hash_deep_dup(resource).tap do |activedocs|
               # public production base URL
-              URI(service.show_proxy.fetch('endpoint')).tap do |uri|
+              URI(service.proxy.fetch('endpoint')).tap do |uri|
                 activedocs['host'] = "#{uri.host}:#{uri.port}"
                 activedocs['schemes'] = [uri.scheme]
               end

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

@@ -6,30 +6,36 @@ module ThreeScaleToolbox
           include Step
 
           def call
-            hits_metric_id = service.hits['id']
-            operations.each do |op|
-              res = service.create_method(hits_metric_id, op.method)
-              metric_id = res['id']
-              # if method system_name exists, ignore error and get metric_id
-              # Make operation indempotent
-              if (errors = res['errors'])
-                raise ThreeScaleToolbox::Error, "Metohd has not been saved. #{errors}" \
-                  unless ThreeScaleToolbox::Helper.system_name_already_taken_error? errors
-
-                metric_id = method_id_by_system_name[op.method['system_name']]
-              end
+            missing_operations.each do |op|
+              method = Entities::Method.create(service: service, parent_id: hits_metric_id,
+                                               attrs: op.method)
+              op.set(:metric_id, method.id)
+            end
 
-              op.set(:metric_id, metric_id)
+            existing_operations.each do |op|
+              op.set(:metric_id, service_methods_index.fetch(op.method['system_name']))
             end
           end
 
           private
 
-          def method_id_by_system_name
-            @method_id_by_system_name ||= service.methods.each_with_object({}) do |method, acc|
+          def hits_metric_id
+            @hits_metric_id ||= service.hits['id']
+          end
+
+          def service_methods_index
+            @service_methods_index ||= service.methods(hits_metric_id).each_with_object({}) do |method, acc|
               acc[method['system_name']] = method['id']
             end
           end
+
+          def missing_operations
+            operations.reject { |op| service_methods_index.key? op.method['system_name'] }
+          end
+
+          def existing_operations
+            operations.select { |op| service_methods_index.key? op.method['system_name'] }
+          end
         end
       end
     end

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

@@ -9,22 +9,19 @@ module ThreeScaleToolbox
           # Creates service with a given system_name
           # If service already exists, update basic settings like name and description
           def call
-            # Create service and update context
-            self.service = Entities::Service.create(remote: threescale_client,
-                                                    service: service_settings,
-                                                    system_name: service_system_name)
-            puts "Created service id: #{service.id}, name: #{service_name}"
-          rescue ThreeScaleToolbox::Error => e
-            raise unless e.message =~ /"system_name"=>\["has already been taken"\]/
-
             # Update service and update context
             self.service = Entities::Service.find_by_system_name(remote: threescale_client,
                                                                  system_name: service_system_name)
-            # It should exist
-            raise ThreeScaleToolbox::Error, "Service with system_name: #{service_system_name}, should exist" if service.nil?
-
-            service.update_service(service_settings)
-            puts "Updated service id: #{service.id}, name: #{service_name}"
+            if service.nil?
+              # Create service and update context
+              self.service = Entities::Service.create(remote: threescale_client,
+                                                      service: service_settings,
+                                                      system_name: service_system_name)
+              puts "Created service id: #{service.id}, name: #{service_name}"
+            else
+              service.update(service_settings)
+              puts "Updated service id: #{service.id}, name: #{service_name}"
+            end
           end
 
           private

data/lib/3scale_toolbox/commands/methods_command.rb

@@ -0,0 +1,28 @@
+require '3scale_toolbox/commands/methods_command/create_command'
+require '3scale_toolbox/commands/methods_command/list_command'
+require '3scale_toolbox/commands/methods_command/apply_command'
+require '3scale_toolbox/commands/methods_command/delete_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module MethodsCommand
+      include ThreeScaleToolbox::Command
+      def self.command
+        Cri::Command.define do
+          name        'methods'
+          usage       'methods <sub-command> [options]'
+          summary     'methods super command'
+          description 'Methods commands'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+      add_subcommand(Create::CreateSubcommand)
+      add_subcommand(List::ListSubcommand)
+      add_subcommand(Apply::ApplySubcommand)
+      add_subcommand(Delete::DeleteSubcommand)
+    end
+  end
+end

data/lib/3scale_toolbox/commands/methods_command/apply_command.rb

@@ -0,0 +1,101 @@
+module ThreeScaleToolbox
+  module Commands
+    module MethodsCommand
+      module Apply
+        class ApplySubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'apply'
+              usage       'apply [opts] <remote> <service> <method>'
+              summary     'Update method'
+              description 'Update (create if it does not exist) method'
+
+              option      :n, :name, 'Method name', argument: :required
+              flag        nil, :disabled, 'Disables this method in all application plans'
+              flag        nil, :enabled, 'Enables this method in all application plans'
+              option      nil, :description, 'Method description', argument: :required
+              param       :remote
+              param       :service_ref
+              param       :method_ref
+
+              runner ApplySubcommand
+            end
+          end
+
+          def run
+            validate_option_params
+            hits = service.hits
+            method = Entities::Method.find(service: service, parent_id: hits.fetch('id'),
+                                           ref: method_ref)
+            if method.nil?
+              method = Entities::Method.create(service: service, parent_id: hits.fetch('id'),
+                                               attrs: create_method_attrs)
+            else
+              method.update(method_attrs) unless method_attrs.empty?
+            end
+
+            method.disable if option_disabled
+            method.enable if option_enabled
+
+            output_msg_array = ["Applied method id: #{method.id}"]
+            output_msg_array << 'Disabled' if option_disabled
+            output_msg_array << 'Enabled' if option_enabled
+            puts output_msg_array.join('; ')
+          end
+
+          private
+
+          def validate_option_params
+            raise ThreeScaleToolbox::Error, '--disabled and --enabled are mutually exclusive' \
+              if option_enabled && option_disabled
+          end
+
+          def create_method_attrs
+            method_attrs.merge('system_name' => method_ref,
+                               'friendly_name' => method_ref) { |_key, oldval, _newval| oldval }
+          end
+
+          def method_attrs
+            {
+              'friendly_name' => options[:name],
+              'description' => options[:description]
+            }.compact
+          end
+
+          def option_enabled
+            !options[:enabled].nil?
+          end
+
+          def option_disabled
+            !options[:disabled].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
+
+          def method_ref
+            arguments[:method_ref]
+          end
+        end
+      end
+    end
+  end
+end

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

@@ -0,0 +1,73 @@
+module ThreeScaleToolbox
+  module Commands
+    module MethodsCommand
+      module Create
+        class CreateSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'create'
+              usage       'create [opts] <remote> <service> <method-name>'
+              summary     'create method'
+              description 'Create method'
+
+              option      :t, 'system-name', 'Method system name', argument: :required
+              flag        nil, :disabled, 'Disables this method in all application plans'
+              option      nil, :description, 'Method description', argument: :required
+              param       :remote
+              param       :service_ref
+              param       :method_name
+
+              runner CreateSubcommand
+            end
+          end
+
+          def run
+            hits = service.hits
+            method = ThreeScaleToolbox::Entities::Method.create(
+              service: service,
+              parent_id: hits.fetch('id'),
+              attrs: method_attrs
+            )
+            method.disable if option_disabled
+            puts "Created method id: #{method.id}. Disabled: #{option_disabled}"
+          end
+
+          private
+
+          def method_attrs
+            {
+              'system_name' => options[:'system-name'],
+              'friendly_name' => arguments[:method_name],
+              'description' => options[:description]
+            }.compact
+          end
+
+          def option_disabled
+            !options[:disabled].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/methods_command/delete_command.rb

@@ -0,0 +1,67 @@
+module ThreeScaleToolbox
+  module Commands
+    module MethodsCommand
+      module Delete
+        class DeleteSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'delete'
+              usage       'delete [opts] <remote> <service> <method>'
+              summary     'delete method'
+              description 'Delete method'
+
+              param       :remote
+              param       :service_ref
+              param       :method_ref
+
+              runner DeleteSubcommand
+            end
+          end
+
+          def run
+            method.delete
+            puts "Method id: #{method.id} deleted"
+          end
+
+          private
+
+          def service
+            @service ||= find_service
+          end
+
+          def method
+            @method ||= find_method
+          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_method
+            hits = service.hits
+            Entities::Method.find(service: service, parent_id: hits.fetch('id'), ref: method_ref).tap do |p|
+              raise ThreeScaleToolbox::Error, "Method #{method_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 method_ref
+            arguments[:method_ref]
+          end
+        end
+      end
+    end
+  end
+end