rspec-json_api 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: ab0bec99f7a2855d51112412fb0aced653ad442808ce16921c651bab808457ac
+  data.tar.gz: 2d8707cc7ea15377f0239dc235c86fc6ca7566667751823e430e3cc88d05ea1a
+SHA512:
+  metadata.gz: f40f7bca528dfb1aac30052c0b83d9e515b3b88115a7ed7c60d7b6c77e56db0dd3077e8f6c0dac43187d97d67ef392f26bd2eff4e5cb1ca3f29cd34c2bd8bfe2
+  data.tar.gz: e6c9ea96e7ad17af2c1ebaa0d6f73e335f929d4ec50f3355e051b4b3f419bb73441169b406d47f5b058594317ca099d711b9a718e0e5e266b357f5a9c8c4070b

data/.github/workflows/main.yml

@@ -0,0 +1,20 @@
+name: Ruby
+
+on: [push,pull_request]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v2
+    - name: Set up Ruby
+      uses: ruby/setup-ruby@v1
+      with:
+        ruby-version: 3.0.1
+    - name: Bundle gems
+      run: |
+        gem install bundler -v 2.2.15
+        bundle install
+    - name: Run rspec
+      run: |
+        bundle exec rspec

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

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

data/.rubocop.yml

@@ -0,0 +1,13 @@
+AllCops:
+  TargetRubyVersion: 3.0.1
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+## [Unreleased]
+
+## [0.1.0] - 2021-08-24
+
+- Initial release

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,84 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming, diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes, and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or
+  advances of any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email
+  address, without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of acceptable behavior and will take appropriate and fair corrective action in response to any behavior that they deem inappropriate, threatening, offensive, or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct, and will communicate reasons for moderation decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when an individual is officially representing the community in public spaces. Examples of representing our community include using an official e-mail address, posting via an official social media account, or acting as an appointed representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported to the community leaders responsible for enforcement at m.gajowiak@nomtek.com. All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing clarity around the nature of the violation and an explanation of why the behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of actions.
+
+**Consequence**: A warning with consequences for continued behavior. No interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, for a specified period of time. This includes avoiding interactions in community spaces as well as external channels like social media. Violating these terms may lead to a temporary or permanent ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public communication with the community for a specified period of time. No public or private interaction with the people involved, including unsolicited interaction with those enforcing the Code of Conduct, is allowed during this period. Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community standards, including sustained inappropriate behavior,  harassment of an individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 2.0,
+available at https://www.contributor-covenant.org/version/2/0/code_of_conduct.html.
+
+Community Impact Guidelines were inspired by [Mozilla's code of conduct enforcement ladder](https://github.com/mozilla/diversity).
+
+[homepage]: https://www.contributor-covenant.org
+
+For answers to common questions about this code of conduct, see the FAQ at
+https://www.contributor-covenant.org/faq. Translations are available at https://www.contributor-covenant.org/translations.

data/Gemfile

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+git_source(:github) { |repo| "https://github.com/#{repo}.git" }
+
+# Specify your gem's dependencies in rspec-json_api.gemspec
+gemspec
+
+gem "activesupport", "~> 6.1", ">= 6.1.4.1"
+gem "rake", "~> 13.0", ">= 13.0.6"
+gem "rspec-rails", "~> 5.0", ">= 5.0.2"
+
+

data/Gemfile.lock

@@ -0,0 +1,165 @@
+PATH
+  remote: .
+  specs:
+    rspec-json_api (1.0.0)
+      activesupport (~> 6.1, >= 6.1.4.1)
+      rails (~> 6.1, >= 6.1.4.1)
+      rspec-rails (~> 5.0, >= 5.0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    actioncable (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nio4r (~> 2.0)
+      websocket-driver (>= 0.6.1)
+    actionmailbox (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (>= 2.7.1)
+    actionmailer (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      mail (~> 2.5, >= 2.5.4)
+      rails-dom-testing (~> 2.0)
+    actionpack (6.1.4.1)
+      actionview (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      rack (~> 2.0, >= 2.0.9)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actiontext (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      nokogiri (>= 1.8.5)
+    actionview (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activejob (6.1.4.1)
+      activesupport (= 6.1.4.1)
+      globalid (>= 0.3.6)
+    activemodel (6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activerecord (6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+    activestorage (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      marcel (~> 1.0.0)
+      mini_mime (>= 1.1.0)
+    activesupport (6.1.4.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 1.6, < 2)
+      minitest (>= 5.1)
+      tzinfo (~> 2.0)
+      zeitwerk (~> 2.3)
+    builder (3.2.4)
+    concurrent-ruby (1.1.9)
+    crass (1.0.6)
+    diff-lcs (1.4.4)
+    erubi (1.10.0)
+    globalid (0.5.2)
+      activesupport (>= 5.0)
+    i18n (1.8.10)
+      concurrent-ruby (~> 1.0)
+    loofah (2.12.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    mail (2.7.1)
+      mini_mime (>= 0.1.1)
+    marcel (1.0.2)
+    method_source (1.0.0)
+    mini_mime (1.1.2)
+    minitest (5.14.4)
+    nio4r (2.5.8)
+    nokogiri (1.12.4-x86_64-darwin)
+      racc (~> 1.4)
+    racc (1.5.2)
+    rack (2.2.3)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails (6.1.4.1)
+      actioncable (= 6.1.4.1)
+      actionmailbox (= 6.1.4.1)
+      actionmailer (= 6.1.4.1)
+      actionpack (= 6.1.4.1)
+      actiontext (= 6.1.4.1)
+      actionview (= 6.1.4.1)
+      activejob (= 6.1.4.1)
+      activemodel (= 6.1.4.1)
+      activerecord (= 6.1.4.1)
+      activestorage (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      bundler (>= 1.15.0)
+      railties (= 6.1.4.1)
+      sprockets-rails (>= 2.0.0)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.4.2)
+      loofah (~> 2.3)
+    railties (6.1.4.1)
+      actionpack (= 6.1.4.1)
+      activesupport (= 6.1.4.1)
+      method_source
+      rake (>= 0.13)
+      thor (~> 1.0)
+    rake (13.0.6)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.10.0)
+    rspec-rails (5.0.2)
+      actionpack (>= 5.2)
+      activesupport (>= 5.2)
+      railties (>= 5.2)
+      rspec-core (~> 3.10)
+      rspec-expectations (~> 3.10)
+      rspec-mocks (~> 3.10)
+      rspec-support (~> 3.10)
+    rspec-support (3.10.2)
+    sprockets (4.0.2)
+      concurrent-ruby (~> 1.0)
+      rack (> 1, < 3)
+    sprockets-rails (3.2.2)
+      actionpack (>= 4.0)
+      activesupport (>= 4.0)
+      sprockets (>= 3.0.0)
+    thor (1.1.0)
+    tzinfo (2.0.4)
+      concurrent-ruby (~> 1.0)
+    websocket-driver (0.7.5)
+      websocket-extensions (>= 0.1.0)
+    websocket-extensions (0.1.5)
+    zeitwerk (2.4.2)
+
+PLATFORMS
+  x86_64-darwin-20
+
+DEPENDENCIES
+  activesupport (~> 6.1, >= 6.1.4.1)
+  rake (~> 13.0, >= 13.0.6)
+  rspec-json_api!
+  rspec-rails (~> 5.0, >= 5.0.2)
+
+BUNDLED WITH
+   2.2.19

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Michal Gajowiak
+
+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,305 @@
+# RSpec::JsonApi
+
+[RSpec:JsonAPI](https://github.com/nomtek/rspec-json_api) 
+is an extension for [RSpec](https://github.com/rspec) 
+to easily allow testing JSON API responses.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'rspec-json_api'
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install rspec-json_api
+
+Generate directory tree:
+
+    rails generate rspec:json_api:install
+
+Require gem assets in your `spec_helper.rb`
+```ruby
+Dir[File.join(__dir__, 'rspec', 'json_api', '**', '*.rb')].each { |file| require file }
+```
+
+## Generators
+
+Using build-in generators it's possible to create custom interface and type.
+
+Generate new template:
+
+    rails generate rspec:json_api:interface interface-name
+
+Generate new type:
+
+    rails generate rspec:json_api:types type-name
+
+
+## Example usage
+
+```ruby
+# spec/controllers/users_controller_spec.rb
+
+RSpec.describe UsersController, type: :controller do
+  describe '#index' do
+    let(:expected_schema) do
+      Array[{
+        id: RSpec::JsonApi::Types::UUID,
+        name: String,
+        age: Integer,
+        favouriteColorHex: /^\#([a-fA-F]|[0-9]){3,6}$/,
+        number: -> { { type: Integer, min: 10, max: 20, lambda: ->(actual) { actual.even? } } }
+      }]
+    end
+
+    it 'matches API response' do
+      get :index
+
+      expect(response.body).to match_json_schema(expected_schema)
+    end
+  end
+end
+```
+
+## Built-in matchers
+- ### match_json_schema
+```
+  expect(response.body).to match_json_schema(expected_schema)
+```
+
+## Interfaces
+The gem introduces interfaces to reuse them during test matches.
+
+```ruby
+# spec/rspec/json_api/interfaces/example_interface.rb
+
+module RSpec
+  module JsonApi
+    module Interfaces
+      EXAMPLE_INTERFACE = {
+        id: Types::UUID,
+        name: String,
+        number: Integer,
+        color: -> { { inclusion: %w[black red white], allow_blank: true } }
+      }.freeze
+    end
+  end
+end
+```
+_Note: You can either generate file on your own or use generator._
+## Types
+
+The gem allow users either to user build-in types or define owns. 
+### Build-in types
+- #### EMAIL
+```ruby
+RSpec::JsonApi::Types::EMAIL
+```
+- #### URI
+```ruby
+RSpec::JsonApi::Types::URI
+```
+- #### UUID
+```ruby
+RSpec::JsonApi::Types::UUID
+```
+
+
+Custom type example:
+```ruby
+# spec/rspec/json_api/types/color_hex.rb
+
+module RSpec
+  module JsonApi
+    module Types
+      COLOR_HEX = /^#(?:[0-9a-fA-F]{3}){1,2}$/
+    end
+  end
+end
+
+RSpec::JsonApi::Types::COLOR_HEX
+```
+
+_Note: You can either generate file on your own or use generator._
+## Matching methods
+The gem offers variety of possible matching methods.
+
+### Presumptions
+- `match_json_schema` always require full keys match.
+
+  Failure Example:
+    ```ruby
+    let(:expected) do
+      {
+        id: RSpec::JsonApi::Types::UUID,
+        name: String,
+        age: Integer
+      }
+    end
+  
+    let(:actual) do
+      {
+        id: "0a2f911f-3767-4cc7-9c19-049f4350e38c",
+        name: "Mikel",
+      }
+    end
+    ```
+  
+  Success Example:
+  ```ruby
+  let(:expected) do
+    {
+      id: RSpec::JsonApi::Types::UUID,
+      name: String,
+      age: Integer
+    }
+  end
+
+  let(:actual) do
+    {
+      id: "0a2f911f-3767-4cc7-9c19-049f4350e38c",
+      name: "John",
+      age: 24
+    }
+  end
+  ```
+
+### Value match
+```ruby
+let(:expected_schema) do
+  {
+    id: "e0067346-4d24-4aa6-b303-f927a410a001",
+    name: "John",
+    age: 24,
+    favouriteColorHex: "#FF5733"
+  }
+end
+```
+
+### Class match
+```ruby
+let(:expected_schema) do
+  {
+    id: Integer,
+    name: String,
+    age: Integer,
+    notes: Array[String]
+  }
+end
+```
+
+### Type match
+```ruby
+let(:expected_schema) do
+  {
+    id: RSpec::JsonApi::Types::UUID,
+    email: RSpec::JsonApi::Types::EMAIL,
+  }
+end
+```
+
+### Regexp match
+```ruby
+let(:expected_schema) do
+  {
+    color: /^\#([a-fA-F]|[0-9]){3,6}$/
+  }
+end
+```
+
+### Interface match
+```ruby
+let(:expected_schema) do
+    Array[RSpec::JsonApi::Interfaces::PERSON]
+end
+```
+
+### Proc match
+Proc match allows to customize schema accoring needs using lambda shorthand notation `->`
+
+Supported options:
+- #### type
+```ruby
+let(:expected_schema) do
+  {
+    name: -> { { type: String } }
+  }
+end
+```
+- #### value
+```ruby
+let(:expected_schema) do
+  {
+    name: -> { { value: "John" } }
+  }
+end
+```
+- #### min
+```ruby
+let(:expected_schema) do
+  {
+    age: -> { { min: 15 } }
+  }
+end
+```
+- #### max
+```ruby
+let(:expected_schema) do
+  {
+    age: -> { { max: 25 } }
+  }
+end
+```
+- #### inclusion
+```ruby
+let(:expected_schema) do
+  {
+    letter: -> { { inclusion: %w[A B C] } }
+  }
+end
+```
+- #### regex
+```ruby
+let(:expected_schema) do
+  {
+    hex: -> { { regex: /^\#([a-fA-F]|[0-9]){3,6}$/ } }
+  }
+end
+```
+- #### lambda
+```ruby
+let(:expected) do
+  {
+    number: -> { { lambda: ->(actual) { actual.even? } } }
+  }
+end
+```
+- #### allow_blank
+
+```ruby
+let(:expected_schema) do
+  {
+    name: -> { { type: String, allow_blank: true } }
+  }
+end
+```
+_Note: Default value is `false`_
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/nomtek/rspec-json_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/nomtek/rspec-json_api/blob/master/CODE_OF_CONDUCT.md).
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the RSpec::JsonApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/nomtek/rspec-json_api/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "rspec/json_api"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/extentions/hash.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+# Extention methods for hash class
+class Hash
+  def deep_keys
+    each_with_object([]) do |(k, v), keys|
+      keys << k
+      keys << v.deep_keys if v.respond_to?(:keys)
+    end
+  end
+
+  def deep_key_paths
+    stack = map { |k, v| [[k], v] }
+    key_map = []
+
+    until stack.empty?
+      key, value = stack.pop
+
+      key_map << key unless value.is_a? Hash
+
+      next unless value.is_a? Hash
+
+      value.map do |k, v|
+        stack.push [key.dup << k, v]
+      end
+    end
+
+    key_map.reverse
+  end
+
+  def sanitize!(keys)
+    keep_if do |k, _v|
+      keys.include?(k)
+    end
+  end
+end

data/lib/generators/rspec/json_api/install/install_generator.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Rspec
+  module JsonApi
+    module Generators
+      class InstallGenerator < Rails::Generators::Base
+        source_root File.expand_path("templates", __dir__)
+
+        def create_dir_scaffold
+          directory "rspec", "spec/rspec"
+        end
+      end
+    end
+  end
+end

data/lib/generators/rspec/json_api/interface/interface_generator.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Rspec
+  module JsonApi
+    module Generators
+      class InterfaceGenerator < Rails::Generators::NamedBase
+        source_root File.expand_path("templates", __dir__)
+
+        def copy_interface_file
+          create_file "spec/rspec/json_api/interfaces/#{file_name}.rb", <<~FILE
+            module RSpec
+              module JsonApi
+                module Interfaces
+                  #{file_name.upcase} = {
+                    # name: String
+                  }
+                end
+              end
+            end
+          FILE
+        end
+      end
+    end
+  end
+end

data/lib/generators/rspec/json_api/interface/templates/interface.erb

@@ -0,0 +1,9 @@
+<%= module RSpec %>
+  <%= module JsonApi %>
+    <%= module Interfaces %>
+      <%= const_set(file_name, {
+
+      }.freeze) %>
+    <%= end %>
+  <%= end %>
+<%= end %>

data/lib/generators/rspec/json_api/type/type_generator.rb

@@ -0,0 +1,23 @@
+# frozen_string_literal: true
+
+module Rspec
+  module JsonApi
+    module Generators
+      class TypeGenerator < Rails::Generators::NamedBase
+        source_root File.expand_path("templates", __dir__)
+
+        def copy_interface_file
+          create_file "spec/rspec/json_api/types/#{file_name}.rb", <<~FILE
+            module RSpec
+              module JsonApi
+                module Types
+                  #{file_name.upcase} = //
+                end
+              end
+            end
+          FILE
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_api/compare_array.rb

@@ -0,0 +1,33 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module CompareArray
+      extend self
+
+      def compare(actual, expected)
+        if interface?(expected)
+          actual.all? do |actual_elem|
+            # Compare actual and expected schema
+            return false unless actual_elem.deep_keys == expected[0].deep_keys
+
+            CompareHash.compare(actual_elem, expected[0])
+          end
+        else
+          actual.each_with_index.all? do |actual_elem, index|
+            # Compare actual and expected schema
+            return false unless actual[index].deep_keys == expected[index].deep_keys
+
+            CompareHash.compare(actual_elem, expected[index])
+          end
+        end
+      end
+
+      private
+
+      def interface?(expected_value)
+        expected_value.size == 1 && expected_value[0].is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/rspec/json_api/compare_hash.rb

@@ -0,0 +1,112 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module CompareHash
+      extend self
+
+      SUPPORTED_OPTIONS = %i[allow_blank type value min max inclusion regex lambda].freeze
+
+      def compare(actual, expected)
+        return false if actual.blank? && expected.present?
+
+        key_paths = actual.deep_key_paths
+
+        key_paths.all? do |key_path|
+          actual_value = actual.dig(*key_path)
+          expected_value = expected.dig(*key_path)
+
+          compare_hash_values(actual_value, expected_value)
+        end
+      end
+
+      private
+
+      def compare_hash_values(actual_value, expected_value)
+        case expected_value
+        when Class
+          compare_class(actual_value, expected_value)
+        when Regexp
+          compare_regexp(actual_value, expected_value)
+        when Proc
+          compare_proc(actual_value, expected_value)
+        when Array
+          compare_array(actual_value, expected_value)
+        else
+          compare_value(actual_value, expected_value)
+        end
+      end
+
+      def compare_class(actual_value, expected_value)
+        actual_value.instance_of?(expected_value)
+      end
+
+      def compare_regexp(actual_value, expected_value)
+        actual_value =~ expected_value
+      end
+
+      def compare_proc(actual_value, expected_value)
+        payload = expected_value.call
+        payload.sanitize!(SUPPORTED_OPTIONS)
+        payload = payload.sort_by { |k, _v| k == :allow_blank ? 0 : 1 }.to_h
+
+        payload.all? do |condition_key, condition_value|
+          case condition_key
+          when :allow_blank
+            return true if actual_value.blank? && condition_value
+
+            true
+          when :type
+            compare_class(actual_value, condition_value)
+          when :value
+            compare_value(actual_value, condition_value)
+          when :inclusion
+            condition_value.include?(actual_value)
+          when :min
+            return false if !condition_value.is_a?(Numeric) || !actual_value.is_a?(Numeric)
+
+            actual_value >= condition_value
+          when :max
+            return false if !condition_value.is_a?(Numeric) || !actual_value.is_a?(Numeric)
+
+            actual_value <= condition_value
+          when :regex
+            compare_regexp(actual_value, condition_value)
+          when :lambda
+            condition_value.call(actual_value)
+          end
+        end
+      end
+
+      def compare_array(actual_value, expected_value)
+        if simple_type?(expected_value)
+          type = expected_value[0]
+
+          actual_value.all? { |elem| compare_class(elem, type) }
+        elsif interface?(expected_value)
+          interface = expected_value[0]
+
+          actual_value.all? { |elem| compare(elem, interface) }
+        else
+          return false if actual_value.size != expected_value.size
+
+          actual_value.each_with_index.all? do |elem, index|
+            elem.is_a?(Hash) ? compare(elem, expected_value[index]) : compare_value(elem, expected_value[index])
+          end
+        end
+      end
+
+      def compare_value(actual_value, expected_value)
+        actual_value == expected_value
+      end
+
+      def simple_type?(expected_value)
+        expected_value.size == 1 && expected_value[0].instance_of?(Class)
+      end
+
+      def interface?(expected_value)
+        expected_value.size == 1 && expected_value[0].is_a?(Hash)
+      end
+    end
+  end
+end

data/lib/rspec/json_api/interfaces/example_interface.rb

@@ -0,0 +1,14 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module Interfaces
+      EXAMPLE_INTERFACE = {
+        id: Types::UUID,
+        name: String,
+        number: Integer,
+        color: -> { { inclusion: %w[black red white], allow_blank: true } }
+      }.freeze
+    end
+  end
+end

data/lib/rspec/json_api/matchers/match_json_schema.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module Matchers
+      class MatchJsonSchema
+        attr_reader :expected
+
+        def initialize(expected)
+          @expected = expected
+        end
+
+        def matches?(actual)
+          actual = JSON.parse(actual, symbolize_names: true)
+
+          # Compare types
+          return false unless actual.instance_of?(expected.class)
+
+          if expected.instance_of?(Array)
+            RSpec::JsonApi::CompareArray.compare(actual, expected)
+          else
+            # Compare actual and expected schema
+            return false unless actual.deep_keys == expected.deep_keys
+
+            RSpec::JsonApi::CompareHash.compare(actual, expected)
+          end
+        end
+
+        def failure_message
+          self
+        end
+
+        def failure_message_when_negated
+          self
+        end
+      end
+    end
+  end
+end

data/lib/rspec/json_api/matchers.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module Matchers
+    def match_json_schema(expected)
+      RSpec::JsonApi::Matchers::MatchJsonSchema.new(expected)
+    end
+  end
+end

data/lib/rspec/json_api/types/email.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module Types
+      EMAIL = URI::MailTo::EMAIL_REGEXP
+    end
+  end
+end

data/lib/rspec/json_api/types/uri.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module Types
+      URI = URI::DEFAULT_PARSER.make_regexp
+    end
+  end
+end

data/lib/rspec/json_api/types/uuid.rb

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    module Types
+      UUID = /^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$/
+    end
+  end
+end

data/lib/rspec/json_api/version.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module RSpec
+  module JsonApi
+    VERSION = "1.0.0"
+  end
+end

data/lib/rspec/json_api.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+# Load 3th party libraries
+require "json"
+require "active_support/core_ext/object/blank"
+
+# Load the json_api parts
+require "rspec/json_api/version"
+require "rspec/json_api/compare_hash"
+require "rspec/json_api/compare_array"
+
+# Load extentions
+require "extentions/hash"
+
+# Load matchers
+require "rspec/json_api/matchers"
+require "rspec/json_api/matchers/match_json_schema"
+
+# Load defined types
+require "rspec/json_api/types/email"
+require "rspec/json_api/types/uri"
+require "rspec/json_api/types/uuid"

data/rspec-json_api.gemspec

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require_relative "lib/rspec/json_api/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "rspec-json_api"
+  spec.version       = RSpec::JsonApi::VERSION
+  spec.authors       = ["Michal Gajowiak"]
+  spec.email         = ["m.gajowiak@nomtek.com"]
+
+  spec.summary       = "RSpec extension to test JSON API response."
+  spec.homepage      = "https://github.com/nomtek/rspec-json_api"
+  spec.license       = "MIT"
+  spec.required_ruby_version = Gem::Requirement.new(">= 3.0.0")
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/nomtek/rspec-json_api"
+  spec.metadata["changelog_uri"] = "https://github.com/nomtek/rspec-json_api/blob/master/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{\A(?:test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Uncomment to register a new dependency of your gem
+  spec.add_dependency "activesupport", "~> 6.1", ">= 6.1.4.1"
+  spec.add_dependency "rails", "~> 6.1", ">= 6.1.4.1"
+  spec.add_dependency "rspec-rails", "~> 5.0", ">= 5.0.2"
+
+  # For more information and examples about making a new gem, checkout our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

metadata

@@ -0,0 +1,137 @@
+--- !ruby/object:Gem::Specification
+name: rspec-json_api
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Michal Gajowiak
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2021-12-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '6.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 6.1.4.1
+- !ruby/object:Gem::Dependency
+  name: rspec-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 5.0.2
+description:
+email:
+- m.gajowiak@nomtek.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".github/workflows/main.yml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/extentions/hash.rb
+- lib/generators/rspec/json_api/install/install_generator.rb
+- lib/generators/rspec/json_api/install/templates/rspec/json_api/interfaces/.empty_directory
+- lib/generators/rspec/json_api/install/templates/rspec/json_api/types/.empty_directory
+- lib/generators/rspec/json_api/interface/interface_generator.rb
+- lib/generators/rspec/json_api/interface/templates/interface.erb
+- lib/generators/rspec/json_api/type/type_generator.rb
+- lib/rspec/json_api.rb
+- lib/rspec/json_api/compare_array.rb
+- lib/rspec/json_api/compare_hash.rb
+- lib/rspec/json_api/interfaces/example_interface.rb
+- lib/rspec/json_api/matchers.rb
+- lib/rspec/json_api/matchers/match_json_schema.rb
+- lib/rspec/json_api/types/email.rb
+- lib/rspec/json_api/types/uri.rb
+- lib/rspec/json_api/types/uuid.rb
+- lib/rspec/json_api/version.rb
+- rspec-json_api.gemspec
+homepage: https://github.com/nomtek/rspec-json_api
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/nomtek/rspec-json_api
+  source_code_uri: https://github.com/nomtek/rspec-json_api
+  changelog_uri: https://github.com/nomtek/rspec-json_api/blob/master/CHANGELOG.md
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.2.16
+signing_key:
+specification_version: 4
+summary: RSpec extension to test JSON API response.
+test_files: []