restforce-db 2.0.0 → 2.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: e92a8e2216150a27646cdd8525a951100055ad99
-  data.tar.gz: 07ade758ff323cd721daede50850a724562df0b1
+  metadata.gz: bd30e064e5e85ed7a3324e54e08797f34df84c84
+  data.tar.gz: 43bf5c31a7517094be1fbb875c701d9b580a4121
 SHA512:
-  metadata.gz: be4a146095c1555becbb048bd0944b56d37fe8c14231cc2e27355f30c372526ced00f8767ed486d14117af61dc47c8b4d55c28d95b99d74723a4f6ec83993c4e
-  data.tar.gz: d5a0929ca903969593e9037961a9ba2874329fa9f3f30e58fee67fa993c1b6d3bdc9bec2a84b06ccd0dee6c0a210261b95b2a9ff0212b80e6f65dc472068c8ca
+  metadata.gz: 9c8c3b7f0ce2cd131c643f2d33f7c15c719b820522e67696bb6d6a4eeb9ef80a77d4a841d8a7d0bf7a8a66fd9caf252357e29cd245f4257823a9d85c55cb9e63
+  data.tar.gz: e75e5b35ed86a07426eea1926ae642d7176167a7de858934a3e251399efe0f85af30fca97e1ea12f93ff9fbcddf7bf925bd08221bb1158e9520987da5ea16d46

data/lib/restforce/db/accumulator.rb

@@ -44,6 +44,19 @@ module Restforce
         end
       end
 
+      # Public: Do the canonical attributes stored in this Accumulator differ
+      # from those in the passed comparison Hash?
+      #
+      # comparison - A Hash mapping of attributes to values.
+      #
+      # Returns a Boolean.
+      def changed?(comparison)
+        attributes.any? do |attribute, value|
+          next unless comparison.key?(attribute)
+          comparison[attribute] != value
+        end
+      end
+
     end
 
   end

data/lib/restforce/db/field_processor.rb

@@ -0,0 +1,70 @@
+module Restforce
+
+  module DB
+
+    # Restforce::DB::FieldProcessor encapsulates logic for preventing
+    # information for unwriteable fields from being submitted to Salesforce.
+    class FieldProcessor
+
+      # Internal: Get a global cache with which to store/fetch the writable
+      # fields for each Salesforce SObject Type.
+      #
+      # Returns a Hash.
+      def self.field_cache
+        @field_cache ||= {}
+      end
+
+      # Internal: Clear out the global field cache.
+      #
+      # Returns nothing.
+      def self.reset
+        @field_cache = {}
+      end
+
+      # Public: Get a restricted version of the passed attributes Hash, with
+      # unwritable fields stripped out.
+      #
+      # sobject_type - A String name of an SObject Type in Salesforce.
+      # attributes   - A Hash with keys corresponding to Salesforce field names.
+      #
+      # Returns a Hash.
+      def process(sobject_type, attributes)
+        attributes.each_with_object({}) do |(field, value), processed|
+          next unless writable?(sobject_type, field)
+          processed[field] = value
+        end
+      end
+
+      private
+
+      # Internal: Is the passed attribute writable for the passed SObject Type?
+      #
+      # sobject_type - A String name of an SObject Type in Salesforce.
+      # field        - A String Salesforce field API name.
+      #
+      # Returns a Boolean.
+      def writable?(sobject_type, field)
+        field_statuses(sobject_type)[field]
+      end
+
+      # Internal: Get a collection of all fields for the passed Salesforce
+      # SObject Type, with an indication of whether or not they are writable.
+      #
+      # sobject_type - A String name of an SObject Type in Salesforce.
+      #
+      # Returns a Hash.
+      def field_statuses(sobject_type)
+        self.class.field_cache[sobject_type] ||= begin
+          fields = Restforce::DB.client.describe(sobject_type).fields
+
+          fields.each_with_object({}) do |field, output|
+            output[field["name"]] = field["updateable"]
+          end
+        end
+      end
+
+    end
+
+  end
+
+end

data/lib/restforce/db/instances/salesforce.rb

@@ -21,6 +21,16 @@ module Restforce
           @record.Id
         end
 
+        # Public: Update the instance with the passed attributes.
+        #
+        # attributes - A Hash mapping attribute names to values.
+        #
+        # Returns self.
+        # Raises if the update fails for any reason.
+        def update!(attributes)
+          super FieldProcessor.new.process(@record_type, attributes)
+        end
+
         # Public: Get the time of the last update to this record.
         #
         # Returns a Time-compatible object.

data/lib/restforce/db/record_types/salesforce.rb

@@ -17,8 +17,8 @@ module Restforce
         # Returns a Restforce::DB::Instances::Salesforce instance.
         # Raises on any error from Salesforce.
         def create!(from_record)
-          attributes = @mapping.convert(@record_type, from_record.attributes)
-          record_id = DB.client.create!(@record_type, attributes)
+          from_attributes = FieldProcessor.new.process(@record_type, from_record.attributes)
+          record_id = DB.client.create!(@record_type, from_attributes)
 
           from_record.update!(@mapping.lookup_column => record_id).after_sync
 

data/lib/restforce/db/synchronizer.rb

@@ -49,10 +49,11 @@ module Restforce
       #
       # Returns nothing.
       def update(instance, accumulator)
+        return unless accumulator.changed?(instance.attributes)
+
         current_attributes = accumulator.current(instance.attributes)
         attributes = @mapping.convert(instance.record_type, current_attributes)
 
-        return if attributes.empty?
         instance.update!(attributes)
       end
 

data/lib/restforce/db/version.rb

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

data/lib/restforce/db.rb

@@ -16,6 +16,7 @@ require "restforce/db/associations/foreign_key"
 require "restforce/db/associations/has_many"
 require "restforce/db/associations/has_one"
 
+require "restforce/db/field_processor"
 require "restforce/db/instances/base"
 require "restforce/db/instances/active_record"
 require "restforce/db/instances/salesforce"