Merge pull request #61 from wadetandy/master

Provide helpful feedback for invalid includes

Author: richmolj

lib/generators/jsonapi/templates/destroy_request_spec.rb.erb

@@ -2,7 +2,7 @@ require 'rails_helper'
 
 RSpec.describe "<%= type %>#destroy", type: :request do
   context 'basic destroy' do
-    let!(:<%= file_name %>) { FactoryGirl.create(:<%= file_name %>) }
+    let!(:<%= file_name %>) { create(:<%= file_name %>) }
 
     it 'updates the resource' do
       expect {

lib/jsonapi_compliable/errors.rb

@@ -13,6 +13,17 @@ def message
       end
     end
 
+    class InvalidInclude < StandardError
+      def initialize(relationship, parent_resource)
+        @relationship = relationship
+        @parent_resource = parent_resource
+      end
+
+      def message
+        "The requested included relationship \"#{@relationship}\" is not supported on resource \"#{@parent_resource}\""
+      end
+    end
+
     class StatNotFound < StandardError
       def initialize(attribute, calculation)
         @attribute = attribute

lib/jsonapi_compliable/scope.rb

@@ -81,6 +81,11 @@ def sideload(results, includes)
 
       includes.each_pair do |name, nested|
         sideload = @resource.sideload(name)
+
+        unless sideload
+          raise JsonapiCompliable::Errors::InvalidInclude.new(name, @resource.type)
+        end
+
         namespace = Util::Sideload.namespace(@namespace, sideload.name)
         sideload.resolve(results, @query, namespace)
       end

spec/scope_spec.rb

@@ -33,9 +33,8 @@
         allow(resource).to receive(:resolve).with(objekt) { results }
       end
 
-      context 'when the requested sideload is allowed' do
+      context 'when the requested sideload exists on the resource' do
         before do
-          allow(resource).to receive(:allowed_sideloads) { { books: {} } }
           allow(resource).to receive(:sideload).with(:books) { sideload }
         end
 
@@ -58,6 +57,18 @@
           end
         end
       end
+
+      context 'when the requested sideload does not exist' do
+        before do
+          allow(resource).to receive(:sideload).with(:books) { nil }
+        end
+
+        it 'raises a helpful error' do
+          expect do
+            instance.resolve
+          end.to raise_error(JsonapiCompliable::Errors::InvalidInclude, 'The requested included relationship "books" is not supported on resource "authors"')
+        end
+      end
     end
 
     context 'when 0 results requested' do