swagalicious 0.5.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 89c4466d6c9ea1d244b293d16b86edf9f1611b3c9fd0f6057cd3dcf63a8328ed
-  data.tar.gz: 0e879d017afc95a8a4f0f27a02e0dad9650eb2eefb07c468d8b732c2149ef70f
+  metadata.gz: abb72dfd425ef772e7d2c0cf1ac1079d60cf9d6310b790dc9eef4454e145d7dd
+  data.tar.gz: 3c919667c104eba4d2e01d4177e68e4bcc5d57a8a0d33ee02b9fcfa79d3cf899
 SHA512:
-  metadata.gz: 2de2c29b4bb1dd5a19fed86010160a445b5f4add5a05a01608761704101f502173dc537c863d7cff8577cac0b8047d7c74a8d4018bfaed1ec61bb63af0918e07
-  data.tar.gz: ec3740df707edf4485ed2d50294f6a696bec691541f102c4b63094e9218d5973a8406299570eb642d10721867073858e41919e40e1a96fb8f5674ea318021b84
+  metadata.gz: 12939af351eaebed0316bff2af98b58fcf7f39041311920bab9338f163e5dc06d2575148fedcb22ab92581f91b9f9d8e28dbffb0bef60cc97faccc2a97bf9718
+  data.tar.gz: 8003706edc0671b7cce79a72d9098827de9d114b0d42502684ea980bf4ee22deab1a998603710a82a55321fa0c318b42414d7f047ae5a2028214ae2a8354a647

data/Gemfile.lock

@@ -1,11 +1,12 @@
 PATH
   remote: .
   specs:
-    swagalicious (0.5.0)
+    swagalicious (1.0.0)
       faraday (~> 2.0)
       faraday-rack
       json-schema
       oj (~> 3.11.0)
+      ox (~> 2.14.14)
       rack-test (~> 2.0.2)
       rspec (~> 3)
 
@@ -20,36 +21,45 @@ GEM
       zeitwerk (~> 2.3)
     addressable (2.8.1)
       public_suffix (>= 2.0.2, < 6.0)
+    ast (2.4.2)
     byebug (11.1.3)
     coderay (1.1.3)
     concurrent-ruby (1.1.10)
     diff-lcs (1.5.0)
     factory_bot (6.1.0)
       activesupport (>= 5.0.0)
-    faraday (2.5.2)
+    faraday (2.7.3)
       faraday-net_http (>= 2.0, < 3.1)
       ruby2_keywords (>= 0.0.4)
-    faraday-net_http (3.0.0)
+    faraday-net_http (3.0.2)
     faraday-rack (2.0.0)
       faraday (~> 2.0)
     i18n (1.10.0)
       concurrent-ruby (~> 1.0)
+    json (2.6.3)
     json-schema (3.0.0)
       addressable (>= 2.8)
     method_source (1.0.0)
     minitest (5.16.1)
     oj (3.11.8)
+    ox (2.14.14)
+    parallel (1.22.1)
+    parser (3.2.1.0)
+      ast (~> 2.4.1)
     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 (5.0.0)
-    rack (3.0.0)
+    public_suffix (5.0.1)
+    rack (3.0.4.1)
     rack-test (2.0.2)
       rack (>= 1.3)
+    rainbow (3.1.1)
     rake (12.3.3)
+    regexp_parser (2.7.0)
+    rexml (3.2.5)
     rspec (3.11.0)
       rspec-core (~> 3.11.0)
       rspec-expectations (~> 3.11.0)
@@ -63,9 +73,28 @@ GEM
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.11.0)
     rspec-support (3.11.0)
+    rubocop (1.48.0)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.26.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.27.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.17.1)
+      rubocop (~> 1.41)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
     ruby2_keywords (0.0.5)
     tzinfo (2.0.4)
       concurrent-ruby (~> 1.0)
+    unicode-display_width (2.4.2)
     zeitwerk (2.6.0)
 
 PLATFORMS
@@ -76,7 +105,9 @@ DEPENDENCIES
   pry-byebug (~> 3.9.0)
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop (~> 1.48.0)
+  rubocop-rspec (~> 2.19.0)
   swagalicious!
 
 BUNDLED WITH
-   2.3.20
+   2.3.17

data/lib/swagalicious/example_group_helpers.rb

@@ -57,8 +57,10 @@ class Swagalicious
     end
 
     def header(name, attributes)
-      metadata[:response][:headers]     ||= {}
-      metadata[:response][:headers][name] = attributes
+      header_name = attributes.delete(:variable) || name
+
+      metadata[:response][:headers]            ||= {}
+      metadata[:response][:headers][header_name] = attributes
     end
 
     # NOTE: Similar to 'description', 'examples' need to handle the case when

data/lib/swagalicious/example_helpers.rb

@@ -1,7 +1,11 @@
 require "faraday"
 require "faraday/rack"
 require "rack"
+require "json"
 require "oj"
+require "ox"
+require "yaml"
+require "active_support/core_ext/hash/indifferent_access"
 
 require_relative "response_validator"
 
@@ -9,6 +13,55 @@ class Swagalicious
   module ExampleHelpers
     include Rack::Test::Methods
 
+    def self.raise_invalid_response(response:, request:, message:)
+      raise InvalidResponseTypeError.new(
+        headers: response.headers,
+        message: message,
+        request: request,
+        response: response,
+        status: response.status,
+      )
+    end
+
+    class InvalidResponseTypeError < RuntimeError
+      attr_reader :status, :_message, :headers, :response, :request
+
+      def initialize(status:, message:, headers:, response:, request:)
+        @headers  = headers
+        @_message = message
+        @request  = request
+        @response = response
+        @status   = status
+      end
+
+      def inspect
+        JSON.pretty_generate(to_h)
+      end
+
+      def to_h
+        hash = {
+          headers: headers.to_h,
+          message: _message,
+          request: request.slice(:verb, :path, :headers),
+          status:  status,
+        }
+
+        if parsed_body = Parser.new(request: request, response: response).parse(raise_on_invalid: false)
+          hash[:parsed_response] = parsed_body
+        end
+
+        hash
+      end
+
+      def to_s
+        "Received unexpected or unparseable response with status code #{status} for #{request[:verb].upcase} #{request[:path]}: #{_message}"
+      end
+
+      def message
+        inspect
+      end
+    end
+
     class MockResponse
       attr_reader :body, :status, :headers
 
@@ -19,6 +72,44 @@ class Swagalicious
       end
     end
 
+    class Parser
+      attr_accessor :body
+      attr_reader :content_type, :request, :response
+
+      def initialize(response:, request:)
+        @content_type = response.headers["Content-Type"]
+        @body         = response.body
+        @response     = response
+        @request      = request
+      end
+
+      def parse(raise_on_invalid: true)
+        # Redirections shouldnt be parsed
+        if response.status >= 300 && response.status <= 399
+          return
+        end
+
+        case content_type
+        when /json/
+          self.body = "{}" if self.body.empty?
+
+          Oj.load(self.body, symbol_keys: true)
+        when /ya?ml/
+          body = "---" if self.body.empty?
+
+          (YAML.load(self.body) || {}).with_indifferent_access
+        when /xml/
+          (Ox.load(self.body, mode: :hash_no_attrs) || {}).with_indifferent_access
+        when "", nil
+          self.body
+        else
+          return unless raise_on_invalid
+
+          Swagalicious::ExampleHelpers.raise_invalid_response(response: response, request: request, message: "Invalid Content-Type header #{response.headers["Content-Type"]}")
+        end
+      end
+    end
+
     def app
       @app ||= if defined?(Rails)
                  Rails.application
@@ -52,10 +143,9 @@ class Swagalicious
                    end
                  end
 
-      body = response.body
-      body = "{}" if body.empty?
+      Swagalicious::ExampleHelpers.raise_invalid_response(response: response, request: request, message: "Received unexpected response code") unless response.status.to_s == metadata[:response][:code].to_s
 
-      @body = Oj.load(body, symbol_keys: true)
+      @body = Parser.new(request: request, response: response).parse
 
       metadata[:paths] ||= []
       metadata[:paths] << request[:path]

data/lib/swagalicious/request_factory.rb

@@ -91,12 +91,14 @@ class Swagalicious
 
       request[:path] = template.tap do |path_template|
         parameters.select { |p| p[:in] == :path }.each do |p|
-          path_template.gsub!("{#{p[:name]}}", example.send(p[:name]).to_s)
+          variable_name = p[:variable_name] || p[:name]
+          path_template.gsub!("{#{p[:name]}}", example.send(variable_name).to_s)
         end
 
         parameters.select { |p| p[:in] == :query }.each_with_index do |p, i|
+          variable_name = p[:variable_name] || p[:name]
           path_template.concat(i.zero? ? "?" : "&")
-          path_template.concat(build_query_string_part(p, example.send(p[:name])))
+          path_template.concat(build_query_string_part(p, example.send(variable_name)))
         end
       end
     end
@@ -122,7 +124,11 @@ class Swagalicious
     def add_headers(request, metadata, swagger_doc, parameters, example)
       tuples = parameters
         .select { |p| p[:in] == :header }
-        .map { |p| [p[:name], example.send(p[:name]).to_s] }
+        .map do |p|
+          variable_name = p[:variable_name] || p[:name]
+
+          [p[:name], example.send(variable_name).to_s]
+        end
 
       # Accept header
       produces = metadata[:operation][:produces] || swagger_doc[:produces]

data/lib/swagalicious/swagger_formatter.rb

@@ -55,7 +55,7 @@ class Swagalicious
     private
 
     def pretty_generate(doc)
-      if config.swagger_format == :yaml
+      if config.swagger_format == :yaml || doc.delete(: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

data/lib/swagalicious/version.rb

@@ -1,3 +1,3 @@
 class Swagalicious
-  VERSION = "0.5.2"
+  VERSION = "1.0.0"
 end

data/swagalicious.gemspec

@@ -28,9 +28,12 @@ Gem::Specification.new do |spec|
   spec.add_dependency "faraday-rack"
   spec.add_dependency "json-schema"
   spec.add_dependency "oj", "~> 3.11.0"
+  spec.add_dependency "ox", "~> 2.14.14"
   spec.add_dependency "rack-test", "~> 2.0.2"
   spec.add_dependency "rspec", "~> 3"
 
+  spec.add_development_dependency "rubocop", "~> 1.48.0"
+  spec.add_development_dependency "rubocop-rspec", "~> 2.19.0"
   spec.add_development_dependency "factory_bot", "~> 6.1.0"
   spec.add_development_dependency "pry-byebug",  "~> 3.9.0"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: swagalicious
 version: !ruby/object:Gem::Version
-  version: 0.5.2
+  version: 1.0.0
 platform: ruby
 authors:
 - Eugene Howe
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-14 00:00:00.000000000 Z
+date: 2023-03-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -66,6 +66,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: 3.11.0
+- !ruby/object:Gem::Dependency
+  name: ox
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.14
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.14.14
 - !ruby/object:Gem::Dependency
   name: rack-test
   requirement: !ruby/object:Gem::Requirement
@@ -94,6 +108,34 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '3'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.48.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.48.0
+- !ruby/object:Gem::Dependency
+  name: rubocop-rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.19.0
 - !ruby/object:Gem::Dependency
   name: factory_bot
   requirement: !ruby/object:Gem::Requirement
@@ -160,7 +202,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
@@ -175,8 +217,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.2.33
+signing_key:
 specification_version: 4
 summary: RSwag without Rails
 test_files: []