restforce 3.0.1 → 5.1.1

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,13 +22,11 @@ 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(f)
-      File.read(File.expand_path("../../fixtures/#{f}.json", __FILE__))
+    def fixture(filename)
+      File.read(File.expand_path("../../fixtures/#{filename}.json", __FILE__))
     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,10 +56,28 @@ 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 '#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,15 +268,15 @@ 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
 
       it 'rescues exceptions' do
-        [Faraday::Error::ClientError].each do |exception_klass|
+        [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

@@ -52,6 +52,16 @@ describe Restforce::Concerns::Authentication do
 
       it { should eq Restforce::Middleware::Authentication::Token }
     end
+
+    context 'when jwt option is provided' do
+      before do
+        client.stub username_password?: false
+        client.stub oauth_refresh?: false
+        client.stub jwt?: true
+      end
+
+      it { should eq Restforce::Middleware::Authentication::JWTBearer }
+    end
   end
 
   describe '.username_password?' do
@@ -70,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
 
@@ -93,11 +103,36 @@ 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
+
+  describe '.jwt?' do
+    subject       { client.jwt? }
+    let(:options) do
+      {}
+    end
+
+    before do
+      client.stub options: options
+    end
+
+    context 'when jwt options are provided' do
+      let(:options) do
+        { jwt_key: 'JWT_PRIVATE_KEY',
+          username: 'foo',
+          client_id: 'client' }
+      end
+
+      it { should be_truthy }
+    end
+
+    context 'when jwt options are not provided' do
+      it { should_not be true }
     end
   end
 end

data/spec/unit/concerns/batch_api_spec.rb

@@ -0,0 +1,107 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restforce::Concerns::BatchAPI do
+  let(:endpoint) { 'composite/batch' }
+
+  before do
+    client.should_receive(:options).and_return(api_version: 34.0)
+  end
+
+  shared_examples_for 'batched requests' do
+    it '#create' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { batchRequests: [
+          { method: 'POST', url: 'v34.0/sobjects/Object', richInput: { name: 'test' } }
+        ], haltOnError: halt_on_error }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.create('Object', name: 'test')
+      end
+    end
+
+    it '#update' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { batchRequests: [
+          { method: 'PATCH', url: "v34.0/sobjects/Object/123", richInput: {
+            name: 'test'
+          } }
+        ], haltOnError: halt_on_error }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.update('Object', id: '123', name: 'test')
+      end
+    end
+
+    it '#destroy' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { batchRequests: [
+          { method: 'DELETE', url: "v34.0/sobjects/Object/123" }
+        ], haltOnError: halt_on_error }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.destroy('Object', '123')
+      end
+    end
+
+    it '#upsert' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { batchRequests: [
+          { method: 'PATCH', url: 'v34.0/sobjects/Object/extIdField__c/456', richInput: {
+            name: 'test'
+          } }
+        ], haltOnError: halt_on_error }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.upsert('Object', 'extIdField__c',
+                           extIdField__c: '456', name: 'test')
+      end
+    end
+
+    it 'multiple subrequests' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { batchRequests: [
+          { method: 'POST', url: 'v34.0/sobjects/Object', richInput: {
+            name: 'test'
+          } },
+          { method: 'PATCH', url: "v34.0/sobjects/Object/123", richInput: {
+            name: 'test'
+          } },
+          { method: 'DELETE', url: "v34.0/sobjects/Object/123" }
+        ], haltOnError: halt_on_error }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.create('Object', name: 'test')
+        subrequests.update('Object', id: '123', name: 'test')
+        subrequests.destroy('Object', '123')
+      end
+    end
+  end
+
+  describe '#batch' do
+    let(:method) { :batch }
+    let(:halt_on_error) { false }
+    let(:response) { double('Faraday::Response', body: { 'results' => [] }) }
+    it_behaves_like 'batched requests'
+  end
+
+  describe '#batch!' do
+    let(:method) { :batch! }
+    let(:halt_on_error) { true }
+    let(:response) {
+      double('Faraday::Response', body: { 'hasErrors' => false, 'results' => [] })
+    }
+    it_behaves_like 'batched requests'
+  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/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

@@ -4,18 +4,73 @@ require 'spec_helper'
 
 describe Restforce::Concerns::Streaming, event_machine: true do
   describe '.subscribe' do
-    let(:channels)        { %w[channel1 channel2] }
-    let(:topics)          { channels.map { |c| "/topic/#{c}" } }
+    let(:channels) do
+      ['/topic/topic1', '/event/MyCustomEvent__e', '/data/ChangeEvents']
+    end
     let(:subscribe_block) { lambda { 'subscribe' } }
     let(:faye_double)     { double('Faye') }
 
     it 'subscribes to the topics with faye' do
       faye_double.
         should_receive(:subscribe).
-        with(topics, &subscribe_block)
+        with(channels)
       client.stub faye: faye_double
 
-      client.subscribe(channels, &subscribe_block)
+      client.subscription(channels)
+    end
+
+    context "replay_handlers" do
+      before {
+        faye_double.should_receive(:subscribe).at_least(1)
+        client.stub faye: faye_double
+      }
+
+      it 'registers nil handlers when no replay option is given' do
+        client.subscription(channels, &subscribe_block)
+        client.replay_handlers.should eq(
+          '/topic/topic1' => nil,
+          '/event/MyCustomEvent__e' => nil,
+          '/data/ChangeEvents' => nil
+        )
+      end
+
+      it 'registers a replay_handler for each channel given' do
+        client.subscription(channels, replay: -2, &subscribe_block)
+        client.replay_handlers.should eq(
+          '/topic/topic1' => -2,
+          '/event/MyCustomEvent__e' => -2,
+          '/data/ChangeEvents' => -2
+        )
+      end
+
+      it 'replaces earlier handlers in subsequent calls' do
+        client.subscription(
+          ['/topic/channel1', '/topic/channel2'],
+          replay: 2,
+          &subscribe_block
+        )
+        client.subscription(
+          ['/topic/channel2', '/topic/channel3'],
+          replay: 3,
+          &subscribe_block
+        )
+
+        client.replay_handlers.should eq(
+          '/topic/channel1' => 2,
+          '/topic/channel2' => 3,
+          '/topic/channel3' => 3
+        )
+      end
+
+      context 'backwards compatibility' do
+        it 'it assumes channels are push topics' do
+          client.subscribe(%w[channel1 channel2], replay: -2, &subscribe_block)
+          client.replay_handlers.should eq(
+            '/topic/channel1' => -2,
+            '/topic/channel2' => -2
+          )
+        end
+      end
     end
   end
 
@@ -42,6 +97,8 @@ describe Restforce::Concerns::Streaming, event_machine: true do
         faye_double.should_receive(:set_header).with('Authorization', 'OAuth secret2')
         faye_double.should_receive(:bind).with('transport:down').and_yield
         faye_double.should_receive(:bind).with('transport:up').and_yield
+        faye_double.should_receive(:add_extension).with \
+          kind_of(Restforce::Concerns::Streaming::ReplayExtension)
         subject
       end
     end
@@ -52,4 +109,87 @@ describe Restforce::Concerns::Streaming, event_machine: true do
       end
     end
   end
+
+  describe "ReplayExtension" do
+    let(:handlers) { {} }
+    let(:extension) { Restforce::Concerns::Streaming::ReplayExtension.new(handlers) }
+
+    it 'sends nil without a specified handler' do
+      output = subscribe(extension, to: "/topic/channel1")
+      read_replay(output).should eq('/topic/channel1' => nil)
+    end
+
+    it 'with a scalar replay id' do
+      handlers['/topic/channel1'] = -2
+      output = subscribe(extension, to: "/topic/channel1")
+      read_replay(output).should eq('/topic/channel1' => -2)
+    end
+
+    it 'with a hash' do
+      hash_handler = { '/topic/channel1' => -1, '/topic/channel2' => -2 }
+
+      handlers['/topic/channel1'] = hash_handler
+      handlers['/topic/channel2'] = hash_handler
+
+      output = subscribe(extension, to: "/topic/channel1")
+      read_replay(output).should eq('/topic/channel1' => -1)
+
+      output = subscribe(extension, to: "/topic/channel2")
+      read_replay(output).should eq('/topic/channel2' => -2)
+    end
+
+    it 'with an object' do
+      custom_handler = double('custom_handler')
+      custom_handler.should_receive(:[]).and_return(123)
+      handlers['/topic/channel1'] = custom_handler
+
+      output = subscribe(extension, to: "/topic/channel1")
+      read_replay(output).should eq('/topic/channel1' => 123)
+    end
+
+    it 'remembers the last replayId' do
+      handler = { '/topic/channel1' => 41 }
+      handlers['/topic/channel1'] = handler
+      message = {
+        'channel' => '/topic/channel1',
+        'data' => {
+          'event' => { 'replayId' => 42 }
+        }
+      }
+
+      extension.incoming(message, ->(m) {})
+      handler.should eq('/topic/channel1' => 42)
+    end
+
+    it 'when an incoming message has no replayId' do
+      handler = { '/topic/channel1' => 41 }
+      handlers['/topic/channel1'] = handler
+
+      message = {
+        'channel' => '/topic/channel1',
+        'data' => {}
+      }
+
+      extension.incoming(message, ->(m) {})
+      handler.should eq('/topic/channel1' => 41)
+    end
+
+    private
+
+    def subscribe(extension, options = {})
+      output = nil
+      message = {
+        'channel' => '/meta/subscribe',
+        'subscription' => options[:to]
+      }
+      extension.outgoing(message, ->(m) {
+        output = m
+      })
+      output
+    end
+
+    def read_replay(message)
+      message.fetch('ext', {})['replay']
+    end
+  end
 end

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