salesforce_ar_sync 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b19087f9160aa21606e6de401c9813e693fb306d
-  data.tar.gz: 7bded65098335e5f1be42efa9bca7a8219c9e419
+  metadata.gz: f37d587db2ecda95601160de49a915cff74ca31a
+  data.tar.gz: e3451ccede1bcbe1a1ac6e59aa39241a0862f5cd
 SHA512:
-  metadata.gz: 5a7d57027cd4067238f8992cfffda917b6dee7654cef6068e4e21c86f27f829fdb65e20e20497558581691165d4b1a02c814a989ba0c788ce310da3879f24b66
-  data.tar.gz: 36219dd2e81e11afcfb77f73ba098c0f6dc427b9a9a7e764fa420c467eea15e2c5fc04877d79717119da6e0fad14675711e2a6dc37289d7ea0d2a59a75da3120
+  metadata.gz: 2fb081124bed9670b20b5485136dd1adbfedc7fd6b28db5438d1ddf0c1c11a04c96cb8a9f6dbf72b665c8f76b3c2fc853d1f57064840bd23c9d36babe44a8703
+  data.tar.gz: 6a3edd80c362394d93906a2888d8b9fb54fe4023c81c3a58dcb38efc3aac2edf094dfd9c3877178c71cb360875f1868224c1e23cca6d83acf82f82096914266f

data/README.md

@@ -111,6 +111,7 @@ The options available to configure are
 * __organization_id__: the 18 character organization id of your Salesforce instance
 * __sync_enabled__: a global sync enabled flag which is a boolean true/false
 * __namespace_prefix__: Namespace prefix of your Salesforce app in case you specified one
+* __deletion_map__: Salesforce object names mapped to internal app name.
 
 To generate a YAML file
 
@@ -125,6 +126,7 @@ which will create a template salesforce_ar_sync.yml in /config that looks like t
     organization_id: <organization id> #18 character organization_id
     sync_enabled: true
     namespace_prefix:
+    deletion_map:
 
 
 To use the ENV variable you must pass environemnt variables to rails via the _export_ command in bash or before the
@@ -134,6 +136,12 @@ initializer loads the ENV settings.
     $ export SALESFORCE_AR_SYNC_SYNC_ENABLED=true
     $ export SALESFORCE_AR_NAMESPACE_PREFIX=my_prefix
 
+An example of adding an aliased object to the deletion map should look like the following:
+
+    deletion_map:
+     -
+      Account: 'YourModelName'
+
 ### Model Options
 The model can have several options set:
 
@@ -159,6 +167,8 @@ The model can have several options set:
 
 [__except__](#except)
 
+[__unscoped_updates__](#unscoped_updates)
+
 #### <a id="salesforce_sync_enabled"></a>salesforce_sync_enabled
 Model level option to enable disable the sync, defaults to true.
 
@@ -246,6 +256,14 @@ method is given then only the salesforce_skip_sync attribute is used. Defaults t
 :except => :except_method_name
 ````
 
+#### unscoped_updates
+Enable bypassing the default scope when searching for records to update.  This is useful when using a
+soft deletion strategy that can respect SF undeletion.
+
+````ruby
+:unscoped_updates => true
+````
+
 ### Stopping the Sync
 
 Stopping the gem from syncing can be done on three levels.
@@ -430,6 +448,16 @@ This is done using the :sync_outbound_delete option, which can take either a boo
   end
 ```
 
+### Soft Deletes
+Setting unscoped_updates to true will permit you to find deleted objects to sync changes to.  You can implement virtual attributes matching the
+undelete field in SF to implement the soft deletion strategy of your choosing.  For the paranoia gem:
+
+```ruby
+  def undeleted=(value)
+    restore if value
+  end
+```
+
 ## Errors
 
 ### Outbound Message Errors

data/app/controllers/salesforce_ar_sync/soap_message_controller.rb

@@ -1,7 +1,9 @@
 module SalesforceArSync
   class SoapMessageController < ::ApplicationController
+
+    protect_from_forgery with: :null_session
     before_filter :validate_ip_ranges
-    
+
     def sync_object
       delayed_soap_handler SalesforceArSync::SoapHandler::Base
     end

data/lib/generators/salesforce_ar_sync/configuration/templates/salesforce_ar_sync.yml

@@ -4,17 +4,20 @@ production:
   # Salesforce owned IPs from: https://help.salesforce.com/apex/HTViewSolution?language=en_US&id=000003652
   ip_ranges: "204.14.232.0/23,204.14.237.0/24,96.43.144.0/22,96.43.148.0/22,204.14.234.0/23,204.14.238.0/23,182.50.76.0/22"
   namespace_prefix:
-  
+  deletion_map:
+
 development:
   organization_id: <%= @organization_id %>
   sync_enabled: false
   # Salesforce owned IPs from: https://help.salesforce.com/apex/HTViewSolution?language=en_US&id=000003652
   ip_ranges: "204.14.232.0/23,204.14.237.0/24,96.43.144.0/22,96.43.148.0/22,204.14.234.0/23,204.14.238.0/23,182.50.76.0/22"
   namespace_prefix:
-    
+  deletion_map:
+
 test:
   organization_id: <%= @organization_id %>
   sync_enabled: false
   # Salesforce owned IPs from: https://help.salesforce.com/apex/HTViewSolution?language=en_US&id=000003652
   ip_ranges: "204.14.232.0/23,204.14.237.0/24,96.43.144.0/22,96.43.148.0/22,204.14.234.0/23,204.14.238.0/23,182.50.76.0/22"
-  namespace_prefix:
+  namespace_prefix:
+  deletion_map:

data/lib/salesforce_ar_sync/engine.rb

@@ -3,7 +3,7 @@ module SalesforceArSync
     initializer "salesforce_ar_sync.load_app_instance_data" do |app|
       SalesforceArSync.setup do |config|
         config.app_root = app.root
-        
+
         #Load the configuration from the environment or a yaml file or disable it if no config present
         SalesforceArSync.config = Hash.new
         #load the config file if we have it
@@ -13,6 +13,7 @@ module SalesforceArSync
           SalesforceArSync.config["SYNC_ENABLED"] = config['sync_enabled']
           SalesforceArSync.config["IP_RANGES"] = config['ip_ranges'].split(',').map{ |ip| ip.strip }
           SalesforceArSync.config["NAMESPACE_PREFIX"] = config['namespace_prefix']
+          SalesforceArSync.config['DELETION_MAP'] = config['deletion_map'].stringify_keys
         end
 
         #if we have ENV flags prefer them
@@ -20,6 +21,7 @@ module SalesforceArSync
         SalesforceArSync.config["SYNC_ENABLED"] = ENV["SALESFORCE_AR_SYNC_SYNC_ENABLED"] if ENV.include? "SALESFORCE_AR_SYNC_SYNC_ENABLED"
         SalesforceArSync.config["IP_RANGES"] = ENV["SALESFORCE_AR_SYNC_IP_RANGES"].split(',').map{ |ip| ip.strip } if ENV["SALESFORCE_AR_SYNC_IP_RANGES"]
         SalesforceArSync.config["NAMESPACE_PREFIX"] = ENV["SALESFORCE_AR_NAMESPACE_PREFIX"] if ENV["SALESFORCE_AR_NAMESPACE_PREFIX"]
+        SalesforceArSync.config['DELETION_MAP'] = ENV['DELETION_MAP'] if ENV['DELETION_MAP']
 
         #do we have valid config options now?
         if !SalesforceArSync.config["ORGANIZATION_ID"].present? || SalesforceArSync.config["ORGANIZATION_ID"].length != 18

data/lib/salesforce_ar_sync/extenders/salesforce_syncable.rb

@@ -17,6 +17,7 @@ module SalesforceArSync
 
         self.sync_inbound_delete = options.has_key?(:sync_inbound_delete) ? options[:sync_inbound_delete] : true
         self.sync_outbound_delete = options.has_key?(:sync_outbound_delete) ? options[:sync_outbound_delete] : false
+        self.unscoped_updates = options.has_key?(:unscoped_updates) ? options[:unscoped_updates] : false
 
         self.salesforce_object_name_method = options.has_key?(:salesforce_object_name) ? options[:salesforce_object_name] : nil
         self.salesforce_skip_sync_method = options.has_key?(:except) ? options[:except] : nil

data/lib/salesforce_ar_sync/salesforce_sync.rb

@@ -39,6 +39,9 @@ module SalesforceArSync
       attr_accessor :sync_inbound_delete
       attr_accessor :sync_outbound_delete
 
+      # Specify whether we should use an unscoped find to update an object (useful with paranoia gem to handle undeletes)
+      attr_accessor :unscoped_updates
+
       attr_accessor :salesforce_web_id_attribute_name
       attr_accessor :salesforce_sync_web_id
       attr_accessor :activerecord_web_id_attribute_name
@@ -56,12 +59,12 @@ module SalesforceArSync
       # Lastly it will create a new record setting it's salesforce_id
       def salesforce_update(attributes={})
         raise ArgumentError, "#{salesforce_id_attribute_name} parameter required" if attributes[salesforce_id_attribute_name].blank?
-
-        object = self.find_by(salesforce_id: attributes[salesforce_id_attribute_name])
-        object ||= self.find_by(activerecord_web_id_attribute_name => attributes[salesforce_web_id_attribute_name]) if salesforce_sync_web_id? && attributes[salesforce_web_id_attribute_name]
+        data_source = unscoped_updates ? unscoped : self
+        object = data_source.find_by(salesforce_id: attributes[salesforce_id_attribute_name])
+        object ||= data_source.find_by(activerecord_web_id_attribute_name => attributes[salesforce_web_id_attribute_name]) if salesforce_sync_web_id? && attributes[salesforce_web_id_attribute_name]
 
         if object.nil?
-          object = self.new
+          object = new
           salesforce_default_attributes_for_create.merge(:salesforce_id => attributes[salesforce_id_attribute_name]).each_pair do |k, v|
             object.send("#{k}=", v)
           end

data/lib/salesforce_ar_sync/soap_handler/base.rb

@@ -34,9 +34,9 @@ module SalesforceArSync
 
       #xml for SFDC response
       #called from soap_message_controller
-      def generate_response(error = nil)      
+      def generate_response(error = nil)
         response = "<Ack>#{sobjects.nil? ? false : true}</Ack>" unless error
-        if error 
+        if error
           response = "<soapenv:Fault><faultcode>soap:Receiver</faultcode><faultstring>#{error.message}</faultstring></soapenv:Fault>"
         end
         return "<?xml version=\"1.0\" encoding=\"UTF-8\"?><soapenv:Envelope xmlns:soapenv=\"http://schemas.xmlsoap.org/soap/envelope/\" xmlns:xsd=\"http://www.w3.org/2001/XMLSchema\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\"><soapenv:Body><notificationsResponse>#{response}</notificationsResponse></soapenv:Body></soapenv:Envelope>"
@@ -45,11 +45,17 @@ module SalesforceArSync
       def self.namespaced(field)
          SalesforceArSync.config["NAMESPACE_PREFIX"].present? ? :"#{SalesforceArSync.config["NAMESPACE_PREFIX"]}__#{field}" : :"#{field}"
       end
-    
+
+      # Get configuration for the in app deletions.
+      # Map to the object within the app if named differently then in SalesForce
+      def self.deletion_map(field)
+        SalesforceArSync.config['DELETION_MAP'].fetch(field, field)
+      end
+
       private
 
       def collect_sobjects
-        notification = @xml_hashed["Envelope"]["Body"]["notifications"]["Notification"] 
+        notification = @xml_hashed["Envelope"]["Body"]["notifications"]["Notification"]
         if notification.is_a? Array
           return notification.collect{ |h| h["sObject"].symbolize_keys}
         else
@@ -58,4 +64,4 @@ module SalesforceArSync
       end
     end
   end
-end
+end

data/lib/salesforce_ar_sync/soap_handler/delete.rb

@@ -1,19 +1,21 @@
 module SalesforceArSync
   module SoapHandler
     class Delete < SalesforceArSync::SoapHandler::Base
-       def process_notifications(priority = 90)
-         batch_process do |sobject|
-           SalesforceArSync::SoapHandler::Delete.delay(:priority => priority, :run_at => 5.seconds.from_now).delete_object(sobject)
-         end
-       end
+      def process_notifications(priority = 90)
+        batch_process do |sobject|
+          SalesforceArSync::SoapHandler::Delete.delay(priority: priority, run_at: 5.seconds.from_now).delete_object(sobject)
+        end
+      end
 
-       def self.delete_object(hash = {})
-         raise ArgumentError, "Object_Id__c parameter required" if hash[namespaced(:Object_Id__c)].blank?
-         raise ArgumentError, "Object_Type__c parameter required" if hash[namespaced(:Object_Type__c)].blank?
-     
-         object = hash[namespaced(:Object_Type__c)].constantize.find_by_salesforce_id(hash[namespaced(:Object_Id__c)])
-         object.destroy if object && object.ar_sync_inbound_delete?
-       end
+      def self.delete_object(hash = {})
+        raise ArgumentError, 'Object_Id__c parameter required' if hash[namespaced(:Object_Id__c)].blank?
+        raise ArgumentError, 'Object_Type__c parameter required' if hash[namespaced(:Object_Type__c)].blank?
+        raise Exception, "Deletion failed: No class found for #{hash[namespaced(:Object_Type__c)]}" unless deletion_map(hash[namespaced(:Object_Type__c)]).safe_constantize
+
+        object = deletion_map(hash[namespaced(:Object_Type__c)]).safe_constantize.try(:find_by_salesforce_id, hash[namespaced(:Object_Id__c)])
+
+        object.destroy if object && object.ar_sync_inbound_delete?
+      end
     end
-   end
- end
+  end
+end

data/lib/salesforce_ar_sync/version.rb

@@ -1,3 +1,3 @@
 module SalesforceArSync
-  VERSION = "2.0.0"
+  VERSION = "2.0.1"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_ar_sync
 version: !ruby/object:Gem::Version
-  version: 2.0.0
+  version: 2.0.1
 platform: ruby
 authors:
 - Michael Halliday
@@ -12,7 +12,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-06-09 00:00:00.000000000 Z
+date: 2016-04-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rails
@@ -188,7 +188,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.7
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: ActiveRecord extension & rails engine for syncing data with Salesforce.com