restforce-db 1.2.5 → 1.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 36ac82d6b0fe9d4374bfe7ee11b60fd36278b4ba
-  data.tar.gz: 934bdb3ef457e51ac31bc1a80e101f789f803bf2
+  metadata.gz: 1841b09cb85809cd87a0f6ae83a6447054b882a6
+  data.tar.gz: 625a699341da7e4291c50ccb93fa20d2a0b03b0f
 SHA512:
-  metadata.gz: ad9bea1820a4bfc48caa95dfbaf24860a3564a69d9d7598eae02478c98a764f9252273495e51a48a897c3466b0281a13b4bb95596567fa17f5145eace8ea9ca1
-  data.tar.gz: 21188a40abaef043ada3c41bf197e1da4b4502e516e980e89fe9001d0f710dffd0170fcb7846aa1f0feba121e88fc1614124f60e2a0e9c419ed6f562b02f0c86
+  metadata.gz: 1f8500084cc35f4bd96f51e0f9d8c5f3403c65affd1912bb96053ccc3f36c4191fabd449bcb20c6c4a00fb97c41b5dfcecd4384ccf4926985e18223eb5ebadc0
+  data.tar.gz: 3b1d6678aa40b3959540454c3cf8c0f5cccc63a62fd3e59cbe2e2ad1800e5b1f9d88773be23da7db9203be048255f1811501e64731c68045838866fc98369032

data/README.md

@@ -173,6 +173,21 @@ In the above example, `Dish__c` is a Salesforce object type which references the
 __NOTE__: Unlike `has_one` associations, `has_many` associations do not currently support multiple lookups from the same model. The Lookup is assumed
 to always refer to the `Id` of the parent object.
 
+### Seed your data
+
+To populate your database with existing information from Salesforce (or vice-versa), you _could_ manually update each of the records you care about, and expect the Restforce::DB daemon to automatically pick them up when it runs. However, for any record type you need/want to _fully_ synchronize, this can be a very tedious process. 
+
+In these cases, you can run the `seed` rake task to synchronize the initial records between both systems.
+
+    $ bundle exec rake restforce:seed[<model>,<start_time>,<end_time>,<config>]
+
+The task takes several arguments, most of which are optional:
+
+- `model`: The name of the ActiveRecord model you wish to sync. This can be any model you've defined a mapping for in your application.
+- `start_time` (optional): The earliest point in time for which records should be gathered.
+- `end_time` (optional): The latest point in time for which records should be gathered.
+- `config` (optional): The path to the file containing your Restforce::DB credentials. If not explicitly provided, the default installation file path (see above) will be used.
+
 ### Run the daemon
 
 To actually perform this system synchronization, you'll want to run the binstub installed through the generator (see above). This will daemonize a process which loops repeatedly to continuously synchronize your database and your Salesforce account, according to the established mappings.

data/lib/restforce/db/railtie.rb

@@ -0,0 +1,19 @@
+module Restforce
+
+  module DB
+
+    # Restforce::DB::Railtie makes Restforce::DB's rake tasks available to any
+    # Rails application which requires the gem.
+    class Railtie < Rails::Railtie
+
+      railtie_name :"restforce-db"
+
+      rake_tasks do
+        load "tasks/restforce.rake"
+      end
+
+    end
+
+  end
+
+end

data/lib/restforce/db/runner.rb

@@ -7,7 +7,8 @@ module Restforce
     # modified records within the context of a specific Mapping.
     class Runner
 
-      attr_reader :last_run, :before, :after
+      attr_reader :last_run
+      attr_accessor :before, :after
 
       # Public: Initialize a new Restforce::DB::Runner.
       #

data/lib/restforce/db/version.rb

@@ -3,7 +3,7 @@ module Restforce
   # :nodoc:
   module DB
 
-    VERSION = "1.2.5"
+    VERSION = "1.2.6"
 
   end
 

data/lib/restforce/db.rb

@@ -39,6 +39,8 @@ require "restforce/db/synchronizer"
 require "restforce/db/tracker"
 require "restforce/db/worker"
 
+require "restforce/db/railtie" if defined?(Rails)
+
 module Restforce
 
   # Restforce::DB exposes basic Restforce client configuration methods for use

data/lib/tasks/restforce.rake

@@ -0,0 +1,20 @@
+namespace :restforce do
+  desc "Populate all records for a specific model within the specified timespan"
+  task :seed, [:model, :start_time, :end_time, :config] => :environment do |_, args|
+    raise ArgumentError, "the name of an ActiveRecord model must be supplied" unless args[:model]
+
+    config_file = args[:config] || Rails.root.join("config", "restforce-db.yml")
+    Restforce::DB.configure { |config| config.parse(config_file) }
+
+    runner = Restforce::DB::Runner.new
+    runner.after = Time.parse(args[:start_time]) if args[:start_time].present?
+    runner.before = Time.parse(args[:end_time]) if args[:end_time].present?
+
+    target_class = args[:model].constantize
+    Restforce::DB::Registry[target_class].each do |mapping|
+      puts "SYNCHRONIZING between #{mapping.database_model.name} and #{mapping.salesforce_model}"
+      Restforce::DB::Initializer.new(mapping, runner).run
+      puts "DONE"
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 1.2.5
+  version: 1.2.6
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-04-27 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord
@@ -224,6 +224,7 @@ files:
 - lib/restforce/db/instances/salesforce.rb
 - lib/restforce/db/mapping.rb
 - lib/restforce/db/model.rb
+- lib/restforce/db/railtie.rb
 - lib/restforce/db/record_types/active_record.rb
 - lib/restforce/db/record_types/base.rb
 - lib/restforce/db/record_types/salesforce.rb
@@ -238,6 +239,7 @@ files:
 - lib/restforce/db/version.rb
 - lib/restforce/db/worker.rb
 - lib/restforce/extensions.rb
+- lib/tasks/restforce.rake
 - restforce-db.gemspec
 - test/cassettes/Restforce_DB/accessing_Salesforce/uses_the_configured_credentials.yml
 - test/cassettes/Restforce_DB_Associations_BelongsTo/with_an_inverse_mapping/_build/returns_an_associated_record_populated_with_the_Salesforce_attributes.yml