3scale_toolbox 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a7b198d2a14662823d04de18bf2cc15b4e08b8b18e9900c888e54d2f7a72a3bb
-  data.tar.gz: fcda8a6926e72cd0a44485f912fc89debd59369e3296420c172f1a899546688b
+  metadata.gz: 5b92f14c66af8c902ae8c68e2052f1fa95fa251eff222665f69e8758a5c4fae5
+  data.tar.gz: 77193321a8835f5e55276a6e454765c4a66f00b42af58a9d2ccecd3a60359804
 SHA512:
-  metadata.gz: 95cbd6fb8d874ea31120d282d67ba5c61d3c5ef0a1d5df844844b7b0dfb8fd266dc0b62d486c2152896a692ff2243ee132a1617fc0ec07a94b21a13fab4251f9
-  data.tar.gz: 93a97483feb149fd5fc27049d75a883f8cae1bf95787e0b80cae14585db37396f46d55b7ef8614a016fd73c25e552a2bc82ea625c48ec6c502e07709fd12458c
+  metadata.gz: bc467460e0db0d22ac18d8c5e8265bc9e3fd6fbb154f0f58d3b222b03a1d1d05980f16d9f21e9414822702bf119e7d6207282a57198af7344e9bf71d335df2d9
+  data.tar.gz: e24bc998136917729814dfcf634e9da8c68a20a6987f5a2080aff6811605904dc160ec1e763e2f06870e0062633f1a8f0abf21145b6cc074fac249ea71afb14e

data/README.md

@@ -11,14 +11,18 @@ See the LICENSE and NOTICE files that should have been provided along with this
 ## Table of contents
 * [Installation](#installation)
 * [Usage](#usage)
-   * [Copy a service](#copy-a-service)
-   * [Update a service](#update-a-service)
-   * [Import from CSV](#import-from-csv)
+   * [Copy a service](docs/copy-service.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)
    * Create, Apply, List, Show, Delete [Application plan](docs/app-plan.md)
    * Create, Apply, List, Delete [Metric](docs/metric.md)
    * 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)
+   * [Copy Policy Registry](docs/copy-policy-registry.md)
+   * Create, Apply, List, Show, Delete, Suspend, Resume [Applications](docs/applications.md)
    * [Remotes](docs/remotes.md)
 * [Development](#development)
    * [Testing](#testing)
@@ -46,11 +50,20 @@ DESCRIPTION
     3scale toolbox to manage your API from the terminal.
 
 COMMANDS
-    copy       copy super command
-    help       show help
-    import     import super command
-    remote     remotes super command
-    update     update super command
+    account              account super command
+    activedocs           activedocs super command
+    application          application super command
+    application-plan     application-plan 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
+    proxy-config         proxy-config super command
+    remote               remotes super command
+    service              services super command
+    update               update super command
 
 OPTIONS
     -c --config-file=<value>      3scale toolbox configuration file (default:
@@ -62,142 +75,6 @@ OPTIONS
        --verbose                  Verbose mode
 ```
 
-### Copy a service
-Will create a new service, copy existing proxy settings, pricing rules, activedocs, metrics, methods, application plans and mapping rules.
-
-3scale instances can be either a [URL](docs/remotes.md#remote-urls) or the name of a [remote](docs/remotes.md).
-
-Help message:
-
-```shell
-$ 3scale copy service --help
-NAME
-    service - Copy service
-
-USAGE
-    3scale copy service [opts] -s <src> -d <dst>
-    <service_id>
-
-DESCRIPTION
-    Will create a new services, copy existing proxy settings, metrics,
-    methods, policies, application plans and mapping rules.
-
-OPTIONS
-    -d --destination=<value>             3scale target instance. Url or
-                                         remote name
-    -s --source=<value>                  3scale source instance. Url or
-                                         remote name
-    -t --target_system_name=<value>      Target system name. Default to
-                                         source system name
-
-OPTIONS FOR COPY
-    -h --help                            show help for this command
-    -k --insecure                        Proceed and operate even for server
-                                         connections otherwise considered
-                                         insecure
-    -v --version                         Prints the version of this command
-       --verbose                         Verbose mode
-```
-
-```shell
-3scale copy service NUMBER --source=foo --destination=https://access_token@foo2-admin.3scale.net
-```
-
-### Update a service
-
-Will update existing service, update proxy settings, pricing rules, activedocs, metrics, methods, application plans and mapping rules.
-
-3scale instances can be either a [URL](docs/remotes.md#remote-urls) or the name of a [remote](docs/remotes.md).
-
-Help message:
-
-```shell
-NAME
-    service - Update service
-
-USAGE
-    3scale update service [opts] -s <src> -d <dst>
-    <src_service_id> <dst_service_id>
-
-DESCRIPTION
-    Will update existing service, update proxy settings, metrics, methods,
-    application plans, policies and mapping rules.
-
-OPTIONS
-    -d --destination=<value>      3scale target instance. Url or
-                                  remote name
-    -f --force                    Overwrites the mapping rules by deleting
-                                  all rules from target service first
-    -r --rules-only               Updates only the mapping rules
-    -s --source=<value>           3scale source instance. Url or
-                                  remote name
-
-OPTIONS FOR UPDATE
-    -h --help                     show help for this command
-    -k --insecure                 Proceed and operate even for server
-                                  connections otherwise considered insecure
-    -v --version                  Prints the version of this command
-       --verbose                  Verbose mode
-```
-
-Example:
-
-```shell
-$ 3scale update service -s https://9874598743@source.example.com -d foo 3 2
-```
-
-### Import from CSV
-
-Will create new services, metrics, methods, and mapping rules having as source comma separated values (CSV) formatted file.
-
-3scale instances can be either a [URL](docs/remotes.md#remote-urls) or the name of a [remote](docs/remotes.md).
-
-CSV header
-
-```csv
-service_name,endpoint_name,endpoint_http_method,endpoint_path,auth_mode,endpoint_system_name,type
-```
-
-File example
-
-```csv
-service_name,endpoint_name,endpoint_http_method,endpoint_path,auth_mode,endpoint_system_name,type
-Movies ,Movies (Biography),GET,/movies/biography/,api_key,movies_biography,metric
-Movies ,Movies (Drama),GET,/movies/drama/,api_key,movies_drama,method
-```
-
-Help message:
-
-```shell
-$ 3scale import csv -h
-NAME
-    csv - Import csv file
-
-USAGE
-    3scale import csv [opts] -d <dst> -f <file>
-
-DESCRIPTION
-    Create new services, metrics, methods and mapping rules from CSV
-    formatted file
-
-OPTIONS
-    -d --destination=<value>      3scale target instance. Url or remote name
-    -f --file=<value>             CSV formatted file
-
-OPTIONS FOR IMPORT
-    -h --help                     show help for this command
-    -k --insecure                 Proceed and operate even for server
-                                  connections otherwise considered insecure
-    -v --version                  Prints the version of this command
-       --verbose                  Verbose mode
-```
-
-Example:
-
-```shell
-3scale import csv --destination=https://provider_key@user-admin.3scale.net --file=examples/import_example.csv
-```
-
 ## 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.rb

@@ -23,7 +23,6 @@ require '3scale_toolbox/commands'
 require '3scale_toolbox/cli'
 
 module ThreeScaleToolbox
-
   def self.load_plugins
     plugin_paths.each { |plugin_path| require plugin_path }
   end

data/lib/3scale_toolbox/commands.rb

@@ -7,6 +7,12 @@ require '3scale_toolbox/commands/remote_command'
 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/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'
 
 module ThreeScaleToolbox
   module Commands
@@ -19,6 +25,12 @@ module ThreeScaleToolbox
       ThreeScaleToolbox::Commands::PlansCommand,
       ThreeScaleToolbox::Commands::MetricsCommand,
       ThreeScaleToolbox::Commands::MethodsCommand,
+      ThreeScaleToolbox::Commands::ServiceCommand,
+      ThreeScaleToolbox::Commands::ActiveDocsCommand,
+      ThreeScaleToolbox::Commands::AccountCommand,
+      ThreeScaleToolbox::Commands::ProxyConfigCommand,
+      ThreeScaleToolbox::Commands::PolicyRegistryCommand,
+      ThreeScaleToolbox::Commands::ApplicationCommand,
     ].freeze
   end
 end

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

@@ -10,7 +10,7 @@ module ThreeScaleToolbox
           summary     '3scale toolbox'
           description '3scale toolbox to manage your API from the terminal.'
           option :c, 'config-file', '3scale toolbox configuration file',
-            argument: :required, default: ThreeScaleToolbox.default_config_file
+                 argument: :required, default: ThreeScaleToolbox.default_config_file
           flag :v, :version, 'Prints the version of this command' do
             puts ThreeScaleToolbox::VERSION
             exit 0

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

@@ -0,0 +1,23 @@
+require '3scale_toolbox/commands/account_command/find_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module AccountCommand
+      include ThreeScaleToolbox::Command
+
+      def self.command
+        Cri::Command.define do
+          name        'account'
+          usage       'acccount <sub-command> [options]'
+          summary     'account super command'
+          description 'Accounts commands'
+
+          run do |_opts, _args, cmd|
+            puts cmd.help
+          end
+        end
+      end
+      add_subcommand(Find::FindSubcommand)
+    end
+  end
+end

data/lib/3scale_toolbox/commands/account_command/find_command.rb

@@ -0,0 +1,41 @@
+require 'cri'
+require '3scale_toolbox/base_command'
+
+module ThreeScaleToolbox
+  module Commands
+    module AccountCommand
+      module Find
+        class FindSubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+
+          def self.command
+            Cri::Command.define do
+              name        'find'
+              usage       'find [opts] <remote> <text>'
+              summary     'find account'
+              description 'Find account by email, provider key or service token'
+
+              option      :a, :'print-all', 'Print all the account info', argument: :forbidden
+              param       :remote
+              param       :text
+
+              runner FindSubcommand
+            end
+          end
+
+          def run
+            client = threescale_client(arguments[:remote])
+            account = ThreeScaleToolbox::Entities::Account.find_by_text(arguments[:text], client)
+            if account.nil?
+              puts 'Account not found'
+              return
+            end
+
+            account.verbose = options[:'print-all']
+            puts account
+          end
+        end
+      end
+    end
+  end
+end

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

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

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

@@ -0,0 +1,127 @@
+module ThreeScaleToolbox
+  module Commands
+    module ActiveDocsCommand
+      module Apply
+        class ApplySubcommand < Cri::CommandRunner
+          include ThreeScaleToolbox::Command
+          include ThreeScaleToolbox::ResourceReader
+
+          def self.command
+            Cri::Command.define do
+              name        'apply'
+              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 :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
+            end
+          end
+
+          def run
+            res = activedocs
+            validate_option_params
+            if !res
+              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(";")
+          end
+
+          private
+
+          def remote
+            @remote ||= threescale_client(arguments[:remote])
+          end
+
+          def validate_option_params
+            if option_publish && option_hide
+              raise ThreeScaleToolbox::Error.new("--publish and --hide are mutually exclusive")
+            end
+          end
+
+          def check_openapi_spec_defined
+            if !option_openapi_spec
+              raise ThreeScaleToolbox::Error.new("--openapi-spec is mandatory when ActiveDocs is created")
+            end
+          end
+
+          def activedocs
+            @activedocs ||= find_activedocs
+          end
+
+          def ref
+            arguments[:activedocs_id_or_system_name]
+          end
+
+          def find_activedocs
+            Entities::ActiveDocs.find(remote: remote, ref: ref)
+          end
+
+          def option_publish
+            options.fetch(:publish, false)
+          end
+
+          def option_hide
+            options.fetch(:hide, false)
+          end
+
+          def option_openapi_spec
+            options[:'openapi-spec']
+          end
+
+          def activedocs_json_spec
+            @json_spec ||= read_activedocs_json_spec
+          end
+
+          def read_activedocs_json_spec
+            activedoc_spec = option_openapi_spec
+            activedoc_spec_content = load_resource(activedoc_spec)
+            JSON.pretty_generate(activedoc_spec_content)
+          end
+
+          def activedocs_attrs
+            activedocs_basic_attrs.tap do |params|
+              params["body"] = activedocs_json_spec if !option_openapi_spec.nil?
+              params["published"] = true if option_publish
+              params["published"] = false if option_hide
+            end
+          end
+
+          def activedocs_basic_attrs
+            {
+              "service_id" => options[:'service-id'],
+              "skip_swagger_validations" => options[:'skip-swagger-validations'],
+              "description" => options[:'description'],
+              "system_name" => options[:'system-name'],
+              "name" => options[:name],
+            }.compact
+          end
+
+          def create_activedocs_attrs
+            check_openapi_spec_defined
+            activedocs_attrs.merge(
+              "system_name" => ref,
+              "name" => ref,
+              "body" => activedocs_json_spec,
+            ) { |_key, oldval, _newval| oldval } # receiver of the merge message has key priority
+          end
+        end
+      end
+    end
+  end
+end