restforce 3.0.1 → 4.2.0

data/lib/restforce/middleware/raise_error.rb

@@ -6,23 +6,30 @@ module Restforce
       @env = env
       case env[:status]
       when 300
-        raise Faraday::Error::ClientError.new("300: The external ID provided matches " \
-                                              "more than one record",
-                                              response_values)
+        raise Restforce::MatchesMultipleError.new(
+          "300: The external ID provided matches more than one record",
+          response_values
+        )
       when 401
         raise Restforce::UnauthorizedError, message
       when 404
-        raise Faraday::Error::ResourceNotFound, message
+        raise Restforce::NotFoundError, message
       when 413
-        raise Faraday::Error::ClientError.new("413: Request Entity Too Large",
-                                              response_values)
+        raise Restforce::EntityTooLargeError.new(
+          "413: Request Entity Too Large",
+          response_values
+        )
       when 400...600
-        raise Faraday::Error::ClientError.new(message, response_values)
+        klass = exception_class_for_error_code(body['errorCode'])
+        raise klass.new(message, response_values)
       end
     end
 
     def message
-      "#{body['errorCode']}: #{body['message']}"
+      message = "#{body['errorCode']}: #{body['message']}"
+      message << "\nRESPONSE: #{JSON.dump(@env[:body])}"
+    rescue StandardError
+      message # if JSON.dump fails, return message without extra detail
     end
 
     def body
@@ -43,5 +50,14 @@ module Restforce
         body: @env[:body]
       }
     end
+
+    ERROR_CODE_MATCHER = /\A[A-Z_]+\z/.freeze
+
+    def exception_class_for_error_code(error_code)
+      return Restforce::ResponseError unless ERROR_CODE_MATCHER.match?(error_code)
+
+      constant_name = error_code.split('_').map(&:capitalize).join.to_sym
+      Restforce::ErrorCode.const_get(constant_name)
+    end
   end
 end

data/lib/restforce/signed_request.rb

@@ -27,6 +27,7 @@ module Restforce
     # Returns nil if the signed request is invalid.
     def decode
       return nil if signature != hmac
+
       JSON.parse(Base64.decode64(payload))
     end
 

data/lib/restforce/sobject.rb

@@ -63,6 +63,7 @@ module Restforce
 
     def ensure_id
       return true if self.Id?
+
       raise ArgumentError, 'You need to query the Id for the record first.'
     end
   end

data/lib/restforce/tooling/client.rb

@@ -5,9 +5,9 @@ module Restforce
     class Client < AbstractClient
       private
 
-        def api_path(path)
-          super("tooling/#{path}")
-        end
+      def api_path(path)
+        super("tooling/#{path}")
+      end
     end
   end
 end

data/lib/restforce/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Restforce
-  VERSION = '3.0.1'
+  VERSION = '4.2.0'
 end

data/restforce.gemspec

@@ -1,6 +1,6 @@
 # frozen_string_literal: true
 
-require File.expand_path('../lib/restforce/version', __FILE__)
+require File.expand_path('lib/restforce/version', __dir__)
 
 Gem::Specification.new do |gem|
   gem.authors       = ["Eric J. Holmes", "Tim Rogers"]
@@ -22,19 +22,20 @@ Gem::Specification.new do |gem|
     'changelog_uri'   => 'https://github.com/restforce/restforce/blob/master/CHANGELOG.md'
   }
 
-  gem.required_ruby_version = '>= 2.3'
+  gem.required_ruby_version = '>= 2.4'
 
   gem.add_dependency 'faraday', '<= 1.0', '>= 0.9.0'
   gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 1.0']
 
   gem.add_dependency 'json', '>= 1.7.5'
+  gem.add_dependency 'jwt', ['>= 1.5.6']
 
   gem.add_dependency 'hashie', ['>= 1.2.0', '< 4.0']
 
-  gem.add_development_dependency 'rspec', '~> 2.14.0'
-  gem.add_development_dependency 'webmock', '~> 3.4.0'
-  gem.add_development_dependency 'simplecov', '~> 0.15.0'
-  gem.add_development_dependency 'rubocop', '~> 0.50.0'
-  gem.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
   gem.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
+  gem.add_development_dependency 'rspec', '~> 2.14.0'
+  gem.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
+  gem.add_development_dependency 'rubocop', '~> 0.75.0'
+  gem.add_development_dependency 'simplecov', '~> 0.17.1'
+  gem.add_development_dependency 'webmock', '~> 3.7.6'
 end

data/spec/fixtures/test_private.key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEAy3KYqxZIgVDgFwdA+OQcKMJQu3iUTlyCSk9b3RLBOudnvk8u
+n0ShtKkOKB4b4RZeedcrlKESoak/6NS+M7CDemRT0EagqUiz/ZsZxB2KUp7au+d8
+0KWX99/loBjDttuon8ITDw2WFC9X0+TZqfsXcQ0iV1/9Sf8WHShd8ZqShjJBlEvf
+7u7VdNW8dXrl+4cvpPzspVxg6jVotEpmp875jmGRvshgx0iz0jtfAyxaaKStITC6
+MxufVNDgIYQDl6queh8b9noDLtt17Eq6YnropYN1hOjaLtoLBP7AN2gsXG7N3vqC
+JG619W9X4zCmKztv4oGjymInrS2msC2J02dNGQIDAQABAoIBAAurTARsJ8Z7DA9m
+FBzygIb59kV6eg8wkSyP9rXscHbfdPzeb88k0Z2aILy+VV0IumyEofRJdNce7RJ+
+uVYfprrrbD9C/c4X5HMEZWrxQtDQWb1zXp5dESVfiz0ujnM7kCVxrUQsxFHuETyP
+IMj2JPcQCMs4L0ACSJNtkE3eTs8xko5kwDHZGiLTi5jD1bLgaHl1A+9CTU8LosTy
+hEIrNSZfNidDPU4QSbwoElYZxpDMSbtyHaIk1WHz7zLzWoogK3x5AIQh64wWAQVd
+zzlp2j2jSM7oQ9j+k1aNiUBdDoRX53jmaIwE/1WDW/LT33qAoqRw+5qHeLRoRcfu
+3uj/WI0CgYEA6wnpIUhqqWT+febhXtCr1mAJlAJpzUUQncN6Zk0Kj/kE1V52OqgL
+gtOactII7J3+0zK7KGptqseTank0ghmGNdRBQ7+1JTQhpjLrCm/huKDhl+sBk95u
+opxw/ZTwMFYPwsmZlFcy4uWRjtI+QzaV+2Xk5JF57H8vUiX/+XqseQcCgYEA3Zdw
+zVHpcVPlyiXCbSvwb9IYXiJaQl/Rg96Klxah3MZNyRRKe5IoKUTJwEDuQ1MAHrve
+cWrNLcXhX6r/PzIXSSLe71wgwpn7UcaqWzZJqqN7OIGEeTzYWbB6tGhse7Dw7tWB
+hRkQSE0LPzZqboHz5msRM02sa61qiI5+ASJvIN8CgYEAvT+IoEzv3R89ruBVPQPm
+KMHBVJSw3iArJex8xJxp0c0fMDJUHhyq0BdTd/pYRzVcNm/VtNAlJ2p07zlSpyKo
+JvWV61gUIjWclnbPO+MkK4YWvzzxUz+5c2NlszjWQQU6wYuUBpZDmeBg2E++5F2y
+W+8KY2QjeOJbltiUCCvXbccCgYEAqARYB5aARumyZqBS16xlVqQazeWGQqWcmzx2
+ITGL8XZ7LGgyQZgE06XQw/F3t5yLjsIsXBr7ECXmST/C4gv9E/tYxm04edV/dfYI
+3bhACx6CI8owxCyabwcdQwWam/8B8FX7KwxiCDBCwt9ju/7VDHVKSXgvsEWBbaF9
+cSbG1EkCgYBZFztTUnD/cLMcvLUegN0K+6Qa3x3nRSrlrJ+v51mU1X8G8qNyFO67
+gUq9h4xbCl4Z5ZTuFKXwPM4XaMzfYdrWNS2zl5IG14FXS077GhDKe062b9mFoxtm
+aViCit4Hm8xpLTS8x9KB7yYAiF9sR/GklW1SUCIqnpL9JShkhzjfZw==
+-----END RSA PRIVATE KEY-----

data/spec/integration/abstract_client_spec.rb

@@ -96,7 +96,7 @@ shared_examples_for Restforce::AbstractClient do
       subject do
         client.create('Account', Name: 'Foobar',
                                  Blob: Restforce::UploadIO.new(
-                                   File.expand_path('../../fixtures/blob.jpg', __FILE__),
+                                   File.expand_path('../fixtures/blob.jpg', __dir__),
                                    'image/jpeg'
                                  ))
       end
@@ -209,6 +209,24 @@ shared_examples_for Restforce::AbstractClient do
         end
       end
     end
+
+    context 'when created with a space in the id' do
+      requests 'sobjects/Account/External__c/foo%20bar',
+               method: :patch,
+               with_body: "{\"Name\":\"Foobar\"}",
+               fixture: 'sobject/upsert_created_success_response'
+
+      [:External__c, 'External__c', :external__c, 'external__c'].each do |key|
+        context "with #{key.inspect} as the external id" do
+          subject do
+            client.upsert!('Account', 'External__c', key => 'foo bar',
+                                                     :Name => 'Foobar')
+          end
+
+          it { should eq 'foo' }
+        end
+      end
+    end
   end
 
   describe '.destroy!' do
@@ -229,6 +247,13 @@ shared_examples_for Restforce::AbstractClient do
 
       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 }
+    end
   end
 
   describe '.destroy' do
@@ -266,6 +291,14 @@ shared_examples_for Restforce::AbstractClient do
       subject { client.find('Account', '1234', 'External_Field__c') }
       it { should be_a Hash }
     end
+
+    context 'with a space in an external id' do
+      requests 'sobjects/Account/External_Field__c/12%2034',
+               fixture: 'sobject/sobject_find_success_response'
+
+      subject { client.find('Account', '12 34', 'External_Field__c') }
+      it { should be_a Hash }
+    end
   end
 
   describe '.select' do
@@ -284,6 +317,14 @@ shared_examples_for Restforce::AbstractClient do
         subject { client.select('Account', '1234', ['External_Field__c']) }
         it { should be_a Hash }
       end
+
+      context 'with a space in the id' do
+        requests 'sobjects/Account/12%2034',
+                 fixture: 'sobject/sobject_select_success_response'
+
+        subject { client.select('Account', '12 34', nil, nil) }
+        it { should be_a Hash }
+      end
     end
 
     context 'when an external id is specified' do

data/spec/support/fixture_helpers.rb

@@ -27,8 +27,8 @@ module FixtureHelpers
       stub
     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/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
@@ -100,4 +110,29 @@ describe Restforce::Concerns::Authentication do
       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_true }
+    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/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, &subscribe_block)
       client.stub faye: faye_double
 
-      client.subscribe(channels, &subscribe_block)
+      client.subscription(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.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 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: "/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