schema_conformist 0.2.2 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b2ff4a7d2a77af891612e63f5a51da3e81d5e54092723668cd90f951427f454f
-  data.tar.gz: 38581d5e2e0b1b0f7677002f51efaaa1ee90c31188c23678ec51e2b9ea32a3dd
+  metadata.gz: 0f371fda7f28311396661b5eabe38e3630fdcf7957654b9bd9066c904adb82f8
+  data.tar.gz: 5a7b206ae48f4124c207f16fc0cf299e5caa1f4734c4c084ca27aff85fad5167
 SHA512:
-  metadata.gz: 575c431682aa802a57f0302ff80b837db47ee1eafc5047a9fd1917617b85b68b4c504db2db6675b65aadb35e73c8c6edaf8aa07ff51430a158659ef98dc497a8
-  data.tar.gz: 5beb3ee32ae2ad67ddac088a9f54b586e9208e5a9b01f31dbe9111690af4ff36589b199acfca6a83b006cb01658d6127532f6b51e79ac9f7c10f3e5bca5a46fc
+  metadata.gz: cf5f6565891b81181b6126d98f96399e0cfaba547c3aa6f6f01fcb8493d02c7701bc558e28522e482246e5f9f8ae25f1eb662906944ab26caf3ffac8aca38278
+  data.tar.gz: b62c4a71d1d3efb3d9f801bd9b384326e9e49edb87b9477c84f15d0783e6ea8a58f79606c7aa668d92643c859f0fed2025df6b61d1313f08008201fe4db56ad5

data/README.md

@@ -6,9 +6,9 @@
 
 SchemaConformist is an automatic JSON 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 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).
+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 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 uses [Committee](https://github.com/interagent/committee) to validate JSONs.
 
 ## Usage
 
@@ -22,14 +22,17 @@ gem 'schema_conformist'
 
 and execute `bundle install`.
 
+Configure `schema_path` as follows (ex. using an OpenAPI 3 schema):
+
+```ruby
+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.
 
 ### Writing the 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:
-
-- 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.
 
@@ -37,21 +40,10 @@ 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 (both JSON and YAML are available as schema files)
-- `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.yaml')
-```
+  - 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.
 
 ## 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,47 +1,27 @@
 module SchemaConformist
   module Driver
-    include Committee::Rails::Test::Methods
+    include Committee::Test::Methods
 
-    def committee_schema
-      @committee_schema ||= driver.parse(schema_hash)
+    def committee_options
+      { schema: committee_schema }
     end
 
-    def schema_hash(schema_data = File.read(schema_path))
-      if %w(.yaml .yml).include?(File.extname(schema_path))
-        YAML.safe_load(schema_data)
-      else
-        JSON.parse(schema_data)
-      end
+    def request_object
+      request
     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 response_data
+      [response.status, response.headers, response.body]
     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
+    private
+
+    def committee_schema
+      @commitee_schema ||= Committee::Drivers::load_from_file(schema_path)
     end
 
-    def driver_name
-      Rails.application.config.schema_conformist.driver
+    def schema_path
+      Rails.application.config.schema_conformist.schema_path
     end
   end
 end

data/lib/schema_conformist/process_with_assertion.rb

@@ -12,7 +12,18 @@ module SchemaConformist
     end
 
     def ignored?(path)
-      Rails.application.config.schema_conformist.ignored_api_paths.any? { |regex| path =~ regex }
+      ignored_api_paths.any? do |pattern|
+        case pattern
+        when String
+          path.start_with?(pattern)
+        when Regexp
+          path.match?(pattern)
+        end
+      end
+    end
+
+    def ignored_api_paths
+      Rails.application.config.schema_conformist.ignored_api_paths
     end
   end
 end

data/lib/schema_conformist/railtie.rb

@@ -2,7 +2,6 @@ module SchemaConformist
   class Railtie < Rails::Railtie
     config.before_configuration do
       config.schema_conformist = Configuration.new
-      config.schema_conformist.driver = :hyper_schema
       config.schema_conformist.ignored_api_paths = []
       config.schema_conformist.schema_path = nil
     end

data/lib/schema_conformist/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: schema_conformist
 version: !ruby/object:Gem::Version
-  version: 0.2.2
+  version: 0.3.0
 platform: ruby
 authors:
 - Kohei Yamamoto
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2019-03-27 00:00:00.000000000 Z
+date: 2019-04-22 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -24,34 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: committee-rails
-  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: committee
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: 3.0.1
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 2.5.1
+        version: 3.0.1
 - !ruby/object:Gem::Dependency
   name: sqlite3
   requirement: !ruby/object:Gem::Requirement