Fix for issue #8

lib/jsonapi_spec_helpers.rb

@@ -3,6 +3,7 @@
 require 'jsonapi_spec_helpers/helpers'
 require 'jsonapi_spec_helpers/payload'
 require 'jsonapi_spec_helpers/payload_sanitizer'
+require 'jsonapi_spec_helpers/errors'
 
 module JsonapiSpecHelpers
   def self.included(klass)
@@ -52,5 +53,13 @@ def assert_payload(name, record, json, &blk)
         expect(key).to be_not_in_payload
       end
     end
+
+    aggregate_failures "payload contains an id and type" do
+      unless record.id.nil?
+        expect(json['id']).to eq(record.id.to_s)
+      end
+
+      expect(json['jsonapi_type']).to_not be_nil
+    end
   end
 end

lib/jsonapi_spec_helpers/errors.rb

@@ -0,0 +1,16 @@
+module JsonapiSpecHelpers
+  module Errors
+    class Base < StandardError; end
+    class IncludedOutOfBounds < Base
+      def initialize(type, index, array)
+        @type = type; @index = index; @array = array
+      end
+
+      def message
+        "You attempted to get an item at index #{@index} of the type '#{@type}' " \
+        "from the included property of your JSON payload. But it contained "    \
+        "#{@array.length} '#{@type}'"
+      end
+    end
+  end
+end

spec/assert_payload_spec.rb

@@ -35,15 +35,15 @@
       end
     end
 
-    context 'when payload is valid' do
-      let(:post_record) do
-        double \
-          id: 1,
-          title: 'post title',
-          description: 'post description',
-          views: 100
-      end
+    let(:post_record) do
+      double \
+        id: 1,
+        title: 'post title',
+        description: 'post description',
+        views: 100
+    end
 
+    context 'when payload is valid' do
       it 'passes assertion' do
         assert_payload(:post, post_record, json_item)
       end
@@ -235,5 +235,43 @@
         end
       end
     end
+
+    context 'when payload contains a "relationship-only" item' do
+      before do
+        JsonapiSpecHelpers::Payload.register(:no_attribute_item) do
+        end
+      end
+
+      let(:no_attribute_record) do
+        double \
+          id: 1,
+          posts: post_record
+      end
+
+      let(:json) do
+        {
+          'data' => {
+            'type' => 'no_attributes_items',
+            'id' => '1',
+            'relationships' => {
+              'posts' => {
+                'data' => [
+                  {'type' => 'posts', 'id' => '1'}
+                ]
+              }
+            }
+          }
+        }
+      end
+
+      it 'still properly throws when no item is present' do
+        empty_json_item = {'id' => nil, 'jsonapi_type' => nil}
+        expect {
+          assert_payload(:no_attribute_item, no_attribute_record, empty_json_item)
+        }.to raise_error(
+          RSpec::Expectations::ExpectationNotMetError
+        )
+      end
+    end
   end
 end