schema_conformist 0.1.1 → 0.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 29e3c7aae3756274d33870d4738b44d712aeae2a
-  data.tar.gz: 886f45cbbe1c9fee58773637c52cfb4a9cae7f67
+SHA256:
+  metadata.gz: 5e54cb66b8b3d2067cff927d88c713d3c6884451015d29ec012ef9de875843cc
+  data.tar.gz: 2244d52ab6750d662b79c1f0e6343a80a773cf82f5cb68ef5b181b92aa6ab20b
 SHA512:
-  metadata.gz: 98e7eb8623de0081ce52e6208b94f52d3b91028fce5e3a962254eb424bb6a47f0a5443d8d6f1ba71da4ac46333da20566dfdb8aae7cec7976ee16898499f6492
-  data.tar.gz: 4195bcd58d4547822e907a81306d0cd9e77aba240fd38f4a9f7dc2ab22cfa9d7ddde9a7f79bce93d158e797d47d97df62adf4e75bfa5912be648dc9277a62b59
+  metadata.gz: 5fbb90f23972a201248b92b3b757d74fca5a40b249f6f3387963cca84ebd20075823619b4af7cbf106e7ebdb7e102350a8025b7a6223209311a39b2bb6aa3ae4
+  data.tar.gz: 71529b799490eb6818c8336a01d78b7930dc4c6ebad10f9d031e1e9fbc5bc15ca7add1b4da222e964ba7ae38e235cc6aa5e981350dde92f7213a556ce5aa575d

data/README.md

@@ -1,12 +1,14 @@
 # SchemaConformist
 
-> An automatic JSON response validator for testing in Rails
+[![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)
 
-SchemaConformist is an automatic JSON response validator for your API testing in Rails.
+> An automatic JSON request/response validator for testing in Rails
 
-This library automatically validates that JSON responses are conformant with the schema. The schema can be described as either [JSON Hyper Schema](http://json-schema.org/latest/json-schema-hypermedia.html) or [OpenAPI 2.0](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md).
+SchemaConformist is an automatic JSON request/response validator for your API testing in Rails.
 
-This library uses [Committee](https://github.com/interagent/committee) and [Committee::Rails](https://github.com/willnet/committee-rails) to validate JSONs and is assumed that used with API mode Rails.
+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.
 
 ## Usage
 
@@ -20,14 +22,17 @@ gem 'schema_conformist'
 
 and execute `bundle install`.
 
-That's all. Then all JSON responses in integration-test/request-spec are validated according to your schema.
+Configure `schema_path` as follows (ex. using an OpenAPI 3 schema):
 
-### Writing the Schema
+```ruby
+Rails.application.config.schema_conformist.schema_path = Rails.root.join('doc', 'openapi.yaml')
+```
+
+That's all. Then all JSON requests/responses in integration-test/request-spec are validated according to your schema.
 
-Write your API schema in either JSON Hyper Schema or OpenAPI 2. For now, the default driver is set to JSON Hyper Schema and default schema paths are following:
+### Writing the Schema
 
-- JSON Hyper Schema: `public/schema.json`
-- OpenAPI 2: `public/swagger.json`
+Write your API schema in one of JSON Hyper Schema, OpenAPI 2 and OpenAPI 3.
 
 See [`test/dummy`](https://github.com/kymmt90/schema_conformist/tree/master/test/dummy) app for examples.
 
@@ -35,21 +40,13 @@ See [`test/dummy`](https://github.com/kymmt90/schema_conformist/tree/master/test
 
 Configuration options are following:
 
-- `schema_conformist.driver`
-  - `:hyper_schema`: Use JSON Hyper Schema as schema format
-  - `:open_api_2`: Use OpenAPI 2 as schema format
-- `schema_conformist.ignored_api_paths`
-  - The array of API paths not to validate. Each path can be described in regular expression.
 - `schema_conformist.schema_path`
-  - The path where the schema is placed
-
-Example:
-
-```ruby
-Rails.application.config.schema_conformist.driver = :open_api_2
-Rails.application.config.schema_conformist.ignored_api_paths << /private/
-Rails.application.config.schema_conformist.schema_path = Rails.root.join('doc', 'swagger.json')
-```
+  - 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.rb

@@ -1,5 +1,4 @@
 require 'committee'
-require 'committee/rails'
 require 'schema_conformist/railtie'
 require 'schema_conformist/driver'
 require 'schema_conformist/process_with_assertion'

data/lib/schema_conformist/driver.rb

@@ -1,43 +1,31 @@
 module SchemaConformist
   module Driver
-    include Committee::Rails::Test::Methods
+    include Committee::Test::Methods
 
-    def committee_schema
-      @committee_schema ||=
-        begin
-          schema_hash = JSON.parse(File.read(schema_path))
-          driver.parse(schema_hash)
-        end
+    def committee_options
+      { schema: committee_schema }.merge(schema_conformist_committee_options)
     end
 
-    def schema_path
-      if schema_path = Rails.application.config.schema_conformist.schema_path
-        schema_path
-      else
-        case driver_name
-        when :hyper_schema
-          Rails.root.join('public', 'schema.json')
-        when :open_api_2
-          Rails.root.join('public', 'swagger.json')
-        else
-          raise SchemaConformist::Error.new("#{driver_name} is unknown driver")
-        end
-      end
+    def request_object
+      request
     end
 
-    def driver
-      case driver_name
-      when :hyper_schema
-        Committee::Drivers::HyperSchema.new
-      when :open_api_2
-        Committee::Drivers::OpenAPI2.new
-      else
-        raise SchemaConformist::Error.new("#{driver_name} is unknown driver")
-      end
+    def response_data
+      [response.status, response.headers, response.body]
+    end
+
+    private
+
+    def committee_schema
+      @commitee_schema ||= Committee::Drivers::load_from_file(schema_path)
+    end
+
+    def schema_path
+      Rails.application.config.schema_conformist.schema_path
     end
 
-    def driver_name
-      Rails.application.config.schema_conformist.driver
+    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,29 @@ 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)
-      Rails.application.config.schema_conformist.ignored_api_paths.any? { |regex| path =~ regex }
+    private
+
+    def schema_conformist_ignored_path?(path)
+      schema_conformist_ignored_api_paths.any? do |pattern|
+        case pattern
+        when String
+          path.start_with?(pattern)
+        when Regexp
+          path.match?(pattern)
+        end
+      end
+    end
+
+    def schema_conformist_ignored_api_paths
+      Rails.application.config.schema_conformist.ignored_api_paths
     end
   end
 end

data/lib/schema_conformist/railtie.rb

@@ -1,10 +1,11 @@
 module SchemaConformist
   class Railtie < Rails::Railtie
     config.before_configuration do
-      config.schema_conformist = Configuration.new
-      config.schema_conformist.driver = :hyper_schema
+      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.1.1'
+  VERSION = '0.4.0'
 end

metadata

@@ -1,57 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: schema_conformist
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.4.0
 platform: ruby
 authors:
 - Kohei Yamamoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-11-06 00:00:00.000000000 Z
+date: 2020-06-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 5.1.0
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: committee
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.0.0
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 2.0.0
-- !ruby/object:Gem::Dependency
-  name: committee-rails
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 4.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.2.0
+        version: 4.0.0
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement
@@ -66,8 +52,8 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: SchemaConformist is an automatic JSON response validator for your API
-  testing in Rails.
+description: SchemaConformist is an automatic JSON request/response validator for
+  your API testing in Rails.
 email:
 - kymmt90@gmail.com
 executables: []
@@ -103,9 +89,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.13
+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: []