restforce-db 0.1.4

data/lib/restforce/db.rb

@@ -0,0 +1,77 @@
+require "time"
+require "restforce"
+
+require "restforce/extensions"
+
+require "restforce/db/version"
+require "restforce/db/configuration"
+
+require "restforce/db/instances/base"
+require "restforce/db/instances/active_record"
+require "restforce/db/instances/salesforce"
+
+require "restforce/db/record_types/base"
+require "restforce/db/record_types/active_record"
+require "restforce/db/record_types/salesforce"
+
+require "restforce/db/mapping"
+require "restforce/db/model"
+require "restforce/db/synchronizer"
+require "restforce/db/record_type"
+require "restforce/db/worker"
+
+module Restforce
+
+  # Restforce::DB exposes basic Restforce client configuration methods for use
+  # by the other classes in this library.
+  module DB
+
+    class << self
+
+      attr_writer :configuration
+
+    end
+
+    # Public: Get the current configuration for Restforce::DB.
+    #
+    # Returns a Restforce::DB::Configuration instance.
+    def self.configuration
+      @configuration ||= Configuration.new
+    end
+
+    # Public: Get a Restforce client based on the currently configured settings.
+    #
+    # Returns a Restforce::Data::Client instance.
+    def self.client
+      @client ||= Restforce.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,
+      )
+    end
+
+    # Public: Configure Restforce::DB by assigning values to the current
+    # configuration.
+    #
+    # Yields the current configuration.
+    # Returns the current configuration.
+    def self.configure
+      yield(configuration)
+      configuration
+    end
+
+    # Public: Eliminate all customizations to the current Restforce::DB
+    # configuration and client.
+    #
+    # Returns nothing.
+    def self.reset
+      @configuration = nil
+      @client = nil
+    end
+
+  end
+
+end

data/lib/restforce/extensions.rb

@@ -0,0 +1,19 @@
+module Restforce
+
+  # :nodoc:
+  class SObject
+
+    # Public: Update the Salesforce record with the passed attributes.
+    #
+    # attributes - A Hash of attributes to assign to the record.
+    #
+    # Raises on update error.
+    def update!(attributes)
+      ensure_id
+      @client.update!(sobject_type, attributes.merge("Id" => self.Id))
+      merge!(attributes)
+    end
+
+  end
+
+end

data/restforce-db.gemspec

@@ -0,0 +1,41 @@
+# coding: utf-8
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "restforce/db/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "restforce-db"
+  spec.version       = Restforce::DB::VERSION
+  spec.authors       = ["Andrew Horner"]
+  spec.email         = ["andrew@tablexi.com"]
+
+  spec.summary       = "Bind your database to Salesforce data"
+  spec.description   = "
+    This gem provides two-way bindings between Salesforce records and records
+    in an ActiveRecord-compatible database. It leans on the Restforce library
+    for Salesforce API interactions, and provides a self-daemonizing binary
+    which keeps records in sync by way of a tight polling loop."
+
+  spec.homepage      = "https://www.github.com/tablexi/restforce-db"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($RS)
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(/^exe\//) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency "activerecord"
+  spec.add_dependency "daemons"
+  spec.add_dependency "restforce"
+
+  spec.add_development_dependency "bundler", "~> 1.8"
+  spec.add_development_dependency "database_cleaner"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-bang"
+  spec.add_development_dependency "minitest-spec-expect"
+  spec.add_development_dependency "minitest-vcr"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rubocop"
+  spec.add_development_dependency "sqlite3"
+  spec.add_development_dependency "webmock"
+end

data/test/cassettes/Restforce_DB/accessing_Salesforce/uses_the_configured_credentials.yml

@@ -0,0 +1,43 @@
+---
+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:
+      - Tue, 17 Mar 2015 18:29:58 GMT
+      Set-Cookie:
+      - BrowserId=KvCaIxn-RmelQDRcZJJmcw;Path=/;Domain=.salesforce.com;Expires=Sat,
+        16-May-2015 18:29:58 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":"1426616998243","token_type":"Bearer","instance_url":"https://<host>","signature":"UW5T01ssq1ZZjJa4k86jnWTT+XYv7lNzCLudxzKJ2BQ=","access_token":"00D1a000000H3O9!AQ4AQBFd3oqpDO.7.Xcxso.goiRaetayUacefPmDpnmt8PamElbwequE5PNhXF16HhJY.W21KtDWD8mnv5vFKKt9refJWu.h"}'
+    http_version: 
+  recorded_at: Tue, 17 Mar 2015 18:29:58 GMT
+recorded_with: VCR 2.9.3

data/test/cassettes/Restforce_DB_Instances_Salesforce/_copy_/updates_the_record_with_the_attributes_from_the_copied_object.yml

@@ -0,0 +1,193 @@
+---
+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:
+      - Wed, 18 Mar 2015 20:34:33 GMT
+      Set-Cookie:
+      - BrowserId=ElUZRQLkSy6kt2YDAVSFKA;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:34:33 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":"1426710873724","token_type":"Bearer","instance_url":"https://<host>","signature":"robX3TYpeZYExmADA4WBjnOtA+qelwKg7GGVQDufmXs=","access_token":"00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m"}'
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:34:32 GMT
+- request:
+    method: post
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c
+    body:
+      encoding: UTF-8
+      string: '{"Name":"Sample object"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:34:33 GMT
+      Set-Cookie:
+      - BrowserId=JIawnNr3TwSQYvLRC3Zy_g;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:34:33 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=26/15000
+      Location:
+      - "/services/data/v26.0/sobjects/CustomObject__c/a001a000001E5iDAAS"
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"a001a000001E5iDAAS","success":true,"errors":[]}'
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:34:33 GMT
+- request:
+    method: get
+    uri: https://<host>/services/data/v26.0/query?q=select%20Id,%20SystemModstamp,%20Example_Field__c%20from%20CustomObject__c%20where%20Id%20=%20%27a001a000001E5iDAAS%27
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:34:34 GMT
+      Set-Cookie:
+      - BrowserId=ZQuS91hNQvG7-aeioBAM0Q;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:34:34 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=26/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/a001a000001E5iDAAS"},"Id":"a001a000001E5iDAAS","SystemModstamp":"2015-03-18T20:34:33.000+0000","Example_Field__c":null}]}'
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:34:33 GMT
+- request:
+    method: patch
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c/a001a000001E5iDAAS
+    body:
+      encoding: UTF-8
+      string: '{"Example_Field__c":"Copied text"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:34:34 GMT
+      Set-Cookie:
+      - BrowserId=Mcsl3yAuTt-WCg7Trps_xA;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:34:34 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=27/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:34:33 GMT
+- request:
+    method: delete
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c/a001a000001E5iDAAS
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:34:34 GMT
+      Set-Cookie:
+      - BrowserId=5R5Mi6kWS-mlesKpWMefDg;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:34:34 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=26/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:34:33 GMT
+recorded_with: VCR 2.9.3

data/test/cassettes/Restforce_DB_Instances_Salesforce/_update_/updates_the_local_record_with_the_passed_attributes.yml

@@ -0,0 +1,193 @@
+---
+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:
+      - Wed, 18 Mar 2015 20:28:24 GMT
+      Set-Cookie:
+      - BrowserId=mx38MLIPRSCaFqs-2qbrvw;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:28: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":"1426710504686","token_type":"Bearer","instance_url":"https://<host>","signature":"l8NUmtIwGCV90XfQi2H8DEGmHpKTNknDLvedcottr0E=","access_token":"00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m"}'
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:28:23 GMT
+- request:
+    method: post
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c
+    body:
+      encoding: UTF-8
+      string: '{"Name":"Sample object"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 201
+      message: Created
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:28:24 GMT
+      Set-Cookie:
+      - BrowserId=fRXtlzl9QcacxtklNtvLoA;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:28:24 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=5/15000
+      Location:
+      - "/services/data/v26.0/sobjects/CustomObject__c/a001a000001E5hoAAC"
+      Content-Type:
+      - application/json;charset=UTF-8
+      Transfer-Encoding:
+      - chunked
+    body:
+      encoding: ASCII-8BIT
+      string: '{"id":"a001a000001E5hoAAC","success":true,"errors":[]}'
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:28:24 GMT
+- request:
+    method: get
+    uri: https://<host>/services/data/v26.0/query?q=select%20Id,%20SystemModstamp,%20Example_Field__c%20from%20CustomObject__c%20where%20Id%20=%20%27a001a000001E5hoAAC%27
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 200
+      message: OK
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:28:25 GMT
+      Set-Cookie:
+      - BrowserId=dXS8uTmeRmu3wHnIoRL0Hg;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:28:25 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=5/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/a001a000001E5hoAAC"},"Id":"a001a000001E5hoAAC","SystemModstamp":"2015-03-18T20:28:24.000+0000","Example_Field__c":null}]}'
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:28:24 GMT
+- request:
+    method: patch
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c/a001a000001E5hoAAC
+    body:
+      encoding: UTF-8
+      string: '{"Example_Field__c":"Some new text"}'
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Content-Type:
+      - application/json
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:28:25 GMT
+      Set-Cookie:
+      - BrowserId=b1i3OOQBT52XairbLpLPiA;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:28:25 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=5/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:28:24 GMT
+- request:
+    method: delete
+    uri: https://<host>/services/data/v26.0/sobjects/CustomObject__c/a001a000001E5hoAAC
+    body:
+      encoding: US-ASCII
+      string: ''
+    headers:
+      User-Agent:
+      - Faraday v0.9.1
+      Authorization:
+      - OAuth 00D1a000000H3O9!AQ4AQBPYB1dtKrLqKFY0OHPXkpY2WSuWV3emXMOLv6.4pyhpMQ0liAbd0z2To0vRk4VoArPod87jkJCAza2a_.92y4ZpZ_4m
+      Accept-Encoding:
+      - gzip;q=1.0,deflate;q=0.6,identity;q=0.3
+      Accept:
+      - "*/*"
+  response:
+    status:
+      code: 204
+      message: No Content
+    headers:
+      Date:
+      - Wed, 18 Mar 2015 20:28:25 GMT
+      Set-Cookie:
+      - BrowserId=hIn49Vb3RECzS5EyNAAQMw;Path=/;Domain=.salesforce.com;Expires=Sun,
+        17-May-2015 20:28:25 GMT
+      Expires:
+      - Thu, 01 Jan 1970 00:00:00 GMT
+      Sforce-Limit-Info:
+      - api-usage=5/15000
+    body:
+      encoding: UTF-8
+      string: ''
+    http_version: 
+  recorded_at: Wed, 18 Mar 2015 20:28:25 GMT
+recorded_with: VCR 2.9.3