restforce 5.0.6 → 6.2.1

data/spec/unit/concerns/composite_api_spec.rb

@@ -0,0 +1,169 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restforce::Concerns::CompositeAPI do
+  let(:endpoint) { 'composite' }
+
+  before do
+    client.should_receive(:options).and_return(api_version: 38.0)
+  end
+
+  shared_examples_for 'composite requests' do
+    it '#create' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { compositeRequest: [
+          {
+            method: 'POST',
+            url: '/services/data/v38.0/sobjects/Object',
+            body: { name: 'test' },
+            referenceId: 'create_ref'
+          }
+        ], allOrNone: all_or_none, collateSubrequests: false }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.create('Object', 'create_ref', name: 'test')
+      end
+    end
+
+    it '#update' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { compositeRequest: [
+          {
+            method: 'PATCH',
+            url: '/services/data/v38.0/sobjects/Object/123',
+            body: { name: 'test' },
+            referenceId: 'update_ref'
+          }
+        ], allOrNone: all_or_none, collateSubrequests: false }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.update('Object', 'update_ref', id: '123', name: 'test')
+      end
+    end
+
+    it '#destroy' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { compositeRequest: [
+          {
+            method: 'DELETE',
+            url: '/services/data/v38.0/sobjects/Object/123',
+            referenceId: 'destroy_ref'
+          }
+        ], allOrNone: all_or_none, collateSubrequests: false }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.destroy('Object', 'destroy_ref', '123')
+      end
+    end
+
+    it '#upsert' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { compositeRequest: [
+          {
+            method: 'PATCH',
+            url: '/services/data/v38.0/sobjects/Object/extIdField__c/456',
+            body: { name: 'test' },
+            referenceId: 'upsert_ref'
+          }
+        ], allOrNone: all_or_none, collateSubrequests: false }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.upsert('Object', 'upsert_ref', 'extIdField__c',
+                           extIdField__c: '456', name: 'test')
+      end
+    end
+
+    it 'multiple subrequests' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { compositeRequest: [
+          {
+            method: 'POST',
+            url: '/services/data/v38.0/sobjects/Object',
+            body: { name: 'test' },
+            referenceId: 'create_ref'
+          },
+          {
+            method: 'PATCH',
+            url: '/services/data/v38.0/sobjects/Object/123',
+            body: { name: 'test' },
+            referenceId: 'update_ref'
+          },
+          {
+            method: 'DELETE',
+            url: '/services/data/v38.0/sobjects/Object/123',
+            referenceId: 'destroy_ref'
+          }
+        ], allOrNone: all_or_none, collateSubrequests: false }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.create('Object', 'create_ref', name: 'test')
+        subrequests.update('Object', 'update_ref', id: '123', name: 'test')
+        subrequests.destroy('Object', 'destroy_ref', '123')
+      end
+    end
+
+    it 'fails if more than 25 requests' do
+      expect do
+        client.send(method) do |subrequests|
+          26.times do |i|
+            subrequests.upsert('Object', "upsert_ref_#{i}", 'extIdField__c',
+                               extIdField__c: '456', name: 'test')
+          end
+        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
+    let(:method) { :composite }
+    let(:all_or_none) { false }
+    let(:response) { double('Faraday::Response', body: { 'compositeResponse' => [] }) }
+    it_behaves_like 'composite requests'
+  end
+
+  describe '#composite!' do
+    let(:method) { :composite! }
+    let(:all_or_none) { true }
+    let(:response) do
+      double('Faraday::Response', body: { 'compositeResponse' => [] })
+    end
+    it_behaves_like 'composite requests'
+  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/concerns/streaming_spec.rb

@@ -13,10 +13,10 @@ describe Restforce::Concerns::Streaming, event_machine: true do
     it 'subscribes to the topics with faye' do
       faye_double.
         should_receive(:subscribe).
-        with(channels, &subscribe_block)
+        with(channels)
       client.stub faye: faye_double
 
-      client.subscription(channels, &subscribe_block)
+      client.subscription(channels)
     end
 
     context "replay_handlers" do
@@ -87,7 +87,7 @@ describe Restforce::Concerns::Streaming, event_machine: true do
       end
 
       it 'connects to the streaming api' do
-        client.stub authenticate!: OpenStruct.new(access_token: 'secret2')
+        client.stub authenticate!: double(access_token: 'secret2')
         faye_double = double('Faye::Client')
         Faye::Client.
           should_receive(:new).
@@ -110,7 +110,7 @@ describe Restforce::Concerns::Streaming, event_machine: true do
     end
   end
 
-  describe Restforce::Concerns::Streaming::ReplayExtension do
+  describe "ReplayExtension" do
     let(:handlers) { {} }
     let(:extension) { Restforce::Concerns::Streaming::ReplayExtension.new(handlers) }
 

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' }
@@ -76,7 +76,7 @@ describe Restforce do
     subject { Restforce.log? }
 
     context 'by default' do
-      it { should be_false }
+      it { should be false }
     end
   end
 

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

@@ -17,15 +17,23 @@ describe Restforce::Middleware::Authentication::JWTBearer do
     let(:success_request) 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))
+              "assertion=abc1234567890"
+      ).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))
+              "assertion=abc1234567890"
+      ).to_return(
+        status: 400,
+        body: fixture(:refresh_error_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
   end
 
@@ -47,15 +55,23 @@ describe Restforce::Middleware::Authentication::JWTBearer do
       let(:success_request) 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))
+                "assertion=abc1234567890"
+        ).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))
+                "assertion=abc1234567890"
+        ).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

@@ -17,15 +17,23 @@ describe Restforce::Middleware::Authentication::Password do
     let(:success_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: 200, body: fixture(:auth_success_response))
+              "&username=foo&password=barsecurity_token"
+      ).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))
+              "&username=foo&password=barsecurity_token"
+      ).to_return(
+        status: 400,
+        body: fixture(:auth_error_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
   end
 

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

@@ -15,15 +15,23 @@ describe Restforce::Middleware::Authentication::Token do
     let(:success_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: 200, body: fixture(:auth_success_response))
+              "client_id=client_id&client_secret=client_secret"
+      ).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))
+              "client_id=client_id&client_secret=client_secret"
+      ).to_return(
+        status: 400,
+        body: fixture(:refresh_error_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
   end
 end

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

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
 
@@ -58,11 +102,11 @@ describe Restforce::Middleware::Gzip do
         env[:response_headers]['Content-Encoding'] = 'gzip'
       end
 
-      it { should be_true }
+      it { should be true }
     end
 
     context 'when not gzipped' do
-      it { should be_false }
+      it { should be false }
     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/middleware/raise_error_spec.rb

@@ -14,8 +14,10 @@ describe Restforce::Middleware::RaiseError do
       let(:status) { 404 }
 
       it 'raises Restforce::NotFoundError' do
-        expect { on_complete }.to raise_error Restforce::NotFoundError,
-                                              'INVALID_FIELD: error_message'
+        expect { on_complete }.to raise_error do |error|
+          expect(error).to be_a Restforce::NotFoundError
+          expect(error.message).to start_with("INVALID_FIELD: error_message")
+        end
       end
 
       it 'raises an error that inherits from Faraday::ResourceNotFound' do
@@ -40,8 +42,10 @@ describe Restforce::Middleware::RaiseError do
       let(:status) { 400 }
 
       it "raises an error derived from the response's errorCode" do
-        expect { on_complete }.to raise_error Restforce::ErrorCode::InvalidField,
-                                              'INVALID_FIELD: error_message'
+        expect { on_complete }.to raise_error do |error|
+          expect(error).to be_a Restforce::ErrorCode::InvalidField
+          expect(error.message).to start_with("INVALID_FIELD: error_message")
+        end
       end
 
       it 'raises an error that inherits from Faraday::ClientError' do
@@ -53,8 +57,10 @@ describe Restforce::Middleware::RaiseError do
       let(:status) { 401 }
 
       it 'raises Restforce::UnauthorizedError' do
-        expect { on_complete }.to raise_error Restforce::UnauthorizedError,
-                                              'INVALID_FIELD: error_message'
+        expect { on_complete }.to raise_error do |error|
+          expect(error).to be_a Restforce::UnauthorizedError
+          expect(error.message).to start_with("INVALID_FIELD: error_message")
+        end
       end
     end
 
@@ -76,13 +82,17 @@ describe Restforce::Middleware::RaiseError do
       let(:status) { 400 }
 
       it 'raises a generic Restforce::ResponseError' do
-        expect { on_complete }.to raise_error Restforce::ResponseError,
-                                              "(error code missing): #{body}"
+        expect { on_complete }.to raise_error do |error|
+          expect(error).to be_a Restforce::ResponseError
+          expect(error.message).to start_with("(error code missing): An error occured")
+        end
       end
 
       it 'raises an error that inherits from Faraday::ClientError' do
-        expect { on_complete }.to raise_error Faraday::ClientError,
-                                              "(error code missing): #{body}"
+        expect { on_complete }.to raise_error do |error|
+          expect(error).to be_a Faraday::ClientError
+          expect(error.message).to start_with("(error code missing): An error occured")
+        end
       end
     end