active_model_serializers_custom 0.10.90

data/test/action_controller/json_api/deserialization_test.rb

@@ -0,0 +1,114 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class DeserializationTest < ActionController::TestCase
+        class DeserializationTestController < ActionController::Base
+          def render_parsed_payload
+            parsed_hash = ActiveModelSerializers::Deserialization.jsonapi_parse(params)
+            render json: parsed_hash
+          end
+
+          def render_polymorphic_parsed_payload
+            parsed_hash = ActiveModelSerializers::Deserialization.jsonapi_parse(
+              params,
+              polymorphic: [:restriction_for, :restricted_to]
+            )
+            render json: parsed_hash
+          end
+        end
+
+        tests DeserializationTestController
+
+        def test_deserialization_of_relationship_only_object
+          hash = {
+            'data' => {
+              'type' => 'restraints',
+              'relationships' => {
+                'restriction_for' => {
+                  'data' => {
+                    'type' => 'discounts',
+                    'id' => '67'
+                  }
+                },
+                'restricted_to' => {
+                  'data' => nil
+                }
+              }
+            },
+            'restraint' => {}
+          }
+
+          post :render_polymorphic_parsed_payload, params: hash
+
+          response = JSON.parse(@response.body)
+          expected = {
+            'restriction_for_id' => '67',
+            'restriction_for_type' => 'Discount',
+            'restricted_to_id' => nil,
+            'restricted_to_type' => nil
+          }
+
+          assert_equal(expected, response)
+        end
+
+        def test_deserialization
+          hash = {
+            'data' => {
+              'type' => 'photos',
+              'id' => 'zorglub',
+              'attributes' => {
+                'title' => 'Ember Hamster',
+                'src' => 'http://example.com/images/productivity.png',
+                'image-width' => '200',
+                'imageHeight' => '200',
+                'ImageSize' => '1024'
+              },
+              'relationships' => {
+                'author' => {
+                  'data' => nil
+                },
+                'photographer' => {
+                  'data' => { 'type' => 'people', 'id' => '9' }
+                },
+                'comments' => {
+                  'data' => [
+                    { 'type' => 'comments', 'id' => '1' },
+                    { 'type' => 'comments', 'id' => '2' }
+                  ]
+                },
+                'related-images' => {
+                  'data' => [
+                    { 'type' => 'image', 'id' => '7' },
+                    { 'type' => 'image', 'id' => '8' }
+                  ]
+                }
+              }
+            }
+          }
+
+          post :render_parsed_payload, params: hash
+
+          response = JSON.parse(@response.body)
+          expected = {
+            'id' => 'zorglub',
+            'title' => 'Ember Hamster',
+            'src' => 'http://example.com/images/productivity.png',
+            'image_width' => '200',
+            'image_height' => '200',
+            'image_size' => '1024',
+            'author_id' => nil,
+            'photographer_id' => '9',
+            'comment_ids' => %w(1 2),
+            'related_image_ids' => %w(7 8)
+          }
+
+          assert_equal(expected, response)
+        end
+      end
+    end
+  end
+end

data/test/action_controller/json_api/errors_test.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class ErrorsTest < ActionController::TestCase
+        def test_active_model_with_multiple_errors
+          get :render_resource_with_errors
+
+          expected_errors_object = {
+            errors:               [
+              { source: { pointer: '/data/attributes/name' }, detail: 'cannot be nil' },
+              { source: { pointer: '/data/attributes/name' }, detail: 'must be longer' },
+              { source: { pointer: '/data/attributes/id' }, detail: 'must be a uuid' }
+            ]
+          }.to_json
+          assert_equal json_response_body.to_json, expected_errors_object
+        end
+
+        def json_response_body
+          JSON.load(@response.body)
+        end
+
+        class ErrorsTestController < ActionController::Base
+          def render_resource_with_errors
+            resource = Profile.new(name: 'Name 1',
+                                   description: 'Description 1',
+                                   comments: 'Comments 1')
+            resource.errors.add(:name, 'cannot be nil')
+            resource.errors.add(:name, 'must be longer')
+            resource.errors.add(:id, 'must be a uuid')
+            render json: resource, adapter: :json_api, serializer: ActiveModel::Serializer::ErrorSerializer
+          end
+        end
+
+        tests ErrorsTestController
+      end
+    end
+  end
+end

data/test/action_controller/json_api/fields_test.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class FieldsTest < ActionController::TestCase
+        class FieldsTestController < ActionController::Base
+          class AuthorWithName < Author
+            attributes :first_name, :last_name
+          end
+          class AuthorWithNameSerializer < AuthorSerializer
+            type 'authors'
+          end
+          class PostWithPublishAt < Post
+            attributes :publish_at
+          end
+          class PostWithPublishAtSerializer < ActiveModel::Serializer
+            type 'posts'
+            attributes :title, :body, :publish_at
+            belongs_to :author
+            has_many :comments
+          end
+
+          def setup_post
+            ActionController::Base.cache_store.clear
+            @author = AuthorWithName.new(id: 1, first_name: 'Bob', last_name: 'Jones')
+            @comment1 = Comment.new(id: 7, body: 'cool', author: @author)
+            @comment2 = Comment.new(id: 12, body: 'awesome', author: @author)
+            @post = PostWithPublishAt.new(id: 1337, title: 'Title 1', body: 'Body 1',
+                                          author: @author, comments: [@comment1, @comment2],
+                                          publish_at: '2020-03-16T03:55:25.291Z')
+            @comment1.post = @post
+            @comment2.post = @post
+          end
+
+          def render_fields_works_on_relationships
+            setup_post
+            render json: @post, serializer: PostWithPublishAtSerializer, adapter: :json_api, fields: { posts: [:author] }
+          end
+        end
+
+        tests FieldsTestController
+
+        test 'fields works on relationships' do
+          get :render_fields_works_on_relationships
+          response = JSON.parse(@response.body)
+          expected = {
+            'data' => {
+              'id' => '1337',
+              'type' => 'posts',
+              'relationships' => {
+                'author' => {
+                  'data' => {
+                    'id' => '1',
+                    'type' => 'authors'
+                  }
+                }
+              }
+            }
+          }
+          assert_equal expected, response
+        end
+      end
+    end
+  end
+end

data/test/action_controller/json_api/linked_test.rb

@@ -0,0 +1,204 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class LinkedTest < ActionDispatch::IntegrationTest
+        class LinkedTestController < ActionController::Base
+          def setup_post
+            ActionController::Base.cache_store.clear
+            @role1 = Role.new(id: 1, name: 'admin')
+            @role2 = Role.new(id: 2, name: 'colab')
+            @author = Author.new(id: 1, name: 'Steve K.')
+            @author.posts = []
+            @author.bio = nil
+            @author.roles = [@role1, @role2]
+            @role1.author = @author
+            @role2.author = @author
+            @author2 = Author.new(id: 2, name: 'Anonymous')
+            @author2.posts = []
+            @author2.bio = nil
+            @author2.roles = []
+            @post = Post.new(id: 1, title: 'New Post', body: 'Body')
+            @first_comment = Comment.new(id: 1, body: 'ZOMG A COMMENT')
+            @second_comment = Comment.new(id: 2, body: 'ZOMG ANOTHER COMMENT')
+            @post.comments = [@first_comment, @second_comment]
+            @post.author = @author
+            @first_comment.post = @post
+            @first_comment.author = @author2
+            @second_comment.post = @post
+            @second_comment.author = nil
+            @post2 = Post.new(id: 2, title: 'Another Post', body: 'Body')
+            @post2.author = @author
+            @post2.comments = []
+            @blog = Blog.new(id: 1, name: 'My Blog!!')
+            @post.blog = @blog
+            @post2.blog = @blog
+          end
+
+          def render_resource_without_include
+            setup_post
+            render json: @post
+          end
+
+          def render_resource_with_include
+            setup_post
+            render json: @post, adapter: :json_api, include: [:author]
+          end
+
+          def render_resource_with_include_of_custom_key_by_original
+            setup_post
+            render json: @post, adapter: :json_api, include: [:reviews], serializer: PostWithCustomKeysSerializer
+          end
+
+          def render_resource_with_nested_include
+            setup_post
+            render json: @post, adapter: :json_api, include: [comments: [:author]]
+          end
+
+          def render_resource_with_nested_has_many_include_wildcard
+            setup_post
+            render json: @post, adapter: :json_api, include: 'author.*'
+          end
+
+          def render_resource_with_missing_nested_has_many_include
+            setup_post
+            @post.author = @author2 # author2 has no roles.
+            render json: @post, adapter: :json_api, include: [author: [:roles]]
+          end
+
+          def render_collection_with_missing_nested_has_many_include
+            setup_post
+            @post.author = @author2
+            render json: [@post, @post2], adapter: :json_api, include: [author: [:roles]]
+          end
+
+          def render_collection_without_include
+            setup_post
+            render json: [@post], adapter: :json_api
+          end
+
+          def render_collection_with_include
+            setup_post
+            render json: [@post], adapter: :json_api, include: 'author, comments'
+          end
+        end
+
+        setup do
+          @routes = Rails.application.routes.draw do
+            ActiveSupport::Deprecation.silence do
+              match ':action', to: LinkedTestController, via: [:get, :post]
+            end
+          end
+        end
+
+        def test_render_resource_without_include
+          get '/render_resource_without_include'
+          response = JSON.parse(@response.body)
+          refute response.key? 'included'
+        end
+
+        def test_render_resource_with_include
+          get '/render_resource_with_include'
+          response = JSON.parse(@response.body)
+          assert response.key? 'included'
+          assert_equal 1, response['included'].size
+          assert_equal 'Steve K.', response['included'].first['attributes']['name']
+        end
+
+        def test_render_resource_with_nested_has_many_include
+          get '/render_resource_with_nested_has_many_include_wildcard'
+          response = JSON.parse(@response.body)
+          expected_linked = [
+            {
+              'id' => '1',
+              'type' => 'authors',
+              'attributes' => {
+                'name' => 'Steve K.'
+              },
+              'relationships' => {
+                'posts' => { 'data' => [] },
+                'roles' => { 'data' => [{ 'type' => 'roles', 'id' => '1' }, { 'type' => 'roles', 'id' => '2' }] },
+                'bio' => { 'data' => nil }
+              }
+            }, {
+              'id' => '1',
+              'type' => 'roles',
+              'attributes' => {
+                'name' => 'admin',
+                'description' => nil,
+                'slug' => 'admin-1'
+              },
+              'relationships' => {
+                'author' => { 'data' => { 'type' => 'authors', 'id' => '1' } }
+              }
+            }, {
+              'id' => '2',
+              'type' => 'roles',
+              'attributes' => {
+                'name' => 'colab',
+                'description' => nil,
+                'slug' => 'colab-2'
+              },
+              'relationships' => {
+                'author' => { 'data' => { 'type' => 'authors', 'id' => '1' } }
+              }
+            }
+          ]
+          assert_equal expected_linked, response['included']
+        end
+
+        def test_render_resource_with_include_of_custom_key_by_original
+          get '/render_resource_with_include_of_custom_key_by_original'
+          response = JSON.parse(@response.body)
+          assert response.key? 'included'
+
+          relationships = response['data']['relationships']
+
+          assert_includes relationships, 'reviews'
+          assert_includes relationships, 'writer'
+          assert_includes relationships, 'site'
+        end
+
+        def test_render_resource_with_nested_include
+          get '/render_resource_with_nested_include'
+          response = JSON.parse(@response.body)
+          assert response.key? 'included'
+          assert_equal 3, response['included'].size
+        end
+
+        def test_render_collection_without_include
+          get '/render_collection_without_include'
+          response = JSON.parse(@response.body)
+          refute response.key? 'included'
+        end
+
+        def test_render_collection_with_include
+          get '/render_collection_with_include'
+          response = JSON.parse(@response.body)
+          assert response.key? 'included'
+        end
+
+        def test_render_resource_with_nested_attributes_even_when_missing_associations
+          get '/render_resource_with_missing_nested_has_many_include'
+          response = JSON.parse(@response.body)
+          assert response.key? 'included'
+          refute include_type?(response['included'], 'roles')
+        end
+
+        def test_render_collection_with_missing_nested_has_many_include
+          get '/render_collection_with_missing_nested_has_many_include'
+          response = JSON.parse(@response.body)
+          assert response.key? 'included'
+          assert include_type?(response['included'], 'roles')
+        end
+
+        def include_type?(collection, value)
+          collection.detect { |i| i['type'] == value }
+        end
+      end
+    end
+  end
+end

data/test/action_controller/json_api/pagination_test.rb

@@ -0,0 +1,126 @@
+# frozen_string_literal: true
+
+require 'test_helper'
+require 'will_paginate/array'
+require 'kaminari'
+require 'kaminari/hooks'
+::Kaminari::Hooks.init
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class PaginationTest < ActionController::TestCase
+        KAMINARI_URI = 'http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_kaminari'.freeze
+        WILL_PAGINATE_URI = 'http://test.host/action_controller/serialization/json_api/pagination_test/pagination_test/render_pagination_using_will_paginate'.freeze
+
+        class PaginationTestController < ActionController::Base
+          def setup
+            @array = [
+              Profile.new(name: 'Name 1', description: 'Description 1', comments: 'Comments 1'),
+              Profile.new(name: 'Name 2', description: 'Description 2', comments: 'Comments 2'),
+              Profile.new(name: 'Name 3', description: 'Description 3', comments: 'Comments 3')
+            ]
+          end
+
+          def using_kaminari
+            setup
+            Kaminari.paginate_array(@array).page(params[:page][:number]).per(params[:page][:size])
+          end
+
+          def using_will_paginate
+            setup
+            @array.paginate(page: params[:page][:number], per_page: params[:page][:size])
+          end
+
+          def render_pagination_using_kaminari
+            render json: using_kaminari, adapter: :json_api
+          end
+
+          def render_pagination_using_will_paginate
+            render json: using_will_paginate, adapter: :json_api
+          end
+
+          def render_array_without_pagination_links
+            setup
+            render json: @array, adapter: :json_api
+          end
+        end
+
+        tests PaginationTestController
+
+        def test_render_pagination_links_with_will_paginate
+          expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
+                             'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'prev' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+                             'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
+
+          get :render_pagination_using_will_paginate, params: { page: { number: 2, size: 1 } }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_first_last_and_next_pagination_links
+          expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+                             'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2",
+                             'prev' => nil,
+                             'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2",
+                             'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2" }
+          get :render_pagination_using_will_paginate, params: { page: { number: 1, size: 2 } }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_pagination_links_with_kaminari
+          expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
+                             'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'next' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+                             'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
+          get :render_pagination_using_kaminari, params: { page: { number: 2, size: 1 } }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_prev_first_and_last_pagination_links
+          expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1",
+                             'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1",
+                             'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1",
+                             'next' => nil,
+                             'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1" }
+          get :render_pagination_using_kaminari, params: { page: { number: 3, size: 1 } }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_first_last_and_next_pagination_links_with_additional_params
+          expected_links = { 'self' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2&teste=additional",
+                             'first' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=2&teste=additional",
+                             'prev' => nil,
+                             'next' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional",
+                             'last' => "#{WILL_PAGINATE_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=2&teste=additional" }
+          get :render_pagination_using_will_paginate, params: { page: { number: 1, size: 2 }, teste: 'additional' }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_render_only_prev_first_and_last_pagination_links_with_additional_params
+          expected_links = { 'self' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1&teste=additional",
+                             'first' => "#{KAMINARI_URI}?page%5Bnumber%5D=1&page%5Bsize%5D=1&teste=additional",
+                             'prev' => "#{KAMINARI_URI}?page%5Bnumber%5D=2&page%5Bsize%5D=1&teste=additional",
+                             'next' => nil,
+                             'last' => "#{KAMINARI_URI}?page%5Bnumber%5D=3&page%5Bsize%5D=1&teste=additional" }
+          get :render_pagination_using_kaminari, params: { page: { number: 3, size: 1 }, teste: 'additional' }
+          response = JSON.parse(@response.body)
+          assert_equal expected_links, response['links']
+        end
+
+        def test_array_without_pagination_links
+          get :render_array_without_pagination_links, params: { page: { number: 2, size: 1 } }
+          response = JSON.parse(@response.body)
+          refute response.key? 'links'
+        end
+      end
+    end
+  end
+end