restforce 2.5.4 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 1b60a2cf872111bbd40293801c0f6754f74ccfec611b07a8010db4762b8f7e0b
-  data.tar.gz: d3764b52e9344cbdda35fa956599ee339d4fd80ec33db8b52714572be49bb649
+  metadata.gz: 9e4311062c172c1fd0706872045d29fed90d5b36df5f6c2656d88c37ac680fb2
+  data.tar.gz: f8b6e07bd7533342229f0bb02ef00a731dda64990927bc2c8d822fbfa46f5a29
 SHA512:
-  metadata.gz: 3ffefa209de00f2be7134324d1c04820e99790b87fb20afe3d60ff6f43cfb790ae964e94dd8a482f8e32803e1dcfc109140905c2ffb14cf9feba7f26de0693fd
-  data.tar.gz: 7a6f11af9e118ab23cd606da4e1943107aca180470178df3ac50beea7e5c22e30d394736e2720609d81a7d7275edbe9cc7ec14079d0b9a3d6f8346807a845a57
+  metadata.gz: 33d02a24a1fc9e7efd40a318f75a48992215b759bcb33c8860a0e4e49fbc5a2eac13cce908dac4605164af58fa6e43473b753668926e0875deeba63eac4cc51c
+  data.tar.gz: 1a6155b0ec55633ebf061e7e709b7e391fe266563f5476b658040139e977ea00baf356602aacf8c5b2aef313c0b48296bfad984d444fe437249424810b567512

data/.circleci/config.yml

@@ -0,0 +1,56 @@
+version: 2
+
+references:
+  steps: &steps
+    - checkout
+
+    - run:
+        name: Update Bundler
+        command: gem install bundler
+
+    - run:
+        name: Install dependencies from .gemspec
+        command: bundle install --jobs=4 --retry=3 --path vendor/bundle
+
+    - run:
+        name: Run RSpec tests
+        command: |
+          mkdir /tmp/test-results
+          
+          bundle exec rspec --format progress \
+                          --format RspecJunitFormatter \
+                          --out /tmp/test-results/rspec.xml \
+                          --format progress \
+                          spec/**/*_spec.rb
+
+    - run:
+        name: Check code style with Rubocop
+        command: bundle exec rubocop
+
+    - store_test_results:
+        path: /tmp/test-results
+    - store_artifacts:
+        path: /tmp/test-results
+        destination: test-results
+
+jobs:
+  build-ruby265:
+    docker:
+       - image: circleci/ruby:2.6.5
+    steps: *steps
+  build-ruby257:
+    docker:
+       - image: circleci/ruby:2.5.7
+    steps: *steps
+  build-ruby249:
+    docker:
+       - image: circleci/ruby:2.4.9
+    steps: *steps
+
+workflows:
+  version: 2
+  tests:
+    jobs:
+      - build-ruby265
+      - build-ruby257
+      - build-ruby249

data/.rubocop.yml

@@ -3,52 +3,52 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  RunRailsCops: false
-  Include:
-    - Rakefile
+  DisplayCopNames: true
   Exclude:
     - .*/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.4
 
 # 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:
   EnforcedStyle: 'only_raise'
 
 # Use trailing rather than leading dots on multi-line call chains
-Style/DotPosition:
+Layout/DotPosition:
   EnforcedStyle: trailing
 
 # Allow non-ASCII characters (e.g. £) in comments
@@ -56,5 +56,18 @@ Style/AsciiComments:
   Enabled: false
 
 # Allow method names beginning with capital letters to match Salesforce conventions
-Style/MethodName:
+Naming/MethodName:
   Enabled: false
+
+Metrics/BlockLength:
+  Exclude:
+    - spec/**/*
+    - restforce.gemspec
+
+Naming/FileName:
+  Exclude:
+    - Gemfile
+    - Guardfile
+
+Lint/UriEscapeUnescape:
+  Enabled: false

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
-Style/AccessorMethodName:
-  Enabled: false
-
-# Offense count: 164
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
-Style/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.
-Style/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
+  Exclude:
+    - 'lib/restforce/middleware/authentication.rb'
 
-# Offense count: 48
-# Cop supports --auto-correct.
-# Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/IndentHash:
-  Enabled: false
-
-# 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.
-Style/MultilineOperationIndentation:
-  Enabled: false
-
-# Offense count: 21
-# Configuration parameters: NamePrefix, NamePrefixBlacklist.
-Style/PredicateName:
-  Enabled: false
-
-# Offense count: 4
-# Cop supports --auto-correct.
-Style/Proc:
-  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: 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.
-Style/SingleSpaceBeforeFirstArg:
-  Enabled: false
-
-# Offense count: 3
-# Cop supports --auto-correct.
-# Configuration parameters: MultiSpaceAllowedForOperators.
-Style/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,14 +1,48 @@
-## 2.5.3 (April 25, 2017)
+## 4.0.0 (Oct 9, 2019)
+
+* __Deprecate support for Ruby 2.3__, since [Ruby 2.3 reached its end-of-life](https://www.ruby-lang.org/en/news/2019/03/31/support-of-ruby-2-3-has-ended/) in March 2019. (This is the only breaking change included in this version.)
+
+## 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)
+
+## 3.0.1 (Aug 4, 2018)
+
+* Fix `NoMethodError` when upserting an existing record (@opti)
+
+## 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.)
+* 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)
 * Use the Restforce client's configured SSL options for authentication requests (@jvdp)
-* Fix bug where `upsert` and `upsert!` mutate the provided attributes, previously fixed in [v1.5.3](https://github.com/ejholmes/restforce/blob/master/CHANGELOG.md#153-jun-26-2015) (@velveret)
+* Fix bug where `upsert` and `upsert!` mutate the provided attributes, previously fixed in [v1.5.3](https://github.com/restforce/restforce/blob/master/CHANGELOG.md#153-jun-26-2015) (@velveret)
 
 
 ## 2.5.2 (Apr 3, 2017)
 
 * Ensure `Restforce::Middleware::Logger` is the last Faraday middleware to be called so everything is properly logged (including the effects of the `Gzip` and `CustomHeaders` middlewares which were previously running after it) (@jonnymacs)
-* Suppress [Hashie](https://github.com/intridea/hashie) warnings when using Hashie v3.5.0 or later (see [#295](https://github.com/ejholmes/restforce/pull/295) for details) (@janraasch)
+* Suppress [Hashie](https://github.com/intridea/hashie) warnings when using Hashie v3.5.0 or later (see [#295](https://github.com/restforce/restforce/pull/295) for details) (@janraasch)
 
 ## 2.5.1 (Mar 16, 2017)