restforce 4.2.1 → 6.0.0

data/spec/fixtures/sobject/list_view_results_success_response.json

@@ -0,0 +1,151 @@
+{
+  "columns" : [ {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "Name",
+    "hidden" : false,
+    "label" : "Account Name",
+    "selectListItem" : "Name",
+    "sortDirection" : "ascending",
+    "sortIndex" : 0,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "Site",
+    "hidden" : false,
+    "label" : "Account Site",
+    "selectListItem" : "Site",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "BillingState",
+    "hidden" : false,
+    "label" : "Billing State/Province",
+    "selectListItem" : "BillingState",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : "9-0",
+    "descendingLabel" : "0-9",
+    "fieldNameOrPath" : "Phone",
+    "hidden" : false,
+    "label" : "Phone",
+    "selectListItem" : "Phone",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "phone"
+  }, {
+    "ascendingLabel" : "Low to High",
+    "descendingLabel" : "High to Low",
+    "fieldNameOrPath" : "Type",
+    "hidden" : false,
+    "label" : "Type",
+    "selectListItem" : "toLabel(Type)",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "picklist"
+  }, {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "Owner.Alias",
+    "hidden" : false,
+    "label" : "Account Owner Alias",
+    "selectListItem" : "Owner.Alias",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "Id",
+    "hidden" : true,
+    "label" : "Account ID",
+    "selectListItem" : "Id",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "id"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "CreatedDate",
+    "hidden" : true,
+    "label" : "Created Date",
+    "selectListItem" : "CreatedDate",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "datetime"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "LastModifiedDate",
+    "hidden" : true,
+    "label" : "Last Modified Date",
+    "selectListItem" : "LastModifiedDate",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "datetime"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "SystemModstamp",
+    "hidden" : true,
+    "label" : "System Modstamp",
+    "selectListItem" : "SystemModstamp",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "datetime"
+  } ],
+  "developerName" : "MyAccounts",
+  "done" : true,
+  "id" : "00BD0000005WcCN",
+  "label" : "My Accounts",
+  "records" : [ {
+    "columns" : [ {
+      "fieldNameOrPath" : "Name",
+      "value" : "Burlington Textiles Corp of America"
+    }, {
+      "fieldNameOrPath" : "Site",
+      "value" : null
+    }, {
+      "fieldNameOrPath" : "BillingState",
+      "value" : "NC"
+    }, {
+      "fieldNameOrPath" : "Phone",
+      "value" : "(336) 222-7000"
+    }, {
+      "fieldNameOrPath" : "Type",
+      "value" : "Customer - Direct"
+    }, {
+      "fieldNameOrPath" : "Owner.Alias",
+      "value" : "TUser"
+    }, {
+      "fieldNameOrPath" : "Id",
+      "value" : "001D000000JliSTIAZ"
+    }, {
+      "fieldNameOrPath" : "CreatedDate",
+      "value" : "Fri Aug 01 21:15:46 GMT 2014"
+    }, {
+      "fieldNameOrPath" : "LastModifiedDate",
+      "value" : "Fri Aug 01 21:15:46 GMT 2014"
+    }, {
+      "fieldNameOrPath" : "SystemModstamp",
+      "value" : "Fri Aug 01 21:15:46 GMT 2014"
+    } ]
+  } ],
+  "size" : 1
+}

data/spec/integration/abstract_client_spec.rb

@@ -86,22 +86,34 @@ shared_examples_for Restforce::AbstractClient do
     end
 
     context 'with multipart' do
-      # rubocop:disable Metrics/LineLength
+      # rubocop:disable Layout/LineLength
       requests 'sobjects/Account',
                method: :post,
-               with_body: %r(----boundary_string\r\nContent-Disposition: form-data; name=\"entity_content\"\r\nContent-Type: application/json\r\n\r\n{\"Name\":\"Foobar\"}\r\n----boundary_string\r\nContent-Disposition: form-data; name=\"Blob\"; filename=\"blob.jpg\"\r\nContent-Length: 42171\r\nContent-Type: image/jpeg\r\nContent-Transfer-Encoding: binary),
+               with_body: %r(----boundary_string\r\nContent-Disposition: form-data; name="entity_content"\r\nContent-Type: application/json\r\n\r\n{"Name":"Foobar"}\r\n----boundary_string\r\nContent-Disposition: form-data; name="Blob"; filename="blob.jpg"\r\nContent-Length: 42171\r\nContent-Type: image/jpeg\r\nContent-Transfer-Encoding: binary),
                fixture: 'sobject/create_success_response'
-      # rubocop:enable Metrics/LineLength
+      # rubocop:enable Layout/LineLength
 
       subject do
         client.create('Account', Name: 'Foobar',
-                                 Blob: Restforce::UploadIO.new(
+                                 Blob: Restforce::FilePart.new(
                                    File.expand_path('../fixtures/blob.jpg', __dir__),
                                    'image/jpeg'
                                  ))
       end
 
       it { should eq 'some_id' }
+
+      context 'with deprecated UploadIO' do
+        subject do
+          client.create('Account', Name: 'Foobar',
+                        Blob: Restforce::UploadIO.new(
+                          File.expand_path('../fixtures/blob.jpg', __dir__),
+                          'image/jpeg'
+                        ))
+        end
+
+        it { should eq 'some_id' }
+      end
     end
   end
 
@@ -117,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
 
@@ -146,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
@@ -160,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
@@ -179,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
@@ -188,7 +197,7 @@ shared_examples_for Restforce::AbstractClient do
                                                    'Name' => 'Foobar')
         end
 
-        it { should be_true }
+        it { should be true }
       end
     end
 
@@ -245,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
 
@@ -265,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
 
@@ -356,9 +365,13 @@ 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"
-        ).to_return(status: 200, body: fixture(:auth_success_response))
+                     "&client_secret=client_secret&username=foo" \
+                     "&password=barsecurity_token"
+        ).to_return(
+          status: 200,
+          body: fixture(:auth_success_response),
+          headers: { "Content-Type" => "application/json" }
+        )
       end
 
       after do
@@ -408,9 +421,13 @@ 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"
-        ).to_return(status: 200, body: fixture(:auth_success_response))
+                     "&client_secret=client_secret&username=foo&" \
+                     "password=barsecurity_token"
+        ).to_return(
+          status: 200,
+          body: fixture(:auth_success_response),
+          headers: { "Content-Type" => "application/json" }
+        )
       end
 
       subject { lambda { client.query('SELECT some, fields FROM object') } }
@@ -425,16 +442,20 @@ 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"
-      ).to_return(status: 200, body: fixture(:auth_success_response))
+                   "client_secret&username=foo&password=barsecurity_token"
+      ).to_return(
+        status: 200,
+        body: fixture(:auth_success_response),
+        headers: { "Content-Type" => "application/json" }
+      )
     end
 
     after do

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!
 
@@ -15,8 +17,29 @@ RSpec.configure do |config|
   config.order = 'random'
   config.filter_run focus: true
   config.run_all_when_everything_filtered = true
+
+  original_stderr = $stderr
+  original_stdout = $stdout
+  config.before(:all) do
+    # Redirect stderr and stdout
+    $stderr = File.open(File::NULL, "w")
+    $stdout = File.open(File::NULL, "w")
+  end
+  config.after(:all) do
+    $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,
 # in spec/support/ and its subdirectories.
-Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")].each { |f| require f }
+paths = Dir[File.join(File.dirname(__FILE__), "support/**/*.rb")]
+paths.sort.each { |f| require f }

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/fixture_helpers.rb

@@ -22,9 +22,7 @@ module FixtureHelpers
     end
 
     def stub_login_request(*)
-      stub = stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
-
-      stub
+      stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
     end
 
     def fixture(filename)

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,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
@@ -312,9 +312,12 @@ describe Restforce::Concerns::API do
         let(:attrs) { { id: '1234', StageName: "Call Scheduled" } }
 
         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
+          client.should_receive(:api_patch) do |*args|
+            expect(args).to eq(["sobjects/Whizbang/1234",
+                                { StageName: "Call Scheduled" }])
+          end
+
+          expect(result).to be true
         end
       end
 
@@ -322,9 +325,13 @@ describe Restforce::Concerns::API do
         let(:attrs) { { id: '1234/?abc', StageName: "Call Scheduled" } }
 
         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
+          client.should_receive(:api_patch) do |*args|
+            expect(args).to eq(['sobjects/Whizbang/1234%2F%3Fabc', {
+                                 StageName: "Call Scheduled"
+                               }])
+          end
+
+          expect(result).to be true
         end
       end
 
@@ -348,7 +355,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 +364,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 +438,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 +455,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 +469,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 +478,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