restforce-db 1.2.7 → 1.2.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d563ffb6d31cbe2705e07d8a67271e6d4f017024
-  data.tar.gz: ad9572805ba0250df541a763534894607d0221d0
+  metadata.gz: 9cf7836ccb586e04a24d23816d7c0ccea2c46ea9
+  data.tar.gz: 089b7c3596be1f796de185ca25ded3a613f19848
 SHA512:
-  metadata.gz: 0a598a642d31e556fea311df8f9d07222c20235734a73e3acd4ef725069416851507c4a5bc03398a05d7a7da79bedc3776d81f7f30f1510800f132f37c0128fb
-  data.tar.gz: 05b53d7e19460990822f2d56d1861a63bd3f694071db543111a84117d98bb78cc67ad8a42b66de41f4b34c5506215b9ac46c8b6130a6550bca17c4f236e177e2
+  metadata.gz: a4e81d52fc31bfdc3104b9720bceb1931410b7ad39d675a8bd9d172d1acedb3b99efe1f2c62937dca9d7b1c2fee57ad52161883988f0522df0876e41ed9552d4
+  data.tar.gz: c0153e58647b5f60bbb610f9b8bb56c65bed0bc514f1d22f31567274bd56c368185f8798ca63359fb4635c51af0764abece5e947a717bb9d5c855dcd09371b51

data/README.md

@@ -39,7 +39,7 @@ To register a Salesforce mapping in an `ActiveRecord` model, you'll need to add
 class Restaurant < ActiveRecord::Base
 
   include Restforce::DB::Model
-  has_one :chef, inverse_of: :restaurant
+  has_one :chef, inverse_of: :restaurant, autosave: true
   has_many :dishes, inverse_of: :restaurant
 
   module StyleAdapter
@@ -202,17 +202,27 @@ For additional information and a full set of options, you can run:
 
     $ bundle exec bin/restforce-db -h
 
+## Caveats
+
+- **API Usage.** 
+  This gem performs most of its functionality via the Salesforce API (by way of the [`restforce`](https://github.com/ejholmes/restforce) gem). If you're at risk of hitting your Salesforce API limits, this may not be the right approach for you.
+
+- **Update Prioritization.**
+  When synchronization occurs, the most recently updated record, Salesforce or database, gets to make the final call about the values of _all_ of the fields it observes. This means that race conditions can and probably will happen if both systems are updated within the same polling interval.
+  
+- **Record Persistence.** 
+  See the `autosave: true` option declared for the `has_one` relationship on `Restaurant`? `Restforce::DB` requires your ActiveRecord models to handle persistence propagation.
+
+  When inserting new records, `save!` will only be invoked on the _entry point_ record (typically a mapping with an `:always` synchronization strategy), so the persistence of any associated records must be chained through this "root" object.
+
+  You may want to consult [the ActiveRecord documentation](http://apidock.com/rails/ActiveRecord/Associations/ClassMethods) for your specific use case.
+
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run `bin/console` for an interactive prompt that will allow you to experiment.
 
 To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release` to create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-## Caveats
-
-- **Update Prioritization.** When synchronization occurs, the most recently updated record, Salesforce or database, gets to make the final call about the values of _all_ of the fields it observes. This means that race conditions can and probably will happen if both systems are updated within the same polling interval.
-- **API Usage.** This gem performs most of its functionality via the Salesforce API (by way of the [`restforce`](https://github.com/ejholmes/restforce) gem). If you're at risk of hitting your Salesforce API limits, this may not be the right approach for you.
-
 ## Contributing
 
 1. Fork it ( https://github.com/tablexi/restforce-db/fork )

data/lib/restforce/db/association_cache.rb

@@ -0,0 +1,49 @@
+module Restforce
+
+  module DB
+
+    # Restforce::DB::AssociationCache stores a set of constructed database
+    # association records, providing utilities to fetch unpersisted records
+    # which match a specific set of Salesforce lookups.
+    class AssociationCache
+
+      attr_reader :cache
+
+      # Public: Initialize a new Restforce::DB::AssociationCache.
+      def initialize
+        @cache = Hash.new { |h, k| h[k] = [] }
+      end
+
+      # Public: Add a record to the cache.
+      #
+      # record - An instance of ActiveRecord::Base.
+      #
+      # Returns nothing.
+      def <<(record)
+        @cache[record.class] << record
+      end
+
+      # Public: Find an existing record with the given lookup values.
+      #
+      # database_model - A subclass of ActiveRecord::Base.
+      # lookups        - A Hash mapping database columns to Salesforce IDs.
+      #
+      # Returns an instance of ActiveRecord::Base or nil.
+      def find(database_model, lookups)
+        record = @cache[database_model].detect do |cached|
+          lookups.all? { |column, value| cached.send(column) == value }
+        end
+
+        return record if record
+
+        record = database_model.find_by(lookups)
+        self << record if record
+
+        record
+      end
+
+    end
+
+  end
+
+end

data/lib/restforce/db/associations/base.rb

@@ -8,7 +8,7 @@ module Restforce
       # mappings in the Registry.
       class Base
 
-        attr_reader :name, :lookup
+        attr_reader :name, :lookup, :cache
 
         # Public: Initialize a new Restforce::DB::Associations::Base.
         #
@@ -23,7 +23,7 @@ module Restforce
         # defined by this class. Must be overridden in subclasses.
         #
         # Raises a NotImplementedError.
-        def build(_database_record, _salesforce_record)
+        def build(_database_record, _salesforce_record, _cache)
           raise NotImplementedError
         end
 
@@ -65,7 +65,7 @@ module Restforce
         # Yields the new database record if one is built.
         # Returns an Array containing all newly-constructed records.
         def constructed_records(database_record, lookups, attributes)
-          associated = target_class(database_record).find_by(lookups)
+          associated = cache.find(target_class(database_record), lookups)
 
           # If the association record already exists, we don't need to build out
           # associations any further.
@@ -74,7 +74,9 @@ module Restforce
             return []
           end
 
-          associated ||= database_record.association(name).build(lookups)
+          associated = database_record.association(name).build(lookups)
+          cache << associated
+
           associated.assign_attributes(attributes)
 
           nested = yield associated if block_given?
@@ -164,7 +166,7 @@ module Restforce
           inverse = inverse_association_name(target_reflection(parent_record))
           nested = salesforce_instance.mapping.associations.flat_map do |a|
             next if a.name == inverse
-            a.build(database_record, salesforce_instance.record)
+            a.build(database_record, salesforce_instance.record, cache)
           end
 
           nested.compact

data/lib/restforce/db/associations/belongs_to.rb

@@ -14,9 +14,12 @@ module Restforce
         #
         # database_record   - An instance of an ActiveRecord::Base subclass.
         # salesforce_record - A Hashie::Mash representing a Salesforce object.
+        # cache             - A Restforce::DB::AssociationCache.
         #
         # Returns an Array of constructed association records.
-        def build(database_record, salesforce_record)
+        def build(database_record, salesforce_record, cache = AssociationCache.new)
+          @cache = cache
+
           lookups = {}
           attributes = {}
           instances = []
@@ -38,6 +41,8 @@ module Restforce
           constructed_records(database_record, lookups, attributes) do |associated|
             instances.flat_map { |i| nested_records(database_record, associated, i) }
           end
+        ensure
+          @cache = nil
         end
 
         private

data/lib/restforce/db/associations/has_many.rb

@@ -14,9 +14,12 @@ module Restforce
         #
         # database_record   - An instance of an ActiveRecord::Base subclass.
         # salesforce_record - A Hashie::Mash representing a Salesforce object.
+        # cache             - A Restforce::DB::AssociationCache.
         #
         # Returns an Array of constructed association records.
-        def build(database_record, salesforce_record)
+        def build(database_record, salesforce_record, cache = AssociationCache.new)
+          @cache = cache
+
           target = target_mapping(database_record)
           lookup_id = "#{lookup} = '#{salesforce_record.Id}'"
 
@@ -26,6 +29,8 @@ module Restforce
           end
 
           records.flatten
+        ensure
+          @cache = nil
         end
 
         private

data/lib/restforce/db/associations/has_one.rb

@@ -14,14 +14,19 @@ module Restforce
         #
         # database_record   - An instance of an ActiveRecord::Base subclass.
         # salesforce_record - A Hashie::Mash representing a Salesforce object.
+        # cache             - A Restforce::DB::AssociationCache.
         #
         # Returns an Array of constructed association records.
-        def build(database_record, salesforce_record)
+        def build(database_record, salesforce_record, cache = AssociationCache.new)
+          @cache = cache
+
           target = target_mapping(database_record)
           query = "#{lookup} = '#{salesforce_record.Id}'"
 
           instance = target.salesforce_record_type.first(query)
           instance ? construct_for(database_record, instance) : []
+        ensure
+          @cache = nil
         end
 
       end

data/lib/restforce/db/version.rb

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

data/lib/restforce/db.rb

@@ -9,6 +9,7 @@ require "restforce/db/registry"
 require "restforce/db/strategy"
 require "restforce/db/dsl"
 
+require "restforce/db/association_cache"
 require "restforce/db/associations/base"
 require "restforce/db/associations/belongs_to"
 require "restforce/db/associations/foreign_key"

data/test/cassettes/Restforce_DB_Associations_BelongsTo/with_an_inverse_mapping/_build/when_the_associated_record_has_been_cached/uses_the_cached_record.yml

@@ -0,0 +1,271 @@
+---
+http_interactions:
+- request:
+    method: post
+    uri: https://<host>/services/oauth2/token
+    body:
+      encoding: US-ASCII
+      string: grant_type=password&client_id=<client_id>&client_secret=<client_secret>&username=<username>&password=<password><security_token>
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/x-www-form-urlencoded
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 01 May 2015 16:33:24 GMT
+      Set-Cookie:
+      - BrowserId=V4xV6073TGS_LEesUDd-EA;Path=/;Domain=.salesforce.com;Expires=Tue,
+        30-Jun-2015 16:33:24 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Pragma:
+      - no-cache
+      Cache-Control:
+      - no-cache, no-store
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"https://login.salesforce.com/id/00D1a000000H3O9EAK/0051a000000UGT8AAO","issued_at":"1430498004388","token_type":"Bearer","instance_url":"https://<host>","signature":"UlHQTMd5UMeQOcODXUr6CtDraNkn2Wq50gFTzKBlpT8=","access_token":"00D1a000000H3O9!AQ4AQDv3Hk9TRSKHVK.6TQHDjiXPpFDEH7AxoxdK.ytZcKr4gkBGokBh2ZhUcaf0_eFqhFa6YVCzmfP.bUKsz9xIJOy41iQD"}'
+    http_version: 
+  recorded_at: Fri, 01 May 2015 16:33:24 GMT
+- request:
+    method: post
+    uri: https://<host>/services/data/v26.0/sobjects/Contact
+    body:
+      encoding: UTF-8
+      string: '{"Email":"somebody@example.com","LastName":"Somebody"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQDv3Hk9TRSKHVK.6TQHDjiXPpFDEH7AxoxdK.ytZcKr4gkBGokBh2ZhUcaf0_eFqhFa6YVCzmfP.bUKsz9xIJOy41iQD
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Fri, 01 May 2015 16:33:24 GMT
+      Set-Cookie:
+      - BrowserId=7i8VqQngSSqFKsKsi7Vk_g;Path=/;Domain=.salesforce.com;Expires=Tue,
+        30-Jun-2015 16:33:24 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=14/15000
+      Location:
+      - "/services/data/v26.0/sobjects/Contact/0031a000002jr5yAAA"
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"0031a000002jr5yAAA","success":true,"errors":[]}'
+    http_version: 
+  recorded_at: Fri, 01 May 2015 16:33:24 GMT
+- request:
+    method: post
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c
+    body:
+      encoding: UTF-8
+      string: '{"Friend__c":"0031a000002jr5yAAA"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQDv3Hk9TRSKHVK.6TQHDjiXPpFDEH7AxoxdK.ytZcKr4gkBGokBh2ZhUcaf0_eFqhFa6YVCzmfP.bUKsz9xIJOy41iQD
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Fri, 01 May 2015 16:33:24 GMT
+      Set-Cookie:
+      - BrowserId=HqVkQER3SLGWhf169ZcfYw;Path=/;Domain=.salesforce.com;Expires=Tue,
+        30-Jun-2015 16:33:24 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=14/15000
+      Location:
+      - "/services/data/v26.0/sobjects/CustomObject__c/a001a000001TuPCAA0"
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"a001a000001TuPCAA0","success":true,"errors":[]}'
+    http_version: 
+  recorded_at: Fri, 01 May 2015 16:33:25 GMT
+- request:
+    method: get
+    uri: https://<host>/services/data/v26.0/query?q=select%20Id,%20SystemModstamp,%20Name,%20Example_Field__c,%20Friend__c%20from%20CustomObject__c%20where%20Id%20=%20%27a001a000001TuPCAA0%27
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQDv3Hk9TRSKHVK.6TQHDjiXPpFDEH7AxoxdK.ytZcKr4gkBGokBh2ZhUcaf0_eFqhFa6YVCzmfP.bUKsz9xIJOy41iQD
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 01 May 2015 16:33:25 GMT
+      Set-Cookie:
+      - BrowserId=HFIYWjmgQESnRKolxabijg;Path=/;Domain=.salesforce.com;Expires=Tue,
+        30-Jun-2015 16:33:25 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=14/15000
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"totalSize":1,"done":true,"records":[{"attributes":{"type":"CustomObject__c","url":"/services/data/v26.0/sobjects/CustomObject__c/a001a000001TuPCAA0"},"Id":"a001a000001TuPCAA0","SystemModstamp":"2015-05-01T16:33:24.000+0000","Name":"a001a000001TuPC","Example_Field__c":null,"Friend__c":"0031a000002jr5yAAA"}]}'
+    http_version: 
+  recorded_at: Fri, 01 May 2015 16:33:25 GMT
+- request:
+    method: get
+    uri: https://<host>/services/data/v26.0/query?q=select%20Id,%20SystemModstamp,%20Email%20from%20Contact%20where%20Id%20=%20%270031a000002jr5yAAA%27
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQDv3Hk9TRSKHVK.6TQHDjiXPpFDEH7AxoxdK.ytZcKr4gkBGokBh2ZhUcaf0_eFqhFa6YVCzmfP.bUKsz9xIJOy41iQD
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Fri, 01 May 2015 16:33:25 GMT
+      Set-Cookie:
+      - BrowserId=fbjM_aMCQk-C-vEXZy2qsg;Path=/;Domain=.salesforce.com;Expires=Tue,
+        30-Jun-2015 16:33:25 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=16/15000
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"totalSize":1,"done":true,"records":[{"attributes":{"type":"Contact","url":"/services/data/v26.0/sobjects/Contact/0031a000002jr5yAAA"},"Id":"0031a000002jr5yAAA","SystemModstamp":"2015-05-01T16:33:24.000+0000","Email":"somebody@example.com"}]}'
+    http_version: 
+  recorded_at: Fri, 01 May 2015 16:33:25 GMT
+- request:
+    method: delete
+    uri: https://<host>/services/data/v26.0/sobjects/Contact/0031a000002jr5yAAA
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQDv3Hk9TRSKHVK.6TQHDjiXPpFDEH7AxoxdK.ytZcKr4gkBGokBh2ZhUcaf0_eFqhFa6YVCzmfP.bUKsz9xIJOy41iQD
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Fri, 01 May 2015 16:33:25 GMT
+      Set-Cookie:
+      - BrowserId=9sf6dtHySYeEZem-2Pu2UA;Path=/;Domain=.salesforce.com;Expires=Tue,
+        30-Jun-2015 16:33:25 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=15/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 01 May 2015 16:33:25 GMT
+- request:
+    method: delete
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c/a001a000001TuPCAA0
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQDv3Hk9TRSKHVK.6TQHDjiXPpFDEH7AxoxdK.ytZcKr4gkBGokBh2ZhUcaf0_eFqhFa6YVCzmfP.bUKsz9xIJOy41iQD
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Fri, 01 May 2015 16:33:25 GMT
+      Set-Cookie:
+      - BrowserId=kXuMYUa-TeafZ0Rlz2v3Tw;Path=/;Domain=.salesforce.com;Expires=Tue,
+        30-Jun-2015 16:33:25 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=14/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Fri, 01 May 2015 16:33:26 GMT
+recorded_with: VCR 2.9.3