jsonapi_rspec 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8409f6d1d66e1c807057ae55f76b8fcbd2d22383
-  data.tar.gz: 94cf34c0cb18fdbd4b8c7ec1a3d90beb751da926
+  metadata.gz: 51b4c3c8b180371728a5009b411cda7f77e2abe6
+  data.tar.gz: 258bf4d2d722df6b7c821d4d9aafd0d60f7261f2
 SHA512:
-  metadata.gz: 717a0dea8650593f11055f37b483bb53f4d57c516024cddce6ff344517d145b9aa78437479db856d46772a55c3cb6b30c5b88eba7b7dee6c43b0fbad485959a9
-  data.tar.gz: fef72061c50a0bb8f9f622e871015627f625125265621e14bb037d41070774c41ab49050e57ab06c85b4f8afb0ff1fc2596dc37d6838d0979a88b2f9bc5b94fb
+  metadata.gz: 9ad0236147e56ee872977834fc829c04bbe5e20442d06c1da8abb2164e1a2a0a9467f4d425bd7cfd3827949156d247cdd334eafef56389c7bede2543a88c9cc2
+  data.tar.gz: 0db6c4e02dc98702339c10cf7a28f6b247057c63332922d15b553770f98034527903cf08434ae3650c2d660646073dedba3894d21cd5a394af12588ca2742805

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    jsonapi_rspec (0.1.0)
+    jsonapi_rspec (0.2.0)
       activesupport (>= 4.2.8)
 
 GEM

data/README.md

@@ -1,12 +1,13 @@
 # JsonapiRspec
 
+[![Gem Version](https://badge.fury.io/rb/jsonapi_rspec.svg)](https://badge.fury.io/rb/jsonapi_rspec)
 [![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.
+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 put 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.
+As such, it may not strictly suit your needs, but if you let me know I'll do my best to accommodate, and [pull requests](https://github.com/midwire/jsonapi_rspec/pulls) are always welcome.
 
 ## Installation
 
@@ -33,7 +34,7 @@ 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
@@ -75,19 +76,19 @@ It currently tests for required json:api sections and matching attributes for th
 
 ### 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"
+* "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}'"
 * "Expected data:type '#{data_type}' to match: '#{object_type}'"
+* "Fix 'match_attribute?' method to handle: '#{obj_val_class_name}'" - [please file an issue](https://github.com/midwire/jsonapi_rspec/issues/new) if you get this one.
+* "The 'data' section is missing or invalid"
 * "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}'"
+* "The 'meta:version' is missing"
+* "Unexpected key in response: '#{key}'"
+* 'Expected response to match an object instance but it is an empty string'
+* 'Response is an error'
 
-See the specs for details.
+[See the specs](https://github.com/midwire/jsonapi_rspec/blob/develop/spec/lib/jsonapi_rspec/be_json_api_response_for_spec.rb) for more details.
 
 ### Configuration
 

data/lib/jsonapi_rspec/be_json_api_response_for.rb

@@ -14,8 +14,9 @@ require 'active_support/all'
 # @author Chris Blackburn <87a1779b@opayq.com>
 #
 class BeJsonApiResponseFor
-  def initialize(object_instance)
+  def initialize(object_instance, plural_form = nil)
     @object_instance = object_instance
+    @plural_form = plural_form
   end
 
   def matches?(response)
@@ -91,7 +92,8 @@ class BeJsonApiResponseFor
   end
 
   def valid_type?(data_type)
-    object_type = @object_instance.class.name.underscore.dasherize.pluralize
+    object_type = @plural_form ||
+                  @object_instance.class.name.pluralize.underscore.dasherize
     unless data_type == object_type
       return set_failure_message("Expected data:type '#{data_type}' to match: '#{object_type}'")
     end
@@ -173,9 +175,9 @@ end
 # Usage:
 #   expect(response).to be_jsonapi_response_for(object_instance)
 #
-RSpec::Matchers.define :be_jsonapi_response_for do |object|
+RSpec::Matchers.define :be_jsonapi_response_for do |object, plural_form|
   match do |actual_response|
-    @instance = BeJsonApiResponseFor.new(object)
+    @instance = BeJsonApiResponseFor.new(object, plural_form)
 
     def failure_message
       @instance.failure_message

data/lib/jsonapi_rspec/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jsonapi_rspec
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Chris Blackburn
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2017-10-17 00:00:00.000000000 Z
+date: 2017-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler