restforce 4.3.0 → 5.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f24606173bf2365a1482e7ed764863aed6bf53ffad8f9e6c380144c5567a7541
-  data.tar.gz: fadc63d588d150937b9b4ff102adcdd2ab91691fc26f8bfaa9515b2eb79a4553
+  metadata.gz: c668433781a24af5211bf9c102e5601ef69919a856928fb4a876de43bb96fa14
+  data.tar.gz: 5d5ee573dc491e1eb38703028d2c107d28a9fa2b37616f08e3004cc20c653868
 SHA512:
-  metadata.gz: 25baee4f91c29f7f3210b23c9a79f9ac1a9ee12a3a6169e20090e860ec62d51b671ef87b84f8ffc25633a2df933cbed0e5e980fb5ef41c7af08db7aa20de4eda
-  data.tar.gz: 6ab7f0096e6931fb2a59febb88d84a3c51a2000d3e690402b9f42ae9b85073f0b2623100a6a106035a420d448f64969c39415411def1a8c4f5bc690ef281c591
+  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/CHANGELOG.md

@@ -1,6 +1,21 @@
-## 4.3.0 (Feb 10, 2021)
+## 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)
 
-* Add compatability with Faraday versions up to but not including `v1.1.0` (@hongtron)
 
 ## 4.2.2 (Jan 23, 2020)
 

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,7 +3,6 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'faraday', '~> 0.17.0'
 gem 'jruby-openssl', platforms: :jruby
 gem 'jwt'
 gem 'rake'

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.3.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".
 
@@ -142,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:
 
@@ -158,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:
@@ -457,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):
@@ -688,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

@@ -15,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'
@@ -44,7 +45,7 @@ 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)
 
@@ -60,11 +61,7 @@ module Restforce
   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

data/lib/restforce/collection.rb

@@ -33,6 +33,11 @@ module Restforce
     end
     alias length size
 
+    # Returns true if the size of the Collection is zero.
+    def empty?
+      size.zero?
+    end
+
     # Return array of the elements on the current page
     def current_page
       first(@raw_page['records'].size)

data/lib/restforce/concerns/api.rb

@@ -510,7 +510,7 @@ module Restforce
 
       # Internal: Errors that should be rescued from in non-bang methods
       def exceptions
-        [Faraday::ClientError]
+        [Faraday::Error]
       end
     end
   end

data/lib/restforce/concerns/caching.rb

@@ -15,6 +15,13 @@ module Restforce
         options.delete(:use_cache)
       end
 
+      def with_caching
+        options[:use_cache] = true
+        yield
+      ensure
+        options[:use_cache] = false
+      end
+
       private
 
       # Internal: Cache to use for the caching middleware

data/lib/restforce/config.rb

@@ -156,6 +156,9 @@ module Restforce
     # Set a log level for logging when Restforce.log is set to true, defaulting to :debug
     option :log_level, default: :debug
 
+    # Set use_cache to false to opt in to caching with client.with_caching
+    option :use_cache, default: true
+
     def options
       self.class.options
     end

data/lib/restforce/error_code.rb

@@ -0,0 +1,406 @@
+# frozen_string_literal: true
+
+module Restforce
+  module ErrorCode
+    GITHUB_ISSUE_URL = "https://github.com/restforce/restforce/issues/new?template=" \
+      "unhandled-salesforce-error.md&title=Unhandled+Salesforce+error%3A+%3Cinsert+" \
+      "error+code+here%3E"
+
+    # We define all of the known errors returned by Salesforce based on the
+    # documentation at
+    # https://developer.salesforce.com/docs/atlas.en-us.api.meta/api/sforce_api_calls_concepts_core_data_objects.htm#statuscode
+    # Previously, these were defined dynamically at runtime using `Module.const_set`. Now
+    # we define them up-front.
+    # It is possible that we will be missing some errors, so we will handle this in
+    # at least a semi-graceful manner.
+    class AllOrNoneOperationRolledBack < ResponseError; end
+    class AlreadyInProcess < ResponseError; end
+    class AssigneeTypeRequired < ResponseError; end
+    class BadCustomEntityParentDomain < ResponseError; end
+    class BccNotAllowedIfBccComplianceEnabled < ResponseError; end
+    class BccSelfNotAllowedIfBccComplianceEnabled < ResponseError; end
+    class CannotCascadeProductActive < ResponseError; end
+    class CannotChangeFieldTypeOfApexReferencedField < ResponseError; end
+    class CannotCreateAnotherManagedPackage < ResponseError; end
+    class CannotDeactivateDivision < ResponseError; end
+    class CannotDeleteLastDatedConversionRate < ResponseError; end
+    class CannotDeleteManagedObject < ResponseError; end
+    class CannotDisableLastAdmin < ResponseError; end
+    class CannotEnableIpRestrictRequests < ResponseError; end
+    class CannotInsertUpdateActivateEntity < ResponseError; end
+    class CannotModifyManagedObject < ResponseError; end
+    class CannotRenameApexReferencedField < ResponseError; end
+    class CannotRenameApexReferencedObject < ResponseError; end
+    class CannotReparentRecord < ResponseError; end
+    class CannotResolveName < ResponseError; end
+    class CannotUpdateConvertedLead < ResponseError; end
+    class CantDisableCorpCurrency < ResponseError; end
+    class CantUnsetCorpCurrency < ResponseError; end
+    class ChildShareFailsParent < ResponseError; end
+    class CircularDependency < ResponseError; end
+    class CommunityNotAccessible < ResponseError; end
+    class CustomClobFieldLimitExceeded < ResponseError; end
+    class CustomEntityOrFieldLimit < ResponseError; end
+    class CustomFieldIndexLimitExceeded < ResponseError; end
+    class CustomIndexExists < ResponseError; end
+    class CustomLinkLimitExceeded < ResponseError; end
+    class CustomMetadataLimitExceeded < ResponseError; end
+    class CustomSettingsLimitExceeded < ResponseError; end
+    class CustomTabLimitExceeded < ResponseError; end
+    class DeleteFailed < ResponseError; end
+    class DependencyExists < ResponseError; end
+    class DuplicateCaseSolution < ResponseError; end
+    class DuplicateCustomEntityDefinition < ResponseError; end
+    class DuplicateCustomTabMotif < ResponseError; end
+    class DuplicateDeveloperName < ResponseError; end
+    class DuplicatesDetected < ResponseError; end
+    class DuplicateExternalId < ResponseError; end
+    class DuplicateMasterLabel < ResponseError; end
+    class DuplicateSenderDisplayName < ResponseError; end
+    class DuplicateUsername < ResponseError; end
+    class DuplicateValue < ResponseError; end
+    class EmailAddressBounced < ResponseError; end
+    class EmailNotProcessedDueToPriorError < ResponseError; end
+    class EmailOptedOut < ResponseError; end
+    class EmailTemplateFormulaError < ResponseError; end
+    class EmailTemplateMergefieldAccessError < ResponseError; end
+    class EmailTemplateMergefieldError < ResponseError; end
+    class EmailTemplateMergefieldValueError < ResponseError; end
+    class EmailTemplateProcessingError < ResponseError; end
+    class EmptyScontrolFileName < ResponseError; end
+    class EntityFailedIflastmodifiedOnUpdate < ResponseError; end
+    class EntityIsArchived < ResponseError; end
+    class EntityIsDeleted < ResponseError; end
+    class EntityIsLocked < ResponseError; end
+    class EnvironmentHubMembershipConflict < ResponseError; end
+    class ErrorInMailer < ResponseError; end
+    class FailedActivation < ResponseError; end
+    class FieldCustomValidationException < ResponseError; end
+    class FieldFilterValidationException < ResponseError; end
+    class FilteredLookupLimitExceeded < ResponseError; end
+    class HtmlFileUploadNotAllowed < ResponseError; end
+    class ImageTooLarge < ResponseError; end
+    class InactiveOwnerOrUser < ResponseError; end
+    class InsertUpdateDeleteNotAllowedDuringMaintenance < ResponseError; end
+    class InsufficientAccessOnCrossReferenceEntity < ResponseError; end
+    class InsufficientAccessOrReadonly < ResponseError; end
+    class InvalidAccessLevel < ResponseError; end
+    class InvalidArgumentType < ResponseError; end
+    class InvalidAssigneeType < ResponseError; end
+    class InvalidAssignmentRule < ResponseError; end
+    class InvalidBatchOperation < ResponseError; end
+    class InvalidContentType < ResponseError; end
+    class InvalidCreditCardInfo < ResponseError; end
+    class InvalidCrossReferenceKey < ResponseError; end
+    class InvalidCrossReferenceTypeForField < ResponseError; end
+    class InvalidCurrencyConvRate < ResponseError; end
+    class InvalidCurrencyCorpRate < ResponseError; end
+    class InvalidCurrencyIso < ResponseError; end
+    class InvalidEmailAddress < ResponseError; end
+    class InvalidEmptyKeyOwner < ResponseError; end
+    class InvalidEventSubscription < ResponseError; end
+    class InvalidField < ResponseError; end
+    class InvalidFieldForInsertUpdate < ResponseError; end
+    class InvalidFieldWhenUsingTemplate < ResponseError; end
+    class InvalidFilterAction < ResponseError; end
+    class InvalidIdField < ResponseError; end
+    class InvalidInetAddress < ResponseError; end
+    class InvalidLineitemCloneState < ResponseError; end
+    class InvalidMasterOrTranslatedSolution < ResponseError; end
+    class InvalidMessageIdReference < ResponseError; end
+    class InvalidOperation < ResponseError; end
+    class InvalidOperator < ResponseError; end
+    class InvalidOrNullForRestrictedPicklist < ResponseError; end
+    class InvalidPartnerNetworkStatus < ResponseError; end
+    class InvalidPersonAccountOperation < ResponseError; end
+    class InvalidReadOnlyUserDml < ResponseError; end
+    class InvalidSaveAsActivityFlag < ResponseError; end
+    class InvalidSessionId < ResponseError; end
+    class InvalidStatus < ResponseError; end
+    class InvalidType < ResponseError; end
+    class InvalidTypeForOperation < ResponseError; end
+    class InvalidTypeOnFieldInRecord < ResponseError; end
+    class IpRangeLimitExceeded < ResponseError; end
+    class JigsawImportLimitExceeded < ResponseError; end
+    class LicenseLimitExceeded < ResponseError; end
+    class LightPortalUserException < ResponseError; end
+    class LimitExceeded < ResponseError; end
+    class LoginChallengeIssued < ResponseError; end
+    class LoginChallengePending < ResponseError; end
+    class LoginMustUseSecurityToken < ResponseError; end
+    class MalformedId < ResponseError; end
+    class ManagerNotDefined < ResponseError; end
+    class MassmailRetryLimitExceeded < ResponseError; end
+    class MassMailLimitExceeded < ResponseError; end
+    class MaximumCcemailsExceeded < ResponseError; end
+    class MaximumDashboardComponentsExceeded < ResponseError; end
+    class MaximumHierarchyLevelsReached < ResponseError; end
+    class MaximumSizeOfAttachment < ResponseError; end
+    class MaximumSizeOfDocument < ResponseError; end
+    class MaxActionsPerRuleExceeded < ResponseError; end
+    class MaxActiveRulesExceeded < ResponseError; end
+    class MaxApprovalStepsExceeded < ResponseError; end
+    class MaxFormulasPerRuleExceeded < ResponseError; end
+    class MaxRulesExceeded < ResponseError; end
+    class MaxRuleEntriesExceeded < ResponseError; end
+    class MaxTaskDescriptionExceeded < ResponseError; end
+    class MaxTmRulesExceeded < ResponseError; end
+    class MaxTmRuleItemsExceeded < ResponseError; end
+    class MergeFailed < ResponseError; end
+    class MissingArgument < ResponseError; end
+    class NonuniqueShippingAddress < ResponseError; end
+    class NoApplicableProcess < ResponseError; end
+    class NoAttachmentPermission < ResponseError; end
+    class NoInactiveDivisionMembers < ResponseError; end
+    class NoMassMailPermission < ResponseError; end
+    class NumberOutsideValidRange < ResponseError; end
+    class NumHistoryFieldsBySobjectExceeded < ResponseError; end
+    class OpWithInvalidUserTypeException < ResponseError; end
+    class OptedOutOfMassMail < ResponseError; end
+    class PackageLicenseRequired < ResponseError; end
+    class PlatformEventEncryptionError < ResponseError; end
+    class PlatformEventPublishingUnavailable < ResponseError; end
+    class PlatformEventPublishFailed < ResponseError; end
+    class PortalUserAlreadyExistsForContact < ResponseError; end
+    class PrivateContactOnAsset < ResponseError; end
+    class RecordInUseByWorkflow < ResponseError; end
+    class RequestRunningTooLong < ResponseError; end
+    class RequiredFieldMissing < ResponseError; end
+    class SelfReferenceFromTrigger < ResponseError; end
+    class ShareNeededForChildOwner < ResponseError; end
+    class SingleEmailLimitExceeded < ResponseError; end
+    class StandardPriceNotDefined < ResponseError; end
+    class StorageLimitExceeded < ResponseError; end
+    class StringTooLong < ResponseError; end
+    class TabsetLimitExceeded < ResponseError; end
+    class TemplateNotActive < ResponseError; end
+    class TerritoryRealignInProgress < ResponseError; end
+    class TextDataOutsideSupportedCharset < ResponseError; end
+    class TooManyApexRequests < ResponseError; end
+    class TooManyEnumValue < ResponseError; end
+    class TransferRequiresRead < ResponseError; end
+    class UnableToLockRow < ResponseError; end
+    class UnavailableRecordtypeException < ResponseError; end
+    class UndeleteFailed < ResponseError; end
+    class UnknownException < ResponseError; end
+    class UnspecifiedEmailAddress < ResponseError; end
+    class UnsupportedApexTriggerOperation < ResponseError; end
+    class UnverifiedSenderAddress < ResponseError; end
+    class WeblinkSizeLimitExceeded < ResponseError; end
+    class WeblinkUrlInvalid < ResponseError; end
+    class WrongControllerType < ResponseError; end
+
+    # Maps `errorCode`s returned from Salesforce to the exception class
+    # to be used for these errors
+    ERROR_EXCEPTION_CLASSES = {
+      "ALL_OR_NONE_OPERATION_ROLLED_BACK" => AllOrNoneOperationRolledBack,
+      "ALREADY_IN_PROCESS" => AlreadyInProcess,
+      "ASSIGNEE_TYPE_REQUIRED" => AssigneeTypeRequired,
+      "BAD_CUSTOM_ENTITY_PARENT_DOMAIN" => BadCustomEntityParentDomain,
+      "BCC_NOT_ALLOWED_IF_BCC_COMPLIANCE_ENABLED" =>
+   BccNotAllowedIfBccComplianceEnabled,
+      "BCC_SELF_NOT_ALLOWED_IF_BCC_COMPLIANCE_ENABLED" =>
+   BccSelfNotAllowedIfBccComplianceEnabled,
+      "CANNOT_CASCADE_PRODUCT_ACTIVE" => CannotCascadeProductActive,
+      "CANNOT_CHANGE_FIELD_TYPE_OF_APEX_REFERENCED_FIELD" =>
+   CannotChangeFieldTypeOfApexReferencedField,
+      "CANNOT_CREATE_ANOTHER_MANAGED_PACKAGE" => CannotCreateAnotherManagedPackage,
+      "CANNOT_DEACTIVATE_DIVISION" => CannotDeactivateDivision,
+      "CANNOT_DELETE_LAST_DATED_CONVERSION_RATE" =>
+   CannotDeleteLastDatedConversionRate,
+      "CANNOT_DELETE_MANAGED_OBJECT" => CannotDeleteManagedObject,
+      "CANNOT_DISABLE_LAST_ADMIN" => CannotDisableLastAdmin,
+      "CANNOT_ENABLE_IP_RESTRICT_REQUESTS" => CannotEnableIpRestrictRequests,
+      "CANNOT_INSERT_UPDATE_ACTIVATE_ENTITY" => CannotInsertUpdateActivateEntity,
+      "CANNOT_MODIFY_MANAGED_OBJECT" => CannotModifyManagedObject,
+      "CANNOT_RENAME_APEX_REFERENCED_FIELD" => CannotRenameApexReferencedField,
+      "CANNOT_RENAME_APEX_REFERENCED_OBJECT" => CannotRenameApexReferencedObject,
+      "CANNOT_REPARENT_RECORD" => CannotReparentRecord,
+      "CANNOT_RESOLVE_NAME" => CannotResolveName,
+      "CANNOT_UPDATE_CONVERTED_LEAD" => CannotUpdateConvertedLead,
+      "CANT_DISABLE_CORP_CURRENCY" => CantDisableCorpCurrency,
+      "CANT_UNSET_CORP_CURRENCY" => CantUnsetCorpCurrency,
+      "CHILD_SHARE_FAILS_PARENT" => ChildShareFailsParent,
+      "CIRCULAR_DEPENDENCY" => CircularDependency,
+      "COMMUNITY_NOT_ACCESSIBLE" => CommunityNotAccessible,
+      "CUSTOM_CLOB_FIELD_LIMIT_EXCEEDED" => CustomClobFieldLimitExceeded,
+      "CUSTOM_ENTITY_OR_FIELD_LIMIT" => CustomEntityOrFieldLimit,
+      "CUSTOM_FIELD_INDEX_LIMIT_EXCEEDED" => CustomFieldIndexLimitExceeded,
+      "CUSTOM_INDEX_EXISTS" => CustomIndexExists,
+      "CUSTOM_LINK_LIMIT_EXCEEDED" => CustomLinkLimitExceeded,
+      "CUSTOM_METADATA_LIMIT_EXCEEDED" => CustomMetadataLimitExceeded,
+      "CUSTOM_SETTINGS_LIMIT_EXCEEDED" => CustomSettingsLimitExceeded,
+      "CUSTOM_TAB_LIMIT_EXCEEDED" => CustomTabLimitExceeded,
+      "DELETE_FAILED" => DeleteFailed,
+      "DEPENDENCY_EXISTS" => DependencyExists,
+      "DUPLICATE_CASE_SOLUTION" => DuplicateCaseSolution,
+      "DUPLICATE_CUSTOM_ENTITY_DEFINITION" => DuplicateCustomEntityDefinition,
+      "DUPLICATE_CUSTOM_TAB_MOTIF" => DuplicateCustomTabMotif,
+      "DUPLICATE_DEVELOPER_NAME" => DuplicateDeveloperName,
+      "DUPLICATES_DETECTED" => DuplicatesDetected,
+      "DUPLICATE_EXTERNAL_ID" => DuplicateExternalId,
+      "DUPLICATE_MASTER_LABEL" => DuplicateMasterLabel,
+      "DUPLICATE_SENDER_DISPLAY_NAME" => DuplicateSenderDisplayName,
+      "DUPLICATE_USERNAME" => DuplicateUsername,
+      "DUPLICATE_VALUE" => DuplicateValue,
+      "EMAIL_ADDRESS_BOUNCED" => EmailAddressBounced,
+      "EMAIL_NOT_PROCESSED_DUE_TO_PRIOR_ERROR" => EmailNotProcessedDueToPriorError,
+      "EMAIL_OPTED_OUT" => EmailOptedOut,
+      "EMAIL_TEMPLATE_FORMULA_ERROR" => EmailTemplateFormulaError,
+      "EMAIL_TEMPLATE_MERGEFIELD_ACCESS_ERROR" =>
+   EmailTemplateMergefieldAccessError,
+      "EMAIL_TEMPLATE_MERGEFIELD_ERROR" => EmailTemplateMergefieldError,
+      "EMAIL_TEMPLATE_MERGEFIELD_VALUE_ERROR" => EmailTemplateMergefieldValueError,
+      "EMAIL_TEMPLATE_PROCESSING_ERROR" => EmailTemplateProcessingError,
+      "EMPTY_SCONTROL_FILE_NAME" => EmptyScontrolFileName,
+      "ENTITY_FAILED_IFLASTMODIFIED_ON_UPDATE" =>
+   EntityFailedIflastmodifiedOnUpdate,
+      "ENTITY_IS_ARCHIVED" => EntityIsArchived,
+      "ENTITY_IS_DELETED" => EntityIsDeleted,
+      "ENTITY_IS_LOCKED" => EntityIsLocked,
+      "ENVIRONMENT_HUB_MEMBERSHIP_CONFLICT" => EnvironmentHubMembershipConflict,
+      "ERROR_IN_MAILER" => ErrorInMailer,
+      "FAILED_ACTIVATION" => FailedActivation,
+      "FIELD_CUSTOM_VALIDATION_EXCEPTION" => FieldCustomValidationException,
+      "FIELD_FILTER_VALIDATION_EXCEPTION" => FieldFilterValidationException,
+      "FILTERED_LOOKUP_LIMIT_EXCEEDED" => FilteredLookupLimitExceeded,
+      "HTML_FILE_UPLOAD_NOT_ALLOWED" => HtmlFileUploadNotAllowed,
+      "IMAGE_TOO_LARGE" => ImageTooLarge,
+      "INACTIVE_OWNER_OR_USER" => InactiveOwnerOrUser,
+      "INSERT_UPDATE_DELETE_NOT_ALLOWED_DURING_MAINTENANCE" =>
+   InsertUpdateDeleteNotAllowedDuringMaintenance,
+      "INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY" =>
+   InsufficientAccessOnCrossReferenceEntity,
+      "INSUFFICIENT_ACCESS_OR_READONLY" => InsufficientAccessOrReadonly,
+      "INVALID_ACCESS_LEVEL" => InvalidAccessLevel,
+      "INVALID_ARGUMENT_TYPE" => InvalidArgumentType,
+      "INVALID_ASSIGNEE_TYPE" => InvalidAssigneeType,
+      "INVALID_ASSIGNMENT_RULE" => InvalidAssignmentRule,
+      "INVALID_BATCH_OPERATION" => InvalidBatchOperation,
+      "INVALID_CONTENT_TYPE" => InvalidContentType,
+      "INVALID_CREDIT_CARD_INFO" => InvalidCreditCardInfo,
+      "INVALID_CROSS_REFERENCE_KEY" => InvalidCrossReferenceKey,
+      "INVALID_CROSS_REFERENCE_TYPE_FOR_FIELD" => InvalidCrossReferenceTypeForField,
+      "INVALID_CURRENCY_CONV_RATE" => InvalidCurrencyConvRate,
+      "INVALID_CURRENCY_CORP_RATE" => InvalidCurrencyCorpRate,
+      "INVALID_CURRENCY_ISO" => InvalidCurrencyIso,
+      "INVALID_EMAIL_ADDRESS" => InvalidEmailAddress,
+      "INVALID_EMPTY_KEY_OWNER" => InvalidEmptyKeyOwner,
+      "INVALID_EVENT_SUBSCRIPTION" => InvalidEventSubscription,
+      "INVALID_FIELD" => InvalidField,
+      "INVALID_FIELD_FOR_INSERT_UPDATE" => InvalidFieldForInsertUpdate,
+      "INVALID_FIELD_WHEN_USING_TEMPLATE" => InvalidFieldWhenUsingTemplate,
+      "INVALID_FILTER_ACTION" => InvalidFilterAction,
+      "INVALID_ID_FIELD" => InvalidIdField,
+      "INVALID_INET_ADDRESS" => InvalidInetAddress,
+      "INVALID_LINEITEM_CLONE_STATE" => InvalidLineitemCloneState,
+      "INVALID_MASTER_OR_TRANSLATED_SOLUTION" => InvalidMasterOrTranslatedSolution,
+      "INVALID_MESSAGE_ID_REFERENCE" => InvalidMessageIdReference,
+      "INVALID_OPERATION" => InvalidOperation,
+      "INVALID_OPERATOR" => InvalidOperator,
+      "INVALID_OR_NULL_FOR_RESTRICTED_PICKLIST" =>
+   InvalidOrNullForRestrictedPicklist,
+      "INVALID_PARTNER_NETWORK_STATUS" => InvalidPartnerNetworkStatus,
+      "INVALID_PERSON_ACCOUNT_OPERATION" => InvalidPersonAccountOperation,
+      "INVALID_READ_ONLY_USER_DML" => InvalidReadOnlyUserDml,
+      "INVALID_SAVE_AS_ACTIVITY_FLAG" => InvalidSaveAsActivityFlag,
+      "INVALID_SESSION_ID" => InvalidSessionId,
+      "INVALID_STATUS" => InvalidStatus,
+      "INVALID_TYPE" => InvalidType,
+      "INVALID_TYPE_FOR_OPERATION" => InvalidTypeForOperation,
+      "INVALID_TYPE_ON_FIELD_IN_RECORD" => InvalidTypeOnFieldInRecord,
+      "IP_RANGE_LIMIT_EXCEEDED" => IpRangeLimitExceeded,
+      "JIGSAW_IMPORT_LIMIT_EXCEEDED" => JigsawImportLimitExceeded,
+      "LICENSE_LIMIT_EXCEEDED" => LicenseLimitExceeded,
+      "LIGHT_PORTAL_USER_EXCEPTION" => LightPortalUserException,
+      "LIMIT_EXCEEDED" => LimitExceeded,
+      "LOGIN_CHALLENGE_ISSUED" => LoginChallengeIssued,
+      "LOGIN_CHALLENGE_PENDING" => LoginChallengePending,
+      "LOGIN_MUST_USE_SECURITY_TOKEN" => LoginMustUseSecurityToken,
+      "MALFORMED_ID" => MalformedId,
+      "MANAGER_NOT_DEFINED" => ManagerNotDefined,
+      "MASSMAIL_RETRY_LIMIT_EXCEEDED" => MassmailRetryLimitExceeded,
+      "MASS_MAIL_LIMIT_EXCEEDED" => MassMailLimitExceeded,
+      "MAXIMUM_CCEMAILS_EXCEEDED" => MaximumCcemailsExceeded,
+      "MAXIMUM_DASHBOARD_COMPONENTS_EXCEEDED" => MaximumDashboardComponentsExceeded,
+      "MAXIMUM_HIERARCHY_LEVELS_REACHED" => MaximumHierarchyLevelsReached,
+      "MAXIMUM_SIZE_OF_ATTACHMENT" => MaximumSizeOfAttachment,
+      "MAXIMUM_SIZE_OF_DOCUMENT" => MaximumSizeOfDocument,
+      "MAX_ACTIONS_PER_RULE_EXCEEDED" => MaxActionsPerRuleExceeded,
+      "MAX_ACTIVE_RULES_EXCEEDED" => MaxActiveRulesExceeded,
+      "MAX_APPROVAL_STEPS_EXCEEDED" => MaxApprovalStepsExceeded,
+      "MAX_FORMULAS_PER_RULE_EXCEEDED" => MaxFormulasPerRuleExceeded,
+      "MAX_RULES_EXCEEDED" => MaxRulesExceeded,
+      "MAX_RULE_ENTRIES_EXCEEDED" => MaxRuleEntriesExceeded,
+      "MAX_TASK_DESCRIPTION_EXCEEDED" => MaxTaskDescriptionExceeded,
+      "MAX_TM_RULES_EXCEEDED" => MaxTmRulesExceeded,
+      "MAX_TM_RULE_ITEMS_EXCEEDED" => MaxTmRuleItemsExceeded,
+      "MERGE_FAILED" => MergeFailed,
+      "MISSING_ARGUMENT" => MissingArgument,
+      "NONUNIQUE_SHIPPING_ADDRESS" => NonuniqueShippingAddress,
+      "NO_APPLICABLE_PROCESS" => NoApplicableProcess,
+      "NO_ATTACHMENT_PERMISSION" => NoAttachmentPermission,
+      "NO_INACTIVE_DIVISION_MEMBERS" => NoInactiveDivisionMembers,
+      "NO_MASS_MAIL_PERMISSION" => NoMassMailPermission,
+      "NUMBER_OUTSIDE_VALID_RANGE" => NumberOutsideValidRange,
+      "NUM_HISTORY_FIELDS_BY_SOBJECT_EXCEEDED" => NumHistoryFieldsBySobjectExceeded,
+      "OP_WITH_INVALID_USER_TYPE_EXCEPTION" => OpWithInvalidUserTypeException,
+      "OPTED_OUT_OF_MASS_MAIL" => OptedOutOfMassMail,
+      "PACKAGE_LICENSE_REQUIRED" => PackageLicenseRequired,
+      "PLATFORM_EVENT_ENCRYPTION_ERROR" => PlatformEventEncryptionError,
+      "PLATFORM_EVENT_PUBLISHING_UNAVAILABLE" => PlatformEventPublishingUnavailable,
+      "PLATFORM_EVENT_PUBLISH_FAILED" => PlatformEventPublishFailed,
+      "PORTAL_USER_ALREADY_EXISTS_FOR_CONTACT" => PortalUserAlreadyExistsForContact,
+      "PRIVATE_CONTACT_ON_ASSET" => PrivateContactOnAsset,
+      "RECORD_IN_USE_BY_WORKFLOW" => RecordInUseByWorkflow,
+      "REQUEST_RUNNING_TOO_LONG" => RequestRunningTooLong,
+      "REQUIRED_FIELD_MISSING" => RequiredFieldMissing,
+      "SELF_REFERENCE_FROM_TRIGGER" => SelfReferenceFromTrigger,
+      "SHARE_NEEDED_FOR_CHILD_OWNER" => ShareNeededForChildOwner,
+      "SINGLE_EMAIL_LIMIT_EXCEEDED" => SingleEmailLimitExceeded,
+      "STANDARD_PRICE_NOT_DEFINED" => StandardPriceNotDefined,
+      "STORAGE_LIMIT_EXCEEDED" => StorageLimitExceeded,
+      "STRING_TOO_LONG" => StringTooLong,
+      "TABSET_LIMIT_EXCEEDED" => TabsetLimitExceeded,
+      "TEMPLATE_NOT_ACTIVE" => TemplateNotActive,
+      "TERRITORY_REALIGN_IN_PROGRESS" => TerritoryRealignInProgress,
+      "TEXT_DATA_OUTSIDE_SUPPORTED_CHARSET" => TextDataOutsideSupportedCharset,
+      "TOO_MANY_APEX_REQUESTS" => TooManyApexRequests,
+      "TOO_MANY_ENUM_VALUE" => TooManyEnumValue,
+      "TRANSFER_REQUIRES_READ" => TransferRequiresRead,
+      "UNABLE_TO_LOCK_ROW" => UnableToLockRow,
+      "UNAVAILABLE_RECORDTYPE_EXCEPTION" => UnavailableRecordtypeException,
+      "UNDELETE_FAILED" => UndeleteFailed,
+      "UNKNOWN_EXCEPTION" => UnknownException,
+      "UNSPECIFIED_EMAIL_ADDRESS" => UnspecifiedEmailAddress,
+      "UNSUPPORTED_APEX_TRIGGER_OPERATION" => UnsupportedApexTriggerOperation,
+      "UNVERIFIED_SENDER_ADDRESS" => UnverifiedSenderAddress,
+      "WEBLINK_SIZE_LIMIT_EXCEEDED" => WeblinkSizeLimitExceeded,
+      "WEBLINK_URL_INVALID" => WeblinkUrlInvalid,
+      "WRONG_CONTROLLER_TYPE" => WrongControllerType
+    }.freeze
+
+    def self.get_exception_class(error_code)
+      ERROR_EXCEPTION_CLASSES.fetch(error_code) do |_|
+        warn "[restforce] An unrecognised error code, `#{error_code}` has been " \
+        "received from Salesforce. Instead of raising an error-specific exception, " \
+        "we'll raise a generic `ResponseError`. Please report this missing error code" \
+        " on GitHub at <#{GITHUB_ISSUE_URL}>."
+
+        # If we've received an unexpected error where we don't have a specific
+        # class defined, we can return a generic ResponseError instead
+        ResponseError
+      end
+    end
+
+    def self.const_missing(constant_name)
+      warn "[restforce] You're referring to a Restforce error that isn't defined, " \
+      "`#{name}::#{constant_name}` (for example by trying to `rescue` it). This might " \
+      "be our fault - we've recently made some changes to how errors are defined. If " \
+      "you're sure that this is a valid Salesforce error, then please create an " \
+      "issue on GitHub at <#{GITHUB_ISSUE_URL}>."
+
+      super(constant_name)
+    end
+  end
+end