HasRemote 0.1.3 → 0.1.4

data/HasRemote.gemspec

@@ -5,11 +5,11 @@
 
 Gem::Specification.new do |s|
   s.name = %q{HasRemote}
-  s.version = "0.1.3"
+  s.version = "0.1.4"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
   s.authors = ["Sjoerd Andringa"]
-  s.date = %q{2010-01-19}
+  s.date = %q{2010-01-25}
   s.description = %q{Bind a remote ActiveResource object to your local ActiveRecord objects, delegate attributes and optionally cache remote attributes locally.}
   s.email = %q{sjoerd.andringa@innovationfactory.eu}
   s.extra_rdoc_files = [

data/README.rdoc

@@ -120,6 +120,10 @@ certain models by using the <tt>MODELS</tt> variable:
 
  rake hr:sync MODELS=Contact,Company
 
+To specify additional parameters to send with the request that fetches updated resources use the PARAMS variable:
+
+ rake hr:sync PARAMS="since=01-01-2010&limit=25"
+
 === Documentation
 
 To generate RDocs for this plugin, from the has_remote directory run:

data/VERSION

@@ -1 +1 @@
-0.1.3
+0.1.4

data/lib/has_remote/synchronizable.rb

@@ -1,5 +1,5 @@
 module HasRemote
-  
+
   # Contains class methods regarding synchronization of changed, added and deleted remotes.
   #
   # === Synchronization examples
@@ -20,8 +20,8 @@ module HasRemote
   # your cache is up to date or use the 'hr:sync' rake task to synchronize all models
   # from the command line.
   #
-  # *Note* 
-  # All remote resources need to have an 'updated_at' field in order for synchronization to work. Records will 
+  # *Note*
+  # All remote resources need to have an 'updated_at' field in order for synchronization to work. Records will
   # be destroyed if their remote resource's 'deleted_at' time lies before the time of synchronization.
   #
   module Synchronizable
@@ -31,7 +31,7 @@ module HasRemote
     def cached_attributes
       @cached_attributes ||= []
     end
-    
+
     # Returns all remote objects that have been changed since the given time or one week ago if no
     # time is given. This may include new and optionally deleted (tagged by a 'deleted_at' attribute) resources.
     #
@@ -47,19 +47,30 @@ module HasRemote
     #    User::Remote.find :all, :from => :search, :params => {:updated_since => time.strftime('...') }
     #  end
     #
-    def changed_remotes_since(time = nil)
-      time ||= 1.week.ago 
-      remote_class.find :all, :from => :updated, :params => {:since => time.to_s}  
+    # *Arguments*
+    #
+    # [<tt>time</tt>:] The given time that defines since (see above)
+    # [<tt>params</tt>:] Optional hash of additional parameters to send with the request (e.g. {:limit =>  5})
+    #
+    def changed_remotes_since(time = nil, params = {})
+      time ||= 1.week.ago
+      remote_class.find :all, :from => :updated, :params => {:since => time.to_s}.merge(params)
     end
-    
+
     # Will update all records that have been created, updated or deleted on the remote host
     # since the last successful synchronization.
     #
+    # *Options*
+    #
+    # [<tt>since</tt>:] Optionally override the time as of which updated resources are fetched. Also see <tt>changes_remotes_since</tt>.
+    #
+    # All other options are passed in as parameters to <tt>changes_remotes_since</tt>.
+    #
     def synchronize!(options = {})
       logger.info( "*** Start synchronizing #{table_name} at #{Time.now.to_s :long} ***\n" )
       @sync_count = 0
       begin
-        changed_objects = changed_remotes_since( options[:since] || synchronized_at )
+        changed_objects = changed_remotes_since( options.delete(:since) || synchronized_at, options )
         if changed_objects.any?
           # Do everything within transaction to prevent ending up in half-synchronized situation if an exception is raised.
           transaction { sync_all_records_for(changed_objects) }
@@ -69,19 +80,19 @@ module HasRemote
       rescue => e
         logger.warn( " - Synchronization of #{table_name} failed: #{e} \n #{e.backtrace}" )
       else
-        self.synchronized_at = changed_objects.map { |o| time_of_update(o) }.sort.last if changed_objects.any?  
+        self.synchronized_at = changed_objects.map { |o| time_of_update(o) }.sort.last if changed_objects.any?
         logger.info( " - Synchronized #{@sync_count} #{table_name}.\n" ) if @sync_count > 0
       ensure
         logger.info( "*** Stopped synchronizing #{table_name} at #{Time.now.to_s :long} ***\n" )
       end
     end
-    
+
     # Time of the last successful synchronization.
     #
     def synchronized_at
       HasRemote::Synchronization.for(self.name).latest_change
     end
-    
+
   private
 
     def synchronized_at=(time) #:nodoc:
@@ -91,7 +102,7 @@ module HasRemote
     def sync_all_records_for(resources) #:nodoc:
       resources.each { |resource| sync_all_records_for_resource(resource) }
     end
-    
+
     def sync_all_records_for_resource(resource) #:nodoc:
       records = find(:all, :conditions => ["#{remote_foreign_key} = ?", resource.send(remote_primary_key)])
       if records.empty?
@@ -100,7 +111,7 @@ module HasRemote
         records.each { |record| sync_record_for_resource(record, resource) }
       end
     end
-    
+
     def sync_record_for_resource(record, resource) #:nodoc:
       if deleted?(resource)
         delete_record_for_resource(record, resource)
@@ -108,7 +119,7 @@ module HasRemote
         update_and_save_record_for_resource(record, resource)
       end
     end
-    
+
     def update_and_save_record_for_resource(record, resource) #:nodoc:
       was_it_new = record.new_record?
       cached_attributes.each do |remote_attr|
@@ -121,24 +132,24 @@ module HasRemote
         logger.info( was_it_new ? " - Created #{name.downcase} with id #{record.id}.\n" : " - Updated #{name.downcase} with id #{record.id}.\n" )
       end
     end
-    
+
     def delete_record_for_resource(record, resource) #:nodoc:
       record.destroy
       @sync_count += 1
       logger.info( " - Deleted #{name.downcase} with id #{record.id}.\n" )
     end
-    
+
     def create_record_for_resource(resource) #:nodoc:
       update_and_save_record_for_resource(new(remote_foreign_key => resource.send(remote_primary_key)), resource)
     end
-    
+
     def time_of_update(resource)
       (resource.respond_to?(:deleted_at) && resource.deleted_at) ? resource.deleted_at : resource.updated_at
     end
-    
+
     def deleted?(resource)
       resource.respond_to?(:deleted_at) && resource.deleted_at && resource.deleted_at <= Time.now
     end
 
-  end  
-end
+  end
+end

data/lib/has_remote/tasks.rb

@@ -3,11 +3,11 @@ namespace :hr do
   desc 'Synchronizes all attributes locally cached by has_remote'
   task :sync => :environment do
     models = ENV['MODELS'].nil? ? HasRemote.models : extract_models
-    models.each(&:synchronize!)
+    options = ENV['PARAMS'] ? Rack::Utils.parse_query(ENV['PARAMS']) : {}
+    models.each{|model| model.synchronize!(options)}
   end
 
   def extract_models
     ENV['MODELS'].split(',').map(&:constantize)
   end
-
-end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: HasRemote
 version: !ruby/object:Gem::Version 
-  version: 0.1.3
+  version: 0.1.4
 platform: ruby
 authors: 
 - Sjoerd Andringa
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-19 00:00:00 +01:00
+date: 2010-01-25 00:00:00 +01:00
 default_executable: 
 dependencies: []