3scale_toolbox 0.15.0 → 0.18.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bf0d2a187e793d654f6e6cef6990cfabaada5072f3a72b9820b1fed1ac13ddfb
-  data.tar.gz: c1b56e8e76059e0143444ff9ef12da633b97ef74b0fccb6875480be8b22cf9e6
+  metadata.gz: 601ddede06d5a842020be721015fbc05a8d9c8409a42794961d6c888e60b62ed
+  data.tar.gz: fa8c908ff50157b7e438d0a5ad185034e74af219b2b79dd3a1037c120d99111f
 SHA512:
-  metadata.gz: f2bf8c3a1f5860a3c6d24fa5fbc976b9b3361ea8ef6a57bbc0707d5f3900a31d8022e9596080bf8129d47116d13d3ab4d2ae7bfc41e246d179adf0f757c7c598
-  data.tar.gz: 3a206838d82a662f56276e7d98291cf74f5bc69eb9f39de239bb3d15f457e62b81e336ee1d0438a508fdecc46f692b49610627ef6413d05788b4c9f1a8c3f2e5
+  metadata.gz: e11b9ad812a4b1fec7e9cbfc85ef7b39ce4ca688b06bfd95c8f927624661b23828ce4650d95b082e2314ecf8fdc8c9eb8b76af2ab88f536515f1154255f77e19
+  data.tar.gz: bb33acecf3213159343cbf9aba66d8c41e0d5c45842c3d80a3610af1b9cf92c3c7f16d3062372f58dcdaa313e6dcc0bc7dd197c9f53687a59b5734ada9152f77

data/3scale_toolbox.gemspec

@@ -31,12 +31,12 @@ Gem::Specification.new do |spec|
 
   spec.add_development_dependency 'bundler'
   spec.add_development_dependency 'dotenv'
-  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.8'
   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.4'
   spec.add_dependency 'cri', '~> 2.15'
   spec.add_dependency 'json-schema', '~> 2.8'
   spec.add_dependency 'oas_parser', '~> 0.20'

data/README.md

@@ -1,9 +1,7 @@
 # 3scale toolbox
 [![CircleCI](https://circleci.com/gh/3scale/3scale_toolbox.svg?style=svg)](https://circleci.com/gh/3scale/3scale_toolbox)
-
-This software is licensed under the [Apache 2.0 license](https://www.apache.org/licenses/LICENSE-2.0).
-
-See the LICENSE and NOTICE files that should have been provided along with this software for details.
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](http://www.apache.org/licenses/LICENSE-2.0)
+[![GitHub release](https://img.shields.io/github/v/release/3scale/3scale_toolbox.svg)](https://github.com/3scale/3scale_toolbox/releases/latest)
 
 ## Description
 3scale toolbox is a set of tools to help you manage your 3scale product. Using the [3scale API Ruby Client](https://github.com/3scale/3scale-api-ruby).
@@ -12,7 +10,10 @@ 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)
+   * [Export/Import product](docs/export-import-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)
@@ -21,15 +22,17 @@ See the LICENSE and NOTICE files that should have been provided along with this
    * Create, Apply, List, Delete [Method](docs/method.md)
    * Create, Apply, List, Show, Delete [Service](docs/service.md)
    * Create, Apply, List, Delete [ActiveDocs](docs/activedocs.md)
-   * List, Show, Promote [Proxy Configuration](docs/proxy-config.md)
+   * List, Show, Promote, Export, Deploy [Proxy Configuration](docs/proxy-config.md)
    * [Copy Policy Registry](docs/copy-policy-registry.md)
    * Create, Apply, List, Show, Delete, Suspend, Resume [Applications](docs/applications.md)
+   * [Export/Import Product Policy Chain](docs/export-import-policy-chain.md)
    * [Remotes](docs/remotes.md)
 * [Development](#development)
    * [Testing](#testing)
    * [Develop your own core command](#develop-core-command)
    * [Licenses](#licenses)
 * [Plugins](#plugins)
+* [Error Reporting](docs/errors.md)
 * [Troubleshooting](#troubleshooting)
 * [Contributing](#contributing)
 
@@ -38,6 +41,7 @@ Supported Ruby interpreters
 
 * MRI 2.5
 * MRI 2.6
+* MRI 2.7
 
 ## Installation
 Install the toolbox:
@@ -73,16 +77,18 @@ 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
     method               method super command
     metric               metric super command
     policy-registry      policy-registry super command
+    product              product super command
     proxy-config         proxy-config super command
     remote               remotes super command
     service              services super command
-    update               [DEPRECTATED] update super command
+    update               [DEPRECATED] update super command
 
 OPTIONS
     -c --config-file=<value>      3scale toolbox configuration file (default:
@@ -117,7 +123,7 @@ rake spec:integration
 
 Integration tests can be run locally or against a real 3scale account.
 When details of the account are set via environment variables,
-integration tests are run agains given account.
+integration tests are run against the given account.
 Otherwise, tests are run locally with mocked 3scale clients.
 
 The easiest way to set everything up is it to have a `.env` file in the root of the project with the following environment variables (set your own values):
@@ -160,7 +166,7 @@ end
 A few things worth highlighting:
 - Your module must include the *ThreeScaleToolbox::Command* module. It allows your command to be added to the toobox command tree.
 - You must implement the `command` module function and return an instance of `Cri::Command` from [cri](https://github.com/ddfreyne/cri)
-- `threescale_client` helper method returns *3scale API* client instance. All the process remote parsing, fetching from remote list and client instantiation is done out of the box.
+- `threescale_client` helper method returns *3scale API* client instance. All the process remote parsing, fetching from the remote list and client instantiation is done out of the box.
 
 Then register the core command in `lib/3scale_toolbox/commands.rb`
 ```

data/lib/3scale_toolbox.rb

@@ -10,17 +10,19 @@ require 'oas_parser'
 require '3scale/api'
 require 'json-schema'
 require 'erb'
+require 'logger'
 
 require '3scale_toolbox/version'
 require '3scale_toolbox/helper'
 require '3scale_toolbox/error'
+require '3scale_toolbox/remote_cache'
 require '3scale_toolbox/proxy_logger'
 require '3scale_toolbox/resource_reader'
 require '3scale_toolbox/configuration'
 require '3scale_toolbox/remotes'
 require '3scale_toolbox/3scale_client_factory'
+require '3scale_toolbox/crds'
 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/3scale_client_factory.rb

@@ -22,10 +22,9 @@ module ThreeScaleToolbox
         remote = remotes.fetch(remote_str)
       end
 
-      client = remote_client(remote.merge(verify_ssl: verify_ssl))
-      return ProxyLogger.new(client) if verbose
-
-      client
+      client = remote_client(**remote.merge(verify_ssl: verify_ssl))
+      client = ProxyLogger.new(client) if verbose
+      RemoteCache.new(client)
     end
 
     private

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/error_handler.rb

@@ -20,10 +20,9 @@ module ThreeScaleToolbox
 
       def handle_error(error)
         if expected_error?(error)
-          warn
-          warn "\e[1m\e[31mError: #{error.message}\e[0m"
+          warn error_serialize(error)
         else
-          print_error(error)
+          print_unexpected_error(error)
         end
       end
 
@@ -36,21 +35,12 @@ module ThreeScaleToolbox
         end
       end
 
-      def print_error(error)
-        write_error(error, $stderr)
-
+      def print_unexpected_error(error)
         File.open('crash.log', 'w') do |io|
           write_verbose_error(error, io)
         end
 
-        write_section_header($stderr, 'Detailed information')
-        warn
-        warn 'A detailed crash log has been written to ./crash.log.'
-      end
-
-      def write_error(error, stream)
-        write_error_message(error, stream)
-        write_stack_trace(error, stream)
+        warn error_serialize(UnexpectedError.new(error))
       end
 
       def write_error_message(error, stream)
@@ -113,6 +103,19 @@ module ThreeScaleToolbox
         stream.puts "===== #{title.upcase}:"
         stream.puts
       end
+
+      def error_serialize(error)
+        JSON.pretty_generate format_error(error)
+      end
+
+      def format_error(error)
+        {
+          code: error.code,
+          message: error.message,
+          class: error.kind,
+          stacktrace: error.stacktrace
+        }.compact
+      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,15 @@ 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'
+require '3scale_toolbox/commands/policies_command'
 
 module ThreeScaleToolbox
   module Commands
@@ -31,6 +34,9 @@ module ThreeScaleToolbox
       ThreeScaleToolbox::Commands::ProxyConfigCommand,
       ThreeScaleToolbox::Commands::PolicyRegistryCommand,
       ThreeScaleToolbox::Commands::ApplicationCommand,
+      ThreeScaleToolbox::Commands::BackendCommand,
+      ThreeScaleToolbox::Commands::ProductCommand,
+      ThreeScaleToolbox::Commands::PoliciesCommand,
     ].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