jsonapi-resources 0.4.2 → 0.4.3

data/test/integration/routes/routes_test.rb

@@ -52,6 +52,53 @@ class RoutesTest < ActionDispatch::IntegrationTest
                    {controller: 'posts', action: 'update_association', post_id: '1', association: 'tags'})
   end
 
+  # Polymorphic
+  def test_routing_polymorphic_get_related_resource
+    assert_routing(
+      {
+        path: '/pictures/1/imageable',
+        method: :get
+      },
+      {
+        association: 'imageable',
+        source: 'pictures',
+        controller: 'imageables',
+        action: 'get_related_resource',
+        picture_id: '1'
+      }
+    )
+  end
+
+  def test_routing_polymorphic_patch_related_resource
+    assert_routing(
+      {
+        path: '/pictures/1/relationships/imageable',
+        method: :patch
+      },
+      {
+        association: 'imageable',
+        controller: 'pictures',
+        action: 'update_association',
+        picture_id: '1'
+      }
+    )
+  end
+
+  def test_routing_polymorphic_delete_related_resource
+    assert_routing(
+      {
+        path: '/pictures/1/relationships/imageable',
+        method: :delete
+      },
+      {
+        association: 'imageable',
+        controller: 'pictures',
+        action: 'destroy_association',
+        picture_id: '1'
+      }
+    )
+  end
+
   # V1
   def test_routing_v1_posts_show
     assert_routing({path: '/api/v1/posts/1', method: :get},

data/test/test_helper.rb

@@ -15,7 +15,7 @@ require 'rails/test_help'
 require 'jsonapi-resources'
 
 require File.expand_path('../helpers/value_matchers', __FILE__)
-require File.expand_path('../helpers/hash_helpers', __FILE__)
+require File.expand_path('../helpers/assertions', __FILE__)
 require File.expand_path('../helpers/functional_helpers', __FILE__)
 
 Rails.env = 'test'
@@ -59,14 +59,30 @@ end
 
 def count_queries(&block)
   @query_count = 0
-  ActiveSupport::Notifications.subscribe('sql.active_record') do
+  @queries = []
+  ActiveSupport::Notifications.subscribe('sql.active_record') do |name, started, finished, unique_id, payload|
     @query_count = @query_count + 1
+    @queries.push payload[:sql]
   end
   yield block
   ActiveSupport::Notifications.unsubscribe('sql.active_record')
   @query_count
 end
 
+def assert_query_count(expected, msg = nil)
+  msg = message(msg) {
+    "Expected #{expected} queries, ran #{@query_count} queries"
+  }
+  show_queries unless expected == @query_count
+  assert expected == @query_count, msg
+end
+
+def show_queries
+  @queries.each_with_index do |query, index|
+    puts "sql[#{index}]: #{query}"
+  end
+end
+
 TestApp.initialize!
 
 require File.expand_path('../fixtures/active_record', __FILE__)
@@ -89,9 +105,16 @@ TestApp.routes.draw do
   jsonapi_resources :preferences
   jsonapi_resources :facts
   jsonapi_resources :categories
+  jsonapi_resources :pictures
+  jsonapi_resources :documents
+  jsonapi_resources :products
 
   namespace :api do
     namespace :v1 do
+      scope ":section_id" do
+        jsonapi_resources :people
+      end
+
       jsonapi_resources :people
       jsonapi_resources :comments
       jsonapi_resources :tags
@@ -110,7 +133,7 @@ TestApp.routes.draw do
     JSONAPI.configuration.route_format = :underscored_route
     namespace :v2 do
       jsonapi_resources :posts do
-        jsonapi_link :author, except: [:destroy]
+        jsonapi_link :author, except: :destroy
       end
 
       jsonapi_resource :preferences, except: [:create, :destroy]
@@ -184,7 +207,7 @@ end
 Minitest::Test = MiniTest::Unit::TestCase unless defined?(Minitest::Test)
 
 class Minitest::Test
-  include Helpers::HashHelpers
+  include Helpers::Assertions
   include Helpers::ValueMatchers
   include Helpers::FunctionalHelpers
 end

data/test/unit/serializer/include_directives_test.rb

@@ -105,4 +105,9 @@ class IncludeDirectivesTest < ActiveSupport::TestCase
       },
       directives)
   end
+
+  def test_three_levels_include_full_model_includes
+    directives = JSONAPI::IncludeDirectives.new(['posts.comments.tags'])
+    assert_array_equals([{:posts=>[{:comments=>[:tags]}]}], directives.model_includes)
+  end
 end

data/test/unit/serializer/polymorphic_serializer_test.rb

@@ -0,0 +1,384 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require 'jsonapi-resources'
+require 'json'
+
+class PolymorphismTest < ActionDispatch::IntegrationTest
+  def setup
+    @pictures = Picture.all
+    @person = Person.find(1)
+
+    JSONAPI.configuration.json_key_format = :camelized_key
+    JSONAPI.configuration.route_format = :camelized_route
+  end
+
+  def after_teardown
+    JSONAPI.configuration.json_key_format = :underscored_key
+  end
+
+  def test_polymorphic_association
+    associations = PictureResource._associations
+    imageable = associations[:imageable]
+
+    assert_equal associations.size, 1
+    assert imageable.polymorphic?
+  end
+
+  def test_polymorphic_has_many_serialization
+    serialized_data = JSONAPI::ResourceSerializer.new(
+      PersonResource,
+      include: %w(vehicles)
+    ).serialize_to_hash(PersonResource.new(@person))
+
+    assert_hash_equals(
+      {
+        :data => {
+          "id" => "1",
+          "type" => "people",
+          "links" => {
+            :self => "/people/1"
+          },
+          "attributes" => {
+            "name" => "Joe Author",
+            "email" => "joe@xyz.fake",
+            "dateJoined" => "2013-08-07 16:25:00 -0400"
+          },
+          "relationships" => {
+            "comments" => {
+              :links => {
+                :self => "/people/1/relationships/comments",
+                :related => "/people/1/comments"
+              }
+            },
+            "posts" => {
+              :links => {
+                :self => "/people/1/relationships/posts",
+                :related => "/people/1/posts"
+              }
+            },
+            "vehicles" => {
+              :links => {
+                :self => "/people/1/relationships/vehicles",
+                :related => "/people/1/vehicles"
+              },
+              :data => [
+                { :type => "cars", :id=> "1" },
+                { :type => "boats", :id=>"2" }
+              ]
+            },
+            "preferences" => {
+              :links => {
+                :self => "/people/1/relationships/preferences",
+                :related => "/people/1/preferences"
+              },
+              :data => {
+                :type => "preferences",
+                :id=>"1"
+              }
+            },
+            "hairCut" => {
+              :links => {
+                :self => "/people/1/relationships/hairCut",
+                :related => "/people/1/hairCut"
+              },
+              :data => nil
+            }
+          }
+        },
+        :included => [
+          {
+            "id" => "1",
+            "type" => "cars",
+            "links" => {
+              :self => "/cars/1"
+            },
+            "relationships" => {
+              "person" => {
+                :links => {
+                  :self => "/cars/1/relationships/person",
+                  :related => "/cars/1/person"
+                },
+                :data => {
+                  :type => "people",
+                  :id => "1"
+                }
+              }
+            }
+          },
+          {
+            "id" => "2",
+            "type" => "boats",
+            "links" => {
+              :self => "/boats/2"
+            },
+            "relationships" => {
+              "person" => {
+                :links => {
+                  :self => "/boats/2/relationships/person",
+                  :related => "/boats/2/person"
+                },
+                :data => {
+                  :type => "people",
+                  :id => "1"
+                }
+              }
+            }
+          }
+        ]
+      },
+      serialized_data
+    )
+  end
+
+  def test_polymorphic_has_one_serialization
+    serialized_data = JSONAPI::ResourceSerializer.new(
+      PictureResource,
+      include: %w(imageable)
+    ).serialize_to_hash(@pictures.map { |p| PictureResource.new p })
+
+    assert_hash_equals(
+      {
+        data: [
+          {
+            id: '1',
+            type: 'pictures',
+            links: {
+              self: '/pictures/1'
+            },
+            attributes: {
+              name: 'enterprise_gizmo.jpg'
+            },
+            relationships: {
+              imageable: {
+                links: {
+                  self: '/pictures/1/relationships/imageable',
+                  related: '/pictures/1/imageable'
+                },
+                data: {
+                  type: 'products',
+                  id: '1'
+                }
+              }
+            }
+          },
+          {
+            id: '2',
+            type: 'pictures',
+            links: {
+              self: '/pictures/2'
+            },
+            attributes: {
+              name: 'company_brochure.jpg'
+            },
+            relationships: {
+              imageable: {
+                links: {
+                  self: '/pictures/2/relationships/imageable',
+                  related: '/pictures/2/imageable'
+                },
+                data: {
+                  type: 'documents',
+                  id: '1'
+                }
+              }
+            }
+          },
+          {
+            id: '3',
+            type: 'pictures',
+            links: {
+              self: '/pictures/3'
+            },
+            attributes: {
+              name: 'group_photo.jpg'
+            },
+            relationships: {
+              imageable: {
+                links: {
+                  self: '/pictures/3/relationships/imageable',
+                  related: '/pictures/3/imageable'
+                },
+                data: nil
+              }
+            }
+          }
+
+        ],
+        :included => [
+          {
+            id: '1',
+            type: 'products',
+            links: {
+              self: '/products/1'
+            },
+            attributes: {
+              name: 'Enterprise Gizmo'
+            },
+            relationships: {
+              picture: {
+                links: {
+                  self: '/products/1/relationships/picture',
+                  related: '/products/1/picture',
+                },
+                data: {
+                  type: 'pictures',
+                  id: '1'
+                }
+              }
+            }
+          },
+          {
+            id: '1',
+            type: 'documents',
+            links: {
+              self: '/documents/1'
+            },
+            attributes: {
+              name: 'Company Brochure'
+            },
+            relationships: {
+              pictures: {
+                links: {
+                  self: '/documents/1/relationships/pictures',
+                  related: '/documents/1/pictures'
+                }
+              }
+            }
+          }
+        ]
+      },
+      serialized_data
+    )
+  end
+
+  def test_polymorphic_get_related_resource
+    get '/pictures/1/imageable'
+    serialized_data = JSON.parse(response.body)
+      assert_hash_equals(
+      {
+        data: {
+          id: '1',
+          type: 'products',
+          links: {
+            self: 'http://www.example.com/products/1'
+          },
+          attributes: {
+            name: 'Enterprise Gizmo'
+          },
+          relationships: {
+            picture: {
+              links: {
+                self: 'http://www.example.com/products/1/relationships/picture',
+                related: 'http://www.example.com/products/1/picture'
+              },
+              data: {
+                type: 'pictures',
+                id: '1'
+              }
+            }
+          }
+        }
+      },
+      serialized_data
+    )
+  end
+
+  def test_create_resource_with_polymorphic_relationship
+    document = Document.find(1)
+    post "/pictures/",
+      {
+        data: {
+          type: "pictures",
+          attributes: {
+            name: "hello.jpg"
+          },
+          relationships: {
+            imageable: {
+              data: {
+                type: "documents",
+                id: document.id.to_s
+              }
+            }
+          }
+        }
+      }.to_json,
+      {
+        'Content-Type' => JSONAPI::MEDIA_TYPE
+      }
+    assert_equal response.status, 201
+    picture = Picture.find(json_response["data"]["id"])
+    assert_not_nil picture.imageable, "imageable should be present"
+  ensure
+    picture.destroy
+  end
+
+  def test_polymorphic_create_relationship
+    picture = Picture.find(3)
+    original_imageable = picture.imageable
+    assert_nil original_imageable
+
+    patch "/pictures/#{picture.id}/relationships/imageable",
+          {
+            association: 'imageable',
+            data: {
+              type: 'documents',
+              id: '1'
+            }
+          }.to_json,
+          {
+            'Content-Type' => JSONAPI::MEDIA_TYPE
+          }
+    assert_response :no_content
+    picture = Picture.find(3)
+    assert_equal 'Document', picture.imageable.class.to_s
+
+    # restore data
+    picture.imageable = original_imageable
+    picture.save
+  end
+
+  def test_polymorphic_update_relationship
+    picture = Picture.find(1)
+    original_imageable = picture.imageable
+    assert_not_equal 'Document', picture.imageable.class.to_s
+
+    patch "/pictures/#{picture.id}/relationships/imageable",
+          {
+            association: 'imageable',
+            data: {
+              type: 'documents',
+              id: '1'
+            }
+          }.to_json,
+          {
+            'Content-Type' => JSONAPI::MEDIA_TYPE
+          }
+    assert_response :no_content
+    picture = Picture.find(1)
+    assert_equal 'Document', picture.imageable.class.to_s
+
+    # restore data
+    picture.imageable = original_imageable
+    picture.save
+  end
+
+  def test_polymorphic_delete_relationship
+    picture = Picture.find(1)
+    original_imageable = picture.imageable
+    assert original_imageable
+
+    delete "/pictures/#{picture.id}/relationships/imageable",
+           {
+             association: 'imageable'
+           }.to_json,
+           {
+             'Content-Type' => JSONAPI::MEDIA_TYPE
+           }
+    assert_response :no_content
+    picture = Picture.find(1)
+    assert_nil picture.imageable
+
+    # restore data
+    picture.imageable = original_imageable
+    picture.save
+  end
+end