Merge pull request #339 from localytics/uuid_primary_key

update to support non-standard primary key has many relationships

Author: lgebhardt

lib/jsonapi/resource.rb

@@ -596,7 +596,7 @@ def _primary_key
       end
 
       def _as_parent_key
-        @_as_parent_key ||= "#{_type.to_s.singularize}_#{_primary_key}"
+        @_as_parent_key ||= "#{_type.to_s.singularize}_id"
       end
 
       def _allowed_filters
@@ -744,7 +744,7 @@ def _add_relationship(klass, *attrs)
 
               sort_criteria =  options.fetch(:sort_criteria, {})
               unless sort_criteria.nil? || sort_criteria.empty?
-                order_options = self.class.construct_order_options(sort_criteria)
+                order_options = relationship.resource_klass.construct_order_options(sort_criteria)
                 records = resource_klass.apply_sort(records, order_options)
               end
 

test/controllers/controller_test.rb

@@ -2634,3 +2634,64 @@ def test_save_model_callbacks_fail
     assert_match /Save failed or was cancelled/, json_response['errors'][0]['detail']
   end
 end
+
+class Api::V1::MoonsControllerTest < ActionController::TestCase
+   def test_get_related_resource
+      get :get_related_resource, {crater_id: 'S56D', relationship: 'moon', source: "api/v1/craters"}
+      assert_response :success
+      assert_hash_equals json_response,
+                              {
+                                data: {
+                                  id: "1",
+                                  type: "moons",
+                                  links: {self: "http://test.host/moons/1"},
+                                  attributes: {name: "Titan", description: "Best known of the Saturn moons."},
+                                  relationships: {
+                                    planet: {links: {self: "http://test.host/moons/1/relationships/planet", related: "http://test.host/moons/1/planet"}},
+                                    craters: {links: {self: "http://test.host/moons/1/relationships/craters", related: "http://test.host/moons/1/craters"}}}
+                                  }
+                                }
+
+   end
+end
+
+class Api::V1::CratersControllerTest < ActionController::TestCase
+  def test_show_single
+    get :show, {id: 'S56D'}
+    assert_response :success
+    assert json_response['data'].is_a?(Hash)
+    assert_equal 'S56D', json_response['data']['attributes']['code']
+    assert_equal 'Very large crater', json_response['data']['attributes']['description']
+    assert_nil json_response['included']
+  end
+
+  def test_get_related_resources
+    get :get_related_resources, {moon_id: '1', relationship: 'craters', source: "api/v1/moons"}
+    assert_response :success
+    assert_hash_equals json_response,
+                      {
+                        data: [
+                          {id:"A4D3",
+                           type:"craters",
+                           links:{self: "http://test.host/craters/A4D3"},
+                           attributes:{code: "A4D3", description: "Small crater"},
+                           relationships:{moon: {links: {self: "http://test.host/craters/A4D3/relationships/moon", related: "http://test.host/craters/A4D3/moon"}}}
+                          },
+                          {id: "S56D",
+                           type: "craters",
+                           links:{self: "http://test.host/craters/S56D"},
+                           attributes:{code: "S56D", description: "Very large crater"},
+                           relationships:{moon: {links: {self: "http://test.host/craters/S56D/relationships/moon", related: "http://test.host/craters/S56D/moon"}}}
+                          }
+                        ]
+                      }
+  end
+
+  def test_show_relationship
+    get :show_relationship, {crater_id: 'S56D', relationship: 'moon'}
+
+    assert_response :success
+    assert_equal "moons", json_response['data']['type']
+    assert_equal "1", json_response['data']['id']
+  end
+end

test/fixtures/active_record.rb

@@ -92,6 +92,12 @@
     t.integer :planet_id
   end
 
+  create_table :craters, id: false, force: true do |t|
+    t.string  :code
+    t.string  :description
+    t.integer :moon_id
+  end
+
   create_table :preferences, force: true do |t|
     t.integer :person_id
     t.boolean :advanced_mode, default: false
@@ -281,6 +287,14 @@ class PlanetType < ActiveRecord::Base
 
 class Moon < ActiveRecord::Base
   belongs_to :planet
+
+  has_many :craters
+end
+
+class Crater < ActiveRecord::Base
+  self.primary_key = :code
+
+  belongs_to :moon
 end
 
 class Preferences < ActiveRecord::Base
@@ -360,7 +374,7 @@ def remove(id)
   end
 end
 
-class CustomerOrder < ActiveRecord::Base
+class Customer < ActiveRecord::Base
   has_many :purchase_orders
 end
 
@@ -524,6 +538,9 @@ class PlanetTypesController < JSONAPI::ResourceController
     class MoonsController < JSONAPI::ResourceController
     end
 
+    class CratersController < JSONAPI::ResourceController
+    end
+
     class LikesController < JSONAPI::ResourceController
     end
   end
@@ -861,6 +878,18 @@ class MoonResource < JSONAPI::Resource
   attribute :description
 
   has_one :planet
+  has_many :craters
+end
+
+class CraterResource < JSONAPI::Resource
+  attribute :code
+  attribute :description
+
+  has_one :moon
+
+  def self.verify_key(key, context = nil)
+    key && String(key)
+  end
 end
 
 class PreferencesResource < JSONAPI::Resource
@@ -952,6 +981,7 @@ def subject
     PlanetResource = PlanetResource.dup
     PlanetTypeResource = PlanetTypeResource.dup
     MoonResource = MoonResource.dup
+    CraterResource = CraterResource.dup
     PreferencesResource = PreferencesResource.dup
     EmployeeResource = EmployeeResource.dup
     FriendResource = FriendResource.dup
@@ -1226,6 +1256,8 @@ class BadlyNamedAttributesResource < JSONAPI::Resource
                        description: 'Saturn is the sixth planet from the Sun and the second largest planet in the Solar System, after Jupiter.',
                        planet_type_id: planetoid.id)
 titan = Moon.create(name:'Titan', description: 'Best known of the Saturn moons.', planet_id: saturn.id)
+crater1 = Crater.create(code:'S56D', description: 'Very large crater', moon_id: titan.id)
+crater2 = Crater.create(code:'A4D3', description: 'Small crater', moon_id: titan.id)
 makemake = Planet.create(name: 'Makemake', description: 'A small planetoid in the Kuiperbelt.', planet_type_id: planetoid.id)
 uranus = Planet.create(name: 'Uranus', description: 'Insert adolescent jokes here.', planet_type_id: gas_giant.id)
 jupiter = Planet.create(name: 'Jupiter', description: 'A gas giant.', planet_type_id: gas_giant.id)

test/test_helper.rb

@@ -110,6 +110,7 @@ def show_queries
   jsonapi_resources :planets
   jsonapi_resources :planet_types
   jsonapi_resources :moons
+  jsonapi_resources :craters
   jsonapi_resources :preferences
   jsonapi_resources :facts
   jsonapi_resources :categories
@@ -130,6 +131,7 @@ def show_queries
       jsonapi_resources :planets
       jsonapi_resources :planet_types
       jsonapi_resources :moons
+      jsonapi_resources :craters
       jsonapi_resources :preferences
       jsonapi_resources :likes
     end