swagalicious 0.3.1 → 0.4.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 660f3ec40bfe890817b3e6bdb147ed5d7499a3bcf5b5f966c2310292fb76f8d7
-  data.tar.gz: 4028bd843b9f12e82ff4c771a5389bf4504549bf304bc30d8fe3b0d66e057d6c
+  metadata.gz: 8d1f1a314f7e3c84ef64184ba490e5d90971fc56213f74829f5af6f0fc6b0274
+  data.tar.gz: a6e07a214f9e574c8151ea7c459d0445790ed79f1a9b6f9dc9958bab9aef9406
 SHA512:
-  metadata.gz: e8250341f3eef2fef73ec5c0db76b38771e8a127c80af680f844fd0c8e342e8be23ac8e8d62b262084b6024177b42076d6544e1ffd7546c1d3689142e0c4618e
-  data.tar.gz: 9ad802f13a6831eb15cccaa1491bbb52ff248b18e21dbf71c8cff0dde5093b52f5170b19f9f3314e4a1bafeec8e64a89ad998e10bda22122d1210fa94606a040
+  metadata.gz: 87bc78e516ccf7ce48eb88b3aaf8045415dd147e6de880b422366fd679b86eac12fb0df34b97358578da75129e49e2dd08285297449a3f26ea85eee503c18098
+  data.tar.gz: 4b083368ef0dc6fb3cb90bb8fd39dbdbde0731de0e41df4583b188822b9387df4c53620941f91a3173b4a54e56fd99f8ba581f0b3de791672d729ed519f00e8c

data/Gemfile.lock

@@ -1,28 +1,48 @@
 PATH
   remote: .
   specs:
-    swagalicious (0.2.0)
+    swagalicious (0.4.3)
       faraday (~> 1.3.0)
       json-schema (~> 2.8.1)
       oj (~> 3.11.0)
-      rack-test (~> 1.1.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)
+    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.11.0)
+    oj (3.11.3)
+    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)
@@ -42,14 +62,20 @@ GEM
       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.2.6
+   2.2.16

data/lib/swagalicious.rb

@@ -1,6 +1,6 @@
 require "rspec/core"
 
-require_relative "swagalicious/version"
+require_relative "./swagalicious/version"
 
 class Swagalicious
   class Error < StandardError; end
@@ -9,13 +9,13 @@ class Swagalicious
     @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"
+  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
 

data/lib/swagalicious/example_helpers.rb

@@ -49,12 +49,28 @@ class Swagalicious
 
       @body = Oj.load(body, symbol_keys: true)
 
-      if request[:payload]
-        metadata[:response][:request] = Oj.load(request[:payload])
-      end
+      metadata[:paths] ||= []
+      metadata[:paths] << request[:path]
+
+      metadata[:response][:requestBody] ||= {}
+      metadata[:response][:examples]    ||= {}
+
+      mime_types = metadata[:response][:produces]  || ["application/json"]
+      full_title = metadata[:swagger_example_name] || "#{metadata[:operation][:summary]}: #{metadata[:description]}"
 
-      metadata[:response][:examples]                   ||= {}
-      metadata[:response][:examples]["application/json"] = @body
+      mime_types.each do |mime_type|
+        if request[:payload]
+          metadata[:response][:requestBody][:content]                                   ||= {}
+          metadata[:response][:requestBody][:content][mime_type]                        ||= {}
+          metadata[:response][:requestBody][:content][mime_type][:examples]             ||= {}
+          metadata[:response][:requestBody][:content][mime_type][:examples][full_title] ||= {}
+
+          metadata[:response][:requestBody][:content][mime_type][:examples][full_title][:value] = Oj.load(request[:payload]).dup
+        end
+
+        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/request_factory.rb

@@ -86,7 +86,7 @@ class Swagalicious
     end
 
     def add_path(request, metadata, swagger_doc, parameters, example)
-      template = (swagger_doc[:basePath] || "") + metadata[:path_item][:template]
+      template = (swagger_doc[:basePath] || (swagger_doc[:servers]&.first || {})[:url] || "") + metadata[:path_item][:template]
 
       request[:path] = template.tap do |path_template|
         parameters.select { |p| p[:in] == :path }.each do |p|

data/lib/swagalicious/response_validator.rb

@@ -44,7 +44,7 @@ class 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

@@ -31,27 +31,6 @@ class Swagalicious
        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
 
@@ -92,12 +71,40 @@ class Swagalicious
     def metadata_to_swagger(metadata)
       response_code = metadata[:response][:code]
       response      = metadata[:response].reject { |k, _v| k == :code }
+      examples      = response.delete(:examples) || []
+      body          = response.delete(:requestBody) || {}
+
+      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]
         .reject { |k, _v| k == :verb }
         .merge(responses: { response_code => response })
 
+      is_hash = operation.is_a?(Hash)
+      if is_hash && operation.dig(:parameters)
+        schema_param = operation.dig(:parameters)&.find { |p| (p[:in] == :body || p[:in] == :formData) && p[:schema] }
+        mime_list    = operation.dig(:consumes)
+        if operation && schema_param && mime_list
+          operation[:requestBody] = { content: {} }
+          mime_list.each do |mime|
+            operation[:requestBody][:content][mime] = { schema: schema_param[:schema] }.merge((body.dig(:content, mime) || {}))
+          end
+        end
+
+        operation[:parameters].reject! { |p| p[:in] == :body || p[:in] == :formData }
+      end
+
       path_template = metadata[:path_item][:template]
       path_item     = metadata[:path_item]
         .reject { |k, _v| k == :template }
@@ -112,7 +119,7 @@ class Swagalicious
 
     def upgrade_response_produces!(swagger_doc, metadata)
       # Accept header
-      mime_list   = Array(metadata[:operation][:produces] || swagger_doc[:produces])
+      mime_list   = Array(metadata[:operation].delete(:produces) || swagger_doc[:produces])
       target_node = metadata[:response]
       upgrade_content!(mime_list, target_node)
       metadata[:response].delete(:schema)
@@ -125,7 +132,11 @@ class 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 @@
 class Swagalicious
-  VERSION = "0.3.1"
+  VERSION = "0.4.4"
 end

data/swagalicious.gemspec

@@ -27,6 +27,9 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday",     "~> 1.3.0"
   spec.add_dependency "json-schema", "~> 2.8.1"
   spec.add_dependency "oj",          "~> 3.11.0"
-  spec.add_dependency "rack-test",   "~> 1.1.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.3.1
+  version: 0.4.4
 platform: ruby
 authors:
 - Eugene Howe
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2021-01-19 00:00:00.000000000 Z
+date: 2021-04-23 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -53,33 +53,61 @@ dependencies:
       - !ruby/object:Gem::Version
         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: 3.10.0
-  type: :runtime
+        version: 6.1.0
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.10.0
+        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: :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.