restforce 5.3.1 → 6.0.0.rc.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7156aa3b1821199121b06cbf84b2c00039efeddc17cc58cbe1d8454bddbf1eb7
-  data.tar.gz: 8cfbd9d725041f02fa8abd45cc08254a38e563dce206747f0c778bd6c91c3306
+  metadata.gz: 06ba6ff782797da12181fade1eb6d25cec0da4395a0880080d684a6c8d0c928e
+  data.tar.gz: 17854adb01066aa6d09c784adeecee764b530afff0083297162c0d2633fac38f
 SHA512:
-  metadata.gz: 5cf147d56213c10144b4e7819f6e5a62961a84c134b66f7b506d4f76bb8aad4563c7d69b39702e06b468441c35dafac4c8e1d74a65c3c76e7c47cab76ef58080
-  data.tar.gz: 1351ded2015aca8bd6c8f89ab8c28c684c125b7aa2fd0c077660072064e96b4a1d917d401c9df1cd99873d12780866ba9811d23e228d185e8b6dc426c14c6aaa
+  metadata.gz: 8cb18b0f488c6e793b2c1a64e54e982f08b1739522ae3bb3a5f7dd8837ffe62c05506365731f9040b25dd396b7ad5f3aff143dd9476fd0f2be475bf23623547f
+  data.tar.gz: 7445f7337587cc19c61743abe80dad16c3d1b2c10527691d6e33edb65a023dcd4afb32db9a569405c43a7878c3cba32fb2426dd50264d7b56cfc95e5bdb2d203

data/.github/workflows/build.yml

@@ -1,15 +1,12 @@
 name: 'Build'
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+on: push
 jobs:
   lint-and-test:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        ruby_version: ['2.6', '2.7', '3.0', '3.1', '3.2.0-preview1']
+        ruby_version: ['2.7', '3.0', '3.1', '3.2.0-preview1']
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

data/.github/workflows/faraday.yml

@@ -1,15 +1,16 @@
 name: 'Test against supported Faraday minor versions'
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+on: push
 jobs:
   lint-and-test:
     runs-on: ubuntu-latest
     strategy:
+      fail-fast: false
       matrix:
-        faraday_version: ['1.0.1', '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']
+        # 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:

data/.rubocop.yml

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

data/CHANGELOG.md

@@ -1,3 +1,13 @@
+# 6.0.0.rc.1 (Aug 4 2022)
+
+*This version is a release candidate. Once we have gathered feedback from users and are confident that it works as expected, we will release a final `v6.0.0` version.*
+
+__This version contains breaking changes. For help with upgrading, see [`UPGRADING.md`](https://github.com/restforce/restforce/blob/v6.0.0.rc.1/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)
+
 # 5.3.1 (Jul 19 2022)
 
 * Handle the `EXCEEDED_ID_LIMIT` error returned by the Salesforce API (@timrogers, @yashshah1)

data/Gemfile

@@ -3,8 +3,10 @@
 source 'https://rubygems.org'
 gemspec
 
+faraday_version = ENV.fetch('FARADAY_VERSION', '~> 1.8.0')
+
 # Enable us to explicitly pick a Faraday version when running tests
-gem 'faraday', ENV.fetch('FARADAY_VERSION', '~> 1.8.0')
+gem 'faraday', faraday_version
 gem 'faye' unless RUBY_PLATFORM == 'java'
 gem 'guard-rspec'
 gem 'guard-rubocop'
@@ -14,6 +16,8 @@ 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.31.2'
+gem 'rubocop', '~> 1.32.0'
 gem 'simplecov', '~> 0.21.2'
-gem 'webmock', '~> 3.14.0'
+gem 'webmock', '~> 3.16.0'
+
+gem 'faraday-typhoeus', '~> 0.2.1' unless faraday_version.start_with?("~> 1")

data/UPGRADING.md

@@ -1,3 +1,32 @@
+# 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.

data/lib/restforce/concerns/connection.rb

@@ -43,7 +43,7 @@ module Restforce
           # Caches GET requests.
           builder.use Restforce::Middleware::Caching, cache, options if cache
           # Follows 30x redirects.
-          builder.use FaradayMiddleware::FollowRedirects
+          builder.use Faraday::FollowRedirects::Middleware
           # Raises errors for 40x responses.
           builder.use Restforce::Middleware::RaiseError
           # Parses returned JSON response into a hash.

data/lib/restforce/file_part.rb

@@ -1,14 +1,12 @@
 # frozen_string_literal: true
 
 case Faraday::VERSION
-when /\A0\./
-  require 'faraday/upload_io'
 when /\A1\.[0-8]\./
   # Faraday 1.x versions before 1.9 - not matched by
   # the previous clause - use `FilePart` (which must be explicitly
   # required)
   require 'faraday/file_part'
-when /\A1\./
+when /\A[12]\./
   # Later 1.x versions from 1.9 onwards automatically include the
   # `faraday-multipart` gem, which includes `Faraday::FilePart`
   require 'faraday/multipart'
@@ -16,7 +14,6 @@ else
   raise "Unexpected Faraday version #{Faraday::VERSION} - not sure how to set up " \
         "multipart support"
 end
-
 module Restforce
   if defined?(::Faraday::FilePart)
     FilePart = Faraday::FilePart

data/lib/restforce/middleware/authentication.rb

@@ -49,7 +49,7 @@ module Restforce
       @connection ||= Faraday.new(faraday_options) do |builder|
         builder.use Faraday::Request::UrlEncoded
         builder.use Restforce::Middleware::Mashify, nil, @options
-        builder.use FaradayMiddleware::FollowRedirects
+        builder.use Faraday::FollowRedirects::Middleware
         builder.response :json
 
         if Restforce.log?

data/lib/restforce/middleware/caching.rb

@@ -1,30 +1,155 @@
 # frozen_string_literal: true
 
+#
+# Taken from `lib/faraday_middleware/response/caching.rb` in the `faraday_middleware`
+# gem (<https://github.com/lostisland/faraday_middleware/blob/784b4f8/lib/faraday_middleware/response/caching.rb>).
+#
+# Includes some small modifications to allow the cache to be cleared in
+# `#without_caching` mode, replicating traditional Restforce behaviour.
+#
+# Copyright (c) 2011 Erik Michaels-Ober, Wynn Netherland, et al.
+# Licensed under the MIT License.
+#
+require 'faraday'
+require 'forwardable'
+require 'digest/sha1'
+
 module Restforce
-  class Middleware::Caching < FaradayMiddleware::Caching
-    def call(env)
-      expire(cache_key(env)) unless use_cache?
-      super
+  # Public: Caches GET responses and pulls subsequent ones from the cache.
+  class Middleware::Caching < Faraday::Middleware
+    attr_reader :cache
+
+    # Internal: List of status codes that can be cached:
+    # * 200 - 'OK'
+    # * 203 - 'Non-Authoritative Information'
+    # * 300 - 'Multiple Choices'
+    # * 301 - 'Moved Permanently'
+    # * 302 - 'Found'
+    # * 404 - 'Not Found'
+    # * 410 - 'Gone'
+    CACHEABLE_STATUS_CODES = [200, 203, 300, 301, 302, 404, 410].freeze
+
+    extend Forwardable
+    def_delegators :'Faraday::Utils', :parse_query, :build_query
+
+    # Public: initialize the middleware.
+    #
+    # cache   - An object that responds to read and write (default: nil).
+    # options - An options Hash (default: {}):
+    #           :ignore_params - String name or Array names of query
+    #                                    params that should be ignored when forming
+    #                                    the cache key (default: []).
+    #           :write_options - Hash of settings that should be passed as the
+    #                                    third options parameter to the cache's #write
+    #                                    method. If not specified, no options parameter
+    #                                    will be passed.
+    #           :full_key      - Boolean - use full URL as cache key:
+    #                                    (url.host + url.request_uri)
+    #           :status_codes  - Array of http status code to be cache
+    #                                    (default: CACHEABLE_STATUS_CODE)
+    #
+    # Yields if no cache is given. The block should return a cache object.
+    def initialize(app, cache = nil, options = {})
+      super(app)
+      if cache.is_a?(Hash) && block_given?
+        options = cache
+        cache = nil
+      end
+      @cache = cache || yield
+      @options = options
     end
 
-    def expire(key)
-      cache&.delete(key)
+    def call(env)
+      # Taken from `Restforce::Middleware::Caching` implementation
+      # before we switched away from the `faraday_middleware` gem.
+      # See https://github.com/restforce/restforce/blob/a08b9d6c5e277bd7111ffa7ed50465dd49c05fab/lib/restforce/middleware/caching.rb.
+      cache&.delete(cache_key(env)) unless use_cache?
+
+      if env[:method] == :get
+        if env[:parallel_manager]
+          # callback mode
+          cache_on_complete(env)
+        else
+          # synchronous mode
+          key = cache_key(env)
+          unless (response = cache.read(key)) && response
+            response = @app.call(env)
+            store_response_in_cache(key, response)
+          end
+          finalize_response(response, env)
+        end
+      else
+        @app.call(env)
+      end
     end
 
-    # We don't want to cache requests for different clients, so append the
-    # oauth token to the cache key.
     def cache_key(env)
-      super(env) + hashed_auth_header(env)
+      url = env[:url].dup
+      if url.query && params_to_ignore.any?
+        params = parse_query url.query
+        params.reject! { |k,| params_to_ignore.include? k }
+        url.query = params.any? ? build_query(params) : nil
+      end
+      url.normalize!
+      digest = full_key? ? url.host + url.request_uri : url.request_uri
+      Digest::SHA1.hexdigest(digest)
     end
 
-    def use_cache?
-      @options[:use_cache]
+    def params_to_ignore
+      @params_to_ignore ||= Array(@options[:ignore_params]).map(&:to_s)
+    end
+
+    def full_key?
+      @full_key ||= @options[:full_key]
     end
 
-    def hashed_auth_header(env)
-      Digest::SHA1.hexdigest(
-        env[:request_headers][Restforce::Middleware::Authorization::AUTH_HEADER]
-      )
+    def custom_status_codes
+      @custom_status_codes ||= begin
+        codes = CACHEABLE_STATUS_CODES & Array(@options[:status_codes]).map(&:to_i)
+        codes.any? ? codes : CACHEABLE_STATUS_CODES
+      end
+    end
+
+    def cache_on_complete(env)
+      key = cache_key(env)
+      if (cached_response = cache.read(key))
+        finalize_response(cached_response, env)
+      else
+        # response.status is nil at this point
+        # any checks need to be done inside on_complete block
+        @app.call(env).on_complete do |response_env|
+          store_response_in_cache(key, response_env.response)
+          response_env
+        end
+      end
+    end
+
+    def store_response_in_cache(key, response)
+      return unless custom_status_codes.include?(response.status)
+
+      if @options[:write_options]
+        cache.write(key, response, @options[:write_options])
+      else
+        cache.write(key, response)
+      end
+    end
+
+    def finalize_response(response, env)
+      response = response.dup if response.frozen?
+      env[:response] = response
+      unless env[:response_headers]
+        env.update response.env
+        # FIXME: omg hax
+        response.instance_variable_set('@env', env)
+      end
+      response
+    end
+
+    # Taken from `Restforce::Middleware::Caching` implementation
+    # before we switched away from the `faraday_middleware` gem.
+    # See https://github.com/restforce/restforce/blob/a08b9d6c5e277bd7111ffa7ed50465dd49c05fab/lib/restforce/middleware/caching.rb.
+    def use_cache?
+      @options[:use_cache]
     end
   end
 end

data/lib/restforce/middleware/json_request.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+#
+# Adapted from `lib/faraday/request/json.rb` in the `faraday`
+# gem (<https://github.com/lostisland/faraday/blob/5366029282968d59980a182258f8c2b0212721c8/lib/faraday/request/json.rb>).
+#
+# We use this because we want to support Faraday 1.x and Faraday 2.x.
+# Faraday 2.x has the JSON middlewares included, but Faraday 1.x doesn't,
+# forcing you to use the `faraday_middleware` gem. This approach allows us
+# to support both.
+#
+# Copyright (c) 2009-2022 Rick Olson, Zack Hobson
+# Licensed under the MIT License.
+#
+require 'json'
+
+module Restforce
+  # Request middleware that encodes the body as JSON.
+  #
+  # Processes only requests with matching Content-type or those without a type.
+  # If a request doesn't have a type but has a body, it sets the Content-type
+  # to JSON MIME-type.
+  #
+  # Doesn't try to encode bodies that already are in string form.
+  # rubocop:disable Style/ClassAndModuleChildren
+  class Middleware::JsonRequest < Faraday::Middleware
+    # rubocop:enable Style/ClassAndModuleChildren
+
+    # This is the only line that differs substantively from the version in
+    # Faraday. In Faraday, this refers to a Faraday constant.
+    CONTENT_TYPE = 'Content-Type'
+
+    MIME_TYPE = 'application/json'
+    MIME_TYPE_REGEX = %r{^application/(vnd\..+\+)?json$}.freeze
+
+    #
+    # Taken from `lib/faraday/middleware.rb` in the `faraday`
+    # gem (<https://github.com/lostisland/faraday/blob/08b7d4d/lib/faraday/middleware.rb>),
+    # with a tiny adaptation to refer to the `@app` instance
+    # variable rather than expecting an `attr_reader` to exist.
+    #
+    # In Faraday versions before v1.2.0, `#call`  is missing.
+    #
+    # Copyright (c) 2009-2022 Rick Olson, Zack Hobson
+    # Licensed under the MIT License.
+    #
+    def call(env)
+      on_request(env) if respond_to?(:on_request)
+      @app.call(env).on_complete do |environment|
+        on_complete(environment) if respond_to?(:on_complete)
+      end
+    end
+
+    def on_request(env)
+      match_content_type(env) do |data|
+        env[:body] = encode(data)
+      end
+    end
+
+    private
+
+    def encode(data)
+      ::JSON.generate(data)
+    end
+
+    def match_content_type(env)
+      return unless process_request?(env)
+
+      env[:request_headers][CONTENT_TYPE] ||= MIME_TYPE
+      yield env[:body] unless env[:body].respond_to?(:to_str)
+    end
+
+    def process_request?(env)
+      type = request_type(env)
+      body?(env) && (type.empty? || type.match?(MIME_TYPE_REGEX))
+    end
+
+    def body?(env)
+      (body = env[:body]) && !(body.respond_to?(:to_str) && body.empty?)
+    end
+
+    def request_type(env)
+      type = env[:request_headers][CONTENT_TYPE].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
+    end
+  end
+end
+
+Faraday::Request.register_middleware(json: Restforce::Middleware::JsonRequest)

data/lib/restforce/middleware/json_response.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: true
+
+#
+# Adapted from `lib/faraday/response/json.rb` in the `faraday`
+# gem (<https://github.com/lostisland/faraday/blob/5366029/lib/faraday/response/json.rb>).
+#
+# Copyright (c) 2009-2022 Rick Olson, Zack Hobson
+# Licensed under the MIT License.
+#
+
+require 'json'
+
+module Restforce
+  # rubocop:disable Style/ClassAndModuleChildren
+  class Middleware::JsonResponse < Faraday::Middleware
+    # rubocop:enable Style/ClassAndModuleChildren
+
+    # This is the only line that differs substantively from the version in
+    # Faraday. In Faraday, this refers to a Faraday constant.
+    CONTENT_TYPE = 'Content-Type'
+
+    def initialize(app = nil, parser_options: nil, content_type: /\bjson$/,
+                   preserve_raw: false)
+      super(app)
+      @parser_options = parser_options
+      @content_types = Array(content_type)
+      @preserve_raw = preserve_raw
+    end
+
+    #
+    # Taken from `lib/faraday/middleware.rb` in the `faraday`
+    # gem (<https://github.com/lostisland/faraday/blob/08b7d4d/lib/faraday/middleware.rb>),
+    # with a tiny adaptation to refer to the `@app` instance
+    # variable rather than expecting an `attr_reader` to exist.
+    #
+    # In Faraday versions before v1.2.0, `#call`  is missing.
+    #
+    # Copyright (c) 2009-2022 Rick Olson, Zack Hobson
+    # Licensed under the MIT License.
+    #
+    def call(env)
+      on_request(env) if respond_to?(:on_request)
+      @app.call(env).on_complete do |environment|
+        on_complete(environment) if respond_to?(:on_complete)
+      end
+    end
+
+    def on_complete(env)
+      process_response(env) if parse_response?(env)
+    end
+
+    private
+
+    def process_response(env)
+      env[:raw_body] = env[:body] if @preserve_raw
+      env[:body] = parse(env[:body])
+    rescue StandardError, SyntaxError => e
+      raise Faraday::ParsingError.new(e, env[:response])
+    end
+
+    def parse(body)
+      ::JSON.parse(body, @parser_options || {}) unless body.strip.empty?
+    end
+
+    def parse_response?(env)
+      process_response_type?(env) &&
+        env[:body].respond_to?(:to_str)
+    end
+
+    def process_response_type?(env)
+      type = response_type(env)
+      @content_types.empty? || @content_types.any? do |pattern|
+        pattern.is_a?(Regexp) ? type.match?(pattern) : type == pattern
+      end
+    end
+
+    def response_type(env)
+      type = env[:response_headers][CONTENT_TYPE].to_s
+      type = type.split(';', 2).first if type.index(';')
+      type
+    end
+  end
+end
+
+Faraday::Response.register_middleware(json: Restforce::Middleware::JsonResponse)

data/lib/restforce/middleware/logger.rb

@@ -3,7 +3,7 @@
 require 'forwardable'
 
 module Restforce
-  class Middleware::Logger < Faraday::Response::Middleware
+  class Middleware::Logger < Faraday::Middleware
     extend Forwardable
 
     def initialize(app, logger, options)
@@ -24,7 +24,11 @@ module Restforce
              headers: env[:request_headers],
              body: env[:body]
       end
-      super
+
+      on_request(env) if respond_to?(:on_request)
+      @app.call(env).on_complete do |environment|
+        on_complete(environment) if respond_to?(:on_complete)
+      end
     end
 
     def on_complete(env)

data/lib/restforce/middleware/raise_error.rb

@@ -1,7 +1,16 @@
 # frozen_string_literal: true
 
 module Restforce
-  class Middleware::RaiseError < Faraday::Response::Middleware
+  class Middleware::RaiseError < Faraday::Middleware
+    # Required for Faraday versions pre-v1.2.0 which do not include
+    # an implementation of `#call` by default
+    def call(env)
+      on_request(env) if respond_to?(:on_request)
+      @app.call(env).on_complete do |environment|
+        on_complete(environment) if respond_to?(:on_complete)
+      end
+    end
+
     def on_complete(env)
       @env = env
       case env[:status]

data/lib/restforce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restforce
-  VERSION = '5.3.1'
+  VERSION = '6.0.0.rc.1'
 end

data/lib/restforce.rb

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
 require 'faraday'
-require 'faraday_middleware'
+require 'faraday/follow_redirects'
 require 'json'
 require 'jwt'
 
@@ -64,21 +64,23 @@ module Restforce
   EntityTooLargeError = Class.new(ResponseError)
 
   require 'restforce/error_code'
+  require 'restforce/middleware/json_request'
+  require 'restforce/middleware/json_response'
 
   class << self
     # Alias for Restforce::Data::Client.new
     #
     # Shamelessly pulled from https://github.com/pengwynn/octokit/blob/master/lib/octokit.rb
-    def new(*args, &block)
-      data(*args, &block)
+    def new(...)
+      data(...)
     end
 
-    def data(*args, &block)
-      Restforce::Data::Client.new(*args, &block)
+    def data(...)
+      Restforce::Data::Client.new(...)
     end
 
-    def tooling(*args, &block)
-      Restforce::Tooling::Client.new(*args, &block)
+    def tooling(...)
+      Restforce::Tooling::Client.new(...)
     end
 
     # Helper for decoding signed requests.

data/restforce.gemspec

@@ -22,10 +22,12 @@ Gem::Specification.new do |gem|
 'rubygems_mfa_required' => 'true'
   }
 
-  gem.required_ruby_version = '>= 2.6'
+  gem.required_ruby_version = '>= 2.7'
 
-  gem.add_dependency 'faraday', '<= 1.10.0', '>= 0.9.0'
-  gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 2.0']
+  gem.add_dependency 'faraday', '< 2.5.0', '>= 1.1.0'
+  gem.add_dependency 'faraday-follow_redirects', '<= 0.3.0', '< 1.0.0'
+  gem.add_dependency 'faraday-multipart', '>= 1.0.0', '< 2.0.0'
+  gem.add_dependency 'faraday-net_http', '< 3.0.0'
   gem.add_dependency 'hashie', '>= 1.2.0', '< 6.0'
   gem.add_dependency 'jwt', ['>= 1.5.6']
 end

data/spec/integration/abstract_client_spec.rb

@@ -367,7 +367,11 @@ shared_examples_for Restforce::AbstractClient do
           with_body: "grant_type=password&client_id=client_id" \
                      "&client_secret=client_secret&username=foo" \
                      "&password=barsecurity_token"
-        ).to_return(status: 200, body: fixture(:auth_success_response))
+        ).to_return(
+          status: 200,
+          body: fixture(:auth_success_response),
+          headers: { "Content-Type" => "application/json" }
+        )
       end
 
       after do
@@ -419,7 +423,11 @@ shared_examples_for Restforce::AbstractClient do
           with_body: "grant_type=password&client_id=client_id" \
                      "&client_secret=client_secret&username=foo&" \
                      "password=barsecurity_token"
-        ).to_return(status: 200, body: fixture(:auth_success_response))
+        ).to_return(
+          status: 200,
+          body: fixture(:auth_success_response),
+          headers: { "Content-Type" => "application/json" }
+        )
       end
 
       subject { lambda { client.query('SELECT some, fields FROM object') } }
@@ -443,7 +451,11 @@ shared_examples_for Restforce::AbstractClient do
       @login = stub_login_request(
         with_body: "grant_type=password&client_id=client_id&client_secret=" \
                    "client_secret&username=foo&password=barsecurity_token"
-      ).to_return(status: 200, body: fixture(:auth_success_response))
+      ).to_return(
+        status: 200,
+        body: fixture(:auth_success_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
 
     after do

data/spec/unit/concerns/connection_spec.rb

@@ -73,7 +73,7 @@ describe Restforce::Concerns::Connection do
         Restforce.stub(log?: true)
       end
 
-      it "must always be used as the last handler" do
+      it "must always be used as the last handler before the adapter" do
         client.middleware.handlers.reverse.index(Restforce::Middleware::Logger).
           should eq 0
       end

data/spec/unit/middleware/authentication/jwt_bearer_spec.rb

@@ -18,14 +18,22 @@ describe Restforce::Middleware::Authentication::JWTBearer do
       stub_login_request(
         body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
               "assertion=abc1234567890"
-      ).to_return(status: 200, body: fixture(:auth_success_response))
+      ).to_return(
+        status: 200,
+        body: fixture(:auth_success_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
 
     let(:fail_request) do
       stub_login_request(
         body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
               "assertion=abc1234567890"
-      ).to_return(status: 400, body: fixture(:refresh_error_response))
+      ).to_return(
+        status: 400,
+        body: fixture(:refresh_error_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
   end
 
@@ -48,14 +56,22 @@ describe Restforce::Middleware::Authentication::JWTBearer do
         stub_login_request(
           body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
                 "assertion=abc1234567890"
-        ).to_return(status: 200, body: fixture(:auth_success_response))
+        ).to_return(
+          status: 200,
+          body: fixture(:auth_success_response),
+          headers: { "Content-Type" => "application/json" }
+        )
       end
 
       let(:fail_request) do
         stub_login_request(
           body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
                 "assertion=abc1234567890"
-        ).to_return(status: 400, body: fixture(:refresh_error_response))
+        ).to_return(
+          status: 400,
+          body: fixture(:refresh_error_response),
+          headers: { "Content-Type" => "application/json" }
+        )
       end
     end
   end

data/spec/unit/middleware/authentication/password_spec.rb

@@ -18,14 +18,22 @@ describe Restforce::Middleware::Authentication::Password do
       stub_login_request(
         body: "grant_type=password&client_id=client_id&client_secret=client_secret" \
               "&username=foo&password=barsecurity_token"
-      ).to_return(status: 200, body: fixture(:auth_success_response))
+      ).to_return(
+        status: 200,
+        body: fixture(:auth_success_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
 
     let(:fail_request) do
       stub_login_request(
         body: "grant_type=password&client_id=client_id&client_secret=client_secret" \
               "&username=foo&password=barsecurity_token"
-      ).to_return(status: 400, body: fixture(:auth_error_response))
+      ).to_return(
+        status: 400,
+        body: fixture(:auth_error_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
   end
 

data/spec/unit/middleware/authentication/token_spec.rb

@@ -16,14 +16,22 @@ describe Restforce::Middleware::Authentication::Token do
       stub_login_request(
         body: "grant_type=refresh_token&refresh_token=refresh_token&" \
               "client_id=client_id&client_secret=client_secret"
-      ).to_return(status: 200, body: fixture(:auth_success_response))
+      ).to_return(
+        status: 200,
+        body: fixture(:auth_success_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
 
     let(:fail_request) do
       stub_login_request(
         body: "grant_type=refresh_token&refresh_token=refresh_token&" \
               "client_id=client_id&client_secret=client_secret"
-      ).to_return(status: 400, body: fixture(:refresh_error_response))
+      ).to_return(
+        status: 400,
+        body: fixture(:refresh_error_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
   end
 end

data/spec/unit/middleware/authentication_spec.rb

@@ -59,7 +59,7 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson
+          should include Restforce::Middleware::JsonResponse
         }
         its(:handlers) { should_not include Restforce::Middleware::Logger }
         its(:adapter) { should eq Faraday::Adapter::NetHttp }
@@ -71,7 +71,7 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson,
+          should include Restforce::Middleware::JsonResponse,
                          Restforce::Middleware::Logger
         }
         its(:adapter) { should eq Faraday::Adapter::NetHttp }
@@ -83,7 +83,7 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson
+          should include Restforce::Middleware::JsonResponse
         }
         its(:adapter) { should eq Faraday::Adapter::Typhoeus }
       end
@@ -97,7 +97,7 @@ describe Restforce::Middleware::Authentication do
   end
 
   describe '.error_message' do
-    context 'when response.body is present' do
+    context 'when response_body is present' do
       let(:response) {
         Faraday::Response.new(
           response_body: { 'error' => 'error', 'error_description' => 'description' },
@@ -109,7 +109,7 @@ describe Restforce::Middleware::Authentication do
       it { should eq "error: description (401)" }
     end
 
-    context 'when response.body is nil' do
+    context 'when response_body is nil' do
       let(:response) { Faraday::Response.new(status: 401) }
 
       subject { middleware.error_message(response) }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 5.3.1
+  version: 6.0.0.rc.1
 platform: ruby
 authors:
 - Tim Rogers
@@ -9,48 +9,82 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-07-19 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.5.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.1.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 1.10.0
+        version: 2.5.0
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.9.0
+        version: 1.1.0
 - !ruby/object:Gem::Dependency
-  name: faraday_middleware
+  name: faraday-follow_redirects
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: 0.3.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: 0.8.8
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
     - - "<="
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 0.3.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-multipart
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 2.0.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
       - !ruby/object:Gem::Version
-        version: 0.8.8
-    - - "<="
+        version: 1.0.0
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 2.0.0
+- !ruby/object:Gem::Dependency
+  name: faraday-net_http
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "<"
+      - !ruby/object:Gem::Version
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -143,6 +177,8 @@ files:
 - lib/restforce/middleware/custom_headers.rb
 - lib/restforce/middleware/gzip.rb
 - lib/restforce/middleware/instance_url.rb
+- lib/restforce/middleware/json_request.rb
+- lib/restforce/middleware/json_response.rb
 - lib/restforce/middleware/logger.rb
 - lib/restforce/middleware/mashify.rb
 - lib/restforce/middleware/multipart.rb
@@ -249,12 +285,12 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.6'
+      version: '2.7'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
 rubygems_version: 3.1.6
 signing_key: