restforce-db 0.4.0 → 0.5.0

data/test/cassettes/Restforce_DB_Synchronizer/_run/given_a_Salesforce_record_with_an_associated_database_record/updates_the_salesforce_record.yml

@@ -0,0 +1,233 @@
+---
+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:
+      - Mon, 06 Apr 2015 19:27:32 GMT
+      Set-Cookie:
+      - BrowserId=H_ENFEUGR5WZTS-rk624sw;Path=/;Domain=.salesforce.com;Expires=Fri,
+        05-Jun-2015 19:27:32 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":"1428348452182","token_type":"Bearer","instance_url":"https://<host>","signature":"P3OMePrj1WH7novmwXpFbmqH0DW5LbNUf9WsrRrMAUA=","access_token":"00D1a000000H3O9!AQ4AQEol4wrcAcAfVF3HH0vTJXCmqHaqBZX0.AfMcJFa2P3Ssl68tDLqC_BJKakn3tKiFCy4SzendJ0gWnbHWkqrzvFuNH6B"}'
+    http_version: 
+  recorded_at: Mon, 06 Apr 2015 19:27:32 GMT
+- request:
+    method: post
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c
+    body:
+      encoding: UTF-8
+      string: '{"Name":"Custom object","Example_Field__c":"Some sample text"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQEol4wrcAcAfVF3HH0vTJXCmqHaqBZX0.AfMcJFa2P3Ssl68tDLqC_BJKakn3tKiFCy4SzendJ0gWnbHWkqrzvFuNH6B
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Mon, 06 Apr 2015 19:27:33 GMT
+      Set-Cookie:
+      - BrowserId=CYLdStRyQ7-Gcf0PlAt6tg;Path=/;Domain=.salesforce.com;Expires=Fri,
+        05-Jun-2015 19:27:33 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=53/15000
+      Location:
+      - "/services/data/v26.0/sobjects/CustomObject__c/a001a000001LHpaAAG"
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"a001a000001LHpaAAG","success":true,"errors":[]}'
+    http_version: 
+  recorded_at: Mon, 06 Apr 2015 19:27:33 GMT
+- request:
+    method: get
+    uri: https://<host>/services/data/v26.0/query?q=select%20Id,%20SystemModstamp,%20Name,%20Example_Field__c%20from%20CustomObject__c%20where%20Id%20=%20%27a001a000001LHpaAAG%27
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQEol4wrcAcAfVF3HH0vTJXCmqHaqBZX0.AfMcJFa2P3Ssl68tDLqC_BJKakn3tKiFCy4SzendJ0gWnbHWkqrzvFuNH6B
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 06 Apr 2015 19:27:34 GMT
+      Set-Cookie:
+      - BrowserId=_tii4-GdTbyU69ifAuYSlw;Path=/;Domain=.salesforce.com;Expires=Fri,
+        05-Jun-2015 19:27:34 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=53/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/a001a000001LHpaAAG"},"Id":"a001a000001LHpaAAG","SystemModstamp":"2015-04-06T19:27:33.000+0000","Name":"Custom
+        object","Example_Field__c":"Some sample text"}]}'
+    http_version: 
+  recorded_at: Mon, 06 Apr 2015 19:27:34 GMT
+- request:
+    method: patch
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c/a001a000001LHpaAAG
+    body:
+      encoding: UTF-8
+      string: '{"Name":"Some new name","Example_Field__c":"New sample text"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQEol4wrcAcAfVF3HH0vTJXCmqHaqBZX0.AfMcJFa2P3Ssl68tDLqC_BJKakn3tKiFCy4SzendJ0gWnbHWkqrzvFuNH6B
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Mon, 06 Apr 2015 19:27:35 GMT
+      Set-Cookie:
+      - BrowserId=w1GFuFqdRyG3lFp9_6eHRw;Path=/;Domain=.salesforce.com;Expires=Fri,
+        05-Jun-2015 19:27:35 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=53/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 06 Apr 2015 19:27:35 GMT
+- request:
+    method: get
+    uri: https://<host>/services/data/v26.0/query?q=select%20Id,%20SystemModstamp,%20Name,%20Example_Field__c%20from%20CustomObject__c%20where%20Id%20=%20%27a001a000001LHpaAAG%27
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQEol4wrcAcAfVF3HH0vTJXCmqHaqBZX0.AfMcJFa2P3Ssl68tDLqC_BJKakn3tKiFCy4SzendJ0gWnbHWkqrzvFuNH6B
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Mon, 06 Apr 2015 19:27:36 GMT
+      Set-Cookie:
+      - BrowserId=QeOpfDAmRk2Do-IQgxE7AQ;Path=/;Domain=.salesforce.com;Expires=Fri,
+        05-Jun-2015 19:27:36 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=53/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/a001a000001LHpaAAG"},"Id":"a001a000001LHpaAAG","SystemModstamp":"2015-04-06T19:27:35.000+0000","Name":"Some
+        new name","Example_Field__c":"New sample text"}]}'
+    http_version: 
+  recorded_at: Mon, 06 Apr 2015 19:27:36 GMT
+- request:
+    method: delete
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c/a001a000001LHpaAAG
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQEol4wrcAcAfVF3HH0vTJXCmqHaqBZX0.AfMcJFa2P3Ssl68tDLqC_BJKakn3tKiFCy4SzendJ0gWnbHWkqrzvFuNH6B
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Mon, 06 Apr 2015 19:27:37 GMT
+      Set-Cookie:
+      - BrowserId=3oZtqDLySCS_3xvQ0quJiQ;Path=/;Domain=.salesforce.com;Expires=Fri,
+        05-Jun-2015 19:27:37 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=53/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Mon, 06 Apr 2015 19:27:37 GMT
+recorded_with: VCR 2.9.3

data/test/lib/restforce/db/accumulator_test.rb

@@ -0,0 +1,71 @@
+require_relative "../../../test_helper"
+
+describe Restforce::DB::Accumulator do
+  let(:accumulator) { Restforce::DB::Accumulator.new }
+
+  describe "#store" do
+    let(:timestamp) { Time.now }
+    let(:changes) { { one_fish: "Two Fish", red_fish: "Blue Fish" } }
+
+    before do
+      accumulator.store(timestamp, changes)
+    end
+
+    it "stores the passed changeset in the accumulator" do
+      expect(accumulator[timestamp]).to_equal changes
+    end
+  end
+
+  describe "#attributes" do
+    let(:timestamp) { Time.now }
+    let(:changes) { { one_fish: "Two Fish", red_fish: "Blue Fish" } }
+
+    before do
+      accumulator.store(timestamp, changes)
+    end
+
+    it "returns the attributes from the recorded changeset" do
+      expect(accumulator.attributes).to_equal changes
+    end
+
+    it "combines multiple changesets" do
+      additional_changes = { hootie: "Blow Fish" }
+
+      accumulator.store Time.now, additional_changes
+      expect(accumulator.attributes).to_equal changes.merge(additional_changes)
+    end
+
+    describe "with conflicting changesets" do
+      let(:new_changes) { { one_fish: "No Fish", red_fish: "Glow Fish" } }
+
+      it "respects the most recently updated values" do
+        accumulator.store timestamp + 1, new_changes
+        expect(accumulator.attributes).to_equal new_changes
+      end
+
+      it "ignores less recently updated values" do
+        accumulator.store timestamp - 1, new_changes
+        expect(accumulator.attributes).to_equal changes
+      end
+    end
+  end
+
+  describe "#diff" do
+    let(:attributes) { { wocket: "Pocket", jertain: "Curtain", zelf: "Shelf" } }
+
+    before do
+      accumulator.store(Time.now, attributes)
+    end
+
+    it "returns the differences from the attributes hash" do
+      expect(accumulator.diff(wocket: "Locket", zelf: "Belfrey")).to_equal(
+        wocket: "Pocket",
+        zelf: "Shelf",
+      )
+    end
+
+    it "ignores attributes not set in the Accumulator" do
+      expect(accumulator.diff(yottle: "Bottle")).to_be :empty?
+    end
+  end
+end

data/test/lib/restforce/db/attribute_map_test.rb

@@ -0,0 +1,70 @@
+require_relative "../../../test_helper"
+
+describe Restforce::DB::AttributeMap do
+
+  configure!
+
+  let(:database_model) { CustomObject }
+  let(:salesforce_model) { "CustomObject__c" }
+  let(:fields) do
+    {
+      column_one: "SF_Field_One__c",
+      column_two: "SF_Field_Two__c",
+    }
+  end
+
+  let(:attribute_map) { Restforce::DB::AttributeMap.new(database_model, salesforce_model, fields) }
+
+  describe "#attributes" do
+    let(:mapping) { Restforce::DB::Mapping.new(database_model, salesforce_model, fields: fields) }
+
+    it "builds a normalized Hash of database attribute values" do
+      attributes = attribute_map.attributes(database_model) do |attribute|
+        expect(mapping.database_fields.include?(attribute)).to_equal true
+        attribute
+      end
+
+      expect(attributes.keys).to_equal(mapping.database_fields)
+      expect(attributes.values).to_equal(mapping.database_fields)
+    end
+
+    it "builds a normalized Hash of Salesforce field values" do
+      attributes = attribute_map.attributes(salesforce_model) do |attribute|
+        expect(mapping.salesforce_fields.include?(attribute)).to_equal true
+        attribute
+      end
+
+      expect(attributes.keys).to_equal(mapping.database_fields)
+      expect(attributes.values).to_equal(mapping.salesforce_fields)
+    end
+  end
+
+  describe "#convert" do
+    let(:attributes) { { column_one: "some value" } }
+
+    it "converts an attribute Hash to a Salesforce-compatible form" do
+      expect(attribute_map.convert(salesforce_model, attributes)).to_equal(
+        fields[attributes.keys.first] => attributes.values.first,
+      )
+    end
+
+    it "performs no special conversion for database columns" do
+      expect(attribute_map.convert(database_model, attributes)).to_equal(attributes)
+    end
+  end
+
+  describe "#convert_from_salesforce" do
+    let(:attributes) { { "SF_Field_One__c" => "some value" } }
+
+    it "converts an attribute Hash to a database-compatible form" do
+      expect(attribute_map.convert_from_salesforce(database_model, attributes)).to_equal(
+        fields.key(attributes.keys.first) => attributes.values.first,
+      )
+    end
+
+    it "performs no special conversion for Salesforce fields" do
+      expect(attribute_map.convert_from_salesforce(salesforce_model, attributes)).to_equal(attributes)
+    end
+  end
+
+end

data/test/lib/restforce/db/collector_test.rb

@@ -0,0 +1,91 @@
+require_relative "../../../test_helper"
+
+describe Restforce::DB::Collector do
+
+  configure!
+  mappings!
+
+  let(:collector) { Restforce::DB::Collector.new(mapping) }
+
+  describe "#run", vcr: { match_requests_on: [:method, VCR.request_matchers.uri_without_param(:q)] } do
+    let(:attributes) do
+      {
+        name:    "Custom object",
+        example: "Some sample text",
+      }
+    end
+    let(:salesforce_id) do
+      Salesforce.create!(
+        salesforce_model,
+        mapping.convert(salesforce_model, attributes),
+      )
+    end
+    let(:key) { [salesforce_id, salesforce_model] }
+
+    subject { collector.run }
+
+    describe "given an existing Salesforce record" do
+      before { salesforce_id }
+
+      it "returns the attributes from the Salesforce record" do
+        record = mapping.salesforce_record_type.find(salesforce_id)
+
+        expect(subject[key]).to_equal(
+          record.last_update => {
+            "Name" => attributes[:name],
+            "Example_Field__c" => attributes[:example],
+          },
+        )
+      end
+    end
+
+    describe "given an existing database record" do
+      let(:salesforce_id) { "a001a000001E1vREAL" }
+      let(:database_metadata) { { salesforce_id: salesforce_id, synchronized_at: Time.now } }
+      let(:database_record) { database_model.create!(attributes.merge(database_metadata)) }
+
+      before { database_record }
+
+      it "returns the attributes from the database record" do
+        record = mapping.database_record_type.find(salesforce_id)
+
+        expect(subject[key]).to_equal(
+          record.last_update => {
+            "Name" => attributes[:name],
+            "Example_Field__c" => attributes[:example],
+          },
+        )
+      end
+    end
+
+    describe "given a Salesforce record with an associated database record" do
+      let(:database_attributes) do
+        {
+          name:    "Some existing name",
+          example: "Some existing sample text",
+        }
+      end
+      let(:database_metadata) { { salesforce_id: salesforce_id, synchronized_at: Time.now } }
+      let(:database_record) { database_model.create!(database_attributes.merge(database_metadata)) }
+
+      before { database_record }
+
+      it "returns the attributes from both records" do
+        sf_record = mapping.salesforce_record_type.find(salesforce_id)
+        db_record = mapping.database_record_type.find(salesforce_id)
+
+        expect(subject[key]).to_equal(
+          sf_record.last_update => {
+            "Name" => attributes[:name],
+            "Example_Field__c" => attributes[:example],
+          },
+          db_record.last_update => {
+            "Name" => database_attributes[:name],
+            "Example_Field__c" => database_attributes[:example],
+          },
+        )
+      end
+    end
+
+  end
+end

data/test/lib/restforce/db/initializer_test.rb

@@ -0,0 +1,92 @@
+require_relative "../../../test_helper"
+
+describe Restforce::DB::Initializer do
+
+  configure!
+  mappings!
+
+  let(:initializer) { Restforce::DB::Initializer.new(mapping) }
+
+  describe "#run", vcr: { match_requests_on: [:method, VCR.request_matchers.uri_without_param(:q)] } do
+    let(:attributes) do
+      {
+        name:    "Custom object",
+        example: "Some sample text",
+      }
+    end
+    let(:salesforce_id) do
+      Salesforce.create!(
+        salesforce_model,
+        mapping.convert(salesforce_model, attributes),
+      )
+    end
+
+    describe "given an existing Salesforce record" do
+      before do
+        salesforce_id
+      end
+
+      describe "for a root mapping" do
+        before do
+          initializer.run
+        end
+
+        it "creates a matching database record" do
+          record = database_model.last
+
+          expect(record.name).to_equal attributes[:name]
+          expect(record.example).to_equal attributes[:example]
+          expect(record.salesforce_id).to_equal salesforce_id
+        end
+      end
+
+      describe "for a non-root mapping" do
+        let(:through) { "SomeField__c" }
+
+        before do
+          initializer.run
+        end
+
+        it "does not create a database record" do
+          expect(database_model.last).to_be_nil
+        end
+      end
+    end
+
+    describe "given an existing database record" do
+      let(:database_record) { database_model.create!(attributes) }
+      let(:salesforce_id) { database_record.reload.salesforce_id }
+
+      before do
+        database_record
+      end
+
+      describe "for a root mapping" do
+        before do
+          initializer.run
+          Salesforce.records << [salesforce_model, salesforce_id]
+        end
+
+        it "populates Salesforce with the new record" do
+          record = mapping.salesforce_record_type.find(salesforce_id).record
+
+          expect(record.Name).to_equal attributes[:name]
+          expect(record.Example_Field__c).to_equal attributes[:example]
+        end
+      end
+
+      describe "for a non-root mapping" do
+        let(:through) { "SomeField__c" }
+
+        before do
+          initializer.run
+        end
+
+        it "does not create a Salesforce record" do
+          expect(salesforce_id).to_be_nil
+        end
+      end
+    end
+
+  end
+end

data/test/lib/restforce/db/instances/active_record_test.rb

@@ -29,17 +29,4 @@ describe Restforce::DB::Instances::ActiveRecord do
       expect(record.reload.synchronized_at).to_not_be_nil
     end
   end
-
-  describe "#copy!" do
-    let(:text) { "Copied text" }
-    let(:copy_from) { Struct.new(:attributes).new(example: text) }
-
-    before do
-      instance.copy!(copy_from)
-    end
-
-    it "updates the record with the attributes from the copied object" do
-      expect(record.example).to_equal text
-    end
-  end
 end

data/test/lib/restforce/db/instances/salesforce_test.rb

@@ -24,19 +24,6 @@ describe Restforce::DB::Instances::Salesforce do
     end
   end
 
-  describe "#copy!", :vcr do
-    let(:text) { "Copied text" }
-    let(:copy_from) { Struct.new(:attributes).new(example: text) }
-
-    before do
-      instance.copy!(copy_from)
-    end
-
-    it "updates the record with the attributes from the copied object" do
-      expect(instance.record.Example_Field__c).to_equal text
-    end
-  end
-
   describe "#last_update" do
     let(:timestamp) { "2015-03-18T20:28:24.000+0000" }
     let(:record) { Struct.new(:SystemModstamp).new(timestamp) }
@@ -47,4 +34,24 @@ describe Restforce::DB::Instances::Salesforce do
     end
   end
 
+  describe "#synced?", :vcr do
+
+    describe "when no matching database record exists" do
+
+      it "returns false" do
+        expect(instance).to_not_be :synced?
+      end
+    end
+
+    describe "when a matching database record exists" do
+      before do
+        database_model.create!(salesforce_id: id)
+      end
+
+      it "returns true" do
+        expect(instance).to_be :synced?
+      end
+    end
+  end
+
 end

data/test/lib/restforce/db/mapping_test.rb

@@ -35,6 +35,7 @@ describe Restforce::DB::Mapping do
 
     it "adds the mapping to the global collection" do
       expect(Restforce::DB::Mapping[database_model]).to_equal [mapping]
+      expect(Restforce::DB::Mapping[salesforce_model]).to_equal [mapping]
     end
   end
 
@@ -95,41 +96,4 @@ describe Restforce::DB::Mapping do
       end
     end
   end
-
-  describe "#attributes" do
-
-    it "builds a normalized Hash of database attribute values" do
-      attributes = mapping.attributes(database_model) do |attribute|
-        expect(mapping.database_fields.include?(attribute)).to_equal true
-        attribute
-      end
-
-      expect(attributes.keys).to_equal(mapping.database_fields)
-      expect(attributes.values).to_equal(mapping.database_fields)
-    end
-
-    it "builds a normalized Hash of Salesforce field values" do
-      attributes = mapping.attributes(salesforce_model) do |attribute|
-        expect(mapping.salesforce_fields.include?(attribute)).to_equal true
-        attribute
-      end
-
-      expect(attributes.keys).to_equal(mapping.database_fields)
-      expect(attributes.values).to_equal(mapping.salesforce_fields)
-    end
-  end
-
-  describe "#convert" do
-    let(:attributes) { { column_one: "some value" } }
-
-    it "converts an attribute Hash to a Salesforce-compatible form" do
-      expect(mapping.convert(salesforce_model, attributes)).to_equal(
-        fields[attributes.keys.first] => attributes.values.first,
-      )
-    end
-
-    it "performs no special conversion for database columns" do
-      expect(mapping.convert(database_model, attributes)).to_equal(attributes)
-    end
-  end
 end