jsonapi-resources 0.0.1

data/test/unit/resource/resource_test.rb

@@ -0,0 +1,45 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require File.expand_path('../../../fixtures/active_record', __FILE__)
+
+class ArticleResource < JSONAPI::Resource
+  model_name 'Post'
+end
+
+class CatResource < JSONAPI::Resource
+  attribute :id
+  attribute :name
+  attribute :breed
+
+  has_one :mother, class_name: 'Cat'
+  has_one :father, class_name: 'Cat'
+end
+
+class ResourceTest < MiniTest::Unit::TestCase
+  def setup
+    @post = Post.first
+  end
+
+  def test_model_name
+    assert_equal(PostResource._model_name, 'Post')
+  end
+
+  def test_model
+    assert_equal(PostResource._model_class, Post)
+  end
+
+  def test_model_alternate
+    assert_equal(ArticleResource._model_class, Post)
+  end
+
+  def test_class_attributes
+    attrs = CatResource._attributes
+    assert_kind_of(Set, attrs)
+    assert_equal(attrs.size, 3)
+  end
+
+  def test_class_assosications
+    associations = CatResource._associations
+    assert_kind_of(Hash, associations)
+    assert_equal(associations.size, 2)
+  end
+end

data/test/unit/serializer/serializer_test.rb

@@ -0,0 +1,429 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require File.expand_path('../../../fixtures/active_record', __FILE__)
+require 'jsonapi/resource_serializer'
+
+
+class SerializerTest < MiniTest::Unit::TestCase
+  def setup
+    @post = Post.find(1)
+    @fred = Person.find_by(name: 'Fred Reader')
+  end
+
+  def test_serializer
+    assert_hash_equals({
+                  posts: [{
+                    id: 1,
+                    title: 'New post',
+                    body: 'A body!!!',
+                    subject: 'New post',
+                    links: {
+                      section: nil,
+                      author: 1,
+                      tags: [1,2,3],
+                      comments: [1,2]
+                    }
+                  }]
+                 }, JSONAPI::ResourceSerializer.new.serialize(PostResource.new(@post), nil, nil))
+  end
+
+  def test_serializer_limited_fieldset
+    assert_hash_equals({
+                   posts: [{
+                     id: 1,
+                     title: 'New post',
+                     links: {
+                       author: 1
+                     }
+                   }]
+                }, JSONAPI::ResourceSerializer.new.serialize(PostResource.new(@post), nil,
+                                                               {posts: [:id, :title, :author]}))
+  end
+
+  def test_serializer_include
+    assert_hash_equals({
+                  posts: [{
+                    id: 1,
+                    title: 'New post',
+                    body: 'A body!!!',
+                    subject: 'New post',
+                    links: {
+                      author: 1,
+                      tags: [1,2,3],
+                      comments: [1,2],
+                      section: nil
+                    }
+                  }],
+                  linked: {
+                    people: [{
+                              id: 1,
+                              name: 'Joe Author',
+                              email: 'joe@xyz.fake',
+                              date_joined: DateTime.parse('2013-08-07 20:25:00 UTC +00:00'),
+                              links: {
+                                  comments: [1],
+                                  posts: [1,2,11]
+                              }
+                             }]
+                  }
+                 }, JSONAPI::ResourceSerializer.new.serialize(PostResource.new(@post), [:author], nil))
+  end
+
+  def test_serializer_include_sub_objects
+    assert_hash_equals(
+        {
+          posts: [{
+            id: 1,
+            title: 'New post',
+            body: 'A body!!!',
+            subject: 'New post',
+            links: {
+              author: 1,
+              tags: [1,2,3],
+              comments: [1,2],
+              section: nil
+            }
+          }],
+          linked: {
+            tags: [
+                {
+                    id: 1,
+                    name: 'short',
+                    links: {
+                        posts: :not_nil
+                    }
+                },
+                {
+                    id: 2,
+                    name: 'whiny',
+                    links: {
+                        posts: :not_nil
+                    }
+                },
+                {
+                    id: 4,
+                    name: 'happy',
+                    links: {
+                        posts: :not_nil
+                    }
+                }
+            ],
+            comments: [
+                {
+                    id: 1,
+                    body: 'what a dumb post',
+                    links: {
+                      author: 1,
+                      post: 1,
+                      tags: [2, 1]
+                    }
+                },
+                {
+                    id: 2,
+                    body: 'i liked it',
+                    links: {
+                      author: 2,
+                      post: 1,
+                      tags: [4, 1]
+                    }
+                }
+            ]
+          }
+         }, JSONAPI::ResourceSerializer.new.serialize(PostResource.new(@post), [:comments,'comments.tags'], nil))
+  end
+
+  def test_serializer_include_has_many_sub_objects_only
+    assert_hash_equals(
+        {
+          posts: [{
+            id: 1,
+            title: 'New post',
+            body: 'A body!!!',
+            subject: 'New post',
+            links: {
+              author: 1,
+              tags: [1,2,3],
+              comments: [1,2],
+              section: nil
+            }
+          }],
+          linked: {
+            tags: [
+                {
+                  id: 1,
+                  name: 'short',
+                  links: {
+                    posts: :not_nil
+                  }
+                },
+                {
+                  id: 2,
+                  name: 'whiny',
+                  links: {
+                      posts: :not_nil
+                  }
+                },
+                {
+                  id: 4,
+                  name: 'happy',
+                  links: {
+                      posts: :not_nil
+                  }
+                }
+            ]
+          }
+         }, JSONAPI::ResourceSerializer.new.serialize(PostResource.new(@post), ['comments.tags'], nil))
+  end
+
+  def test_serializer_include_has_one_sub_objects_only
+    assert_hash_equals(
+        {
+          posts: [{
+            id: 1,
+            title: 'New post',
+            body: 'A body!!!',
+            subject: 'New post',
+            links: {
+              author: 1,
+              tags: [1,2,3],
+              comments: [1,2],
+              section: nil
+            }
+          }],
+          linked: {
+              comments: [
+                  {
+                      id: 1,
+                      body: 'what a dumb post',
+                      links: {
+                        author: 1,
+                        post: 1,
+                        tags: [2, 1]
+                      }
+                  }
+              ]
+          }
+         }, JSONAPI::ResourceSerializer.new.serialize(PostResource.new(@post), ['author.comments'], nil))
+  end
+
+  def test_serializer_different_foreign_key
+    assert_hash_equals(
+        {
+          people: [{
+            id: 2,
+            name: 'Fred Reader',
+            email: 'fred@xyz.fake',
+            date_joined: DateTime.parse('2013-10-31 20:25:00 UTC +00:00'),
+            links: {
+              posts: [],
+              comments: [2,3]
+            }
+          }],
+          linked: {
+              comments: [{
+                id: 2,
+                body: 'i liked it',
+                links: {
+                  author: 2,
+                  post: 1,
+                  tags: [4, 1]
+                }
+              },
+              {
+                id: 3,
+                body: 'Thanks man. Great post. But what is JR?',
+                links: {
+                  author: 2,
+                  post: 2,
+                  tags: [5]
+                }
+              }
+              ]
+          }
+         }, JSONAPI::ResourceSerializer.new.serialize(PersonResource.new(@fred), ['comments'], nil))
+  end
+
+  def test_serializer_array_of_resources
+
+    posts = []
+    Post.find(1,2).each do |post|
+      posts.push PostResource.new(post)
+    end
+
+    assert_hash_equals(
+        {
+          posts: [{
+            id: 1,
+            title: 'New post',
+            body: 'A body!!!',
+            subject: 'New post',
+            links: {
+              author: 1,
+              tags: [1,2,3],
+              comments: [1,2],
+              section: nil
+            }
+          },
+          {
+            id: 2,
+            title: 'JR Solves your serialization woes!',
+            body: 'Use JR',
+            subject: 'JR Solves your serialization woes!',
+            links: {
+              author: 1,
+              tags: [5],
+              comments: [3],
+              section: 3
+            }
+          }],
+          linked: {
+            tags: [
+                {
+                  id: 1,
+                  name: 'short',
+                  links: {
+                      posts: :not_nil
+                  }
+                },
+                {
+                  id: 2,
+                  name: 'whiny',
+                  links: {
+                      posts: :not_nil
+                  }
+                },
+                {
+                  id: 4,
+                  name: 'happy',
+                  links: {
+                      posts: :not_nil
+                  }
+                },
+                {
+                  id: 5,
+                  name: 'JR',
+                  links: {
+                      posts: [2,11]
+                  }
+                }
+            ],
+            comments: [
+                {
+                    id: 1,
+                    body: 'what a dumb post',
+                    links: {
+                      author: 1,
+                      post: 1,
+                      tags: [2, 1]
+                    }
+                },
+                {
+                    id: 2,
+                    body: 'i liked it',
+                    links: {
+                      author: 2,
+                      post: 1,
+                      tags: [4, 1]
+                    }
+                },
+                {
+                    id: 3,
+                    body: 'Thanks man. Great post. But what is JR?',
+                    links: {
+                      author: 2,
+                      post: 2,
+                      tags: [5]
+                    }
+                }
+            ]
+          }
+         }, JSONAPI::ResourceSerializer.new.serialize(posts, ['comments','comments.tags'], nil))
+  end
+
+  def test_serializer_array_of_resources_limited_fields
+
+    posts = []
+    Post.find(1,2).each do |post|
+      posts.push PostResource.new(post)
+    end
+
+    assert_hash_equals(
+        {
+            posts: [{
+                        id: 1,
+                        title: 'New post',
+                        links: {
+                            author: 1
+                        }
+                    },
+                    {
+                        id: 2,
+                        title: 'JR Solves your serialization woes!',
+                        links: {
+                            author: 1
+                        }
+                    }],
+            linked: {
+                tags: [
+                    {
+                        name: 'short'
+                    },
+                    {
+                        name: 'whiny'
+                    },
+                    {
+                        name: 'happy'
+                    },
+                    {
+                        name: 'JR'
+                    }
+                ],
+                comments: [
+                    {
+                        id: 1,
+                        body: 'what a dumb post',
+                        links: {
+                            post: 1
+                        }
+                    },
+                    {
+                        id: 2,
+                        body: 'i liked it',
+                        links: {
+                            post: 1
+                        }
+                    },
+                    {
+                        id: 3,
+                        body: 'Thanks man. Great post. But what is JR?',
+                        links: {
+                            post: 2
+                        }
+                    }
+                ],
+                posts: [
+                    {
+                        id: 11,
+                        title: 'JR How To',
+                        links: {
+                            author: 1
+                        }
+                    }
+                ],
+                people: [
+                    {
+                        id: 1,
+                        email: 'joe@xyz.fake',
+                        links: {
+                            comments: [1]
+                        }
+                    }]
+            }
+        }, JSONAPI::ResourceSerializer.new.serialize(posts, ['comments','author','comments.tags','author.posts'],
+                                                       {
+                                                           people: [:id, :email, :comments],
+                                                           posts: [:id, :title, :author],
+                                                           tags: [:name],
+                                                           comments: [:id, :body, :post]
+                                                        }))
+  end
+end