api_resource 0.6.4 → 0.6.5

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    api_resource (0.6.3)
+    api_resource (0.6.4)
       colorize
       differ
       json

data/lib/api_resource/associations/association_proxy.rb

@@ -28,7 +28,9 @@ module ApiResource
         klass.api_resource_generated_methods.module_eval <<-EOE, __FILE__, __LINE__ + 1
           def #{assoc_name}
             @attributes_cache[:#{assoc_name}] ||= begin
-              instance = #{self}.new(#{associated_class}, self)
+              instance = #{self}.new(
+                #{associated_class}, self, #{opts}
+              )
               if @attributes[:#{assoc_name}].present?
                 instance.internal_object = @attributes[:#{assoc_name}]
               end
@@ -70,8 +72,8 @@ module ApiResource
 
       public
 
-      def initialize(klass, owner, opts = {})
-
+      def initialize(klass, owner, options = {})
+        
         # the base class for our scope, e.g. ApiResource::SomeClass
         @klass = klass.is_a?(String) ? klass.constantize : klass
 
@@ -79,8 +81,9 @@ module ApiResource
         @klass.load_resource_definition
 
         @owner = owner
-        
-        self.internal_object = opts
+
+        # store our options
+        @options = options
       end
 
       def ttl

data/lib/api_resource/associations/belongs_to_remote_object_proxy.rb

@@ -2,11 +2,23 @@ module ApiResource
   module Associations
     class BelongsToRemoteObjectProxy < SingleObjectProxy
 
-      def initialize(klass, owner)
-        super(klass, owner)
-        
-        # now if we have an owner and a foreign key, we set the data up to load
-        if key = owner.send(self.klass.to_s.foreign_key)
+      attr_reader :foreign_key
+
+
+      # sets some defaults for the foreign key name for this association
+      def self.define_association_as_attribute(klass, assoc_name, opts = {})
+        opts["foreign_key"] = self.foreign_key_name(assoc_name)
+        super(klass, assoc_name, opts)
+      end
+
+      # constructor
+      def initialize(klass, owner, opts = {})
+        super
+
+        @foreign_key = opts["foreign_key"] || @klass.to_s.foreign_key
+        # now if we have an owner and a foreign key, we set 
+        # the data up to load
+        if key = owner.send(self.foreign_key)
           self.remote_path =  self.klass.element_path(key)
         end
       end

data/lib/api_resource/associations/has_one_remote_object_proxy.rb

@@ -30,17 +30,10 @@ module ApiResource
 
       # because of how this works we use a multi object proxy and return the first element
       def to_condition
-        ApiResource::Conditions::MultiObjectAssociationCondition.new(
+        ApiResource::Conditions::SingleObjectAssociationCondition.new(
           self.klass, self.remote_path
         )
       end
-      
-      def load(opts = {})
-        res = Array.wrap(self.to_condition.load).first
-        @loaded = true
-        res
-      end
-
     end
   end
 end

data/lib/api_resource/associations/multi_object_proxy.rb

@@ -6,12 +6,6 @@ module ApiResource
 
         include Enumerable
 
-        # override the constructor to set data to nil by 
-        # default
-        def initialize(klass, owner, data = nil)
-          super
-        end
-
         def all
           self.internal_object
         end

data/lib/api_resource/associations/single_object_proxy.rb

@@ -14,14 +14,13 @@ module ApiResource
       end
 
       def internal_object
-        unless instance_variable_defined?(:@internal_object)
-          if self.remote_path.present?
-            instance_variable_set(:@internal_object, self.load)
+        @internal_object ||= begin
+          if self.remote_path.present? && !self.loaded?
+            self.load
           else
-            instance_variable_set(:@internal_object, nil)
+            nil
           end
         end
-        instance_variable_get(:@internal_object)
       end
       
       def internal_object=(contents)
@@ -67,7 +66,9 @@ module ApiResource
       def to_condition
         obj = nil
         obj = self.internal_object if self.loaded?
-        ApiResource::Conditions::SingleObjectAssociationCondition.new(self.klass, self.remote_path, obj)
+        ApiResource::Conditions::SingleObjectAssociationCondition.new(
+          self.klass, self.remote_path, obj
+        )
       end
 
       # Should make a proper conditions object and call find on it

data/lib/api_resource/associations.rb

@@ -185,6 +185,8 @@ module ApiResource
         end
 
         def define_association_as_attribute(assoc_type, assoc_name, opts)
+          opts.stringify_keys!
+
           id_method_name = association_foreign_key_field(
             assoc_name, assoc_type
           )
@@ -209,10 +211,9 @@ module ApiResource
           klass = klass.constantize
 
           # gives us the namespaced classname
-          opts[:class_name] = self.find_namespaced_class_name(
-            opts[:class_name] || assoc_name.to_s.classify
+          opts["class_name"] = self.find_namespaced_class_name(
+            opts["class_name"] || assoc_name.to_s.classify
           )
-          
           klass.define_association_as_attribute(self, assoc_name, opts)
         end
         

data/lib/api_resource/attributes.rb

@@ -264,6 +264,20 @@ module ApiResource
 
       return val
     end
+
+    private
+
+    # this is here for compatibility with ActiveModel::AttributeMethods
+    # it is the fallback called in method_missing
+    def attribute(name)
+      read_attribute(name)      
+    end
+
+    # this is here for compatibility with ActiveModel::AttributeMethods
+    # it is the fallback called in method_missing
+    def attribute=(name, val)
+      write_attribute(name, val)      
+    end
     
   end
   

data/lib/api_resource/finders/multi_object_association_finder.rb

@@ -22,6 +22,9 @@ module ApiResource
 					data = self.klass.connection.get(self.build_load_path)
 					return [] if data.blank?
 
+					# handle non-array data for more flexibility in our endpoints
+					data = [data] unless data.is_a?(Array)
+
 					@internal_object = self.klass.instantiate_collection(data)
 				end
 

data/lib/api_resource/finders/single_object_association_finder.rb

@@ -22,6 +22,11 @@ module ApiResource
 					data = self.klass.connection.get(self.build_load_path)
 					
 					return nil if data.blank?
+
+					# we want to handle an array if we get one back from our endpoint
+					# this allows for more flexibility
+					data = data.first if data.is_a?(Array)
+
 					@internal_object = self.klass.instantiate_record(data)
 				end
 

data/lib/api_resource/version.rb

@@ -1,3 +1,3 @@
 module ApiResource
-  VERSION = "0.6.4"
+  VERSION = "0.6.5"
 end

data/spec/lib/associations/belongs_to_remote_object_proxy_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+module ApiResource
+  module Associations
+    
+    describe BelongsToRemoteObjectProxy do
+
+      before(:all) do
+        TestResource.reload_resource_definition
+      end
+
+      context "#remote_path" do
+
+        it "allows for custom named relationships and constructs the 
+          correct remote path" do
+          
+          tr = TestResource.new(:custom_name_id => 123)
+          tr.custom_name.remote_path.should eql(
+            "/belongs_to_objects/123.json"
+          )
+        end
+
+      end
+
+    end
+  end
+end

data/spec/lib/associations/has_many_remote_object_proxy_spec.rb

@@ -5,6 +5,10 @@ module ApiResource
     
     describe HasManyRemoteObjectProxy do
 
+      before(:all) do
+        TestResource.reload_resource_definition
+      end
+
       context "#<<" do
         
         it "implements the shift operator" do

data/spec/lib/associations/has_one_remote_object_proxy_spec.rb

@@ -0,0 +1,30 @@
+require 'spec_helper'
+
+module ApiResource
+  module Associations
+    
+    describe HasOneRemoteObjectProxy do
+
+      before(:all) do
+        TestResource.reload_resource_definition
+      end
+
+      context "#load" do
+        
+        it "correctly loads data from an endpoint that returns
+          a single record" do
+          
+          tr = TestResource.new(
+            :has_one_object => {:service_uri => "/has_one_objects/1.json"} 
+          )
+
+          tr.has_one_object.internal_object.should be_instance_of(
+            HasOneObject
+          )
+        end
+
+      end
+
+    end
+  end
+end

data/spec/lib/associations_spec.rb

@@ -9,12 +9,14 @@ describe "Associations" do
   end
 
   let(:ap) do
-    Associations::SingleObjectProxy.new(
+    res = Associations::SingleObjectProxy.new(
       "TestResource", 
-      HasManyObject.new, {
-        :service_uri => '/single_object_association'
-      }
+      HasManyObject.new
     )
+    res.internal_object = {
+      :service_uri => '/single_object_association'
+    }
+    res
   end
 
   context "Comparison" do
@@ -238,10 +240,11 @@ describe "Associations" do
     it "should be able to extract a service uri from the contents hash" do
       ap = Associations::SingleObjectProxy.new(
         "TestResource", 
-        HasManyObject.new, {
-          :service_uri => '/path'
-        }
+        HasManyObject.new
       )
+      ap.internal_object = {
+        :service_uri => '/path'
+      }
       ap.remote_path.should eql("/path")
     end
 
@@ -251,11 +254,13 @@ describe "Associations" do
       TestResource.define_attributes :test
       ap = Associations::SingleObjectProxy.new(
         "TestResource", 
-        HasManyObject.new, {
-          :service_uri => '/path',
-          :test => "testval"
-        }
+        HasManyObject.new
       )
+
+      ap.internal_object = {
+        :service_uri => '/path',
+        :test => "testval"
+      }
       ap.scope?("test").should be_false
       ap.test.should eql("testval")
 
@@ -302,9 +307,9 @@ describe "Associations" do
         it "should be able to recognize a settings hash if it has a service_uri" do
           ap = Associations::MultiObjectProxy.new(
             "TestResource",
-            BelongsToObject.new,
-            [{:service_uri => "/route"}]
+            BelongsToObject.new
           )
+          ap.internal_object = [{:service_uri => "/route"}]
           ap.remote_path.should eql("/route")
         end
 
@@ -312,40 +317,31 @@ describe "Associations" do
           Associations::MultiObjectProxy.remote_path_element = :the_element
           ap = Associations::MultiObjectProxy.new(
             "TestResource",
-            BelongsToObject.new,
-            [{:the_element => "/route"}]
+            BelongsToObject.new
           )
+          ap.internal_object = [{: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", 
-              BelongsToObject,
-              {:hi => 3}
-            )
-          }.should raise_error
-        end
 
         it "should be able to recognize settings from a hash" do
           ap = Associations::MultiObjectProxy.new(
             "TestResource", 
-            BelongsToObject,
-            {:service_uri => "/route"}
+            BelongsToObject
           )
+          ap.internal_object = {:service_uri => "/route"}
           ap.remote_path.should eql("/route")
         end
 
         it "should be able to recognize settings from a hash as a string" do
           ap = Associations::MultiObjectProxy.new(
             "TestResource", 
-            BelongsToObject,
-            {"service_uri" => "/route"}
+            BelongsToObject
           )
+          ap.internal_object = {"service_uri" => "/route"}
           ap.remote_path.should eql("/route")
         end
 
@@ -353,9 +349,9 @@ describe "Associations" do
           Associations::MultiObjectProxy.remote_path_element = :the_element
           ap = Associations::MultiObjectProxy.new(
             "TestResource", 
-            BelongsToObject,
-            {:the_element => "/route"}
+            BelongsToObject
           )
+          ap.internal_object = {:the_element => "/route"}
           ap.remote_path.should eql("/route")
         end
 
@@ -457,10 +453,11 @@ describe "Associations" do
       it "should proxy unknown methods to the object loading if it hasn't already" do
         ap = Associations::SingleObjectProxy.new(
           "TestResource", 
-          HasManyObject.new, {
-            :service_uri => '/single_object_association'
-          }
+          HasManyObject.new
         )
+        ap.internal_object = {
+          :service_uri => '/single_object_association'
+        }
         ap.should_not be_loaded
         ap.id.should_not be_blank
         ap.should be_loaded
@@ -469,10 +466,11 @@ describe "Associations" do
       it "should load scopes with caching" do
         ap = Associations::SingleObjectProxy.new(
           "TestResource", 
-          HasManyObject.new, {
-            :service_uri => '/single_object_association'
-          }
+          HasManyObject.new
         )
+        ap.internal_object = {
+          :service_uri => "/single_object_association"
+        }
         ap.should_not be_loaded
         ap.active.expires_in(30).internal_object
 
@@ -484,30 +482,33 @@ describe "Associations" do
       it "should check that ttl matches the expiration parameter" do
        ap = Associations::SingleObjectProxy.new(
           "TestResource", 
-          HasManyObject.new, {
-            :service_uri => '/single_object_association'
-          }
+          HasManyObject.new
         )
+       ap.internal_object = {
+        :service_uri => "/single_object_association"
+       }
         ap.active.expires_in(10).ttl.should eql(10)
       end
 
       it "should cache scopes when caching enabled" do
         ap = Associations::SingleObjectProxy.new(
           "TestResource", 
-          HasManyObject.new, {
-            :service_uri => '/single_object_association'
-          }
+          HasManyObject.new
         )
+        ap.internal_object = {
+          :service_uri => "/single_object_association"
+        }
         ap.active(:expires_in => 10).internal_object
       end
 
       it "should be able to clear it's loading cache" do
         ap = Associations::SingleObjectProxy.new(
           "TestResource", 
-          HasManyObject.new, {
-            :service_uri => '/single_object_association'
-          }
+          HasManyObject.new
         )
+        ap.internal_object = {
+          :service_uri => '/single_object_association'
+        }
         active = ap.active
 
         active.internal_object
@@ -523,10 +524,11 @@ describe "Associations" do
     it "should be able to reload a single-object association" do
       ap = Associations::SingleObjectProxy.new(
         "TestResource", 
-        HasManyObject.new, {
-          :service_uri => '/single_object_association'
-        }
+        HasManyObject.new
       )
+      ap.internal_object = {
+        :service_uri => '/single_object_association'
+      }
 
       old_name = ap.name
 
@@ -544,10 +546,11 @@ describe "Associations" do
       
       ap = Associations::MultiObjectProxy.new(
         "TestResource", 
-        BelongsToObject.new, {
-          :service_uri => '/multi_object_association'
-        }
+        BelongsToObject.new
       )
+      ap.internal_object = {
+        :service_uri => '/multi_object_association'
+      }
 
       old_name = ap.first.name
 
@@ -566,10 +569,11 @@ describe "Associations" do
       it "should be able to load 'all'" do
         ap = Associations::MultiObjectProxy.new(
           "TestResource", 
-          BelongsToObject.new, {
-            :service_uri => '/multi_object_association'
-          }
+          BelongsToObject.new
         )
+        ap.internal_object = {
+          :service_uri => '/multi_object_association'
+        }
         results = ap.all
         results.size.should eql(5)
         results.first.is_active?.should be_false
@@ -578,10 +582,11 @@ describe "Associations" do
       it "should be able to load a scope" do
         ap = Associations::MultiObjectProxy.new(
           "TestResource", 
-          BelongsToObject.new, {
-            :service_uri => '/multi_object_association'
-          }
+          BelongsToObject.new
         )
+        ap.internal_object = {
+          :service_uri => '/multi_object_association'
+        }
         results = ap.active
         results.size.should eql(5)
         record = results.first
@@ -591,10 +596,11 @@ describe "Associations" do
       it "should be able to load a chain of scopes" do
         ap = Associations::MultiObjectProxy.new(
           "TestResource", 
-          BelongsToObject.new, {
-            :service_uri => '/multi_object_association'
-          }
+          BelongsToObject.new
         )
+        ap.internal_object = {
+          :service_uri => '/multi_object_association'
+        }
         results = ap.active.birthday(Date.today)
         results.first.is_active.should be_true
         results.first.bday.should_not be_blank
@@ -605,10 +611,11 @@ describe "Associations" do
 
         ap = Associations::MultiObjectProxy.new(
           "TestResource", 
-          BelongsToObject.new, {
-            :service_uri => '/multi_object_association'
-          }
+          BelongsToObject.new
         )
+        ap.internal_object = {
+          :service_uri => '/multi_object_association'
+        }
         active = ap.active
 
         active.internal_object
@@ -622,10 +629,11 @@ describe "Associations" do
       it "should be enumerable" do
         ap = Associations::MultiObjectProxy.new(
           "TestResource", 
-          BelongsToObject.new, {
-            :service_uri => '/multi_object_association'
-          }
+          BelongsToObject.new
         )
+        ap.internal_object = {
+          :service_uri => '/multi_object_association'
+        }
         ap.each do |tr|
           tr.name.should_not be_blank
         end

data/spec/lib/base_spec.rb

@@ -61,6 +61,29 @@ describe "Base" do
 
   end
 
+  context "#method_missing" do
+
+    after(:all) do
+      TestResource.reload_resource_definition
+    end
+
+    it "should attempt to reload the resource definition if a method
+      is not found" do
+
+      TestResource.class_eval do
+        remove_method :bday
+      end
+
+      tr = TestResource.new
+      
+      lambda{
+        tr.bday
+      }.should_not raise_error
+
+    end
+
+  end
+
 
   context "Prefixes" do
 

data/spec/support/mocks/association_mocks.rb

@@ -46,6 +46,10 @@ Mocks.define do
       :params => {:test_resource_id => 1}.matcher
     )
   end
+
+  endpoint("/has_one_objects/:id.json") do
+    get(HashDealer.roll(:has_one_object))
+  end
   
   endpoint("/has_many_objects/new") do
     get({

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_resource
 version: !ruby/object:Gem::Version
-  version: 0.6.4
+  version: 0.6.5
   prerelease: 
 platform: ruby
 authors:
@@ -424,7 +424,9 @@ files:
 - nohup.out
 - spec/lib/api_resource_spec.rb
 - spec/lib/associations/association_scope_spec.rb
+- spec/lib/associations/belongs_to_remote_object_proxy_spec.rb
 - spec/lib/associations/has_many_remote_object_proxy_spec.rb
+- spec/lib/associations/has_one_remote_object_proxy_spec.rb
 - spec/lib/associations_spec.rb
 - spec/lib/attributes_spec.rb
 - spec/lib/base_spec.rb
@@ -485,7 +487,9 @@ summary: ActiveRecord for restful APIs
 test_files:
 - spec/lib/api_resource_spec.rb
 - spec/lib/associations/association_scope_spec.rb
+- spec/lib/associations/belongs_to_remote_object_proxy_spec.rb
 - spec/lib/associations/has_many_remote_object_proxy_spec.rb
+- spec/lib/associations/has_one_remote_object_proxy_spec.rb
 - spec/lib/associations_spec.rb
 - spec/lib/attributes_spec.rb
 - spec/lib/base_spec.rb