restforce 5.2.4 → 6.0.0.rc.1

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.2.4'
+  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

@@ -12,7 +12,6 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "restforce"
   gem.require_paths = ["lib"]
   gem.version       = Restforce::VERSION
@@ -23,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.9.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/api_spec.rb

@@ -312,8 +312,11 @@ describe Restforce::Concerns::API do
         let(:attrs) { { id: '1234', StageName: "Call Scheduled" } }
 
         it 'sends an HTTP PATCH, and returns true' do
-          client.should_receive(:api_patch).
-            with('sobjects/Whizbang/1234', StageName: "Call Scheduled")
+          client.should_receive(:api_patch) do |*args|
+            expect(args).to eq(["sobjects/Whizbang/1234",
+                                { StageName: "Call Scheduled" }])
+          end
+
           expect(result).to be true
         end
       end
@@ -322,8 +325,12 @@ describe Restforce::Concerns::API do
         let(:attrs) { { id: '1234/?abc', StageName: "Call Scheduled" } }
 
         it 'sends an HTTP PATCH, and encodes the ID' do
-          client.should_receive(:api_patch).
-            with('sobjects/Whizbang/1234%2F%3Fabc', StageName: "Call Scheduled")
+          client.should_receive(:api_patch) do |*args|
+            expect(args).to eq(['sobjects/Whizbang/1234%2F%3Fabc', {
+                                 StageName: "Call Scheduled"
+                               }])
+          end
+
           expect(result).to be true
         end
       end

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/config_spec.rb

@@ -44,7 +44,7 @@ describe Restforce do
           'SALESFORCE_PROXY_URI'      => 'proxy',
           'SALESFORCE_HOST'           => 'test.host.com',
           'SALESFORCE_API_VERSION'    => '37.0' }.
-          each { |var, value| ENV.stub(:[]).with(var).and_return(value) }
+          each { |var, value| ENV.stub(:fetch).with(var, anything).and_return(value) }
       end
 
       its(:username)       { should eq 'foo' }

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,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 5.2.4
+  version: 6.0.0.rc.1
 platform: ruby
 authors:
 - Tim Rogers
 - Eric J. Holmes
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-08-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,40 +17,74 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 1.9.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.9.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.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: '2.0'
+        version: 3.0.0
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -93,9 +127,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/unhandled-salesforce-error.md"
 - ".github/dependabot.yml"
+- ".github/workflows/build.yml"
+- ".github/workflows/faraday.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -142,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
@@ -240,7 +277,7 @@ metadata:
   source_code_uri: https://github.com/restforce/restforce
   changelog_uri: https://github.com/restforce/restforce/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -248,92 +285,15 @@ 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.3.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A lightweight Ruby client for the Salesforce REST API
-test_files:
-- spec/fixtures/auth_error_response.json
-- spec/fixtures/auth_success_response.json
-- spec/fixtures/blob.jpg
-- spec/fixtures/expired_session_response.json
-- spec/fixtures/reauth_success_response.json
-- spec/fixtures/refresh_error_response.json
-- spec/fixtures/refresh_success_response.json
-- spec/fixtures/services_data_success_response.json
-- spec/fixtures/sobject/create_success_response.json
-- spec/fixtures/sobject/delete_error_response.json
-- spec/fixtures/sobject/describe_sobjects_success_response.json
-- spec/fixtures/sobject/get_deleted_success_response.json
-- spec/fixtures/sobject/get_updated_success_response.json
-- spec/fixtures/sobject/list_sobjects_success_response.json
-- spec/fixtures/sobject/list_view_results_success_response.json
-- spec/fixtures/sobject/org_query_response.json
-- spec/fixtures/sobject/query_aggregate_success_response.json
-- spec/fixtures/sobject/query_empty_response.json
-- spec/fixtures/sobject/query_error_response.json
-- spec/fixtures/sobject/query_paginated_first_page_response.json
-- spec/fixtures/sobject/query_paginated_last_page_response.json
-- spec/fixtures/sobject/query_success_response.json
-- spec/fixtures/sobject/recent_success_response.json
-- spec/fixtures/sobject/search_error_response.json
-- spec/fixtures/sobject/search_success_response.json
-- spec/fixtures/sobject/sobject_describe_error_response.json
-- spec/fixtures/sobject/sobject_describe_success_response.json
-- spec/fixtures/sobject/sobject_find_error_response.json
-- spec/fixtures/sobject/sobject_find_success_response.json
-- spec/fixtures/sobject/sobject_select_success_response.json
-- spec/fixtures/sobject/upsert_created_success_response.json
-- spec/fixtures/sobject/upsert_error_response.json
-- spec/fixtures/sobject/upsert_multiple_error_response.json
-- spec/fixtures/sobject/upsert_updated_success_response.json
-- spec/fixtures/sobject/write_error_response.json
-- spec/fixtures/test_private.key
-- spec/integration/abstract_client_spec.rb
-- spec/integration/data/client_spec.rb
-- spec/spec_helper.rb
-- spec/support/client_integration.rb
-- spec/support/concerns.rb
-- spec/support/event_machine.rb
-- spec/support/fixture_helpers.rb
-- spec/support/matchers.rb
-- spec/support/middleware.rb
-- spec/support/mock_cache.rb
-- spec/unit/abstract_client_spec.rb
-- spec/unit/attachment_spec.rb
-- spec/unit/collection_spec.rb
-- spec/unit/concerns/api_spec.rb
-- spec/unit/concerns/authentication_spec.rb
-- spec/unit/concerns/base_spec.rb
-- spec/unit/concerns/batch_api_spec.rb
-- spec/unit/concerns/caching_spec.rb
-- spec/unit/concerns/canvas_spec.rb
-- spec/unit/concerns/composite_api_spec.rb
-- spec/unit/concerns/connection_spec.rb
-- spec/unit/concerns/streaming_spec.rb
-- spec/unit/config_spec.rb
-- spec/unit/data/client_spec.rb
-- spec/unit/document_spec.rb
-- spec/unit/error_code_spec.rb
-- spec/unit/mash_spec.rb
-- spec/unit/middleware/authentication/jwt_bearer_spec.rb
-- spec/unit/middleware/authentication/password_spec.rb
-- spec/unit/middleware/authentication/token_spec.rb
-- spec/unit/middleware/authentication_spec.rb
-- spec/unit/middleware/authorization_spec.rb
-- spec/unit/middleware/custom_headers_spec.rb
-- spec/unit/middleware/gzip_spec.rb
-- spec/unit/middleware/instance_url_spec.rb
-- spec/unit/middleware/logger_spec.rb
-- spec/unit/middleware/mashify_spec.rb
-- spec/unit/middleware/raise_error_spec.rb
-- spec/unit/signed_request_spec.rb
-- spec/unit/sobject_spec.rb
-- spec/unit/tooling/client_spec.rb
+test_files: []

data/.circleci/config.yml

@@ -1,61 +0,0 @@
-version: 2
-
-references:
-  steps: &steps
-    - checkout
-
-    - run:
-        name: Update Bundler
-        command: gem install bundler
-
-    - run:
-        name: Install dependencies from .gemspec
-        command: bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-    - run:
-        name: Run RSpec tests
-        command: |
-          mkdir /tmp/test-results
-          
-          bundle exec rspec --format progress \
-                          --format RspecJunitFormatter \
-                          --out /tmp/test-results/rspec.xml \
-                          --format progress \
-                          spec/**/*_spec.rb
-
-    - run:
-        name: Check code style with Rubocop
-        command: bundle exec rubocop
-
-    - store_test_results:
-        path: /tmp/test-results
-    - store_artifacts:
-        path: /tmp/test-results
-        destination: test-results
-
-jobs:
-  build-ruby31:
-    docker:
-       - image: cimg/ruby:3.1
-    steps: *steps
-  build-ruby30:
-    docker:
-       - image: cimg/ruby:3.0
-    steps: *steps
-  build-ruby27:
-    docker:
-       - image: cimg/ruby:2.7
-    steps: *steps
-  build-ruby26:
-    docker:
-       - image: cimg/ruby:2.6
-    steps: *steps
-
-workflows:
-  version: 2
-  tests:
-    jobs:
-      - build-ruby31
-      - build-ruby30
-      - build-ruby27
-      - build-ruby26