Merge pull request #72 from MPursche/add_render_related_json

New Feature: Added options to "jsonapi_render" to allow rendering of related resource pages

Author: tiagopog

Rakefile

@@ -2,7 +2,7 @@ require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
 
 RSpec::Core::RakeTask.new(:spec) do |test|
-  test.pattern = 'spec/controllers/{user,post}s_controller.rb'
+  test.pattern = 'spec/**/*_spec.rb'
 end
 
 task default: :spec

bin/rspec

@@ -0,0 +1,17 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+#
+# This file was generated by Bundler.
+#
+# The application 'rspec' is installed as part of a gem, and
+# this file is here to facilitate running it.
+#
+
+require "pathname"
+ENV["BUNDLE_GEMFILE"] ||= File.expand_path("../../Gemfile",
+  Pathname.new(__FILE__).realpath)
+
+require "rubygems"
+require "bundler/setup"
+
+load Gem.bin_path("rspec-core", "rspec")

jsonapi-utils.gemspec

@@ -30,4 +30,6 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'smart_rspec', '~> 0.1.6'
   spec.add_development_dependency 'pry', '~> 0.10.3'
   spec.add_development_dependency 'pry-byebug'
+  spec.add_development_dependency 'debase'
+  spec.add_development_dependency 'ruby-debug-ide'
 end

lib/jsonapi/utils/response/formatters.rb

@@ -15,6 +15,11 @@ module Formatters
         # @option options [JSONAPI::Resource] resource: it tells the formatter which resource
         #   class to be used rather than use an infered one (default behaviour)
         #
+        # @option options [JSONAPI::Resource] source_resource: it tells the formatter that this response is from a related resource
+        #   and the result should be interpreted as a related resources response
+        #
+        # @option options [String, Symbol] relationship_type: it tells that the formatter which relationship the data is from
+        #
         # @option options [ActiveRecord::Base] model: ActiveRecord model class to be instantiated
         #   when a Hash or Array of Hashes is passed as the "object" argument
         #
@@ -51,7 +56,7 @@ def jsonapi_format(object, options = {})
         # @api public
         def jsonapi_format_errors(object)
           if active_record_obj?(object)
-            object = JSONAPI::Utils::Exceptions::ActiveRecord.new(object, @request.resource_klass, context) 
+            object = JSONAPI::Utils::Exceptions::ActiveRecord.new(object, @request.resource_klass, context)
           end
           errors = object.respond_to?(:errors) ? object.errors : object
           JSONAPI::Utils::Support::Error.sanitize(errors).uniq
@@ -84,6 +89,11 @@ def active_record_obj?(object)
         # @option options [JSONAPI::Resource] resource: it tells the builder which resource
         #   class to be used rather than use an infered one (default behaviour)
         #
+        # @option options [ActiveRecord::Base, JSONAPI::Resource] source: it tells the builder that this response is from a related resource
+        #   and the result should be interpreted as a related resources response
+        #
+        # @option options [String, Symbol] relationship: it tells that the builder which relationship the data is from
+        #
         # @option options [Integer] count: if it's rendering a collection of resources, the default
         #   gem's counting method can be bypassed by the use of this options. It's shows then the total
         #   records resulting from that request and also calculates the pagination.
@@ -96,7 +106,19 @@ def build_response_document(object, options)
 
           if object.respond_to?(:to_ary)
             records = build_collection(object, options)
-            results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, records, result_options(object, options)))
+
+            if params[:source].present? && params[:relationship].present?
+              source_resource = turn_source_into_resource(options[:source], options)
+              relationship_type = get_source_relationship(options)
+
+              results.add_result(JSONAPI::RelatedResourcesOperationResult.new(:ok,
+                                                          source_resource,
+                                                          relationship_type,
+                                                          records,
+                                                          result_options(object, options)))
+            else
+              results.add_result(JSONAPI::ResourcesOperationResult.new(:ok, records, result_options(object, options)))
+            end
           else
             record = turn_into_resource(object, options)
             results.add_result(JSONAPI::ResourceOperationResult.new(:ok, record))
@@ -171,6 +193,34 @@ def turn_into_resource(record, options)
           end
         end
 
+        # Get JSONAPI::Resource for source object
+        # @option options [JSONAPI::Resource] resource: it tells which resource
+        #   class to be used rather than use an infered one (default behaviour)
+        # @return [JSONAPI::Resource]
+        #
+        # @api private
+        def turn_source_into_resource(source, options)
+          if source.kind_of? JSONAPI::Resource
+            source
+          else            
+            @request.source_klass.new(source, context)
+          end
+        end
+
+        # Get relationship type of source object
+        # @option options [Symbol] relationship: it tells which relationship
+        #   to be used rather than use an infered one (default behaviour)
+        # @return [Symbol]
+        #
+        # @api private
+        def get_source_relationship(options)
+          if options[:relationship].present?
+            options[:relationship].to_sym
+          else
+            params[:relationship].to_sym || @request.resource_klass._type
+          end
+        end
+
         # Apply some result options like pagination params and record count to collection responses.
         #
         # @param records [ActiveRecord::Relation, Hash, Array<Hash>]

lib/jsonapi/utils/response/renders.rb

@@ -14,6 +14,11 @@ module Renders
         #
         # @option options [JSONAPI::Resource] resource: it tells the render which resource
         #   class to be used rather than use an infered one (default behaviour)
+        # 
+        # @option options [JSONAPI::Resource] source_resource: it tells the render that this response is from a related resource
+        #   and the result should be interpreted as a related resources response
+        #
+        # @option options [String, Symbol] relationship_type: it tells that the render which relationship the data is from
         #
         # @option options [ActiveRecord::Base] model: ActiveRecord model class to be instantiated
         #   when a Hash or Array of Hashes is passed to the "json" key argument

spec/controllers/posts_controller_spec.rb

@@ -355,6 +355,80 @@
     end
   end
 
+  describe 'GET #related_resources' do
+    shared_context 'related_resources request' do |use_resource:, explicit_relationship:|
+      subject { get :get_related_resources, params: params }
+      let (:params) { {
+        source: "users",
+        user_id: parent_id,
+        relationship: "posts",
+        use_resource: use_resource,
+        explicit_relationship: explicit_relationship
+      } }
+    end
+
+    context 'using model as source' do
+      include_context 'related_resources request', use_resource: false, explicit_relationship: false
+
+      it 'loads all posts of a user' do
+        expect(subject).to have_http_status :ok
+        expect(subject).to have_primary_data('posts')
+        expect(subject).to have_data_attributes(fields)
+        expect(subject).to have_relationships(relationships)
+
+        # it should use nested url
+        expect(json.dig('links', 'first')).to include("/users/#{parent_id}/posts")
+        expect(json.dig('links', 'last')).to include("/users/#{parent_id}/posts")
+      end
+    end
+
+    context 'using model as source and relationship from options' do
+      include_context 'related_resources request', use_resource: false, explicit_relationship: true
+
+      it 'loads all posts of a user' do
+        expect(subject).to have_http_status :ok
+        expect(subject).to have_primary_data('posts')
+        expect(subject).to have_data_attributes(fields)
+        expect(subject).to have_relationships(relationships)
+
+        # it should use nested url
+        expect(json.dig('links', 'first')).to include("/users/#{parent_id}/posts")
+        expect(json.dig('links', 'last')).to include("/users/#{parent_id}/posts")
+      end
+    end
+
+
+    context 'using resource as source' do
+      include_context 'related_resources request', use_resource: true, explicit_relationship: false
+
+      it 'loads all posts of a user' do
+        expect(subject).to have_http_status :ok
+        expect(subject).to have_primary_data('posts')
+        expect(subject).to have_data_attributes(fields)
+        expect(subject).to have_relationships(relationships)
+
+        # it should use nested url
+        expect(json.dig('links', 'first')).to include("/users/#{parent_id}/posts")
+        expect(json.dig('links', 'last')).to include("/users/#{parent_id}/posts")
+      end
+    end
+
+    context 'using resource as source and relationship from options' do
+      include_context 'related_resources request', use_resource: true, explicit_relationship: true
+
+      it 'loads all posts of a user' do
+        expect(subject).to have_http_status :ok
+        expect(subject).to have_primary_data('posts')
+        expect(subject).to have_data_attributes(fields)
+        expect(subject).to have_relationships(relationships)
+
+        # it should use nested url
+        expect(json.dig('links', 'first')).to include("/users/#{parent_id}/posts")
+        expect(json.dig('links', 'last')).to include("/users/#{parent_id}/posts")
+      end
+    end
+  end
+
   describe 'PATCH #update' do
     shared_context 'update request' do |action:|
       subject { patch action, params: params.merge(body) }

spec/support/controllers.rb

@@ -7,7 +7,7 @@ class BaseController < ActionController::Base
 end
 
 class PostsController < BaseController
-  before_action :load_user, only: %i(index)
+  before_action :load_user, only: %i(index get_related_resources)
 
   # GET /users/:user_id/posts
   def index
@@ -49,6 +49,22 @@ def create
     end
   end
 
+  # GET /users/:user_id/posts
+  def get_related_resources
+    if params[:source] == "users" && params[:relationship] == "posts"
+      # Example for custom method to fetch related resources
+      @posts = @user.posts
+
+      jsonapi_render json: @posts, options: {
+        source: (params[:use_resource] == "true") ? UserResource.new(@user, context) : @user,
+        relationship: (params[:explicit_relationship] == "true") ? 'posts' : nil
+      }
+    else
+      # handle other requests with default method
+      process_request
+    end
+  end
+
   # PATCH /posts/:id
   def update_with_error_on_base
     post = Post.find(params[:id])

spec/test_app.rb

@@ -60,10 +60,11 @@ def TestApp.draw_app_routes
   TestApp.routes.draw do
     jsonapi_resources :users do
       jsonapi_links :profile
-      jsonapi_resources :posts, shallow: true
+      jsonapi_related_resources :posts
     end
 
     jsonapi_resource :profile
+    jsonapi_resources :posts
 
     patch :update_with_error_on_base, to: 'posts#update_with_error_on_base'