json_response_matchers 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: f9d75ea0b51b5fe4ecbb1c396dfd73788d3b5c931d3c048f1b452b4f31fbda80
+  data.tar.gz: f7db535ebccc51e66eb9d41e6f24aca40d76226f5accd29300f34c9cdf042c13
+SHA512:
+  metadata.gz: c129e180cac8ea2780c9135d217e25fada4bfc7f8269900fc14ac2997a1a5fd9c0a92620ae256e633cf5b498b0a71d50f5667668cf934d26f9dcc6cc37c3ca6f
+  data.tar.gz: 282bd1cb707e91d05fa1a05c058d52ccef806d53ecac35a335bc96748c78f2ba909386203452120037de6e6e77c4bff9db0fb0f92085d6dff11fda5637981cf7

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/Appraisals

@@ -0,0 +1,25 @@
+if RUBY_VERSION < '2.4'
+  appraise 'activesupport-4' do
+    gem 'activesupport', '4.0.6'
+  end
+end
+
+if RUBY_VERSION >= '2.3'
+  appraise 'activesupport-5' do
+    gem 'activesupport', '5.0.0'
+  end
+
+  appraise 'activesupport-5.2.2' do
+    gem 'activesupport', '5.2.2'
+  end
+end
+
+appraise 'rspec-3' do
+  gem 'rspec', '3.0.0'
+  gem 'activesupport', '4.0.6' if RUBY_VERSION < '2.3'
+end
+
+appraise 'rspec-3.8' do
+  gem 'rspec', '3.8.0'
+  gem 'activesupport', '4.0.6' if RUBY_VERSION < '2.3'
+end

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in json_response_matchers.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2019 Szijjártó Nagy Misu
+
+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,148 @@
+# JsonResponseMatchers
+
+[rspec](https://relishapp.com/rspec) matchers for testing json responses in a [rails](https://rubyonrails.org/) application.
+
+## Dependencies
+
+* **ruby** `'>= 2.0.0'`
+* **rspec** `'>= 3.0'` <!-- see composable matchers -->
+* **activesupport** `'>= 4.0.6'` <!-- see https://github.com/rails/rails/pull/10887 -->
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'json_response_matchers'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+1. include the matchers in your rspec config
+
+  ```ruby
+  # spec/rails_helper.rb
+  RSpec.configure do |config|
+    # you can include it in a general way
+    config.include JsonResponseMatchers
+    # but it is recommended to include it only for the request
+    config.include JsonResponseMatchers, type: :request
+    # or the request and controller specs
+    config.include JsonResponseMatchers, type: /request|controller/
+  end
+  ```
+
+2. write more concise request specs
+
+  ```ruby
+  # in your request spec examples
+  # instead of
+  item = JSON.parse(response.body)['item']
+  expect(item['name']).to eq 'item-name'
+  # use the #have_json_content matcher
+  expect(response).to have_json_content('item-name').at_key :item, :name
+
+  # instead of
+  items = JSON.parse(repsonse.body)['items']
+  expect(items.map { |item| item['id'] }).to match_array [ 1, 2, 3, 4, 5 ]
+  # use the #have_json_values matcher
+  expect(response).to have_json_values(1, 2, 3, 4, 5).for(:id).at_key :items
+  ```
+
+### general rules
+
+The target of the matchers can be a json parsable string or an object with such a string at the method `#body` (like the test response in rails request tests).
+
+```ruby
+expect('{"item":{"id":1,"name":"item-name"}}').to have_json_content('item-name').at_key :item, :name
+# or if `response.body` contains the above json
+expect(response).to have_json_content('item-name').at_key :item, :name
+```
+
+The `#at_key` method is optional and can receive one or more `string`, `symbol` or `integer` keys.
+
+```ruby
+expect('false').to have_json_content(false)
+
+json = '{"items":[{"id":1,"name":"item-1"},{"id":2,"name":"item-2"}]}'
+expect(json).to have_json_values(1, 2).for(:id).at_key 'items'
+expect(json).to have_json_values(1, 2).for(:id).at_key :items
+expect(json).to have_json_content('item-2').at_key :items, 1, 'name'
+```
+
+Both matchers are [composable](https://relishapp.com/rspec/rspec-expectations/docs/composing-matchers).
+
+```ruby
+expect('{"item":{"id":1},"user":{"name":"user"}}')
+  .to have_json_content(1).at_key(:item, :id)
+  .and have_json_values('user').at_key(:user, :name)
+
+expect('{"items":[{"id":1},{"id":2}],"page":1}')
+  .to have_json_values(1, 2).for(:id).at_key(:item)
+  .and have_json_content(1).at_key(:page)
+```
+
+### #have_json_content
+
+Checks single values.
+
+* If expected value is not a `hash`, it checks equality
+
+  ```ruby
+  # all pass
+  expect('{"string":"string"}').to have_json_content('string').at_key :string
+  expect('{"number":123}').to have_json_content(123).at_key :number
+  expect('{"boolean":false}').to have_json_content(false).at_key :boolean
+  expect('{"array":["a",2]}').to have_json_content([ 'a', 2 ]).at_key :array
+  expect('{"null":null}').to have_json_content(nil).at_key :null
+  ```
+
+* If expected value is a `hash`
+  * and `#with_full_match` is specified, it checks equality
+  * otherwise it checks inclusion
+  * accepts symbol keys
+
+    ```ruby
+    expect('{"id":1,"name":"i1"}').to have_json_content('id'=>1).with_full_match # fails
+    expect('{"id":1,"name":"i1"}').to have_json_content('id'=>1) # passes
+    expect('{"id":1,"name":"i1"}').to have_json_content(name: 'i1', id: 1).with_full_match # passes
+    ```
+
+
+### #have_json_values
+
+Checks arrays. The expected values are passed as a parameter list (`*args`) to the matcher.
+
+* the metod `#for` is required and can take a `string` or `symbol` value
+
+  ```ruby
+  items = [
+    { id: 1, name: 'item-1' },
+    { id: 2, name: 'item-2' },
+    { id: 3, name: 'item-3' }
+  ]
+  expect(items.to_json).to have_json_values(1, 2, 3).for('id') # passes
+  expect(items.to_json).to have_json_values(1, 2, 3).for(:id) # passes
+  expect(items.to_json).to have_json_values(*items) # fails with ArgumentError
+  ```
+
+* checks order only if `#in_strict_order` is specified
+
+  ```ruby
+  expect(items.to_json).to have_json_values(1, 3, 2).for(:id) # passes
+  expect(items.to_json).to have_json_values(1, 3, 2).for(:id).in_strict_order # fails
+  ```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/SzNagyMisu/json_response_matchers.
+
+## 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 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+DEFAULT_RUBY_VERSIONS = [ '2.0.0', '2.3.7', '2.5.1', '2.6.0-preview2' ].freeze
+
+desc "Test against multiple ruby, activerecord and rspec versions - " +
+  "set RUBY_VERSIONS to the version(s) to test with (default: #{DEFAULT_RUBY_VERSIONS.join(',').inspect})"
+task :full_test do
+  versions = ENV['RUBY_VERSIONS'] ? ENV['RUBY_VERSIONS'].split(',') : DEFAULT_RUBY_VERSIONS
+  started_at = Time.now
+
+  versions.each do |version|
+    sh "./bin/test #{version}"
+  end
+
+  time_elapsed = (Time.now - started_at).to_i
+  hours = time_elapsed / 3600
+  minutes = time_elapsed / 60 % 60
+  seconds = time_elapsed % 60
+  puts "\nTest suit complete\n" +
+    "  ruby versions: #{versions.join(', ')}\n" +
+    "  run in #{hours}h #{minutes}m #{seconds}s\n"
+end
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/test

@@ -0,0 +1,21 @@
+#!/usr/bin/env bash
+
+set -e
+
+if [ $1 ]; then
+  # see https://rvm.io/workflow/scripting
+  if [[ -s "$HOME/.rvm/scripts/rvm" ]] ; then
+    source "$HOME/.rvm/scripts/rvm"
+  elif [[ -s "/usr/local/rvm/scripts/rvm" ]] ; then
+    source "/usr/local/rvm/scripts/rvm"
+  else
+    printf "ERROR: An RVM installation was not found."
+  fi
+  rvm use $1
+fi
+
+bundle update
+bundle exec appraisal update
+bundle exec appraisal rspec
+
+echo 'Success!'

data/gemfiles/activesupport_4.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "4.0.6"
+
+gemspec path: "../"

data/gemfiles/activesupport_4.gemfile.lock

@@ -0,0 +1,56 @@
+PATH
+  remote: ..
+  specs:
+    json_response_matchers (1.1.0)
+      activesupport (>= 4.0.6)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.6)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (4.7.5)
+    multi_json (1.13.1)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (0.3.55)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (= 4.0.6)
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  json_response_matchers!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/gemfiles/activesupport_5.2.2.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "5.2.2"
+
+gemspec path: "../"

data/gemfiles/activesupport_5.2.2.gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: ..
+  specs:
+    json_response_matchers (1.1.0)
+      activesupport (>= 4.0.6)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (= 5.2.2)
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  json_response_matchers!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/gemfiles/activesupport_5.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "activesupport", "5.0.0"
+
+gemspec path: "../"

data/gemfiles/activesupport_5.gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: ..
+  specs:
+    json_response_matchers (1.1.0)
+      activesupport (>= 4.0.6)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.0.0)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  activesupport (= 5.0.0)
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  json_response_matchers!
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.6

data/gemfiles/rspec_3.8.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec", "3.8.0"
+
+gemspec path: "../"

data/gemfiles/rspec_3.8.gemfile.lock

@@ -0,0 +1,55 @@
+PATH
+  remote: ..
+  specs:
+    json_response_matchers (1.1.0)
+      activesupport (>= 4.0.6)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.8.0)
+      rspec-core (~> 3.8.0)
+      rspec-expectations (~> 3.8.0)
+      rspec-mocks (~> 3.8.0)
+    rspec-core (3.8.0)
+      rspec-support (~> 3.8.0)
+    rspec-expectations (3.8.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-mocks (3.8.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.8.0)
+    rspec-support (3.8.0)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  json_response_matchers!
+  rake (~> 10.0)
+  rspec (= 3.8.0)
+
+BUNDLED WITH
+   1.16.6

data/gemfiles/rspec_3.gemfile

@@ -0,0 +1,7 @@
+# This file was generated by Appraisal
+
+source "https://rubygems.org"
+
+gem "rspec", "3.0.0"
+
+gemspec path: "../"

data/gemfiles/rspec_3.gemfile.lock

@@ -0,0 +1,54 @@
+PATH
+  remote: ..
+  specs:
+    json_response_matchers (1.1.0)
+      activesupport (>= 4.0.6)
+      rspec (~> 3.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    appraisal (2.2.0)
+      bundler
+      rake
+      thor (>= 0.14.0)
+    concurrent-ruby (1.1.4)
+    diff-lcs (1.3)
+    i18n (1.5.3)
+      concurrent-ruby (~> 1.0)
+    minitest (5.11.3)
+    rake (10.5.0)
+    rspec (3.0.0)
+      rspec-core (~> 3.0.0)
+      rspec-expectations (~> 3.0.0)
+      rspec-mocks (~> 3.0.0)
+    rspec-core (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-expectations (3.0.4)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.0.0)
+    rspec-mocks (3.0.4)
+      rspec-support (~> 3.0.0)
+    rspec-support (3.0.4)
+    thor (0.20.3)
+    thread_safe (0.3.6)
+    tzinfo (1.2.5)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  appraisal (~> 2.2)
+  bundler (~> 1.16)
+  json_response_matchers!
+  rake (~> 10.0)
+  rspec (= 3.0.0)
+
+BUNDLED WITH
+   1.16.6

data/json_response_matchers.gemspec

@@ -0,0 +1,39 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "json_response_matchers/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "json_response_matchers"
+  spec.version       = JsonResponseMatchers::VERSION
+  spec.authors       = ["Szijjártó Nagy Misu"]
+  spec.email         = ["szijjartonagy.misu@gmail.com"]
+
+  spec.summary       = 'rspec matchers to test http responses with json content in rails'
+  spec.description   = 'Provides two matchers (#have_json_content and #have_json_values) to make testing the content of json responses easy.'
+  spec.homepage      = 'https://github.com/SzNagyMisu/json_response_matchers'
+  spec.license       = "MIT"
+
+  if spec.respond_to?(:metadata)
+    spec.metadata["homepage_uri"]    = spec.homepage
+    spec.metadata["source_code_uri"] = spec.homepage
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  spec.files         = `git ls-files -- lib/*`.split("\n") + %w[ README.md LICENSE.txt json_response_matchers.gemspec ]
+  spec.bindir        = "bin"
+  spec.test_files    = `git ls-files -- gemfiles/* spec/*`.split("\n") + %w[ Appraisals Gemfile Rakefile .rspec bin/test ]
+  spec.executables   = []
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = ">= 2.0.0"
+
+  spec.add_dependency "rspec", "~> 3.0"
+  spec.add_dependency "activesupport", ">= 4.0.6"
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "appraisal", "~> 2.2"
+end

data/lib/json_response_matchers/base.rb

@@ -0,0 +1,37 @@
+require "json"
+require 'active_support/core_ext/hash/keys'
+require 'rspec'
+
+module JsonResponseMatchers
+  class Base
+    attr_reader :expected, :actual
+
+    include RSpec::Matchers::Composable
+
+    def initialize expected
+      @expected = expected
+    end
+
+    def at_key *hash_keys
+      @keys = hash_keys
+      self
+    end
+
+    def diffable?
+      true
+    end
+
+
+    private
+
+      def extract_parsed_json_from json_or_response
+        json = json_or_response.respond_to?(:body) ? json_or_response.body : json_or_response
+        JSON.parse json
+      end
+
+      def fetch_from hash
+        ( @keys || [] ).each { |key| hash = hash.fetch(Integer === key ? key : key.to_s) }
+        hash
+      end
+  end
+end

data/lib/json_response_matchers/content.rb

@@ -0,0 +1,36 @@
+require "json_response_matchers/base"
+
+module JsonResponseMatchers
+  class Content < Base
+    def initialize expected
+      super
+      @exact = true
+      if Hash === @expected
+        @expected.deep_stringify_keys!
+        @exact = false
+      end
+    end
+
+    def failure_message
+      "expected\n    #{@actual}\nto #{@exact ? 'equal' : 'include'}\n    #{@expected}"
+    end
+
+
+    def matches? actual
+      @actual = fetch_from extract_parsed_json_from actual
+      @exact ? @actual == @expected : hash_include?
+    end
+
+    def with_full_match
+      @exact = true
+      self
+    end
+
+
+    private
+
+      def hash_include?
+        @expected.all? { |key, expected_value| @actual[key.to_s] == expected_value }
+      end
+  end
+end

data/lib/json_response_matchers/values.rb

@@ -0,0 +1,49 @@
+require "json_response_matchers/base"
+
+module JsonResponseMatchers
+  class Values < Base
+
+    def initialize expected
+      super
+      @check_order = false
+    end
+
+    def failure_message
+      "expected\n    #{@actual}\nto #{@check_order ? 'equal' : 'match'}\n    #{@expected}"
+    end
+
+
+    def matches? actual
+      raise ArgumentError, "You must set one or more attributes for mapping with #for:\n    have_json_values(#{@expected}).for(attribute_name(s))" unless @for
+      @actual = fetch_from extract_parsed_json_from actual
+      @actual = @actual.map do |item|
+        @for.one? ? item[@for.first] : @for.map { |attribute| item[attribute] }
+      end
+      @check_order ? @actual == @expected : arrays_match?
+    end
+
+    def for *attributes
+      @for = attributes.map &:to_s
+      self
+    end
+
+    def in_strict_order
+      @check_order = true
+      self
+    end
+
+
+    private
+
+      def arrays_match?
+        expected = @expected.dup
+        all_matches = @actual.all? do |actual_value|
+          if expected.include? actual_value
+            expected.delete actual_value
+            true
+          end
+        end
+        all_matches && expected.empty?
+      end
+  end
+end

data/lib/json_response_matchers/version.rb

@@ -0,0 +1,3 @@
+module JsonResponseMatchers
+  VERSION = "1.1.0"
+end

data/lib/json_response_matchers.rb

@@ -0,0 +1,13 @@
+require "json_response_matchers/version"
+require "json_response_matchers/content"
+require "json_response_matchers/values"
+
+module JsonResponseMatchers
+  def have_json_values *values
+    Values.new values
+  end
+
+  def have_json_content parsed_content
+    Content.new parsed_content
+  end
+end

data/spec/content_spec.rb

@@ -0,0 +1,99 @@
+RSpec.describe '#have_json_content' do
+  let(:item)     { { item: { name: 'item 1', count: 2 } } }
+  let(:json)     { item.to_json }
+  let(:nested)   { { items: [ item ] }.to_json }
+  let(:response) { Struct.new(:body).new json }
+
+  describe 'the expected value' do
+    it 'can be a string.' do
+      expect({ string: 'string' }.to_json).to have_json_content('string').at_key(:string)
+    end
+
+    it 'can be a number.' do
+      expect({ number: 123 }.to_json).to have_json_content(123).at_key(:number)
+    end
+
+    it 'can be a boolean.' do
+      expect({ boolean: false }.to_json).to have_json_content(false).at_key(:boolean)
+    end
+
+    it 'can be an array.' do
+      expect({ array: [ :a, 2 ] }.to_json).to have_json_content([ 'a', 2 ]).at_key(:array)
+    end
+
+    it 'can be nil.' do
+      expect({ null: nil }.to_json).to have_json_content(nil).at_key(:null)
+    end
+
+    describe 'can be a hash' do
+      it 'with string keys.' do
+        expect(json).to have_json_content('name' => 'item 1', 'count' => 2).at_key('item')
+      end
+
+      it 'with symbol keys.'do
+        expect(json).to have_json_content(name: 'item 1', count: 2).at_key(:item)
+      end
+
+      it 'with symbol keys in deep nesting.' do
+        expect(nested).to have_json_content(items: [ item: { name: 'item 1', count: 2 } ])
+      end
+    end
+  end
+
+
+  it 'works for the response object.' do
+    expect(response).to have_json_content(name: 'item 1', count: 2).at_key(:item)
+  end
+
+  it 'works for the response body (json string).' do
+    expect(response.body).to have_json_content(name: 'item 1', count: 2).at_key(:item)
+  end
+
+  it 'works with no key passed.' do
+    expect(item[:item].to_json).to have_json_content(name: 'item 1', count: 2)
+  end
+
+  it 'works with multiple keys passed.' do
+    expect({ container: item }.to_json).to have_json_content(name: 'item 1', count: 2).at_key(:container, :item)
+  end
+
+  it 'works with symbol, string or integer key.' do
+    expect({ items: [ { name: 'item 1' } ] }.to_json).to have_json_content('item 1').at_key('items', 0, :name)
+  end
+
+  it 'checks inclusion by default.' do
+    expect(json).to have_json_content(name: 'item 1').at_key(:item)
+    expect(json).to have_json_content(count: 2).at_key(:item)
+  end
+
+  it 'checks equality if #with_full_match is set.' do
+    expect {
+      expect(json).to have_json_content(name: 'item 1').at_key(:item).with_full_match
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError
+    expect(json).to have_json_content(count: 2, name: 'item 1').at_key(:item)
+  end
+
+  it 'fails if additional key value pairs are passed as expected.' do
+    expect {
+      expect(json).to have_json_content(name: 'item 1', count: 2, price: 100).at_key(:item)
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError
+    expect {
+      expect(json).to have_json_content(name: 'item 1', count: 2, price: 100).at_key(:item).with_full_match
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError
+  end
+
+  it 'fails with error message giving information about order check, actual, expected (and diff).' do
+    expect {
+      expect(json).to have_json_content(name: 'item 2').at_key(:item)
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError, /expected\n    \{"name"=>"item 1", "count"=>2\}\nto include\n    \{"name"=>"item 2"\}/
+    expect {
+      expect(json).to have_json_content(name: 'item 1').at_key(:item).with_full_match
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError, /expected\n    \{"name"=>"item 1", "count"=>2\}\nto equal\n    \{"name"=>"item 1"\}/
+  end
+
+  it 'works as compound matcher.' do
+    expect(json).to have_json_content(name: 'item 1', count: 2).at_key(:item).and include('"item":')
+    expect(json).to have_json_content(name: 'item 2', count: 1).at_key(:item).or  include('"item":')
+    expect(response).to have_json_content(count: 2).at_key(:item).and have_json_content('item 1').at_key :item, :name
+  end
+end

data/spec/json_response_matchers_spec.rb

@@ -0,0 +1,5 @@
+RSpec.describe JsonResponseMatchers do
+  it "has a version number" do
+    expect(JsonResponseMatchers::VERSION).to eq '1.1.0'
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require "bundler/setup"
+require "json_response_matchers"
+
+RSpec.configure do |config|
+  # Enable flags like --only-failures and --next-failure
+  config.example_status_persistence_file_path = ".rspec_status" if RSpec::Core::Version::STRING >= '3.3.0'
+
+  # Disable RSpec exposing methods globally on `Module` and `main`
+  config.disable_monkey_patching!
+
+  config.expect_with :rspec do |c|
+    c.syntax = :expect
+  end
+
+  config.include JsonResponseMatchers
+end

data/spec/values_spec.rb

@@ -0,0 +1,94 @@
+RSpec.describe '#have_json_values' do
+  let(:items) do
+    {
+      items: [
+        { name: 'item 1', count: 2 },
+        { name: 'item 2', count: 11 },
+        { name: 'item 3', count: 0 }
+      ]
+    }
+  end
+  let(:json)     { items.to_json }
+  let(:response) { Struct.new(:body).new items.to_json }
+
+  it 'works with string keys.' do
+    expect(json).to have_json_values('item 1', 'item 2', 'item 3').for('name').at_key('items')
+  end
+
+  it 'works with symbol keys.' do
+    expect(json).to have_json_values('item 1', 'item 2', 'item 3').for(:name).at_key(:items)
+  end
+
+  it 'works with integer keys for array.' do
+    json_in_array = [ items ].to_json
+    expect(json_in_array).to have_json_values(2, 11, 0).for(:count).at_key 0, :items
+  end
+
+  it 'works for the response object.' do
+    expect(response).to have_json_values('item 1', 'item 2', 'item 3').for(:name).at_key(:items)
+  end
+
+  it 'works for the response body (json string).' do
+    expect(response.body).to have_json_values('item 1', 'item 2', 'item 3').for(:name).at_key(:items)
+  end
+
+  it 'works with no key passed.' do
+    expect(items[:items].to_json).to have_json_values('item 1', 'item 2', 'item 3').for(:name)
+  end
+
+  it 'works with multiple keys passed.' do
+    expect({ container: items }.to_json).to have_json_values('item 1', 'item 2', 'item 3').for(:name).at_key(:container, :items)
+  end
+
+  it 'fails if no :for passed' do
+    expect {
+      expect(json).to have_json_values('item 1', 'item 2', 'item 3').at_key(:items)
+    }.to raise_exception ArgumentError, /set one or more attributes/
+  end
+
+  it 'works with multiple :fors passed' do
+    expect(json).to have_json_values([ 'item 1', 2 ], [ 'item 2', 11 ], [ 'item 3', 0 ]).for(:name, :count).at_key(:items)
+  end
+
+  it 'works with falsy values too.' do
+    json = { items: [ { value: nil }, { value: false }, { value: true } ] }.to_json
+    expect(json).to have_json_values(nil, false, true).for(:value).at_key :items
+  end
+
+  it 'does not check array order by default.' do
+    expect(json).to have_json_values('item 2', 'item 1', 'item 3').for(:name).at_key(:items)
+  end
+
+  it 'checks array order if #in_strict_order is set.' do
+    expect {
+      expect(json).to have_json_values('item 2', 'item 1', 'item 3').in_strict_order.for(:name).at_key(:items)
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError
+    expect(json).to have_json_values('item 1', 'item 2', 'item 3').for(:name).at_key(:items).in_strict_order
+  end
+
+  it 'fails if additional elements are passed as expected.' do
+    expect {
+      expect(json).to have_json_values('item 1', 'item 2', 'item 3', 'item 4').for(:name).at_key(:items)
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError
+    expect {
+      expect(json).to have_json_values('item 1', 'item 2', 'item 3', 'item 4').for(:name).at_key(:items).in_strict_order
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError
+  end
+
+  it 'fails with error message giving information about order check, actual, expected (and diff).' do
+    expect {
+      expect(json).to have_json_values('item 1').for(:name).at_key(:items)
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError, /expected\n    \["item 1", "item 2", "item 3"\]\nto match\n    \["item 1"\]/
+    expect {
+      expect(json).to have_json_values('item 1').for(:name).at_key(:items).in_strict_order
+    }.to raise_exception RSpec::Expectations::ExpectationNotMetError, /expected\n    \["item 1", "item 2", "item 3"\]\nto equal\n    \["item 1"\]/
+  end
+
+  it 'works as compound matcher.' do
+    expect(json).to have_json_values('item 1', 'item 2', 'item 3').for(:name).at_key(:items).and include('"items":')
+    expect(json).to have_json_values('item 4', 'item 5', 'item 6').for(:name).at_key(:items).or  include('"items":')
+    expect('{"items":[{"id":1},{"id":2}],"page":2}')
+      .to have_json_values(1, 2).for(:id).at_key(:items)
+      .and have_json_content(2).at_key(:page)
+  end
+end

metadata

@@ -0,0 +1,163 @@
+--- !ruby/object:Gem::Specification
+name: json_response_matchers
+version: !ruby/object:Gem::Version
+  version: 1.1.0
+platform: ruby
+authors:
+- Szijjártó Nagy Misu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2019-01-31 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.0.6
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.16'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: appraisal
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+description: 'Provides two matchers (#have_json_content and #have_json_values) to
+  make testing the content of json responses easy.'
+email:
+- szijjartonagy.misu@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rspec"
+- Appraisals
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/test
+- gemfiles/activesupport_4.gemfile
+- gemfiles/activesupport_4.gemfile.lock
+- gemfiles/activesupport_5.2.2.gemfile
+- gemfiles/activesupport_5.2.2.gemfile.lock
+- gemfiles/activesupport_5.gemfile
+- gemfiles/activesupport_5.gemfile.lock
+- gemfiles/rspec_3.8.gemfile
+- gemfiles/rspec_3.8.gemfile.lock
+- gemfiles/rspec_3.gemfile
+- gemfiles/rspec_3.gemfile.lock
+- json_response_matchers.gemspec
+- lib/json_response_matchers.rb
+- lib/json_response_matchers/base.rb
+- lib/json_response_matchers/content.rb
+- lib/json_response_matchers/values.rb
+- lib/json_response_matchers/version.rb
+- spec/content_spec.rb
+- spec/json_response_matchers_spec.rb
+- spec/spec_helper.rb
+- spec/values_spec.rb
+homepage: https://github.com/SzNagyMisu/json_response_matchers
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/SzNagyMisu/json_response_matchers
+  source_code_uri: https://github.com/SzNagyMisu/json_response_matchers
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.7.6
+signing_key: 
+specification_version: 4
+summary: rspec matchers to test http responses with json content in rails
+test_files:
+- gemfiles/activesupport_4.gemfile
+- gemfiles/activesupport_4.gemfile.lock
+- gemfiles/activesupport_5.2.2.gemfile
+- gemfiles/activesupport_5.2.2.gemfile.lock
+- gemfiles/activesupport_5.gemfile
+- gemfiles/activesupport_5.gemfile.lock
+- gemfiles/rspec_3.8.gemfile
+- gemfiles/rspec_3.8.gemfile.lock
+- gemfiles/rspec_3.gemfile
+- gemfiles/rspec_3.gemfile.lock
+- spec/content_spec.rb
+- spec/json_response_matchers_spec.rb
+- spec/spec_helper.rb
+- spec/values_spec.rb
+- Appraisals
+- Gemfile
+- Rakefile
+- ".rspec"
+- bin/test