bump-cli 0.3.2 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: aa0bd892b8317be2e6bce1fe83c0d747c6ae989fe3e02c69730479e9c595ba9b
-  data.tar.gz: '0924e8faa5b4221383c8c3ea0dc80774790666a5568c7180e51ad655a5c9cfcd'
+  metadata.gz: a76424c2ad6eed8a8b65caa28e57e26c7efb892b8909a9e6aed60871b9964105
+  data.tar.gz: 4f597a0961e36cfb2108409198a11abae798333b49fadf298fbd0f7b332c529a
 SHA512:
-  metadata.gz: de9f6fe376a5ebba4144c595004d5b990a10be581a58ca6af116d80ab9cb957cdbe9e03a549ea7ba1b2597f194e38bc5d9b001232beb0675cf152a01ca599021
-  data.tar.gz: 7fa8848a39ceabc042183cb1d5fe5151f6956f001149a01db4751d02c05793e3a6306695b432fda851dbb88741a20a770bd78ae47fd891765f0ddb395c6099bd
+  metadata.gz: bda499aed9b3edfb4600ccd8ede77a65dd6bd98403937f29b714c557e8fb5457f8258d49d55ab5968499c5e10ff67b6a0cd446d3304a5b0ea69afeab20f0e47d
+  data.tar.gz: 2fa948728d09d134b552954d12d2f64d3141bf5c0422ffdd95ec853afed861aed0440c4c6a3ff5378025f5788d1ceb535e04c37a12e8b4180441d35b850b499c

data/.gitignore

@@ -1,4 +1,5 @@
 .byebug_history
+.ruby-version
 /.bundle/
 /.yardoc
 /Gemfile.lock

data/README.md

@@ -20,27 +20,40 @@ 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`
+
+`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`.
 
 ### 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
+Preview a documentation:
+
+    $ 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 --doc DOC_ID_OR_SLUG --token DOC_TOKEN
 
 ### Deploy
 
-Deploy the file as the current version of the documentation.
+Deploy the file as the current version of the documentation:
+
+    $ bundle exec bump deploy path/to/your/file.yml --doc DOC_ID_OR_SLUG --token DOC_TOKEN
+
+Automatically create a documentation inside a hub and deploy it:
 
-    $ bundle exec bump deploy path/to/your/openapi.yml --id DOC_ID --token DOC_TOKEN
+    $ bundle exec bump deploy path/to/your/file.yml --auto-create --doc DOC_SLUG --hub HUB_ID_OR_SLUG --token HUB_TOKEN
 
 ## Development
 

data/bump-cli.gemspec

@@ -26,13 +26,13 @@ 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 "dry-cli", '~> 0'
+  spec.add_dependency "http", '>= 3'
 
-  spec.add_development_dependency "bundler", "~> 1.15"
-  spec.add_development_dependency "byebug", "~> 9"
+  spec.add_development_dependency "bundler", ">= 1", "< 3"
+  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.rb

@@ -1,5 +1,5 @@
 require "bump/cli/version"
-require "hanami/cli"
+require "dry/cli"
 require "http"
 
 module Bump
@@ -9,11 +9,11 @@ module Bump
     API_URL = ROOT_URL + API_PATH
 
     def call(*args)
-      Hanami::CLI.new(Commands).call(*args)
+      Dry::CLI.new(Commands).call(*args)
     end
 
     module Commands
-      extend Hanami::CLI::Registry
+      extend Dry::CLI::Registry
     end
   end
 end

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

@@ -1,9 +1,10 @@
-require 'open-uri'
+require 'bump/cli/definition'
+require 'bump/cli/uuid'
 
 module Bump
   class CLI
     module Commands
-      class Base < Hanami::CLI::Command
+      class Base < Dry::CLI::Command
         USER_AGENT = "bump-cli/#{VERSION}".freeze
 
         private
@@ -14,11 +15,64 @@ module Bump
             .post(url, body: body)
         end
 
-        def body(file, specification)
-          {
-            definition: open(file).read,
-            specification: specification
-          }
+        def body(file, **options)
+          deprecation_warning(options)
+
+          compact(
+            {
+              definition: prepare_file(file, options),
+              specification: options[:specification],
+              validation: options[:validation],
+              auto_create_documentation: options[:'auto-create']
+            }.merge(documentation_or_hub(options))
+          )
+        end
+
+        def prepare_file(file, options)
+          Definition.new(file, import_external_references: options[:'import-external-references']).prepare
+        end
+
+        def deprecation_warning(options)
+          if present?(options[:id])
+            puts "[DEPRECATION WARNING] --id option is deprecated. Please use --doc instead."
+          end
+        end
+
+        def present?(string)
+          !string.nil? && string != ''
+        end
+
+        def compact(hash)
+          hash.delete_if { |key, value| value.nil? }
+        end
+
+        def documentation_or_hub(options)
+          result = {}
+
+          result[:documentation_id] = options[:id]
+          result[:documentation_id] = options[:doc] if documentation_uuid?(options)
+          result[:documentation_slug] = options[:doc] if documentation_slug?(options)
+          result[:documentation_name] = options[:'doc-name']
+          result[:hub_id] = options[:hub] if hub_uuid?(options)
+          result[:hub_slug] = options[:hub] if hub_slug?(options)
+
+          compact(result)
+        end
+
+        def documentation_uuid?(options)
+          Bump::CLI::UUID.valid?(options[:doc])
+        end
+
+        def documentation_slug?(options)
+          !options[:doc].nil? && !documentation_uuid?(options)
+        end
+
+        def hub_uuid?(options)
+          Bump::CLI::UUID.valid?(options[:hub])
+        end
+
+        def hub_slug?(options)
+          !options[:hub].nil? && !hub_uuid?(options)
         end
 
         def with_errors_rescued

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

@@ -5,17 +5,23 @@ 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."
-        option :id, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation public id"
-        option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation private token"
+        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'
 
-        def call(file:, id:, token:, specification: nil)
+        def call(file:, **options)
           with_errors_rescued do
             response = post(
-              url: API_URL + "/docs/#{id}/versions",
-              body: body(file, specification).to_json,
-              token: token
+              url: API_URL + "/versions",
+              body: body(file, options).to_json,
+              token: options[:token]
             )
 
             if response.code == 201

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."
+        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'
 
-        def call(file:, specification: nil)
+        def call(file:, **options)
           with_errors_rescued do
             response = post(
               url: API_URL + "/previews",
-              body: body(file, specification).to_json
+              body: body(file, options).to_json
             )
 
             if response.code == 201

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

@@ -5,17 +5,23 @@ 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."
-        option :id, default: ENV.fetch("BUMP_ID", ""), desc: "Documentation public id"
-        option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation private token"
+        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'
 
-        def call(file:, id:, token:, specification: nil)
+        def call(file:, **options)
           with_errors_rescued do
             response = post(
-              url: API_URL + "/docs/#{id}/validations",
-              body: body(file, specification).to_json,
-              token: token
+              url: API_URL + "/validations",
+              body: body(file, options).to_json,
+              token: options[:token]
             )
 
             if response.code == 200

data/lib/bump/cli/definition.rb

@@ -0,0 +1,43 @@
+require 'open-uri'
+require 'bump/cli/parser'
+require 'bump/cli/references'
+
+module Bump
+  class CLI
+    class Definition
+      def initialize(path, import_external_references: false)
+        @path = path
+        @import_external_references = import_external_references
+      end
+
+      def prepare
+        if !import_external_references
+          read_file
+        else
+          parse_file_and_import_external_references
+        end
+      end
+
+      private
+
+      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
+      end
+    end
+  end
+end

data/lib/bump/cli/parser.rb

@@ -0,0 +1,24 @@
+require 'json'
+require 'yaml'
+
+module Bump
+  class CLI
+    class Parser
+      def load(content)
+        [:json, ::JSON.parse(content)]
+      rescue ::JSON::ParserError => e
+        [:yaml, ::YAML.safe_load(content, [Date, Time])]
+      rescue ::Psych::SyntaxError
+        raise 'Invalid format: definition file should be valid YAML or JSON'
+      end
+
+      def dump(definition, format)
+        if format == :yaml
+          ::YAML.dump(definition)
+        else
+          ::JSON.dump(definition)
+        end
+      end
+    end
+  end
+end

data/lib/bump/cli/references.rb

@@ -0,0 +1,88 @@
+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 = {}
+      end
+
+      def import!
+        if !processed
+          @definition = traverse_and_replace_external_references(definition)
+          import_references
+          @processed = true
+        end
+      end
+
+      private
+
+      attr_reader :base_path, :processed, :external_references
+
+      def traverse_and_replace_external_references(current, parent = nil)
+        current.each do |key, value|
+          if key == '$ref'
+            current[key] = replace_external_reference(value)
+          elsif value.is_a?(Hash)
+            traverse_and_replace_external_references(value, key)
+          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
+        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
+      end
+
+      def prepare_path(key)
+        key = key.sub(/#.*/, '')
+        if url?(key) || absolute_path?(key)
+          key
+        else
+          base_path + key
+        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
+
+      def cleanup(path)
+        Pathname.new(path).dirname.to_s + Pathname::SEPARATOR_LIST
+      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.3.2"
+    VERSION = "0.6.0"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bump-cli
 version: !ruby/object:Gem::Version
-  version: 0.3.2
+  version: 0.6.0
 platform: ruby
 authors:
 - Mehdi Lahmam
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2019-01-17 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hanami-cli
+  name: dry-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -29,44 +29,50 @@ 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
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1'
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '1.15'
+        version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '9'
+        version: '11'
 - !ruby/object:Gem::Dependency
   name: climate_control
   requirement: !ruby/object:Gem::Requirement
@@ -87,14 +93,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
@@ -149,6 +155,10 @@ files:
 - lib/bump/cli/commands/deploy.rb
 - 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/uuid.rb
 - lib/bump/cli/version.rb
 homepage: https://bump.sh
 licenses: