restforce-db 3.1.8 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d8874f70a0cf3d3c7af7a6a9de53a5671c370167
-  data.tar.gz: 42bc65bde75eb76c8e99e81c1953cf5cba823cac
+  metadata.gz: ab0eecfbe7d96562d9b473a036e8b84b95ea1394
+  data.tar.gz: cb384f1779f4c48d8e654affc00e205ba5a86a8f
 SHA512:
-  metadata.gz: 5856dd8ba049126c320db5e966b5db6c3b44cbcf81ef3369e98b2a37fdcddc3543c07ce5dd4a41bb155c8cf7578a72541474e636b278c653580e60058bcb2799
-  data.tar.gz: d9361ab68c7087ab30eb792cef71bb3f596a4e55deca9006578984fc34ebfeadbccf2926e1bf4b0b48e13af3448d649c297c4b7add2c0ca32c95fac148a63f3a
+  metadata.gz: d7f800c5e374fdb8b3929cd9e23e2b17d31df13d9f74181985edd502248856a1cd39104dcf6131422d19fc4d0f598dd858d71983bda9f88ec52b5aff5cccf2dc
+  data.tar.gz: 518570b3d2d27b7b0bf2b3a3aee7f1403eb98d6932e767aecb535f4e0a772ce8b2104674af6fa5f6105fda4ba6a90a45ef8618cdef7d1e2139bb0f9ac8b35e40

data/README.md

@@ -252,6 +252,19 @@ The task takes several arguments, most of which are optional:
 - `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.
 
+### Pull down missing fields
+
+To populate existing synchronized records with data from newly-mapped fields, you can run the `populate` rake task. This will iterate through _all_ records in your database for the specified model, and populate the specified field on each record. This could potentially take a while if you have a large number of
+records.
+
+    $ bundle exec rake restforce:populate[<model>,<salesforce_model>,<field>]
+
+This task takes a handful of required arguments:
+
+- `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.
+- `salesforce_model`: The name of the specfic Salesforce model to which the desired field is mapped. This object type will be used as the data source.
+- `field`: The name of the attribute to populate on your ActiveRecord model. Will usually correspond to a database column name.
+
 ### 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/version.rb

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

data/lib/restforce/db.rb

@@ -84,17 +84,29 @@ module Restforce
     #
     # Returns a Restforce::Data::Client instance.
     def self.client
-      @client ||= DB::Client.new(
-        username:       configuration.username,
-        password:       configuration.password,
-        security_token: configuration.security_token,
-        client_id:      configuration.client_id,
-        client_secret:  configuration.client_secret,
-        host:           configuration.host,
-        api_version:    configuration.api_version,
-        timeout:        configuration.timeout,
-        adapter:        configuration.adapter,
-      )
+      @client ||= begin
+        client = DB::Client.new(
+          username:       configuration.username,
+          password:       configuration.password,
+          security_token: configuration.security_token,
+          client_id:      configuration.client_id,
+          client_secret:  configuration.client_secret,
+          host:           configuration.host,
+          api_version:    configuration.api_version,
+          timeout:        configuration.timeout,
+          adapter:        configuration.adapter,
+        )
+
+        # NOTE: By default, the Retry middleware will catch timeout exceptions,
+        # and retry up to two times. For more information, see:
+        # https://github.com/lostisland/faraday/blob/master/lib/faraday/request/retry.rb
+        client.middleware.request(
+          :retry,
+          methods: [:get, :head, :options, :put, :patch, :delete],
+        )
+
+        client
+      end
     end
 
     # Public: Get the ID of the Salesforce user which is being used to access

data/lib/tasks/restforce.rake

@@ -18,6 +18,33 @@ namespace :restforce do
     end
   end
 
+  desc "Pull down the requested Salesforce data for the specified model"
+  task :populate, [:model, :salesforce_model, :field] => :environment do |_, args|
+    raise ArgumentError, "An ActiveRecord model name must be supplied" unless args[:model]
+    raise ArgumentError, "A Salesforce model name must be supplied" unless args[:salesforce_model]
+    raise ArgumentError, "An attribute name must be supplied" unless args[:field]
+
+    Rails.application.eager_load!
+
+    model = args[:model].constantize
+    field = args[:field].to_sym
+
+    mapping = Restforce::DB::Registry[model].detect do |m|
+      m.salesforce_model == args[:salesforce_model]
+    end
+
+    raise ArgumentError, "No Mapping was found between #{args[:model]} and #{args[:salesforce_model]}" unless mapping
+
+    model.where.not(mapping.lookup_column => nil).find_each do |record|
+      salesforce_id = record.send(mapping.lookup_column)
+      salesforce_instance = mapping.salesforce_record_type.find(salesforce_id)
+      next unless salesforce_instance
+
+      attributes = mapping.convert(model, salesforce_instance.attributes)
+      record.update_columns field => attributes[field]
+    end
+  end
+
   desc "Get the 18-character version of a 15-character Salesforce ID"
   task :convertid, [:salesforce_id] do |_, args|
     sfid = args[:salesforce_id]

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 3.1.8
+  version: 3.2.0
 platform: ruby
 authors:
 - Andrew Horner
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2015-07-08 00:00:00.000000000 Z
+date: 2015-07-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activerecord