spyke 4.0.1 → 4.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 89f544498e8d5c745ad7255f701ff8403d9199e9
-  data.tar.gz: cdda57ef83c4c6b3efbd7d7bcee9bc73332b2212
+  metadata.gz: 577ad0ebdd60714a718b17b86a679185f8f9c636
+  data.tar.gz: b83cf403640604c5222fdbda68bce4628dc97b9b
 SHA512:
-  metadata.gz: 5ea490a4c53f399e4b26b4365981b8018d9d4e87e0ed6cc56285e088991eace6d727a6ec81768b6266570a0f53fb77e1b477e336dfe8b1f0be479ad644c4652f
-  data.tar.gz: eb126a85144b37a05de296901d40b0ec1e153e519555a6e470d1751133652f8e8c87d1993403799aee88942556c0119f5f71e942952a12882b5847ad3d648139
+  metadata.gz: baee2b01c8e6c987c47fad6c7ec0034c5cf438e669f9f5c2b2e65a35678d6387a909fe980dc4f7b10e7f8ca5c58ac0b6206cebb7a671132097d0aada67f252ce
+  data.tar.gz: b02433383758e4c430749baf650aceaa005eef0e7df9f7f2bf5df07a0049b27e4ae98e58f3043c1bf2317bba2512ad06849f52771af077c52910d2925dfbd143

data/lib/spyke/associations/belongs_to.rb

@@ -3,8 +3,8 @@ module Spyke
     class BelongsTo < Association
       def initialize(*args)
         super
-        @options.reverse_merge!(uri: "#{@name.to_s.pluralize}/:id", foreign_key: "#{klass.model_name.element}_id")
-        @params[:id] = parent.try(foreign_key)
+        @options.reverse_merge!(uri: "#{@name.to_s.pluralize}/:#{primary_key}", foreign_key: "#{klass.model_name.element}_id")
+        @params[primary_key] = parent.try(foreign_key)
       end
     end
   end

data/lib/spyke/associations/has_many.rb

@@ -3,7 +3,7 @@ module Spyke
     class HasMany < Association
       def initialize(*args)
         super
-        @options.reverse_merge!(uri: "#{parent.class.model_name.element.pluralize}/:#{foreign_key}/#{@name}/(:id)")
+        @options.reverse_merge!(uri: "#{parent_path}/:#{foreign_key}/#{@name}/(:#{primary_key})")
         @params[foreign_key] = parent.id
       end
 
@@ -22,6 +22,10 @@ module Spyke
 
       private
 
+        def parent_path
+          parent.class.model_name.element.pluralize
+        end
+
         def combine_with_existing(incoming)
           return incoming unless primary_keys_present_in_existing?
           combined = embedded_attributes + incoming
@@ -35,11 +39,11 @@ module Spyke
         end
 
         def group_by_primary_key(array)
-          array.group_by { |h| h.with_indifferent_access[:id].to_s }
+          array.group_by { |h| h.with_indifferent_access[primary_key].to_s }
         end
 
         def primary_keys_present_in_existing?
-          embedded_attributes && embedded_attributes.any? { |attr| attr.has_key?('id') }
+          embedded_attributes && embedded_attributes.any? { |attr| attr.has_key?(primary_key) }
         end
 
         def clear_existing!

data/lib/spyke/attribute_assignment.rb

@@ -42,11 +42,11 @@ module Spyke
     end
 
     def id
-      attributes[:id]
+      attributes[primary_key]
     end
 
     def id=(value)
-      attributes[:id] = value if value.present?
+      attributes[primary_key] = value if value.present?
     end
 
     def hash
@@ -69,11 +69,18 @@ module Spyke
     private
 
       def use_setters(attributes)
+        # Set id attribute directly if using a custom primary key alongside an attribute named "id" to avoid clobbering
+        set_attribute :id, attributes.delete(:id) if conflicting_ids?(attributes)
+
         attributes.each do |key, value|
           send "#{key}=", value
         end
       end
 
+      def conflicting_ids?(attributes)
+        primary_key != :id && attributes.key?(:id) && attributes.key?(primary_key)
+      end
+
       def method_missing(name, *args, &block)
         case
         when association?(name) then association(name).load
@@ -125,7 +132,7 @@ module Spyke
       end
 
       def inspect_attributes
-        attributes.except(:id).map { |k, v| "#{k}: #{v.inspect}" }.join(' ')
+        attributes.except(primary_key).map { |k, v| "#{k}: #{v.inspect}" }.join(' ')
       end
   end
 end

data/lib/spyke/http.rb

@@ -72,7 +72,7 @@ module Spyke
         end
 
         def default_uri
-          "#{model_name.element.pluralize}/(:id)"
+          "#{model_name.element.pluralize}/(:#{primary_key})"
         end
     end
 

data/lib/spyke/orm.rb

@@ -10,6 +10,9 @@ module Spyke
 
       class_attribute :callback_methods, instance_accessor: false
       self.callback_methods = { create: :post, update: :put }.freeze
+
+      class_attribute :primary_key
+      self.primary_key = :id
     end
 
     module ClassMethods
@@ -24,7 +27,7 @@ module Spyke
 
       def find(id)
         raise ResourceNotFound if id.blank?
-        where(id: id).find_one || raise(ResourceNotFound)
+        where(primary_key => id).find_one || raise(ResourceNotFound)
       end
 
       def fetch
@@ -38,7 +41,7 @@ module Spyke
       end
 
       def destroy(id = nil)
-        new(id: id).destroy
+        new(primary_key => id).destroy
       end
     end
 

data/lib/spyke/version.rb

@@ -1,3 +1,3 @@
 module Spyke
-  VERSION = '4.0.1'
+  VERSION = '4.1.0'
 end

data/test/associations_test.rb

@@ -307,14 +307,14 @@ module Spyke
       assert_equal %w{ flavor }, recipe.groups.map(&:title)
     end
 
-    def test_nested_attributes_merging_with_existing_when_ids_present?
+    def test_nested_attributes_merging_with_existing_when_ids_present
       recipe = Recipe.new(groups_attributes: [{ id: 1, title: 'starter', description: 'nice' }, { id: 2, title: 'sauce', description: 'spicy' }])
       recipe.attributes = { groups_attributes: [{ 'id' => '2', 'title' => 'flavor' }, { 'title' => 'spices', 'description' => 'lovely' }, { 'title' => 'sweetener', 'description' => 'sweet' }] }
       assert_equal %w{ starter flavor spices sweetener }, recipe.groups.map(&:title)
       assert_equal %w{ nice spicy lovely sweet }, recipe.groups.map(&:description)
     end
 
-    def test_nested_attributes_appending_to_existing_when_ids_present?
+    def test_nested_attributes_appending_to_existing_when_ids_present
       recipe = Recipe.new(groups_attributes: [{ id: 1, title: 'starter' }, { id: 2, title: 'sauce' }])
       recipe.attributes = { groups_attributes: [{ title: 'flavor' }] }
       assert_equal %w{ starter sauce flavor }, recipe.groups.map(&:title)
@@ -428,5 +428,27 @@ module Spyke
         Cookbook::Tip.new.votes
       end
     end
+
+    def test_custom_primary_key_for_belongs_to
+      comment_endpoint = stub_request(:get, 'http://sushi.com/comments/1').to_return_json(result: { user_id: 1 })
+      user_endpoint = stub_request(:get, 'http://sushi.com/users/1').to_return_json(result: { id: 2 })
+      user = Comment.find(1).user
+      assert_equal 2, user.id
+      assert_requested comment_endpoint
+      assert_requested user_endpoint
+    end
+
+    def test_custom_primary_key_for_has_many
+      stub_request(:get, 'http://sushi.com/comments/1').to_return_json(result: { users: [{ id: 1 }] })
+      comment = Comment.find(1)
+      assert_equal 1, comment.users.first.id
+    end
+
+    def test_custom_primary_key_with_nested_attributes
+      comment = Comment.new(users_attributes: [{ uuid: 1, name: "user_1" }])
+      comment.attributes = { users_attributes: [{ uuid: 1, name: "user_1_new_name"}] }
+      assert_equal %w{ user_1_new_name }, comment.users.map(&:name)
+      assert_equal [1], comment.users.map(&:id)
+    end
   end
 end

data/test/attributes_test.rb

@@ -139,7 +139,7 @@ module Spyke
       recipe = Recipe.new
       assert_equal '#<Recipe(recipes/(:id)) id: nil >', recipe.inspect
       user = Recipe.new.build_user
-      assert_equal '#<User(users/:id) id: nil >', user.inspect
+      assert_equal '#<User(users/:uuid) id: nil >', user.inspect
       group = Recipe.new.groups.build
       assert_equal '#<Group(recipes/:recipe_id/groups/(:id)) id: nil recipe_id: nil>', group.inspect
     end

data/test/orm_test.rb

@@ -168,5 +168,33 @@ module Spyke
 
       Spyke::Base.connection.url_prefix = previous
     end
+
+    def test_custom_primary_key_on_collection
+      endpoint = stub_request(:get, 'http://sushi.com/users').to_return_json(result: [{ uuid: 1 }])
+      user = User.all.first
+      assert_requested endpoint
+      assert_equal 1, user.id
+      assert_equal 1, user.uuid
+    end
+
+    def test_custom_primary_key_and_id_are_the_same
+      endpoint = stub_request(:get, 'http://sushi.com/users').to_return_json(result: [{ uuid: 1 }])
+      user = User.all.first
+      assert_requested endpoint
+      assert_equal 1, user.id
+      assert_equal 1, user.uuid
+      assert_equal({ "uuid" => 1 }, user.attributes)
+    end
+
+    def test_custom_primary_key_with_response_that_also_has_id_attribute
+      endpoint = stub_request(:get, 'http://sushi.com/users').to_return_json(result: [{ uuid: 1, id: 42 }])
+      user = User.all.to_a.first
+      assert_requested endpoint
+
+      assert_equal 1, user.id
+      assert_equal 1, user.uuid
+      assert_equal 1, user[:uuid]
+      assert_equal 42, user[:id]
+    end
   end
 end

data/test/support/fixtures.rb

@@ -94,6 +94,7 @@ class Ingredient < Spyke::Base
 end
 
 class User < Spyke::Base
+  self.primary_key = :uuid
   has_many :recipes
 end
 
@@ -102,7 +103,10 @@ class Photo < Spyke::Base
 end
 
 class Comment < Spyke::Base
+  belongs_to :user
+  has_many :users
   scope :approved, -> { where(comment_approved: true) }
+  accepts_nested_attributes_for :users
 end
 
 class OtherApi < Spyke::Base

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: spyke
 version: !ruby/object:Gem::Version
-  version: 4.0.1
+  version: 4.1.0
 platform: ruby
 authors:
 - Jens Balvig
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-10-30 00:00:00.000000000 Z
+date: 2016-06-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -334,3 +334,4 @@ test_files:
 - test/support/fixtures.rb
 - test/support/webmock.rb
 - test/test_helper.rb
+has_rdoc: