schema_conformist 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: abd4ddfeec30a4b51b428d7f2b254dc563235a53
+  data.tar.gz: 1f6f6fb6d728cb13a79dbc723b9a37bec34c6bb7
+SHA512:
+  metadata.gz: f9e72c573dce8eef1ae369470b3c422d6e120cf6dd3abb66b2a5b85de15cc102fd724c351d7c3a2fdd6aafac9a96d06dd4aa9e523929bdad580126659416a151
+  data.tar.gz: 105eeaaec3432b13424f16726b60ca0303a9bbec6cbfd33befae89c1f9d078628519a9726985ab042f9b74e12d5ce5a93e2cbc2b8140aed92a55b733a5c88405

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Kohei Yamamoto
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,60 @@
+# SchemaConformist
+
+> An automatic JSON response validator for testing in Rails
+
+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 uses [Committee](https://github.com/interagent/committee) and [Committee::Rails](https://github.com/willnet/committee-rails) to validate JSONs.
+
+## Usage
+
+### Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+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.
+
+### 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`
+
+See [`test/dummy`](https://github.com/kymmt90/schema_conformist/tree/master/test/dummy) app for examples.
+
+### Configurations
+
+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')
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/kymmt90/schema_conformist.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'SchemaConformist'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/action_dispatch/integration.rb

@@ -0,0 +1,7 @@
+module ActionDispatch
+  module Integration
+    class Session
+      prepend SchemaConformist::ProcessWithAssertion
+    end
+  end
+end

data/lib/schema_conformist/driver.rb

@@ -0,0 +1,43 @@
+module SchemaConformist
+  module Driver
+    include Committee::Rails::Test::Methods
+
+    def committee_schema
+      @committee_schema ||=
+        begin
+          schema_hash = JSON.parse(File.read(schema_path))
+          driver.parse(schema_hash)
+        end
+    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
+    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
+    end
+
+    def driver_name
+      Rails.application.config.schema_conformist.driver
+    end
+  end
+end

data/lib/schema_conformist/process_with_assertion.rb

@@ -0,0 +1,18 @@
+module SchemaConformist
+  module ProcessWithAssertion
+    include SchemaConformist::Driver
+
+    def process(*args)
+      super *args
+
+      path = args[1]
+      return if ignored?(path)
+
+      assert_schema_conform
+    end
+
+    def ignored?(path)
+      Rails.application.config.schema_conformist.ignored_api_paths.any? { |regex| path =~ regex }
+    end
+  end
+end

data/lib/schema_conformist/railtie.rb

@@ -0,0 +1,13 @@
+module SchemaConformist
+  class Railtie < Rails::Railtie
+    config.before_configuration do
+      config.schema_conformist = Configuration.new
+    end
+
+    initializer 'config.schema_conformist' do
+      config.schema_conformist.driver = :hyper_schema
+      config.schema_conformist.ignored_api_paths = []
+      config.schema_conformist.schema_path = nil
+    end
+  end
+end

data/lib/schema_conformist/version.rb

@@ -0,0 +1,3 @@
+module SchemaConformist
+  VERSION = '0.1.0'
+end

data/lib/schema_conformist.rb

@@ -0,0 +1,10 @@
+require 'committee'
+require 'committee/rails'
+require 'schema_conformist/railtie'
+require 'schema_conformist/driver'
+require 'schema_conformist/process_with_assertion'
+require 'action_dispatch/integration'
+
+module SchemaConformist
+  class Error < StandardError; end
+end

data/lib/tasks/schema_conformist_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :schema_conformist do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: schema_conformist
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Kohei Yamamoto
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2017-11-05 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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 5.1.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
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.0
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: SchemaConformist is an automatic JSON response validator for your API
+  testing in Rails.
+email:
+- kymmt90@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/action_dispatch/integration.rb
+- lib/schema_conformist.rb
+- lib/schema_conformist/driver.rb
+- lib/schema_conformist/process_with_assertion.rb
+- lib/schema_conformist/railtie.rb
+- lib/schema_conformist/version.rb
+- lib/tasks/schema_conformist_tasks.rake
+homepage: https://github.com/kymmt90/schema_conformist
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.13
+signing_key: 
+specification_version: 4
+summary: An automatic JSON response validator for testing in Rails
+test_files: []