her 0.3.1 → 0.3.2

data/spec/model/introspection_spec.rb

@@ -21,31 +21,31 @@ describe Her::Model::Introspection do
     describe "#inspect" do
       it "outputs resource attributs for an existing resource" do # {{{
         @user = Foo::User.find(1)
-        ["#<Foo::User(/users/1) name=\"Tobias Funke\" id=1>", "#<Foo::User(/users/1) id=1 name=\"Tobias Funke\">"].should include(@user.inspect)
+        ["#<Foo::User(users/1) name=\"Tobias Funke\" id=1>", "#<Foo::User(users/1) id=1 name=\"Tobias Funke\">"].should include(@user.inspect)
       end # }}}
 
       it "outputs resource attributs for an not-saved-yet resource" do # {{{
         @user = Foo::User.new(:name => "Tobias Funke")
-        @user.inspect.should == "#<Foo::User(/users) name=\"Tobias Funke\">"
+        @user.inspect.should == "#<Foo::User(users) name=\"Tobias Funke\">"
       end # }}}
     end
   end
 
   describe "#nearby_class" do
-    context "for a class inside of a module" do
-      before do
+    context "for a class inside of a module" do # {{{
+      before do # {{{
         spawn_model "Foo::User"
         spawn_model "Foo::AccessRecord"
         spawn_model "AccessRecord"
         spawn_model "Log"
-      end
+      end # }}}
 
-      it "returns a sibling class, if found" do
+      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
-      end
-    end
+      end # }}}
+    end # }}}
   end
 end

data/spec/model/orm_spec.rb

@@ -59,6 +59,27 @@ describe Her::Model::ORM 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#}}}
   end
 
   context "mapping data, metadata and error data to Ruby objects" do
@@ -155,6 +176,59 @@ describe Her::Model::ORM do
     end # }}}
   end
 
+  context "finding resources" do
+    before do # {{{
+      api = Her::API.new
+      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, :age => 42 }.to_json] }
+          stub.get("/users/2") { |env| [200, {}, { :id => 2, :age => 34 }.to_json] }
+          stub.get("/users?age=42") { |env| [200, {}, [{ :id => 1, :age => 42 }].to_json] }
+        end
+      end
+
+      spawn_model :User do
+        uses_api api
+      end
+    end # }}}
+
+    it "handles finding by a single id" do # {{{
+      @user = User.find(1)
+      @user.id.should == 1
+    end # }}}
+
+    it "handles finding by multiple ids" do # {{{
+      @users = User.find(1, 2)
+      @users.should be_kind_of(Array)
+      @users.length.should == 2
+      @users[0].id.should == 1
+      @users[1].id.should == 2
+    end # }}}
+
+    it "handles finding by an array of ids" do
+      @users = User.find([1, 2])
+      @users.should be_kind_of(Array)
+      @users.length.should == 2
+      @users[0].id.should == 1
+      @users[1].id.should == 2
+    end
+
+    it "handles finding by an array of ids of length 1" do
+      @users = User.find([1])
+      @users.should be_kind_of(Array)
+      @users.length.should == 1
+      @users[0].id.should == 1
+    end
+
+    it "handles finding with other parameters" do # {{{
+      @users = User.all(:age => 42)
+      @users.should be_kind_of(Array)
+      @users.should be_all { |u| u.age == 42 }
+    end # }}}
+  end
+
   context "creating resources" do
     before do # {{{
       Her::API.setup :url => "https://api.example.com" do |builder|
@@ -240,4 +314,102 @@ describe Her::Model::ORM do
       @user.active.should be_false
     end # }}}
   end
+
+  context "saving resources with overridden to_params" 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.post("/users") do |env|
+            body = {
+              :id => 1,
+              :fullname => Faraday::Utils.parse_query(env[:body])['fullname']
+            }.to_json
+            [200, {}, body]
+          end
+        end
+      end # }}}
+
+      spawn_model "Foo::User" do
+        def to_params
+          { :fullname => "Lindsay Fünke" }
+        end
+      end
+    end # }}}
+
+    it "changes the request parameters for one-line resource creation" do # {{{
+      @user = Foo::User.create(:fullname => "Tobias Fünke")
+      @user.fullname.should == "Lindsay Fünke"
+    end # }}}
+
+    it "changes the request parameters for Model.new + #save" do # {{{
+      @user = Foo::User.new(:fullname => "Tobias Fünke")
+      @user.save
+      @user.fullname.should == "Lindsay Fünke"
+    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.expects(:==).with(other).returns(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/paths_spec.rb

@@ -10,8 +10,8 @@ describe Her::Model::Paths do
 
       describe "#build_request_path" do
         it "builds paths with defaults" do # {{{
-          Foo::User.build_request_path(:id => "foo").should == "/users/foo"
-          Foo::User.build_request_path.should == "/users"
+          Foo::User.build_request_path(:id => "foo").should == "users/foo"
+          Foo::User.build_request_path.should == "users"
         end # }}}
 
         it "builds paths with custom collection path" do # {{{
@@ -20,16 +20,42 @@ describe Her::Model::Paths do
           Foo::User.build_request_path.should == "/utilisateurs"
         end # }}}
 
+        it "builds paths with custom relative collection path" do # {{{
+          Foo::User.collection_path "utilisateurs"
+          Foo::User.build_request_path(:id => "foo").should == "utilisateurs/foo"
+          Foo::User.build_request_path.should == "utilisateurs"
+        end # }}}
+
         it "builds paths with custom collection path with multiple variables" do # {{{
           Foo::User.collection_path "/organizations/:organization_id/utilisateurs"
+
           Foo::User.build_request_path(:id => "foo", :_organization_id => "acme").should == "/organizations/acme/utilisateurs/foo"
           Foo::User.build_request_path(:_organization_id => "acme").should == "/organizations/acme/utilisateurs"
+
+          Foo::User.build_request_path(:id => "foo", :organization_id => "acme").should == "/organizations/acme/utilisateurs/foo"
+          Foo::User.build_request_path(:organization_id => "acme").should == "/organizations/acme/utilisateurs"
+        end # }}}
+
+        it "builds paths with custom relative collection path with multiple variables" do # {{{
+          Foo::User.collection_path "organizations/:organization_id/utilisateurs"
+
+          Foo::User.build_request_path(:id => "foo", :_organization_id => "acme").should == "organizations/acme/utilisateurs/foo"
+          Foo::User.build_request_path(:_organization_id => "acme").should == "organizations/acme/utilisateurs"
+
+          Foo::User.build_request_path(:id => "foo", :organization_id => "acme").should == "organizations/acme/utilisateurs/foo"
+          Foo::User.build_request_path(:organization_id => "acme").should == "organizations/acme/utilisateurs"
         end # }}}
 
         it "builds paths with custom item path" do # {{{
           Foo::User.resource_path "/utilisateurs/:id"
           Foo::User.build_request_path(:id => "foo").should == "/utilisateurs/foo"
-          Foo::User.build_request_path.should == "/users"
+          Foo::User.build_request_path.should == "users"
+        end # }}}
+
+        it "builds paths with custom relative item path" do # {{{
+          Foo::User.resource_path "utilisateurs/:id"
+          Foo::User.build_request_path(:id => "foo").should == "utilisateurs/foo"
+          Foo::User.build_request_path.should == "users"
         end # }}}
 
         it "raises exceptions when building a path without required custom variables" do # {{{
@@ -46,8 +72,8 @@ describe Her::Model::Paths do
 
       describe "#build_request_path" do
         it "builds paths with defaults" do # {{{
-          Foo::AdminUser.build_request_path(:id => "foo").should == "/admin_users/foo"
-          Foo::AdminUser.build_request_path.should == "/admin_users"
+          Foo::AdminUser.build_request_path(:id => "foo").should == "admin_users/foo"
+          Foo::AdminUser.build_request_path.should == "admin_users"
         end # }}}
 
         it "builds paths with custom collection path" do # {{{
@@ -56,22 +82,45 @@ describe Her::Model::Paths do
           Foo::AdminUser.build_request_path.should == "/users"
         end # }}}
 
+        it "builds paths with custom relative collection path" do # {{{
+          Foo::AdminUser.collection_path "users"
+          Foo::AdminUser.build_request_path(:id => "foo").should == "users/foo"
+          Foo::AdminUser.build_request_path.should == "users"
+        end # }}}
+
         it "builds paths with custom collection path with multiple variables" do # {{{
           Foo::AdminUser.collection_path "/organizations/:organization_id/users"
           Foo::AdminUser.build_request_path(:id => "foo", :_organization_id => "acme").should == "/organizations/acme/users/foo"
           Foo::AdminUser.build_request_path(:_organization_id => "acme").should == "/organizations/acme/users"
         end # }}}
 
+        it "builds paths with custom relative collection path with multiple variables" do # {{{
+          Foo::AdminUser.collection_path "organizations/:organization_id/users"
+          Foo::AdminUser.build_request_path(:id => "foo", :_organization_id => "acme").should == "organizations/acme/users/foo"
+          Foo::AdminUser.build_request_path(:_organization_id => "acme").should == "organizations/acme/users"
+        end # }}}
+
         it "builds paths with custom item path" do # {{{
           Foo::AdminUser.resource_path "/users/:id"
           Foo::AdminUser.build_request_path(:id => "foo").should == "/users/foo"
-          Foo::AdminUser.build_request_path.should == "/admin_users"
+          Foo::AdminUser.build_request_path.should == "admin_users"
+        end # }}}
+
+        it "builds paths with custom relative item path" do # {{{
+          Foo::AdminUser.resource_path "users/:id"
+          Foo::AdminUser.build_request_path(:id => "foo").should == "users/foo"
+          Foo::AdminUser.build_request_path.should == "admin_users"
         end # }}}
 
         it "raises exceptions when building a path without required custom variables" do # {{{
           Foo::AdminUser.collection_path "/organizations/:organization_id/users"
           expect { Foo::AdminUser.build_request_path(:id => "foo") }.to raise_error(Her::Errors::PathError)
         end # }}}
+
+        it "raises exceptions when building a relative path without required custom variables" do # {{{
+          Foo::AdminUser.collection_path "organizations/:organization_id/users"
+          expect { Foo::AdminUser.build_request_path(:id => "foo") }.to raise_error(Her::Errors::PathError)
+        end # }}}
       end
     end
 
@@ -82,29 +131,29 @@ describe Her::Model::Paths do
 
       describe "#build_request_path" do
         it "builds paths with defaults" do # {{{
-          Foo::User.build_request_path(:id => "foo").should == "/users/foo"
-          Foo::User.build_request_path.should == "/users"
+          Foo::User.build_request_path(:id => "foo").should == "users/foo"
+          Foo::User.build_request_path.should == "users"
         end # }}}
       end
     end
   end
 
-  context "making HTTP requests" do
+  context "making subdomain HTTP requests" do
     before do # {{{
-      Her::API.setup :url => "https://api.example.com" do |builder|
+      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("/organizations/2/users") { |env| [200, {}, [{ :id => 1, :fullname => "Tobias Fünke", :organization_id => 2 }, { :id => 2, :fullname => "Lindsay Fünke", :organization_id => 2 }].to_json] }
-          stub.post("/organizations/2/users") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke", :organization_id => 2 }.to_json] }
-          stub.put("/organizations/2/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke", :organization_id => 2 }.to_json] }
-          stub.get("/organizations/2/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke", :organization_id => 2, :active => true }.to_json] }
-          stub.delete("/organizations/2/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke", :organization_id => 2, :active => false }.to_json] }
+          stub.get("organizations/2/users") { |env| [200, {}, [{ :id => 1, :fullname => "Tobias Fünke", :organization_id => 2 }, { :id => 2, :fullname => "Lindsay Fünke", :organization_id => 2 }].to_json] }
+          stub.post("organizations/2/users") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke", :organization_id => 2 }.to_json] }
+          stub.put("organizations/2/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke", :organization_id => 2 }.to_json] }
+          stub.get("organizations/2/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke", :organization_id => 2, :active => true }.to_json] }
+          stub.delete("organizations/2/users/1") { |env| [200, {}, { :id => 1, :fullname => "Lindsay Fünke", :organization_id => 2, :active => false }.to_json] }
         end
       end
 
       spawn_model "Foo::User" do
-        collection_path "/organizations/:organization_id/users"
+        collection_path "organizations/:organization_id/users"
       end
     end # }}}
 
@@ -182,4 +231,55 @@ describe Her::Model::Paths do
       end # }}}
     end
   end
+
+  context "making path HTTP requests" do
+    before do # {{{
+      Her::API.setup :url => "https://example.com/api/" do |builder|
+        builder.use Her::Middleware::FirstLevelParseJSON
+        builder.use Faraday::Request::UrlEncoded
+        builder.adapter :test do |stub|
+          stub.get("/api/organizations/2/users") { |env| [200, {}, [{ :id => 1, :fullname => "Tobias Fünke", :organization_id => 2 }, { :id => 2, :fullname => "Lindsay Fünke", :organization_id => 2 }].to_json] }
+          stub.get("/api/organizations/2/users/1") { |env| [200, {}, { :id => 1, :fullname => "Tobias Fünke", :organization_id => 2, :active => true }.to_json] }
+        end
+      end
+
+      spawn_model "Foo::User" do
+        collection_path "organizations/:organization_id/users"
+      end
+    end # }}}
+
+    describe "fetching a resource" do
+      it "maps a single resource to a Ruby object" do # {{{
+        @user = Foo::User.find(1, :_organization_id => 2)
+        @user.id.should == 1
+        @user.fullname.should == "Tobias Fünke"
+      end # }}}
+    end
+
+    describe "fetching a collection" do
+      it "maps a collection of resources to an array of Ruby objects" do # {{{
+        @users = Foo::User.all(:_organization_id => 2)
+        @users.length.should == 2
+        @users.first.fullname.should == "Tobias Fünke"
+      end # }}}
+    end
+
+    describe "fetching a resource with absolute path" do
+      it "maps a single resource to a Ruby object" do # {{{
+        Foo::User.resource_path '/api/' + Foo::User.resource_path
+        @user = Foo::User.find(1, :_organization_id => 2)
+        @user.id.should == 1
+        @user.fullname.should == "Tobias Fünke"
+      end # }}}
+    end
+
+    describe "fetching a collection with absolute path" do
+      it "maps a collection of resources to an array of Ruby objects" do # {{{
+        Foo::User.collection_path '/api/' + Foo::User.collection_path
+        @users = Foo::User.all(:_organization_id => 2)
+        @users.length.should == 2
+        @users.first.fullname.should == "Tobias Fünke"
+      end # }}}
+    end
+  end
 end

data/spec/model/relationships_spec.rb

@@ -60,6 +60,16 @@ describe Her::Model::Relationships do
       Foo::User.belongs_to :organization, :class_name => "Business", :foreign_key => "org_id"
       Foo::User.relationships[:belongs_to].should == [{ :name => :organization, :class_name => "Business", :foreign_key => "org_id", :path => "/organizations/:id" }]
     end # }}}
+
+    context "inheriting relationships from a superclass" do
+      it "copies relationships to the subclass" do # {{{
+        Foo::User.has_many :comments, :class_name => "Post"
+        subclass = Class.new(Foo::User)
+        subclass.relationships.object_id.should_not == Foo::User.relationships.object_id
+        subclass.relationships[:has_many].length.should == 1
+        subclass.relationships[:has_many].first[:class_name].should == "Post"
+      end # }}}
+    end
   end
 
   context "handling relationships without details" do
@@ -69,10 +79,13 @@ describe Her::Model::Relationships do
         builder.use Faraday::Request::UrlEncoded
         builder.adapter :test do |stub|
           stub.get("/users/1") { |env| [200, {}, { :id => 1, :name => "Tobias Fünke", :comments => [{ :id => 2, :body => "Tobias, you blow hard!" }, { :id => 3, :body => "I wouldn't mind kissing that man between the cheeks, so to speak" }], :role => { :id => 1, :body => "Admin" }, :organization => { :id => 1, :name => "Bluth Company" }, :organization_id => 1 }.to_json] }
-          stub.get("/users/2") { |env| [200, {}, { :id => 2, :name => "Lindsay Fünke", :organization_id => 1 }.to_json] }
+          stub.get("/users/2") { |env| [200, {}, { :id => 2, :name => "Lindsay Fünke", :organization_id => 2 }.to_json] }
+          stub.get("/users/1/comments") { |env| [200, {}, [{ :id => 4, :body => "They're having a FIRESALE?" }].to_json] }
           stub.get("/users/2/comments") { |env| [200, {}, [{ :id => 4, :body => "They're having a FIRESALE?" }, { :id => 5, :body => "Is this the tiny town from Footloose?" }].to_json] }
           stub.get("/users/2/role") { |env| [200, {}, { :id => 2, :body => "User" }.to_json] }
-          stub.get("/organizations/1") { |env| [200, {}, { :id => 1, :name => "Bluth Company" }.to_json] }
+          stub.get("/users/1/role") { |env| [200, {}, { :id => 3, :body => "User" }.to_json] }
+          stub.get("/organizations/1") { |env| [200, {}, { :id => 1, :name => "Bluth Company Foo" }.to_json] }
+          stub.get("/organizations/2") { |env| [200, {}, { :id => 2, :name => "Bluth Company" }.to_json] }
         end
       end
 
@@ -104,6 +117,10 @@ describe Her::Model::Relationships do
       @user_without_included_data.comments.first.body.should == "They're having a FIRESALE?"
     end # }}}
 
+    it "fetches has_many data even if it was included, only if called with parameters" do # {{{
+      @user_with_included_data.comments(:foo_id => 1).length.should == 1
+    end # }}}
+
     it "maps an array of included data through has_one" do # {{{
       @user_with_included_data.role.should be_a(Foo::Role)
       @user_with_included_data.role.id.should == 1
@@ -116,6 +133,10 @@ describe Her::Model::Relationships do
       @user_without_included_data.role.body.should == "User"
     end # }}}
 
+    it "fetches has_one data even if it was included, only if called with parameters" do # {{{
+      @user_with_included_data.role(:foo_id => 2).id.should == 3
+    end # }}}
+
     it "maps an array of included data through belongs_to" do # {{{
       @user_with_included_data.organization.should be_a(Foo::Organization)
       @user_with_included_data.organization.id.should == 1
@@ -124,9 +145,13 @@ describe Her::Model::Relationships do
 
     it "fetches data that was not included through belongs_to" do # {{{
       @user_without_included_data.organization.should be_a(Foo::Organization)
-      @user_without_included_data.organization.id.should == 1
+      @user_without_included_data.organization.id.should == 2
       @user_without_included_data.organization.name.should == "Bluth Company"
     end # }}}
+
+    it "fetches belongs_to data even if it was included, only if called with parameters" do # {{{
+      @user_with_included_data.organization(:foo_id => 1).name.should == "Bluth Company Foo"
+    end # }}}
   end
 
   context "handling relationships with details" do