restforce 6.0.0 → 8.0.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9aade8a096cdf3f75ed27ec3d2f8393b6c2798875a3eb25fa5d7c3506532f104
-  data.tar.gz: b7d98630ac5c44018f4a30bcd17c14bc6d89c3d50fb27331270e7e94cb64e1a8
+  metadata.gz: d15210bc91589b14b39393257c157630f0e97a48f645182f859b111ff217c1ce
+  data.tar.gz: 6e53ae6ada7fcb4743e5e9ee5b42728007d878612bf7487a02510755786d6355
 SHA512:
-  metadata.gz: 4d8e4d1d84a12806a0e913a0ca0e64d481584fc774abeb2f968c95cff2d9e92699a872c8f06fe0f03eca6a838345d1b7dfebed6decacfb6f28f72f26e2cae033
-  data.tar.gz: 04a9c55df3fd6e49491b0a87a5da2b5f1bdd816c5f1256810770c790ec27d8aa264e537fda96b029d8ba11ce1f1872510507004e9d692cf34360da42a7252844
+  metadata.gz: c8eb88e8e6eb093808deaa1aa6def7c59d9e883069d3835a315b492903cab8b6a3f85bd14a3b0a27ee43376075bfa49ed5af97cf11149748f7e7f2947a29b54d
+  data.tar.gz: f74e373ce9c0c206541f1555fa822ae0b2ade70a05fdec3eb5d3f7cee2ffeb0da8876a33b20e2e7350af34cb97b6335c0eaa64bf5b207d905113aebd5b9095f7

data/.github/workflows/build.yml

@@ -6,10 +6,10 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby_version: ['2.7', '3.0', '3.1', '3.2.0-preview1']
+        ruby_version: ["3.1", "3.2", "3.3", "3.4", "4.0"]
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Ruby ${{ matrix.ruby_version }}
         uses: ruby/setup-ruby@v1
         with:
@@ -20,4 +20,4 @@ jobs:
       - name: Lint Ruby files
         run: bundle exec rubocop
       - name: Run RSpec tests
-        run: bundle exec rspec
+        run: bundle exec rspec

data/.github/workflows/faraday.yml

@@ -10,12 +10,40 @@ jobs:
         # 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']
+        faraday_version:
+          [
+            "1.1.0",
+            "1.2.0",
+            "1.3.1",
+            "1.4.3",
+            "1.5.1",
+            "1.6.0",
+            "1.7.2",
+            "1.8.0",
+            "1.9.3",
+            "1.10.3",
+            "2.0.0",
+            "2.0.1",
+            "2.1.0",
+            "2.2.0",
+            "2.3.0",
+            "2.4.0",
+            "2.5.2",
+            "2.6.0",
+            "2.7.12",
+            "2.8.1",
+            "2.9.2",
+            "2.10.1",
+            "2.11.0",
+            "2.12.3",
+            "2.13.4",
+            "2.14.0"
+          ]
     env:
       FARADAY_VERSION: ~> ${{ matrix.faraday_version }}
     steps:
       - name: Checkout code
-        uses: actions/checkout@v3
+        uses: actions/checkout@v4
       - name: Setup Ruby ${{ matrix.ruby_version }}
         uses: ruby/setup-ruby@v1
         with:
@@ -24,4 +52,4 @@ jobs:
       - name: Install dependencies
         run: bundle install
       - name: Run RSpec tests
-        run: bundle exec rspec
+        run: bundle exec rspec

data/.gitignore

@@ -19,3 +19,7 @@ tmp
 .rspec
 .ruby-version
 *.swp
+.idea
+Vagrantfile
+.vagrant/
+vendor/

data/.rubocop.yml

@@ -8,7 +8,7 @@ AllCops:
     - .*/**/*
     - vendor/**/*
   NewCops: enable
-  TargetRubyVersion: 2.7
+  TargetRubyVersion: 3.1
 
 # Limit lines to 90 characters.
 Layout/LineLength:

data/CHANGELOG.md

@@ -1,3 +1,77 @@
+## 8.0.1 (December 29, 2025)
+
+* Allow `faraday-follow_redirects` v0.4.x and v0.5.x to unlock Ruby 4.0 compatibility
+
+## 8.0.0 (December 18, 2024)
+
+**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 3.0**, since Ruby 3.0 has reached its end-of-life (@timrogers)
+
+## 7.6.0 (December 18, 2024)
+
+- **Allow all `faraday` versions up to, but not including, v3.0.0**: For more details, see https://github.com/restforce/restforce/pull/915 (@timrogers)
+
+## 7.5.0 (September 4, 2024)
+
+- Add support for `faraday` v2.11.x (@timrogers)
+
+## 7.4.0 (July 10, 2024)
+
+- Add support for `faraday` v2.10.x (@ryan-mcneil)
+
+# 7.3.1 (Mar 30, 2024)
+
+- Fix `uninitialized constant StringIO` error by explicitly requiring `StringIO` where it's used (@timrogers)
+
+# 7.3.0 (Feb 14, 2024 🧡)
+
+- Add support for making `GET` requests using the Composite API (@shravan097)
+
+# 7.2.0 (Jan 23, 2024)
+
+- Add support for `faraday` v2.9.x (@timrogers)
+
+# 7.1.1 (Jan 23, 2024)
+
+- Handle the `APEX_REST_SERVICES_DISABLED` error returned by the Salesforce API (@timrogers)
+
+# 7.1.0 (Dec 20, 2023)
+
+- Add support for the [OAuth 2.0 Client Credentials authentication flow](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_client_credentials_flow.htm&type=5) (@rh-taro)
+- Add support for `faraday` v2.8.x (@timrogers)
+
+# 7.0.0 (Oct 6, 2023)
+
+__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.7__, since [Ruby 2.7 has reached its end-of-life](https://www.ruby-lang.org/en/downloads/) (@timrogers)
+
+# 6.2.4 (Oct 6, 2023)
+
+* Register the custom JSON middleware for Faraday with a more unique name to avoid clashes with other middleware (@dbackeus)
+
+# 6.2.3 (Jun 18 2023)
+
+* Handle the `CANNOT_DELETE_OWNER`, `CANNOT_POST_TO_ARCHIVED_GROUP`, `INVALID_INPUT`, `INVALID_MARKUP` and `INVALID_SEARCH` errors returned by the Salesforce API (@spurton)
+
+# 6.2.2 (Mar 24 2023)
+
+* Handle the `INSUFFICIENT_ACCESS` error returned by the Salesforce API (@timrogers, @nstuart-at-salesforce)
+
+# 6.2.1 (Jan 18 2023)
+
+* When a response claims to be gzipped but isn't, return the body as it is and don't explode (@timrogers)
+
+# 6.2.0 (Jan 18 2023)
+
+* Add support for `faraday` v2.7.x (@timrogers)
+* Expose the Faraday `Response` on` `CompositeAPIError`s (@shravan097)
+
+# 6.1.0 (Nov 18 2022)
+
+* Add support for `faraday` v2.5.x and v2.6.x (@marcrohloff, @timrogers)
+
 # 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).__

data/Gemfile

@@ -3,20 +3,20 @@
 source 'https://rubygems.org'
 gemspec
 
-faraday_version = ENV.fetch('FARADAY_VERSION', '~> 1.8.0')
+faraday_version = ENV.fetch('FARADAY_VERSION', '~> 2.12.2')
 
 # 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 'faraday-typhoeus', '~> 1.1.0' unless faraday_version.start_with?("~> 1")
 gem 'faye' unless RUBY_PLATFORM == 'java'
 gem 'guard-rspec'
 gem 'guard-rubocop'
 gem 'jruby-openssl', platforms: :jruby
 gem 'rake'
-gem 'rspec', '~> 3.11.0'
+gem 'rspec', '~> 3.13.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'
+gem 'rspec-its', '~> 2.0.0'
+gem 'rspec_junit_formatter', '~> 0.6.0'
+gem 'rubocop', '~> 1.70.0'
+gem 'simplecov', '~> 0.22.0'
+gem 'webmock', '~> 3.24.0'

data/README.md

@@ -3,7 +3,7 @@
 [![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).
+Restforce is a ruby gem for the [Salesforce REST API](http://www.salesforce.com/us/developer/docs/api_rest/index.htm).
 
 Features include:
 
@@ -27,7 +27,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 6.0.0'
+    gem 'restforce', '~> 8.0.1'
 
 And then execute:
 
@@ -37,14 +37,16 @@ Or install it yourself as:
 
     $ gem install restforce
 
-__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:
+**As of version 8.0.0, this gem is only compatible with Ruby 3.1.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
+- for Ruby 3.0, use version 7.6.0 or earlier
+- for Ruby 2.7, use version 6.2.4 or earlier
+- 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.
 
@@ -58,7 +60,7 @@ so you can do things like `client.query('select Id, (select Name from Children__
 
 Which authentication method you use really depends on your use case. If you're
 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,
+through OAuth and you need to interact with data in their org on their behalf,
 you should use the OAuth token authentication method.
 
 If you're using the gem to interact with a single org (maybe you're building some
@@ -112,12 +114,13 @@ The `id` field can be used to [uniquely identify](https://developer.salesforce.c
 If you prefer to use a username and password to authenticate:
 
 ```ruby
-client = Restforce.new(username: 'foo',
-                       password: 'bar',
-                       security_token: 'security token',
-                       client_id: 'client_id',
-                       client_secret: 'client_secret',
-                       api_version: '41.0')
+client = Restforce.new(username: config['username'],
+                       password: config['password'],
+                       instance_url: config['instance_url'],
+                       host: config['host'],                   # test.salesforce.com for sandbox (optional)
+                       client_id: config['client_key'],        # Salesforce Client Key
+                       client_secret: config['client_secret'], # Salesforce Client Secret
+                       api_version: '55.0')
 ```
 
 #### JWT Bearer Token
@@ -153,6 +156,17 @@ client = Restforce.new
 
 **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. 
 
+#### Client Credentials
+
+If you want to authenticate as an application, you can use the [Client Credentials flow](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_client_credentials_flow.htm&type=5):
+
+```ruby
+client = Restforce.new(client_id: 'client_id',
+                       client_secret: 'client_secret',
+                       api_version: '55.0',
+                       host: 'MYDOMAIN.my.salesforce.com')
+```
+
 #### Sandbox Organizations
 
 You can connect to sandbox organizations by specifying a host. The default host is
@@ -316,7 +330,7 @@ client.search('FIND {bar}')
 # => #<Restforce::Collection >
 
 # Find accounts matching the term 'genepoint' and return the `Name` field
-client.search('FIND {genepoint} RETURNING Account (Name)').map(&:Name)
+client.search('FIND {genepoint} RETURNING Account (Name)')["searchRecords"].map(&:Name)
 # => ['GenePoint']
 ```
 
@@ -587,7 +601,6 @@ 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:
@@ -830,12 +843,17 @@ client.create!("CustomField", {
 })
 ```
 
-## Links
+## Configuration Precedence
+
+Here's the order of precedence from highest to lowest:
+
+Arguments on new: passing configuration options directly as arguments has the highest precedence. These settings will override any other configuration.
+
+Configuration block: using Restforce.configure to set configuration options is the next in line. They will take precedence over environment variables and defaults but will be overridden by direct arguments on instantiation.
+
+Environment variables: has the lowest precedence. If you set options using environment variables, they will be overridden by any other configuration method.
 
-If you need a full Active Record experience, may be you can use
-[ActiveForce](https://github.com/ionia-corporation/active_force) that wraps
-Restforce and adds Associations, Query Building (like AREL), Validations and
-Callbacks.
+Defaults: If none of the above methods are used, Restforce falls back to its default configuration values.
 
 ## Contributing
 

data/UPGRADING.md

@@ -1,3 +1,27 @@
+# Upgrading from Restforce 7.x to 8.x
+
+## Ruby 3.0 is no longer supported
+
+**Likelyhood of impact**: Moderate
+
+Ruby 3.0 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 3.0 in the Restforce library. The gemspec now specifies that only 3.1 onwards is supported, and this will be enforced by RubyGems.
+
+Before you update to Restforce 8.x, you'll need to switch to Ruby 3.1.0 or later. The current version of Ruby at the time of writing is 3.3.6.
+
+# Upgrading from Restforce 6.x to 7.x
+
+## Ruby 2.7 is no longer supported
+
+__Likelyhood of impact__: Moderate
+
+Ruby 2.7 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.7 in the Restforce library. The gemspec now specifies that only 3.0 onwards is supported, and this will be enforced by RubyGems.
+
+Before you update to Restforce 7.x, you'll need to switch to Ruby 3.0.0 or later. The current version of Ruby at the time of writing is 3.2.2.
+
 # 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.

data/lib/restforce/collection.rb

@@ -12,12 +12,12 @@ module Restforce
     end
 
     # Yield each value on each page.
-    def each(&block)
+    def each(&)
       @raw_page['records'].each { |record| yield Restforce::Mash.build(record, @client) }
 
       np = next_page
       while np
-        np.current_page.each(&block)
+        np.current_page.each(&)
         np = np.next_page
       end
     end

data/lib/restforce/concerns/authentication.rb

@@ -21,6 +21,8 @@ module Restforce
           Restforce::Middleware::Authentication::Token
         elsif jwt?
           Restforce::Middleware::Authentication::JWTBearer
+        elsif client_credential?
+          Restforce::Middleware::Authentication::ClientCredential
         end
       end
 
@@ -48,6 +50,12 @@ module Restforce
           options[:username] &&
           options[:client_id]
       end
+
+      # Internal: Returns true if client credential flow should be used for
+      # authentication.
+      def client_credential?
+        options[:client_id] && options[:client_secret]
+      end
     end
   end
 end

data/lib/restforce/concerns/base.rb

@@ -57,6 +57,11 @@ module Restforce
       #
       #        :request_headers         - A hash containing custom headers that will be
       #                                   appended to each request
+      #
+      #     :clear_authorization_header - A boolean that when set to true will cause
+      #                                   the Faraday::FollowRedirects middleware to
+      #                                   omit the auth header when following
+      #                                   redirects (default: false)
 
       def initialize(opts = {})
         raise ArgumentError, 'Please specify a hash of options' unless opts.is_a?(Hash)

data/lib/restforce/concerns/batch_api.rb

@@ -29,8 +29,8 @@ module Restforce
         end.flatten
       end
 
-      def batch!(&block)
-        batch(halt_on_error: true, &block)
+      def batch!(&)
+        batch(halt_on_error: true, &)
       end
 
       class Subrequests

data/lib/restforce/concerns/composite_api.rb

@@ -29,7 +29,7 @@ module Restforce
         if all_or_none && has_errors
           last_error_index = results.rindex { |result| result['httpStatusCode'] != 412 }
           last_error = results[last_error_index]
-          raise CompositeAPIError, last_error['body'][0]['errorCode']
+          raise CompositeAPIError.new(last_error['body'][0]['errorCode'], response)
         end
 
         results
@@ -93,6 +93,14 @@ module Restforce
           }
         end
 
+        def find(sobject, reference_id, id)
+          requests << {
+            method: 'GET',
+            url: composite_api_path("#{sobject}/#{id}"),
+            referenceId: reference_id
+          }
+        end
+
         private
 
         def composite_api_path(path)

data/lib/restforce/concerns/connection.rb

@@ -20,6 +20,8 @@ module Restforce
       private
 
       # Internal: Internal faraday connection where all requests go through
+      # rubocop:disable Metrics/AbcSize
+      # rubocop:disable Metrics/BlockLength
       def connection
         @connection ||= Faraday.new(options[:instance_url],
                                     connection_options) do |builder|
@@ -31,7 +33,7 @@ module Restforce
           # Handles multipart file uploads for blobs.
           builder.use Restforce::Middleware::Multipart
           # Converts the request into JSON.
-          builder.request :json
+          builder.request :restforce_json
           # Handles reauthentication for 403 responses.
           if authentication_middleware
             builder.use authentication_middleware, self, options
@@ -43,11 +45,14 @@ module Restforce
           # Caches GET requests.
           builder.use Restforce::Middleware::Caching, cache, options if cache
           # Follows 30x redirects.
-          builder.use Faraday::FollowRedirects::Middleware
+          builder.use Faraday::FollowRedirects::Middleware, {
+            # Pass the option to clear or send the auth header on redirects through
+            clear_authorization_header: options[:clear_authorization_header]
+          }
           # Raises errors for 40x responses.
           builder.use Restforce::Middleware::RaiseError
           # Parses returned JSON response into a hash.
-          builder.response :json, content_type: /\bjson$/
+          builder.response :restforce_json, content_type: /\bjson$/
           # Compress/Decompress the request/response
           unless adapter == :httpclient
             builder.use Restforce::Middleware::Gzip, self, options
@@ -64,6 +69,8 @@ module Restforce
           builder.adapter adapter
         end
       end
+      # rubocop:enable Metrics/BlockLength
+      # rubocop:enable Metrics/AbcSize
 
       def adapter
         options[:adapter]

data/lib/restforce/concerns/picklists.rb

@@ -85,7 +85,7 @@ module Restforce
         def valid?(picklist_entry)
           valid_for = picklist_entry['validFor'].ljust(16, 'A').unpack1('m').
                       unpack('C*')
-          (valid_for[index >> 3] & (0x80 >> (index % 8))).positive?
+          valid_for[index >> 3].anybits?((0x80 >> (index % 8)))
         end
       end
     end

data/lib/restforce/concerns/streaming.rb

@@ -9,9 +9,9 @@ module Restforce
       # block    - A block to run when a new message is received.
       #
       # Returns a Faye::Subscription
-      def legacy_subscribe(topics, options = {}, &block)
+      def legacy_subscribe(topics, options = {}, &)
         topics = Array(topics).map { |channel| "/topic/#{channel}" }
-        subscription(topics, options, &block)
+        subscription(topics, options, &)
       end
       alias subscribe legacy_subscribe
 
@@ -21,12 +21,12 @@ module Restforce
       # block    - A block to run when a new message is received.
       #
       # Returns a Faye::Subscription
-      def subscription(channels, options = {}, &block)
+      def subscription(channels, options = {}, &)
         one_or_more_channels = Array(channels)
         one_or_more_channels.each do |channel|
           replay_handlers[channel] = options[:replay]
         end
-        faye.subscribe(one_or_more_channels, &block)
+        faye.subscribe(one_or_more_channels, &)
       end
 
       # Public: Faye client to use for subscribing to PushTopics

data/lib/restforce/config.rb

@@ -113,8 +113,8 @@ module Restforce
     # The private key for JWT authentication
     option :jwt_key
 
-    # Set this to true if you're authenticating with a Sandbox instance.
-    # Defaults to false.
+    # The login host.
+    # Defaults to login.salesforce.com.
     option :host, default: lambda { ENV.fetch('SALESFORCE_HOST', 'login.salesforce.com') }
 
     option :oauth_token
@@ -161,6 +161,10 @@ module Restforce
     # Set use_cache to false to opt in to caching with client.with_caching
     option :use_cache, default: true
 
+    # Set to true to have Faraday::FollowRedirects middleware omit the auth header
+    # when following redirects
+    option :clear_authorization_header, default: false
+
     def options
       self.class.options
     end