restforce 4.2.0 → 5.0.2

data/lib/restforce/file_part.rb

@@ -0,0 +1,24 @@
+# frozen_string_literal: true
+
+begin
+  require 'faraday/file_part'
+rescue LoadError
+  require 'faraday/upload_io'
+end
+
+module Restforce
+  if defined?(::Faraday::FilePart)
+    FilePart = Faraday::FilePart
+
+    # Deprecated
+    UploadIO = Faraday::FilePart
+  else
+    # Handle pre-1.0 versions of faraday
+    FilePart = Faraday::UploadIO
+    UploadIO = Faraday::UploadIO
+  end
+end
+
+# This patch is only needed with multipart-post < 2.0.0
+# 2.0.0 was released in 2013.
+require 'restforce/patches/parts' unless Parts::Part.method(:new).arity.abs == 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.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/middleware/authentication.rb

@@ -63,7 +63,10 @@ module Restforce
 
     # Internal: The parsed error response.
     def error_message(response)
-      "#{response.body['error']}: #{response.body['error_description']}"
+      return response.status.to_s unless response.body
+
+      "#{response.body['error']}: #{response.body['error_description']} " \
+        "(#{response.status})"
     end
 
     # Featured detect form encoding.

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

@@ -14,7 +14,7 @@ module Restforce
     end
 
     def url_prefix_set?
-      !!(connection.url_prefix&.host)
+      !!connection.url_prefix&.host
     end
   end
 end

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
 
@@ -36,7 +36,8 @@ module Restforce
     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/version.rb

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

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)
@@ -22,20 +22,19 @@ Gem::Specification.new do |gem|
     'changelog_uri'   => 'https://github.com/restforce/restforce/blob/master/CHANGELOG.md'
   }
 
-  gem.required_ruby_version = '>= 2.4'
+  gem.required_ruby_version = '>= 2.5'
 
-  gem.add_dependency 'faraday', '<= 1.0', '>= 0.9.0'
-  gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 1.0']
+  gem.add_dependency 'faraday', '<= 2.0', '>= 0.9.0'
+  gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 2.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_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.75.0'
-  gem.add_development_dependency 'simplecov', '~> 0.17.1'
-  gem.add_development_dependency 'webmock', '~> 3.7.6'
+  gem.add_development_dependency 'rubocop', '~> 0.90.0'
+  gem.add_development_dependency 'simplecov', '~> 0.19.0'
+  gem.add_development_dependency 'webmock', '~> 3.8.3'
 end

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
 
@@ -125,7 +137,7 @@ shared_examples_for Restforce::AbstractClient do
 
       it {
         should raise_error(
-          Faraday::Error::ResourceNotFound,
+          Faraday::ResourceNotFound,
           "#{error.first['errorCode']}: #{error.first['message']}"
         )
       }
@@ -239,7 +251,7 @@ shared_examples_for Restforce::AbstractClient do
                status: 404
 
       subject { lambda { destroy! } }
-      it { should raise_error Faraday::Error::ResourceNotFound }
+      it { should raise_error Faraday::ResourceNotFound }
     end
 
     context 'with success' do

data/spec/spec_helper.rb

@@ -15,8 +15,21 @@ 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
 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/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/unit/collection_spec.rb

@@ -62,4 +62,22 @@ describe Restforce::Collection do
       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

@@ -274,7 +274,7 @@ describe Restforce::Concerns::API do
       end
 
       it 'rescues exceptions' do
-        [Faraday::Error::ClientError].each do |exception_klass|
+        [Faraday::ClientError].each do |exception_klass|
           client.should_receive(:"#{method}!").
             with(*args).
             and_raise(exception_klass.new(nil))

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

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restforce::ErrorCode do
+  describe "mapping of error codes to classes" do
+    subject(:error_exception_classes) { described_class::ERROR_EXCEPTION_CLASSES }
+
+    let(:exception_classes) do
+      described_class.constants.
+        map { |constant_name| described_class.const_get(constant_name) }.
+        select { |constant| constant.is_a?(Class) }
+    end
+
+    it "maps all defined exception classes to an error code" do
+      exception_classes.each do |exception_class|
+        expect(error_exception_classes.values).to include(exception_class)
+      end
+    end
+
+    it "maps all error codes to a defined exception class" do
+      error_exception_classes.each_value do |mapped_exception_class|
+        expect(exception_classes).to include(mapped_exception_class)
+      end
+    end
+  end
+
+  describe '.get_exception_class' do
+    context 'when a non-existent error code is looked up' do
+      let(:new_error_code) { 'ANOTHER_NEW_ERROR_CODE' }
+      subject              { described_class.get_exception_class(new_error_code) }
+
+      it { should be Restforce::ResponseError }
+
+      it 'outputs a warning' do
+        expect(Warning).to receive(:warn)
+        subject
+      end
+    end
+
+    context 'when a known error code is looked up' do
+      let(:existing_error_code) { "ALL_OR_NONE_OPERATION_ROLLED_BACK" }
+      let(:existing_error)      { described_class::AllOrNoneOperationRolledBack }
+
+      subject do
+        described_class.get_exception_class(existing_error_code)
+      end
+
+      it { should < Restforce::ResponseError }
+
+      it 'returns existing error' do
+        should be(existing_error)
+      end
+
+      it 'does not output a warning' do
+        expect(Warning).to_not receive(:warn)
+        subject
+      end
+    end
+  end
+end

data/spec/unit/mash_spec.rb

@@ -33,6 +33,11 @@ describe Restforce::Mash do
         let(:input) { { 'attributes' => { 'type' => 'Document' } } }
         it { should eq Restforce::Document }
       end
+
+      context 'when the attributes value is nil' do
+        let(:input) { { 'attributes' => nil } }
+        it { should eq Restforce::SObject }
+      end
     end
 
     context 'else' do

data/spec/unit/middleware/authentication_spec.rb

@@ -57,10 +57,10 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson,
-                         Faraday::Adapter::NetHttp
+          should include FaradayMiddleware::ParseJson
         }
         its(:handlers) { should_not include Restforce::Middleware::Logger }
+        its(:adapter) { should eq Faraday::Adapter::NetHttp }
       end
 
       context 'with logging enabled' do
@@ -70,8 +70,9 @@ describe Restforce::Middleware::Authentication do
 
         its(:handlers) {
           should include FaradayMiddleware::ParseJson,
-                         Restforce::Middleware::Logger, Faraday::Adapter::NetHttp
+                         Restforce::Middleware::Logger
         }
+        its(:adapter) { should eq Faraday::Adapter::NetHttp }
       end
 
       context 'with specified adapter' do
@@ -80,8 +81,9 @@ describe Restforce::Middleware::Authentication do
         end
 
         its(:handlers) {
-          should include FaradayMiddleware::ParseJson, Faraday::Adapter::Typhoeus
+          should include FaradayMiddleware::ParseJson
         }
+        its(:adapter) { should eq Faraday::Adapter::Typhoeus }
       end
     end
 
@@ -89,4 +91,25 @@ describe Restforce::Middleware::Authentication do
       connection.ssl[:version].should eq(:TLSv1_2)
     end
   end
+
+  describe '.error_message' do
+    context 'when response.body is present' do
+      let(:response) {
+        Faraday::Response.new(
+          response_body: { 'error' => 'error', 'error_description' => 'description' },
+          status: 401
+        )
+      }
+
+      subject { middleware.error_message(response) }
+      it { should eq "error: description (401)" }
+    end
+
+    context 'when response.body is nil' do
+      let(:response) { Faraday::Response.new(status: 401) }
+
+      subject { middleware.error_message(response) }
+      it { should eq "401" }
+    end
+  end
 end