openapi_rspec 0.4 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bea441305836e75d93b65e38d4cb5297c16501228e286d6f444d2870a2bfc30
-  data.tar.gz: 3fa60f7de6682ba67b56b17562ad5e35d0548a51e8e61a5afe3f5462a38cbd36
+  metadata.gz: ed454989937d48a4eeef30f34682c4bff0f7e2a40da349eea0eeb8b5a19afb8d
+  data.tar.gz: 4df1828cf06d45281a58b9f3f90c2a8f8d89ca1271303611087e0c90d17d5d2d
 SHA512:
-  metadata.gz: 6df382e223c149c2c250b8bb97a19470be4d784fe8bdd0cebc1161b806f69aef13cc13f6ca299a9c8f3df9792d2606bb64ecb893183d669769fb4b95aed27a6f
-  data.tar.gz: e4cf9b350d38b189fdf73e451143ccd5388e19104f9b557f62636e41791cfc2d28aec5e3e813f0868dc95eaa84165b3471585f3fa74b5f445e0e1743ac7f59a0
+  metadata.gz: 667444e7e303fbb92082a8c1a1dd796633cafaf532bdfdecae27521c1c5f3e2b70a70816e63c460ec75f414a9a869b834d1864829bd6958e34d3e1f9885e8765
+  data.tar.gz: 3f4328e0214bf15036c8f628bc034dadf497fab685737122cb6f5e80330024ca8328baa832b8b91716a5c80ba0da83c974ae47a2c6fe2c17b95578e7d893e6f3

data/README.md

@@ -1,12 +1,10 @@
 [gem]: https://rubygems.org/gems/openapi_rspec
-[travis]: https://travis-ci.org/medsolutions/openapi_rspec
-[codeclimate]: https://codeclimate.com/github/medsolutions/openapi_rspec
+[codeclimate]: https://codeclimate.com/github/skryukov/openapi_rspec
 
 # openapi_rspec
 [![Gem Version](https://badge.fury.io/rb/openapi_rspec.svg)][gem]
-[![Build Status](https://travis-ci.org/medsolutions/openapi_rspec.svg?branch=master)][travis]
-[![Code Climate](https://codeclimate.com/github/medsolutions/openapi_rspec/badges/gpa.svg)][codeclimate]
-[![Test Coverage](https://codeclimate.com/github/medsolutions/openapi_rspec/badges/coverage.svg)][codeclimate]
+[![Build](https://github.com/skryukov/openapi_rspec/workflows/Build/badge.svg)](https://github.com/skryukov/openapi_rspec/actions)
+[![Ruby Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://github.com/testdouble/standard)
 
 Test your API against OpenApi v3 documentation
 
@@ -147,7 +145,7 @@ To validate response use:
 # ...
 ```
 
-To set **request body** use `params` helper method:
+To set **request body** (as form data) use `params` helper method and provide a `Hash`:
 
 ```ruby
 # ...
@@ -159,6 +157,19 @@ To set **request body** use `params` helper method:
 # ...
 ```
 
+To set **raw request body** use the `params` helper method and provide a `String`:
+
+```ruby
+# ...
+  post "/pets" do
+    params { JSON.dump(name: "Lucky") }
+
+    validate_code(201)
+  end
+# ...
+```
+
+
 To set **path parameter** use `let` helper method:
 
 ```ruby
@@ -252,7 +263,7 @@ This will raise an error if any of the documented paths are not validated.
 
 ## Contributing
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/medsolutions/openapi_rspec.
+Bug reports and pull requests are welcome on GitHub at https://github.com/skryukov/openapi_rspec.
 
 ## License
 

data/lib/openapi_rspec/documentation_validator.rb

@@ -8,7 +8,7 @@ module OpenapiRspec
     end
 
     def description
-      'be a valid OpenAPI documentation'
+      "be a valid OpenAPI documentation"
     end
 
     def failure_message

data/lib/openapi_rspec/helpers.rb

@@ -5,10 +5,12 @@ module OpenapiRspec
     def request_params(metadata)
       path = defined?(uri) ? uri : metadata[:uri]
       method = defined?(http_method) ? http_method : metadata[:method]
+
       {
         method: method,
         path: path,
-        params: path_params(path).merge!(openapi_rspec_params),
+        params: openapi_rspec_params,
+        path_params: path_params(path),
         headers: openapi_rspec_headers,
         query: openapi_rspec_query,
         media_type: openapi_rspec_media_type
@@ -17,7 +19,7 @@ module OpenapiRspec
 
     def path_params(path)
       path_params = {}
-      path.scan(/\{([^\}]*)\}/).each do |param|
+      path.scan(/\{([^}]*)\}/).each do |param|
         key = param.first.to_sym
         path_params[key] = public_send(key) if respond_to?(key)
       end

data/lib/openapi_rspec/matchers.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'openapi_rspec/documentation_validator'
-require 'openapi_rspec/request_validator'
+require "openapi_rspec/documentation_validator"
+require "openapi_rspec/request_validator"
 
 module OpenapiRspec
   module Matchers

data/lib/openapi_rspec/module_helpers.rb

@@ -7,7 +7,7 @@ module OpenapiRspec
         metadata = example.metadata[:openapi_rspec]
         validator = RequestValidator.new(**request_params(metadata), code: code)
         expect(subject).to validator
-        instance_exec validator, &block if block_given?
+        instance_exec validator, &block if block
       end
     end
 
@@ -52,8 +52,8 @@ module OpenapiRspec
     end
 
     def process(method, uri)
-      metadata[:openapi_rspec] = { uri: uri, method: method }
-      let(:openapi_rspec_media_type) { 'application/json' }
+      metadata[:openapi_rspec] = {uri: uri, method: method}
+      let(:openapi_rspec_media_type) { "application/json" }
       let(:openapi_rspec_params) { {} }
       let(:openapi_rspec_headers) { {} }
       let(:openapi_rspec_query) { {} }

data/lib/openapi_rspec/request_validator.rb

@@ -1,8 +1,8 @@
 # frozen_string_literal: true
 
-require 'dry-initializer'
-require 'rack/test'
-require 'uri'
+require "dry-initializer"
+require "rack/test"
+require "uri"
 
 module OpenapiRspec
   class RequestValidator
@@ -13,6 +13,7 @@ module OpenapiRspec
     option :method
     option :code
     option :media_type
+    option :path_params
     option :params
     option :query
     option :headers
@@ -46,27 +47,27 @@ module OpenapiRspec
 
     private
 
+    def perform_request(doc)
+      headers.each do |key, value|
+        header key, value
+      end
+      request(request_uri(doc), method: method, **request_params)
+      @response = last_response
+    end
+
     def request_uri(doc)
-      path.scan(/\{([^\}]*)\}/).each do |param|
+      path.scan(/\{([^}]*)\}/).each do |param|
         key = param.first.to_sym
-        if params && params[key]
-          @path = path.gsub "{#{key}}", params.delete(key).to_s
+        if path_params && path_params[key]
+          @path = path.gsub "{#{key}}", path_params[key].to_s
         else
-          raise URI::InvalidURIError, "No substitution data found for {#{key}}"\
+          raise URI::InvalidURIError, "No substitution data found for {#{key}}" \
             " to test the path #{path}."
         end
       end
       "#{doc.api_base_path}#{path}?#{URI.encode_www_form(query)}"
     end
 
-    def perform_request(doc)
-      headers.each do |key, value|
-        header key, value
-      end
-      request(request_uri(doc), method: method, **request_params)
-      @response = last_response
-    end
-
     def request_params
       {
         headers: headers,

data/lib/openapi_rspec/schema_loader.rb

@@ -13,7 +13,7 @@ module OpenapiRspec
       rescue JSON::ParserError
         YAML.safe_load(schema)
       end
-    rescue StandardError => e
+    rescue => e
       raise "Unable to parse OpenAPI schema. #{e}"
     end
 
@@ -22,10 +22,10 @@ module OpenapiRspec
       response = session.get(path)
 
       raise "Response code: #{response.status}" unless response.successful?
-      raise 'Empty body' if response.body.empty?
+      raise "Empty body" if response.body.empty?
 
       response.body
-    rescue StandardError => e
+    rescue => e
       raise "Unable to perform GET request for the OpenAPI schema '#{path}'. #{e}"
     end
   end

data/lib/openapi_rspec/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module OpenapiRspec
-  VERSION = '0.4'
+  VERSION = "0.6.0"
 end

data/lib/openapi_rspec.rb

@@ -1,14 +1,14 @@
 # frozen_string_literal: true
 
-require 'dry-configurable'
-require 'openapi_validator'
-require 'rspec'
+require "dry-configurable"
+require "openapi_validator"
+require "rspec"
 
-require 'openapi_rspec/helpers'
-require 'openapi_rspec/matchers'
-require 'openapi_rspec/module_helpers'
-require 'openapi_rspec/schema_loader'
-require 'openapi_rspec/version'
+require "openapi_rspec/helpers"
+require "openapi_rspec/matchers"
+require "openapi_rspec/module_helpers"
+require "openapi_rspec/schema_loader"
+require "openapi_rspec/version"
 
 module OpenapiRspec
   extend Dry::Configurable

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_rspec
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: 0.6.0
 platform: ruby
 authors:
 - Svyatoslav Kryukov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2022-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -58,14 +58,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.1'
+        version: '2.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -98,17 +98,17 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
-description: 
+        version: 12.3.3
+description:
 email:
 - s.g.kryukov@yandex.ru
 executables: []
@@ -129,7 +129,7 @@ homepage: https://github.com/medsolutions/openapi_rspec
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -144,8 +144,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Test your API against OpenApi v3 documentation
 test_files: []