jsonapi_rspec 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 8409f6d1d66e1c807057ae55f76b8fcbd2d22383
+  data.tar.gz: 94cf34c0cb18fdbd4b8c7ec1a3d90beb751da926
+SHA512:
+  metadata.gz: 717a0dea8650593f11055f37b483bb53f4d57c516024cddce6ff344517d145b9aa78437479db856d46772a55c3cb6b30c5b88eba7b7dee6c43b0fbad485959a9
+  data.tar.gz: fef72061c50a0bb8f9f622e871015627f625125265621e14bb037d41070774c41ab49050e57ab06c85b4f8afb0ff1fc2596dc37d6838d0979a88b2f9bc5b94fb

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/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.1
+before_install: bundle update

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 jsonapi_rspec.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    jsonapi_rspec (0.1.0)
+      activesupport (>= 4.2.8)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (5.1.4)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (~> 0.7)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+    coderay (1.1.2)
+    concurrent-ruby (1.0.5)
+    diff-lcs (1.3)
+    docile (1.1.5)
+    i18n (0.8.6)
+    json (2.1.0)
+    method_source (0.8.2)
+    midwire_common (0.3.0)
+      thor (~> 0.19)
+    minitest (5.10.3)
+    pry (0.10.4)
+      coderay (~> 1.1.0)
+      method_source (~> 0.8.1)
+      slop (~> 3.4)
+    pry-nav (0.2.4)
+      pry (>= 0.9.10, < 0.11.0)
+    rack (2.0.3)
+    rake (10.5.0)
+    rspec (3.6.0)
+      rspec-core (~> 3.6.0)
+      rspec-expectations (~> 3.6.0)
+      rspec-mocks (~> 3.6.0)
+    rspec-core (3.6.0)
+      rspec-support (~> 3.6.0)
+    rspec-expectations (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-mocks (3.6.0)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.6.0)
+    rspec-support (3.6.0)
+    simplecov (0.15.1)
+      docile (~> 1.1.0)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    slop (3.6.0)
+    thor (0.20.0)
+    thread_safe (0.3.6)
+    tzinfo (1.2.3)
+      thread_safe (~> 0.1)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.15.4)
+  jsonapi_rspec!
+  midwire_common (~> 0.1)
+  pry-nav (~> 0.2.4)
+  rack
+  rake (~> 10.0)
+  rspec (~> 3.0)
+  simplecov
+
+BUNDLED WITH
+   1.16.0.pre.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2017 Chris Blackburn
+
+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,107 @@
+# JsonapiRspec
+
+[![Build Status](https://travis-ci.org/midwire/jsonapi_rspec.svg?branch=master)](https://travis-ci.org/midwire/jsonapi_rspec)
+
+Match json:api formatted Rack::Response (or Rails controller response) to an instantiated object or ActiveRecord/ActiveModel object.
+
+This project started because I wanted to be able to easily compare a json:api response to a model in my Rails API controllers, across several projects. Finding myself copying the code between projects, I decided to stick it all in a gem.
+
+As such, it may not strictly suit your needs, but if you let me know I'll do my best to accommodate.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+group :test do
+  gem 'jsonapi_rspec'
+end
+```
+
+And then execute:
+
+    $ bundle
+
+## Usage
+
+In your controller specs:
+
+```ruby
+my_model = MyModel.create(...)
+get :show, params: { id: my_model.id }
+expect(response).to be_jsonapi_response_for(my_model)
+```
+
+It currently tests for required json:api sections and matching attributes for the passed model instance.
+```json
+{
+  "jsonapi": "version 1.1",   // does not check
+  "data":{                    // checks if exists and is a hash
+    "id":"123",               // checks if this matches the object.id
+    "type":"tags",     // checks if exists and is the matching type for object
+    "attributes":{     // checks each attrib. against object attributes
+      "string_attribute":"Category",
+      "datetime_attribute":"2017-10-13T19:33:54+00:00",
+      "time_attribute":"2017-10-14 17:12:45 -0500",
+      "true_attribute":true,
+      "false_attribute":false,
+      "nil_attribute":null,
+      "fixnum_attribute":11,
+      "float_attribute":11.11,
+      "bignum_attribute":9999999999999999999999999999999,
+      "links":{                // does not check
+        "self":"http://test.host/api/v1/tag_types.123"
+      }
+    }
+  },
+  "included": [{               // does not check
+    "type": "users",
+    "id": 9,
+    "attributes": {
+      "first-name": "Dan",
+      "last-name": "Gebhardt",
+      "twitter": "dgeb"
+    },
+    "links": {
+      "self": "http://example.com/users/9"
+    }
+  }],
+  "meta":{  // does not check for existance by default
+    "copyright":"Copyright 2017 Chris Blackburn", // required if meta tag exists
+    "version":"v1"  // required if meta tag exists
+  }
+}
+```
+
+### Possible Failure Messages
+
+* 'Response is an error'
+* "Unexpected key in response: '#{key}'"
+* 'Expected response to match an object instance but it is an empty string'
+* "The 'data' section is missing or invalid"
+* "Expected data:type '#{data_type}' to match: '#{object_type}'"
+* "The 'meta' section is missing or invalid"
+* "The 'meta:version' is missing"
+* "The 'meta:copyright' is missing or invalid - regex: '/^Copyright.+\\d{4}/'"
+* "Fix 'match_attribute?' method to handle: '#{obj_val_class_name}'" - please file an issue if you get this one.
+* "Attribute: :#{attr_name} with a value of '#{json_val}'(#{json_val.class.name}) does not match object: '#{obj_val}'(#{obj_val.class.name})
+* "Expected '#{value}' to match object id: '#{object_id}'"
+
+See the specs for details.
+
+### Configuration
+
+This is the only configuration option at the moment:
+
+    JsonapiRspec.configure do |config|
+      config.meta_required = false # default
+    end
+
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/midwire/jsonapi_rspec.
+
+## 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,13 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task default: :spec
+
+begin
+  require 'midwire_common/rake_tasks'
+rescue StandardError => e
+  puts(">>> Can't load midwire_common/rake_tasks.")
+  puts(">>> Did you 'bundle exec'?: #{e.message}")
+  exit
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "jsonapi_rspec"
+
+# 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/jsonapi_rspec.gemspec

@@ -0,0 +1,33 @@
+
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'jsonapi_rspec/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'jsonapi_rspec'
+  spec.version       = JsonapiRspec::VERSION
+  spec.authors       = ['Chris Blackburn']
+  spec.email         = ['chris@midwiretech.com']
+
+  spec.summary       = 'Provides RSpec matchers for json:api related specs'
+  spec.description   = spec.summary
+  spec.homepage      = 'https://github.com/midwire/jsonapi_rspec'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.15.4'
+  spec.add_development_dependency 'rake', '~> 10.0'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'pry-nav', '~> 0.2.4'
+  spec.add_development_dependency 'rack'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'midwire_common', '~> 0.1'
+
+  spec.add_dependency 'activesupport', '>= 4.2.8'
+end

data/lib/jsonapi_rspec/be_json_api_response_for.rb

@@ -0,0 +1,190 @@
+require_relative 'string'
+require 'active_support/all'
+
+# Class BeJsonApiResponseFor provides custom RSpec matching for json:api
+# responses for a given object instance. It checks attributes and elements
+# iteratively and fails on the first mismatch that it finds.
+#
+# It expects a Rack::Response (or similar) object to be passed as the left-side
+# of the comparison and a regular Object-derived instance as the right-side.
+#
+# Usage:
+#   expect(response).to BeJsonApiResponseFor.new(object_instance)
+#
+# @author Chris Blackburn <87a1779b@opayq.com>
+#
+class BeJsonApiResponseFor
+  def initialize(object_instance)
+    @object_instance = object_instance
+  end
+
+  def matches?(response)
+    return false unless valid_response?(response)
+
+    @parsed_response = JSON.parse(response.body)
+
+    return false if response_is_error?
+    return false unless valid_data_section?
+    if JsonapiRspec.configuration.meta_required
+      return false unless valid_meta_section?
+    end
+
+    @parsed_response.each do |key, value|
+      case key.to_sym
+      when :data
+        return false unless match_object?(value)
+      when :meta
+        return false unless valid_meta_section?
+      when :jsonapi
+        next # this can legally be anything
+      when :included
+        next # TODO: handle included objects
+      else
+        return set_failure_message("Unexpected key in response: '#{key}'")
+      end
+    end
+
+    true
+  end
+
+  def failure_message
+    @failure_message ||= "Expected object [#{@object_instance}] to match"
+    "#{@failure_message} - parsed response: #{pretty_response}"
+  end
+
+  def failure_message_when_negated
+    @failure_message = "handle method 'failure_message_when_negated' in custom_matchers.rb"
+    "#{@failure_message}: #{pretty_response}"
+  end
+
+  private
+
+  def pretty_response
+    JSON.pretty_generate(@parsed_response)
+  rescue JSON::GeneratorError
+    @parsed_response.to_s
+  end
+
+  # Set the failure message
+  #
+  # @param [String] msg Failure message
+  #
+  # @return [Boolean] always returns false
+  #
+  def set_failure_message(msg)
+    @failure_message = msg
+    false
+  end
+
+  def valid_response?(response)
+    if response.body == ''
+      return set_failure_message('Expected response to match an object instance but it is an empty string')
+    end
+    true
+  end
+
+  def valid_data_section?
+    unless @parsed_response.dig('data').is_a?(Hash)
+      return set_failure_message("The 'data' section is missing or invalid")
+    end
+    true
+  end
+
+  def valid_type?(data_type)
+    object_type = @object_instance.class.name.underscore.dasherize.pluralize
+    unless data_type == object_type
+      return set_failure_message("Expected data:type '#{data_type}' to match: '#{object_type}'")
+    end
+    true
+  end
+
+  def valid_meta_section?
+    meta = @parsed_response.dig('meta')
+    return set_failure_message("The 'meta' section is missing or invalid") unless meta.is_a?(Hash)
+    return set_failure_message("The 'meta:version' is missing") if meta.dig('version').nil?
+    unless meta.dig('copyright') =~ /^Copyright.+\d{4}/
+      return set_failure_message("The 'meta:copyright' is missing or invalid - regex: '/^Copyright.+\\d{4}/'")
+    end
+    true
+  end
+
+  def response_is_error?
+    is_error = !@parsed_response.dig('errors').nil?
+    set_failure_message('Response is an error') if is_error
+    is_error
+  end
+
+  def match_attribute?(attr_name, json_val)
+    obj_val = @object_instance.send(attr_name.to_sym)
+    obj_val_class_name = obj_val.class.name
+
+    case obj_val_class_name
+    when 'Float'
+      matched = obj_val == json_val.to_f
+    when 'DateTime'
+      matched = obj_val.to_i == DateTime.parse(json_val).to_i
+    when 'Time'
+      matched = obj_val.to_i == Time.parse(json_val).to_i
+    when 'String', 'NilClass', 'TrueClass', 'FalseClass', 'Fixnum', 'Integer', 'Bignum'
+      matched = obj_val == json_val
+    else
+      return set_failure_message("Fix 'match_attribute?' method to handle: '#{obj_val_class_name}'")
+    end
+
+    unless matched
+      return set_failure_message(
+        <<-STRING.here_with_pipe!(' ')
+          |Attribute: :#{attr_name}
+          |with a value of '#{json_val}'(#{json_val.class.name})
+          |does not match object: '#{obj_val}'(#{obj_val.class.name})
+        STRING
+      )
+    end
+    true
+  end
+
+  def match_object?(values)
+    values.each do |key, value|
+      case key.to_sym
+      when :id
+        object_id = @object_instance.send(key)
+        unless object_id == value.to_i
+          return set_failure_message("Expected '#{value}' to match object id: '#{object_id}'")
+        end
+      when :type
+        return false unless valid_type?(value)
+      when :attributes
+        value.each do |attr, val|
+          attribute = attr.underscore
+          next if attr.to_sym == :links # skip link validation
+          # return false unless @object_instance.send(attribute) == val
+          return false unless match_attribute?(attribute, val)
+        end
+      when :relationships
+        next # skip relationships validation
+      else
+        fail "Invalid attribute: '#{key}'"
+      end
+    end
+    true
+  end
+end
+
+# Usage:
+#   expect(response).to be_jsonapi_response_for(object_instance)
+#
+RSpec::Matchers.define :be_jsonapi_response_for do |object|
+  match do |actual_response|
+    @instance = BeJsonApiResponseFor.new(object)
+
+    def failure_message
+      @instance.failure_message
+    end
+
+    def failure_message_when_negated
+      @instance.failure_message
+    end
+
+    @instance.matches?(actual_response)
+  end
+end

data/lib/jsonapi_rspec/configuration.rb

@@ -0,0 +1,9 @@
+module JsonapiRspec
+  class Configuration
+    attr_accessor :meta_required
+
+    def initialize
+      @meta_required = false
+    end
+  end
+end

data/lib/jsonapi_rspec/string.rb

@@ -0,0 +1,22 @@
+class String
+  # Helper for the heredoc functionality. Allows pipe '|' delimeted heredocs
+  # with a parameterized delimeter.
+  #
+  # Example:
+  # html = <<-stop.here_with_pipe(delimeter="\n")
+  #   |<!-- Begin: comment  -->
+  #   |<script type="text/javascript">
+  # stop
+  # html == '<!-- Begin: comment  -->\n<script type="text/javascript">'
+  #
+  # @param [String] delimeter Joins the lines of strings with this delimeter.
+  #
+  # @return [String] Returns the concatenated string.
+  #
+  def here_with_pipe!(delimeter = ' ')
+    lines = split("\n")
+    lines.map! { |c| c.sub!(/\s*\|/, '') }
+    new_string = lines.join(delimeter)
+    replace(new_string)
+  end
+end

data/lib/jsonapi_rspec/version.rb

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

data/lib/jsonapi_rspec.rb

@@ -0,0 +1,21 @@
+require 'jsonapi_rspec/version'
+require 'jsonapi_rspec/be_json_api_response_for'
+
+module JsonapiRspec
+  class << self
+    attr_accessor :configuration
+
+    def root
+      Pathname.new(File.dirname(__FILE__)).parent
+    end
+
+    def configure
+      self.configuration ||= Configuration.new
+      yield(configuration)
+    end
+  end
+
+  autoload :Configuration, 'jsonapi_rspec/configuration'
+end
+
+JsonapiRspec.configure {} # initialize the configuration

metadata

@@ -0,0 +1,172 @@
+--- !ruby/object:Gem::Specification
+name: jsonapi_rspec
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Chris Blackburn
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-10-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 1.15.4
+- !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: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.4
+- !ruby/object:Gem::Dependency
+  name: rack
+  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: simplecov
+  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: midwire_common
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 4.2.8
+description: Provides RSpec matchers for json:api related specs
+email:
+- chris@midwiretech.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- jsonapi_rspec.gemspec
+- lib/jsonapi_rspec.rb
+- lib/jsonapi_rspec/be_json_api_response_for.rb
+- lib/jsonapi_rspec/configuration.rb
+- lib/jsonapi_rspec/string.rb
+- lib/jsonapi_rspec/version.rb
+homepage: https://github.com/midwire/jsonapi_rspec
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Provides RSpec matchers for json:api related specs
+test_files: []