schema_matcher 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 2f63cddcf87db79491fd97d87fb673ad47dd9d096a7697be86e0b8ce71f48ff6
+  data.tar.gz: '0879f7a6573e9459bbb8b4a3797d3deecdbf5060cc458a57fcd46477b5c4e5d7'
+SHA512:
+  metadata.gz: 73ca9559bfc1be14108137dc3c26450671150859870e75163e56f50d33067d4353a7e4ec89ee3cd36f8dcc03b407eaaee37fdfe053792ed3fe38ac3dc0fde174
+  data.tar.gz: cfcdba8173782eeefdb0d3dfe31b201530fb7cc64c92e4b19749a9e26e2e865402de866bab69bea312397230f033df0f9dd3aa24bebc27b33953abe75bcaf18f

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2019 Ivan Rudskikh
+
+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,85 @@
+# SchemaMatcher
+
+Use power of ruby DSL to validate json!
+
+## Installation
+
+Add this line to your application's Gemfile:
+```ruby
+group :test do
+  gem 'schema_matcher'
+end
+```
+
+And then execute:
+```bash
+$ bundle
+```
+
+Or install it yourself as:
+```bash
+$ gem install schema_matcher
+```
+
+Add include to `spec/spec_helper.rb` or `spec/rails_helper.rb` if using Rails
+```ruby
+require "schema_matcher/rspec"
+```
+  
+## Usage
+
+1) Write your schema
+```ruby
+SchemaMatcher.build_schema do
+  define :user do
+    attribute :id, type: :number
+    attribute :first_name #it uses type string by default
+    attribute :last_name
+    attribute :avatar, nullable: true
+    attribute :disabled, type: :boolean
+    attribute :role, optional: true
+    attribute :posts, array: true, ref: :post
+  end
+
+  define :post do
+    attribute :id, type: :number
+    attribute :content
+    attribute :author do
+      attribute :id, type: :number
+      attribute :first_name
+      attribute :last_name
+    end
+  end
+end
+```
+
+2) Check responses:
+```ruby
+RSpec.describe 'Users' do
+ let(:json_response) { JSON.parse(response.body) }
+ 
+  it 'returns user' do
+    get '/users/1'
+    expect(json_response).to match_json_schema(:user)
+  end
+
+  it 'returns a few users' do
+    get '/users'
+    expect(json_response).to match_json_schema(:user, array: true)
+  end
+end
+```
+3) Enjoy!
+
+## Contributing
+
+* Fork the project.
+* Add a breaking test for your change.
+* Make the tests pass.
+* Run `rubocop -a`
+* Push your fork.
+* Submit a pull request.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,27 @@
+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    = 'SchemaMatcher'
+  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/schema_matcher/assertion.rb

@@ -0,0 +1,39 @@
+require 'json-schema'
+require 'schema_matcher/extended_schema'
+
+module SchemaMatcher
+  class Assertion
+    attr_reader :errors
+
+    def initialize(schema_name, payload, options = {})
+      @schema_name = schema_name.to_sym
+      @payload = payload
+      @options = options
+    end
+
+    def valid?
+      @errors = JSON::Validator.fully_validate(schema, payload, validator_options)
+      return true if @errors.empty?
+
+      false
+    end
+
+    private
+
+    attr_reader :payload, :schema_name, :last_error_message, :options
+
+    def schema
+      SchemaMatcher
+        .schema[schema_name]
+        .merge('$schema' => SchemaMatcher::ExtendedSchema::SCHEMA_URI)
+        .merge!(definitions: SchemaMatcher.schema)
+    end
+
+    def validator_options
+      {
+        strict: true,
+        list: options.key?(:array) ? options[:array] : payload.is_a?(Array)
+      }
+    end
+  end
+end

data/lib/schema_matcher/builder.rb

@@ -0,0 +1,5 @@
+module SchemaMatcher
+  class Builder
+    include BuilderApi
+  end
+end

data/lib/schema_matcher/builder_api.rb

@@ -0,0 +1,22 @@
+module SchemaMatcher
+  module BuilderApi
+    def self.included(base)
+      base.instance_variable_set(:@schema, {})
+      base.extend ClassMethods
+    end
+
+    module ClassMethods
+      def schema
+        instance_variable_get(:@schema)
+      end
+
+      def define(model, &blk)
+        schema[model] = Entity.new(&blk)
+      end
+
+      def to_schema
+        schema.transform_values(&:to_schema)
+      end
+    end
+  end
+end

data/lib/schema_matcher/entity.rb

@@ -0,0 +1,53 @@
+module SchemaMatcher
+  class Entity
+    attr_reader :attributes
+
+    def initialize(&blk)
+      @attributes = {}
+      instance_exec(&blk)
+    end
+
+    def attribute(name, options = {}, &blk)
+      return attributes[name] = { type: self.class.new(&blk) }.merge(options).compact if block_given?
+
+      attributes[name] = { type: :string }.merge(options).compact
+    end
+
+    def to_schema
+      {
+        type: :object,
+        properties: attributes.transform_values { |attribute| swaggerize_attribute(attribute) }.compact
+      }
+    end
+
+    private
+
+    def swaggerize_attribute(attribute)
+      if attribute[:array]
+        {
+          type: :array,
+          item: attr_to_schema(attribute)
+        }.merge(extra_schema_properties(attribute))
+      else
+        attr_to_schema(attribute).merge(extra_schema_properties(attribute))
+      end
+    end
+
+    def attr_to_schema(attribute)
+      return { '$ref' => "#/definitions/#{attribute[:ref]}" } if attribute[:ref]
+
+      if attribute[:type].respond_to?(:to_schema)
+        attribute[:type].to_schema
+      else
+        attribute.except(:nullable, :optional, :array)
+      end
+    end
+
+    def extra_schema_properties(attribute)
+      {
+        'x-nullable' => attribute[:nullable],
+        required: attribute[:ref] && !attribute[:array] ? nil : !attribute[:optional]
+      }.compact
+    end
+  end
+end

data/lib/schema_matcher/extended_schema.rb

@@ -0,0 +1,27 @@
+require 'json-schema'
+
+module SchemaMatcher
+  class ExtendedSchema < JSON::Schema::Draft4
+    SCHEMA_URI = 'http://tempuri.org/schema_matcher/extended_schema'.freeze
+
+    def initialize
+      super
+      @attributes['type'] = ExtendedTypeAttribute
+      @attributes['properties'] = JSON::Schema::PropertiesAttribute
+      @uri = URI.parse(SCHEMA_URI)
+      @names = ['draft4-custom', SCHEMA_URI]
+    end
+  end
+
+  class ExtendedTypeAttribute < JSON::Schema::TypeV4Attribute
+    # rubocop:disable Metrics/ParameterLists
+    def self.validate(current_schema, data, fragments, processor, validator, options = {})
+      return if data.nil? && current_schema.schema['x-nullable']
+
+      super
+    end
+    # rubocop:enable Metrics/ParameterLists
+  end
+
+  JSON::Validator.register_validator(ExtendedSchema.new)
+end

data/lib/schema_matcher/rspec.rb

@@ -0,0 +1,5 @@
+require 'schema_matcher/rspec_matchers'
+
+RSpec.configure do |config|
+  config.include(SchemaMatcher::RspecMatchers)
+end

data/lib/schema_matcher/rspec_matchers.rb

@@ -0,0 +1,70 @@
+require 'schema_matcher'
+require 'schema_matcher/assertion'
+
+module SchemaMatcher
+  module RspecMatchers
+    class JsonSchemaMatcher
+      attr_reader :schema_name, :payload, :assertion
+
+      def initialize(schema_name)
+        @schema_name = schema_name
+      end
+
+      def matches?(payload, options = {})
+        @payload = payload
+        @assertion = SchemaMatcher::Assertion.new(schema_name, payload, options)
+        @assertion.valid?
+      end
+
+      def error_message
+        @assertion.errors[0]
+      end
+
+      def failure_message
+        <<~FAIL
+          #{error_message}
+
+          ---
+
+          expected
+
+          #{format_json(payload)}
+
+          to match schema "#{schema_name}":
+
+        FAIL
+      end
+
+      def failure_message_when_negated
+        <<~FAIL
+          #{error_message}
+
+          ---
+
+          expected
+
+          #{format_json(payload)}
+
+          not to match schema "#{schema_name}":
+
+        FAIL
+      end
+
+      def failure_message_for_should
+        failure_message
+      end
+
+      def failure_message_for_should_not
+        failure_message_when_negated
+      end
+
+      def format_json(_json)
+        JSON.pretty_generate(payload)
+      end
+    end
+
+    def match_json_schema(schema)
+      JsonSchemaMatcher.new(schema)
+    end
+  end
+end

data/lib/schema_matcher/version.rb

@@ -0,0 +1,3 @@
+module SchemaMatcher
+  VERSION = '0.1.0'.freeze
+end

data/lib/schema_matcher.rb

@@ -0,0 +1,16 @@
+require 'schema_matcher/version'
+require 'schema_matcher/entity'
+require 'schema_matcher/builder_api'
+require 'schema_matcher/builder'
+
+module SchemaMatcher
+  @schema = nil
+
+  def self.schema
+    @schema ||= Builder.to_schema
+  end
+
+  def self.build_schema(&blk)
+    Builder.class_eval(&blk)
+  end
+end

data/lib/tasks/schema_matcher_tasks.rake

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

metadata

@@ -0,0 +1,113 @@
+--- !ruby/object:Gem::Specification
+name: schema_matcher
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Ivan Rudskikh
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-07-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: json-schema
+  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: factory_bot
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.8'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.8'
+- !ruby/object:Gem::Dependency
+  name: ffaker
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.0'
+description: Use power of ruby DSL to validate json!
+email:
+- shredder.rull@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/schema_matcher.rb
+- lib/schema_matcher/assertion.rb
+- lib/schema_matcher/builder.rb
+- lib/schema_matcher/builder_api.rb
+- lib/schema_matcher/entity.rb
+- lib/schema_matcher/extended_schema.rb
+- lib/schema_matcher/rspec.rb
+- lib/schema_matcher/rspec_matchers.rb
+- lib/schema_matcher/version.rb
+- lib/tasks/schema_matcher_tasks.rake
+homepage: https://github.com/digital-design-nyc/schema_matcher
+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.7.9
+signing_key: 
+specification_version: 4
+summary: Use power of ruby DSL to validate json!
+test_files: []