her 0.5.3 → 0.5.4

data/lib/her/version.rb

@@ -1,3 +1,3 @@
 module Her
-  VERSION = "0.5.3"
+  VERSION = "0.5.4"
 end

data/spec/model/attributes_spec.rb

@@ -0,0 +1,139 @@
+# encoding: utf-8
+require File.join(File.dirname(__FILE__), "../spec_helper.rb")
+
+describe Her::Model::Attributes do
+  context "mapping data to Ruby objects" do
+    before { spawn_model "Foo::User" }
+
+    it "handles new resource" do
+      @new_user = Foo::User.new(:fullname => "Tobias Fünke")
+      @new_user.new?.should be_true
+      @new_user.fullname.should == "Tobias Fünke"
+    end
+
+    it "accepts new resource with strings as hash keys" do
+      @new_user = Foo::User.new('fullname' => "Tobias Fünke")
+      @new_user.fullname.should == "Tobias Fünke"
+    end
+
+    it "handles method missing for getter" do
+      @new_user = Foo::User.new(:fullname => 'Mayonegg')
+      lambda { @new_user.unknown_method_for_a_user }.should raise_error(NoMethodError)
+      expect { @new_user.fullname }.to_not raise_error(NoMethodError)
+    end
+
+    it "handles method missing for setter" do
+      @new_user = Foo::User.new
+      expect { @new_user.fullname = "Tobias Fünke" }.to_not raise_error(NoMethodError)
+    end
+
+    it "handles method missing for query" do
+      @new_user = Foo::User.new
+      expect { @new_user.fullname? }.to_not raise_error(NoMethodError)
+    end
+
+    it "handles respond_to for getter" do
+      @new_user = Foo::User.new(:fullname => 'Mayonegg')
+      @new_user.should_not respond_to(:unknown_method_for_a_user)
+      @new_user.should respond_to(:fullname)
+    end
+
+    it "handles respond_to for setter" do
+      @new_user = Foo::User.new
+      @new_user.should respond_to(:fullname=)
+    end
+
+    it "handles respond_to for query" do
+      @new_user = Foo::User.new
+      @new_user.should respond_to(:fullname?)
+    end
+
+    it "handles has_data? for getter" do
+      @new_user = Foo::User.new(:fullname => 'Mayonegg')
+      @new_user.should_not have_data(:unknown_method_for_a_user)
+      @new_user.should have_data(:fullname)
+    end
+
+    it "handles get_data for getter" do
+      @new_user = Foo::User.new(:fullname => 'Mayonegg')
+      @new_user.get_data(:unknown_method_for_a_user).should be_nil
+      @new_user.get_data(:fullname).should == 'Mayonegg'
+    end
+  end
+
+
+  context "assigning new resource data" do
+    before do
+      spawn_model "Foo::User"
+      @user = Foo::User.new(:active => false)
+    end
+
+    it "handles data update through #assign_attributes" do
+      @user.assign_attributes :active => true
+      @user.should be_active
+    end
+  end
+
+  context "checking resource equality" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.get("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke" }.to_json] }
+          stub.get("/users/2") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
+          stub.get("/admins/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke" }.to_json] }
+        end
+      end
+
+      spawn_model "Foo::User"
+      spawn_model "Foo::Admin"
+    end
+
+    let(:user) { Foo::User.find(1) }
+
+    it "returns true for the exact same object" do
+      user.should == user
+    end
+
+    it "returns true for the same resource via find" do
+      user.should == Foo::User.find(1)
+    end
+
+    it "returns true for the same class with identical data" do
+      user.should == Foo::User.new(:id => 1, :fullname => "Lindsay Fünke")
+    end
+
+    it "returns true for a different resource with the same data" do
+      user.should == Foo::Admin.find(1)
+    end
+
+    it "returns false for the same class with different data" do
+      user.should_not == Foo::User.new(:id => 2, :fullname => "Tobias Fünke")
+    end
+
+    it "returns false for a non-resource with the same data" do
+      fake_user = stub(:data => { :id => 1, :fullname => "Lindsay Fünke" })
+      user.should_not == fake_user
+    end
+
+    it "delegates eql? to ==" do
+      other = Object.new
+      user.should_receive(:==).with(other).and_return(true)
+      user.eql?(other).should be_true
+    end
+
+    it "treats equal resources as equal for Array#uniq" do
+      user2 = Foo::User.find(1)
+      [user, user2].uniq.should == [user]
+    end
+
+    it "treats equal resources as equal for hash keys" do
+      Foo::User.find(1)
+      hash = { user => true }
+      hash[Foo::User.find(1)] = false
+      hash.size.should == 1
+      hash.should == { user => false }
+    end
+  end
+end

data/spec/model/dirty_spec.rb

@@ -2,4 +2,44 @@
 require File.join(File.dirname(__FILE__), "../spec_helper.rb")
 
 describe "Her::Model and ActiveModel::Dirty" do
+  context "checking dirty attributes" do
+    before do
+      Her::API.setup :url => "https://api.example.com" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.get("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke" }.to_json] }
+          stub.put("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
+          stub.post("/users") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
+        end
+      end
+
+      spawn_model "Foo::User" do
+        attributes :fullname, :email
+      end
+    end
+
+    context "for existing resource" do
+      it "tracks dirty attributes" do
+        user = Foo::User.find(1)
+        user.fullname = "Tobias Fünke"
+        user.fullname_changed?.should be_true
+        user.email_changed?.should be_false
+        user.should be_changed
+        user.save
+        user.should_not be_changed
+      end
+    end
+
+    context "for new resource" do
+      it "tracks dirty attributes" do
+        user = Foo::User.new
+        user.fullname = "Tobias Fünke"
+        user.fullname_changed?.should be_true
+        user.should be_changed
+        user.save
+        user.should_not be_changed
+      end
+    end
+  end
 end

data/spec/model/introspection_spec.rb

@@ -39,7 +39,7 @@ describe Her::Model::Introspection do
     end
   end
 
-  describe "#nearby_class" do
+  describe "#her_nearby_class" do
     context "for a class inside of a module" do
       before do
         spawn_model "Foo::User"
@@ -49,10 +49,10 @@ describe Her::Model::Introspection do
       end
 
       it "returns a sibling class, if found" do
-        Foo::User.nearby_class("AccessRecord").should == Foo::AccessRecord
-        AccessRecord.nearby_class("Log").should == Log
-        Foo::User.nearby_class("Log").should == Log
-        Foo::User.nearby_class("X").should be_nil
+        Foo::User.her_nearby_class("AccessRecord").should == Foo::AccessRecord
+        AccessRecord.her_nearby_class("Log").should == Log
+        Foo::User.her_nearby_class("Log").should == Log
+        Foo::User.her_nearby_class("X").should be_nil
       end
     end
   end

data/spec/model/orm_spec.rb

@@ -11,7 +11,8 @@ describe Her::Model::ORM do
         builder.adapter :test do |stub|
           stub.get("/users/1") { |env| [200, {}, { :id => 1, :name => "Tobias Fünke" }.to_json] }
           stub.get("/users") { |env| [200, {}, [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }].to_json] }
-          stub.get("/admin_users") { |env| [200, {}, [{ :id => 1, :name => "Tobias Fünke" }, { :id => 2, :name => "Lindsay Fünke" }].to_json] }
+          stub.get("/admin_users") { |env| [200, {}, [{ :admin_id => 1, :name => "Tobias Fünke" }, { :admin_id => 2, :name => "Lindsay Fünke" }].to_json] }
+          stub.get("/admin_users/1") { |env| [200, {}, { :admin_id => 1, :name => "Tobias Fünke" }.to_json] }
         end
       end
 
@@ -21,6 +22,7 @@ describe Her::Model::ORM do
 
       spawn_model "Foo::AdminUser" do
         uses_api api
+        primary_key :admin_id
       end
     end
 
@@ -28,6 +30,10 @@ describe Her::Model::ORM do
       @user = Foo::User.find(1)
       @user.id.should == 1
       @user.name.should == "Tobias Fünke"
+
+      @admin = Foo::AdminUser.find(1)
+      @admin.id.should == 1
+      @admin.name.should == "Tobias Fünke"
     end
 
     it "maps a collection of resources to an array of Ruby objects" do
@@ -49,53 +55,12 @@ describe Her::Model::ORM do
       @existing_user.new?.should be_false
     end
 
-    it "accepts new resource with strings as hash keys" do
-      @new_user = Foo::User.new('fullname' => "Tobias Fünke")
-      @new_user.fullname.should == "Tobias Fünke"
-    end
-
-    it "handles method missing for getter" do
-      @new_user = Foo::User.new(:fullname => 'Mayonegg')
-      lambda { @new_user.unknown_method_for_a_user }.should raise_error(NoMethodError)
-      expect { @new_user.fullname }.to_not raise_error(NoMethodError)
-    end
-
-    it "handles method missing for setter" do
-      @new_user = Foo::User.new
-      expect { @new_user.fullname = "Tobias Fünke" }.to_not raise_error(NoMethodError)
-    end
-
-    it "handles method missing for query" do
-      @new_user = Foo::User.new
-      expect { @new_user.fullname? }.to_not raise_error(NoMethodError)
-    end
-
-    it "handles respond_to for getter" do
-      @new_user = Foo::User.new(:fullname => 'Mayonegg')
-      @new_user.should_not respond_to(:unknown_method_for_a_user)
-      @new_user.should respond_to(:fullname)
-    end
-
-    it "handles respond_to for setter" do
-      @new_user = Foo::User.new
-      @new_user.should respond_to(:fullname=)
-    end
-
-    it "handles respond_to for query" do
-      @new_user = Foo::User.new
-      @new_user.should respond_to(:fullname?)
-    end
+    it 'handles new resource with custom primary key' do
+      @new_user = Foo::AdminUser.new(:fullname => 'Lindsay Fünke', :id => -1)
+      @new_user.should be_new
 
-    it "handles has_data? for getter" do
-      @new_user = Foo::User.new(:fullname => 'Mayonegg')
-      @new_user.should_not have_data(:unknown_method_for_a_user)
-      @new_user.should have_data(:fullname)
-    end
-
-    it "handles get_data for getter" do
-      @new_user = Foo::User.new(:fullname => 'Mayonegg')
-      @new_user.get_data(:unknown_method_for_a_user).should be_nil
-      @new_user.get_data(:fullname).should == 'Mayonegg'
+      @existing_user = Foo::AdminUser.find(1)
+      @existing_user.should_not be_new
     end
   end
 
@@ -308,26 +273,6 @@ describe Her::Model::ORM do
     end
   end
 
-  context "assigning new resource data" do
-    before do
-      Her::API.setup :url => "https://api.example.com" do |builder|
-        builder.use Her::Middleware::FirstLevelParseJSON
-        builder.use Faraday::Request::UrlEncoded
-        builder.adapter :test do |stub|
-          stub.get("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke", :active => true }.to_json] }
-        end
-      end
-
-      spawn_model "Foo::User"
-      @user = Foo::User.find(1)
-    end
-
-    it "handles data update through #assign_attributes" do
-      @user.assign_attributes :active => true
-      @user.should be_active
-    end
-  end
-
   context "deleting resources" do
     before do
       Her::API.setup :url => "https://api.example.com" do |builder|
@@ -436,7 +381,7 @@ describe Her::Model::ORM do
 
     it "delegates eql? to ==" do
       other = Object.new
-      user.expects(:==).with(other).returns(true)
+      user.should_receive(:==).with(other).and_return(true)
       user.eql?(other).should be_true
     end
 
@@ -454,65 +399,6 @@ describe Her::Model::ORM do
     end
   end
 
-  context "checking dirty attributes" do
-    before do
-      Her::API.setup :url => "https://api.example.com" do |builder|
-        builder.use Her::Middleware::FirstLevelParseJSON
-        builder.use Faraday::Request::UrlEncoded
-        builder.adapter :test do |stub|
-          stub.get("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke" }.to_json] }
-          stub.put("/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
-          stub.post("/users") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke" }.to_json] }
-        end
-      end
-
-      spawn_model "Foo::User" do
-        attributes :fullname, :email
-      end
-    end
-
-    context "for existing resource" do
-      it "tracks dirty attributes" do
-        user = Foo::User.find(1)
-        user.fullname = "Tobias Fünke"
-        user.fullname_changed?.should be_true
-        user.email_changed?.should be_false
-        user.should be_changed
-        user.save
-        user.should_not be_changed
-      end
-    end
-
-    context "for new resource" do
-      it "tracks dirty attributes" do
-        user = Foo::User.new
-        user.fullname = "Tobias Fünke"
-        user.fullname_changed?.should be_true
-        user.should be_changed
-        user.save
-        user.should_not be_changed
-      end
-    end
-  end
-
-  context "validating attributes" do
-    before do
-      spawn_model "Foo::User" do
-        attributes :fullname, :email
-        validates_presence_of :fullname
-        validates_presence_of :email
-      end
-    end
-
-    it "validates attributes when calling #valid?" do
-      user = Foo::User.new
-      user.should_not be_valid
-      user.fullname = "Tobias Fünke"
-      user.email = "tobias@bluthcompany.com"
-      user.should be_valid
-    end
-  end
-
   context "when include_root_in_json is true" do
     context "when include_root_in_json is true" do
       before do
@@ -523,7 +409,7 @@ describe Her::Model::ORM do
 
       it "wraps params in the element name" do
         @new_user = Foo::User.new(:fullname => "Tobias Fünke")
-        @new_user.to_params.should == { 'user' => { :fullname => "Tobias Fünke" } }
+        @new_user.to_params.should == { :user => { :fullname => "Tobias Fünke" } }
       end
     end
 

data/spec/model/paths_spec.rb

@@ -137,6 +137,32 @@ describe Her::Model::Paths do
         end
       end
     end
+
+    context 'custom primary key' do
+      before do
+        spawn_model 'User' do
+          primary_key 'UserId'
+          resource_path 'users/:UserId'
+        end
+
+        spawn_model 'Customer' do
+          primary_key :customer_id
+          resource_path 'customers/:id'
+        end
+      end
+
+      describe '#build_request_path' do
+        it 'uses the correct primary key attribute' do
+          User.build_request_path(:UserId => 'foo').should == 'users/foo'
+          User.build_request_path(:id => 'foo').should == 'users'
+        end
+
+        it 'replaces :id with the appropriate primary key' do
+          Customer.build_request_path(:customer_id => 'joe').should == 'customers/joe'
+          Customer.build_request_path(:id => 'joe').should == 'customers'
+        end
+      end
+    end
   end
 
   context "making subdomain HTTP requests" do

data/spec/model/validations_spec.rb

@@ -2,4 +2,21 @@
 require File.join(File.dirname(__FILE__), "../spec_helper.rb")
 
 describe "Her::Model and ActiveModel::Validations" do
+  context "validating attributes" do
+    before do
+      spawn_model "Foo::User" do
+        attributes :fullname, :email
+        validates_presence_of :fullname
+        validates_presence_of :email
+      end
+    end
+
+    it "validates attributes when calling #valid?" do
+      user = Foo::User.new
+      user.should_not be_valid
+      user.fullname = "Tobias Fünke"
+      user.email = "tobias@bluthcompany.com"
+      user.should be_valid
+    end
+  end
 end