restforce 4.2.1 → 5.2.4

data/lib/restforce/mash.rb

@@ -11,9 +11,10 @@ module Restforce
       # appropriate Restforce::Collection, Restforce::SObject and
       # Restforce::Mash objects.
       def build(val, client)
-        if val.is_a?(Array)
+        case val
+        when Array
           val.collect { |a_val| self.build(a_val, client) }
-        elsif val.is_a?(Hash)
+        when Hash
           self.klass(val).new(val, client)
         else
           val
@@ -28,7 +29,7 @@ module Restforce
           # of sobject records.
           Restforce::Collection
         elsif val.key? 'attributes'
-          case (val['attributes']['type'])
+          case val.dig('attributes', 'type')
           when "Attachment"
             Restforce::Attachment
           when "Document"
@@ -55,6 +56,9 @@ module Restforce
       self.class.new(self, @client, self.default)
     end
 
+    # The #convert_value method and its signature are part of Hashie::Mash's API, so we
+    # can't unilaterally decide to change `duping` to be a keyword argument
+    # rubocop:disable Style/OptionalBooleanParameter
     def convert_value(val, duping = false)
       case val
       when self.class
@@ -68,5 +72,6 @@ module Restforce
         val
       end
     end
+    # rubocop:enable Style/OptionalBooleanParameter
   end
 end

data/lib/restforce/middleware/caching.rb

@@ -18,7 +18,7 @@ module Restforce
     end
 
     def use_cache?
-      @options.fetch(:use_cache, true)
+      @options[:use_cache]
     end
 
     def hashed_auth_header(env)

data/lib/restforce/middleware/logger.rb

@@ -11,7 +11,7 @@ module Restforce
       @options = options
       @logger = logger || begin
         require 'logger'
-        ::Logger.new(STDOUT)
+        ::Logger.new($stdout)
       end
     end
 
@@ -20,9 +20,9 @@ module Restforce
     def call(env)
       debug('request') do
         dump url: env[:url].to_s,
-          method: env[:method],
-          headers: env[:request_headers],
-          body: env[:body]
+             method: env[:method],
+             headers: env[:request_headers],
+             body: env[:body]
       end
       super
     end
@@ -30,13 +30,14 @@ module Restforce
     def on_complete(env)
       debug('response') do
         dump status: env[:status].to_s,
-          headers: env[:response_headers],
-          body: env[:body]
+             headers: env[:response_headers],
+             body: env[:body]
       end
     end
 
     def dump(hash)
-      "\n" + hash.map { |k, v| "  #{k}: #{v.inspect}" }.join("\n")
+      dumped_pairs = hash.map { |k, v| "  #{k}: #{v.inspect}" }.join("\n")
+      "\n#{dumped_pairs}"
     end
   end
 end

data/lib/restforce/middleware/raise_error.rb

@@ -11,9 +11,9 @@ module Restforce
           response_values
         )
       when 401
-        raise Restforce::UnauthorizedError, message
+        raise Restforce::UnauthorizedError.new(message, response_values)
       when 404
-        raise Restforce::NotFoundError, message
+        raise Restforce::NotFoundError.new(message, response_values)
       when 413
         raise Restforce::EntityTooLargeError.new(
           "413: Request Entity Too Large",
@@ -56,8 +56,7 @@ module Restforce
     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)
+      Restforce::ErrorCode.get_exception_class(error_code)
     end
   end
 end

data/lib/restforce/middleware.rb

@@ -16,6 +16,8 @@ module Restforce
     autoload :CustomHeaders,  'restforce/middleware/custom_headers'
 
     def initialize(app, client, options)
+      super(app)
+
       @app = app
       @client = client
       @options = options

data/lib/restforce/version.rb

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

data/lib/restforce.rb

@@ -15,7 +15,8 @@ module Restforce
   autoload :Middleware,     'restforce/middleware'
   autoload :Attachment,     'restforce/attachment'
   autoload :Document,       'restforce/document'
-  autoload :UploadIO,       'restforce/upload_io'
+  autoload :FilePart,       'restforce/file_part'
+  autoload :UploadIO,       'restforce/file_part' # Deprecated
   autoload :SObject,        'restforce/sobject'
   autoload :Client,         'restforce/client'
   autoload :Mash,           'restforce/mash'
@@ -31,6 +32,7 @@ module Restforce
     autoload :Base,           'restforce/concerns/base'
     autoload :API,            'restforce/concerns/api'
     autoload :BatchAPI,       'restforce/concerns/batch_api'
+    autoload :CompositeAPI,   'restforce/concerns/composite_api'
   end
 
   module Data
@@ -44,9 +46,10 @@ module Restforce
   Error               = Class.new(StandardError)
   ServerError         = Class.new(Error)
   AuthenticationError = Class.new(Error)
-  UnauthorizedError   = Class.new(Error)
+  UnauthorizedError   = Class.new(Faraday::ClientError)
   APIVersionError     = Class.new(Error)
   BatchAPIError       = Class.new(Error)
+  CompositeAPIError   = Class.new(Error)
 
   # Inherit from Faraday::ResourceNotFound for backwards-compatibility
   # Consumers of this library that rescue and handle Faraday::ResourceNotFound
@@ -60,11 +63,7 @@ module Restforce
   MatchesMultipleError= Class.new(ResponseError)
   EntityTooLargeError = Class.new(ResponseError)
 
-  module ErrorCode
-    def self.const_missing(constant_name)
-      const_set constant_name, Class.new(ResponseError)
-    end
-  end
+  require 'restforce/error_code'
 
   class << self
     # Alias for Restforce::Data::Client.new

data/restforce.gemspec

@@ -3,11 +3,11 @@
 require File.expand_path('lib/restforce/version', __dir__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Eric J. Holmes", "Tim Rogers"]
-  gem.email         = ["eric@ejholmes.net", "tim@gocardless.com"]
-  gem.description   = 'A lightweight ruby client for the Salesforce REST API.'
-  gem.summary       = 'A lightweight ruby client for the Salesforce REST API.'
-  gem.homepage      = "http://restforce.org/"
+  gem.authors       = ["Tim Rogers", "Eric J. Holmes"]
+  gem.email         = ["me@timrogers.co.uk", "eric@ejholmes.net"]
+  gem.description   = 'A lightweight Ruby client for the Salesforce REST API'
+  gem.summary       = 'A lightweight Ruby client for the Salesforce REST API'
+  gem.homepage      = "https://restforce.github.io/"
   gem.license       = "MIT"
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
@@ -19,23 +19,14 @@ Gem::Specification.new do |gem|
 
   gem.metadata = {
     'source_code_uri' => 'https://github.com/restforce/restforce',
-    'changelog_uri'   => 'https://github.com/restforce/restforce/blob/master/CHANGELOG.md'
+    'changelog_uri'   => 'https://github.com/restforce/restforce/blob/master/CHANGELOG.md',
+'rubygems_mfa_required' => 'true'
   }
 
-  gem.required_ruby_version = '>= 2.4'
+  gem.required_ruby_version = '>= 2.6'
 
-  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 'faraday', '< 1.9.0', '>= 0.9.0'
+  gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 2.0']
+  gem.add_dependency 'hashie', '>= 1.2.0', '< 6.0'
   gem.add_dependency 'jwt', ['>= 1.5.6']
-
-  gem.add_dependency 'hashie', '>= 1.2.0', '< 5.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.77.0'
-  gem.add_development_dependency 'simplecov', '~> 0.17.1'
-  gem.add_development_dependency 'webmock', '~> 3.7.6'
 end

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,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
 
@@ -408,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
 
@@ -425,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!
 
@@ -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