jsonapi-resources 0.4.4 → 0.5.0

data/test/unit/jsonapi_request/jsonapi_request_test.rb

@@ -70,7 +70,7 @@ class JSONAPIRequestTest < ActiveSupport::TestCase
     )
 
     refute request.errors.empty?
-    assert_equal 'iso_currency is not a valid association of expense-entries', request.errors[0].detail
+    assert_equal 'iso_currency is not a valid relationship of expense-entries', request.errors[0].detail
   end
 
   def test_parse_fields_underscored

data/test/unit/operation/operations_processor_test.rb

@@ -99,7 +99,7 @@ class OperationsProcessorTest < Minitest::Test
     assert_equal(Planet.count, count + 3)
   end
 
-  def test_replace_has_one_association
+  def test_replace_to_one_relationship
     op = JSONAPI::OperationsProcessor.new()
 
     saturn = Planet.find(1)
@@ -108,11 +108,11 @@ class OperationsProcessorTest < Minitest::Test
     assert_equal(saturn.planet_type_id, planetoid.id)
 
     operations = [
-      JSONAPI::ReplaceHasOneAssociationOperation.new(
+      JSONAPI::ReplaceToOneRelationshipOperation.new(
         PlanetResource,
         {
           resource_id: saturn.id,
-          association_type: :planet_type,
+          relationship_type: :planet_type,
           key_value: gas_giant.id
         }
       )
@@ -132,11 +132,11 @@ class OperationsProcessorTest < Minitest::Test
 
     # Remove link
     operations = [
-      JSONAPI::ReplaceHasOneAssociationOperation.new(
+      JSONAPI::ReplaceToOneRelationshipOperation.new(
         PlanetResource,
         {
           resource_id: saturn.id,
-          association_type: :planet_type,
+          relationship_type: :planet_type,
           key_value: nil
         }
       )
@@ -151,11 +151,11 @@ class OperationsProcessorTest < Minitest::Test
 
     # Reset
     operations = [
-      JSONAPI::ReplaceHasOneAssociationOperation.new(
+      JSONAPI::ReplaceToOneRelationshipOperation.new(
         PlanetResource,
         {
           resource_id: saturn.id,
-          association_type: :planet_type,
+          relationship_type: :planet_type,
           key_value: 5
         }
       )
@@ -169,7 +169,7 @@ class OperationsProcessorTest < Minitest::Test
     assert_equal(saturn.planet_type_id, 5)
   end
 
-  def test_create_has_many_association
+  def test_create_to_many_relationship
     op = JSONAPI::OperationsProcessor.new()
 
     betax = Planet.find(5)
@@ -185,11 +185,11 @@ class OperationsProcessorTest < Minitest::Test
     betaz.save!
 
     operations = [
-      JSONAPI::CreateHasManyAssociationOperation.new(
+      JSONAPI::CreateToManyRelationshipOperation.new(
         PlanetTypeResource,
         {
           resource_id: gas_giant.id,
-          association_type: :planets,
+          relationship_type: :planets,
           data: [betax.id, betay.id, betaz.id]
         }
       )
@@ -217,7 +217,7 @@ class OperationsProcessorTest < Minitest::Test
     betaz.save!
   end
 
-  def test_replace_has_many_association
+  def test_replace_to_many_relationship
     op = JSONAPI::OperationsProcessor.new()
 
     betax = Planet.find(5)
@@ -233,11 +233,11 @@ class OperationsProcessorTest < Minitest::Test
     betaz.save!
 
     operations = [
-      JSONAPI::ReplaceHasManyAssociationOperation.new(
+      JSONAPI::ReplaceToManyRelationshipOperation.new(
         PlanetTypeResource,
         {
           resource_id: gas_giant.id,
-          association_type: :planets,
+          relationship_type: :planets,
           data: [betax.id, betay.id, betaz.id]
         }
       )
@@ -386,11 +386,11 @@ class OperationsProcessorTest < Minitest::Test
     assert operation_results.has_errors?
   end
 
-  def test_show_association_operation
+  def test_show_relationship_operation
     op = JSONAPI::OperationsProcessor.new
 
     operations = [
-      JSONAPI::ShowAssociationOperation.new(PlanetResource, {parent_key: '1', association_type: :planet_type})
+      JSONAPI::ShowRelationshipOperation.new(PlanetResource, {parent_key: '1', relationship_type: :planet_type})
     ]
 
     request = JSONAPI::Request.new
@@ -403,11 +403,11 @@ class OperationsProcessorTest < Minitest::Test
     refute operation_results.has_errors?
   end
 
-  def test_show_association_operation_error
+  def test_show_relationship_operation_error
     op = JSONAPI::OperationsProcessor.new
 
     operations = [
-      JSONAPI::ShowAssociationOperation.new(PlanetResource, {parent_key: '145', association_type: :planet_type})
+      JSONAPI::ShowRelationshipOperation.new(PlanetResource, {parent_key: '145', relationship_type: :planet_type})
     ]
 
     request = JSONAPI::Request.new
@@ -428,7 +428,7 @@ class OperationsProcessorTest < Minitest::Test
                                                 {
                                                   source_klass: PlanetResource,
                                                   source_id: '1',
-                                                  association_type: :planet_type})
+                                                  relationship_type: :planet_type})
     ]
 
     request = JSONAPI::Request.new
@@ -449,7 +449,7 @@ class OperationsProcessorTest < Minitest::Test
                                                 {
                                                   source_klass: PlanetResource,
                                                   source_id: '145',
-                                                  association_type: :planet_type})
+                                                  relationship_type: :planet_type})
     ]
 
     request = JSONAPI::Request.new
@@ -470,7 +470,7 @@ class OperationsProcessorTest < Minitest::Test
                                                 {
                                                   source_klass: PlanetResource,
                                                   source_id: '1',
-                                                  association_type: :moons})
+                                                  relationship_type: :moons})
     ]
 
     request = JSONAPI::Request.new
@@ -491,7 +491,7 @@ class OperationsProcessorTest < Minitest::Test
                                                 {
                                                   source_klass: PlanetResource,
                                                   source_id: '145',
-                                                  association_type: :moons})
+                                                  relationship_type: :moons})
     ]
 
     request = JSONAPI::Request.new

data/test/unit/resource/resource_test.rb

@@ -18,7 +18,7 @@ class CatResource < JSONAPI::Resource
 end
 
 class PersonWithCustomRecordsForResource < PersonResource
-  def records_for(association_name, context)
+  def records_for(relationship_name, context)
     :records_for
   end
 end
@@ -34,7 +34,7 @@ end
 
 class PersonWithCustomRecordsForErrorResource < PersonResource
   class AuthorizationError < StandardError; end
-  def records_for(association_name, context)
+  def records_for(relationship_name, context)
     raise AuthorizationError
   end
 end
@@ -62,10 +62,10 @@ class ResourceTest < ActiveSupport::TestCase
     assert_equal(attrs.keys.size, 3)
   end
 
-  def test_class_associations
-    associations = CatResource._associations
-    assert_kind_of(Hash, associations)
-    assert_equal(associations.size, 2)
+  def test_class_relationships
+    relationships = CatResource._relationships
+    assert_kind_of(Hash, relationships)
+    assert_equal(relationships.size, 2)
   end
 
   def test_find_with_customized_base_records
@@ -93,28 +93,28 @@ class ResourceTest < ActiveSupport::TestCase
     end
   end
 
-  def test_records_for_meta_method_for_has_one
+  def test_records_for_meta_method_for_to_one
     author = Person.find(1)
     author.update! preferences: Preferences.first
     author_resource = PersonWithCustomRecordsForRelationshipsResource.new(author)
     assert_equal(author_resource.record_for_preferences, :record_for_preferences)
   end
 
-  def test_records_for_meta_method_for_has_one_calling_records_for
+  def test_records_for_meta_method_for_to_one_calling_records_for
     author = Person.find(1)
     author.update! preferences: Preferences.first
     author_resource = PersonWithCustomRecordsForResource.new(author)
     assert_equal(author_resource.record_for_preferences, :records_for)
   end
 
-  def test_associated_records_meta_method_for_has_many
+  def test_associated_records_meta_method_for_to_many
     author = Person.find(1)
     author.posts << Post.find(1)
     author_resource = PersonWithCustomRecordsForRelationshipsResource.new(author)
     assert_equal(author_resource.records_for_posts, :records_for_posts)
   end
 
-  def test_associated_records_meta_method_for_has_many_calling_records_for
+  def test_associated_records_meta_method_for_to_many_calling_records_for
     author = Person.find(1)
     author.posts << Post.find(1)
     author_resource = PersonWithCustomRecordsForResource.new(author)
@@ -150,7 +150,7 @@ class ResourceTest < ActiveSupport::TestCase
     end
   end
 
-  def test_has_many_association_filters
+  def test_to_many_relationship_filters
     post_resource = PostResource.new(Post.find(1))
     comments = post_resource.comments
     assert_equal(2, comments.size)
@@ -177,7 +177,7 @@ class ResourceTest < ActiveSupport::TestCase
     end
   end
 
-  def test_has_many_association_sorts
+  def test_to_many_relationship_sorts
     post_resource = PostResource.new(Post.find(1))
     comment_ids = post_resource.comments.map{|c| c.model.id }
     assert_equal [1,2], comment_ids
@@ -204,7 +204,7 @@ class ResourceTest < ActiveSupport::TestCase
     end
   end
 
-  def test_has_many_association_pagination
+  def test_to_many_relationship_pagination
     post_resource = PostResource.new(Post.find(1))
     comments = post_resource.comments
     assert_equal 2, comments.size

data/test/unit/serializer/link_builder_test.rb

@@ -0,0 +1,183 @@
+require File.expand_path('../../../test_helper', __FILE__)
+require 'jsonapi-resources'
+require 'json'
+
+class LinkBuilderTest < ActionDispatch::IntegrationTest
+  def setup
+    @base_url        = "http://example.com"
+    @route_formatter = JSONAPI.configuration.route_formatter
+    @steve           = Person.create(name: "Steve Rogers", date_joined: "1941-03-01")
+  end
+
+  def test_engine_boolean
+    assert JSONAPI::LinkBuilder.new(
+      primary_resource_klass: MyEngine::Api::V1::PersonResource
+    ).engine?, "MyEngine should be considered an Engine"
+
+    refute JSONAPI::LinkBuilder.new(
+      primary_resource_klass: Api::V1::PersonResource
+    ).engine?, "Api shouldn't be considered an Engine"
+  end
+
+  def test_engine_name
+    assert_equal MyEngine::Engine,
+      JSONAPI::LinkBuilder.new(
+        primary_resource_klass: MyEngine::Api::V1::PersonResource
+    ).engine_name
+
+    assert_equal nil,
+      JSONAPI::LinkBuilder.new(
+        primary_resource_klass: Api::V1::PersonResource
+    ).engine_name
+  end
+
+  def test_self_link_regular_app
+    primary_resource_klass = Api::V1::PersonResource
+
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: primary_resource_klass,
+    }
+
+    builder = JSONAPI::LinkBuilder.new(config)
+    source  = primary_resource_klass.new(@steve)
+    expected_link = "#{ @base_url }/api/v1/people/#{ source.id }"
+
+    assert_equal expected_link, builder.self_link(source)
+  end
+
+  def test_self_link_with_engine_app
+    primary_resource_klass = MyEngine::Api::V1::PersonResource
+
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: primary_resource_klass,
+    }
+
+    builder = JSONAPI::LinkBuilder.new(config)
+    source  = primary_resource_klass.new(@steve)
+    expected_link = "#{ @base_url }/boomshaka/api/v1/people/#{ source.id }"
+
+    assert_equal expected_link, builder.self_link(source)
+  end
+
+  def test_primary_resources_url_for_regular_app
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: Api::V1::PersonResource,
+    }
+
+    builder = JSONAPI::LinkBuilder.new(config)
+    expected_link = "#{ @base_url }/api/v1/people"
+
+    assert_equal expected_link, builder.primary_resources_url
+  end
+
+  def test_primary_resources_url_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: MyEngine::Api::V1::PersonResource
+    }
+
+    builder = JSONAPI::LinkBuilder.new(config)
+    expected_link = "#{ @base_url }/boomshaka/api/v1/people"
+
+    assert_equal expected_link, builder.primary_resources_url
+  end
+
+  def test_relationships_self_link_for_regular_app
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: Api::V1::PersonResource
+    }
+
+    builder       = JSONAPI::LinkBuilder.new(config)
+    source        = Api::V1::PersonResource.new(@steve)
+    relationship  = JSONAPI::Relationship::ToMany.new("posts", {})
+    expected_link = "#{ @base_url }/api/v1/people/#{ @steve.id }/relationships/posts"
+
+    assert_equal expected_link,
+      builder.relationships_self_link(source, relationship)
+  end
+
+  def test_relationships_self_link_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: MyEngine::Api::V1::PersonResource
+    }
+
+    builder       = JSONAPI::LinkBuilder.new(config)
+    source        = MyEngine::Api::V1::PersonResource.new(@steve)
+    relationship  = JSONAPI::Relationship::ToMany.new("posts", {})
+    expected_link = "#{ @base_url }/boomshaka/api/v1/people/#{ @steve.id }/relationships/posts"
+
+    assert_equal expected_link,
+      builder.relationships_self_link(source, relationship)
+  end
+
+  def test_relationships_related_link_for_regular_app
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: Api::V1::PersonResource
+    }
+
+    builder       = JSONAPI::LinkBuilder.new(config)
+    source        = Api::V1::PersonResource.new(@steve)
+    relationship  = JSONAPI::Relationship::ToMany.new("posts", {})
+    expected_link = "#{ @base_url }/api/v1/people/#{ @steve.id }/posts"
+
+    assert_equal expected_link,
+      builder.relationships_related_link(source, relationship)
+  end
+
+  def test_relationships_related_link_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: MyEngine::Api::V1::PersonResource
+    }
+
+    builder       = JSONAPI::LinkBuilder.new(config)
+    source        = MyEngine::Api::V1::PersonResource.new(@steve)
+    relationship  = JSONAPI::Relationship::ToMany.new("posts", {})
+    expected_link = "#{ @base_url }/boomshaka/api/v1/people/#{ @steve.id }/posts"
+
+    assert_equal expected_link,
+      builder.relationships_related_link(source, relationship)
+  end
+
+  def test_query_link_for_regular_app
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: Api::V1::PersonResource
+    }
+
+    query         = { page: { offset: 0, limit: 12 } }
+    builder       = JSONAPI::LinkBuilder.new(config)
+    expected_link = "#{ @base_url }/api/v1/people?page%5Blimit%5D=12&page%5Boffset%5D=0"
+
+    assert_equal expected_link, builder.query_link(query)
+  end
+
+  def test_query_link_for_engine
+    config = {
+      base_url: @base_url,
+      route_formatter: @route_formatter,
+      primary_resource_klass: MyEngine::Api::V1::PersonResource
+    }
+
+    query         = { page: { offset: 0, limit: 12 } }
+    builder       = JSONAPI::LinkBuilder.new(config)
+    expected_link = "#{ @base_url }/boomshaka/api/v1/people?page%5Blimit%5D=12&page%5Boffset%5D=0"
+
+    assert_equal expected_link, builder.query_link(query)
+  end
+end

data/test/unit/serializer/polymorphic_serializer_test.rb

@@ -15,15 +15,15 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
     JSONAPI.configuration.json_key_format = :underscored_key
   end
 
-  def test_polymorphic_association
-    associations = PictureResource._associations
-    imageable = associations[:imageable]
+  def test_polymorphic_relationship
+    relationships = PictureResource._relationships
+    imageable = relationships[:imageable]
 
-    assert_equal associations.size, 1
+    assert_equal relationships.size, 1
     assert imageable.polymorphic?
   end
 
-  def test_polymorphic_has_many_serialization
+  def test_sti_polymorphic_to_many_serialization
     serialized_data = JSONAPI::ResourceSerializer.new(
       PersonResource,
       include: %w(vehicles)
@@ -31,94 +31,93 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
 
     assert_hash_equals(
       {
-        :data => {
-          "id" => "1",
-          "type" => "people",
-          "links" => {
-            :self => "/people/1"
+        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"
+          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"
+          relationships: {
+            comments: {
+              links: {
+                self: '/people/1/relationships/comments',
+                related: '/people/1/comments'
               }
             },
-            "posts" => {
-              :links => {
-                :self => "/people/1/relationships/posts",
-                :related => "/people/1/posts"
+            posts: {
+              links: {
+                self: '/people/1/relationships/posts',
+                related: '/people/1/posts'
               }
             },
-            "vehicles" => {
-              :links => {
-                :self => "/people/1/relationships/vehicles",
-                :related => "/people/1/vehicles"
+            vehicles: {
+              links: {
+                self: '/people/1/relationships/vehicles',
+                related: '/people/1/vehicles'
               },
               :data => [
-                { :type => "cars", :id=> "1" },
-                { :type => "boats", :id=>"2" }
+                { type: 'cars', id: '1' },
+                { type: 'boats', id: '2' }
               ]
             },
-            "preferences" => {
-              :links => {
-                :self => "/people/1/relationships/preferences",
-                :related => "/people/1/preferences"
-              },
-              :data => {
-                :type => "preferences",
-                :id=>"1"
+            preferences: {
+              links: {
+                self: '/people/1/relationships/preferences',
+                related: '/people/1/preferences'
               }
             },
-            "hairCut" => {
-              :links => {
-                :self => "/people/1/relationships/hairCut",
-                :related => "/people/1/hairCut"
-              },
-              :data => nil
+            hairCut: {
+              links: {
+                self: '/people/1/relationships/hairCut',
+                related: '/people/1/hairCut'
+              }
             }
           }
         },
-        :included => [
+        included: [
           {
-            "id" => "1",
-            "type" => "cars",
-            "links" => {
-              :self => "/cars/1"
+            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"
+            attributes: {
+              make: 'Mazda',
+              vehicleModel: 'Miata MX5',
+              driveLayout: 'Front Engine RWD',
+              serialNumber: '32432adfsfdysua'
+            },
+            relationships: {
+              person: {
+                links: {
+                  self: '/cars/1/relationships/person',
+                  related: '/cars/1/person'
                 }
               }
             }
           },
           {
-            "id" => "2",
-            "type" => "boats",
-            "links" => {
-              :self => "/boats/2"
+            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"
+            attributes: {
+              make: 'Chris-Craft',
+              vehicleModel: 'Launch 20',
+              lengthAtWaterLine: '15.5ft',
+              serialNumber: '434253JJJSD'
+            },
+            relationships: {
+              person: {
+                links: {
+                  self: '/boats/2/relationships/person',
+                  related: '/boats/2/person'
                 }
               }
             }
@@ -129,7 +128,7 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
     )
   end
 
-  def test_polymorphic_has_one_serialization
+  def test_polymorphic_to_one_serialization
     serialized_data = JSONAPI::ResourceSerializer.new(
       PictureResource,
       include: %w(imageable)
@@ -318,7 +317,7 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
 
     patch "/pictures/#{picture.id}/relationships/imageable",
           {
-            association: 'imageable',
+            relationship: 'imageable',
             data: {
               type: 'documents',
               id: '1'
@@ -343,7 +342,7 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
 
     patch "/pictures/#{picture.id}/relationships/imageable",
           {
-            association: 'imageable',
+            relationship: 'imageable',
             data: {
               type: 'documents',
               id: '1'
@@ -368,7 +367,7 @@ class PolymorphismTest < ActionDispatch::IntegrationTest
 
     delete "/pictures/#{picture.id}/relationships/imageable",
            {
-             association: 'imageable'
+             relationship: 'imageable'
            }.to_json,
            {
              'Content-Type' => JSONAPI::MEDIA_TYPE