swagalicious 0.1.0 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 941a558739b2079027c117ccea67ffc90c7a21f682811ab817a739ef0ea93d82
-  data.tar.gz: 275cce80dedbfcaa5b5e76d01499fe18babcc7e30a948806ad95df1cea46d475
+  metadata.gz: a5c37b19faf98f5e71159ac6285f997cb4387f8e4647087f19d33546fee346a7
+  data.tar.gz: fdab1f1246d2eb02a3d8279f6db96e5f3b067ebfef940c5e9cbb558525b60680
 SHA512:
-  metadata.gz: 2e8f90a288217b8e27e85411194a73a7f5d1bbe7bd8881a1f086c11319b8ee9a832143bc9c610a8398fb11051484be70f828f3a1625d5c2180d5e1d1194e5121
-  data.tar.gz: 181ff6d1a9dcab5b13499f648b75299f4ab6321c2ea4d65956a94d4bd8b62f90d8e049c771629ed457ca828635f7f90ab35f9bba630b437d0ebb11136d0cdb19
+  metadata.gz: 2197185fc859b4cc8912aeb8467c3dd3097df510b0ba790ee194d1a22317479be3e1a635e21eac7d27803d1e59a2ef6bb42c958eea555dbb8436389d19a67043
+  data.tar.gz: 47d027e1184e3e7e74a6896b3d56f04a1ea096b287b964b5578489fe522b61cea4125380ae96f1f368e295b621fa98df6fddbc92bb9cc3306eb830dd0a9a8d35

data/Gemfile.lock

@@ -1,50 +1,81 @@
 PATH
   remote: .
   specs:
-    swagalicious (0.1.0)
-      faraday (~> 1.0.1)
+    swagalicious (0.3.1)
+      faraday (~> 1.3.0)
       json-schema (~> 2.8.1)
-      oj (~> 3.10.14)
-      rack-test (~> 1.1.0)
+      oj (~> 3.11.0)
+      rspec (~> 3.10.0)
 
 GEM
   remote: https://rubygems.org/
   specs:
+    activesupport (6.1.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
     addressable (2.7.0)
       public_suffix (>= 2.0.2, < 5.0)
+    byebug (11.1.3)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.8)
     diff-lcs (1.4.4)
-    faraday (1.0.1)
+    factory_bot (6.1.0)
+      activesupport (>= 5.0.0)
+    faraday (1.3.0)
+      faraday-net_http (~> 1.0)
       multipart-post (>= 1.2, < 3)
+      ruby2_keywords
+    faraday-net_http (1.0.1)
+    i18n (1.8.7)
+      concurrent-ruby (~> 1.0)
     json-schema (2.8.1)
       addressable (>= 2.4)
+    method_source (1.0.0)
+    minitest (5.14.3)
     multipart-post (2.1.1)
-    oj (3.10.14)
+    oj (3.11.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    pry-byebug (3.9.0)
+      byebug (~> 11.0)
+      pry (~> 0.13.0)
     public_suffix (4.0.6)
     rack (2.2.3)
     rack-test (1.1.0)
       rack (>= 1.0, < 3)
     rake (12.3.3)
-    rspec (3.9.0)
-      rspec-core (~> 3.9.0)
-      rspec-expectations (~> 3.9.0)
-      rspec-mocks (~> 3.9.0)
-    rspec-core (3.9.2)
-      rspec-support (~> 3.9.3)
-    rspec-expectations (3.9.2)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-mocks (3.9.1)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.9.0)
-    rspec-support (3.9.3)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.1)
+    ruby2_keywords (0.0.4)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    zeitwerk (2.4.2)
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
+  factory_bot (~> 6.1.0)
+  pry-byebug (~> 3.9.0)
+  rack-test (~> 1.1.0)
   rake (~> 12.0)
   rspec (~> 3.0)
   swagalicious!
 
 BUNDLED WITH
-   2.1.2
+   2.2.6

data/README.md

@@ -27,13 +27,11 @@ Add the following to your `spec_helper.rb` or add a new `swagger_helper.rb`
 ```ruby
 require 'swagalicious`
 
-DEFINITIONS = Oj.load(File.read(File.expand_path("docs/definitions.json", __dir__))).freeze
-
 RSpec.configure do |c|
   c.swagger_root = "public/swagger_docs" # This is the relative path where the swagger docs will be output
   c.swagger_docs = {
     "path/to/swagger_doc.json" => {
-      swagger:  "3.0",
+      openapi:  "3.0.3",
       basePath: "/api/",
       version:  "v1",
       info:     {
@@ -57,7 +55,7 @@ end
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/eugene@xtreme-computers.net/swagalicious.
+Bug reports and pull requests are welcome on GitHub at https://github.com/ehowe/swagalicious.
 
 
 ## License

data/lib/core/ext/hash.rb

@@ -1,9 +1,17 @@
 class Hash
-  def deep_merge!(other_hash)
-    self.merge(other_hash) do |key, oldval, newval|
-      oldval = oldval.to_hash if oldval.respond_to?(:to_hash)
-      newval = newval.to_hash if newval.respond_to?(:to_hash)
-      oldval.class.to_s == "Hash" && newval.class.to_s == "Hash" ? oldval.deep_merge(newval) : newval
+  def deep_merge(other_hash, &block)
+    dup.deep_merge!(other_hash)
+  end
+
+  def deep_merge!(other_hash, &block)
+    merge!(other_hash) do |key, this_val, other_val|
+      if this_val.is_a?(Hash) && other_val.is_a?(Hash)
+        this_val.deep_merge(other_val, &block)
+      elsif block_given?
+        block.call(key, this_val, other_val)
+      else
+        other_val
+      end
     end
   end
 

data/lib/swagalicious.rb

@@ -1,17 +1,21 @@
 require "rspec/core"
 
-require_relative "swagalicious/version"
+require_relative "./swagalicious/version"
 
-module Swagalicious
+class Swagalicious
   class Error < StandardError; end
 
-  require_relative "swagalicious/configuration"
-  require_relative "swagalicious/example_group_helpers"
-  require_relative "swagalicious/example_helpers"
-  require_relative "swagalicious/extended_schema"
-  require_relative "swagalicious/request_factory"
-  require_relative "swagalicious/response_validator"
-  require_relative "swagalicious/swagger_formatter"
+  def self.config
+    @config ||= Swagalicious::Configuration.new(RSpec.configuration)
+  end
+
+  require_relative "./swagalicious/configuration"
+  require_relative "./swagalicious/example_group_helpers"
+  require_relative "./swagalicious/example_helpers"
+  require_relative "./swagalicious/extended_schema"
+  require_relative "./swagalicious/request_factory"
+  require_relative "./swagalicious/response_validator"
+  require_relative "./swagalicious/swagger_formatter"
 
   ::RSpec::Core::ExampleGroup.define_example_group_method :path
 
@@ -23,8 +27,4 @@ module Swagalicious
     c.extend Swagalicious::ExampleGroupHelpers, type: :doc
     c.include Swagalicious::ExampleHelpers, type: :doc
   end
-
-  def self.config
-    @config ||= Swagalicious::Configuration.new(RSpec.configuration)
-  end
 end

data/lib/swagalicious/configuration.rb

@@ -1,4 +1,4 @@
-module Swagalicious
+class Swagalicious
   class ConfigurationError < StandardError; end
 
   class Configuration

data/lib/swagalicious/example_group_helpers.rb

@@ -1,4 +1,4 @@
-module Swagalicious
+class Swagalicious
   module ExampleGroupHelpers
     def path(template, metadata={}, &block)
       metadata[:path_item] = { template: template }

data/lib/swagalicious/example_helpers.rb

@@ -5,7 +5,7 @@ require "oj"
 
 require_relative "response_validator"
 
-module Swagalicious
+class Swagalicious
   module ExampleHelpers
     include Rack::Test::Methods
 
@@ -49,12 +49,22 @@ module Swagalicious
 
       @body = Oj.load(body, symbol_keys: true)
 
+      metadata[:paths] ||= []
+      metadata[:paths] << request[:path]
+
       if request[:payload]
         metadata[:response][:request] = Oj.load(request[:payload])
       end
 
-      metadata[:response][:examples]                   ||= {}
-      metadata[:response][:examples]["application/json"] = @body
+      metadata[:response][:examples] ||= {}
+
+      mime_types = metadata[:response][:produces]  || ["application/json"]
+      full_title = metadata[:swagger_example_name] || "#{metadata[:operation][:summary]}: #{metadata[:description]}"
+
+      mime_types.each do |mime_type|
+        metadata[:response][:examples][mime_type] ||= {}
+        metadata[:response][:examples][mime_type][full_title] = @body
+      end
 
       # Validates response matches the proper schema
       Swagalicious::ResponseValidator.new.validate!(metadata, response)

data/lib/swagalicious/extended_schema.rb

@@ -1,6 +1,6 @@
 require "json-schema"
 
-module Swagalicious
+class Swagalicious
   class ExtendedSchema < JSON::Schema::Draft4
     def initialize
       super

data/lib/swagalicious/request_factory.rb

@@ -1,7 +1,7 @@
 require "faraday"
 require "faraday/adapter/rack"
 
-module Swagalicious
+class Swagalicious
   class RequestFactory
     def initialize(config = ::Swagalicious.config)
       @config = config

data/lib/swagalicious/response_validator.rb

@@ -1,6 +1,6 @@
 require "json"
 
-module Swagalicious
+class Swagalicious
   class UnexpectedResponse < StandardError; end
 
   class ResponseValidator
@@ -44,7 +44,7 @@ module Swagalicious
         .merge(schemas)
 
       errors = JSON::Validator.fully_validate(validation_schema, body)
-      raise UnexpectedResponse, "Expected response body to match schema: #{errors[0]}" if errors.any?
+      raise UnexpectedResponse, "Expected response body to match schema: #{errors.join(", ")}" unless errors.empty?
     end
 
     def definitions_or_component_schemas(swagger_doc, version)

data/lib/swagalicious/swagger_formatter.rb

@@ -2,67 +2,71 @@
 
 require_relative "../core/ext/hash"
 
-module Swagalicious
+class Swagalicious
   class SwaggerFormatter
-    RSpec::Core::Formatters.register self, :example_group_finished, :stop
+    RSpec::Core::Formatters.register self, :stop
 
-    def initialize(output, config = Swagalicious.config)
+    def config
+      @config ||= Swagalicious.config
+    end
+
+    def initialize(output, config = nil)
       @output = output
       @config = config
 
       @output.puts "Generating Swagger docs ..."
     end
 
-    def example_group_finished(notification)
-      metadata = notification.group.metadata
-
-      # !metadata[:document] won"t work, since nil means we should generate
-      # docs.
-      return if metadata[:document] == false
-      return unless metadata.key?(:response)
-
-      swagger_doc = @config.get_swagger_doc(metadata[:swagger_doc])
-
-      # This is called multiple times per file!
-      # metadata[:operation] is also re-used between examples within file
-      # therefore be careful NOT to modify its content here.
-      upgrade_request_type!(metadata)
-      upgrade_servers!(swagger_doc)
-      upgrade_oauth!(swagger_doc)
-      upgrade_response_produces!(swagger_doc, metadata)
-
-      swagger_doc.deep_merge!(metadata_to_swagger(metadata))
+    def merge_metadata_to_document(doc, example)
+       metadata = example.metadata
+       # !metadata[:document] won"t work, since nil means we should generate
+       # docs.
+       return {} if metadata[:document] == false
+       return {} unless metadata.key?(:response)
+       # This is called multiple times per file!
+       # metadata[:operation] is also re-used between examples within file
+       # therefore be careful NOT to modify its content here.
+       upgrade_servers!(doc)
+       upgrade_oauth!(doc)
+       upgrade_response_produces!(doc, metadata)
+       upgrade_request_type!(metadata)
+
+       unless doc_version(doc).start_with?("2")
+         doc[:paths]&.each_pair do |_k, v|
+           v.each_pair do |_verb, value|
+             is_hash = value.is_a?(Hash)
+             if is_hash && value.dig(:parameters)
+               schema_param = value.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
+               mime_list    = value.dig(:consumes)
+               if value && schema_param && mime_list
+                 value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
+                 mime_list.each do |mime|
+                   value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
+                 end
+               end
+
+               value[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
+             end
+             remove_invalid_operation_keys!(value)
+           end
+         end
+       end
+
+       doc.deep_merge!(metadata_to_swagger(metadata))
     end
 
-    def stop(_notification = nil)
-      @config.swagger_docs.each do |url_path, doc|
-        unless doc_version(doc).start_with?("2")
-          doc[:paths]&.each_pair do |_k, v|
-            v.each_pair do |_verb, value|
-              is_hash = value.is_a?(Hash)
-              if is_hash && value.dig(:parameters)
-                schema_param = value.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
-                mime_list    = value.dig(:consumes)
-                if value && schema_param && mime_list
-                  value[:requestBody] = { content: {} } unless value.dig(:requestBody, :content)
-                  mime_list.each do |mime|
-                    value[:requestBody][:content][mime] = { schema: schema_param[:schema] }
-                  end
-                end
-
-                value[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
-              end
-              remove_invalid_operation_keys!(value)
-            end
-          end
-        end
+    def stop(notification = nil)
+      config.swagger_docs.each do |url_path, doc|
+        examples = notification.examples.select { |e| e.metadata[:swagger_doc] == url_path }
+
+        merged_doc = examples.each_with_object(doc) { |e, doc| doc = doc.deep_merge!(merge_metadata_to_document(doc, e)) }
 
-        file_path = File.join(@config.swagger_root, url_path)
+        file_path = File.join(config.swagger_root, url_path)
         dirname   = File.dirname(file_path)
         FileUtils.mkdir_p dirname unless File.exist?(dirname)
 
         File.open(file_path, "w") do |file|
-          file.write(pretty_generate(doc))
+          file.write(pretty_generate(merged_doc))
         end
 
         @output.puts "Swagger doc generated at #{file_path}"
@@ -72,7 +76,7 @@ module Swagalicious
     private
 
     def pretty_generate(doc)
-      if @config.swagger_format == :yaml
+      if config.swagger_format == :yaml
         clean_doc = yaml_prepare(doc)
         YAML.dump(clean_doc)
       else # config errors are thrown in "def swagger_format", no throw needed here
@@ -88,6 +92,19 @@ module Swagalicious
     def metadata_to_swagger(metadata)
       response_code = metadata[:response][:code]
       response      = metadata[:response].reject { |k, _v| k == :code }
+      examples      = response.delete(:examples) || []
+
+      examples.each do |mime_type, titles|
+        titles.each do |title, example|
+          next unless response[:content][mime_type]
+
+          response[:content][mime_type][:examples] ||= {}
+
+          response[:content][mime_type][:examples][title] ||= {}
+
+          response[:content][mime_type][:examples][title][:value] = example
+        end
+      end
 
       verb      = metadata[:operation][:verb]
       operation = metadata[:operation]
@@ -103,7 +120,7 @@ module Swagalicious
     end
 
     def doc_version(doc)
-      doc[:openapi] || doc[:swagger] || "3"
+      doc[:openapi] || doc[:swagger] || "3.0.0"
     end
 
     def upgrade_response_produces!(swagger_doc, metadata)
@@ -121,7 +138,11 @@ module Swagalicious
 
       mime_list.each do |mime_type|
         # TODO upgrade to have content-type specific schema
-        target_node[:content][mime_type] = { schema: schema }
+        body = target_node
+          .fetch(:body, {})
+          .fetch(mime_type, {})
+
+        target_node[:content][mime_type] = { schema: schema }.merge(body)
       end
     end
 

data/lib/swagalicious/version.rb

@@ -1,3 +1,3 @@
-module Swagalicious
-  VERSION = "0.1.0"
+class Swagalicious
+  VERSION = "0.4.1"
 end

data/swagalicious.gemspec

@@ -24,9 +24,12 @@ Gem::Specification.new do |spec|
   end
   spec.require_paths = ["lib"]
 
-  spec.add_dependency "faraday",     "~> 1.0.1"
+  spec.add_dependency "faraday",     "~> 1.3.0"
   spec.add_dependency "json-schema", "~> 2.8.1"
-  spec.add_dependency "oj",          "~> 3.10.14"
-  spec.add_dependency "rack-test",   "~> 1.1.0"
-  spec.add_dependency "rspec",       "~> 3.9.0"
+  spec.add_dependency "oj",          "~> 3.11.0"
+  spec.add_dependency "rspec",       "~> 3.10.0"
+
+  spec.add_development_dependency "factory_bot", "~> 6.1.0"
+  spec.add_development_dependency "pry-byebug",  "~> 3.9.0"
+  spec.add_development_dependency "rack-test",   "~> 1.1.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagalicious
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.4.1
 platform: ruby
 authors:
 - Eugene Howe
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-09-10 00:00:00.000000000 Z
+date: 2021-01-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.3.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.0.1
+        version: 1.3.0
 - !ruby/object:Gem::Dependency
   name: json-schema
   requirement: !ruby/object:Gem::Requirement
@@ -44,42 +44,70 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.14
+        version: 3.11.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.14
+        version: 3.11.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.10.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 1.1.0
+        version: 3.10.0
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 6.1.0
+- !ruby/object:Gem::Dependency
+  name: pry-byebug
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.9.0
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.9.0
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.1.0
 description: This gem is almost a straight copy and paste of https://github.com/rswag/rswag/tree/master/rswag-specs
   with the Rails specific code stripped out so it can be used in Rack applications
   that don't use Rails.
@@ -118,7 +146,7 @@ metadata:
   allowed_push_host: https://rubygems.org
   homepage_uri: https://github.com/ehowe/swagalicious
   source_code_uri: https://github.com/ehowe/swagalicious
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -133,8 +161,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.6
-signing_key:
+rubygems_version: 3.0.8
+signing_key: 
 specification_version: 4
 summary: RSwag without Rails
 test_files: []