bump-cli 0.2.1 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5169670a252b09da084e26e8d2b8278edd15d9e904f123983f68649c5ead88f
-  data.tar.gz: 186066a217405dbdef02f5f95c05954925220b400aaa1b2ba8320366b5d807d3
+  metadata.gz: cc466d8c09963a1ac25e48d63016b6604750bb6dd5047e58c8dbb7735b104187
+  data.tar.gz: 8e86094c69c571e5e3b37dc89f2c0634006545651c0798e5094bc93ec303dc88
 SHA512:
-  metadata.gz: 358db0967d78738d45711ad7628c2b407f565b3032e526704e7919c47916774686c02dd093d857a6d3ffc8ed2829905fdb739b7a50627f0f04f37a95fe5446ec
-  data.tar.gz: aedba4f9f17a31bdbf2cfb85a6d297fe7b4ecb9924559c815e74262fb08aea0a07766d869b9ab3d54a0eec6b2f85f431aeec58822c20ce89ffad52c3e40abc0d
+  metadata.gz: 0afc11a8d8e2c15a9e6eb252cd059f0c9076b4e443bd53ea385817b9c1f45768b6f93bdc0e50f3756f3c1b1e049fe265a289210396a4ca3cc0772d1bc0024f47
+  data.tar.gz: 80df03f014b02a00cde98e21c0a38b832273245d7bbe7cba718c5dab46881f1d9302a2a233e1960479c755a932bb9cf7d0b5004c01bc23de753c6324d3fec91b

data/.gitignore

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

data/bump-cli.gemspec

@@ -30,6 +30,7 @@ Gem::Specification.new do |spec|
   spec.add_dependency "http", '~> 3'
 
   spec.add_development_dependency "bundler", "~> 1.15"
+  spec.add_development_dependency "byebug", "~> 9"
   spec.add_development_dependency "climate_control", '~> 0'
   spec.add_development_dependency "rake", "~> 10.0"
   spec.add_development_dependency "rspec", "~> 3"

data/lib/bump/cli.rb

@@ -4,7 +4,7 @@ require "http"
 
 module Bump
   class CLI
-    ROOT_URL = "https://bump.sh".freeze
+    ROOT_URL = "https://bump-staging.herokuapp.com".freeze
     API_PATH = "/api/v1".freeze
     API_URL = ROOT_URL + API_PATH
 

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

@@ -1,11 +1,20 @@
 require 'open-uri'
+require 'byebug'
 
 module Bump
   class CLI
     module Commands
       class Base < Hanami::CLI::Command
+        USER_AGENT = "bump-cli/#{VERSION}".freeze
+
         private
 
+        def post(url:, body:, token: nil)
+          HTTP
+            .headers(headers(token: token))
+            .post(url, body: body)
+        end
+
         def body(file, specification)
           {
             definition: open(file).read,
@@ -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

@@ -8,13 +8,15 @@ module Bump
         argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is 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"
 
-        def call(file:, specification:, id:, token:)
+        def call(file:, id:, token:, 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).to_json,
+              token: token
+            )
 
             if response.code == 201
               puts "New version has been successfully deployed."

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

@@ -4,13 +4,14 @@ module Bump
       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"
+        option :specification, desc: "Specification of the definition"
 
-        def call(file:, specification:)
+        def call(file:, 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).to_json
+            )
 
             if response.code == 201
               body = JSON.parse(response.body)

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

@@ -8,13 +8,15 @@ module Bump
         argument :file, required: true, desc: "Path or URL to your API documentation file. Only OpenApi 2.0 (Swagger) specification is 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"
 
-        def call(file:, specification:, id:, token:)
+        def call(file:, id:, token:, 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).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.3.0"
   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.3.0
 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: 2018-11-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: hanami-cli
@@ -53,6 +53,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '1.15'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '9'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement