match_json 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6700101a6f7589f99d3ac22a5e22392cca6bef8b
+  data.tar.gz: e608c2d863253955e52214efad1bc0ff984c0352
+SHA512:
+  metadata.gz: 59005a3e78998816e9fac442cf60296e5c9a7bb5e111ac787eb78129c8f22465e7b221aef64617014f8059102fd5b2b7346c4216fdf3a13a5b7c9f53c70f5341
+  data.tar.gz: 1cc241114b0cc43d5cec22b479b4b5823920d07e17cda729ea04688ca2121eefb8810df813146fcd2622b997d58c081b1ec4c2116a481e400bc7fcaf3701f961

data/.gitignore

@@ -0,0 +1,14 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/Gemfile

@@ -0,0 +1,11 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in match_json.gemspec
+gemspec
+
+gem 'rspec', git: 'https://github.com/rspec/rspec.git'
+gem 'rspec-core', git: 'https://github.com/rspec/rspec-core.git'
+gem 'rspec-mocks', git: 'https://github.com/rspec/rspec-mocks.git'
+gem 'rspec-expectations', git: 'https://github.com/rspec/rspec-expectations.git'
+gem 'rspec-support', git: 'https://github.com/rspec/rspec-support.git'
+

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2015 Pavel Gabriel and White Payments Technologies FZE
+
+MIT License
+
+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,94 @@
+# MatchJson
+
+Easily test your JSON in RSpec and Cucumber.
+
+This matcher can't be the only tool when you test your JSON. We also
+recommend to use [json-schema](https://github.com/ruby-json-schema/json-schema)
+as a perfect companion to MatchJson.
+
+## Usage: RSpec
+
+In RSpec we add this matcher: ```include_json```
+
+So you can use it as follows:
+
+```ruby
+it 'returns charge' do
+  get '/charges/#{charge.id}'
+
+  expect(response).to include_json(<<-JSON)
+  {
+    "id": "{uuid}",
+    "amount": 100,
+    "currency": "USD",
+    "created_at": "{date_time_iso8601}"
+  }
+  JSON
+end
+
+it 'returns list of charges' do
+  get '/charges'
+
+  expect(response).to include_json(<<-JSON)
+  {
+    "charges": [
+      {
+        "id": "{uuid}",
+        "amount": 100,
+        "currency": "USD",
+        "created_at": "{date_time_iso8601}"
+      }
+    ]
+  }
+  JSON
+end
+```
+
+As you can see for cases when you do not know the value of some properties like
+```id``` or ```created_at``` or even ```email``` you can use 'pattern' instead.
+
+You can use the following predefined patterns:
+
+* date_time_iso8601
+* date
+* uuid
+* email
+* string
+
+You also can add your own pattern in this way:
+
+```ruby
+MatchJson::Matchers::IncludeJson::PATTERNS['id'] = /\A\d{6}\z/
+```
+
+and then use it in your spec:
+
+```ruby
+it 'uses patten to check value' do
+  expect(%Q({"one": "123456"})).to include_json(%Q({"one": "{id}"}))
+end
+```
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'match_json'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install match_json
+
+## Contributing
+
+1. Fork it ( https://github.com/[my-github-username]/match_json/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+

data/lib/match_json/matchers/include_json.rb

@@ -0,0 +1,98 @@
+
+module MatchJson
+  module Matchers
+    class IncludeJson
+      PATTERNS = {
+        'date_time_iso8601' => /^\d{4}-\d{2}-\d{2}T\d{2}:\d{2}:\d{2}/,
+        'date' => /^\d{4}-\d{2}-\d{2}/,
+        'uuid' => /\h{32}/,
+        'email' => /\A[-a-z0-9_+\.]+\@([-a-z0-9]+\.)+[a-z0-9]{2,6}\z/i,
+        'string' => /\A.+\z/i
+      }
+
+      def initialize(expected_json)
+        @expected_json = JSON.parse(expected_json)
+      end
+
+      def matches?(actual_json)
+        @actual_json = actual_json.respond_to?(:body) ? JSON.parse(actual_json.body) : JSON.parse(actual_json)
+
+        match = catch(:match) { json_included?(@actual_json, @expected_json) }
+      end
+
+      def failure_message
+        @failure_message
+      end
+
+      def failure_message_when_negated
+        "does not support negation"
+      end
+
+      private
+
+      def json_included?(actual, expected)
+        equal_value?(actual, expected)
+      end
+
+      def hash_included?(actual, expected, nested, raise_error)
+        expected.each do |key, value|
+          if (!equal_value?(actual[key], value, "#{nested} > #{key}", raise_error))
+            @failure_message = %Q("#{key}"=>#{value} was not found in\n #{actual})
+
+            if raise_error
+              throw(:match, false)
+            else
+              return false
+            end
+          end
+        end
+      end
+
+      def array_included?(actual, expected, nested, raise_error)
+        expected.each do |value|
+          if (!actual.any? { |actual_value| equal_value?(actual_value, value, nested, false) })
+            @failure_message = %Q("#{value}" was not found in\n )
+            @failure_message << %Q("#{nested}"=>) if !nested.empty?
+            @failure_message << "#{actual}"
+
+            if raise_error
+              throw(:match, false)
+            else
+              return false
+            end
+          end
+        end
+      end
+
+      def equal_value?(actual, expected, nested = '', raise_error = true)
+        case expected
+        when Array then array_included?(actual, expected, nested, raise_error)
+        when Hash then hash_included?(actual, expected, nested, raise_error)
+        when String then compare_with_pattern(expected, actual)
+        else
+          actual == expected
+        end
+      end
+
+      def compare_with_pattern(value, actual)
+        case
+        when regexp?(value)
+          reg_exp = value.match(/{re:(.*)}/)[1]
+          actual =~ Regexp.new(reg_exp)
+        when pattern?(value)
+          actual =~ PATTERNS["#{value.gsub('{', '').gsub('}', '')}"]
+        else
+          value == actual
+        end
+      end
+
+      def pattern?(str)
+        !!(str =~ /\A\{\w+\}\z/)
+      end
+
+      def regexp?(str)
+        !!(str =~ /\A\{re:.+\}\z/)
+      end
+    end
+  end
+end

data/lib/match_json/matchers.rb

@@ -0,0 +1,13 @@
+require 'match_json/matchers/include_json'
+
+module MatchJson
+  module Matchers
+    def include_json(json)
+      MatchJson::Matchers::IncludeJson.new(json)
+    end
+  end
+end
+
+RSpec.configure do |config|
+  config.include MatchJson::Matchers
+end

data/lib/match_json/version.rb

@@ -0,0 +1,3 @@
+module MatchJson
+  VERSION = "0.0.1"
+end

data/lib/match_json.rb

@@ -0,0 +1,7 @@
+require "json"
+require "match_json/version"
+require "match_json/matchers"
+
+module MatchJson
+  # Your code goes here...
+end

data/match_json.gemspec

@@ -0,0 +1,23 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'match_json/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "match_json"
+  spec.version       = MatchJson::VERSION
+  spec.authors       = ["Pavel Gabriel", "White Payments"]
+  spec.email         = ["alovak@gmail.com"]
+  spec.summary       = %q{RSpec matcher for JSON documents}
+  spec.description   = %q{Easily test your JSON in RSpec and Cucumber.}
+  spec.homepage      = "https://github.com/WhitePayments/match_json"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.7"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/spec/match_json/matchers_spec.rb

@@ -0,0 +1,81 @@
+require 'spec_helper'
+
+describe "include_json" do
+  it 'passes when object is partially included' do
+    expect(%Q({ "one": 1, "two": 2 })).to include_json(%Q({ "one": 1 }))
+  end
+
+  it "fails when expected object is not included" do
+    expect {
+      expect(%Q({ "one": 1 })).to include_json(%Q({ "one": 2 }))
+    }.to fail_with(%Q("one"=>2 was not found in\n {"one"=>1}))
+  end
+
+  it 'passes when array is partially included' do
+    expect(%Q([1, 2, 3])).to include_json(%Q([3, 2]))
+    expect(%Q([1, 2, 3])).to include_json(%Q([1, 2, 3]))
+  end
+
+  it 'fails when there is no such array' do
+    expect {
+      expect(%Q([1, 2, 3])).to include_json(%Q([3, 5]))
+    }.to fail_with(%Q("5" was not found in\n [1, 2, 3]))
+  end
+
+  context 'when object contains array' do
+    it 'passes when array included' do
+      expect(%Q({ "array" : [1, 2, 3] })).to include_json(%Q({ "array" : [3, 2, 1] }))
+    end
+
+    it 'fails with there is no such array' do
+      expect {
+        expect(%Q({ "array" : [1, 2, 3] })).to include_json(%Q({ "array" : [5, 1] }))
+      }.to fail_with(%Q("5" was not found in\n " > array"=>[1, 2, 3]))
+    end
+  end
+
+  context 'when array contains object' do
+    it 'passes when object included in array' do
+      expect(%Q([ { "one": 1 }, { "two": 2 }])).to include_json(%Q([ { "one": 1 }]))
+    end
+
+    it 'fails when there is no such object in array' do
+      expect {
+        expect(%Q([ { "one": 1 }, { "two": 2 }])).to include_json(%Q([ { "one": 2 }]))
+      }.to fail_with(%Q(\"{"one"=>2}\" was not found in\n [{"one"=>1}, {"two"=>2}]))
+    end
+  end
+
+  context 'in multilevel structure' do
+    it 'fails if object was not found' do
+      expect {
+        expect(%Q([ { "one": { "array": [1,2,3] } } ])).to include_json(%Q([ { "one": { "array": [1,2,3,4] } } ]))
+      }.to fail_with(%Q("{"one"=>{"array"=>[1, 2, 3, 4]}}" was not found in\n [{"one"=>{"array"=>[1, 2, 3]}}]))
+    end
+  end
+
+  context 'with pattern' do
+    it 'passes when value matches pattern' do
+      expect(%Q({"one": "test@exmaple.com"})).to include_json(%Q({"one": "{email}"}))
+      expect(%Q({"one": "2020-12-22"})).to include_json(%Q({"one": "{date}"}))
+    end
+  end
+
+  context 'with custom pattern' do
+    before do
+      MatchJson::Matchers::IncludeJson::PATTERNS['id'] = /\A\d{6}\z/
+    end
+
+    after do
+      MatchJson::Matchers::IncludeJson::PATTERNS.delete('id')
+    end
+
+    it 'uses patten to check value' do
+      expect(%Q({"one": "123456"})).to include_json(%Q({"one": "{id}"}))
+
+      expect {
+        expect(%Q({"one": "abcdef"})).to include_json(%Q({"one": "{id}"}))
+      }.to fail_with(%Q("one"=>{id} was not found in\n {"one"=>"abcdef"}))
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,10 @@
+require 'match_json'
+require 'byebug'
+
+Dir['./spec/support/**/*'].each do |f|
+  require f.sub(%r{\./spec/}, '')
+end
+
+RSpec.configure do |config|
+  config.include RSpec::Matchers::FailMatchers
+end

data/spec/support/fail_matchers.rb

@@ -0,0 +1,41 @@
+module RSpec
+  module Matchers
+    # Matchers for testing RSpec matchers. Include them with:
+    #
+    #     require 'rspec/matchers/fail_matchers'
+    #     RSpec.configure do |config|
+    #       config.include RSpec::Matchers::FailMatchers
+    #     end
+    #
+    module FailMatchers
+      # Matches if an expectation fails
+      #
+      # @example
+      #   expect { some_expectation }.to fail
+      def fail
+        raise_error(RSpec::Expectations::ExpectationNotMetError)
+      end
+
+      # Matches if an expectation fails with the provided message
+      #
+      # @example
+      #   expect { some_expectation }.to fail_with("some failure message")
+      #   expect { some_expectation }.to fail_with(/some failure message/)
+      def fail_with(message)
+        raise_error(RSpec::Expectations::ExpectationNotMetError, message)
+      end
+
+      # Matches if an expectation fails including the provided message
+      #
+      # @example
+      #   expect { some_expectation }.to fail_including("portion of some failure message")
+      def fail_including(snippet)
+        raise_error(
+          RSpec::Expectations::ExpectationNotMetError,
+          a_string_including(snippet)
+        )
+      end
+    end
+  end
+end
+

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification
+name: match_json
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Pavel Gabriel
+- White Payments
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2015-02-27 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.7'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: Easily test your JSON in RSpec and Cucumber.
+email:
+- alovak@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/match_json.rb
+- lib/match_json/matchers.rb
+- lib/match_json/matchers/include_json.rb
+- lib/match_json/version.rb
+- match_json.gemspec
+- spec/match_json/matchers_spec.rb
+- spec/spec_helper.rb
+- spec/support/fail_matchers.rb
+homepage: https://github.com/WhitePayments/match_json
+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.4.5
+signing_key: 
+specification_version: 4
+summary: RSpec matcher for JSON documents
+test_files:
+- spec/match_json/matchers_spec.rb
+- spec/spec_helper.rb
+- spec/support/fail_matchers.rb