restforce 4.0.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e4311062c172c1fd0706872045d29fed90d5b36df5f6c2656d88c37ac680fb2
-  data.tar.gz: f8b6e07bd7533342229f0bb02ef00a731dda64990927bc2c8d822fbfa46f5a29
+  metadata.gz: c668433781a24af5211bf9c102e5601ef69919a856928fb4a876de43bb96fa14
+  data.tar.gz: 5d5ee573dc491e1eb38703028d2c107d28a9fa2b37616f08e3004cc20c653868
 SHA512:
-  metadata.gz: 33d02a24a1fc9e7efd40a318f75a48992215b759bcb33c8860a0e4e49fbc5a2eac13cce908dac4605164af58fa6e43473b753668926e0875deeba63eac4cc51c
-  data.tar.gz: 1a6155b0ec55633ebf061e7e709b7e391fe266563f5476b658040139e977ea00baf356602aacf8c5b2aef313c0b48296bfad984d444fe437249424810b567512
+  metadata.gz: f938c2e517cb05c33c4526c04c0384edaa70f39bed1a391a58032fb52574fd50c20fab21f859439957070506d4c03d84447134885e14d5ad59f3bff02f689545
+  data.tar.gz: f2c466b8d4ae41bc6519dfaa27dbdbae2e302ad99c1ca52456f94bc391f243f99037bad48fc58533b83bb9cb146a30580e0cbe79a91cd9872e70fd0c9775865d

data/.circleci/config.yml

@@ -34,23 +34,23 @@ references:
         destination: test-results
 
 jobs:
-  build-ruby265:
+  build-ruby271:
     docker:
-       - image: circleci/ruby:2.6.5
+       - image: circleci/ruby:2.7.1
     steps: *steps
-  build-ruby257:
+  build-ruby266:
     docker:
-       - image: circleci/ruby:2.5.7
+       - image: circleci/ruby:2.6.6
     steps: *steps
-  build-ruby249:
+  build-ruby258:
     docker:
-       - image: circleci/ruby:2.4.9
+       - image: circleci/ruby:2.5.8
     steps: *steps
 
 workflows:
   version: 2
   tests:
     jobs:
-      - build-ruby265
-      - build-ruby257
-      - build-ruby249
+      - build-ruby271
+      - build-ruby266
+      - build-ruby258

data/.github/ISSUE_TEMPLATE/unhandled-salesforce-error.md

@@ -0,0 +1,17 @@
+---
+name: Unhandled Salesforce error
+about: We've recently changed the way we handle Salesforce errors to define them ahead
+  of time, rather than dynamically. This might mean we're missing some errors. Please
+  use this template to report them.
+title: 'Unhandled Salesforce error: <insert error code here>'
+labels: bug
+assignees: timrogers
+
+---
+
+Restforce doesn't have a definition for the error code `INSERT ERROR CODE HERE`.
+
+I discovered this missing error code because:
+
+- [ ] I tried to `rescue` it or refer to it in my code
+- [ ] I got this error back from Salesforce

data/.rubocop.yml

@@ -7,10 +7,11 @@ AllCops:
   Exclude:
     - .*/**/*
     - vendor/**/*
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  TargetRubyVersion: 2.5
 
-# Limit lines to 80 characters.
-Metrics/LineLength:
+# Limit lines to 90 characters.
+Layout/LineLength:
   Max: 90
 
 Metrics/ClassLength:

data/.rubocop_todo.yml

@@ -12,7 +12,7 @@
 # SupportedHashRocketStyles: key, separator, table
 # SupportedColonStyles: key, separator, table
 # SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/AlignHash:
+Layout/HashAlignment:
   Exclude:
     - 'lib/restforce/middleware/logger.rb'
     - 'restforce.gemspec'
@@ -23,7 +23,7 @@ Layout/AlignHash:
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, IndentationWidth.
 # SupportedStyles: special_inside_parentheses, consistent, align_braces
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   Exclude:
     - 'lib/restforce/concerns/connection.rb'
 

data/CHANGELOG.md

@@ -1,3 +1,39 @@
+## 5.0.0 (Jul 10, 2020)
+
+For instructions on upgrading from Restforce 4.x to 5.x, see our ["Upgrading from Restforce 4.x to 5.x"](https://github.com/restforce/restforce/blob/master/UPGRADING.md) guide.
+
+### Breaking changes 
+
+* __⚠️  Define exception classes for Salesforce errors up-front instead of dynamically at runtime__, *running the risk that we might miss some errors which should be defined*. If any errors are missed, they will be added in patch versions (e.g. `5.0.1`). For more details on this change, see the ["Upgrading from Restforce 4.x to 5.x"](https://github.com/restforce/restforce/blob/master/UPGRADING.md) guide (@presidentbeef, @timrogers).
+* __⚠️  Deprecate support for Ruby 2.4__, since [Ruby 2.4 reached its end-of-life](https://www.ruby-lang.org/en/news/2020/04/05/support-of-ruby-2-4-has-ended/) in April 2020 (@timrogers)
+* __⚠️  Change the ancestry of `Restforce::UnauthorizedError` so it inherits from `Faraday::ClientError`, not `Restforce::Error`__. This breaking change was required to expose the response body returned by the API as part of this error - see the non-breaking changes entry below for further details (@michaldbianchi).
+
+### Non-breaking changes
+
+* Add support for `lostisland/faraday` v1.x, whilst maintaining support for v0.9.x (@ryansch)
+* Add `#empty?` method to `Restforce::Collection`, returning whether they are any items in a collection (@bubaflub)
+* Allow opting-in to caching on a per-call basis with `Restforce::Client#with_caching` (@swaincreates)
+* Expose the response body from Salesforce on `Restforce::UnauthorizedError` and `Restforce::NotFoundError` (@michaeldbianchi)
+* Remove the unnecessary depending on the `json` gem, which has been part of the Ruby standard library since v1.9 (@vonTronje)
+
+
+## 4.2.2 (Jan 23, 2020)
+
+* Fix `NoMethodError: undefined method '[]' for nil:NilClass` error when generating objects to return (@apurkiss)
+
+## 4.2.1 (Dec 4, 2019)
+
+* Handle empty response bodies returned with authentication errors (@sylvandor)
+* Fix Faraday deprecation warning in newer Faraday versions (`v0.17.1` onwards) caused by inheriting from a deprecated class 
+
+## 4.2.0 (Oct 23, 2019)
+
+* Add support for platform events, CDC, generic events, etc. in the Streaming API (@nathanKramer)
+
+## 4.1.0 (Oct 20, 2019)
+
+* Add support for JWT authentication (@nathanKramer, @tagCincy)
+
 ## 4.0.0 (Oct 9, 2019)
 
 * __Deprecate support for Ruby 2.3__, since [Ruby 2.3 reached its end-of-life](https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/) in March 2019. (This is the only breaking change included in this version.)

data/CONTRIBUTING.md

@@ -34,4 +34,4 @@ Some things that will increase the chance that your pull request is accepted:
 * Write tests.
 * Write a [good commit message](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html).
 
-*Adapted from [factory_girl_rails's CONTRIBUTING.md](https://github.com/thoughtbot/factory_girl_rails/blob/master/CONTRIBUTING.md).*
+*Adapted from [factory_bot_rails's CONTRIBUTING.md](https://github.com/thoughtbot/factory_bot_rails/blob/master/CONTRIBUTING.md).*

data/Gemfile

@@ -3,8 +3,8 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'faraday', '~> 0.17.0'
 gem 'jruby-openssl', platforms: :jruby
+gem 'jwt'
 gem 'rake'
 
 group :development do

data/README.md

@@ -8,7 +8,7 @@ Restforce is a ruby gem for the [Salesforce REST api](http://www.salesforce.com/
 Features include:
 
 * A clean and modular architecture using [Faraday middleware](https://github.com/technoweenie/faraday) and [Hashie::Mash](https://github.com/intridea/hashie/tree/v1.2.0)'d responses.
-* Support for interacting with multiple users from different orgs.
+* Support for interacting with multiple users from different organizations.
 * Support for parent-to-child relationships.
 * Support for aggregate queries.
 * Support for the [Streaming API](#streaming)
@@ -19,13 +19,13 @@ Features include:
 * Support for dependent picklists.
 * Support for decoding [Force.com Canvas](http://www.salesforce.com/us/developer/docs/platform_connectpre/canvas_framework.pdf) signed requests. (NEW!)
 
-[Official Website](http://restforce.org/) | [Documentation](http://rubydoc.info/gems/restforce/frames) | [Changelog](https://github.com/restforce/restforce/tree/master/CHANGELOG.md)
+[Official Website](https://restforce.github.io/) | [Documentation](http://rubydoc.info/gems/restforce/frames) | [Changelog](https://github.com/restforce/restforce/tree/master/CHANGELOG.md)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 4.0.0'
+    gem 'restforce', '~> 5.0.0'
 
 And then execute:
 
@@ -35,7 +35,12 @@ Or install it yourself as:
 
     $ gem install restforce
 
-__As of [version 4.0.0](https://github.com/restforce/restforce/blob/master/CHANGELOG.md#400-oct-9-2019), this gem is only compatible with Ruby 2.4.0 and later.__ You'll need to use version 3.2.0 or earlier if you're running on Ruby 2.3. If you're running on Ruby 2.2, 2.1 or 2.0, use version 2.5.3 or earlier. For Ruby 1.9.3, you'll need to manually specify that you wish to use version 2.4.2.
+__As of version 5.0.0, this gem is only compatible with Ruby 2.5.0 and later.__ If you're using an earlier Ruby version:
+
+* for Ruby 2.4, use version 4.2.2 or earlier
+* for Ruby 2.3, use version 3.2.0 or earlier
+* for Ruby versions 2.2, 2.1 and 2.0, use version 2.5.3 or earlier
+* for Ruby 1.9.3, use version 2.4.2
 
 This gem is versioned using [Semantic Versioning](http://semver.org/), so you can be confident when updating that there will not be breaking changes outside of a major version (following format MAJOR.MINOR.PATCH, so for instance moving from 3.1.0 to 4.0.0 would be allowed to include incompatible API changes). See the [changelog](https://github.com/restforce/restforce/tree/master/CHANGELOG.md) for details on what has changed in each version.
 
@@ -48,7 +53,7 @@ so you can do things like `client.query('select Id, (select Name from Children__
 ### Initialization
 
 Which authentication method you use really depends on your use case. If you're
-building an application where many users from different orgs are authenticated
+building an application where many users from different organizations are authenticated
 through oauth and you need to interact with data in their org on their behalf,
 you should use the OAuth token authentication method.
 
@@ -78,7 +83,7 @@ client = Restforce.new(oauth_token: 'access_token',
                        api_version: '41.0')
 ```
 
-The middleware will use the `refresh_token` automatically to acquire a new `access_token` if the existing `access_token` is invalid.
+The middleware will use the `refresh_token` automatically to acquire a new `access_token` if the existing `access_token` is invalid. The refresh process uses the `host` option so make sure that is set correctly for sandbox organizations.
 
 `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".
 
@@ -111,6 +116,21 @@ client = Restforce.new(username: 'foo',
                        api_version: '41.0')
 ```
 
+#### JWT Bearer Token
+
+If you prefer to use a [JWT Bearer Token](https://developer.salesforce.com/page/Digging_Deeper_into_OAuth_2.0_on_Force.com#Obtaining_an_Access_Token_using_a_JWT_Bearer_Token) to authenticate:
+
+```ruby
+client = Restforce.new(username: 'foo',
+                       client_id: 'client_id',
+                       instance_url: 'instance_url',
+                       jwt_key: 'certificate_private_key',
+                       api_version: '38.0')
+```
+
+The `jwt_key` option is the private key of the certificate uploaded to your Connected App in Salesforce.
+Choose "use digital signatures" in the Connected App configuration screen to upload your certificate.
+
 You can also set the username, password, security token, client ID, client
 secret and API version in environment variables:
 
@@ -127,7 +147,17 @@ export SALESFORCE_API_VERSION="41.0"
 client = Restforce.new
 ```
 
-### Proxy Support
+#### Sandbox Organizations
+
+You can connect to sandbox organizations by specifying a host. The default host is
+'login.salesforce.com':
+
+```ruby
+client = Restforce.new(host: 'test.salesforce.com')
+```
+The host can also be set with the environment variable `SALESFORCE_HOST`.
+
+#### Proxy Support
 
 You can specify a HTTP proxy using the `proxy_uri` option, as follows, or by setting the `SALESFORCE_PROXY_URI` environment variable:
 
@@ -143,16 +173,6 @@ client = Restforce.new(username: 'foo',
 
 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
-
-You can connect to sandbox orgs by specifying a host. The default host is
-'login.salesforce.com':
-
-```ruby
-client = Restforce.new(host: 'test.salesforce.com')
-```
-The host can also be set with the environment variable `SALESFORCE_HOST`.
-
 #### Global configuration
 
 You can set any of the options passed into `Restforce.new` globally:
@@ -442,7 +462,7 @@ Using the new [Blob Data](http://www.salesforce.com/us/developer/docs/api_rest/C
 client.create('Document', FolderId: '00lE0000000FJ6H',
                           Description: 'Document test',
                           Name: 'My image',
-                          Body: Restforce::UploadIO.new(File.expand_path('image.jpg', __FILE__), 'image/jpeg')
+                          Body: Restforce::FilePart.new(File.expand_path('image.jpg', __FILE__), 'image/jpeg')
 ```
 
 Using base64 encoded data (37.5mb limit):
@@ -473,11 +493,11 @@ document = client.query('select Id, Name, Body from Document').first
 File.open(document.Name, 'wb') { |f| f.write(document.Body) }
 ```
 
-**Note:** The example above is only applicable if your SOQL query returns a single Document record. If more than one record is returned, 
+**Note:** The example above is only applicable if your SOQL query returns a single Document record. If more than one record is returned,
 the Body field contains an URL to retrieve the BLOB content for the first 2000 records returned. Subsequent records contain the BLOB content
-in the Body field. This is confusing and hard to debug. See notes in [Issue #301](https://github.com/restforce/restforce/issues/301#issuecomment-298972959) explaining this detail. 
-**Executive Summary:** Don't retrieve the Body field in a SOQL query; instead, use the BLOB retrieval URL documented 
-in [SObject BLOB Retrieve](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_blob_retrieve.htm) 
+in the Body field. This is confusing and hard to debug. See notes in [Issue #301](https://github.com/restforce/restforce/issues/301#issuecomment-298972959) explaining this detail.
+**Executive Summary:** Don't retrieve the Body field in a SOQL query; instead, use the BLOB retrieval URL documented
+in [SObject BLOB Retrieve](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_blob_retrieve.htm)
 
 * * *
 
@@ -513,8 +533,10 @@ client.get('/services/apexrest/FieldCase', company: 'GenePoint')
 
 ### Streaming
 
-Restforce supports the [Streaming API](http://wiki.developerforce.com/page/Getting_Started_with_the_Force.com_Streaming_API), and makes implementing
-pub/sub with Salesforce a trivial task:
+Restforce supports the [Streaming API](https://trailhead.salesforce.com/en/content/learn/modules/api_basics/api_basics_streaming), and makes implementing
+pub/sub with Salesforce a trivial task.
+
+Here is an example of creating and subscribing to a `PushTopic`:
 
 ```ruby
 # Restforce uses faye as the underlying implementation for CometD.
@@ -538,7 +560,7 @@ client.create!('PushTopic',
 
 EM.run do
   # Subscribe to the PushTopic.
-  client.subscribe 'AllAccounts' do |message|
+  client.subscription '/topic/AllAccounts' do |message|
     puts message.inspect
   end
 end
@@ -559,7 +581,7 @@ that event ID:
 ```ruby
 EM.run {
   # Subscribe to the PushTopic.
-  client.subscribe 'AllAccounts', replay: 10 do |message|
+  client.subscription '/topic/AllAccounts', replay: 10 do |message|
     puts message.inspect
   end
 }
@@ -574,14 +596,14 @@ There are two magic values for the replay ID accepted by Salesforce:
 
 **Warning**: Only use a replay ID of a event from the last 24 hours otherwise
 Salesforce will not send anything, including newer events. If in doubt, use one
-of the two magic replay IDs mentioned above. 
+of the two magic replay IDs mentioned above.
 
-You might want to store the replay ID in some sort of datastore so you can 
+You might want to store the replay ID in some sort of datastore so you can
 access it, for example between application restarts. In that case, there is the
 option of passing a custom replay handler which responds to `[]` and `[]=`.
 
 Below is a sample replay handler that stores the replay ID for each channel in
-memory using a Hash, stores a timestamp and has some rudimentary logic that 
+memory using a Hash, stores a timestamp and has some rudimentary logic that
 will use one of the magic IDs depending on the value of the timestamp:
 
 ```ruby
@@ -633,13 +655,13 @@ of the subscription:
 EM.run {
   # Subscribe to the PushTopic and use the custom replay handler to store any
   # received replay ID.
-  client.subscribe 'AllAccounts', replay: SimpleReplayHandler.new do |message|
+  client.subscription '/topic/AllAccounts', replay: SimpleReplayHandler.new do |message|
     puts message.inspect
   end
 }
-``` 
+```
 
-_See also_: 
+_See also_:
 
 * [Force.com Streaming API docs](http://www.salesforce.com/us/developer/docs/api_streaming/index.htm)
 * [Message Durability docs](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/using_streaming_api_durability.htm)
@@ -671,7 +693,23 @@ client.without_caching do
 end
 ```
 
-Caching is done on based on your authentication credentials, so cached responses will not be shared between different Salesforce logins.
+If you prefer to opt in to caching on a per-request, you can do so by using .with_caching and
+setting the `use_cache` config option to false:
+
+```ruby
+Restforce.configure do |config|
+  config.cache = Rails.cache
+  config.use_cache = false
+end
+```
+
+```ruby
+client.with_caching do
+  client.query('select Id from Account')
+end
+```
+
+Caching is done based on your authentication credentials, so cached responses will not be shared between different Salesforce logins.
 
 * * *
 

data/UPGRADING.md

@@ -0,0 +1,38 @@
+# Upgrading from Restforce 4.x to 5.x
+
+__There are three breaking changes introduced in Restforce 5.x__. In this guide, you'll learn about these changes and what you should check in your code to make sure that it will work with the latest version of the library.
+
+## Error classes are now defined up-front, rather than dynamically at runtime
+
+__Likelyhood of impact__: Moderate
+
+The Salesforce REST API can return a range of `errorCode`s representing different kinds of errors. To make these easy to
+handle in your code, we want to turn these into individual, specific exception classes in the `Restforce::ErrorCode` namespace that inherit from `Restforce:: ResponseError`.
+
+Up until now, these exception classes have been defined dynamically at runtime which has some disadvantages - see the [pull request](https://github.com/restforce/restforce/pull/551) for more details.
+
+In this version, we switch to defining them up-front in the code based on a list in the Salesforce documentation. There is a risk that we might have missed some errors which should be defined. If any errors are missed, they will be added in patch versions (e.g. `5.0.1`). 
+
+If your application won't run because you are referring to an exception class that no longer exists, or you see warnings logged anywhere, please [create an issue](https://github.com/restforce/restforce/issues/new?template=unhandled-salesforce-error.md&title=Unhandled+Salesforce+error%3A+%3Cinsert+error+code+here%3E).
+
+## Ruby 2.4 is no longer supported
+
+__Likelyhood of impact__: Moderate
+
+As of [5th April 2020](https://www.ruby-lang.org/en/news/2020/04/05/support-of-ruby-2-4-has-ended/), Ruby 2.4 is no longer officially supported as an active version of the Ruby language. That means that it will not receive patches and security fixes.
+
+Accordingly, we've dropped support for Ruby 2.4 and earlier in the Restforce library. It *may* be compatible, bu we don't guarantee this or enforce it with automated tests.
+
+Before you update to Restforce 5.x, you'll need to switch to Ruby 2.5 or later. The current version of Ruby at the time of wriing is 2.7.
+
+## `Restforce::UnauthorizedError` no longer inherits from `Restforce::Error`
+
+__Likelyhood of impact__: Low
+
+Previously, the `Restforce::UnauthorizedError` returned when the library couldn't authenticate with the Salesforce API inherits from `Restforce::Error`. So, if you used `rescue Restforce::Error` in your code, you'd catch these exceptions.
+
+We've now changed this exception class to inherit from `Faraday::ClientError` which allows the response body returned from the Salesforce API to be attached to the error.
+
+If you refer to `Restforce::Error` anywhere in your code, you should check whether you also need to take into account `Restforce::UnauthorizedError`.
+
+If you refer to `Faraday::ClientError` anywhere in your code, you should check that you want the case where Restforce can't authenticate to be included.

data/lib/restforce.rb

@@ -3,6 +3,7 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
+require 'jwt'
 
 require 'restforce/version'
 require 'restforce/config'
@@ -14,7 +15,8 @@ module Restforce
   autoload :Middleware,     'restforce/middleware'
   autoload :Attachment,     'restforce/attachment'
   autoload :Document,       'restforce/document'
-  autoload :UploadIO,       'restforce/upload_io'
+  autoload :FilePart,       'restforce/file_part'
+  autoload :UploadIO,       'restforce/file_part' # Deprecated
   autoload :SObject,        'restforce/sobject'
   autoload :Client,         'restforce/client'
   autoload :Mash,           'restforce/mash'
@@ -43,27 +45,23 @@ module Restforce
   Error               = Class.new(StandardError)
   ServerError         = Class.new(Error)
   AuthenticationError = Class.new(Error)
-  UnauthorizedError   = Class.new(Error)
+  UnauthorizedError   = Class.new(Faraday::ClientError)
   APIVersionError     = Class.new(Error)
   BatchAPIError       = Class.new(Error)
 
-  # Inherit from Faraday::Error::ResourceNotFound for backwards-compatibility
-  # Consumers of this library that rescue and handle Faraday::Error::ResourceNotFound
+  # Inherit from Faraday::ResourceNotFound for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::ResourceNotFound
   # can continue to do so.
-  NotFoundError       = Class.new(Faraday::Error::ResourceNotFound)
+  NotFoundError       = Class.new(Faraday::ResourceNotFound)
 
-  # Inherit from Faraday::Error::ClientError for backwards-compatibility
-  # Consumers of this library that rescue and handle Faraday::Error::ClientError
+  # Inherit from Faraday::ClientError for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::ClientError
   # can continue to do so.
-  ResponseError       = Class.new(Faraday::Error::ClientError)
+  ResponseError       = Class.new(Faraday::ClientError)
   MatchesMultipleError= Class.new(ResponseError)
   EntityTooLargeError = Class.new(ResponseError)
 
-  module ErrorCode
-    def self.const_missing(constant_name)
-      const_set constant_name, Class.new(ResponseError)
-    end
-  end
+  require 'restforce/error_code'
 
   class << self
     # Alias for Restforce::Data::Client.new