restforce 5.0.5 → 5.2.0

data/spec/integration/abstract_client_spec.rb

@@ -129,18 +129,15 @@ shared_examples_for Restforce::AbstractClient do
         JSON.parse(fixture('sobject/delete_error_response'))
       end
 
-      subject do
-        lambda do
-          client.update!('Account', Id: '001D000000INjVe', Name: 'Foobar')
-        end
-      end
+      it "raises Faraday::ResourceNotFound" do
+        expect { client.update!('Account', Id: '001D000000INjVe', Name: 'Foobar') }.
+          to raise_error do |exception|
+            expect(exception).to be_a(Faraday::ResourceNotFound)
 
-      it {
-        should raise_error(
-          Faraday::ResourceNotFound,
-          "#{error.first['errorCode']}: #{error.first['message']}"
-        )
-      }
+            expect(exception.message).
+              to start_with("#{error.first['errorCode']}: #{error.first['message']}")
+          end
+      end
     end
   end
 
@@ -158,7 +155,7 @@ shared_examples_for Restforce::AbstractClient do
                fixture: 'sobject/delete_error_response'
 
       subject { client.update('Account', Id: '001D000000INjVe', Name: 'Foobar') }
-      it { should be_false }
+      it { should be false }
     end
 
     context 'with success' do
@@ -172,7 +169,7 @@ shared_examples_for Restforce::AbstractClient do
             client.update('Account', key => '001D000000INjVe', :Name => 'Foobar')
           end
 
-          it { should be_true }
+          it { should be true }
         end
       end
     end
@@ -191,7 +188,7 @@ shared_examples_for Restforce::AbstractClient do
                                                    Name: 'Foobar')
         end
 
-        it { should be_true }
+        it { should be true }
       end
 
       context 'with string external Id key' do
@@ -200,7 +197,7 @@ shared_examples_for Restforce::AbstractClient do
                                                    'Name' => 'Foobar')
         end
 
-        it { should be_true }
+        it { should be true }
       end
     end
 
@@ -257,14 +254,14 @@ shared_examples_for Restforce::AbstractClient do
     context 'with success' do
       requests 'sobjects/Account/001D000000INjVe', method: :delete
 
-      it { should be_true }
+      it { should be true }
     end
 
     context 'with a space in the id' do
       subject(:destroy!) { client.destroy!('Account', '001D000000 INjVe') }
       requests 'sobjects/Account/001D000000%20INjVe', method: :delete
 
-      it { should be_true }
+      it { should be true }
     end
   end
 
@@ -277,13 +274,13 @@ shared_examples_for Restforce::AbstractClient do
                method: :delete,
                status: 404
 
-      it { should be_false }
+      it { should be false }
     end
 
     context 'with success' do
       requests 'sobjects/Account/001D000000INjVe', method: :delete
 
-      it { should be_true }
+      it { should be true }
     end
   end
 
@@ -368,8 +365,8 @@ shared_examples_for Restforce::AbstractClient do
       before do
         @request = stub_login_request(
           with_body: "grant_type=password&client_id=client_id" \
-                        "&client_secret=client_secret&username=foo" \
-                        "&password=barsecurity_token"
+                     "&client_secret=client_secret&username=foo" \
+                     "&password=barsecurity_token"
         ).to_return(status: 200, body: fixture(:auth_success_response))
       end
 
@@ -420,8 +417,8 @@ shared_examples_for Restforce::AbstractClient do
 
         @query_request = stub_login_request(
           with_body: "grant_type=password&client_id=client_id" \
-                        "&client_secret=client_secret&username=foo&" \
-                        "password=barsecurity_token"
+                     "&client_secret=client_secret&username=foo&" \
+                     "password=barsecurity_token"
         ).to_return(status: 200, body: fixture(:auth_success_response))
       end
 
@@ -437,15 +434,15 @@ shared_examples_for Restforce::AbstractClient do
       @query = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object').
                with(headers: { 'Authorization' => "OAuth #{oauth_token}" }).
                to_return(status: 401,
-                  body: fixture('expired_session_response'),
-                  headers: { 'Content-Type' => 'application/json' }).then.
+                         body: fixture('expired_session_response'),
+                         headers: { 'Content-Type' => 'application/json' }).then.
                to_return(status: 200,
-                  body: fixture('sobject/query_success_response'),
-                  headers: { 'Content-Type' => 'application/json' })
+                         body: fixture('sobject/query_success_response'),
+                         headers: { 'Content-Type' => 'application/json' })
 
       @login = stub_login_request(
         with_body: "grant_type=password&client_id=client_id&client_secret=" \
-                      "client_secret&username=foo&password=barsecurity_token"
+                   "client_secret&username=foo&password=barsecurity_token"
       ).to_return(status: 200, body: fixture(:auth_success_response))
     end
 

data/spec/integration/data/client_spec.rb

@@ -98,17 +98,21 @@ shared_examples_for Restforce::Data::Client do
   end
 
   describe '.subscribe', event_machine: true do
+    let(:faye_double)     { double('Faye') }
+
     context 'when given a single pushtopic' do
       it 'subscribes to the pushtopic' do
-        client.faye.should_receive(:subscribe).with(['/topic/PushTopic'])
+        faye_double.should_receive(:subscribe).with(['/topic/PushTopic'])
+        client.stub faye: faye_double
         client.subscribe('PushTopic')
       end
     end
 
     context 'when given an array of pushtopics' do
       it 'subscribes to each pushtopic' do
-        client.faye.should_receive(:subscribe).with(['/topic/PushTopic1',
+        faye_double.should_receive(:subscribe).with(['/topic/PushTopic1',
                                                      '/topic/PushTopic2'])
+        client.stub faye: faye_double
         client.subscribe(%w[PushTopic1 PushTopic2])
       end
     end

data/spec/spec_helper.rb

@@ -8,6 +8,8 @@ Bundler.require :default, :test
 require 'faye' unless RUBY_PLATFORM == 'java'
 
 require 'webmock/rspec'
+require 'rspec/collection_matchers'
+require 'rspec/its'
 
 WebMock.disable_net_connect!
 
@@ -27,6 +29,14 @@ RSpec.configure do |config|
     $stderr = original_stderr
     $stdout = original_stdout
   end
+
+  config.expect_with :rspec do |expectations|
+    expectations.syntax = %i[expect should]
+  end
+
+  config.mock_with :rspec do |mocks|
+    mocks.syntax = %i[expect should]
+  end
 end
 
 # Requires supporting ruby files with custom matchers and macros, etc,

data/spec/support/client_integration.rb

@@ -5,7 +5,7 @@ module ClientIntegrationExampleGroup
     base.class_eval do
       let(:oauth_token) do
         '00Dx0000000BV7z!AR8AQAxo9UfVkh8AlV0Gomt9Czx9LjHnSSpwBMmbRcgKFmxOtvxjTrKW19ye6P' \
-        'E3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs'
+          'E3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs'
       end
 
       let(:refresh_token)  { 'refresh' }
@@ -39,13 +39,13 @@ module ClientIntegrationExampleGroup
   end
 
   RSpec.configure do |config|
+    describes = lambda do |described|
+      described <= Restforce::AbstractClient
+    end
+
     config.include self,
-                   example_group: {
-                     describes: lambda do |described|
-                       described <= Restforce::AbstractClient
-                     end,
-                     file_path: %r{spec/integration}
-                   }
+                   file_path: %r{spec/integration},
+                   describes: describes
 
     config.before mashify: false do
       base_options.merge!(mashify: false)

data/spec/support/concerns.rb

@@ -15,6 +15,6 @@ module ConcernsExampleGroup
   end
 
   RSpec.configure do |config|
-    config.include self, example_group: { file_path: %r{spec/unit/concerns} }
+    config.include self, file_path: %r{spec/unit/concerns}
   end
 end

data/spec/support/middleware.rb

@@ -19,8 +19,7 @@ module MiddlewareExampleGroup
   end
 
   RSpec.configure do |config|
-    config.include self,
-                   example_group: { file_path: %r{spec/unit/middleware} }
+    config.include self, file_path: %r{spec/unit/middleware}
   end
 end
 

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,7 +56,7 @@ 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
@@ -71,13 +71,13 @@ describe Restforce::Collection do
     context 'with size 1' do
       let(:sobject_fixture) { 'sobject/query_success_response' }
 
-      it { should be_false }
+      it { should be false }
     end
 
     context 'with size 0' do
       let(:sobject_fixture) { 'sobject/query_empty_response' }
 
-      it { should be_true }
+      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/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/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
@@ -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/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/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