api_resource 0.3.12 → 0.3.13

data/VERSION

@@ -1 +1 @@
-0.3.12
+0.3.13

data/api_resource.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = "api_resource"
-  s.version = "0.3.12"
+  s.version = "0.3.13"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Ethan Langevin"]
-  s.date = "2012-09-11"
+  s.date = "2012-09-20"
   s.description = "A replacement for ActiveResource for RESTful APIs that handles associated object and multiple data sources"
   s.email = "ejl6266@gmail.com"
   s.extra_rdoc_files = [
@@ -35,6 +35,7 @@ Gem::Specification.new do |s|
     "lib/api_resource/associations/belongs_to_remote_object_proxy.rb",
     "lib/api_resource/associations/dynamic_resource_scope.rb",
     "lib/api_resource/associations/has_many_remote_object_proxy.rb",
+    "lib/api_resource/associations/has_many_through_remote_object_proxy.rb",
     "lib/api_resource/associations/has_one_remote_object_proxy.rb",
     "lib/api_resource/associations/multi_argument_resource_scope.rb",
     "lib/api_resource/associations/multi_object_proxy.rb",
@@ -83,7 +84,7 @@ Gem::Specification.new do |s|
   s.homepage = "http://github.com/ejlangev/resource"
   s.licenses = ["MIT"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.24"
+  s.rubygems_version = "1.8.22"
   s.summary = "A replacement for ActiveResource for RESTful APIs that handles associated object and multiple data sources"
 
   if s.respond_to? :specification_version then

data/lib/api_resource/associations/has_many_remote_object_proxy.rb

@@ -13,4 +13,4 @@ module ApiResource
       end
     end
   end
-end
+end

data/lib/api_resource/associations/has_many_through_remote_object_proxy.rb

@@ -0,0 +1,13 @@
+module ApiResource
+  module Associations
+    module HasManyThroughRemoteObjectProxy
+      def has_many_through_remote(association, options) 
+        self.instance_eval do
+          send(:define_method, association) do
+            send(options[:through]).collect{ |t| t.send(association.to_s.singularize) }.flatten  
+          end
+        end
+      end
+    end    
+  end
+end

data/lib/api_resource/associations/relation_scope.rb

@@ -8,7 +8,9 @@ module ApiResource
 
       # Use this method to access the internal data, this guarantees that loading only occurs once per object
       def internal_object
-        @internal_object ||= self.klass.send(:load_scope_with_options, self.current_scope, self.to_hash)
+        ApiResource.with_ttl(ttl) do
+          @internal_object ||= self.klass.send(:load_scope_with_options, self.current_scope, self.to_hash)
+        end
       end
       # 
       # class factory

data/lib/api_resource/associations/resource_scope.rb

@@ -9,7 +9,9 @@ module ApiResource
       include Enumerable
 
       def internal_object
-        @internal_object ||= self.klass.send(:find, :all, :params => self.to_hash)
+        ApiResource.with_ttl(ttl) do
+          @internal_object ||= self.klass.send(:find, :all, :params => self.to_hash)
+        end
       end
       
       alias_method :all, :internal_object
@@ -31,4 +33,4 @@ module ApiResource
       end
     end
   end
-end
+end

data/lib/api_resource/associations/scope.rb

@@ -12,6 +12,7 @@ module ApiResource
         # Holds onto the association proxy this RelationScope is bound to
         @klass = klass
         @parent = opts.delete(:parent)
+        @ttl = opts.delete(:expires_in)
         # splits on _and_ and sorts to get a consistent scope key order
         @current_scope = (self.parent_scope + Array.wrap(current_scope.to_s)).sort
         # define methods for the scopes of the object
@@ -32,7 +33,11 @@ module ApiResource
         # This expression substitutes the options from opts into the default attributes of the scope, it will only copy keys that exist in the original
         self.scopes[self.current_scope] = opts.inject(self.scopes[current_scope]){|accum,(k,v)| accum.key?(k.to_s) ? accum.merge(k.to_s => v) : accum}
       end
-
+      
+      def ttl
+        @ttl || 0
+      end
+      
       # Use this method to access the internal data, this guarantees that loading only occurs once per object
       def internal_object
         raise "Not Implemented: This method must be implemented in a subclass"

data/lib/api_resource/associations.rb

@@ -10,6 +10,7 @@ require 'api_resource/associations/single_object_proxy'
 require 'api_resource/associations/belongs_to_remote_object_proxy'
 require 'api_resource/associations/has_one_remote_object_proxy'
 require 'api_resource/associations/has_many_remote_object_proxy'
+require 'api_resource/associations/has_many_through_remote_object_proxy'
 require 'api_resource/associations/related_object_hash'
 
 module ApiResource
@@ -50,7 +51,7 @@ module ApiResource
         self.activate_associations(
           :has_many_remote => :has_many_remote, 
           :belongs_to_remote => :belongs_to_remote, 
-          :has_one_remote => :has_one_remote
+          :has_one_remote => :has_one_remote,
         )
       end
     end

data/lib/api_resource/base.rb

@@ -260,16 +260,23 @@ module ApiResource
         self.new(attributes).tap{ |resource| resource.save }
       end
       
+      # This decides which finder method to call. 
+      # It accepts arguments of the form "scope", "options={}"
+      # where options can be standard rails options or :expires_in. 
+      # If :expires_in is set, it caches it for expires_in seconds.
       def find(*arguments)
         scope   = arguments.slice!(0)
         options = arguments.slice!(0) || {}
-
-        case scope
-          when :all   then find_every(options)
-          when :first then find_every(options).first
-          when :last  then find_every(options).last
-          when :one   then find_one(options)
-          else             find_single(scope, options)
+        
+        expiry = options.delete(:expires_in) || ApiResource::Base.ttl || 0
+        ApiResource.with_ttl(expiry.to_f) do
+          case scope
+            when :all   then find_every(options)
+            when :first then find_every(options).first
+            when :last  then find_every(options).last
+            when :one   then find_one(options)
+            else             find_single(scope, options)
+          end
         end
       end
 

data/lib/api_resource/scopes.rb

@@ -42,4 +42,4 @@ module ApiResource
     end
     
   end
-end
+end

data/spec/lib/associations_spec.rb

@@ -393,6 +393,20 @@ describe "Associations" do
         ap.times_loaded.should eql(1)
       end
       
+      it "should load scopes with caching" 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, :expires_in => 10).internal_object
+        ap.times_loaded.should eql(1)
+        ap.active(:active => true, :expires_in => 10).ttl.should eql(10)
+      end
+      
+      it "should cache scopes when caching enabled" do
+        ap = Associations::SingleObjectProxy.new("TestResource",{:service_uri => '/single_object_association', :active => {:active => false}, :with_birthday => {:birthday => true}, :scopes_only => true})
+        ApiResource.expects(:with_ttl).with(10)
+        ap.active(:active => true, :expires_in => 10).internal_object
+      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)
@@ -658,13 +672,11 @@ describe "Associations" do
           end
         end
         context "Belongs To" do
-
           before(:all) do
             TestAR.class_eval do
               belongs_to_remote :test_resource
             end
           end
-
           it "should attempt to load a single remote object for a belongs_to relationship" do
             tar = TestAR.new
             tar.stubs(:test_resource_id).returns(1)
@@ -672,7 +684,6 @@ describe "Associations" do
             # load the test resource
             tar.test_resource.name.should eql "testing"
           end
-          
         end
         context "Has One" do
           before(:all) do
@@ -701,7 +712,28 @@ describe "Associations" do
             # load the test resource
             tar.has_many_objects.first.name.should eql "testing"
           end
-          
+        end
+        context "Has Many Through" do
+          before(:all) do       
+            TestAR.class_eval do 
+              self.extend ApiResource::Associations::HasManyThroughRemoteObjectProxy
+              has_many :test_throughs
+              has_many_through_remote(:belongs_to_objects, :through => :test_throughs)
+            end
+          end
+          it "should attempt to load a collection of remote objects for a has_many_through relationship" do
+            tar = TestAR.new
+            through_test_resource_1 = TestThrough.new
+            through_test_resource_2 = TestThrough.new
+            belongs_to_object_1 = BelongsToObject.new
+            belongs_to_object_2 = BelongsToObject.new
+            tar.expects(:test_throughs).returns([through_test_resource_1, through_test_resource_2])
+            through_test_resource_1.expects(:belongs_to_object).returns([belongs_to_object_1])
+            through_test_resource_2.expects(:belongs_to_object).returns([belongs_to_object_2])
+
+            tar.belongs_to_objects.should eql [belongs_to_object_1, belongs_to_object_2]
+          end
+
         end
       end
     end

data/spec/lib/base_spec.rb

@@ -621,6 +621,14 @@ describe "Base" do
         ApiResource.stubs(:cache => cache)
         TestResource.find(123)
       end
+      
+      it "should find with expires_in and cache" do
+        ApiResource.cache.expects(:fetch).with(anything, :expires_in => 10.0).returns({:id => 2, :name => "d"})
+        res = TestResource.find("adfa", :expires_in => 10)
+        
+        ApiResource::Base.ttl.should eql(1)
+        res.id.to_i.should eql(2)
+      end
     end
 
   end

data/spec/support/mocks/association_mocks.rb

@@ -54,5 +54,9 @@ Mocks.define do
   endpoint("/childern/new") do
     get({})
   end
+
+  endpoint("/test_throughs/new") do
+    get({})
+  end
   
 end

data/spec/support/test_resource.rb

@@ -39,6 +39,10 @@ class ErrorFullMessageResource < ApiResource::Base
   
 end
 
+class TestThrough < ApiResource::Base
+
+end
+
 module TestMod
   
   module InnerMod

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: api_resource
 version: !ruby/object:Gem::Version
-  version: 0.3.12
+  version: 0.3.13
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-11 00:00:00.000000000 Z
+date: 2012-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -438,6 +438,7 @@ files:
 - lib/api_resource/associations/belongs_to_remote_object_proxy.rb
 - lib/api_resource/associations/dynamic_resource_scope.rb
 - lib/api_resource/associations/has_many_remote_object_proxy.rb
+- lib/api_resource/associations/has_many_through_remote_object_proxy.rb
 - lib/api_resource/associations/has_one_remote_object_proxy.rb
 - lib/api_resource/associations/multi_argument_resource_scope.rb
 - lib/api_resource/associations/multi_object_proxy.rb
@@ -497,7 +498,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 2099614695071453573
+      hash: 3537958463116260436
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -506,7 +507,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.22
 signing_key: 
 specification_version: 3
 summary: A replacement for ActiveResource for RESTful APIs that handles associated