3scale_toolbox 0.11.0 → 0.12.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 5b92f14c66af8c902ae8c68e2052f1fa95fa251eff222665f69e8758a5c4fae5
-  data.tar.gz: 77193321a8835f5e55276a6e454765c4a66f00b42af58a9d2ccecd3a60359804
+  metadata.gz: ac2ca1bf3c4ac290e97697ff6a757b2a81342c97052074cb997733fac2d3bea4
+  data.tar.gz: c5789fe4bca6c849fd5a1f1a0662d8d3d6ebae3ba87032818d5eaf2bd31d29bb
 SHA512:
-  metadata.gz: bc467460e0db0d22ac18d8c5e8265bc9e3fd6fbb154f0f58d3b222b03a1d1d05980f16d9f21e9414822702bf119e7d6207282a57198af7344e9bf71d335df2d9
-  data.tar.gz: e24bc998136917729814dfcf634e9da8c68a20a6987f5a2080aff6811605904dc160ec1e763e2f06870e0062633f1a8f0abf21145b6cc074fac249ea71afb14e
+  metadata.gz: 44d69df53320a59ab55520e2d0e6d056e43a780d8ec063f79233a4a4d1235a36f336140d9330b2511951e383e4cdc16c2503a803f0ae2934db56db8c73439aa7
+  data.tar.gz: fe318dd7a63e36ae80e860ad07b1b2c5a9f0347282693fa0c43087370802cd0944a5734b8ef89742ef9b6eb268d342ad8a64c7fe5c49192320fb57fc187b0219

data/3scale_toolbox.gemspec

@@ -0,0 +1,42 @@
+# coding: utf-8
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require '3scale_toolbox/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = '3scale_toolbox'
+  spec.version       = ThreeScaleToolbox::VERSION
+  spec.licenses      = ['MIT']
+  spec.authors       = ['Michal Cichra', 'Eguzki Astiz Lezaun']
+  spec.email         = ['michal@3scale.net', 'eastizle@redhat.com']
+
+  spec.summary       = %q{3scale Toolbox.}
+  spec.description   = %q{3scale tools to manage your API from the terminal.}
+  spec.homepage      = 'https://github.com/3scale/3scale_toolbox'
+
+  spec.files         = Dir['{lib}/**/*.rb']
+  spec.files         += Dir['{exe,resources}/*']
+  spec.files         << 'README.md'
+  spec.files         << 'licenses.xml'
+  spec.files         << 'LICENSE'
+  spec.files         << 'NOTICE'
+  # There is a bug in gem 2.7.6 and __FILE__ cannot be used.
+  # It is expanded in rake release task with full path on the building host
+  spec.files         << '3scale_toolbox.gemspec'
+
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler'
+  spec.add_development_dependency 'dotenv'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.8'
+  spec.add_development_dependency 'webmock', '~> 3.4'
+  spec.required_ruby_version = '>= 2.4'
+
+  spec.add_dependency '3scale-api', '~> 0.6.0'
+  spec.add_dependency 'cri', '~> 2.15'
+  spec.add_dependency 'json-schema', '~> 2.8'
+end

data/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/NOTICE

@@ -0,0 +1,15 @@
+   Red Hat 3scale Toolbox
+   Copyright (c) 2010-2016 3scale, Inc
+   Copyright (c) 2016-2019 Red Hat, Inc.
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

data/README.md

@@ -27,6 +27,7 @@ See the LICENSE and NOTICE files that should have been provided along with this
 * [Development](#development)
    * [Testing](#testing)
    * [Develop your own core command](#develop-core-command)
+   * [Licenses](#licenses)
 * [Plugins](#plugins)
 * [Troubleshooting](#troubleshooting)
 * [Contributing](#contributing)
@@ -173,6 +174,13 @@ Running the new core command:
 $ 3scale service_list my-3scale-instance
 { ... }
 ```
+### Licenses
+
+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:report > licenses.xml` to update licenses file.
 
 ## Plugins
 

data/lib/3scale_toolbox.rb

@@ -5,6 +5,7 @@ require 'uri'
 require 'time'
 require 'csv'
 require 'net/http'
+require 'pathname'
 require '3scale/api'
 
 require '3scale_toolbox/version'

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

@@ -26,6 +26,7 @@ module ThreeScaleToolbox
               option      nil, :account, 'Application\'s account. Required when creating', argument: :required
               option      nil, :service, 'Application\'s service. Required when creating', argument: :required
               option      nil, :plan, 'Application\'s plan. Required when creating', argument: :required
+              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)'
               param       :remote
@@ -38,7 +39,8 @@ module ThreeScaleToolbox
           def run
             validate_option_params
 
-            application = Entities::Application.find(remote: remote, ref: application_ref)
+            application = Entities::Application.find(remote: remote, service_id: service_id,
+                                                     ref: application_ref)
             if application.nil?
               validate_creation_option_params
               application = Entities::Application.create(remote: remote,
@@ -69,6 +71,8 @@ module ThreeScaleToolbox
               '--account is required to create' if option_account.nil?
             raise ThreeScaleToolbox::Error, "Application #{application_ref} does not exist." \
               '--service is required to create' if option_service.nil?
+            raise ThreeScaleToolbox::Error, "Service #{option_service} does not exist" if service.nil?
+
             raise ThreeScaleToolbox::Error, "Application #{application_ref} does not exist." \
               '--plan is required to create' if option_plan.nil?
             raise ThreeScaleToolbox::Error, "Application #{application_ref} does not exist." \
@@ -84,6 +88,7 @@ module ThreeScaleToolbox
               'user_key' => application_ref,
               'application_id' => application_ref,
               'application_key' => option_app_key,
+              'redirect_url' => option_redirect_url,
             }.compact
           end
 
@@ -94,6 +99,7 @@ module ThreeScaleToolbox
               'name' => option_name,
               'description' => description,
               'user_key' => option_user_key,
+              'redirect_url' => option_redirect_url,
             }.compact
           end
 
@@ -108,15 +114,20 @@ module ThreeScaleToolbox
             end
           end
 
+          def service_id
+            return if service.nil?
+
+            service.id
+          end
+
           def service
-            @service ||= find_service
+            return @service if defined? @service
+
+            @service = find_service
           end
 
           def find_service
-            Entities::Service.find(remote: remote,
-                                   ref: option_service).tap do |svc|
-              raise ThreeScaleToolbox::Error, "Service #{option_service} does not exist" if svc.nil?
-            end
+            return Entities::Service.find(remote: remote, ref: option_service) unless option_service.nil?
           end
 
           def plan
@@ -172,6 +183,10 @@ module ThreeScaleToolbox
           def application_ref
             arguments[:application]
           end
+
+          def option_redirect_url
+            options[:'redirect-url']
+          end
         end
       end
     end

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

@@ -16,6 +16,7 @@ module ThreeScaleToolbox
               option      nil, 'application-id', 'App ID or Client ID (for OAuth and OpenID Connect authentication modes) of the application to be created. ', argument: :required
               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
               param       :remote
               param       :account
               param       :service
@@ -45,7 +46,8 @@ module ThreeScaleToolbox
               'description' => description,
               'user_key' => options[:'user-key'],
               'application_id' => options[:'application-id'],
-              'application_key' => options[:'application-key']
+              'application_key' => options[:'application-key'],
+              'redirect_url' => options[:'redirect-url'],
             }.compact
           end
 

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

@@ -43,6 +43,11 @@ module ThreeScaleToolbox
                                                       service_params: create_service_attrs)
           end
 
+          if target_service == source_service
+            raise ThreeScaleToolbox::Error, 'Source and destination services are the same: ' \
+              "ID: #{source_service.id} system_name: #{source_service.attrs['system_name']}"
+          end
+
           puts "new service id #{target_service.id}"
 
           context = create_context(source_service, target_service)

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

@@ -32,10 +32,11 @@ module ThreeScaleToolbox
               flag    nil, 'skip-openapi-validation', 'Skip OpenAPI schema validation'
               option  nil, 'oidc-issuer-endpoint', 'OIDC Issuer Endpoint', argument: :required
               option  nil, 'default-credentials-userkey', 'Default credentials policy userkey', argument: :required
-              option  nil, 'override-private-basepath', 'Override the basepath for the public URLs', argument: :required
-              option  nil, 'override-public-basepath', 'Override the basepath for the private URLs', argument: :required
+              option  nil, 'override-private-basepath', 'Override the basepath for the private URLs', argument: :required
+              option  nil, 'override-public-basepath', 'Override the basepath for the public URLs', argument: :required
               option  nil, 'staging-public-base-url', 'Custom public staging URL', argument: :required
               option  nil, 'production-public-base-url', 'Custom public production URL', argument: :required
+              option  nil, 'override-private-base-url', 'Custom private base URL', argument: :required
               param   :openapi_resource
 
               runner OpenAPISubcommand
@@ -80,7 +81,8 @@ module ThreeScaleToolbox
               skip_openapi_validation: options[:'skip-openapi-validation'],
               override_private_basepath: options[:'override-private-basepath'],
               production_public_base_url: options[:'production-public-base-url'],
-              staging_public_base_url: options[:'staging-public-base-url']
+              staging_public_base_url: options[:'staging-public-base-url'],
+              override_private_base_url: options[:'override-private-base-url'],
             }
           end
 

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

@@ -77,12 +77,20 @@ module ThreeScaleToolbox
             end
           end
 
+          def cleaned_issuer_endpoint
+            return if oidc_issuer_endpoint.nil?
+
+            issuer_uri = ThreeScaleToolbox::Helper.parse_uri(oidc_issuer_endpoint)
+            issuer_uri.userinfo = ''
+            issuer_uri.to_s
+          end
+
           def authorization_url
-            "#{oidc_issuer_endpoint}/protocol/openid-connect/auth"
+            "#{cleaned_issuer_endpoint}/protocol/openid-connect/auth"
           end
 
           def token_url
-            "#{oidc_issuer_endpoint}/protocol/openid-connect/token"
+            "#{cleaned_issuer_endpoint}/protocol/openid-connect/token"
           end
         end
       end