bump-cli 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f05f855eadd927f38eaa826e35ca2261414d3e46b004a1f0ebea38cf3687def8
-  data.tar.gz: 68b1c1580133034e65b7e501caf218ebbeb4f496c9bb9acc9c2bb5276d0945fa
+  metadata.gz: a76424c2ad6eed8a8b65caa28e57e26c7efb892b8909a9e6aed60871b9964105
+  data.tar.gz: 4f597a0961e36cfb2108409198a11abae798333b49fadf298fbd0f7b332c529a
 SHA512:
-  metadata.gz: b83e980a9565c4b0ccb28d4853ec70da95e35c3579df9efc251555c370abe82d1568d1005b5e43a505a32fbcad8569181f5c2dca6341af07832663e15025ca16
-  data.tar.gz: d6bff352f2a5611cfd293ee9eb142277e9931f0e675f9769ae2f57c0ca534d5d8dca412737529f2126a5624660af1ef7b49b3241c6fa48a604478c5138e192f0
+  metadata.gz: bda499aed9b3edfb4600ccd8ede77a65dd6bd98403937f29b714c557e8fb5457f8258d49d55ab5968499c5e10ff67b6a0cd446d3304a5b0ea69afeab20f0e47d
+  data.tar.gz: 2fa948728d09d134b552954d12d2f64d3141bf5c0422ffdd95ec853afed861aed0440c4c6a3ff5378025f5788d1ceb535e04c37a12e8b4180441d35b850b499c

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
@@ -20,7 +20,7 @@ module Bump
 
           compact(
             {
-              definition: open(file).read,
+              definition: prepare_file(file, options),
               specification: options[:specification],
               validation: options[:validation],
               auto_create_documentation: options[:'auto-create']
@@ -28,6 +28,10 @@ module Bump
           )
         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."
@@ -56,7 +60,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 +68,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)

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

@@ -14,6 +14,7 @@ module Bump
         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:, **options)
           with_errors_rescued do

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

@@ -6,6 +6,7 @@ module Bump
         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:, **options)
           with_errors_rescued do

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

@@ -14,6 +14,7 @@ module Bump
         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:, **options)
           with_errors_rescued do

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.5.1"
+    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.5.1
+  version: 0.6.0
 platform: ruby
 authors:
 - Mehdi Lahmam
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-08 00:00:00.000000000 Z
+date: 2020-06-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-cli
@@ -155,7 +155,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/parser.rb
+- lib/bump/cli/references.rb
+- lib/bump/cli/uuid.rb
 - lib/bump/cli/version.rb
 homepage: https://bump.sh
 licenses:

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