restforce 6.2.0 → 6.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 7f7a29ac5ff461f9db1f386570aceebfa30244ec519ccd26320e6255cdaddc57
-  data.tar.gz: 556b7407db043fe2a3d5e9fe9183be767693cacacd31fe8ac492aca9fd195194
+  metadata.gz: 5b88661434383f16571c2b240a9c2482035058a34adadfe39a86b4fecb7382ca
+  data.tar.gz: bb4ac026f9b7fbd43f7b5237760e341d9d351c5433ca19009daa24794be251f0
 SHA512:
-  metadata.gz: '0585185aed0e16fea289b78ccb16122306186901195daa5d2b323dedcbb4999e5760910e5d8ceb7966424b8e4d636d20c92f61bcc283f1fe75de3857ca35d68b'
-  data.tar.gz: b17650d7d7984b0b412c2c678a49d61d8d69fc961454aad313c4a8c1ed25ea49f04d68b1d658bb4464b4514f81118f1e69392465a541f0431571d60096e9d9c0
+  metadata.gz: da66afd00a69c078e3883f76ae0039d2742911de7b0ca8cb6b14b15801695973a25deec7e71fede838d9193a60224510eee625b72b06c827d6f0467111757023
+  data.tar.gz: 86cad2e9fecc5610dae221bdec91a8a1868b9333d7aa552b5fb21af928352c73cad50ea64f63f26cd61ea50048784f5c3dad20b04d798c70aee2f0295c1721bd

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+# 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/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.1'
 
 And then execute:
 

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.1'
 end

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.1
 platform: ruby
 authors:
 - Tim Rogers