3scale_toolbox 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf0d2a187e793d654f6e6cef6990cfabaada5072f3a72b9820b1fed1ac13ddfb
-  data.tar.gz: c1b56e8e76059e0143444ff9ef12da633b97ef74b0fccb6875480be8b22cf9e6
+  metadata.gz: 77ce2f220c416d634541773317d35da8018a75d7e3d91c009338b7a971614eee
+  data.tar.gz: 4d5ee60b4cc55c0ba002fc007ba578801012c9c5580b4fe540f03c3c9dbb2d26
 SHA512:
-  metadata.gz: f2bf8c3a1f5860a3c6d24fa5fbc976b9b3361ea8ef6a57bbc0707d5f3900a31d8022e9596080bf8129d47116d13d3ab4d2ae7bfc41e246d179adf0f757c7c598
-  data.tar.gz: 3a206838d82a662f56276e7d98291cf74f5bc69eb9f39de239bb3d15f457e62b81e336ee1d0438a508fdecc46f692b49610627ef6413d05788b4c9f1a8c3f2e5
+  metadata.gz: 947d84f88a8b8e673ea313ba79a3e72eda4b03b85af30f12003b8c6b867f98addf8bc0eebea2e4a3c3bdbc64f80f241346c0e70bdb2ec9e5e9b3a698ab539438
+  data.tar.gz: 106e99be0a64a27284d6b7a64b796ac0ef6b14e30011b3d42366d1e6494e9f623fdb6221924204830e4e9dbb59a6086b0aac8601a4e7b5a968a59f9bfaefed61

data/3scale_toolbox.gemspec

@@ -36,7 +36,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.4'
   spec.required_ruby_version = '>= 2.5'
 
-  spec.add_dependency '3scale-api', '~> 0.6.0'
+  spec.add_dependency '3scale-api', '~> 1.0'
   spec.add_dependency 'cri', '~> 2.15'
   spec.add_dependency 'json-schema', '~> 2.8'
   spec.add_dependency 'oas_parser', '~> 0.20'

data/README.md

@@ -12,7 +12,9 @@ See the LICENSE and NOTICE files that should have been provided along with this
 * [Requirements](#requirements)
 * [Installation](#installation)
 * [Usage](#usage)
-   * [Copy a service](docs/copy-service.md)
+   * [Copy service](docs/copy-service.md)
+   * [Copy backend](docs/copy-backend.md)
+   * [Copy product](docs/copy-product.md)
    * [Import from CSV](docs/import-csv.md)
    * [Import from OpenAPI definition](docs/openapi.md)
    * [Export/Import Application Plan](docs/export-import-app-plan.md)
@@ -73,6 +75,7 @@ COMMANDS
     activedocs           activedocs super command
     application          application super command
     application-plan     application-plan super command
+    backend              backend super command
     copy                 copy super command
     help                 show help
     import               import super command

data/lib/3scale_toolbox.rb

@@ -20,7 +20,6 @@ require '3scale_toolbox/configuration'
 require '3scale_toolbox/remotes'
 require '3scale_toolbox/3scale_client_factory'
 require '3scale_toolbox/entities'
-require '3scale_toolbox/tasks'
 require '3scale_toolbox/attribute_filters'
 require '3scale_toolbox/base_command'
 require '3scale_toolbox/openapi'

data/lib/3scale_toolbox/cli.rb

@@ -1,4 +1,8 @@
 require '3scale_toolbox/cli/error_handler'
+require '3scale_toolbox/cli/json_printer'
+require '3scale_toolbox/cli/yaml_printer'
+require '3scale_toolbox/cli/custom_table_printer'
+require '3scale_toolbox/cli/output_flag'
 
 module ThreeScaleToolbox::CLI
   def self.root_command

data/lib/3scale_toolbox/cli/custom_table_printer.rb

@@ -0,0 +1,32 @@
+module ThreeScaleToolbox
+  module CLI
+    class CustomTablePrinter
+      attr_reader :fields
+
+      def initialize(fields)
+        @fields = fields
+      end
+
+      def print_record(record)
+        print_collection([record])
+      end
+
+      def print_collection(collection)
+        print_header
+        print_data(collection)
+      end
+
+      private
+
+      def print_header
+        puts fields.map(&:upcase).join("\t")
+      end
+
+      def print_data(collection)
+        collection.each do |obj|
+          puts fields.map { |field| obj.fetch(field, '(empty)').to_s }.join("\t")
+        end
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/cli/json_printer.rb

@@ -0,0 +1,13 @@
+module ThreeScaleToolbox
+  module CLI
+    class JsonPrinter
+      def print_record(record)
+        puts JSON.pretty_generate(record)
+      end
+
+      def print_collection(collection)
+        puts JSON.pretty_generate(collection)
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/cli/output_flag.rb

@@ -0,0 +1,20 @@
+module ThreeScaleToolbox
+  module CLI
+    class PrinterTransformer
+      def call(output_format)
+        raise unless %w[yaml json].include?(output_format)
+
+        case output_format
+        when 'yaml'
+          YamlPrinter.new
+        when 'json'
+          JsonPrinter.new
+        end
+      end
+    end
+
+    def self.output_flag(dsl)
+      dsl.option :o, :output, 'Output format. One of: json|yaml', argument: :required, transform: PrinterTransformer.new
+    end
+  end
+end

data/lib/3scale_toolbox/cli/yaml_printer.rb

@@ -0,0 +1,13 @@
+module ThreeScaleToolbox
+  module CLI
+    class YamlPrinter
+      def print_record(record)
+        puts YAML.dump(record)
+      end
+
+      def print_collection(collection)
+        puts YAML.dump(collection)
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/commands.rb

@@ -1,6 +1,5 @@
 require '3scale_toolbox/commands/3scale_command'
 require '3scale_toolbox/commands/help_command'
-require '3scale_toolbox/commands/copy_command'
 require '3scale_toolbox/commands/import_command'
 require '3scale_toolbox/commands/update_command'
 require '3scale_toolbox/commands/remote_command'
@@ -8,11 +7,14 @@ require '3scale_toolbox/commands/plans_command'
 require '3scale_toolbox/commands/metrics_command'
 require '3scale_toolbox/commands/methods_command'
 require '3scale_toolbox/commands/service_command'
+require '3scale_toolbox/commands/copy_command'
 require '3scale_toolbox/commands/activedocs_command'
 require '3scale_toolbox/commands/account_command'
 require '3scale_toolbox/commands/proxy_config_command'
 require '3scale_toolbox/commands/policy_registry_command'
 require '3scale_toolbox/commands/application_command'
+require '3scale_toolbox/commands/backend_command'
+require '3scale_toolbox/commands/product_command'
 
 module ThreeScaleToolbox
   module Commands
@@ -31,6 +33,8 @@ module ThreeScaleToolbox
       ThreeScaleToolbox::Commands::ProxyConfigCommand,
       ThreeScaleToolbox::Commands::PolicyRegistryCommand,
       ThreeScaleToolbox::Commands::ApplicationCommand,
+      ThreeScaleToolbox::Commands::BackendCommand,
+      ThreeScaleToolbox::Commands::ProductCommand,
     ].freeze
   end
 end

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

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module ActiveDocsCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_publish, :option_hide
+
+          def initialize(options)
+            @option_publish = options[:publish]
+            @option_hide = options[:hide]
+          end
+
+          def print_record(active_docs)
+            output_msg_array = ["Applied ActiveDocs id: #{active_docs['id']}"]
+            output_msg_array << 'Published' if option_publish
+            output_msg_array << 'Hidden' if option_hide
+            puts output_msg_array.join(';')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
           include ThreeScaleToolbox::ResourceReader
@@ -12,10 +30,6 @@ module ThreeScaleToolbox
               usage       'apply <remote> <activedocs_id_or_system_name>'
               summary     'Update activedocs'
               description 'Create or update an ActiveDocs'
-              runner ApplySubcommand
-
-              param   :remote
-              param   :activedocs_id_or_system_name
 
               option :i, :'service-id', "Specify the Service ID associated to the ActiveDocs", argument: :required
               option :p, :'publish', "Specify it to publish the ActiveDocs on the Developer Portal. Otherwise it will be hidden", argument: :forbidden
@@ -24,22 +38,26 @@ module ThreeScaleToolbox
               option :d, :'description', "Specify the description of the ActiveDocs", argument: :required
               option :s, :'name', "Specify the name of the ActiveDocs", argument: :required
               option nil, :'openapi-spec', "Specify the swagger spec. Can be a file, an URL or '-' to read from stdin. This option is mandatory when applying the ActiveDoc for the first time", argument: :required
+
+              param   :remote
+              param   :activedocs_id_or_system_name
+
+              ThreeScaleToolbox::CLI.output_flag(self)
+
+              runner ApplySubcommand
             end
           end
 
           def run
-            res = activedocs
             validate_option_params
+            res = activedocs
             if !res
-              res = Entities::ActiveDocs::create(remote: remote, attrs: create_activedocs_attrs)
+              res = Entities::ActiveDocs.create(remote: remote, attrs: create_activedocs_attrs)
             else
               res.update(activedocs_attrs) unless activedocs_attrs.empty?
             end
 
-            output_msg_array = ["Applied ActiveDocs id: #{res.id}"]
-            output_msg_array << "Published" if option_publish
-            output_msg_array << "Hidden" if option_hide
-            puts output_msg_array.join(";")
+            printer.print_record res.attrs
           end
 
           private
@@ -120,6 +138,11 @@ module ThreeScaleToolbox
               "body" => activedocs_json_spec,
             ) { |_key, oldval, _newval| oldval } # receiver of the merge message has key priority
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(publish: option_publish, hide: option_hide))
+          end
         end
       end
     end

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

@@ -2,6 +2,14 @@ module ThreeScaleToolbox
   module Commands
     module ActiveDocsCommand
       module Create
+        class CustomPrinter
+          def print_record(activedocs)
+            puts "ActiveDocs '#{activedocs['name']}' has been created with ID: #{activedocs['id']}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
           include ThreeScaleToolbox::ResourceReader
@@ -12,23 +20,25 @@ module ThreeScaleToolbox
               usage       'create <remote> <activedocs-name> <spec>'
               summary     'Create an ActiveDocs'
               description 'Create an ActiveDocs'
-              runner CreateSubcommand
-
-              param   :remote
-              param   :activedocs_name
-              param   :activedocs_spec
 
               option :i, :'service-id', "Specify the Service ID associated to the ActiveDocs", argument: :required
               option :p, :'published', "Specify it to publish the ActiveDoc on the Developer Portal. Otherwise it will be hidden", argument: :forbidden
               option nil, :'skip-swagger-validations', "Specify it to skip validation of the Swagger specification", argument: :forbidden
               option :d, :'description', "Specify the description of the ActiveDocs", argument: :required
               option :s, :'system-name', "Specify the system-name of the ActiveDocs", argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
+              param   :remote
+              param   :activedocs_name
+              param   :activedocs_spec
+
+              runner CreateSubcommand
             end
           end
 
           def run
-            res = Entities::ActiveDocs::create(remote: remote, attrs: activedocs_attrs)
-            puts "ActiveDocs '#{activedocs_name}' has been created with ID: #{res.id}"
+            res = Entities::ActiveDocs.create(remote: remote, attrs: activedocs_attrs)
+            printer.print_record res.attrs
           end
 
           private
@@ -58,6 +68,11 @@ module ThreeScaleToolbox
               "body" => activedocs_json_spec,
             }.compact
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new)
+          end
         end
       end
     end

data/lib/3scale_toolbox/commands/activedocs_command/list_command.rb

@@ -11,16 +11,17 @@ module ThreeScaleToolbox
               usage       'list <remote>'
               summary     'List ActiveDocs'
               description 'List all defined ActiveDocs'
-              runner ListSubcommand
 
+              ThreeScaleToolbox::CLI.output_flag(self)
               param :remote
               option :s, :'service-ref', "Filter the ActiveDocs by Service reference", argument: :required
+
+              runner ListSubcommand
             end
           end
 
           def run
-            activedocs = remote.list_activedocs
-            print_activedocs_data(activedocs, ACTIVEDOCS_FIELDS_TO_SHOW)
+            printer.print_collection filtered_activedocs
           end
 
           private
@@ -34,13 +35,9 @@ module ThreeScaleToolbox
             @remote ||= threescale_client(arguments[:remote])
           end
 
-          def print_activedocs_data(activedocs, fields_to_show)
-            print_header(fields_to_show)
-            print_results(activedocs, fields_to_show)
-          end
-
-          def print_header(fields_to_show)
-            puts fields_to_show.map { |e| e.upcase }.join("\t")
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CLI::CustomTablePrinter.new(ACTIVEDOCS_FIELDS_TO_SHOW))
           end
 
           def service_ref_filter
@@ -55,13 +52,9 @@ module ThreeScaleToolbox
             res
           end
 
-          def filtered_activedocs(activedocs)
-            filters.reduce(activedocs) { |current_list, filter| filter.filter(current_list) }
-          end
-
-          def print_results(activedocs, fields_to_show)
-            filtered_activedocs(activedocs).each do |activedoc|
-              puts fields_to_show.map { |field| activedoc.fetch(field, '(empty)') }.join("\t")
+          def filtered_activedocs
+            filters.reduce(remote.list_activedocs) do |current_list, filter|
+              filter.filter(current_list)
             end
           end
         end

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

@@ -2,6 +2,24 @@ module ThreeScaleToolbox
   module Commands
     module ApplicationCommand
       module Apply
+        class CustomPrinter
+          attr_reader :option_resume, :option_suspend
+
+          def initialize(options)
+            @option_resume = options[:resume]
+            @option_suspend = options[:suspend]
+          end
+
+          def print_record(application)
+            output_msg_array = ["Applied application id: #{application['id']}"]
+            output_msg_array << 'Resumed' if option_resume
+            output_msg_array << 'Suspended' if option_suspend
+            puts output_msg_array.join('; ')
+          end
+
+          def print_collection(collection) end
+        end
+
         class ApplySubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -28,6 +46,8 @@ module ThreeScaleToolbox
               option      nil, :'redirect-url', 'OpenID Connect redirect url', argument: :required
               flag        nil, :resume, 'Resume a suspended application'
               flag        nil, :suspend, 'Suspends an application (changes the state to suspended)'
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :application
 
@@ -52,10 +72,8 @@ module ThreeScaleToolbox
 
             application.resume if option_resume
             application.suspend if option_suspend
-            output_msg_array = ["Applied application id: #{application.id}"]
-            output_msg_array << 'Resumed' if option_resume
-            output_msg_array << 'Suspended' if option_suspend
-            puts output_msg_array.join('; ')
+
+            printer.print_record application.attrs
           end
 
           private
@@ -186,6 +204,11 @@ module ThreeScaleToolbox
           def option_redirect_url
             options[:'redirect-url']
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new(resume: option_resume, suspend: option_suspend))
+          end
         end
       end
     end

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

@@ -2,6 +2,14 @@ module ThreeScaleToolbox
   module Commands
     module ApplicationCommand
       module Create
+        class CustomPrinter
+          def print_record(application)
+            puts "Created application id: #{application['id']}"
+          end
+
+          def print_collection(collection) end
+        end
+
         class CreateSubcommand < Cri::CommandRunner
           include ThreeScaleToolbox::Command
 
@@ -17,6 +25,8 @@ module ThreeScaleToolbox
               option      nil, 'application-key', 'App Key(s) or Client Secret (for OAuth and OpenID Connect authentication modes) of the application to be created.' , argument: :required
               option      nil, :description, 'Application description', argument: :required
               option      nil, :'redirect-url', 'OpenID Connect redirect url', argument: :required
+              ThreeScaleToolbox::CLI.output_flag(self)
+
               param       :remote
               param       :account
               param       :service
@@ -35,7 +45,7 @@ module ThreeScaleToolbox
               app_attrs: app_attrs
             )
 
-            puts "Created application id: #{application.id}"
+            printer.print_record application.attrs
           end
 
           private
@@ -105,6 +115,11 @@ module ThreeScaleToolbox
           def remote
             @remote ||= threescale_client(arguments[:remote])
           end
+
+          def printer
+            # keep backwards compatibility
+            options.fetch(:output, CustomPrinter.new)
+          end
         end
       end
     end