restforce 2.5.4 → 4.0.0

data/spec/unit/concerns/caching_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Concerns::Caching do

data/spec/unit/concerns/canvas_spec.rb

@@ -1,7 +1,9 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Concerns::Canvas do
-  let(:options) { Hash.new }
+  let(:options) { {} }
 
   before do
     client.stub options: options

data/spec/unit/concerns/connection_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Concerns::Connection do
@@ -34,7 +36,7 @@ describe Restforce::Concerns::Connection do
       describe 'with mashify not specified' do
         it 'includes the Mashify middleware' do
           client.middleware.handlers.index(Restforce::Middleware::Mashify).
-              should_not be_nil
+            should_not be_nil
         end
       end
 
@@ -45,7 +47,7 @@ describe Restforce::Concerns::Connection do
 
         it 'includes the Mashify middleware' do
           client.middleware.handlers.index(Restforce::Middleware::Mashify).
-              should_not be_nil
+            should_not be_nil
         end
       end
 
@@ -56,7 +58,7 @@ describe Restforce::Concerns::Connection do
 
         it 'does not include the Mashify middleware' do
           client.middleware.handlers.index(Restforce::Middleware::Mashify).
-              should be_nil
+            should be_nil
         end
       end
     end

data/spec/unit/concerns/streaming_spec.rb

@@ -1,8 +1,10 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Concerns::Streaming, event_machine: true do
   describe '.subscribe' do
-    let(:channels)        { %w( channel1 channel2 ) }
+    let(:channels)        { %w[channel1 channel2] }
     let(:topics)          { channels.map { |c| "/topic/#{c}" } }
     let(:subscribe_block) { lambda { 'subscribe' } }
     let(:faye_double)     { double('Faye') }
@@ -15,6 +17,33 @@ describe Restforce::Concerns::Streaming, event_machine: true do
 
       client.subscribe(channels, &subscribe_block)
     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.subscribe(channels, &subscribe_block)
+        client.replay_handlers.should eq('channel1' => nil, 'channel2' => nil)
+      end
+
+      it 'registers a replay_handler for each channel given' do
+        client.subscribe(channels, replay: -2, &subscribe_block)
+        client.replay_handlers.should eq('channel1' => -2, 'channel2' => -2)
+      end
+
+      it 'replaces earlier handlers in subsequent calls' do
+        client.subscribe(%w[channel1 channel2], replay: 2, &subscribe_block)
+        client.subscribe(%w[channel2 channel3], replay: 3, &subscribe_block)
+        client.replay_handlers.should eq(
+          'channel1' => 2,
+          'channel2' => 3,
+          'channel3' => 3
+        )
+      end
+    end
   end
 
   describe '.faye' do
@@ -40,6 +69,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
@@ -50,4 +81,87 @@ describe Restforce::Concerns::Streaming, event_machine: true do
       end
     end
   end
+
+  describe Restforce::Concerns::Streaming::ReplayExtension do
+    let(:handlers) { {} }
+    let(:extension) { Restforce::Concerns::Streaming::ReplayExtension.new(handlers) }
+
+    it 'sends nil without a specified handler' do
+      output = subscribe(extension, to: "channel1")
+      read_replay(output).should eq('/topic/channel1' => nil)
+    end
+
+    it 'with a scalar replay id' do
+      handlers['channel1'] = -2
+      output = subscribe(extension, to: "channel1")
+      read_replay(output).should eq('/topic/channel1' => -2)
+    end
+
+    it 'with a hash' do
+      hash_handler = { 'channel1' => -1, 'channel2' => -2 }
+
+      handlers['channel1'] = hash_handler
+      handlers['channel2'] = hash_handler
+
+      output = subscribe(extension, to: "channel1")
+      read_replay(output).should eq('/topic/channel1' => -1)
+
+      output = subscribe(extension, to: "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['channel1'] = custom_handler
+
+      output = subscribe(extension, to: "channel1")
+      read_replay(output).should eq('/topic/channel1' => 123)
+    end
+
+    it 'remembers the last replayId' do
+      handler = { 'channel1' => 41 }
+      handlers['channel1'] = handler
+      message = {
+        'channel' => '/topic/channel1',
+        'data' => {
+          'event' => { 'replayId' => 42 }
+        }
+      }
+
+      extension.incoming(message, ->(m) {})
+      handler.should eq('channel1' => 42)
+    end
+
+    it 'when an incoming message has no replayId' do
+      handler = { 'channel1' => 41 }
+      handlers['channel1'] = handler
+
+      message = {
+        'channel' => '/topic/channel1',
+        'data' => {}
+      }
+
+      extension.incoming(message, ->(m) {})
+      handler.should eq('channel1' => 41)
+    end
+
+    private
+
+    def subscribe(extension, options = {})
+      output = nil
+      message = {
+        'channel' => '/meta/subscribe',
+        'subscription' => "/topic/#{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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce do
@@ -25,9 +27,9 @@ describe Restforce do
       its(:authentication_retries) { should eq 3 }
       its(:adapter)                { should eq Faraday.default_adapter }
       its(:ssl)                    { should eq({}) }
-      [:username, :password, :security_token, :client_id, :client_secret,
-       :oauth_token, :refresh_token, :instance_url, :compress, :timeout,
-       :proxy_uri, :authentication_callback, :mashify, :request_headers].each do |attr|
+      %i[username password security_token client_id client_secret
+         oauth_token refresh_token instance_url compress timeout
+         proxy_uri authentication_callback mashify request_headers].each do |attr|
         its(attr) { should be_nil }
       end
     end
@@ -42,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(:[]).with(var).and_return(value) }
       end
 
       its(:username)       { should eq 'foo' }
@@ -57,10 +59,10 @@ describe Restforce do
   end
 
   describe '#configure' do
-    [:username, :password, :security_token, :client_id, :client_secret, :compress,
-     :timeout, :oauth_token, :refresh_token, :instance_url, :api_version, :host, :mashify,
-     :authentication_retries, :proxy_uri, :authentication_callback, :ssl,
-     :request_headers, :log_level, :logger].each do |attr|
+    %i[username password security_token client_id client_secret compress
+       timeout oauth_token refresh_token instance_url api_version host mashify
+       authentication_retries proxy_uri authentication_callback ssl
+       request_headers log_level logger].each do |attr|
       it "allows #{attr} to be set" do
         Restforce.configure do |config|
           config.send("#{attr}=", 'foobar')

data/spec/unit/data/client_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Client do

data/spec/unit/document_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Document do

data/spec/unit/mash_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Mash do
@@ -6,7 +8,7 @@ describe Restforce::Mash do
 
     context 'when array' do
       let(:input) { [{ foo: 'hello' }, { bar: 'world' }] }
-      it { should be_all { |obj| expect(obj).to be_a Restforce::Mash } }
+      it { should(be_all { |obj| expect(obj).to be_a Restforce::Mash }) }
     end
   end
 

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Authentication::Password do

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

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Authentication::Token do

data/spec/unit/middleware/authentication_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Authentication do
@@ -58,7 +60,7 @@ describe Restforce::Middleware::Authentication do
           should include FaradayMiddleware::ParseJson,
                          Faraday::Adapter::NetHttp
         }
-        its(:handlers) { should_not include Restforce::Middleware::Logger  }
+        its(:handlers) { should_not include Restforce::Middleware::Logger }
       end
 
       context 'with logging enabled' do

data/spec/unit/middleware/authorization_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Authorization do

data/spec/unit/middleware/custom_headers_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::CustomHeaders do
@@ -13,7 +15,7 @@ describe Restforce::Middleware::CustomHeaders do
     context 'when :request_headers are not a Hash' do
       let(:options) { { request_headers: 'bad header' } }
 
-      it { should_not change { env[:request_headers] } }
+      it { should_not(change { env[:request_headers] }) }
     end
   end
 end

data/spec/unit/middleware/gzip_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Gzip do
@@ -29,7 +31,7 @@ describe Restforce::Middleware::Gzip do
     end
 
     context 'when :compress is false' do
-      it { should_not change { env[:request_headers]['Accept-Encoding'] } }
+      it { should_not(change { env[:request_headers]['Accept-Encoding'] }) }
     end
 
     context 'when :compress is true' do
@@ -37,7 +39,7 @@ describe Restforce::Middleware::Gzip do
         options[:compress] = true
       end
 
-      it { should change { env[:request_headers]['Accept-Encoding'] }.to('gzip') }
+      it { should(change { env[:request_headers]['Accept-Encoding'] }.to('gzip')) }
     end
   end
 

data/spec/unit/middleware/instance_url_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::InstanceURL do

data/spec/unit/middleware/logger_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Logger do

data/spec/unit/middleware/mashify_spec.rb

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Mashify do
   let(:env) { { body: JSON.parse(fixture('sobject/query_success_response')) } }
   subject(:middleware) {
-    described_class.new(lambda {|env|
+    described_class.new(lambda { |env|
       Faraday::Response.new(env)
     }, client, options)
   }

data/spec/unit/middleware/raise_error_spec.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'spec_helper'
 
 describe Restforce::Middleware::RaiseError do
@@ -11,34 +13,46 @@ describe Restforce::Middleware::RaiseError do
     context 'when the status code is 404' do
       let(:status) { 404 }
 
-      it "raises an error" do
-        expect { on_complete }.to raise_error Faraday::Error::ResourceNotFound,
+      it 'raises Restforce::NotFoundError' do
+        expect { on_complete }.to raise_error Restforce::NotFoundError,
                                               'INVALID_FIELD: error_message'
       end
+
+      it 'raises an error that inherits from Faraday::Error::ResourceNotFound' do
+        expect { on_complete }.to raise_error Faraday::Error::ResourceNotFound
+      end
     end
 
     context 'when the status code is 300' do
       let(:status) { 300 }
 
-      it "raises an error" do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError,
+      it 'raises Restforce::MatchesMultipleError' do
+        expect { on_complete }.to raise_error Restforce::MatchesMultipleError,
                                               /300: The external ID provided/
       end
+
+      it 'raises an error that inherits from Faraday::Error::ClientError' do
+        expect { on_complete }.to raise_error Faraday::Error::ClientError
+      end
     end
 
     context 'when the status code is 400' do
       let(:status) { 400 }
 
-      it "raises an error" do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError,
+      it "raises an error derived from the response's errorCode" do
+        expect { on_complete }.to raise_error Restforce::ErrorCode::InvalidField,
                                               'INVALID_FIELD: error_message'
       end
+
+      it 'raises an error that inherits from Faraday::Error::ClientError' do
+        expect { on_complete }.to raise_error Faraday::Error::ClientError
+      end
     end
 
     context 'when the status code is 401' do
       let(:status) { 401 }
 
-      it "raises an error" do
+      it 'raises Restforce::UnauthorizedError' do
         expect { on_complete }.to raise_error Restforce::UnauthorizedError,
                                               'INVALID_FIELD: error_message'
       end
@@ -47,17 +61,26 @@ describe Restforce::Middleware::RaiseError do
     context 'when the status code is 413' do
       let(:status) { 413 }
 
-      it "raises an error" do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError,
+      it 'raises Restforce::EntityTooLargeError' do
+        expect { on_complete }.to raise_error Restforce::EntityTooLargeError,
                                               '413: Request Entity Too Large'
       end
+
+      it 'raises an error that inherits from Faraday::Error::ClientError' do
+        expect { on_complete }.to raise_error Faraday::Error::ClientError
+      end
     end
 
     context 'when status is 400+ and body is a string' do
       let(:body)   { 'An error occured' }
-      let(:status) { 404 }
+      let(:status) { 400 }
+
+      it 'raises a generic Restforce::ResponseError' do
+        expect { on_complete }.to raise_error Restforce::ResponseError,
+                                              "(error code missing): #{body}"
+      end
 
-      it 'raises an error with a non-existing error code' do
+      it 'raises an error that inherits from Faraday::Error::ClientError' do
         expect { on_complete }.to raise_error Faraday::Error::ClientError,
                                               "(error code missing): #{body}"
       end