3scale_toolbox 0.13.0 → 0.17.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f44badf850b3935e7e0fcce80095f7914860e1fa5b427647ba7a5dc25b1d57a8
-  data.tar.gz: ba0ea206371d28c88e7ea4fc27edc074850e72bd8825d2ab98b2fdb6b32c83c0
+  metadata.gz: 2757cb4872a0b79aecc940e202197af6474d8d4057b2b576b1e094315a3c91c6
+  data.tar.gz: 84702d1a9d6430db62c85689ae4c18f2a1cab152ffd3dc2ea4ac8b8b6c22df39
 SHA512:
-  metadata.gz: e50cf4c210e27b2ca2c0d38bb5a52ecfcf39bc440b1fc7a6974b68dc7ca06d976fe2375d41c2dae79f0c08fcd320c213936bef462673c87418cd54b2710c904e
-  data.tar.gz: 1479ae95b5b42856aac547e5a495c1bb4a5c56c4065753e760a3c43405132900eb474e4b8c2d1f597b508f68a93abf3f013ddbf2db1ba3ac39c28426fb5fd2d7
+  metadata.gz: 6e19f6db5644ecdd2825aba35bc1113dbfb45a19ee66ed8caa3f1a1295febaf158a2d39b66d1755c8f4b2826e2334fe149f3711c7c75d6bdfd31544fee5f5d31
+  data.tar.gz: 838988ab2096976ec1bda3b94a0cea0e5bcefbca49ecf8cbe56a6fee0648a8e4ed2dba26819da3e061ceae9bdba8a1191899ead70b8fe0eb8cf73e9d29a2ef3a

data/3scale_toolbox.gemspec

@@ -31,12 +31,13 @@ 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.4'
+  spec.required_ruby_version = '>= 2.5'
 
-  spec.add_dependency '3scale-api', '~> 0.6.0'
+  spec.add_dependency '3scale-api', '~> 1.1'
   spec.add_dependency 'cri', '~> 2.15'
   spec.add_dependency 'json-schema', '~> 2.8'
+  spec.add_dependency 'oas_parser', '~> 0.20'
 end

data/README.md

@@ -1,17 +1,18 @@
 # 3scale toolbox
-[![Build Status](https://travis-ci.org/3scale/3scale_toolbox.svg?branch=master)](https://travis-ci.org/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.
+[![CircleCI](https://circleci.com/gh/3scale/3scale_toolbox.svg?style=svg)](https://circleci.com/gh/3scale/3scale_toolbox)
+[![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).
 
 ## Table of contents
+* [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)
@@ -20,7 +21,7 @@ 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 [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)
    * [Remotes](docs/remotes.md)
@@ -29,13 +30,31 @@ See the LICENSE and NOTICE files that should have been provided along with this
    * [Develop your own core command](#develop-core-command)
    * [Licenses](#licenses)
 * [Plugins](#plugins)
+* [Error Reporting](docs/errors.md)
 * [Troubleshooting](#troubleshooting)
 * [Contributing](#contributing)
 
+## Requirements
+Supported Ruby interpreters
+
+* MRI 2.5
+* MRI 2.6
+
 ## Installation
 Install the toolbox:
 
-    $ gem install 3scale_toolbox
+```
+$ gem install 3scale_toolbox
+```
+
+The [3scale toolbox packaging repo](https://github.com/3scale/3scale_toolbox_packaging)
+provides packages and installation/deployment steps for the following platforms:
+* CentOS/Fedora
+* Ubuntu/Debian
+* Mac OS X
+* Windows
+* Docker
+* Kubernetes / Openshift
 
 ## Usage
 
@@ -55,16 +74,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:
@@ -178,7 +199,7 @@ $ 3scale service_list my-3scale-instance
 
 It is a requirement that we include a file describing all the licenses used in the product, so that users can examine it.
 
-Run `rake license_finder:check` to check licenses when dependencies change. 
+Run `rake license_finder:check` to check licenses when dependencies change.
 
 Run `rake license_finder:report > licenses.xml` to update licenses file.
 

data/lib/3scale_toolbox.rb

@@ -6,20 +6,23 @@ require 'time'
 require 'csv'
 require 'net/http'
 require 'pathname'
+require 'oas_parser'
 require '3scale/api'
+require 'json-schema'
+require 'erb'
 
 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'
 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'
 require '3scale_toolbox/commands'
 require '3scale_toolbox/cli'
 

data/lib/3scale_toolbox/attribute_filters.rb

@@ -0,0 +1,2 @@
+require '3scale_toolbox/attribute_filters/attribute_filter'
+require '3scale_toolbox/attribute_filters/service_id_from_ref_filter'

data/lib/3scale_toolbox/attribute_filters/attribute_filter.rb

@@ -0,0 +1,9 @@
+module ThreeScaleToolbox
+  module AttributeFilters
+    module AttributeFilter
+      def filter(enumerable)
+        raise "Not implemented"
+      end
+    end
+  end
+end

data/lib/3scale_toolbox/attribute_filters/service_id_from_ref_filter.rb

@@ -0,0 +1,30 @@
+module ThreeScaleToolbox
+  module AttributeFilters
+    class ServiceIDFilterFromServiceRef
+      include AttributeFilter
+
+      attr_reader :remote, :service_ref, :service_id_key
+
+      def initialize(remote, service_ref, service_id_key)
+        @remote = remote
+        @service_ref = service_ref
+        @service_id_key = service_id_key
+      end
+
+      def filter(enumerable)
+        svc_id = find_service
+        enumerable.select { |e| e.key?(service_id_key) && e[service_id_key].to_s == svc_id.to_s }
+      end
+
+      private
+
+      def find_service
+        svc_id = -1
+        Entities::Service.find(remote: remote, ref: service_ref).tap do |svc|
+          svc_id = svc.id if !svc.nil?
+        end
+        svc_id
+      end
+    end
+  end
+end

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,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,34 +30,34 @@ 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
               option nil, :'hide', "Specify it to hide the ActiveDocs on the Developer Portal", argument: :forbidden
-              option nil, :'skip-swagger-validations', "Specify it to skip validation of the Swagger specification", argument: :forbidden
+              option nil, :'skip-swagger-validations', "Skip validation of the Swagger specification. true or false", argument: :required, transform: ThreeScaleToolbox::Helper::BooleanTransformer.new
               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