restforce 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 307702db9af787319aab32acd6a4d2d6969be792
-  data.tar.gz: b62523a1931297c0598f7c52043b5e4dbf0afe0b
+  metadata.gz: 6856a7534599d3903698a710a379d2af99866a80
+  data.tar.gz: 1d888bc1f8d088abd95361718b131b2111f7c693
 SHA512:
-  metadata.gz: f8a11572c3132c5f223ddc6d3159908957c4a250b4fb7805a4156c7f258e5789b30a58c6ce93a07f23c86d8b1068741a041326c8d5c8dcaad7f7c7bee4c7ba35
-  data.tar.gz: 17d37b8a1b9546fd3b90e211c73baa7ae6bb3cd7c429a22dd8f062c3e90a59bbfe5fe20aa36e86ed70ba8d10895c0b01f952edb099ebe52da69d2de6fa11f53e
+  metadata.gz: 98686516419562bc5ac3c2ca2748197d642373c5a508fc937921a00cfbec34ab835af2813acce8d95bd0595a8228a3b9fe26374d116f179bc0c9bfc70058f2db
+  data.tar.gz: d67b50a3bc94beed337823ea61abb4e196ce0cd0eaa1c57818ff1e6791cb78737ac4554e28e16e6628d80dfec84c4732bba6e590b08d0ffb9d6f5afecf8cffea

data/CHANGELOG.md

@@ -1,3 +1,12 @@
+## 2.1.3 (Mar 9, 2016)
+
+* Raise a `Restforce::ServerError` when Salesforce responds with a `500` due to an internal error (@greysteil)
+* Improving handling of response body in errors (@kuono)
+
+## 2.1.2 (Nov 2, 2015)
+
+* Always parse the JSON response before errors are raised to improve exceptions (@kouno)
+
 ## 2.1.1 (Aug 20, 2015)
 
 * Added support for `get_updated` call (@web-connect)

data/README.md

@@ -61,21 +61,41 @@ It is also important to note that the client object should not be reused across
 #### OAuth token authentication
 
 ```ruby
-client = Restforce.new :oauth_token => 'oauth token',
+client = Restforce.new :oauth_token => 'access_token',
   :instance_url  => 'instance url'
 ```
 
-Although the above will work, you'll probably want to take advantage of the
-(re)authentication middleware by specifying a `refresh_token`, `client_id` and `client_secret`:
+Although the above will work, you'll probably want to take advantage of the (re)authentication middleware by specifying `refresh_token`, `client_id`, `client_secret`, and `authentication_callback`:
 
 ```ruby
-client = Restforce.new :oauth_token => 'oauth token',
-  :refresh_token => 'refresh token',
-  :instance_url  => 'instance url',
-  :client_id     => 'client_id',
-  :client_secret => 'client_secret'
+client = Restforce.new :oauth_token => 'access_token',
+  :refresh_token           => 'refresh token',
+  :instance_url            => 'instance url',
+  :client_id               => 'client_id',
+  :client_secret           => 'client_secret',
+  :authentication_callback => Proc.new {|x| Rails.logger.debug x.to_s}
 ```
 
+The middleware will use the `refresh_token` automatically to acquire a new `access_token` if the existing `access_token` is invalid.
+
+`authentication_callback` is a proc that handles the response from Salesforce when the `refresh_token` is used to obtain a new `access_token`. This allows the `access_token` to be saved for re-use later, otherwise subsequent API calls will continue the cycle of "auth failure/issue new access_token/auth success".
+
+The proc is passed one argument, a `Hashie::Mash` of the response from the [Salesforce API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_refresh_token_oauth.htm):
+
+```ruby
+{
+    "access_token" => "00Dx0000000BV7z!AR8AQP0jITN80ESEsj5EbaZTFG0RNBaT1cyWk7T5rqoDjoNIWQ2ME_sTZzBjfmOE6zMHq6y8PIW4eWze9JksNEkWUl.Cju7m4",
+       "signature" => "SSSbLO/gBhmmyNUvN18ODBDFYHzakxOMgqYtu+hDPsc=",
+           "scope" => "refresh_token full",
+    "instance_url" => "https://na1.salesforce.com",
+              "id" => "https://login.salesforce.com/id/00Dx0000000BV7z/005x00000012Q9P",
+      "token_type" => "Bearer",
+       "issued_at" => "1278448384422"
+}
+```
+
+The `id` field can be used to [uniquely identify](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_refresh_token_oauth.htm) the user that the `access_token` and `refresh_token` belong to.
+
 #### Username/Password authentication
 
 If you prefer to use a username and password to authenticate:
@@ -116,7 +136,7 @@ client = Restforce.new :username => 'foo',
   :proxy_uri      => 'http://proxy.example.com:123'
 ```
 
-You may specify a username and password for the proxy with a URL along the lines of 'http://user@password:proxy.example.com:123'.
+You may specify a username and password for the proxy with a URL along the lines of 'http://user:password@proxy.example.com:123'.
 
 #### Sandbox Orgs
 
@@ -199,6 +219,7 @@ account.destroy
 ```ruby
 accounts = client.query_all("select Id, Something__c from Account where isDeleted = true")
 # => #<Restforce::Collection >
+```
 
 query_all allows you to include results from your query that Salesforce hides in the default "query" method.  These include soft-deleted records and archived records (e.g. Task and Event records which are usually archived automatically after they are a year old).
 
@@ -353,7 +374,7 @@ Retrieves the list of individual record IDs that have been updated (added or cha
 
 ```ruby
 # Get the ids of all accounts which have been updated in the last day
-client.get_updated('Account', Time.local(2015,8,18) Time.local(2015,8,19))
+client.get_updated('Account', Time.local(2015,8,18), Time.local(2015,8,19))
 # => { ... }
 ```
 

data/lib/restforce.rb

@@ -37,6 +37,7 @@ module Restforce
   end
 
   Error               = Class.new(StandardError)
+  ServerError         = Class.new(Error)
   AuthenticationError = Class.new(Error)
   UnauthorizedError   = Class.new(Error)
   APIVersionError     = Class.new(Error)

data/lib/restforce/middleware/authentication.rb

@@ -22,7 +22,9 @@ module Restforce
         req.body = encode_www_form(params)
       end
 
-      if response.status != 200
+      if response.status >= 500
+        raise Restforce::ServerError, error_message(response)
+      elsif response.status != 200
         raise Restforce::AuthenticationError, error_message(response)
       end
 

data/lib/restforce/middleware/raise_error.rb

@@ -20,7 +20,7 @@ module Restforce
     end
 
     def body
-      @body = (@env[:body].respond_to?(:first) ? @env[:body].first : @env[:body])
+      @body = (@env[:body].is_a?(Array) ? @env[:body].first : @env[:body])
 
       case @body
       when Hash

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '2.1.2'
+  VERSION = '2.1.3'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-11-02 00:00:00.000000000 Z
+date: 2016-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday