restforce-db 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d654a26f7dcf3a36b610fb1df64c96c1cb18cf0d
-  data.tar.gz: 8d2bc3363eaddfc8b716368852d6d849da7b93ce
+  metadata.gz: 776100229186286c8c26c55b04ecd47ede80603c
+  data.tar.gz: 9e4478c44aff6fd877c35506212cc67db1901d50
 SHA512:
-  metadata.gz: da5b6f83c431404f40886ece5ffc4cccdbe4a944b303d93ebfbb3768bc03da0ffddee231ff8679a1ac4268a9ef05bf693b087aecc9621edcd6dd8622f5a6f7ca
-  data.tar.gz: 15500d13fa9004bc5714df6f54c8d1e5d2ed1ece3cc31a049afe05843064f83ee6c63a1743f67fdc273d16fc8059e423feff3d9d0e416046e09fb0bfd17a248f
+  metadata.gz: e7a6f574ba1b60141c3764c48cebb481fe62abe1050168b2e29a01bed4bc271c62c3fede9f86f807a19a2b89780d887338eda0c98d2e2062ec0541648cc70d5a
+  data.tar.gz: 1ae95cb2a150d27f49eccb35f843177e84dd91ef2f8672e602adbb99894e05139ca51406a96357310dfc0573b9ed52bc3fb94ddd213029438e7dd8379cf1eb2f

data/README.md

@@ -22,6 +22,36 @@ First, you'll want to install the default bin and configuration files, which is
 
 This gem assumes that you're running Rails 4 or greater, therefore the `bin` file should be checked into the repository with the rest of your code. The `config/restforce-db.yml` file should be managed the same way you manage your secrets files, and probably not checked into the repository.
 
+### Modify your configurations
+
+The following key-value pairs _must_ be set in your configuration file:
+
+- `username`:
+  Your Salesforce username. Note that sandbox users typically have the name of the sandbox appended to their email address, e.g. "ahorner@tablexi.com.mysandbox".
+
+- `password`:
+  Your Salesforce password.
+
+- `security_token`:
+  Your Salesforce Security Token. If you didn't receive one in your email during setup, you can find this by signing in, and visiting Setup > Personal Information > Reset your security token.
+
+- `client_id`, `client_secret`:
+  When signed in to Salesforce with the proper authorization level, navigate to Setup > App Setup > Create > Apps, and hit "New" for "Connected Apps" if no appropriate connected app has already been added. Enable OAuth settings for the app, and once it is created you should see the Consumer Key (Client ID) and Secret under the API settings for the app. If a connected app has already been created, you can simply grab the existing ID and Secret by clicking through.
+
+- `host`:
+  This hostname of the Salesforce instance. You can typically use a more generic environment URL, e.g., "login.salesforce.com".
+
+The following _can_ be set in your configuration file:
+
+- `api_version`:
+  Restforce::DB defaults to version 29.0 of the Salesforce API. If you need a more (or less, for whatever reason) recent version of the API for your use case, you can specify an `api_version` key in your restforce-db.yml configuration. Version 29.0 or above is required for full gem functionality.
+
+- `timeout`:
+  The maximum amount of time a request to Salesforce can take before it will be interrupted. This defaults to 5 seconds.
+
+- `adapter`:
+  The HTTP adapter which should be used to make requests to Salesforce. By default, we use Net::HTTP (which is available by default in Ruby, and used by default through Faraday), but something like `typhoeus` may give better, more consistent performance for your use case. If you modify the configured adapter, be sure the relevant gem is available for your application.
+
 ### Update your model schema
 
 In order to keep your database records in sync with Salesforce, the table will need to store a reference to its associated Salesforce record. A generator is included to trivially add a generic `salesforce_id` column to your tables:
@@ -241,9 +271,6 @@ The example above would disable the default ActiveRecord logging specifically fo
 - **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.
 
-- **API Version.**
-  Restforce::DB defaults to version 29.0 of the Salesforce API. If you need a more (or less, for whatever reason) recent version of the API for your use case, you can specify an `api_version` key in your restforce-db.yml configuration. Version 29.0 or above is required for full gem functionality.
-
 - **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.
 

data/circle.yml

@@ -17,4 +17,3 @@ test:
   override:
     - bundle exec rubocop
     - bundle exec rake test
-

data/lib/generators/templates/config.yml

@@ -6,3 +6,8 @@ client:
   client_id:      "<your salesforce remote app client id>"
   client_secret:  "<your salesforce remote app client secret>"
   host:           "login.salesforce.com"
+
+  # The following are not required, but you may want to modify them:
+  api_version:    "29.0"
+  timeout:        5
+  adapter:        "net_http"

data/lib/restforce/db.rb

@@ -91,7 +91,7 @@ module Restforce
         host:           configuration.host,
         api_version:    configuration.api_version,
         timeout:        configuration.timeout,
-        adapter:        :net_http_persistent,
+        adapter:        configuration.adapter,
       )
     end
 

data/lib/restforce/db/configuration.rb

@@ -9,7 +9,8 @@ module Restforce
     class Configuration
 
       DEFAULT_API_VERSION = "29.0".freeze
-      DEFAULT_TIMEOUT     = 5
+      DEFAULT_TIMEOUT     = 5.freeze
+      DEFAULT_ADAPTER     = :net_http.freeze
 
       attr_accessor(*%i(
         username
@@ -19,6 +20,7 @@ module Restforce
         client_secret
         host
         timeout
+        adapter
         api_version
         logger
       ))
@@ -76,6 +78,7 @@ module Restforce
         # endpoint for recently deleted records.
         self.api_version    = configurations["api_version"] || DEFAULT_API_VERSION
         self.timeout        = configurations["timeout"] || DEFAULT_TIMEOUT
+        self.adapter        = (configurations["adapter"] || DEFAULT_ADAPTER).to_sym
       end
 
       private

data/lib/restforce/db/version.rb

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

data/restforce-db.gemspec

@@ -26,7 +26,6 @@ Gem::Specification.new do |spec|
 
   spec.add_dependency "activerecord"
   spec.add_dependency "daemons"
-  spec.add_dependency "net-http-persistent"
   spec.add_dependency "restforce"
 
   spec.add_development_dependency "bundler"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce-db
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Andrew Horner
@@ -38,20 +38,6 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: net-http-persistent
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - ">="
-      - !ruby/object:Gem::Version
-        version: '0'
 - !ruby/object:Gem::Dependency
   name: restforce
   requirement: !ruby/object:Gem::Requirement