restforce 3.1.0 → 3.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 3352202fbc4460b9f83a50b93f32dce58142b7ad
-  data.tar.gz: a2680033dec036183f9fcb767cb4935f17ecad27
+SHA256:
+  metadata.gz: 41d61a57996195a4809acd8e3d16d79dcf1ff9b1637ddd0e4c8b12cb8f967f5c
+  data.tar.gz: 41a090599ea254b58142ffdd0ed4fae33bad9d99fce472260d187018768a0cac
 SHA512:
-  metadata.gz: 8ef0d7d4a741961ce17a76fb5b93e3906f216bbe7bea5dbe2598eead312571e859392e4a54f32414fda1cffb0ffca9a4a3e8283f9eb333baea58529e51d9f86a
-  data.tar.gz: b6f445ee78e3e217b9279b7958744281e9d16dcb5cb7e1606c1a1cdc7d6f462afc8c7278a1de4ce751fd929a8372d5fbdd22c19148bc504b64f6790f1e52cfdb
+  metadata.gz: 7be41c73c7e8aa79f1d5246e339e320e567cfddee5f317dc8286279d3fba0cbcf0bf631524330c2b4e2fad6ba71c6da6c88fa63f0af871fad04e9c5e43a0aaed
+  data.tar.gz: 42fe28bb527485254263015de5c5877a6371e59f14eb2aa6048fd3821356d17c143801bf389603632100eae860559f644c816727dcd0dc651d97aad30839d34a

data/.rubocop.yml

@@ -4,46 +4,44 @@ inherit_from: .rubocop_todo.yml
 
 AllCops:
   DisplayCopNames: true
-  Include:
-    - Rakefile
   Exclude:
     - .*/**/*
     - vendor/**/*
   TargetRubyVersion: 2.3
 
 # Limit lines to 80 characters.
-LineLength:
+Metrics/LineLength:
   Max: 90
 
-ClassLength:
+Metrics/ClassLength:
   Enabled: false
 
-ModuleLength:
+Metrics/ModuleLength:
   Enabled: false
 
 # Avoid methods longer than 30 lines of code
-MethodLength:
+Metrics/MethodLength:
   CountComments: false  # count full line comments?
   Max: 87
 
 # Avoid single-line methods.
-SingleLineMethods:
+Style/SingleLineMethods:
   AllowIfMethodIsEmpty: true
 
-StringLiterals:
+Style/StringLiterals:
   Enabled: false
 
-GlobalVars:
+Style/GlobalVars:
   Enabled: false # We use them Redis + StatsD (though maybe we shouldn't?)
 
 # Wants underscores in all large numbers. Pain in the ass for things like
 # unix timestamps.
-NumericLiterals:
+Style/NumericLiterals:
   Enabled: false
 
 # Wants you to use the same argument names for every reduce. This seems kinda
 # naff compared to naming them semantically
-SingleLineBlockParams:
+Style/SingleLineBlockParams:
   Enabled: false
 
 Style/SignalException:

data/.rubocop_todo.yml

@@ -1,117 +1,164 @@
-# This configuration was generated by `rubocop --auto-gen-config`
-# on 2015-06-06 22:47:07 +0100 using RuboCop version 0.32.0.
+# This configuration was generated by
+# `rubocop --auto-gen-config`
+# on 2019-10-09 21:39:40 +0100 using RuboCop version 0.75.0.
 # The point is for the user to remove these configuration records
 # one by one as the offenses are removed from the code base.
 # Note that changes in the inspected code, or installation of new
 # versions of RuboCop, may require this file to be generated again.
 
-# Offense count: 50
+# Offense count: 17
 # Cop supports --auto-correct.
+# Configuration parameters: AllowMultipleStyles, EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle.
+# SupportedHashRocketStyles: key, separator, table
+# SupportedColonStyles: key, separator, table
+# SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
+Layout/AlignHash:
+  Exclude:
+    - 'lib/restforce/middleware/logger.rb'
+    - 'restforce.gemspec'
+    - 'spec/integration/abstract_client_spec.rb'
+    - 'spec/unit/config_spec.rb'
+
+# Offense count: 2
+# Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle, IndentationWidth.
+# SupportedStyles: special_inside_parentheses, consistent, align_braces
+Layout/IndentFirstHashElement:
+  Exclude:
+    - 'lib/restforce/concerns/connection.rb'
+
+# Offense count: 1
+# Cop supports --auto-correct.
+# Configuration parameters: AllowForAlignment.
+Layout/SpaceAroundOperators:
+  Exclude:
+    - 'lib/restforce.rb'
+
+# Offense count: 8
+# Cop supports --auto-correct.
+# Configuration parameters: IgnoreEmptyBlocks, AllowUnusedKeywordArguments.
 Lint/UnusedBlockArgument:
-  Enabled: false
+  Exclude:
+    - 'lib/restforce/concerns/api.rb'
+    - 'lib/restforce/concerns/batch_api.rb'
+    - 'lib/restforce/middleware/multipart.rb'
+    - 'spec/unit/config_spec.rb'
 
-# Offense count: 187
+# Offense count: 9
 Metrics/AbcSize:
-  Max: 61
+  Max: 38
 
-# Offense count: 26
+# Offense count: 1
 Metrics/CyclomaticComplexity:
-  Max: 10
+  Max: 8
 
-# Offense count: 11
+# Offense count: 1
 Metrics/PerceivedComplexity:
-  Max: 10
+  Max: 9
 
-# Offense count: 12
-Naming/AccessorMethodName:
-  Enabled: false
-
-# Offense count: 164
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
-Layout/AlignHash:
-  Enabled: false
+# Offense count: 5
+# Configuration parameters: EnforcedStyleForLeadingUnderscores.
+# SupportedStylesForLeadingUnderscores: disallowed, required, optional
+Naming/MemoizedInstanceVariableName:
+  Exclude:
+    - 'lib/restforce/concerns/picklists.rb'
+    - 'lib/restforce/concerns/streaming.rb'
+
+# Offense count: 2
+# Configuration parameters: NamePrefix, NamePrefixBlacklist, NameWhitelist, MethodDefinitionMacros.
+# NamePrefix: is_, has_, have_
+# NamePrefixBlacklist: is_, has_, have_
+# NameWhitelist: is_a?
+# MethodDefinitionMacros: define_method, define_singleton_method
+Naming/PredicateName:
+  Exclude:
+    - 'spec/**/*'
+    - 'lib/restforce/collection.rb'
+    - 'lib/restforce/middleware/multipart.rb'
 
-# Offense count: 3
+# Offense count: 12
 # Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles, ProceduralMethods, FunctionalMethods, IgnoredMethods.
+# Configuration parameters: EnforcedStyle, ProceduralMethods, FunctionalMethods, IgnoredMethods, AllowBracesOnProceduralOneLiners.
+# SupportedStyles: line_count_based, semantic, braces_for_chaining, always_braces
+# ProceduralMethods: benchmark, bm, bmbm, create, each_with_object, measure, new, realtime, tap, with_object
+# FunctionalMethods: let, let!, subject, watch
+# IgnoredMethods: lambda, proc, it
 Style/BlockDelimiters:
-  Enabled: false
+  Exclude:
+    - 'lib/restforce/concerns/batch_api.rb'
+    - 'spec/support/event_machine.rb'
+    - 'spec/support/middleware.rb'
+    - 'spec/unit/concerns/base_spec.rb'
+    - 'spec/unit/concerns/batch_api_spec.rb'
+    - 'spec/unit/concerns/caching_spec.rb'
+    - 'spec/unit/concerns/streaming_spec.rb'
+    - 'spec/unit/middleware/authentication_spec.rb'
+    - 'spec/unit/middleware/mashify_spec.rb'
 
-# Offense count: 128
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/ClassAndModuleChildren:
-  Enabled: false
-
-# Offense count: 21
-# Cop supports --auto-correct.
-Layout/ClosingParenthesisIndentation:
-  Enabled: false
-
-# Offense count: 13
+# Offense count: 12
 # Cop supports --auto-correct.
-# Configuration parameters: Keywords.
-Style/CommentAnnotation:
-  Enabled: false
-
-# Offense count: 743
+# Configuration parameters: AutoCorrect, EnforcedStyle.
+# SupportedStyles: nested, compact
+Style/ClassAndModuleChildren:
+  Exclude:
+    - 'lib/restforce/middleware/authentication.rb'
+    - 'lib/restforce/middleware/authentication/password.rb'
+    - 'lib/restforce/middleware/authentication/token.rb'
+    - 'lib/restforce/middleware/authorization.rb'
+    - 'lib/restforce/middleware/caching.rb'
+    - 'lib/restforce/middleware/custom_headers.rb'
+    - 'lib/restforce/middleware/gzip.rb'
+    - 'lib/restforce/middleware/instance_url.rb'
+    - 'lib/restforce/middleware/logger.rb'
+    - 'lib/restforce/middleware/mashify.rb'
+    - 'lib/restforce/middleware/multipart.rb'
+    - 'lib/restforce/middleware/raise_error.rb'
+
+# Offense count: 36
 Style/Documentation:
   Enabled: false
 
-# Offense count: 9
+# Offense count: 3
 Style/DoubleNegation:
-  Enabled: false
+  Exclude:
+    - 'lib/restforce/concerns/picklists.rb'
+    - 'lib/restforce/middleware/instance_url.rb'
 
-# Offense count: 109
+# Offense count: 1
 # Configuration parameters: MinBodyLength.
 Style/GuardClause:
-  Enabled: false
-
-# Offense count: 48
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Layout/IndentHash:
-  Enabled: false
+  Exclude:
+    - 'lib/restforce/middleware/authentication.rb'
 
-# Offense count: 70
+# Offense count: 25
 # Cop supports --auto-correct.
+# Configuration parameters: EnforcedStyle.
+# SupportedStyles: line_count_dependent, lambda, literal
 Style/Lambda:
-  Enabled: false
-
-# Offense count: 577
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Layout/MultilineOperationIndentation:
-  Enabled: false
-
-# Offense count: 21
-# Configuration parameters: NamePrefix, NamePrefixBlacklist.
-Naming/PredicateName:
-  Enabled: false
+  Exclude:
+    - 'lib/restforce/config.rb'
+    - 'spec/integration/abstract_client_spec.rb'
+    - 'spec/unit/concerns/base_spec.rb'
+    - 'spec/unit/concerns/streaming_spec.rb'
+    - 'spec/unit/middleware/authentication_spec.rb'
+    - 'spec/unit/middleware/authorization_spec.rb'
+    - 'spec/unit/middleware/custom_headers_spec.rb'
+    - 'spec/unit/middleware/gzip_spec.rb'
+    - 'spec/unit/middleware/instance_url_spec.rb'
+    - 'spec/unit/middleware/logger_spec.rb'
+    - 'spec/unit/sobject_spec.rb'
 
-# Offense count: 4
-# Cop supports --auto-correct.
-Style/Proc:
-  Enabled: false
-
-# Offense count: 173
+# Offense count: 5
 # Cop supports --auto-correct.
 Style/RedundantSelf:
-  Enabled: false
+  Exclude:
+    - 'lib/restforce/mash.rb'
+    - 'lib/restforce/sobject.rb'
 
-# Offense count: 28
-# Cop supports --auto-correct.
-Layout/SpaceBeforeFirstArg:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: MultiSpaceAllowedForOperators.
-Layout/SpaceAroundOperators:
-  Enabled: false
-
-# Offense count: 5
+# Offense count: 1
 # Cop supports --auto-correct.
 # Configuration parameters: ExactNameMatch, AllowPredicates, AllowDSLWriters, IgnoreClassMethods, Whitelist.
+# Whitelist: to_ary, to_a, to_c, to_enum, to_h, to_hash, to_i, to_int, to_io, to_open, to_path, to_proc, to_r, to_regexp, to_str, to_s, to_sym
 Style/TrivialAccessors:
-  Enabled: false
+  Exclude:
+    - 'lib/restforce/middleware.rb'

data/CHANGELOG.md

@@ -1,3 +1,10 @@
+## 3.2.0 (Oct 9, 2019)
+
+* Add support for the Batch API (@gaiottino, @teoulas)
+* Return specific exceptions for errors that might be returned from Salesforce.com - instead of getting a generic `Faraday::Error::ClientError`, you might get something like a `Restforce::EntityTooLargeError` (@boblail)
+* Expose the full response in exceptions' messages to make debugging easier (@boblail)
+* Properly escape IDs with spaces in them when working with existing records (@pushups)
+
 ## 3.1.0 (Aug 16, 2018)
 
 * Add support for replaying missed messages when using the Salesforce Streaming API (@andreimaxim, @drteeth, @panozzaj)
@@ -8,13 +15,19 @@
 
 ## 3.0.0 (Aug 2, 2018)
 
-* __Deprecate support for Ruby 2.0, 2.1 and 2.2__, since [even Ruby 2.2 reached its end-of-life]##(https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/) in June 2018. (This is the only breaking change included in this version.)
+* __Deprecate support for Ruby 2.0, 2.1 and 2.2__, since [even Ruby 2.2 reached its end-of-life](https://www.ruby-lang.org/en/news/2018/06/20/support-of-ruby-2-2-has-ended/) in June 2018. (This is the only breaking change included in this version.)
 * Fix `NoMethodError` when trying to upsert a record using a `Fixnum` as the external ID (@AlexandruCD)
 * Escape record IDs passed in to the client to identify records to find, delete, etc. (@jmdx)
 * Stop relying on our middleware for Gzip compression if you're using `httpclient`, since Faraday enables this automatically using `httpclient`'s built-in support (@shivanshgaur)
 * Fix `get_updated` and `get_deleted` API calls by removing the erroneous leading forward slash from the path (@scottolsen)
 * Fix unpacking of dependent picklist options (@parkm)
 
+## 2.5.4 (May 15, 2019)
+
+See the [`v2`](https://github.com/restforce/restforce/tree/v2) branch for this release.
+
+* Escape record IDs passed in to the client to identify records to find, delete, etc. (@jmdx, @apanzerj)
+
 ## 2.5.3 (Apr 25, 2017)
 
 * Raise an error where a custom external ID field name is supplied to `upsert` and `upsert!`, but it is missing from the provided attributes (@velveret)

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 gemspec
 
-gem 'faraday', '~> 0.15.0'
+gem 'faraday', '~> 0.17.0'
 gem 'jruby-openssl', platforms: :jruby
 gem 'rake'
 

data/README.md

@@ -25,7 +25,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 3.1.0'
+    gem 'restforce', '~> 3.2.0'
 
 And then execute:
 
@@ -43,7 +43,7 @@ This gem is versioned using [Semantic Versioning](http://semver.org/), so you ca
 
 Restforce is designed with flexibility and ease of use in mind. By default, all API calls will
 return [Hashie::Mash](https://github.com/intridea/hashie/tree/v1.2.0) objects,
-so you can do things like `client.query('select Id, (select Name from Children__r) from Account').Children__r.first.Name`.
+so you can do things like `client.query('select Id, (select Name from Children__r) from Account').first.Children__r.first.Name`.
 
 ### Initialization
 
@@ -523,7 +523,7 @@ require 'faye'
 # Initialize a client with your username/password/oauth token/etc.
 client = Restforce.new(username: 'foo',
                        password: 'bar',
-                       security_token: 'security token'
+                       security_token: 'security token',
                        client_id: 'client_id',
                        client_secret: 'client_secret')
 
@@ -585,7 +585,7 @@ memory using a Hash, stores a timestamp and has some rudimentary logic that
 will use one of the magic IDs depending on the value of the timestamp:
 
 ```ruby
-class SimpleReplayHander
+class SimpleReplayHandler
 
   MAX_AGE = 86_400 # 24 hours
 

data/lib/restforce.rb

@@ -29,6 +29,7 @@ module Restforce
     autoload :Verbs,          'restforce/concerns/verbs'
     autoload :Base,           'restforce/concerns/base'
     autoload :API,            'restforce/concerns/api'
+    autoload :BatchAPI,       'restforce/concerns/batch_api'
   end
 
   module Data
@@ -44,6 +45,25 @@ module Restforce
   AuthenticationError = Class.new(Error)
   UnauthorizedError   = Class.new(Error)
   APIVersionError     = Class.new(Error)
+  BatchAPIError       = Class.new(Error)
+
+  # Inherit from Faraday::Error::ResourceNotFound for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::Error::ResourceNotFound
+  # can continue to do so.
+  NotFoundError       = Class.new(Faraday::Error::ResourceNotFound)
+
+  # Inherit from Faraday::Error::ClientError for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::Error::ClientError
+  # can continue to do so.
+  ResponseError       = Class.new(Faraday::Error::ClientError)
+  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
 
   class << self
     # Alias for Restforce::Data::Client.new
@@ -74,7 +94,7 @@ module Restforce
       self
     end
   end
-  Object.send :include, Restforce::CoreExtensions unless Object.respond_to? :tap
+  Object.include Restforce::CoreExtensions unless Object.respond_to? :tap
 end
 
 if ENV['PROXY_URI']

data/lib/restforce/abstract_client.rb

@@ -7,5 +7,6 @@ module Restforce
     include Restforce::Concerns::Authentication
     include Restforce::Concerns::Caching
     include Restforce::Concerns::API
+    include Restforce::Concerns::BatchAPI
   end
 end

data/lib/restforce/attachment.rb

@@ -17,6 +17,7 @@ module Restforce
 
     def ensure_body
       return true if self.Body?
+
       raise 'You need to query the Body for the record first.'
     end
   end

data/lib/restforce/concerns/api.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'erb'
 require 'uri'
 require 'restforce/concerns/verbs'
 
@@ -320,6 +321,7 @@ module Restforce
       def update!(sobject, attrs)
         id = attrs.fetch(attrs.keys.find { |k, v| k.to_s.casecmp('id').zero? }, nil)
         raise ArgumentError, 'ID field missing from provided attributes' unless id
+
         attrs_without_id = attrs.reject { |k, v| k.to_s.casecmp("id").zero? }
         api_patch "sobjects/#{sobject}/#{CGI.escape(id)}", attrs_without_id
         true
@@ -377,7 +379,8 @@ module Restforce
               api_post "sobjects/#{sobject}/#{field}", attrs
             end
           else
-            api_patch "sobjects/#{sobject}/#{field}/#{CGI.escape(external_id)}", attrs
+            api_patch "sobjects/#{sobject}/#{field}/" \
+              "#{ERB::Util.url_encode(external_id)}", attrs
           end
 
         response.body.respond_to?(:fetch) ? response.body.fetch('id', true) : true
@@ -414,7 +417,7 @@ module Restforce
       # Returns true of the sobject was successfully deleted.
       # Raises an exception if an error is returned from Salesforce.
       def destroy!(sobject, id)
-        api_delete "sobjects/#{sobject}/#{CGI.escape(id)}"
+        api_delete "sobjects/#{sobject}/#{ERB::Util.url_encode(id)}"
         true
       end
 
@@ -428,9 +431,9 @@ module Restforce
       # Returns the Restforce::SObject sobject record.
       def find(sobject, id, field = nil)
         url = if field
-                "sobjects/#{sobject}/#{field}/#{CGI.escape(id)}"
+                "sobjects/#{sobject}/#{field}/#{ERB::Util.url_encode(id)}"
               else
-                "sobjects/#{sobject}/#{CGI.escape(id)}"
+                "sobjects/#{sobject}/#{ERB::Util.url_encode(id)}"
               end
         api_get(url).body
       end
@@ -446,9 +449,9 @@ module Restforce
       #
       def select(sobject, id, select, field = nil)
         path = if field
-                 "sobjects/#{sobject}/#{field}/#{CGI.escape(id)}"
+                 "sobjects/#{sobject}/#{field}/#{ERB::Util.url_encode(id)}"
                else
-                 "sobjects/#{sobject}/#{CGI.escape(id)}"
+                 "sobjects/#{sobject}/#{ERB::Util.url_encode(id)}"
                end
 
         path = "#{path}?fields=#{select.join(',')}" if select&.any?

data/lib/restforce/concerns/batch_api.rb

@@ -0,0 +1,87 @@
+# frozen_string_literal: true
+
+require 'restforce/concerns/verbs'
+
+module Restforce
+  module Concerns
+    module BatchAPI
+      extend Restforce::Concerns::Verbs
+
+      define_verbs :post
+
+      def batch(halt_on_error: false)
+        subrequests = Subrequests.new(options)
+        yield(subrequests)
+        subrequests.requests.each_slice(25).map do |requests|
+          properties = {
+            batchRequests: requests,
+            haltOnError: halt_on_error
+          }
+          response = api_post('composite/batch', properties.to_json)
+          body = response.body
+          results = body['results']
+          if halt_on_error && body['hasErrors']
+            last_error_index = results.rindex { |result| result['statusCode'] != 412 }
+            last_error = results[last_error_index]
+            raise BatchAPIError, last_error['result'][0]['errorCode']
+          end
+          results.map(&:compact)
+        end.flatten
+      end
+
+      def batch!(&block)
+        batch(halt_on_error: true, &block)
+      end
+
+      class Subrequests
+        def initialize(options)
+          @options = options
+          @requests = []
+        end
+        attr_reader :options, :requests
+
+        def create(sobject, attrs)
+          requests << { method: 'POST', url: batch_api_path(sobject), richInput: attrs }
+        end
+
+        def update(sobject, attrs)
+          id = attrs.fetch(attrs.keys.find { |k, v| k.to_s.casecmp?('id') }, nil)
+          raise ArgumentError, 'Id field missing from attrs.' unless id
+
+          attrs_without_id = attrs.reject { |k, v| k.to_s.casecmp?('id') }
+          requests << {
+            method: 'PATCH',
+            url: batch_api_path("#{sobject}/#{id}"),
+            richInput: attrs_without_id
+          }
+        end
+
+        def destroy(sobject, id)
+          requests << { method: 'DELETE', url: batch_api_path("#{sobject}/#{id}") }
+        end
+
+        def upsert(sobject, ext_field, attrs)
+          raise ArgumentError, 'External id field missing.' unless ext_field
+
+          ext_id = attrs.fetch(attrs.keys.find { |k, v|
+            k.to_s.casecmp?(ext_field.to_s)
+          }, nil)
+          raise ArgumentError, 'External id missing from attrs.' unless ext_id
+
+          attrs_without_ext_id = attrs.reject { |k, v| k.to_s.casecmp?(ext_field) }
+          requests << {
+            method: 'PATCH',
+            url: batch_api_path("#{sobject}/#{ext_field}/#{ext_id}"),
+            richInput: attrs_without_ext_id
+          }
+        end
+
+        private
+
+        def batch_api_path(path)
+          "v#{options[:api_version]}/sobjects/#{path}"
+        end
+      end
+    end
+  end
+end

data/lib/restforce/concerns/canvas.rb

@@ -5,6 +5,7 @@ module Restforce
     module Canvas
       def decode_signed_request(signed_request)
         raise 'client_secret not set.' unless options[:client_secret]
+
         SignedRequest.decode(signed_request, options[:client_secret])
       end
     end

data/lib/restforce/concerns/picklists.rb

@@ -34,6 +34,7 @@ module Restforce
           @field = field
           @valid_for = options.delete(:valid_for)
           raise "#{field} is not a dependent picklist" if @valid_for && !dependent?
+
           replace(picklist_values)
         end
 

data/lib/restforce/concerns/streaming.rb

@@ -62,9 +62,7 @@ module Restforce
 
         def outgoing(message, callback)
           # Leave non-subscribe messages alone
-          unless message['channel'] == '/meta/subscribe'
-            return callback.call(message)
-          end
+          return callback.call(message) unless message['channel'] == '/meta/subscribe'
 
           channel = message['subscription'].gsub('/topic/', '')
 

data/lib/restforce/config.rb

@@ -34,6 +34,7 @@ module Restforce
 
     def log(message)
       return unless Restforce.log?
+
       configuration.logger.send(configuration.log_level, message)
     end
   end

data/lib/restforce/document.rb

@@ -17,6 +17,7 @@ module Restforce
 
     def ensure_body
       return true if self.Body?
+
       raise 'You need to query the Body for the record first.'
     end
   end

data/lib/restforce/middleware/multipart.rb

@@ -49,6 +49,7 @@ module Restforce
       # Files
       params.each do |k, v|
         next unless v.respond_to? :content_type
+
         parts << Faraday::Parts::Part.new(boundary,
                                           k.to_s,
                                           v)

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.1.0'
+  VERSION = '3.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"]
@@ -31,10 +31,10 @@ Gem::Specification.new do |gem|
 
   gem.add_dependency 'hashie', ['>= 1.2.0', '< 4.0']
 
+  gem.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
   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 'rubocop', '~> 0.75.0'
+  gem.add_development_dependency 'simplecov', '~> 0.17.1'
+  gem.add_development_dependency 'webmock', '~> 3.7.6'
 end

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/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/middleware/raise_error_spec.rb

@@ -13,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
@@ -49,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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 3.1.0
+  version: 3.2.0
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,28 +9,28 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-08-16 00:00:00.000000000 Z
+date: 2019-10-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
-      - !ruby/object:Gem::Version
-        version: '1.0'
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
+    - - "<="
+      - !ruby/object:Gem::Version
+        version: '1.0'
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -86,89 +86,89 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: faye
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: 2.14.0
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: webmock
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.4.0
+        version: 2.14.0
 - !ruby/object:Gem::Dependency
-  name: simplecov
+  name: rspec_junit_formatter
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.3.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.15.0
+        version: 0.3.0
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.75.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.50.0
+        version: 0.75.0
 - !ruby/object:Gem::Dependency
-  name: rspec_junit_formatter
+  name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.17.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.17.1
 - !ruby/object:Gem::Dependency
-  name: faye
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.6
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - "~>"
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 3.7.6
 description: A lightweight ruby client for the Salesforce REST API.
 email:
 - eric@ejholmes.net
@@ -197,6 +197,7 @@ files:
 - lib/restforce/concerns/api.rb
 - lib/restforce/concerns/authentication.rb
 - lib/restforce/concerns/base.rb
+- lib/restforce/concerns/batch_api.rb
 - lib/restforce/concerns/caching.rb
 - lib/restforce/concerns/canvas.rb
 - lib/restforce/concerns/connection.rb
@@ -281,6 +282,7 @@ files:
 - spec/unit/concerns/api_spec.rb
 - spec/unit/concerns/authentication_spec.rb
 - spec/unit/concerns/base_spec.rb
+- spec/unit/concerns/batch_api_spec.rb
 - spec/unit/concerns/caching_spec.rb
 - spec/unit/concerns/canvas_spec.rb
 - spec/unit/concerns/connection_spec.rb
@@ -323,8 +325,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.14.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A lightweight ruby client for the Salesforce REST API.
@@ -379,6 +380,7 @@ test_files:
 - spec/unit/concerns/api_spec.rb
 - spec/unit/concerns/authentication_spec.rb
 - spec/unit/concerns/base_spec.rb
+- spec/unit/concerns/batch_api_spec.rb
 - spec/unit/concerns/caching_spec.rb
 - spec/unit/concerns/canvas_spec.rb
 - spec/unit/concerns/connection_spec.rb