resource 0.1.0

data/spec/lib/associations_spec.rb

@@ -0,0 +1,412 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include ApiResource
+
+describe "Associations" do
+  
+  after(:all) do
+    TestResource.reload_class_attributes
+  end
+  
+  context "creating and testing for associations of various types" do
+    
+    it "should be be able to define an asociation using a method named after that association type" do
+      TestResource.has_many :has_many_objects
+      TestResource.has_many?(:has_many_objects).should be_true
+    end
+    
+    it "should be able to define associations with different class names" do
+      TestResource.has_many :test_name, :class_name => :has_many_objects
+      TestResource.has_many?(:test_name).should be_true
+      TestResource.has_many_class_name(:test_name).should eql("HasManyObject")
+    end
+    
+    it "should be able to define multiple associations at the same time" do
+      TestResource.has_many :has_many_objects, :other_has_many_objects
+      TestResource.has_many?(:has_many_objects).should be_true
+      TestResource.has_many?(:other_has_many_objects).should be_true
+    end
+    
+    it "should be able to tell if something is an association via the association? method" do
+      TestResource.belongs_to :belongs_to_object
+      TestResource.association?(:belongs_to_object).should be_true
+    end
+    
+    it "should be able to get the class name of an association via the association_class_name method" do
+      TestResource.belongs_to :belongs_to_object
+      TestResource.association_class_name(:belongs_to_object).should eql("BelongsToObject")
+      TestResource.belongs_to :strange_name, :class_name => :belongs_to_object
+      TestResource.association_class_name(:strange_name).should eql("BelongsToObject")
+    end
+  end
+  
+  context "creating and testing for scopes" do
+    
+    it "should be able to define scopes which require class names" do
+      lambda {
+        TestResource.scope :test_scope
+      }.should raise_error
+      TestResource.scope :test_scope, {:has_many_objects => "test"}
+    end
+    
+    it "should be able to test if a scope exists" do
+      TestResource.scope :test_scope, {:item => "test"}
+      TestResource.scope?(:test_scope).should be_true
+      TestResource.scope_attributes(:test_scope).should eql({"item" => "test"})
+    end 
+    
+  end
+  
+  context "testing for scopes and associations on an instance" do
+    
+    it "should be able to define associations on a class and test for them on an instance" do
+      TestResource.has_many :has_many_objects, :class_name => :other_has_many_objects
+      tst = TestResource.new
+      tst.has_many?(:has_many_objects).should be_true
+      tst.has_many_class_name(:has_many_objects).should eql("OtherHasManyObject")
+    end
+    
+    it "should be able to define scopes on a class and test for them on an instance" do
+      TestResource.scope :has_many_objects, {:item => "test"}
+      tst = TestResource.new
+      tst.scope?(:has_many_objects).should be_true
+      tst.scope_attributes(:has_many_objects).should eql({"item" => "test"})
+    end
+    
+  end
+  
+  describe "Single Object Associations" do
+    
+    before(:all) do
+      TestResource.reload_class_attributes
+    end
+    
+    after(:all) do
+      TestResource.reload_class_attributes
+    end
+    
+    it "should be able to create a SingleObjectProxy around a blank hash" do
+      ap = Associations::SingleObjectProxy.new("TestResource", {})
+      ap.remote_path.should be_blank
+    end
+    
+    it "should be able to extract a service uri from the contents hash" do
+      ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => "/path"})
+      ap.remote_path.should eql("/path")
+    end
+    
+    it "should be able to recognize the attributes of an object and not make them scopes" do
+      TestResource.define_attributes :test
+      ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => "/path", :test => "testval"})
+      ap.scope?("test").should be_false
+      ap.remote_path.should eql("/path")
+    end
+    
+    it "should make all attributes except the service uri into scopes given the scopes_only option" do
+      ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => "/path", :test_scope => {"testval" => true}, :scopes_only => true})
+      ap.scope?("test_scope").should be_true
+      ap.remote_path.should eql("/path")
+    end
+
+    it "should pass the attributes that are not scopes and make them attributes of the object" do
+      TestResource.define_attributes :test
+      ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => "/path", :test => "testval"})
+      ap.internal_object.attributes.keys.should include("test")
+    end
+  end
+  
+  describe "Multi Object Associations" do
+
+    before(:all) do
+      TestResource.related_objects[:scope].clear
+    end
+
+    after(:each) do
+      Associations::MultiObjectProxy.remote_path_element = :service_uri
+    end
+
+    describe "Loading settings" do
+
+      context "Loading array contents" do
+
+        it "should be able to load a blank array" do
+          ap = Associations::MultiObjectProxy.new("TestResource",[])
+          ap.remote_path.should be_nil
+          ap.scopes.keys.should eql([])
+        end
+
+        it "should be able to recognize a settings hash if it has a service_uri" do
+          ap = Associations::MultiObjectProxy.new("TestResource",[{:service_uri => "/route"}])
+          ap.remote_path.should eql("/route")
+        end
+
+        it "should be able to recognize a settings hash if it has a 'service_uri' with another preset name" do
+          Associations::MultiObjectProxy.remote_path_element = :the_element
+          ap = Associations::MultiObjectProxy.new("TestResource",[{:the_element => "/route"}])
+          ap.remote_path.should eql("/route")
+        end
+
+      end
+
+      context "Loading hash contents" do
+
+        it "should not be able to load a hash without a 'service_uri'" do
+          lambda {
+            Associations::MultiObjectProxy.new("TestResource", {})
+          }.should raise_error
+        end
+
+        it "should be able to recognize settings from a hash" do
+          ap = Associations::MultiObjectProxy.new("TestResource", {:service_uri => "/route"})
+          ap.remote_path.should eql("/route")
+        end
+
+        it "should recognize settings with differing 'service_uri' names" do
+          Associations::MultiObjectProxy.remote_path_element = :the_element
+          ap = Associations::MultiObjectProxy.new("TestResource",{:the_element => "/route"})
+          ap.remote_path.should eql("/route")
+        end
+      end
+
+      context "Defining scopes" do
+
+        it "should define scopes based on the other keys in a settings hash" do
+          ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope1 => {"scope1" => true}, :scope2 => {"scope2" => true}}])
+          [:scope1, :scope2].each{|s| ap.scopes.include?(s).should be_true }
+        end
+
+        it "should identify known scopes based on the scopes defined on the object it is a proxy to" do
+          TestResource.scope :class_scope, "class_scope" => "true"
+          ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope1 => {"scope1" => true}, :scope2 => {"scope2" => true}}])
+          [:scope1, :scope2, :class_scope].each{|s| ap.scopes.include?(s).should be_true}
+        end
+
+        it "scopes in the response should shadow class defined scopes" do
+          TestResource.scope :scope1, "scope1" => "true"
+          ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope1 => {"scope1" => true}, :scope2 => {"scope2" => true}}])
+          ap.scopes[:scope1].should eql({"scope1" => true})
+        end
+      end
+
+    end
+
+    describe "Selecting scopes" do
+
+      it "should be able to change scopes" do
+        ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope1 => {"scope1" => true}, :scope2 => {"scope2" => true}}])
+        ap.scope1.should be_a(Associations::RelationScope)
+        ap.scope1.current_scope.scope1_scope?.should be_true
+      end
+
+      it "should be able to chain scope calls together" do
+        ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope1 => {"scope1" => true}, :scope2 => {"scope2" => true}}])
+        ap.scope1.scope2.current_scope.scope1_and_scope2_scope?.should be_true
+        ap.scope1.scope2.to_query.should eql("scope1=true&scope2=true")
+      end
+      
+      it "should support scopes that contain underscores" do
+        ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope_1 => {"scope_1" => true}, :scope_2 => {"scope_2" => true}}])
+        ap.scope_1.scope_2.current_scope.scope_1_and_scope_2_scope?.should be_true
+      end
+      
+      it "should be able to return the current query string" do
+        ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope_1 => {"scope_1" => true}, :scope_2 => {"scope_2" => true}}])
+        ap.scope_1.scope_2.to_query.should eql("scope_1=true&scope_2=true")
+      end
+      
+      it "should be able to substitute values into the scope query strings by passing a hash to the methods" do
+        ap = Associations::MultiObjectProxy.new("TestResource", [{:service_uri => "/route", :scope_1 => {"scope_1" => true, :test_sub => false}, :scope_2 => {"scope_2" => true}}])
+        obj = ap.scope_1(:test_sub => true).scope_2
+        obj.to_query.should eql("scope_1=true&scope_2=true&test_sub=true")
+      end
+    end
+
+
+  end
+  
+  describe "Loading and Caching loaded data" do
+    
+    context "Single Object" do
+      
+      before(:all) do
+        TestResource.reload_class_attributes
+      end
+      
+      it "should be able to force load an object" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => true}, :scopes_only => true})
+        ap.loaded.should be_blank
+        name = ap.name
+        name.should_not be_blank
+        ap.loaded.should_not be_blank
+        # Make sure it isn't reloaded
+        ap.name.should eql(name)
+      end
+      
+      it "should be able to load a scope" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => true}, :scopes_only => true})
+        ap.internal_object.active.should be_false
+        ap.times_loaded.should eql(1)
+        ap.active.should be_a Associations::RelationScope
+        ap.active.name.should_not be_blank
+        ap.times_loaded.should eql(2)
+        ap.active.internal_object.active.should be_true
+        # another check that the resource wasn't reloaded
+        ap.times_loaded.should eql(2)       
+      end
+      
+      it "should be able to load a chain of scopes" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => true}, :with_birthday => {:birthday => true}, :scopes_only => true})
+        first = ap.active.with_birthday.id
+        ap.with_birthday.active.id.should eql(first)
+        ap.times_loaded.should eql(1)
+        ap.active.with_birthday.birthday.should_not be_blank
+      end
+      
+      it "should be able to load a chain of scopes with substitution" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => false}, :with_birthday => {:birthday => true}, :scopes_only => true})
+        item = ap.active(:active => true).internal_object
+        item.active.should be_true
+        ap.times_loaded.should eql(1)
+        # This error and incrementing times_loaded means it tried to load again
+        lambda {
+          ap.active.internal_object
+        }.should raise_error
+        ap.times_loaded.should eql(2)
+      end
+      
+      it "should proxy unknown methods to the object loading if it hasn't already" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => false}, :with_birthday => {:birthday => true}, :scopes_only => true})
+        ap.times_loaded.should eql(0)
+        ap.id.should_not be_blank
+        ap.times_loaded.should eql(1)
+      end
+      
+      it "should only load each distinct set of scopes once" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => false}, :with_birthday => {:birthday => true}, :scopes_only => true})
+        ap.times_loaded.should eql(0)
+        ap.active(:active => true).with_birthday.internal_object
+        ap.with_birthday.active(:active => true).internal_object
+        ap.times_loaded.should eql(1)
+      end
+      
+      it "should be able to clear it's loading cache" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => true}, :with_birthday => {:birthday => true}, :scopes_only => true})
+        ap.active.internal_object
+        ap.times_loaded.should eql(1)
+        ap.reload
+        ap.active.internal_object
+        ap.times_loaded.should eql(1)
+      end
+      
+    end
+    
+    context "Multi Object" do
+      
+      it "should be able to load 'all'" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => false}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        results = ap.all
+        results.size.should eql(5)
+        results.first.active.should be_false
+      end
+      
+      it "should be able to load a scope" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => false}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        results = ap.active.internal_object
+        results.size.should eql(5)
+        results.first.active.should be_true
+      end
+      
+      it "should be able to load a chain of scopes" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => true}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        results = ap.active.with_birthday.internal_object
+        results.first.active.should be_true
+        results.first.birthday.should_not be_blank
+      end
+      
+      it "should be able to load a chain of scopes with substitution" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => true}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        results = ap.inactive(:active => true).with_birthday.internal_object
+        results.first.active.should be_true
+        results.first.birthday.should_not be_blank
+      end
+      
+      it "should proxy unknown methods to the object array loading if it hasn't already" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => true}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        ap.first.should be_a TestResource
+        ap.active.first.should be_a TestResource
+        ap.times_loaded.should eql(2)
+      end
+      
+      it "should only load each distinct set of scopes once" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => true}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        ap.first
+        ap.active.first
+        ap.times_loaded.should eql(2)
+        ap.active.first
+        ap.times_loaded.should eql(2)
+        ap.active.with_birthday.first
+        ap.with_birthday.active.first
+        ap.times_loaded.should eql(3)
+      end
+      
+      it "should be able to clear it's loading cache" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => true}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        ap.active.first
+        ap.times_loaded.should eql(1)
+        ap.reload
+        ap.active.first
+        ap.times_loaded.should eql(1)
+      end
+      
+      it "should be enumerable" do
+        ap = Associations::MultiObjectProxy.new("TestResource",{:service_uri => '/multi_object_association', :active => {:active => true}, :inactive => {:active => false}, :with_birthday => {:birthday => true}})
+        ap.each do |tr|
+          tr.name.should_not be_blank
+        end
+      end
+      
+    end
+    
+    context "Scopes" do
+      
+      before(:all) do
+        TestResource.reload_class_attributes
+      end
+      
+      it "should define class methods for the known scopes" do
+        TestResource.scopes.each do |key, _|
+          TestResource.should respond_to key
+        end
+      end
+      
+      it "should return a ResourceScope when calling any scope on a class" do
+        TestResource.send(TestResource.scopes.first.first.to_sym).should be_a Associations::ResourceScope
+      end
+      
+      it "should be able to chain scopes" do
+        scp = TestResource.active.paginate
+        scp.should be_a Associations::ResourceScope
+        scp.to_query.should eql("active=true&current_page=current_page&paginate=true&per_page=per_page")
+      end
+      
+      it "should load when calling all" do
+        TestResource.active.should respond_to :all
+        TestResource.active.should respond_to :internal_object
+        results = TestResource.active.all
+        results.should be_a Array
+        results.size.should eql(5)
+        results.each do |res|
+          res.should be_a TestResource
+        end
+      end
+      
+      it "should load when calling an enumerable method or an array method" do
+        TestResource.active.each do |result|
+          result.should be_a TestResource
+        end
+      end
+    end
+    
+  end
+  
+end

data/spec/lib/attributes_spec.rb

@@ -0,0 +1,109 @@
+require File.expand_path(File.dirname(__FILE__) + '/../spec_helper')
+
+include ApiResource
+
+describe "Attributes" do
+  
+  after(:all) do
+    TestResource.reload_class_attributes
+  end
+  
+  context "Defining, getting, and setting attributes" do
+    it "should be able to define known attributes" do
+      TestResource.define_attributes :attr1, :attr2
+      TestResource.attribute?(:attr1).should be_true
+      TestResource.attribute?(:attr2).should be_true
+    end
+    
+    it "should define methods for testing for reading and writing known attributes" do
+      TestResource.define_attributes :attr1, :attr2
+      tst = TestResource.new
+      tst.respond_to?(:attr1).should be_true
+      tst.respond_to?(:attr1=).should be_true
+      tst.respond_to?(:attr1?).should be_true
+    end
+    
+    it "should be able to set and change attributes" do
+      TestResource.define_attributes :attr1, :attr2
+      tst = TestResource.new
+      tst.attr1.should be_nil
+      tst.attr1?.should be_false
+      tst.attr1 = "test"
+      tst.attr1.should eql("test")
+      tst.attr1?.should be_true
+    end
+  end
+  
+  context "Protected attributes" do
+    it "should allow protected attributes that cannot be changed" do
+      TestResource.define_protected_attributes :pattr3
+      lambda {
+        tst = TestResource.new
+        tst.attr3 = "test"
+      }.should raise_error
+    end
+  end
+  
+  context "Dirty tracking" do
+    context "Changes to attributes" do
+      it "should implement dirty tracking for attributes" do
+        TestResource.define_attributes :attr1, :attr2
+        tst = TestResource.new
+        tst.changed.should be_blank
+        tst.attr1 = "Hello"
+        tst.changed.include?("attr1").should be_true
+        tst.changes.should_not be_blank
+        
+        # Set an attribute equal to itself
+        tst.attr2 = tst.attr2
+        tst.changes.include?("attr2").should be_false
+      end
+
+    end
+    
+    context "Resetting and marking attributes current" do
+      
+      before(:each) do
+        TestResource.define_attributes :attr1, :attr2
+      end
+      
+      it "should be able to mark any list of attributes as current (unchanged)" do
+        tst = TestResource.new
+        tst.attr1 = "Hello"
+        tst.changed.should_not be_blank
+        tst.set_attributes_as_current :attr1, :attr2
+        tst.changed.should be_blank
+      end
+      
+      it "should be able to mark all the attributes as current if none are given" do
+        tst = TestResource.new
+        tst.attr1 = "attr1"
+        tst.attr2 = "attr2"
+        tst.changed.should_not be_blank
+        tst.set_attributes_as_current
+        tst.changed.should be_blank
+      end
+      
+      it "should be able to reset any list of attributes" do
+        tst = TestResource.new
+        tst.attr1 = "attr1"
+        tst.reset_attribute_changes :attr1
+        tst.attr1.should be_nil
+        tst.changed.should be_blank
+      end
+      
+      it "should be able to reset all the attributes if none are given" do
+        tst = TestResource.new
+        tst.attr1 = "attr1"
+        tst.attr2 = "attr2"
+
+        tst.reset_attribute_changes
+        tst.attr1.should be_nil
+        tst.attr2.should be_nil
+        tst.changed.should be_blank
+      end
+    end
+    
+  end
+  
+end