openapi_rspec 0.4 → 0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6bea441305836e75d93b65e38d4cb5297c16501228e286d6f444d2870a2bfc30
-  data.tar.gz: 3fa60f7de6682ba67b56b17562ad5e35d0548a51e8e61a5afe3f5462a38cbd36
+  metadata.gz: 748ba53aceac0ac02c274be192c1fadb895df66212e38da8bf9f88f80943f504
+  data.tar.gz: d2ab4b53ae116da4daf0bdaec48e2c8ff4d54b8ff98e1e4dc05bfd2d0d4c6dfc
 SHA512:
-  metadata.gz: 6df382e223c149c2c250b8bb97a19470be4d784fe8bdd0cebc1161b806f69aef13cc13f6ca299a9c8f3df9792d2606bb64ecb893183d669769fb4b95aed27a6f
-  data.tar.gz: e4cf9b350d38b189fdf73e451143ccd5388e19104f9b557f62636e41791cfc2d28aec5e3e813f0868dc95eaa84165b3471585f3fa74b5f445e0e1743ac7f59a0
+  metadata.gz: 1a89fcf6b169fddf3ade6b8032354460046e5be264b38ba4b6fd164a2c5caaa1fc10a5369599701aa9b03bd347a6dbff313a3b7ca36e48e12ac2557fde4ca6e4
+  data.tar.gz: 15d575f392ac9ba39e2e5e11aa1732596f8ca9eaf43cbba72cf76ef036901d5bdd06ed40f8e5c7f5ff45afcd1038b2552c266e1bd420b0703642322c08ce2bde

data/README.md

@@ -7,6 +7,7 @@
 [![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]
+[![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 +148,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 +160,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

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

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,13 +5,19 @@ module OpenapiRspec
     def request_params(metadata)
       path = defined?(uri) ? uri : metadata[:uri]
       method = defined?(http_method) ? http_method : metadata[:method]
+      params = if openapi_rspec_params.is_a?(Hash)
+        path_params(path).merge!(openapi_rspec_params)
+      else
+        openapi_rspec_params
+      end
+
       {
         method: method,
         path: path,
-        params: path_params(path).merge!(openapi_rspec_params),
+        params: params,
         headers: openapi_rspec_headers,
         query: openapi_rspec_query,
-        media_type: openapi_rspec_media_type
+        media_type: openapi_rspec_media_type,
       }
     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

@@ -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
@@ -70,7 +70,7 @@ module OpenapiRspec
     def request_params
       {
         headers: headers,
-        params: params
+        params: params,
       }
     end
   end

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.5"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: openapi_rspec
 version: !ruby/object:Gem::Version
-  version: '0.4'
+  version: '0.5'
 platform: ruby
 authors:
 - Svyatoslav Kryukov
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-07 00:00:00.000000000 Z
+date: 2020-08-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: dry-configurable
@@ -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
@@ -145,7 +145,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubygems_version: 3.0.3
-signing_key: 
+signing_key:
 specification_version: 4
 summary: Test your API against OpenApi v3 documentation
 test_files: []