swagalicious 0.5.3 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e5ca94c771cd7880a7ca5067494dbeb2191f24135cac0632a1a80b4b446b44c5
-  data.tar.gz: 50be7a011f75c16a812d7674ab226abe1506b20e08f86e8d9f9385887bb4c9f2
+  metadata.gz: 7b591f97affd8dc1fa23c0ba79eb43aeccfc0b954d6a8eb8a3dbaae10d4e5da8
+  data.tar.gz: 6d5b20f69b8543406a99e5d1e59848d02b1299558f14be5f9023e473a7b1e903
 SHA512:
-  metadata.gz: 11eaddf8649effe8652269a2257a9438c766960c59e00d406172daa33639b10a4ba9bae05f6d792d3ca7feb4602c4a230e0c13cc7489e45d771496a3679f9a19
-  data.tar.gz: 9f187376ca50e6ea1333c432c88cbb872f6c0ba841be7018957624b5c01105bb7b4b897483ab45503f37e8b80c42abf3d0c5613f8b65b8fc84eec3a70539a37e
+  metadata.gz: 233c014d7df4f7625275193eda7fe58ae8cfd7ad3dea95ce8a4e19aabad3d9b9ef4ad082042bc4ba873d698a64b0b262298f2859fc13f1408729462dc478a6dc
+  data.tar.gz: 93f9dcb0fb104aaac7a54cfbda195dcd27d8b47598f7176cc65f6b5b0f0ac6b260f2f760ee7b9355ad429c91c1ebf164bff5ae28c7aace7686559ea9b89b6095

data/Gemfile.lock

@@ -1,12 +1,13 @@
 PATH
   remote: .
   specs:
-    swagalicious (0.5.3)
+    swagalicious (1.0.0)
       faraday (~> 2.0)
       faraday-rack
       json-schema
       oj (~> 3.11.0)
-      rack-test (~> 2.0.2)
+      ox (~> 2.14.14)
+      rack-test
       rspec (~> 3)
 
 GEM
@@ -20,6 +21,7 @@ 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)
@@ -34,11 +36,16 @@ GEM
       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)
@@ -49,7 +56,10 @@ GEM
     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,6 +105,8 @@ DEPENDENCIES
   pry-byebug (~> 3.9.0)
   rake (~> 12.0)
   rspec (~> 3.0)
+  rubocop (~> 1.48.0)
+  rubocop-rspec (~> 2.19.0)
   swagalicious!
 
 BUNDLED WITH

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

@@ -35,11 +35,11 @@ class Swagalicious
 
     def derive_security_params(metadata, swagger_doc)
       requirements = metadata[:operation][:security] || swagger_doc[:security] || []
-      scheme_names = requirements.flat_map(&:keys)
+      scheme_names = requirements.flat_map { |r| r.has_key?(:type) ? r[:type] : r.keys }
       schemes      = security_version(scheme_names, swagger_doc)
 
       schemes.map do |scheme|
-        param = (scheme[:type] == :apiKey) ? scheme.slice(:name, :in, :required) : { name: "Authorization", in: :header }
+        param = (scheme[:type] == :apiKey) ? scheme.slice(:name, :in, :required, :force_name) : { name: "Authorization", in: :header }
         param.merge(required: requirements.one?) unless param.has_key?(:required)
         param.merge(type: :string)
       end
@@ -127,7 +127,7 @@ class Swagalicious
         .map do |p|
           variable_name = p[:variable_name] || p[:name]
 
-          [p[:name], example.send(variable_name).to_s]
+          [p[:name], example.send(variable_name).to_s, p[:force_name]]
         end
 
       # Accept header
@@ -145,15 +145,16 @@ class Swagalicious
       end
 
       # Rails test infrastructure requires rackified headers
-      rackified_tuples = tuples.map do |pair|
+      rackified_tuples = tuples.map do |tuple|
         [
-          case pair[0]
+          case tuple[0]
           when "Accept" then "HTTP_ACCEPT"
           when "Content-Type" then "CONTENT_TYPE"
-          when "Authorization" then "HTTP_AUTHORIZATION"
-          else pair[0]
+          when "Authorization"
+            tuple[2] ? tuple[0] : "HTTP_AUTHORIZATION"
+          else tuple[0]
           end,
-          pair[1]
+          tuple[1]
         ]
       end
 

data/lib/swagalicious/version.rb

@@ -1,3 +1,3 @@
 class Swagalicious
-  VERSION = "0.5.3"
+  VERSION = "1.1.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 "rack-test", "~> 2.0.2"
+  spec.add_dependency "ox", "~> 2.14.14"
+  spec.add_dependency "rack-test"
   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.3
+  version: 1.1.0
 platform: ruby
 authors:
 - Eugene Howe
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-19 00:00:00.000000000 Z
+date: 2023-08-17 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -67,19 +67,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: 3.11.0
 - !ruby/object:Gem::Dependency
-  name: rack-test
+  name: ox
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.14.14
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.2
+        version: 2.14.14
+- !ruby/object:Gem::Dependency
+  name: rack-test
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   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