active_model_serializers 0.8.3 → 0.10.0

data/test/action_controller/explicit_serializer_test.rb

@@ -0,0 +1,134 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class ExplicitSerializerTest < ActionController::TestCase
+      class ExplicitSerializerTestController < ActionController::Base
+        def render_using_explicit_serializer
+          @profile = Profile.new(name: 'Name 1',
+                                 description: 'Description 1',
+                                 comments: 'Comments 1')
+          render json: @profile, serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_explicit_serializer
+          array = [
+            Profile.new(name: 'Name 1',
+                        description: 'Description 1',
+                        comments: 'Comments 1'),
+            Profile.new(name: 'Name 2',
+                        description: 'Description 2',
+                        comments: 'Comments 2')
+          ]
+          render json: array,
+                 serializer: PaginatedSerializer,
+                 each_serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_implicit_serializer
+          array = [
+            Profile.new(name: 'Name 1',
+                        description: 'Description 1',
+                        comments: 'Comments 1'),
+            Profile.new(name: 'Name 2',
+                        description: 'Description 2',
+                        comments: 'Comments 2')
+          ]
+          render json: array,
+                 each_serializer: ProfilePreviewSerializer
+        end
+
+        def render_array_using_explicit_serializer_and_custom_serializers
+          @post = Post.new(title: 'New Post', body: 'Body')
+          @author = Author.new(name: 'Jane Blogger')
+          @author.posts = [@post]
+          @post.author = @author
+          @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]
+          @first_comment.post = @post
+          @first_comment.author = nil
+          @second_comment.post = @post
+          @second_comment.author = nil
+          @blog = Blog.new(id: 23, name: 'AMS Blog')
+          @post.blog = @blog
+
+          render json: [@post], each_serializer: PostPreviewSerializer
+        end
+
+        def render_using_explicit_each_serializer
+          location       = Location.new(id: 42, lat: '-23.550520', lng: '-46.633309')
+          place          = Place.new(id: 1337, name: 'Amazing Place', locations: [location])
+
+          render json: place, each_serializer: PlaceSerializer
+        end
+      end
+
+      tests ExplicitSerializerTestController
+
+      def test_render_using_explicit_serializer
+        get :render_using_explicit_serializer
+
+        assert_equal 'application/json', @response.content_type
+        assert_equal '{"name":"Name 1"}', @response.body
+      end
+
+      def test_render_array_using_explicit_serializer
+        get :render_array_using_explicit_serializer
+        assert_equal 'application/json', @response.content_type
+
+        expected = [
+          { 'name' => 'Name 1' },
+          { 'name' => 'Name 2' }
+        ]
+
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_implicit_serializer
+        get :render_array_using_implicit_serializer
+        assert_equal 'application/json', @response.content_type
+
+        expected = [
+          { 'name' => 'Name 1' },
+          { 'name' => 'Name 2' }
+        ]
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_array_using_explicit_serializer_and_custom_serializers
+        get :render_array_using_explicit_serializer_and_custom_serializers
+
+        expected = [
+          { 'title' => 'New Post',
+            'body' => 'Body',
+            'id' => assigns(:post).id,
+            'comments' => [{ 'id' => 1 }, { 'id' => 2 }],
+            'author' => { 'id' => assigns(:author).id }
+          }
+        ]
+
+        assert_equal expected.to_json, @response.body
+      end
+
+      def test_render_using_explicit_each_serializer
+        get :render_using_explicit_each_serializer
+
+        expected = {
+          id: 1337,
+          name: 'Amazing Place',
+          locations: [
+            {
+              id: 42,
+              lat: '-23.550520',
+              lng: '-46.633309',
+              place: 'Nowhere' # is a virtual attribute on LocationSerializer
+            }
+          ]
+        }
+
+        assert_equal expected.to_json, response.body
+      end
+    end
+  end
+end

data/test/action_controller/json/include_test.rb

@@ -0,0 +1,167 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class Json
+      class IncludeTest < ActionController::TestCase
+        class IncludeTestController < ActionController::Base
+          def setup_data
+            ActionController::Base.cache_store.clear
+
+            @author = Author.new(id: 1, name: 'Steve K.')
+
+            @post = Post.new(id: 42, 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
+            @second_comment.post = @post
+
+            @blog = Blog.new(id: 1, name: 'My Blog!!')
+            @post.blog = @blog
+            @author.posts = [@post]
+
+            @first_comment.author = @author
+            @second_comment.author = @author
+            @author.comments = [@first_comment, @second_comment]
+            @author.roles = []
+            @author.bio = {}
+          end
+
+          def render_without_include
+            setup_data
+            render json: @author, adapter: :json
+          end
+
+          def render_resource_with_include_hash
+            setup_data
+            render json: @author, include: { posts: :comments }, adapter: :json
+          end
+
+          def render_resource_with_include_string
+            setup_data
+            render json: @author, include: 'posts.comments', adapter: :json
+          end
+
+          def render_resource_with_deep_include
+            setup_data
+            render json: @author, include: 'posts.comments.author', adapter: :json
+          end
+        end
+
+        tests IncludeTestController
+
+        def test_render_without_include
+          get :render_without_include
+          response = JSON.parse(@response.body)
+          expected = {
+            'author' => {
+              'id' => 1,
+              'name' => 'Steve K.',
+              'posts' => [
+                {
+                  'id' => 42, 'title' => 'New Post', 'body' => 'Body'
+                }
+              ],
+              'roles' => [],
+              'bio' => {}
+            }
+          }
+
+          assert_equal(expected, response)
+        end
+
+        def test_render_resource_with_include_hash
+          get :render_resource_with_include_hash
+          response = JSON.parse(@response.body)
+          expected = {
+            'author' => {
+              'id' => 1,
+              'name' => 'Steve K.',
+              'posts' => [
+                {
+                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
+                  'comments' => [
+                    {
+                      'id' => 1, 'body' => 'ZOMG A COMMENT'
+                    },
+                    {
+                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT'
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+
+          assert_equal(expected, response)
+        end
+
+        def test_render_resource_with_include_string
+          get :render_resource_with_include_string
+
+          response = JSON.parse(@response.body)
+          expected = {
+            'author' => {
+              'id' => 1,
+              'name' => 'Steve K.',
+              'posts' => [
+                {
+                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
+                  'comments' => [
+                    {
+                      'id' => 1, 'body' => 'ZOMG A COMMENT'
+                    },
+                    {
+                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT'
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+
+          assert_equal(expected, response)
+        end
+
+        def test_render_resource_with_deep_include
+          get :render_resource_with_deep_include
+
+          response = JSON.parse(@response.body)
+          expected = {
+            'author' => {
+              'id' => 1,
+              'name' => 'Steve K.',
+              'posts' => [
+                {
+                  'id' => 42, 'title' => 'New Post', 'body' => 'Body',
+                  'comments' => [
+                    {
+                      'id' => 1, 'body' => 'ZOMG A COMMENT',
+                      'author' => {
+                        'id' => 1,
+                        'name' => 'Steve K.'
+                      }
+                    },
+                    {
+                      'id' => 2, 'body' => 'ZOMG ANOTHER COMMENT',
+                      'author' => {
+                        'id' => 1,
+                        'name' => 'Steve K.'
+                      }
+                    }
+                  ]
+                }
+              ]
+            }
+          }
+
+          assert_equal(expected, response)
+        end
+      end
+    end
+  end
+end

data/test/action_controller/json_api/deserialization_test.rb

@@ -0,0 +1,112 @@
+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' => 'discounts',
+            '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,41 @@
+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_reponse_body.to_json, expected_errors_object
+        end
+
+        def json_reponse_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/linked_test.rb

@@ -0,0 +1,197 @@
+require 'test_helper'
+
+module ActionController
+  module Serialization
+    class JsonApi
+      class LinkedTest < ActionController::TestCase
+        class LinkedTestController < ActionController::Base
+          require 'active_model_serializers/register_jsonapi_renderer'
+          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 jsonapi: @post
+          end
+
+          def render_resource_with_include
+            setup_post
+            render jsonapi: @post, include: [:author]
+          end
+
+          def render_resource_with_include_of_custom_key_by_original
+            setup_post
+            render jsonapi: @post, include: [:reviews], serializer: PostWithCustomKeysSerializer
+          end
+
+          def render_resource_with_nested_include
+            setup_post
+            render jsonapi: @post, include: [comments: [:author]]
+          end
+
+          def render_resource_with_nested_has_many_include_wildcard
+            setup_post
+            render jsonapi: @post, include: 'author.*'
+          end
+
+          def render_resource_with_missing_nested_has_many_include
+            setup_post
+            @post.author = @author2 # author2 has no roles.
+            render jsonapi: @post, include: [author: [:roles]]
+          end
+
+          def render_collection_with_missing_nested_has_many_include
+            setup_post
+            @post.author = @author2
+            render jsonapi: [@post, @post2], include: [author: [:roles]]
+          end
+
+          def render_collection_without_include
+            setup_post
+            render jsonapi: [@post]
+          end
+
+          def render_collection_with_include
+            setup_post
+            render jsonapi: [@post], include: 'author, comments'
+          end
+        end
+
+        tests LinkedTestController
+
+        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 has_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 has_type?(response['included'], 'roles')
+        end
+
+        def has_type?(collection, value)
+          collection.detect { |i| i['type'] == value }
+        end
+      end
+    end
+  end
+end