bump-cli 0.5.1 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f05f855eadd927f38eaa826e35ca2261414d3e46b004a1f0ebea38cf3687def8
-  data.tar.gz: 68b1c1580133034e65b7e501caf218ebbeb4f496c9bb9acc9c2bb5276d0945fa
+  metadata.gz: 7864d9fa40e4b79da664f8c470553d4cb441c68b98ec7864f14a73a1bf74cca7
+  data.tar.gz: 9bf79f7526d64a7d4505401f7b624f2f24970d181005cb0fecb7fdcca9169c84
 SHA512:
-  metadata.gz: b83e980a9565c4b0ccb28d4853ec70da95e35c3579df9efc251555c370abe82d1568d1005b5e43a505a32fbcad8569181f5c2dca6341af07832663e15025ca16
-  data.tar.gz: d6bff352f2a5611cfd293ee9eb142277e9931f0e675f9769ae2f57c0ca534d5d8dca412737529f2126a5624660af1ef7b49b3241c6fa48a604478c5138e192f0
+  metadata.gz: c9bdb8df99ff13e7b0b41a0d8512bb9a950882eecafca78374fcee7e8f8e88eb43a9cc0efc75e97ef4c82405ff1d8e43d77a84153e94fc235072ebce1f390517
+  data.tar.gz: 721abefc4a876cd07f6a09195b63973131ef17353acf7133891d9f31106527ce1a7c250e3847d495e97d0e80eb4fe4b421d6f05555b3e97c1578c56539ecb8e4

data/.circleci/config.yml

@@ -3,7 +3,7 @@ jobs:
   build-latest: &common-build
     working_directory: ~/bump-cli
     docker:
-      - image: circleci/ruby:2.5.0-node
+      - image: circleci/ruby:latest
     steps:
       - checkout
       - run:
@@ -29,20 +29,30 @@ jobs:
 
       - run:
           name: Run tests
-          command: rake
+          command: bundle exec rspec
+  build-2-6:
+    <<: *common-build
+    docker:
+      - image: circleci/ruby:2.6
+  build-2-5:
+    <<: *common-build
+    docker:
+      - image: circleci/ruby:2.5
   build-2-4:
     <<: *common-build
     docker:
-      - image: circleci/ruby:2.4.3-node
+      - image: circleci/ruby:2.4
   build-2-3:
     <<: *common-build
     docker:
-      - image: circleci/ruby:2.3.6-node
+      - image: circleci/ruby:2.3
 
 workflows:
   version: 2
   build:
     jobs:
       - build-latest
+      - build-2-6
+      - build-2-5
       - build-2-4
       - build-2-3

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

@@ -1,5 +1,12 @@
 # Bump::CLI
 
+**⚠️ DEPRECATION WARNING:** This repository is now deprecated in favor of our [new Node based Bump CLI](https://github.com/bump-sh/cli). Please migrate to v2.x+ version of our CLI to enjoy all features of Bump.sh. ⚠️
+
+- [**Read the new CLI announcement**](https://headwayapp.co/bump-changelog/new-command-line-interface-era-196226)
+- [**Read our Bump CLI help section**](https://help.bump.sh/bump-cli)
+
+_If you still want to use this ruby gem, please [contact us](mailto:hello@bump.sh) to discuss alternatives and share your use case. Thank you!_
+
 The `bump-cli` gem provides a simple command line access to the Bump (https://bump.sh) API.
 
 ## Installation
@@ -29,7 +36,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.rb

@@ -9,6 +9,14 @@ module Bump
     API_URL = ROOT_URL + API_PATH
 
     def call(*args)
+      warn ":WARNING:"
+      warn "  This Bump CLI is now legacy and will not be maintained any further."
+      warn ""
+      warn "  Please update to our new v2.x CLI available at https://github.com/bump-sh/cli"
+      warn "  You can install the new Bump CLI with 'npm install -g bump-cli'"
+      warn "                                     or 'yarn global add bump-cli'"
+      warn ":WARNING:"
+      warn ""
       Dry::CLI.new(Commands).call(*args)
     end
 

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

@@ -1,5 +1,5 @@
-require 'open-uri'
-require 'bump/cli/tools/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: open(file).read,
+              definition: definition.content,
+              references: prepare_references(definition.external_references),
               specification: options[:specification],
               validation: options[:validation],
               auto_create_documentation: options[:'auto-create']
@@ -28,14 +32,16 @@ module Bump
           )
         end
 
-        def deprecation_warning(options)
-          if present?(options[:id])
-            puts "[DEPRECATION WARNING] --id option is deprecated. Please use --doc instead."
-          end
+        def prepare_references(references)
+          references.reduce([]) { |references, (location, content)|
+            references << {location: location, content: content}
+          }
         end
 
-        def present?(string)
-          !string.nil? && string != ''
+        def deprecation_warning(options)
+          if options[:"import-external-references"]
+            puts "[DEPRECATION WARNING] --import-external-references option is deprecated. External references are imported by default."
+          end
         end
 
         def compact(hash)
@@ -56,7 +62,7 @@ module Bump
         end
 
         def documentation_uuid?(options)
-          Bump::CLI::Tools::UUID.valid?(options[:doc])
+          Bump::CLI::UUID.valid?(options[:doc])
         end
 
         def documentation_slug?(options)
@@ -64,7 +70,7 @@ module Bump
         end
 
         def hub_uuid?(options)
-          Bump::CLI::Tools::UUID.valid?(options[:hub])
+          Bump::CLI::UUID.valid?(options[:hub])
         end
 
         def hub_slug?(options)
@@ -75,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
@@ -105,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
@@ -116,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,27 +6,28 @@ 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 :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
             response = post(
               url: API_URL + "/versions",
-              body: body(file, options).to_json,
+              body: body(file, **options).to_json,
               token: options[:token]
             )
 
             if response.code == 201
-              puts "New version has been successfully deployed."
+              puts "The new version is currently being processed."
             elsif response.code == 204
-              puts "Version was already deployed."
+              puts "This version has already been deployed."
             else
               display_error(response)
             end

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

@@ -5,18 +5,20 @@ 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 :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
             response = post(
               url: API_URL + "/previews",
-              body: body(file, options).to_json
+              body: body(file, **options).to_json
             )
 
             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,20 +6,21 @@ 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 :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
             response = post(
               url: API_URL + "/validations",
-              body: body(file, options).to_json,
+              body: body(file, **options).to_json,
               token: options[:token]
             )
 

data/lib/bump/cli/definition.rb

@@ -0,0 +1,32 @@
+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!
+        @content = Resource.read(path)
+
+        if import_external_references
+          external_references.load(Resource.parse(content))
+        end
+      end
+
+      private
+
+      attr_reader :path, :import_external_references
+
+      def find_base_path(path)
+        Pathname.new(path.to_s).dirname.to_s + Pathname::SEPARATOR_LIST
+      end
+    end
+  end
+end

data/lib/bump/cli/references.rb

@@ -0,0 +1,68 @@
+require "open-uri"
+require "pathname"
+
+module Bump
+  class CLI
+    class References < Hash
+      def initialize(root_path: "")
+        @root_path = root_path
+      end
+
+      def load(definition)
+        traverse_and_load_external_references(definition) if definition.is_a?(Enumerable)
+      end
+
+      private
+
+      attr_reader :root_path
+
+      def traverse_and_load_external_references(current)
+        current.each do |key, value|
+          if key == "$ref"
+            load_external_reference(value) if external?(value)
+          elsif value.is_a?(Hash)
+            traverse_and_load_external_references(value)
+          elsif value.is_a?(Array)
+            value.each do |array_value|
+              if array_value.is_a?(Hash)
+                traverse_and_load_external_references(array_value)
+              end
+            end
+          end
+        end
+      end
+
+      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 cleanup_reference(reference)
+        reference.sub(/#.*/, "")
+      end
+
+      def prepare_location(reference)
+        if url?(reference) || absolute_path?(reference)
+          reference
+        else
+          root_path + reference
+        end
+      end
+
+      def external?(reference)
+        !reference.start_with?("#")
+      end
+
+      def url?(path)
+        path.start_with?("http")
+      end
+
+      def absolute_path?(path)
+        path.start_with?("/")
+      end
+    end
+  end
+end

data/lib/bump/cli/resource.rb

@@ -0,0 +1,27 @@
+require "json"
+require "yaml"
+
+module Bump
+  class CLI
+    class Resource
+      def self.read(location)
+        if location.start_with?("http")
+          ::HTTP.follow(max_hops: 50)
+            .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/uuid.rb

@@ -0,0 +1,11 @@
+module Bump
+  class CLI
+    class UUID
+      REGEXP = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
+
+      def self.valid?(string)
+        string.to_s =~ REGEXP
+      end
+    end
+  end
+end

data/lib/bump/cli/version.rb

@@ -1,5 +1,5 @@
 module Bump
   class CLI
-    VERSION = "0.5.1"
+    VERSION = "0.8.0"
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: bump-cli
 version: !ruby/object:Gem::Version
-  version: 0.5.1
+  version: 0.8.0
 platform: ruby
 authors:
 - Mehdi Lahmam
 - Sébastien Charrier
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2021-07-16 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
@@ -155,7 +170,10 @@ files:
 - lib/bump/cli/commands/deploy.rb
 - lib/bump/cli/commands/preview.rb
 - lib/bump/cli/commands/validate.rb
-- lib/bump/cli/tools/uuid.rb
+- lib/bump/cli/definition.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
 licenses:
@@ -163,7 +181,7 @@ licenses:
 metadata:
   allowed_push_host: https://rubygems.org
   source_code_uri: https://github.com/bump-sh/bump-cli
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -178,9 +196,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.4
-signing_key: 
+rubygems_version: 3.1.2
+signing_key:
 specification_version: 4
 summary: Bump.sh CLI
 test_files: []

data/lib/bump/cli/tools/uuid.rb

@@ -1,13 +0,0 @@
-module Bump
-  class CLI
-    module Tools
-      class UUID
-        REGEXP = /^[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}$/
-
-        def self.valid?(string)
-          string.to_s =~ REGEXP
-        end
-      end
-    end
-  end
-end