restforce 4.2.1 → 6.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4f7647ad705f0f4eac359a3b1e792ab4603e9ae4d177570e9369734f7ff3356
-  data.tar.gz: 7fc076cb9239ebd513926e068d5d1e4ebec01cbb5245e919fd165ea5bf7b841c
+  metadata.gz: 9aade8a096cdf3f75ed27ec3d2f8393b6c2798875a3eb25fa5d7c3506532f104
+  data.tar.gz: b7d98630ac5c44018f4a30bcd17c14bc6d89c3d50fb27331270e7e94cb64e1a8
 SHA512:
-  metadata.gz: ad1cfc119e9d3a64d5491c667254647a1e79298bebb7c036dee95f87b2a6823f0ed5fbb862dc29c6d25166399042767ecae5520498726fa4025b99b439bcd9f1
-  data.tar.gz: f8e0ab3e2cc1e74e4a1d8d50da2ca8b5bcb13436765993c8737582703248c1c47ca2c6ff02430f19390c02f1b5d95960e6d40e5510ef53e5b25d4e61add35ecc
+  metadata.gz: 4d8e4d1d84a12806a0e913a0ca0e64d481584fc774abeb2f968c95cff2d9e92699a872c8f06fe0f03eca6a838345d1b7dfebed6decacfb6f28f72f26e2cae033
+  data.tar.gz: 04a9c55df3fd6e49491b0a87a5da2b5f1bdd816c5f1256810770c790ec27d8aa264e537fda96b029d8ba11ce1f1872510507004e9d692cf34360da42a7252844

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/.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+- package-ecosystem: bundler
+  directory: "/"
+  schedule:
+    interval: daily
+- package-ecosystem: 'github-actions'
+  directory: '/'
+  schedule:
+    interval: 'daily'

data/.github/funding.yml

@@ -0,0 +1 @@
+github: [restforce]

data/.github/workflows/build.yml

@@ -0,0 +1,23 @@
+name: 'Build'
+on: push
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby_version: ['2.7', '3.0', '3.1', '3.2.0-preview1']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Lint Ruby files
+        run: bundle exec rubocop
+      - name: Run RSpec tests
+        run: bundle exec rspec

data/.github/workflows/faraday.yml

@@ -0,0 +1,27 @@
+name: 'Test against supported Faraday minor versions'
+on: push
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        # Normally, we only test the most recent patch version for any given minor version.
+        # For v2.0.x, we test v2.0.0 and v2.0.1 because v2.0.0 has a special behaviour where
+        # the Net::HTTP adapter is not included. See
+        # https://github.com/lostisland/faraday/blob/main/UPGRADING.md#faraday-20.
+        faraday_version: ['1.1.0', '1.2.0', '1.3.1', '1.4.1', '1.5.1', '1.6.0', '1.7.2', '1.8.0', '1.9.3', '1.10.0', '2.0.0', '2.0.1', '2.1.0', '2.2.0', '2.3.0', '2.4.0']
+    env:
+      FARADAY_VERSION: ~> ${{ matrix.faraday_version }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.1
+      - name: Install dependencies
+        run: bundle install
+      - name: Run RSpec tests
+        run: bundle exec rspec

data/.rubocop.yml

@@ -7,10 +7,11 @@ AllCops:
   Exclude:
     - .*/**/*
     - vendor/**/*
-  TargetRubyVersion: 2.4
+  NewCops: enable
+  TargetRubyVersion: 2.7
 
-# Limit lines to 80 characters.
-Metrics/LineLength:
+# Limit lines to 90 characters.
+Layout/LineLength:
   Max: 90
 
 Metrics/ClassLength:
@@ -70,4 +71,4 @@ Naming/FileName:
     - Guardfile
 
 Lint/UriEscapeUnescape:
-  Enabled: false
+  Enabled: false

data/CHANGELOG.md

@@ -1,3 +1,118 @@
+# 6.0.0 (Sep 9 2022)
+
+__This version contains breaking changes. For help with upgrading, see [`UPGRADING.md`](https://github.com/restforce/restforce/blob/main/UPGRADING.md).__
+
+* __⚠️  Drop support for Ruby 2.6__, since [Ruby 2.6 has reached its end-of-life](https://www.ruby-lang.org/en/downloads/) (@timrogers)
+* __⚠️  Drop compatability with `faraday` versions before `v1.1.0`__ (@timrogers)
+* Add support for `faraday` versions `v2.0.0` onwards (@timrogers)
+
+*This version was also released as [`v6.0.0.rc.1`](https://github.com/restforce/restforce/releases/tag/v6.0.0.rc.1) on Aug 4 2022.*
+
+# 5.3.1 (Jul 19 2022)
+
+* Handle the `EXCEEDED_ID_LIMIT` error returned by the Salesforce API (@timrogers, @yashshah1)
+
+# 5.3.0 (May 30, 2022)
+
+* Add support for Faraday v1.9.x and v1.10.0 (@magni-, @timrogers)
+* Follow redirects during authentication to support Lightning URLs (e.g. `*.lightning.force.com` instead of `*.my.salesforce.com`) (@nhocki)
+
+# 5.2.4 (Mar 16, 2022)
+
+* Fix `Restforce::Collection#size` for Salesforce APIs that use the `size` property to return the total number of results, instead of `totalSize` (@kwong-yw)
+
+# 5.2.3 (Jan 17, 2022)
+
+* Add official support for Ruby 3.1 (@timrogers)
+* Fix handling of responses from the Composite API (@robob27)
+* Fix dependencies to correctly declare that the gem doesn't work with [faraday](https://github.com/lostisland/faraday) `v1.9.0` or later (@timrogers)
+
+# 5.2.2 (Dec 16, 2021)
+
+* Handle the `MALFORMED_SEARCH` error returned by Salesforce (@timrogers)
+
+# 5.2.1 (Dec 8, 2021)
+
+* Handle the `OPERATION_TOO_LARGE` error returned by Salesforce (@timrogers)
+* Handle the `INVALID_SIGNUP_COUNTRY` error returned by Salesforce (@timrogers)
+
+## 5.2.0 (Oct 15, 2021)
+
+* Add support for Salesforce's Composite API and Composite Batch API (@meenie, @amacdougall)
+* Improve the performance of counting numbers of query results with `Restforce::Collection#count`, avoiding unnecessary API requests (@jhass)
+
+## 5.1.1 (Oct 13, 2021)
+
+* Handle the `INVALID_REPLICATION_DATE` error returned by Salesforce (@michaelwnyc)
+* Handle the `BIG_OBJECT_UNSUPPORTED_OPERATION` error returned by Salesforce (@remon)
+
+## 5.1.0 (Aug 26, 2021)
+
+* Add official support for Ruby 3.0 (@timrogers)
+* Drop support for Ruby 2.5, which has reached end-of-life (@timrogers)
+* Handle the `QUERY_TIMEOUT` error returned by Salesforce (@timrogers)
+* Remove unnecessary development dependencies for the gem, which can just be in the project's `Gemfile` (@timrogers)
+
+## 5.0.6 (Jun 17, 2021)
+
+* Handle the `API_DISABLED_FOR_ORG` error returned by Salesforce (@cmac)
+* Handle the `METHOD_NOT_ALLOWED` error returned by Salesforce (@timrogers)
+* Handle the `APEX_ERROR` error returned by Salesforce (@timrogers)
+
+## 5.0.5 (Feb 17, 2021)
+
+* Handle the `CANNOT_EXECUTE_FLOW_TRIGGER` error returned by Salesforce (@almusavi, @timrogers)
+
+## 5.0.4 (Jan 18, 2021)
+
+* Handle the `INVALID_QUERY_LOCATOR` error returned by Salesforce
+* Handle the `INVALID_OPERATION_WITH_EXPIRED_PASSWORD` error returned by Salesforce
+* Handle the `FIELD_INTEGRITY_EXCEPTION` error returned by Salesforce
+* Handle the `FORBIDDEN` error returned by Salesforce
+* Handle the `ILLEGAL_QUERY_PARAMETER_VALUE` error returned by Salesforce
+* Handle the `JSON_PARSER_ERROR` error returned by Salesforce
+
+## 5.0.3 (Sep 8, 2020)
+
+* Handle the undocumented `EXCEEDED_MAX_SEMIJOIN_SUBSELECTS` error returned by Salesforce (@embertel, @timrogers)
+
+## 5.0.2 (Sep 6, 2020)
+
+* Handle the undocumented `REQUEST_LIMIT_EXCEEDED` error returned by Salesforce (@wkirkby, @timrogers)
+* Handle the undocumented `SERVER_UNAVAILABLE` error returned by Salesforce (@wkirkby, @timrogers)
+* Refactor the library to be compatible with Rubocop 0.90's cops (this shouldn't introduce any noticeable changes see #569 for detailed changes) (@timrogers)
+
+## 5.0.1 (Aug 13, 2020)
+
+* Handle the undocumented `API_CURRENTLY_DISABLED` error returned by Salesforce (@ruipserra, @timrogers)
+* Handle the undocumented `MALFORMED_QUERY` error returned by Salesforce (@scottserok, @timrogers)
+* Handle the undocumented `INVALID_QUERY_FILTER_OPERATOR` error returned by Salesforce (@Dantemss, @timrogers)
+* Add documentation and scripts for running the
+library's tests using Docker (@ryansch)
+
+## 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)

data/CONTRIBUTING.md

@@ -34,4 +34,24 @@ 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).*
+
+## Docker
+
+If you'd rather use a docker container to run the tests, you can use the following instructions.
+
+To set up the container image:
+
+`docker-compose build --pull`
+
+To run specs:
+
+`docker-compose run --rm restforce rspec`
+
+To run rubocop:
+
+`docker-compose run --rm restforce rubocop`
+
+To reset the bundler cache:
+
+`docker-compose down -v`

data/Dockerfile

@@ -0,0 +1,31 @@
+FROM ruby:2.6.5-alpine
+
+RUN apk add --no-cache \
+  ca-certificates \
+  wget \
+  openssl \ 
+  bash \
+  build-base \
+  git \
+  sqlite-dev \
+  tzdata \
+  tini
+
+ENV LANG en_US.UTF-8
+ENV LANGUAGE en_US:en
+ENV LC_ALL en_US.UTF-8
+
+ENV BUNDLER_VERSION 2.1.4
+RUN gem install bundler -v ${BUNDLER_VERSION} -i /usr/local/lib/ruby/gems/$(ls /usr/local/lib/ruby/gems) --force
+
+WORKDIR /srv
+
+COPY Gemfile restforce.gemspec /srv/
+COPY lib/restforce/version.rb /srv/lib/restforce/version.rb
+
+RUN bundle install
+
+COPY . /srv/
+
+ENTRYPOINT ["/sbin/tini", "-g", "--", "bundle", "exec"]
+CMD ["rspec"]

data/Gemfile

@@ -3,12 +3,20 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'faraday', '~> 0.17.0'
+faraday_version = ENV.fetch('FARADAY_VERSION', '~> 1.8.0')
+
+# Enable us to explicitly pick a Faraday version when running tests
+gem 'faraday', faraday_version
+gem 'faraday-typhoeus', '~> 0.2.1' unless faraday_version.start_with?("~> 1")
+gem 'faye' unless RUBY_PLATFORM == 'java'
+gem 'guard-rspec'
+gem 'guard-rubocop'
 gem 'jruby-openssl', platforms: :jruby
-gem 'jwt'
 gem 'rake'
-
-group :development do
-  gem 'guard-rspec'
-  gem 'guard-rubocop'
-end
+gem 'rspec', '~> 3.11.0'
+gem 'rspec-collection_matchers', '~> 1.2.0'
+gem 'rspec-its', '~> 1.3.0'
+gem 'rspec_junit_formatter', '~> 0.5.1'
+gem 'rubocop', '~> 1.36.0'
+gem 'simplecov', '~> 0.21.2'
+gem 'webmock', '~> 3.18.1'

data/README.md

@@ -1,17 +1,19 @@
 # Restforce
 
-[![CircleCI](https://circleci.com/gh/restforce/restforce.svg?style=svg)](https://circleci.com/gh/restforce/restforce) [![Code Climate](https://codeclimate.com/github/restforce/restforce.png)](https://codeclimate.com/github/restforce/restforce) [![Dependency Status](https://gemnasium.com/restforce/restforce.png)](https://gemnasium.com/restforce/restforce)
-![](https://img.shields.io/gem/dt/restforce.svg)
+[![CircleCI](https://circleci.com/gh/restforce/restforce.svg?style=svg)](https://circleci.com/gh/restforce/restforce)
+![Downloads](https://img.shields.io/gem/dt/restforce.svg)
 
 Restforce is a ruby gem for the [Salesforce REST api](http://www.salesforce.com/us/developer/docs/api_rest/index.htm).
 
 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)
+* Support for the [Composite API](#composite-api)
+* Support for the [Composite Batch API](#composite-batch-api)
 * Support for the GetUpdated API
 * Support for blob data types.
 * Support for GZIP compression.
@@ -19,13 +21,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.2.0'
+    gem 'restforce', '~> 6.0.0'
 
 And then execute:
 
@@ -35,7 +37,14 @@ 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 6.0.0, this gem is only compatible with Ruby 2.7.0 and later.__ If you're using an earlier Ruby version:
+
+* for Ruby 2.6, use version 5.3.1 or earlier
+* for Ruby 2.5, use version 5.0.6 or earlier
+* for Ruby 2.4, use version 4.3.0 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 +57,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 +87,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 +151,19 @@ export SALESFORCE_API_VERSION="41.0"
 client = Restforce.new
 ```
 
-### Proxy Support
+**Note:** Restforce library does not cache JWT Bearer tokens automatically. This means that every instantiation of the Restforce class will be treated as a new login by Salesforce. Remember that Salesforce enforces [rate limits on login requests](https://help.salesforce.com/s/articleView?id=000312767&type=1). If you are building an application that will instantiate the Restforce class more than this specified rate limit, you might want to consider caching the Bearer token either in-memory or in your own storage by leveraging the `authentication_callback` method. 
+
+#### 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 +179,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:
@@ -183,7 +194,7 @@ end
 
 By default, the gem defaults to using Version 26.0 (Winter '13) of the Salesforce API. This maintains backwards compatibility for existing users.
 
-__We strongly suggest configuring Restforce to use the most recent API version, currently Version 41.0 (Winter '18) to get the best Salesforce API experience__ - for example, some more recently-added API endpoints will not be available without moving to a more recent
+__We strongly suggest configuring Restforce to use the [most recent API version](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_versions.htm), to get the best Salesforce API experience__ - for example, some more recently-added API endpoints will not be available without moving to a more recent
 version. If you're trying to use a method that is unavailable with your API version,
 Restforce will raise an `APIVersionError`.
 
@@ -285,6 +296,8 @@ client.find('Account', '1234', 'Some_External_Id_Field__c')
 # => #<Restforce::SObject Id="001D000000INjVe" Name="Test" LastModifiedBy="005G0000002f8FHIAY" ... >
 ```
 
+`find` raises an error if nothing is found.
+
 ### select
 
 `select` allows the fetching of a specific list of fields from a single object.  It requires an `external_id` lookup, but is often much faster than an arbitrary query.
@@ -328,8 +341,11 @@ client.update('Account', Id: '0016000000MRatd', Name: 'Whizbang Corp')
 ```ruby
 # Update the record with external `External__c` external ID set to '12'
 client.upsert('Account', 'External__c', External__c: 12, Name: 'Foobar')
+# => true or "RecordId"
 ```
 
+The upsert method will return the record Id if included in the response body from the Salesforce API; otherwise, it returns true. Currently the Salesforce API only returns the Id for newly created records.
+
 ### destroy
 
 ```ruby
@@ -451,13 +467,13 @@ info.user_id
 
 ### File Uploads
 
-Using the new [Blob Data](http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_insert_update_blob.htm) api feature (500mb limit):
+Using the new [Blob Data](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_sobject_insert_update_blob.htm) api feature (500mb limit):
 
 ```ruby
 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):
@@ -469,7 +485,7 @@ client.create('Document', FolderId: '00lE0000000FJ6H',
                           Body: Base64::encode64(File.read('image.jpg'))
 ```
 
-_See also: [Inserting or updating blob data](http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_insert_update_blob.htm)_
+_See also: [Inserting or updating blob data](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/dome_sobject_insert_update_blob.htm)_
 
 * * *
 
@@ -564,6 +580,52 @@ end
 Boom, you're now receiving push notifications when Accounts are
 created/updated.
 
+#### Composite API
+
+Restforce supports the [Composite API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_composite.htm).
+This feature permits the user to send a composite object—that is, a complex
+object with nested children—in a single API call. Up to 25 requests may be
+included in a single composite.
+
+Note that `GET` is not yet implemented for this API.
+
+```ruby
+# build up an array of requests:
+requests << {
+  method: :update,
+  sobject: sobject, # e.g. "Contact"
+  reference_id: reference_id,
+  data: data
+}
+
+# send every 25 requests as a subrequest in a single composite call
+requests.each_slice(25).map do |req_slice|
+  client.composite do |subrequest|
+    req_slice.each do |r|
+      subrequest.send *r.values
+    end
+  end
+end
+
+# note that we're using `map` to return an array of each responses to each
+# composite call; 100 requests will produce 4 responses
+```
+
+#### Composite Batch API
+
+Restforce supports the [Composite Batch API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_composite_batch.htm).
+This feature permits up to 25 subrequests in a single request, though each
+subrequest counts against the API limit. On the other hand, it has fewer
+limitations than the Composite API.
+
+```
+client.batch do |subrequests|
+  subrequests.create('Object', name: 'test')
+  subrequests.update('Object', id: '123', name: 'test')
+  subrequests.destroy('Object', '123')
+end
+```
+
 #### Replaying Events
 
 Since API version 37.0, Salesforce stores events for 24 hours and they can be
@@ -688,7 +750,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,67 @@
+# Upgrading from Restforce 5.x to 6.x
+
+__There are two breaking changes introduced in Restforce 6.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.
+
+## Versions of `faraday` before `v1.1.0` are no longer supported
+
+__Likelyhood of impact__: Moderate
+
+Restforce uses a gem called [`faraday`](https://github.com/lostisland/faraday) to make HTTP requests to Salesforce. 
+
+Up until now, Restforce has supported Faraday versions between v0.9.0 and v1.10.0. 
+
+In Restforce 6.x, we drop support for Faraday versions before v1.1.0, and add support for Faraday v2.x.
+
+This will allow you to use the latest versions of Faraday and benefit from security patches, new features, etc., but you may need to adapt your code. The impact of this change will depend on your project:
+
+* If Restforce is the only part of your project using Faraday - that is, your own code doesn't use Faraday and none of your other gems use Faraday - then you shouldn't need to do anything special. Just upgrade Restforce, and everything should be handled automatically.
+* If your own code uses Faraday or another gem you use depends on Faraday, and you're currently using a Faraday version before v1.1.0, you will need to upgrade your Faraday version. If possible, you should upgrade to the latest version (v2.4.0 at the time of writing). This may require you to adapt your code (see [here](https://github.com/lostisland/faraday/blob/main/UPGRADING.md) for Faraday's instructions) or upgrade other gems you depend on.
+
+## Ruby 2.6 is no longer supported
+
+__Likelyhood of impact__: Moderate
+
+Ruby 2.6 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.6 and earlier in the Restforce library. The gemspec now specifies that only 2.7 onwards is supported, and this will be enforced by RubyGems.
+
+Before you update to Restforce 6.x, you'll need to switch to Ruby 2.7 or later. The current version of Ruby at the time of wriing is 3.1.
+
+# 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/docker-compose.yml

@@ -0,0 +1,7 @@
+version: "3.6"
+services:
+  restforce:
+    build: .
+    image: restforce:dev
+    volumes:
+      - .:/srv

data/lib/restforce/abstract_client.rb

@@ -8,5 +8,6 @@ module Restforce
     include Restforce::Concerns::Caching
     include Restforce::Concerns::API
     include Restforce::Concerns::BatchAPI
+    include Restforce::Concerns::CompositeAPI
   end
 end