schema_conformist 0.3.0 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0f371fda7f28311396661b5eabe38e3630fdcf7957654b9bd9066c904adb82f8
-  data.tar.gz: 5a7b206ae48f4124c207f16fc0cf299e5caa1f4734c4c084ca27aff85fad5167
+  metadata.gz: 5e54cb66b8b3d2067cff927d88c713d3c6884451015d29ec012ef9de875843cc
+  data.tar.gz: 2244d52ab6750d662b79c1f0e6343a80a773cf82f5cb68ef5b181b92aa6ab20b
 SHA512:
-  metadata.gz: cf5f6565891b81181b6126d98f96399e0cfaba547c3aa6f6f01fcb8493d02c7701bc558e28522e482246e5f9f8ae25f1eb662906944ab26caf3ffac8aca38278
-  data.tar.gz: b62c4a71d1d3efb3d9f801bd9b384326e9e49edb87b9477c84f15d0783e6ea8a58f79606c7aa668d92643c859f0fed2025df6b61d1313f08008201fe4db56ad5
+  metadata.gz: 5fbb90f23972a201248b92b3b757d74fca5a40b249f6f3387963cca84ebd20075823619b4af7cbf106e7ebdb7e102350a8025b7a6223209311a39b2bb6aa3ae4
+  data.tar.gz: 71529b799490eb6818c8336a01d78b7930dc4c6ebad10f9d031e1e9fbc5bc15ca7add1b4da222e964ba7ae38e235cc6aa5e981350dde92f7213a556ce5aa575d

data/README.md

@@ -1,12 +1,12 @@
 # SchemaConformist
 
-[![Gem Version](https://badge.fury.io/rb/schema_conformist.svg)](https://badge.fury.io/rb/schema_conformist) [![Build Status](https://travis-ci.org/kymmt90/schema_conformist.svg?branch=master)](https://travis-ci.org/kymmt90/schema_conformist)
+[![Gem Version](https://badge.fury.io/rb/schema_conformist.svg)](https://badge.fury.io/rb/schema_conformist) [![Build Status](https://github.com/kymmt90/schema_conformist/workflows/build/badge.svg)](https://github.com/kymmt90/schema_conformist/actions?workflow=build)
 
-> An automatic JSON response validator for testing in Rails
+> An automatic JSON request/response validator for testing in Rails
 
-SchemaConformist is an automatic JSON response validator for your API testing in Rails.
+SchemaConformist is an automatic JSON request/response validator for your API testing in Rails.
 
-This library automatically validates that JSON responses are conformant with the schema. The schema can be described as one of [JSON Hyper Schema](http://json-schema.org/latest/json-schema-hypermedia.html), [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) and OpenAPI 3 (currently [3.0.2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) is latest).
+This library automatically validates that JSON requests/responses are conformant with the schema. The schema can be described as one of [JSON Hyper Schema](http://json-schema.org/latest/json-schema-hypermedia.html), [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md) and OpenAPI 3 (currently [3.0.2](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md) is latest).
 
 This library uses [Committee](https://github.com/interagent/committee) to validate JSONs.
 
@@ -28,7 +28,7 @@ Configure `schema_path` as follows (ex. using an OpenAPI 3 schema):
 Rails.application.config.schema_conformist.schema_path = Rails.root.join('doc', 'openapi.yaml')
 ```
 
-That's all. Then all JSON responses in integration-test/request-spec are validated according to your schema.
+That's all. Then all JSON requests/responses in integration-test/request-spec are validated according to your schema.
 
 ### Writing the Schema
 
@@ -44,6 +44,9 @@ Configuration options are following:
   - Required. The path where the schema is placed
 - `schema_conformist.ignored_api_paths`
   - Optional. The array of API paths not to validate. Each path can be described in String literal (used for prefix search) or regular expression.
+- `schema_conformist.committee.old_assert_behavior`
+  - Optional. Set `true` if you want to skip validating request parameters. The default value is `false`.
+  - cf. ["Test Assertions" in Committee README](https://github.com/interagent/committee#test-assertions)
 
 ## Contributing
 

data/lib/schema_conformist/driver.rb

@@ -3,7 +3,7 @@ module SchemaConformist
     include Committee::Test::Methods
 
     def committee_options
-      { schema: committee_schema }
+      { schema: committee_schema }.merge(schema_conformist_committee_options)
     end
 
     def request_object
@@ -23,5 +23,9 @@ module SchemaConformist
     def schema_path
       Rails.application.config.schema_conformist.schema_path
     end
+
+    def schema_conformist_committee_options
+      Rails.application.config.schema_conformist.committee
+    end
   end
 end

data/lib/schema_conformist/process_with_assertion.rb

@@ -2,17 +2,18 @@ module SchemaConformist
   module ProcessWithAssertion
     include SchemaConformist::Driver
 
-    def process(*args)
-      super *args
+    def process(method, path, **kwargs)
+      super
 
-      path = args[1]
-      return if ignored?(path)
+      return if schema_conformist_ignored_path?(path)
 
       assert_schema_conform
     end
 
-    def ignored?(path)
-      ignored_api_paths.any? do |pattern|
+    private
+
+    def schema_conformist_ignored_path?(path)
+      schema_conformist_ignored_api_paths.any? do |pattern|
         case pattern
         when String
           path.start_with?(pattern)
@@ -22,7 +23,7 @@ module SchemaConformist
       end
     end
 
-    def ignored_api_paths
+    def schema_conformist_ignored_api_paths
       Rails.application.config.schema_conformist.ignored_api_paths
     end
   end

data/lib/schema_conformist/railtie.rb

@@ -1,9 +1,11 @@
 module SchemaConformist
   class Railtie < Rails::Railtie
     config.before_configuration do
-      config.schema_conformist = Configuration.new
+      config.schema_conformist = ActiveSupport::OrderedOptions.new
       config.schema_conformist.ignored_api_paths = []
       config.schema_conformist.schema_path = nil
+      config.schema_conformist.committee = ActiveSupport::OrderedOptions.new
+      config.schema_conformist.committee.old_assert_behavior = false
     end
   end
 end

data/lib/schema_conformist/version.rb

@@ -1,3 +1,3 @@
 module SchemaConformist
-  VERSION = '0.3.0'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_conformist
 version: !ruby/object:Gem::Version
-  version: 0.3.0
+  version: 0.4.0
 platform: ruby
 authors:
 - Kohei Yamamoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-04-22 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -30,30 +30,30 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.1
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 1.3.6
-description: SchemaConformist is an automatic JSON response validator for your API
-  testing in Rails.
+        version: '0'
+description: SchemaConformist is an automatic JSON request/response validator for
+  your API testing in Rails.
 email:
 - kymmt90@gmail.com
 executables: []
@@ -89,8 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: An automatic JSON response validator for testing in Rails
+summary: An automatic JSON request/response validator for testing in Rails
 test_files: []