restforce 6.2.0 → 6.2.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7a29ac5ff461f9db1f386570aceebfa30244ec519ccd26320e6255cdaddc57
-  data.tar.gz: 556b7407db043fe2a3d5e9fe9183be767693cacacd31fe8ac492aca9fd195194
+  metadata.gz: 18f985dc2a3f2b1776f442009e24453e35c19d946f1d0f6ecdd42af56693c8ca
+  data.tar.gz: a9ab15688f2eaf7122b57bdca9bdbd54724983f6c38ee311aed095cd7ed3c950
 SHA512:
-  metadata.gz: '0585185aed0e16fea289b78ccb16122306186901195daa5d2b323dedcbb4999e5760910e5d8ceb7966424b8e4d636d20c92f61bcc283f1fe75de3857ca35d68b'
-  data.tar.gz: b17650d7d7984b0b412c2c678a49d61d8d69fc961454aad313c4a8c1ed25ea49f04d68b1d658bb4464b4514f81118f1e69392465a541f0431571d60096e9d9c0
+  metadata.gz: 22bdd50789784b18f20dabaa86358db0d05e37e630770ea70da379b5c3410059b8b003e7e8a26347c3ee0141f8b81dc1d422d796454e32bca7531b9f81f72041
+  data.tar.gz: 520de3d9f192d6f658fc8bca961975550432054b8c6db5710a5198bb7947c0b485b5a9ff112a1e4cf1848a13344f6cdc0adb2ef498a2ea5175c76582f4bdd395

data/.github/workflows/faraday.yml

@@ -10,7 +10,7 @@ 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', '2.5.0', '2.6.0', '2.7.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.4']
     env:
       FARADAY_VERSION: ~> ${{ matrix.faraday_version }}
     steps:
@@ -24,4 +24,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,6 @@ tmp
 .rspec
 .ruby-version
 *.swp
+.idea
+Vagrantfile
+.vagrant/

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 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)

data/Gemfile

@@ -7,7 +7,7 @@ faraday_version = ENV.fetch('FARADAY_VERSION', '~> 2.7.3')
 
 # 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.0.0' unless faraday_version.start_with?("~> 1")
 gem 'faye' unless RUBY_PLATFORM == 'java'
 gem 'guard-rspec'
 gem 'guard-rubocop'
@@ -17,6 +17,6 @@ gem 'rspec', '~> 3.12.0'
 gem 'rspec-collection_matchers', '~> 1.2.0'
 gem 'rspec-its', '~> 1.3.0'
 gem 'rspec_junit_formatter', '~> 0.6.0'
-gem 'rubocop', '~> 1.43.0'
+gem 'rubocop', '~> 1.48.0'
 gem 'simplecov', '~> 0.22.0'
 gem 'webmock', '~> 3.18.1'

data/README.md

@@ -27,7 +27,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 6.2.0'
+    gem 'restforce', '~> 6.2.2'
 
 And then execute:
 
@@ -112,12 +112,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'],                   # https://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

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/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|
@@ -43,7 +45,10 @@ 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.
@@ -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/config.rb

@@ -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

data/lib/restforce/error_code.rb

@@ -171,6 +171,8 @@ module Restforce
 
     class InsertUpdateDeleteNotAllowedDuringMaintenance < ResponseError; end
 
+    class InsufficientAccess < ResponseError; end
+
     class InsufficientAccessOnCrossReferenceEntity < ResponseError; end
 
     class InsufficientAccessOrReadonly < ResponseError; end
@@ -500,6 +502,8 @@ module Restforce
       "INACTIVE_OWNER_OR_USER" => InactiveOwnerOrUser,
       "INSERT_UPDATE_DELETE_NOT_ALLOWED_DURING_MAINTENANCE" =>
    InsertUpdateDeleteNotAllowedDuringMaintenance,
+      "INSUFFICIENT_ACCESS" =>
+   InsufficientAccess,
       "INSUFFICIENT_ACCESS_ON_CROSS_REFERENCE_ENTITY" =>
    InsufficientAccessOnCrossReferenceEntity,
       "INSUFFICIENT_ACCESS_OR_READONLY" => InsufficientAccessOrReadonly,

data/lib/restforce/file_part.rb

@@ -29,4 +29,6 @@ end
 
 # This patch is only needed with multipart-post < 2.0.0
 # 2.0.0 was released in 2013.
-require 'restforce/patches/parts' unless Parts::Part.method(:new).arity.abs == 4
+if defined?(Parts) && Parts::Part.method(:new).arity.abs != 4
+  require 'restforce/patches/parts'
+end

data/lib/restforce/middleware/gzip.rb

@@ -28,6 +28,10 @@ module Restforce
     # Internal: Decompresses a gzipped string.
     def decompress(body)
       Zlib::GzipReader.new(StringIO.new(body)).read
+    rescue Zlib::GzipFile::Error
+      # We thought the response was gzipped, but it wasn't. Return the original
+      # body back to the caller. See https://github.com/restforce/restforce/issues/761.
+      body
     end
   end
 end

data/lib/restforce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restforce
-  VERSION = '6.2.0'
+  VERSION = '6.2.2'
 end

data/spec/unit/config_spec.rb

@@ -62,7 +62,7 @@ describe Restforce do
     %i[username password security_token client_id client_secret compress
        timeout oauth_token refresh_token instance_url api_version host mashify
        authentication_retries proxy_uri authentication_callback ssl
-       request_headers log_level logger].each do |attr|
+       request_headers log_level logger clear_authorization_header].each do |attr|
       it "allows #{attr} to be set" do
         Restforce.configure do |config|
           config.send("#{attr}=", 'foobar')

data/spec/unit/middleware/gzip_spec.rb

@@ -17,38 +17,73 @@ describe Restforce::Middleware::Gzip do
   describe '.call' do
     subject { lambda { middleware.call(env) } }
 
-    before do
-      app.should_receive(:on_complete) { middleware.on_complete(env) }
-      app.should_receive(:call) do
-        env[:body] = gzip fixture('sobject/query_success_response')
-        env[:response_headers]['Content-Encoding'] = 'gzip'
-        app
+    context 'when the response is gzipped' do
+      before do
+        app.should_receive(:on_complete) { middleware.on_complete(env) }
+        app.should_receive(:call) do
+          env[:body] = gzip fixture('sobject/query_success_response')
+          env[:response_headers]['Content-Encoding'] = 'gzip'
+          app
+        end
+      end
+
+      it 'decompresses the body' do
+        expect { subject.call }.to change {
+                                     env[:body]
+                                   }.to(fixture('sobject/query_success_response'))
+      end
+
+      context 'when :compress is false' do
+        it 'does not set request headers to ask the response to be compressed' do
+          expect { subject.call }.
+            not_to(change { env[:request_headers]['Accept-Encoding'] })
+        end
       end
-    end
 
-    it 'decompresses the body' do
-      expect { subject.call }.to change {
-                                   env[:body]
-                                 }.to(fixture('sobject/query_success_response'))
+      context 'when :compress is true' do
+        before do
+          options[:compress] = true
+        end
+
+        it 'sets request headers to ask the response to be compressed' do
+          expect { subject.call }.to change {
+                                       env[:request_headers]['Accept-Encoding']
+                                     }.to('gzip')
+        end
+      end
     end
 
-    context 'when :compress is false' do
-      it {
-        expect { subject.call }.
-          not_to(change { env[:request_headers]['Accept-Encoding'] })
-      }
+    context 'when the response claims to be gzipped, but is not' do
+      before do
+        app.should_receive(:on_complete) { middleware.on_complete(env) }
+        app.should_receive(:call) do
+          env[:body] = fixture('sobject/query_success_response')
+          env[:response_headers]['Content-Encoding'] = 'gzip'
+          app
+        end
+      end
+
+      it 'does not decompress the body' do
+        expect { subject.call }.to change {
+                                     env[:body]
+                                   }.to(fixture('sobject/query_success_response'))
+      end
     end
 
-    context 'when :compress is true' do
+    context 'when the response does not even claim to be gzipped' do
       before do
-        options[:compress] = true
+        app.should_receive(:on_complete) { middleware.on_complete(env) }
+        app.should_receive(:call) do
+          env[:body] = fixture('sobject/query_success_response')
+          app
+        end
       end
 
-      it {
+      it 'does not decompress the body' do
         expect { subject.call }.to change {
-                                     env[:request_headers]['Accept-Encoding']
-                                   }.to('gzip')
-      }
+                                     env[:body]
+                                   }.to(fixture('sobject/query_success_response'))
+      end
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 6.2.0
+  version: 6.2.2
 platform: ruby
 authors:
 - Tim Rogers
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-01-18 00:00:00.000000000 Z
+date: 2023-03-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -293,7 +293,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.1
+rubygems_version: 3.4.7
 signing_key:
 specification_version: 4
 summary: A lightweight Ruby client for the Salesforce REST API