bump-cli 0.2.1 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5169670a252b09da084e26e8d2b8278edd15d9e904f123983f68649c5ead88f
-  data.tar.gz: 186066a217405dbdef02f5f95c05954925220b400aaa1b2ba8320366b5d807d3
+  metadata.gz: 037f50e1dc85f791e29b7d04610c536d5c5de55465129218036508f7dc9b4f23
+  data.tar.gz: a88fcc165c82445b31447194f4156479793294519327b7a37e0f253a532043d3
 SHA512:
-  metadata.gz: 358db0967d78738d45711ad7628c2b407f565b3032e526704e7919c47916774686c02dd093d857a6d3ffc8ed2829905fdb739b7a50627f0f04f37a95fe5446ec
-  data.tar.gz: aedba4f9f17a31bdbf2cfb85a6d297fe7b4ecb9924559c815e74262fb08aea0a07766d869b9ab3d54a0eec6b2f85f431aeec58822c20ce89ffad52c3e40abc0d
+  metadata.gz: 62985d280a33db74d42a6afafde570231aca07a18fbae7a492756352f9315ea38b7fc7fa97b188d0dd2823d65a82e6cc8b639449b1064746f831d7c3de1a5e2f
+  data.tar.gz: 6179fc9f2b65c33c4416f869a1c7c1e41b825d81a1e77533bb3d84e6a319f870c79ffbd45b5ac53b4d4a9f54fd23d841959fd40f83cac77457124dd82defa438

data/.gitignore

@@ -1,3 +1,4 @@
+.byebug_history
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/README.md

@@ -20,27 +20,34 @@ Or install it yourself as:
 
 ## Usage
 
-By default, `bump-cli` considers files as `yaml` ones. If you work with JSON definitions, you need to specify the format for all the commands using `--format json`.
+Bump tries to identify your file specification and format automatically. You can force it by using the `--specification` option. Here are the supported values:
 
-The doc `id` and `token` used below can be found in your documentation settings page on https://bump.sh. Note that you can replace the options by environments variables: `--id` can be replaced by `BUMP_ID`, and `--token` can by replaced by `BUMP_TOKEN`. This is useful to keep your private token secret.
+* `openapi/v2/json`
+* `openapi/v2/yaml`
+* `openapi/v3/json`
+* `openapi/v3/yaml`
+* `asyncapi/v2/json`
+* `asyncapi/v2/yaml`
+
+The doc `id` and `token` options used below can be found in your documentation settings page on https://bump.sh. Note that you can replace these options by environments variables: `--id` can be replaced by `BUMP_ID`, and `--token` can by replaced by `BUMP_TOKEN`. This is useful to keep your private token secret.
 
 ### Preview
 
 You can preview your documentation by calling the `preview` command. A temporary preview will be created, with a unique URL. This preview will be available for 30 minutes. You don't need any credentials to use this command.
 
-    $ bundle exec bump preview path/to/your/openapi.yml
+    $ bundle exec bump preview path/to/your/file.yml
 
 ### Validate
 
-Validate your file against the OpenApi specification.
+Validate your file against its specification.
 
-    $ bundle exec bump validate path/to/your/openapi.yml --id DOC_ID --token DOC_TOKEN
+    $ bundle exec bump validate path/to/your/file.yml --id DOC_ID --token DOC_TOKEN
 
 ### Deploy
 
 Deploy the file as the current version of the documentation.
 
-    $ bundle exec bump deploy path/to/your/openapi.yml --id DOC_ID --token DOC_TOKEN
+    $ bundle exec bump deploy path/to/your/file.yml --id DOC_ID --token DOC_TOKEN
 
 ## Development
 

data/bump-cli.gemspec

@@ -27,11 +27,12 @@ Gem::Specification.new do |spec|
   spec.required_ruby_version = '>= 2.3'
 
   spec.add_dependency "hanami-cli", '~> 0'
-  spec.add_dependency "http", '~> 3'
+  spec.add_dependency "http", '>= 3'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "bundler", "~> 1"
+  spec.add_development_dependency "byebug", "~> 11"
   spec.add_development_dependency "climate_control", '~> 0'
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3"
   spec.add_development_dependency "webmock", "~> 3"
 end

data/lib/bump/cli/commands/base.rb

@@ -4,12 +4,21 @@ module Bump
   class CLI
     module Commands
       class Base < Hanami::CLI::Command
+        USER_AGENT = "bump-cli/#{VERSION}".freeze
+
         private
 
-        def body(file, specification)
+        def post(url:, body:, token: nil)
+          HTTP
+            .headers(headers(token: token))
+            .post(url, body: body)
+        end
+
+        def body(file, specification, validation)
           {
             definition: open(file).read,
-            specification: specification
+            specification: specification,
+            validation: validation
           }
         end
 
@@ -20,22 +29,22 @@ module Bump
         end
 
         def headers(token: '')
+          headers = {
+            'Content-Type' => 'application/json',
+            'User-Agent' => USER_AGENT
+          }
+
           if token
-            {
-              "Content-Type" => "application/json",
-              "Authorization" => "Basic #{Base64.strict_encode64(token + ':')}"
-            }
-          else
-            {
-              "Content-Type" => "application/json"
-            }
+            headers['Authorization'] = "Basic #{Base64.strict_encode64(token + ':')}"
           end
+
+          headers
         end
 
         def display_error(response)
           if response.code == 422
             body = JSON.parse(response.body)
-            display_invalid_definition(body)
+            display_validation_errors(body)
           elsif response.code == 401
             abort "Invalid credentials (status: 401)"
           else
@@ -46,13 +55,30 @@ module Bump
           abort "Unknown error (status: #{response.code})"
         end
 
-        def display_invalid_definition(body)
-          puts "Definition is not valid:"
-          body["errors"]["raw_definition"].each do |error|
-            puts "> #{error}"
+        def display_validation_errors(body)
+          errors = body.dig('errors') || []
+
+          $stderr.puts "Invalid request:"
+          errors.each do |attribute, messages|
+            display_attribute_errors(attribute, messages)
           end
+
           abort
         end
+
+        def display_attribute_errors(attribute, messages)
+          case
+          when messages.is_a?(String)
+            $stderr.puts "- #{attribute}: #{messages}"
+          when messages.is_a?(Array) && messages.count == 1
+            $stderr.puts "- #{attribute}: #{messages[0]}"
+          when messages.is_a?(Array)
+            $stderr.puts "- #{attribute}:"
+            messages.each do |message|
+              $stderr.puts " #{message}"
+            end
+          end
+        end
       end
     end
   end

data/lib/bump/cli/commands/deploy.rb

@@ -5,16 +5,19 @@ module Bump
     module Commands
       class Deploy < Base
         desc "Create a new version"
-        argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is currently supported."
+        argument :file, required: true, desc: "Path or URL to your API documentation file. OpenAPI (2.0 to 3.0.2) and AsyncAPI (2.0) specifications are currently supported."
         option :id, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation public id"
         option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation private token"
-        option :specification, default: 'openapi/v2/yaml', desc: "Specification of the definition"
+        option :specification, desc: "Specification of the definition"
+        option :validation, desc: "Validation mode", values: %w(basic strict), default: 'basic'
 
-        def call(file:, specification:, id:, token:)
+        def call(file:, id:, token:, validation:, specification: nil)
           with_errors_rescued do
-            response = HTTP
-              .headers(headers(token: token))
-              .post(API_URL + "/docs/#{id}/versions", body: body(file, specification).to_json)
+            response = post(
+              url: API_URL + "/docs/#{id}/versions",
+              body: body(file, specification, validation).to_json,
+              token: token
+            )
 
             if response.code == 201
               puts "New version has been successfully deployed."

data/lib/bump/cli/commands/preview.rb

@@ -3,14 +3,16 @@ module Bump
     module Commands
       class Preview < Base
         desc "Create a documentation preview for the given file"
-        argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is currently supported."
-        option :specification, default: 'openapi/v2/yaml', desc: "Specification of the definition"
+        argument :file, required: true, desc: "Path or URL to your API documentation file. OpenAPI (2.0 to 3.0.2) and AsyncAPI (2.0) specifications are currently supported."
+        option :specification, desc: "Specification of the definition"
+        option :validation, desc: "Validation mode", values: %w(basic strict), default: 'basic'
 
-        def call(file:, specification:)
+        def call(file:, validation:, specification: nil)
           with_errors_rescued do
-            response = HTTP
-              .headers(headers)
-              .post(API_URL + "/previews", body: body(file, specification).to_json)
+            response = post(
+              url: API_URL + "/previews",
+              body: body(file, specification, validation).to_json
+            )
 
             if response.code == 201
               body = JSON.parse(response.body)

data/lib/bump/cli/commands/validate.rb

@@ -5,16 +5,19 @@ module Bump
     module Commands
       class Validate < Base
         desc "Validate a given file against its schema definition"
-        argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is currently supported."
+        argument :file, required: true, desc: "Path or URL to your API documentation file. OpenAPI (2.0 to 3.0.2) and AsyncAPI (2.0) specifications are currently supported."
         option :id, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation public id"
         option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation private token"
-        option :specification, default: 'openapi/v2/yaml', desc: "Specification of the definition"
+        option :specification, desc: "Specification of the definition"
+        option :validation, desc: "Validation mode", values: %w(basic strict), default: 'basic'
 
-        def call(file:, specification:, id:, token:)
+        def call(file:, id:, token:, validation:, specification: nil)
           with_errors_rescued do
-            response = HTTP
-              .headers(headers(token: token))
-              .post(API_URL + "/docs/#{id}/validations", body: body(file, specification).to_json)
+            response = post(
+              url: API_URL + "/docs/#{id}/validations",
+              body: body(file, specification, validation).to_json,
+              token: token
+            )
 
             if response.code == 200
               puts "Definition is valid."

data/lib/bump/cli/version.rb

@@ -1,5 +1,5 @@
 module Bump
   class CLI
-    VERSION = "0.2.1"
+    VERSION = "0.4.1"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bump-cli
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.4.1
 platform: ruby
 authors:
 - Mehdi Lahmam
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2020-02-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-cli
@@ -29,14 +29,14 @@ dependencies:
   name: http
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '3'
 - !ruby/object:Gem::Dependency
@@ -45,14 +45,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -73,14 +87,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '13'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement