Add swagger compatibility

Author: Lee Richmond

lib/jsonapi_compliable/base.rb

@@ -28,8 +28,10 @@ def resource!
 
     # TODO pass controller and action name here to guard
     def wrap_context
-      resource.with_context(self, action_name.to_sym) do
-        yield
+      if self.class._jsonapi_compliable
+        resource.with_context(self, action_name.to_sym) do
+          yield
+        end
       end
     end
 

lib/jsonapi_compliable/resource.rb

@@ -156,12 +156,13 @@ def association_names
       end
     end
 
-    def allowed_sideloads
+    def allowed_sideloads(namespace = nil)
       return {} unless sideloading
 
+      namespace ||= context[:namespace]
       sideloads = sideloading.to_hash[:base]
-      if !sideload_whitelist.empty? && context[:namespace]
-        sideloads = Util::IncludeParams.scrub(sideloads, sideload_whitelist[context[:namespace]])
+      if !sideload_whitelist.empty? && namespace
+        sideloads = Util::IncludeParams.scrub(sideloads, sideload_whitelist[namespace])
       end
       sideloads
     end

spec/jsonapi_compliable_spec.rb

@@ -65,6 +65,38 @@ def config(obj)
     end
   end
 
+  describe '#wrap_context' do
+    before do
+      allow(controller).to receive(:action_name) { 'index' }
+    end
+
+    it 'wraps in the resource context' do
+      controller.wrap_context do
+        expect(controller.resource.context).to eq({
+          object: controller,
+          namespace: :index
+        })
+      end
+    end
+
+    context 'when the class does not have a resource' do
+      let(:klass) do
+        Class.new(ApplicationController) do
+          include JsonapiCompliable::Base
+          self._jsonapi_compliable = nil
+        end
+      end
+
+      let(:instance) { klass.new }
+
+      it 'does nothing' do
+        instance.wrap_context do
+          expect(instance.resource).to be_nil
+        end
+      end
+    end
+  end
+
   describe '#render_jsonapi' do
     it 'is able to override options' do
       author = Author.create!(first_name: 'Stephen', last_name: 'King')

spec/resource_spec.rb

@@ -162,7 +162,6 @@
       it { is_expected.to eq({}) }
     end
 
-    # TODO only/as
     context 'when sideloads' do
       before do
         klass.allow_sideload :foo do
@@ -177,7 +176,21 @@
         instance.set_config(klass.config)
       end
 
-      context 'and a namespace is set' do
+      context 'and a namespace is passed as an argument' do
+        around do |e|
+          instance.with_context({}, :show) do
+            e.run
+          end
+        end
+
+        it 'uses that namespace' do
+          expect(instance.allowed_sideloads(:index)).to eq({
+            foo: { bar: {} }
+          })
+        end
+      end
+
+      context 'and a context namespace is set' do
         around do |e|
           instance.with_context({}, :show) do
             e.run