restforce 6.1.0 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 00cd20b461c775bcec8084de1916659fbf3d6f9328624daa79dbfad47f48efbe
-  data.tar.gz: 6de0e7734bd1a53d088107effd4ed737f8eb20d1e3c51292f098f05195f9b0b9
+  metadata.gz: 5b88661434383f16571c2b240a9c2482035058a34adadfe39a86b4fecb7382ca
+  data.tar.gz: bb4ac026f9b7fbd43f7b5237760e341d9d351c5433ca19009daa24794be251f0
 SHA512:
-  metadata.gz: d26f78e108cd25d6358720652bcd09d125e1a91caef34c85ab2a4e033763a7a2aa4a7dada91ff393c43dc433c9c1cd68d58c6b918c88c103c2f45cd50030f1b1
-  data.tar.gz: 930d88396329214bcf344c0fbb11210b716c3db66a645c6c4369598095d36f66a0cc6486c597fd4ebe8f225a9bd5fac0150b76a4b3f95922b9f7f14ed2ef6df3
+  metadata.gz: da66afd00a69c078e3883f76ae0039d2742911de7b0ca8cb6b14b15801695973a25deec7e71fede838d9193a60224510eee625b72b06c827d6f0467111757023
+  data.tar.gz: 86cad2e9fecc5610dae221bdec91a8a1868b9333d7aa552b5fb21af928352c73cad50ea64f63f26cd61ea50048784f5c3dad20b04d798c70aee2f0295c1721bd

data/.github/workflows/build.yml

@@ -6,7 +6,7 @@ jobs:
     strategy:
       fail-fast: false
       matrix:
-        ruby_version: ['2.7', '3.0', '3.1', '3.2.0-preview1']
+        ruby_version: ['2.7', '3.0', '3.1', '3.2']
     steps:
       - name: Checkout code
         uses: actions/checkout@v3

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']
+        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']
     env:
       FARADAY_VERSION: ~> ${{ matrix.faraday_version }}
     steps:

data/CHANGELOG.md

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

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 gemspec
 
-faraday_version = ENV.fetch('FARADAY_VERSION', '~> 1.8.0')
+faraday_version = ENV.fetch('FARADAY_VERSION', '~> 2.7.3')
 
 # Enable us to explicitly pick a Faraday version when running tests
 gem 'faraday', faraday_version
@@ -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.39.0'
-gem 'simplecov', '~> 0.21.2'
+gem 'rubocop', '~> 1.43.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.1.0'
+    gem 'restforce', '~> 6.2.1'
 
 And then execute:
 

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

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.1.0'
+  VERSION = '6.2.1'
 end

data/lib/restforce.rb

@@ -49,7 +49,6 @@ module Restforce
   UnauthorizedError   = Class.new(Faraday::ClientError)
   APIVersionError     = Class.new(Error)
   BatchAPIError       = Class.new(Error)
-  CompositeAPIError   = Class.new(Error)
 
   # Inherit from Faraday::ResourceNotFound for backwards-compatibility
   # Consumers of this library that rescue and handle Faraday::ResourceNotFound
@@ -60,6 +59,7 @@ module Restforce
   # Consumers of this library that rescue and handle Faraday::ClientError
   # can continue to do so.
   ResponseError       = Class.new(Faraday::ClientError)
+  CompositeAPIError   = Class.new(ResponseError)
   MatchesMultipleError= Class.new(ResponseError)
   EntityTooLargeError = Class.new(ResponseError)
 

data/restforce.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.7'
 
-  gem.add_dependency 'faraday', '< 2.7.0', '>= 1.1.0'
+  gem.add_dependency 'faraday', '< 2.8.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', '< 4.0.0'

data/spec/integration/abstract_client_spec.rb

@@ -144,7 +144,10 @@ shared_examples_for Restforce::AbstractClient do
   describe '.update' do
     context 'with missing Id' do
       subject { lambda { client.update('Account', Name: 'Foobar') } }
-      it { should raise_error ArgumentError, 'ID field missing from provided attributes' }
+      it {
+        expect { subject.call }.
+          to raise_error ArgumentError, 'ID field missing from provided attributes'
+      }
     end
 
     context 'with invalid Id' do
@@ -248,7 +251,7 @@ shared_examples_for Restforce::AbstractClient do
                status: 404
 
       subject { lambda { destroy! } }
-      it { should raise_error Faraday::ResourceNotFound }
+      it { expect { subject.call }.to raise_error Faraday::ResourceNotFound }
     end
 
     context 'with success' do
@@ -431,7 +434,7 @@ shared_examples_for Restforce::AbstractClient do
       end
 
       subject { lambda { client.query('SELECT some, fields FROM object') } }
-      it { should raise_error Restforce::UnauthorizedError }
+      it { expect { subject.call }.to raise_error Restforce::UnauthorizedError }
     end
   end
 

data/spec/unit/concerns/base_spec.rb

@@ -28,7 +28,7 @@ describe Restforce::Concerns::Base do
 
   describe '.options' do
     subject { lambda { client.options } }
-    it { should_not raise_error }
+    it { expect { subject.call }.not_to raise_error }
   end
 
   describe '.instance_url' do

data/spec/unit/concerns/composite_api_spec.rb

@@ -123,6 +123,32 @@ describe Restforce::Concerns::CompositeAPI do
         end
       end.to raise_error(ArgumentError)
     end
+
+    it 'has response in CompositeAPIError' do
+      response = double('Faraday::Response',
+                        body: { 'compositeResponse' =>
+                                  [{ 'httpStatusCode' => 400,
+                                     'body' => [{ 'errorCode' =>
+                                                    'DUPLICATE_VALUE' }] }] })
+      client.
+        should_receive(:api_post).
+        with(endpoint, { compositeRequest: [
+          {
+            method: 'POST',
+            url: '/services/data/v38.0/sobjects/Object',
+            body: { name: 'test' },
+            referenceId: 'create_ref'
+          }
+        ], allOrNone: true, collateSubrequests: false }.to_json).
+        and_return(response)
+      arg = method == :composite ? { all_or_none: true } : {}
+      expect do
+        client.send(method, **arg) do |subrequests|
+          subrequests.create('Object', 'create_ref', name: 'test')
+        end
+      end.to raise_error(an_instance_of(Restforce::CompositeAPIError).
+        and(having_attributes(response: response)))
+    end
   end
 
   describe '#composite' do

data/spec/unit/middleware/authentication_spec.rb

@@ -15,7 +15,7 @@ describe Restforce::Middleware::Authentication do
 
   describe '.authenticate!' do
     subject { lambda { middleware.authenticate! } }
-    it      { should raise_error NotImplementedError }
+    it      { expect { subject.call }.to raise_error NotImplementedError }
   end
 
   describe '.call' do
@@ -26,7 +26,7 @@ describe Restforce::Middleware::Authentication do
         app.should_receive(:call).once
       end
 
-      it { should_not raise_error }
+      it { expect { subject.call }.not_to raise_error }
     end
 
     context 'when an exception is thrown' do
@@ -37,7 +37,7 @@ describe Restforce::Middleware::Authentication do
           and_raise(Restforce::UnauthorizedError.new('something bad'))
       end
 
-      it { should raise_error Restforce::UnauthorizedError }
+      it { expect { subject.call }.to raise_error Restforce::UnauthorizedError }
     end
   end
 

data/spec/unit/middleware/authorization_spec.rb

@@ -8,6 +8,10 @@ describe Restforce::Middleware::Authorization do
   describe '.call' do
     subject { lambda { middleware.call(env) } }
 
-    it { should change { env[:request_headers]['Authorization'] }.to eq 'OAuth token' }
+    it {
+      expect { subject.call }.to change {
+                                   env[:request_headers]['Authorization']
+                                 }.to eq 'OAuth token'
+    }
   end
 end

data/spec/unit/middleware/custom_headers_spec.rb

@@ -9,13 +9,17 @@ describe Restforce::Middleware::CustomHeaders do
     context 'when :request_headers are a Hash' do
       let(:options) { { request_headers: { 'x-test-header' => 'Test Value' } } }
 
-      it { should change { env[:request_headers]['x-test-header'] }.to eq 'Test Value' }
+      it {
+        expect { subject.call }.to change {
+                                     env[:request_headers]['x-test-header']
+                                   }.to eq 'Test Value'
+      }
     end
 
     context 'when :request_headers are not a Hash' do
       let(:options) { { request_headers: 'bad header' } }
 
-      it { should_not(change { env[:request_headers] }) }
+      it { expect { subject.call }.not_to(change { env[:request_headers] }) }
     end
   end
 end

data/spec/unit/middleware/gzip_spec.rb

@@ -17,29 +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
-      should 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 { should_not(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 { should(change { env[:request_headers]['Accept-Encoding'] }.to('gzip')) }
+      it 'does not decompress the body' do
+        expect { subject.call }.to change {
+                                     env[:body]
+                                   }.to(fixture('sobject/query_success_response'))
+      end
     end
   end
 

data/spec/unit/middleware/instance_url_spec.rb

@@ -11,7 +11,7 @@ describe Restforce::Middleware::InstanceURL do
         client.stub_chain :connection, url_prefix: URI.parse('http:/')
       end
 
-      it { should raise_error Restforce::UnauthorizedError }
+      it { expect { subject.call }.to raise_error Restforce::UnauthorizedError }
     end
 
     context 'when the instance url is set' do
@@ -20,7 +20,7 @@ describe Restforce::Middleware::InstanceURL do
         app.should_receive(:call).once
       end
 
-      it { should_not raise_error }
+      it { expect { subject.call }.not_to raise_error }
     end
   end
 end

data/spec/unit/middleware/logger_spec.rb

@@ -16,6 +16,6 @@ describe Restforce::Middleware::Logger do
       logger.should_receive(:debug).with('response')
     end
 
-    it { should_not raise_error }
+    it { expect { subject.call }.not_to raise_error }
   end
 end

data/spec/unit/sobject_spec.rb

@@ -48,7 +48,11 @@ describe Restforce::SObject do
       subject(:send_method) { lambda { sobject.send(method) } }
 
       context 'when an Id was not queried' do
-        it { should raise_error ArgumentError, /need to query the Id for the record/ }
+        it {
+          expect do
+            subject.call
+          end.to raise_error ArgumentError, /need to query the Id for the record/
+        }
       end
 
       context 'when an Id is present' do
@@ -57,7 +61,7 @@ describe Restforce::SObject do
           client.should_receive(receiver)
         end
 
-        it { should_not raise_error }
+        it { expect { subject.call }.not_to raise_error }
       end
     end
   end
@@ -69,7 +73,7 @@ describe Restforce::SObject do
       client.should_receive(:describe).with('Whizbang')
     end
 
-    it { should_not raise_error }
+    it { expect { subject.call }.not_to raise_error }
   end
 
   describe '.describe_layouts' do
@@ -80,13 +84,13 @@ describe Restforce::SObject do
       client.should_receive(:describe_layouts).with('Whizbang', layout_id)
     end
 
-    it { should_not raise_error }
+    it { expect { subject.call }.not_to raise_error }
 
     context 'when a layout Id is specified' do
       let(:layout_id) { '012E0000000RHEp' }
       subject { lambda { sobject.describe_layouts(layout_id) } }
 
-      it { should_not raise_error }
+      it { expect { subject.call }.not_to raise_error }
     end
   end
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 6.1.0
+  version: 6.2.1
 platform: ruby
 authors:
 - Tim Rogers
 - Eric J. Holmes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-11-18 00:00:00.000000000 Z
+date: 2023-01-18 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,7 +17,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.7.0
+        version: 2.8.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
@@ -278,7 +278,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
@@ -293,8 +293,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.6
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: A lightweight Ruby client for the Salesforce REST API
 test_files: []