bump-cli 0.4.1 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 037f50e1dc85f791e29b7d04610c536d5c5de55465129218036508f7dc9b4f23
-  data.tar.gz: a88fcc165c82445b31447194f4156479793294519327b7a37e0f253a532043d3
+  metadata.gz: d7f6a735076725944a751da14fdcf7dab5dafcaea84cf1b18d433d05bb23be71
+  data.tar.gz: d8ee9a2b87963ba54ea9bdc373ba02a1a85b23b6255dd58d9291d0855b927ce8
 SHA512:
-  metadata.gz: 62985d280a33db74d42a6afafde570231aca07a18fbae7a492756352f9315ea38b7fc7fa97b188d0dd2823d65a82e6cc8b639449b1064746f831d7c3de1a5e2f
-  data.tar.gz: 6179fc9f2b65c33c4416f869a1c7c1e41b825d81a1e77533bb3d84e6a319f870c79ffbd45b5ac53b4d4a9f54fd23d841959fd40f83cac77457124dd82defa438
+  metadata.gz: 3fc376b3b9b123f0b70ed488a49b651e2ed17ba95888bd07fcb9e7fb793663bea97d0f36d1e0508f2c4619b28186f568f607264c806ede9983a34e323d5fd7c8
+  data.tar.gz: b2f9e4d90a99813e03e6a46f2d7ecd43d43c449c238c89a1a3bf4eb70c79f1be7f09df7b1a2b0b70d6e816800e2135bf141a32422c97fce24ecf72cac591497d

data/.gitignore

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

data/README.md

@@ -29,25 +29,31 @@ Bump tries to identify your file specification and format automatically. You can
 * `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.
+`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.
 
+Preview a documentation:
+
     $ bundle exec bump preview path/to/your/file.yml
 
 ### Validate
 
-Validate your file against its specification.
+Validate your file against its specification:
 
-    $ bundle exec bump validate path/to/your/file.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/file.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,10 +26,10 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 2.3'
 
-  spec.add_dependency "hanami-cli", '~> 0'
+  spec.add_dependency "dry-cli", '~> 0'
   spec.add_dependency "http", '>= 3'
 
-  spec.add_development_dependency "bundler", "~> 1"
+  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", "~> 13"

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/tools/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,12 +15,56 @@ module Bump
             .post(url, body: body)
         end
 
-        def body(file, specification, validation)
-          {
-            definition: open(file).read,
-            specification: specification,
-            validation: validation
-          }
+        def body(file, **options)
+          deprecation_warning(options)
+
+          compact(
+            {
+              definition: open(file).read,
+              specification: options[:specification],
+              validation: options[:validation],
+              auto_create_documentation: options[:'auto-create']
+            }.merge(documentation_or_hub(options))
+          )
+        end
+
+        def deprecation_warning(options)
+          if !options[:id].nil?
+            puts "[DEPRECATION WARNING] --id option is deprecated. Please use --doc instead."
+          end
+        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::Tools::UUID.valid?(options[:doc])
+        end
+
+        def documentation_slug?(options)
+          !options[:doc].nil? && !documentation_uuid?(options)
+        end
+
+        def hub_uuid?(options)
+          Bump::CLI::Tools::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

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

@@ -7,11 +7,11 @@ module Bump
         option :specification, desc: "Specification of the definition"
         option :validation, desc: "Validation mode", values: %w(basic strict), default: 'basic'
 
-        def call(file:, validation:, specification: nil)
+        def call(file:, **options)
           with_errors_rescued do
             response = post(
               url: API_URL + "/previews",
-              body: body(file, specification, validation).to_json
+              body: body(file, options).to_json
             )
 
             if response.code == 201

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

@@ -6,17 +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: "Documentation public id"
-        option :token, default: ENV.fetch("BUMP_TOKEN", ""), desc: "Documentation private token"
+        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)'
 
-        def call(file:, id:, token:, validation:, specification: nil)
+        def call(file:, **options)
           with_errors_rescued do
             response = post(
-              url: API_URL + "/docs/#{id}/validations",
-              body: body(file, specification, validation).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/tools/uuid.rb

@@ -0,0 +1,13 @@
+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

data/lib/bump/cli/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: bump-cli
 version: !ruby/object:Gem::Version
-  version: 0.4.1
+  version: 0.5.0
 platform: ruby
 authors:
 - Mehdi Lahmam
@@ -9,10 +9,10 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-02-11 00:00:00.000000000 Z
+date: 2020-04-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: hanami-cli
+  name: dry-cli
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
@@ -43,16 +43,22 @@ dependencies:
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1'
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: '3'
 - !ruby/object:Gem::Dependency
   name: byebug
   requirement: !ruby/object:Gem::Requirement
@@ -149,6 +155,7 @@ 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/version.rb
 homepage: https://bump.sh
 licenses: