bump-cli 0.6.1 → 0.7.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 165f19120b51a189b1f7428e00901fed5ea5b91bfb5f21bc2f9fe983adc3cc31
-  data.tar.gz: 724ec534aff1c7d264b185ca8c9d6bf46db552d8149d39fe2a2cf3c2185a341d
+  metadata.gz: 00d797137b0dae0f38a0a9106badd11c90ffacd37648eb7d2bdcdc4370e0e2b0
+  data.tar.gz: 1cd3d2d72d423284a9a0ffc3c0f86fd577b2ece23acf68f0fa36e43896aae730
 SHA512:
-  metadata.gz: 5a5df45b5a14cb7e79063504ce1a5dc5e5342088840de2dcf6eca79928712b46115ed590765e4a516c497e461eb12cdeaa65ce052f217decfb5eb5e9075bfc7a
-  data.tar.gz: 3c3ab329ab7c5bd4d0bada3147cd4fdb8c61131fcc32efb3e980811e48bdecef868d1d99823e099b7b612b4b18755c1b7706cc71adb129e717dc2ddfa265e43c
+  metadata.gz: 0e2a0eaa1fb62b4f9b7b5f88883e8f00ded7653467d80f3776a8aadf6f0190e32fdb620acc3e8568e30be88fa4e7f5370ec7e777137ecda72cc7e77a6cdd5576
+  data.tar.gz: c3f88a2d70ff4f893a13b985beb3f8198f349a02fed67f93e7949527867acc9655409a586db8f13a364b145b467c70d5cede4c4f74e3aa42b92c558140afc5a5

data/.github/ISSUE_TEMPLATE/cli-runtime-error.md

@@ -0,0 +1,26 @@
+---
+name: CLI runtime error
+about: Create a report of an exception happening when running a CLI command
+title: "[ERROR MESSAGE]"
+labels: ""
+assignees: ""
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Command**
+Paste here the exact command executed (with arguments and options) which led to the bug.
+
+**Stack trace**
+Paste here the stack trace displayed by the CLI, if available.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. macOS Catalina 10.15.7]
+ - Ruby version [e.g. 2.7]
+
+**Additional context**
+Add any other context about the problem here. If publishable, do not hesitate to join the specification you were trying to deploy/preview on Bump.

data/Gemfile

@@ -1,6 +1,6 @@
 source "https://rubygems.org"
 
-git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
 # Specify your gem's dependencies in bump-cli.gemspec
 gemspec

data/README.md

@@ -29,7 +29,10 @@ Bump tries to identify your file specification and format automatically. You can
 * `asyncapi/v2/json`
 * `asyncapi/v2/yaml`
 
-`doc` and `token` options used below can be found in your documentation settings page on https://bump.sh. Note that you can replace the token option by an environment variable, to keep it secret: `--token` can by replaced by `BUMP_TOKEN`.
+Both the `--doc` and `--token` options used below can be found in your documentation settings page on https://bump.sh. Note that you can replace both the `--doc` and `--token` option by an environment variable. This will help to keep those values secret:
+
+- `--doc` can by replaced by `BUMP_ID`.
+- `--token` can by replaced by `BUMP_TOKEN`.
 
 ### Preview
 

data/bump-cli.gemspec

@@ -1,38 +1,38 @@
-# coding: utf-8
 lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require "bump/cli/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = "bump-cli"
-  spec.version       = Bump::CLI::VERSION
-  spec.authors       = ["Mehdi Lahmam", "Sébastien Charrier"]
-  spec.email         = ["mehdi@lahmam.com", "sebastien@bump.sh"]
+  spec.name = "bump-cli"
+  spec.version = Bump::CLI::VERSION
+  spec.authors = ["Mehdi Lahmam", "Sébastien Charrier"]
+  spec.email = ["mehdi@lahmam.com", "sebastien@bump.sh"]
 
-  spec.summary       = %q{Bump.sh CLI}
-  spec.description   = %q{Bump.sh CLI to interact with the API}
-  spec.homepage      = "https://bump.sh"
-  spec.license       = "MIT"
+  spec.summary = "Bump.sh CLI"
+  spec.description = "Bump.sh CLI to interact with the API"
+  spec.homepage = "https://bump.sh"
+  spec.license = "MIT"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
-  spec.metadata["source_code_uri"]   = "https://github.com/bump-sh/bump-cli"
+  spec.metadata["source_code_uri"] = "https://github.com/bump-sh/bump-cli"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+  spec.files = `git ls-files -z`.split("\x0").reject do |f|
     f.match(%r{^(test|spec|features)/})
   end
-  spec.bindir        = "exe"
-  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.3'
+  spec.required_ruby_version = ">= 2.3"
 
-  spec.add_dependency "dry-cli", '~> 0'
-  spec.add_dependency "http", '>= 3'
+  spec.add_dependency "dry-cli", "~> 0"
+  spec.add_dependency "http", ">= 3"
 
   spec.add_development_dependency "bundler", ">= 1", "< 3"
   spec.add_development_dependency "byebug", "~> 11"
-  spec.add_development_dependency "climate_control", '~> 0'
+  spec.add_development_dependency "climate_control", "~> 0"
   spec.add_development_dependency "rake", "~> 13"
   spec.add_development_dependency "rspec", "~> 3"
+  spec.add_development_dependency "standard"
   spec.add_development_dependency "webmock", "~> 3"
 end

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

@@ -1,5 +1,5 @@
-require 'bump/cli/definition'
-require 'bump/cli/uuid'
+require "bump/cli/definition"
+require "bump/cli/uuid"
 
 module Bump
   class CLI
@@ -18,9 +18,13 @@ module Bump
         def body(file, **options)
           deprecation_warning(options)
 
+          definition = Definition.new(file, import_external_references: !options[:'no-external-references'])
+          definition.prepare!
+
           compact(
             {
-              definition: prepare_file(file, options),
+              definition: definition.content,
+              references: prepare_references(definition.external_references),
               specification: options[:specification],
               validation: options[:validation],
               auto_create_documentation: options[:'auto-create']
@@ -28,20 +32,18 @@ module Bump
           )
         end
 
-        def prepare_file(file, options)
-          Definition.new(file, import_external_references: options[:'import-external-references']).prepare
+        def prepare_references(references)
+          references.reduce([]) { |references, (location, content)|
+            references << {location: location, content: content}
+          }
         end
 
         def deprecation_warning(options)
-          if present?(options[:id])
-            puts "[DEPRECATION WARNING] --id option is deprecated. Please use --doc instead."
+          if options[:"import-external-references"]
+            puts "[DEPRECATION WARNING] --import-external-references option is deprecated. External references are imported by default."
           end
         end
 
-        def present?(string)
-          !string.nil? && string != ''
-        end
-
         def compact(hash)
           hash.delete_if { |key, value| value.nil? }
         end
@@ -79,16 +81,24 @@ module Bump
           yield
         rescue HTTP::Error, Errno::ENOENT, SocketError => error
           abort "Error: #{error.message}"
+        rescue => error
+          warn "An unexpected error occurred. Sorry about that!"
+          warn "We don't monitor errors raised by the CLI running on your computer, so we have not been notified."
+          warn "You can help us fix this by creating an issue on https://github.com/bump-sh/bump-cli/issues/new?template=cli-runtime-error.md."
+          warn "\n"
+          warn "#{error.class}: #{error.message}"
+          warn error.backtrace.take(10).join("\n")
+          exit(1)
         end
 
-        def headers(token: '')
+        def headers(token: "")
           headers = {
-            'Content-Type' => 'application/json',
-            'User-Agent' => USER_AGENT
+            "Content-Type" => "application/json",
+            "User-Agent" => USER_AGENT
           }
 
           if token
-            headers['Authorization'] = "Basic #{Base64.strict_encode64(token + ':')}"
+            headers["Authorization"] = "Basic #{Base64.strict_encode64(token + ":")}"
           end
 
           headers
@@ -109,9 +119,9 @@ module Bump
         end
 
         def display_validation_errors(body)
-          errors = body.dig('errors') || []
+          errors = body.dig("errors") || []
 
-          $stderr.puts "Invalid request:"
+          warn "Invalid request:"
           errors.each do |attribute, messages|
             display_attribute_errors(attribute, messages)
           end
@@ -120,15 +130,14 @@ module Bump
         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}:"
+          if messages.is_a?(String)
+            warn "- #{attribute}: #{messages}"
+          elsif messages.is_a?(Array) && messages.count == 1
+            warn "- #{attribute}: #{messages[0]}"
+          elsif messages.is_a?(Array)
+            warn "- #{attribute}:"
             messages.each do |message|
-              $stderr.puts " #{message}"
+              warn " #{message}"
             end
           end
         end

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

@@ -1,4 +1,4 @@
-require 'base64'
+require "base64"
 
 module Bump
   class CLI
@@ -6,15 +6,15 @@ module Bump
       class Deploy < Base
         desc "Create a new version"
         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: "[DEPRECATED] Documentation id. Use `documentation` option instead"
         option :doc, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation id or slug"
         option :'doc-name', desc: "Documentation name. Used with --auto-create flag."
         option :hub, default: ENV.fetch("BUMP_HUB_ID", ""), desc: "Hub id or slug"
         option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation or Hub token"
         option :specification, desc: "Specification of the definition"
-        option :validation, desc: "Validation mode", values: %w(basic strict), default: 'basic'
-        option :'auto-create', type: :boolean, default: false, desc: 'Automatically create the documentation if needed (only available with a hub and when specifying a slug for documentation)'
-        option :'import-external-references', type: :boolean, default: false, desc: 'Import external $refs (URI or file system) into the specification before sending it to Bump servers'
+        option :validation, desc: "Validation mode", values: %w[basic strict], default: "basic"
+        option :'auto-create', type: :boolean, default: false, desc: "Automatically create the documentation if needed (only available with a hub and when specifying a slug for documentation)"
+        option :'no-external-references', type: :boolean, default: false, desc: "Do not import external references ($ref)"
+        option :'import-external-references', type: :boolean, default: false, desc: "[DEPRECATED] External references are imported by default"
 
         def call(file:, **options)
           with_errors_rescued do

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

@@ -5,8 +5,9 @@ module Bump
         desc "Create a documentation preview for the given file"
         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'
-        option :'import-external-references', type: :boolean, default: false, desc: 'Import external $refs (URI or file system) into the specification before sending it to Bump servers'
+        option :validation, desc: "Validation mode", values: %w[basic strict], default: "basic"
+        option :'no-external-references', type: :boolean, default: false, desc: "Do not import external references ($ref)"
+        option :'import-external-references', type: :boolean, default: false, desc: "[DEPRECATED] External references are imported by default"
 
         def call(file:, **options)
           with_errors_rescued do
@@ -17,7 +18,7 @@ module Bump
 
             if response.code == 201
               body = JSON.parse(response.body)
-              puts "Preview created : #{ROOT_URL + '/preview/' + body['id']} (expires at #{body['expires_at']})"
+              puts "Preview created : #{ROOT_URL + "/preview/" + body["id"]} (expires at #{body["expires_at"]})"
             else
               display_error(response)
             end

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

@@ -1,4 +1,4 @@
-require 'base64'
+require "base64"
 
 module Bump
   class CLI
@@ -6,15 +6,15 @@ module Bump
       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. OpenAPI (2.0 to 3.0.2) and AsyncAPI (2.0) specifications are currently supported."
-        option :id, default: ENV.fetch("BUMP_ID", ""), desc: "[DEPRECATED] Documentation id. Use `documentation` option instead"
         option :doc, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation public id or slug"
         option :'doc-name', desc: "Documentation name. Used with --auto-create flag."
         option :hub, desc: "Hub id or slug"
         option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation or Hub token"
         option :specification, desc: "Specification of the definition"
-        option :validation, desc: "Validation mode", values: %w(basic strict), default: 'basic'
-        option :'auto-create', type: :boolean, default: false, desc: 'Automatically create the documentation if needed (only available with a hub and when specifying a slug for documentation)'
-        option :'import-external-references', type: :boolean, default: false, desc: 'Import external $refs (URI or file system) into the specification before sending it to Bump servers'
+        option :validation, desc: "Validation mode", values: %w[basic strict], default: "basic"
+        option :'auto-create', type: :boolean, default: false, desc: "Automatically create the documentation if needed (only available with a hub and when specifying a slug for documentation)"
+        option :'no-external-references', type: :boolean, default: false, desc: "Do not import external references ($ref)"
+        option :'import-external-references', type: :boolean, default: false, desc: "[DEPRECATED] External references are imported by default"
 
         def call(file:, **options)
           with_errors_rescued do

data/lib/bump/cli/definition.rb

@@ -1,20 +1,22 @@
-require 'open-uri'
-require 'bump/cli/parser'
-require 'bump/cli/references'
+require "bump/cli/references"
+require "bump/cli/resource"
 
 module Bump
   class CLI
     class Definition
+      attr_reader :content, :external_references
+
       def initialize(path, import_external_references: false)
         @path = path
         @import_external_references = import_external_references
+        @external_references = References.new(root_path: find_base_path(path))
       end
 
-      def prepare
-        if !import_external_references
-          read_file
-        else
-          parse_file_and_import_external_references
+      def prepare!
+        @content = Resource.read(path)
+
+        if import_external_references
+          external_references.load(Resource.parse(content))
         end
       end
 
@@ -22,21 +24,8 @@ module Bump
 
       attr_reader :path, :import_external_references
 
-      def read_file
-        open(path).read
-      end
-
-      def parse_file_and_import_external_references
-        original_format, definition = parser.load(read_file)
-
-        references = References.new(definition, base_path: path)
-        references.import!
-
-        parser.dump(references.definition, original_format)
-      end
-
-      def parser
-        @parser ||= Parser.new
+      def find_base_path(path)
+        Pathname.new(path.to_s).dirname.to_s + Pathname::SEPARATOR_LIST
       end
     end
   end

data/lib/bump/cli/references.rb

@@ -1,91 +1,67 @@
-require 'open-uri'
-require 'pathname'
+require "open-uri"
+require "pathname"
 
 module Bump
   class CLI
-    class References
-      attr_reader :definition
-
-      def initialize(definition, base_path: '')
-        @definition = definition
-        @base_path = cleanup(base_path)
-        @processed = false
-        @external_references = {}
+    class References < Hash
+      def initialize(root_path: "")
+        @root_path = root_path
       end
 
-      def import!
-        if !processed
-          @definition = traverse_and_replace_external_references(definition)
-          import_references
-          @processed = true
-        end
+      def load(definition)
+        traverse_and_load_external_references(definition) if definition.is_a?(Enumerable)
       end
 
       private
 
-      attr_reader :base_path, :processed, :external_references
+      attr_reader :root_path
 
-      def traverse_and_replace_external_references(current)
+      def traverse_and_load_external_references(current)
         current.each do |key, value|
-          if key == '$ref'
-            current[key] = replace_external_reference(value)
+          if key == "$ref"
+            load_external_reference(value) if external?(value)
           elsif value.is_a?(Hash)
-            traverse_and_replace_external_references(value)
+            traverse_and_load_external_references(value)
           elsif value.is_a?(Array)
             value.each do |array_value|
-              traverse_and_replace_external_references(array_value)
+              if array_value.is_a?(Hash)
+                traverse_and_load_external_references(array_value)
+              end
             end
           end
         end
       end
 
-      def replace_external_reference(reference)
-        if external?(reference)
-          if external_references[reference].nil?
-            @external_references[reference] = "#{external_references.count + 1}"
-          end
-
-          subpath = reference[/#(.*)$/, 1]
-          "#/components/x-imported/#{external_references[reference]}#{ '/' + subpath if !subpath.nil? }"
-        else
-          reference
+      def load_external_reference(reference)
+        if self[reference].nil?
+          base_reference = cleanup_reference(reference)
+          location = prepare_location(base_reference)
+          self[base_reference] = Resource.read(location)
         end
       end
 
-      def import_references
-        if external_references.count > 0
-          @definition['components'] = {} if @definition['components'].nil?
-          @definition['components']['x-imported'] = {} if @definition['components']['x-imported'].nil?
-
-          external_references.each do |key, value|
-            _, @definition['components']['x-imported'][value.to_s] = Parser.new.load(open(prepare_path(key)).read)
-          end
-        end
+      def cleanup_reference(reference)
+        reference.sub(/#.*/, "")
       end
 
-      def prepare_path(key)
-        key = key.sub(/#.*/, '')
-        if url?(key) || absolute_path?(key)
-          key
+      def prepare_location(reference)
+        if url?(reference) || absolute_path?(reference)
+          reference
         else
-          base_path + key
+          root_path + reference
         end
       end
 
       def external?(reference)
-        !reference.start_with?('#')
+        !reference.start_with?("#")
       end
 
       def url?(path)
-        path.start_with?('http')
+        path.start_with?("http")
       end
 
       def absolute_path?(path)
-        path.start_with?('/')
-      end
-
-      def cleanup(path)
-        Pathname.new(path).dirname.to_s + Pathname::SEPARATOR_LIST
+        path.start_with?("/")
       end
     end
   end

data/lib/bump/cli/resource.rb

@@ -0,0 +1,26 @@
+require "json"
+require "yaml"
+
+module Bump
+  class CLI
+    class Resource
+      def self.read(location)
+        if location.start_with?("http")
+          ::HTTP.get(location).to_s
+        else
+          ::File.read(location).force_encoding(Encoding::UTF_8)
+        end
+      end
+
+      def self.parse(content)
+        ::JSON.parse(content)
+      rescue ::JSON::ParserError
+        begin
+          ::YAML.safe_load(content, [Date, Time])
+        rescue ::Psych::SyntaxError
+          content
+        end
+      end
+    end
+  end
+end

data/lib/bump/cli/version.rb

@@ -1,5 +1,5 @@
 module Bump
   class CLI
-    VERSION = "0.6.1"
+    VERSION = "0.7.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bump-cli
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.7.0
 platform: ruby
 authors:
 - Mehdi Lahmam
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-10-09 00:00:00.000000000 Z
+date: 2021-03-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -115,6 +115,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: standard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -139,6 +153,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".circleci/config.yml"
+- ".github/ISSUE_TEMPLATE/cli-runtime-error.md"
 - ".gitignore"
 - ".travis.yml"
 - CODE_OF_CONDUCT.md
@@ -156,8 +171,8 @@ files:
 - lib/bump/cli/commands/preview.rb
 - lib/bump/cli/commands/validate.rb
 - lib/bump/cli/definition.rb
-- lib/bump/cli/parser.rb
 - lib/bump/cli/references.rb
+- lib/bump/cli/resource.rb
 - lib/bump/cli/uuid.rb
 - lib/bump/cli/version.rb
 homepage: https://bump.sh

data/lib/bump/cli/parser.rb

@@ -1,26 +0,0 @@
-require 'json'
-require 'yaml'
-
-module Bump
-  class CLI
-    class Parser
-      def load(content)
-        [:json, ::JSON.parse(content)]
-      rescue ::JSON::ParserError => e
-        begin
-          [:yaml, ::YAML.safe_load(content, [Date, Time])]
-        rescue ::Psych::SyntaxError
-          [:text, content]
-        end
-      end
-
-      def dump(definition, format)
-        if format == :yaml
-          ::YAML.dump(definition)
-        else
-          ::JSON.dump(definition)
-        end
-      end
-    end
-  end
-end