restforce 4.2.1 → 5.2.4

data/spec/unit/collection_spec.rb

@@ -13,7 +13,7 @@ describe Restforce::Collection do
 
       it                   { should respond_to :each }
       its(:size)           { should eq 1 }
-      its(:has_next_page?) { should be_false }
+      its(:has_next_page?) { should be false }
       it                   { should have_client client }
       its(:page_size)      { should eq 1 }
 
@@ -56,10 +56,46 @@ describe Restforce::Collection do
           should(be_all { |page| expect(page).to be_a Restforce::Collection })
         end
 
-        its(:has_next_page?) { should be_true }
+        its(:has_next_page?) { should be true }
         it { should(be_all { |record| expect(record).to be_a Restforce::SObject }) }
         its(:next_page)      { should be_a Restforce::Collection }
       end
     end
   end
+
+  describe '#size' do
+    subject(:size) do
+      described_class.new(JSON.parse(fixture(sobject_fixture)), client).size
+    end
+
+    context 'when the query response contains a totalSize field' do
+      let(:sobject_fixture) { 'sobject/query_success_response' }
+
+      it { should eq 1 }
+    end
+
+    context 'when the query response contains a size field' do
+      let(:sobject_fixture) { 'sobject/list_view_results_success_response' }
+
+      it { should eq 1 }
+    end
+  end
+
+  describe '#empty?' do
+    subject(:empty?) do
+      described_class.new(JSON.parse(fixture(sobject_fixture)), client).empty?
+    end
+
+    context 'with size 1' do
+      let(:sobject_fixture) { 'sobject/query_success_response' }
+
+      it { should be false }
+    end
+
+    context 'with size 0' do
+      let(:sobject_fixture) { 'sobject/query_empty_response' }
+
+      it { should be true }
+    end
+  end
 end

data/spec/unit/concerns/api_spec.rb

@@ -11,7 +11,7 @@ describe Restforce::Concerns::API do
     it 'returns the user info from identity url' do
       identity_url = double('identity_url')
       response.body.stub(:identity).and_return(identity_url)
-      client.should_receive(:api_get).with.and_return(response)
+      client.should_receive(:api_get).with(no_args).and_return(response)
 
       identity = double('identity')
       identity.stub(:body).and_return(identity)
@@ -268,7 +268,7 @@ describe Restforce::Concerns::API do
 
       it "delegates to :#{method}!" do
         client.should_receive(:"#{method}!").
-          with(*args).
+          with(no_args).
           and_return(response)
         expect(result).to eq response
       end
@@ -276,7 +276,7 @@ describe Restforce::Concerns::API do
       it 'rescues exceptions' do
         [Faraday::ClientError].each do |exception_klass|
           client.should_receive(:"#{method}!").
-            with(*args).
+            with(no_args).
             and_raise(exception_klass.new(nil))
           expect(result).to eq false
         end
@@ -314,7 +314,7 @@ describe Restforce::Concerns::API do
         it 'sends an HTTP PATCH, and returns true' do
           client.should_receive(:api_patch).
             with('sobjects/Whizbang/1234', StageName: "Call Scheduled")
-          expect(result).to be_true
+          expect(result).to be true
         end
       end
 
@@ -324,7 +324,7 @@ describe Restforce::Concerns::API do
         it 'sends an HTTP PATCH, and encodes the ID' do
           client.should_receive(:api_patch).
             with('sobjects/Whizbang/1234%2F%3Fabc', StageName: "Call Scheduled")
-          expect(result).to be_true
+          expect(result).to be true
         end
       end
 
@@ -348,7 +348,7 @@ describe Restforce::Concerns::API do
           client.should_receive(:api_patch).
             with('sobjects/Whizbang/External_ID__c/1234', {}).
             and_return(response)
-          expect(result).to be_true
+          expect(result).to be true
         end
 
         context 'and the response body is a string' do
@@ -357,7 +357,7 @@ describe Restforce::Concerns::API do
             client.should_receive(:api_patch).
               with('sobjects/Whizbang/External_ID__c/1234', {}).
               and_return(response)
-            expect(result).to be_true
+            expect(result).to be true
           end
         end
       end
@@ -431,7 +431,7 @@ describe Restforce::Concerns::API do
           client.should_receive(:api_patch).
             with('sobjects/Whizbang/External_ID__c/%E3%81%82', {}).
             and_return(response)
-          expect(result).to be_true
+          expect(result).to be true
         end
       end
     end
@@ -448,7 +448,7 @@ describe Restforce::Concerns::API do
           client.should_receive(:api_patch).
             with('sobjects/Whizbang/External_ID__c/1234', {}).
             and_return(response)
-          expect(result).to be_true
+          expect(result).to be true
         end
       end
     end
@@ -462,7 +462,7 @@ describe Restforce::Concerns::API do
     it 'sends and HTTP delete, and returns true' do
       client.should_receive(:api_delete).
         with('sobjects/Whizbang/1234')
-      expect(result).to be_true
+      expect(result).to be true
     end
 
     context 'when the id field contains special characters' do
@@ -471,7 +471,7 @@ describe Restforce::Concerns::API do
       it 'sends an HTTP delete, and encodes the ID' do
         client.should_receive(:api_delete).
           with('sobjects/Whizbang/1234%2F%3Fabc')
-        expect(result).to be_true
+        expect(result).to be true
       end
     end
   end

data/spec/unit/concerns/authentication_spec.rb

@@ -80,11 +80,11 @@ describe Restforce::Concerns::Authentication do
           client_secret: 'secret' }
       end
 
-      it { should be_true }
+      it { should be_truthy }
     end
 
     context 'when username and password options are not provided' do
-      it { should_not be_true }
+      it { should_not be_truthy }
     end
   end
 
@@ -103,11 +103,11 @@ describe Restforce::Concerns::Authentication do
           client_secret: 'secret' }
       end
 
-      it { should be_true }
+      it { should be_truthy }
     end
 
     context 'when oauth options are not provided' do
-      it { should_not be_true }
+      it { should_not be true }
     end
   end
 
@@ -128,11 +128,11 @@ describe Restforce::Concerns::Authentication do
           client_id: 'client' }
       end
 
-      it { should be_true }
+      it { should be_truthy }
     end
 
     context 'when jwt options are not provided' do
-      it { should_not be_true }
+      it { should_not be true }
     end
   end
 end

data/spec/unit/concerns/caching_spec.rb

@@ -28,4 +28,30 @@ describe Restforce::Concerns::Caching do
       end
     end
   end
+
+  describe '.with_caching' do
+    let(:options) { double('Options') }
+
+    before do
+      client.stub options: options
+    end
+
+    it 'runs the block with caching enabled' do
+      options.should_receive(:[]=).with(:use_cache, true)
+      options.should_receive(:[]=).with(:use_cache, false)
+      expect { |b| client.with_caching(&b) }.to yield_control
+    end
+
+    context 'when an exception is raised' do
+      it 'ensures the :use_cache is set to false' do
+        options.should_receive(:[]=).with(:use_cache, true)
+        options.should_receive(:[]=).with(:use_cache, false)
+        expect {
+          client.with_caching do
+            raise 'Foo'
+          end
+        }.to raise_error 'Foo'
+      end
+    end
+  end
 end

data/spec/unit/concerns/composite_api_spec.rb

@@ -0,0 +1,143 @@
+# 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
+  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,9 +73,9 @@ describe Restforce::Concerns::Connection do
         Restforce.stub(log?: true)
       end
 
-      it "must always be used last before the Faraday Adapter" do
+      it "must always be used as the last handler" do
         client.middleware.handlers.reverse.index(Restforce::Middleware::Logger).
-          should eq 1
+          should eq 0
       end
     end
   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

@@ -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/error_code_spec.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restforce::ErrorCode do
+  describe "mapping of error codes to classes" do
+    subject(:error_exception_classes) { described_class::ERROR_EXCEPTION_CLASSES }
+
+    let(:exception_classes) do
+      described_class.constants.
+        map { |constant_name| described_class.const_get(constant_name) }.
+        select { |constant| constant.is_a?(Class) }
+    end
+
+    it "maps all defined exception classes to an error code" do
+      exception_classes.each do |exception_class|
+        expect(error_exception_classes.values).to include(exception_class)
+      end
+    end
+
+    it "maps all error codes to a defined exception class" do
+      error_exception_classes.each_value do |mapped_exception_class|
+        expect(exception_classes).to include(mapped_exception_class)
+      end
+    end
+  end
+
+  describe '.get_exception_class' do
+    context 'when a non-existent error code is looked up' do
+      let(:new_error_code) { 'ANOTHER_NEW_ERROR_CODE' }
+      subject              { described_class.get_exception_class(new_error_code) }
+
+      it { should be Restforce::ResponseError }
+
+      it 'outputs a warning' do
+        expect(Warning).to receive(:warn)
+        subject
+      end
+    end
+
+    context 'when a known error code is looked up' do
+      let(:existing_error_code) { "ALL_OR_NONE_OPERATION_ROLLED_BACK" }
+      let(:existing_error)      { described_class::AllOrNoneOperationRolledBack }
+
+      subject do
+        described_class.get_exception_class(existing_error_code)
+      end
+
+      it { should < Restforce::ResponseError }
+
+      it 'returns existing error' do
+        should be(existing_error)
+      end
+
+      it 'does not output a warning' do
+        expect(Warning).to_not receive(:warn)
+        subject
+      end
+    end
+  end
+end

data/spec/unit/mash_spec.rb

@@ -33,6 +33,11 @@ describe Restforce::Mash do
         let(:input) { { 'attributes' => { 'type' => 'Document' } } }
         it { should eq Restforce::Document }
       end
+
+      context 'when the attributes value is nil' do
+        let(:input) { { 'attributes' => nil } }
+        it { should eq Restforce::SObject }
+      end
     end
 
     context 'else' do

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

@@ -17,14 +17,14 @@ 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"
+              "assertion=abc1234567890"
       ).to_return(status: 200, body: fixture(:auth_success_response))
     end
 
     let(:fail_request) do
       stub_login_request(
         body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
-             "assertion=abc1234567890"
+              "assertion=abc1234567890"
       ).to_return(status: 400, body: fixture(:refresh_error_response))
     end
   end
@@ -47,14 +47,14 @@ 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"
+                "assertion=abc1234567890"
         ).to_return(status: 200, body: fixture(:auth_success_response))
       end
 
       let(:fail_request) do
         stub_login_request(
           body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
-            "assertion=abc1234567890"
+                "assertion=abc1234567890"
         ).to_return(status: 400, body: fixture(:refresh_error_response))
       end
     end

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

@@ -17,14 +17,14 @@ 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"
+              "&username=foo&password=barsecurity_token"
       ).to_return(status: 200, body: fixture(:auth_success_response))
     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"
+              "&username=foo&password=barsecurity_token"
       ).to_return(status: 400, body: fixture(:auth_error_response))
     end
   end

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

@@ -15,14 +15,14 @@ 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"
+              "client_id=client_id&client_secret=client_secret"
       ).to_return(status: 200, body: fixture(:auth_success_response))
     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"
+              "client_id=client_id&client_secret=client_secret"
       ).to_return(status: 400, body: fixture(:refresh_error_response))
     end
   end

data/spec/unit/middleware/authentication_spec.rb

@@ -8,7 +8,9 @@ describe Restforce::Middleware::Authentication do
       proxy_uri: 'https://not-a-real-site.com',
       authentication_retries: retries,
       adapter: :net_http,
+      # rubocop:disable Naming/VariableNumber
       ssl: { version: :TLSv1_2 } }
+    # rubocop:enable Naming/VariableNumber
   end
 
   describe '.authenticate!' do
@@ -57,10 +59,10 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson,
-                         Faraday::Adapter::NetHttp
+          should include FaradayMiddleware::ParseJson
         }
         its(:handlers) { should_not include Restforce::Middleware::Logger }
+        its(:adapter) { should eq Faraday::Adapter::NetHttp }
       end
 
       context 'with logging enabled' do
@@ -70,8 +72,9 @@ describe Restforce::Middleware::Authentication do
 
         its(:handlers) {
           should include FaradayMiddleware::ParseJson,
-                         Restforce::Middleware::Logger, Faraday::Adapter::NetHttp
+                         Restforce::Middleware::Logger
         }
+        its(:adapter) { should eq Faraday::Adapter::NetHttp }
       end
 
       context 'with specified adapter' do
@@ -80,13 +83,16 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson, Faraday::Adapter::Typhoeus
+          should include FaradayMiddleware::ParseJson
         }
+        its(:adapter) { should eq Faraday::Adapter::Typhoeus }
       end
     end
 
     it "should have SSL config set" do
+      # rubocop:disable Naming/VariableNumber
       connection.ssl[:version].should eq(:TLSv1_2)
+      # rubocop:enable Naming/VariableNumber
     end
   end
 
@@ -94,7 +100,7 @@ describe Restforce::Middleware::Authentication do
     context 'when response.body is present' do
       let(:response) {
         Faraday::Response.new(
-          body: { 'error' => 'error', 'error_description' => 'description' },
+          response_body: { 'error' => 'error', 'error_description' => 'description' },
           status: 401
         )
       }

data/spec/unit/middleware/gzip_spec.rb

@@ -58,11 +58,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