restforce 2.5.4 → 3.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA256:
-  metadata.gz: 1b60a2cf872111bbd40293801c0f6754f74ccfec611b07a8010db4762b8f7e0b
-  data.tar.gz: d3764b52e9344cbdda35fa956599ee339d4fd80ec33db8b52714572be49bb649
+SHA1:
+  metadata.gz: a6f15b3e19ea1b3b90368ade66b38fafbe055997
+  data.tar.gz: d30a34bf7ea9ca49efe0edbf1034d60080f5b837
 SHA512:
-  metadata.gz: 3ffefa209de00f2be7134324d1c04820e99790b87fb20afe3d60ff6f43cfb790ae964e94dd8a482f8e32803e1dcfc109140905c2ffb14cf9feba7f26de0693fd
-  data.tar.gz: 7a6f11af9e118ab23cd606da4e1943107aca180470178df3ac50beea7e5c22e30d394736e2720609d81a7d7275edbe9cc7ec14079d0b9a3d6f8346807a845a57
+  metadata.gz: 97ddd07dbcf2415d01d7940002221d473a81343365abafdde740dc1597c4581850bdbfb571c2a747df94a586d79ce7814a76f1784e97dc9b9136bbb44be6e718
+  data.tar.gz: 9a91f9b00c0cce33da5593b3c12dd106f7a48dd8ab5005f27255b14f6f0cd93500975571413b570ea154201ef6a86f1b44785cb8261934bcd91c7ac64c2e800a

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-ruby251:
+    docker:
+       - image: circleci/ruby:2.5.1
+    steps: *steps
+  build-ruby244:
+    docker:
+       - image: circleci/ruby:2.4.4
+    steps: *steps
+  build-ruby237:
+    docker:
+       - image: circleci/ruby:2.3.7
+    steps: *steps
+
+workflows:
+  version: 2
+  tests:
+    jobs:
+      - build-ruby251
+      - build-ruby244
+      - build-ruby237

data/.rubocop.yml

@@ -3,11 +3,13 @@
 inherit_from: .rubocop_todo.yml
 
 AllCops:
-  RunRailsCops: false
+  DisplayCopNames: true
   Include:
     - Rakefile
   Exclude:
     - .*/**/*
+    - vendor/**/*
+  TargetRubyVersion: 2.3
 
 # Limit lines to 80 characters.
 LineLength:
@@ -48,7 +50,7 @@ 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 +58,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

@@ -23,13 +23,13 @@ Metrics/PerceivedComplexity:
   Max: 10
 
 # Offense count: 12
-Style/AccessorMethodName:
+Naming/AccessorMethodName:
   Enabled: false
 
 # Offense count: 164
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedHashRocketStyle, EnforcedColonStyle, EnforcedLastArgumentHashStyle, SupportedLastArgumentHashStyles.
-Style/AlignHash:
+Layout/AlignHash:
   Enabled: false
 
 # Offense count: 3
@@ -45,7 +45,7 @@ Style/ClassAndModuleChildren:
 
 # Offense count: 21
 # Cop supports --auto-correct.
-Style/ClosingParenthesisIndentation:
+Layout/ClosingParenthesisIndentation:
   Enabled: false
 
 # Offense count: 13
@@ -70,7 +70,7 @@ Style/GuardClause:
 # Offense count: 48
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/IndentHash:
+Layout/IndentHash:
   Enabled: false
 
 # Offense count: 70
@@ -81,12 +81,12 @@ Style/Lambda:
 # Offense count: 577
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, SupportedStyles.
-Style/MultilineOperationIndentation:
+Layout/MultilineOperationIndentation:
   Enabled: false
 
 # Offense count: 21
 # Configuration parameters: NamePrefix, NamePrefixBlacklist.
-Style/PredicateName:
+Naming/PredicateName:
   Enabled: false
 
 # Offense count: 4
@@ -101,13 +101,13 @@ Style/RedundantSelf:
 
 # Offense count: 28
 # Cop supports --auto-correct.
-Style/SingleSpaceBeforeFirstArg:
+Layout/SpaceBeforeFirstArg:
   Enabled: false
 
 # Offense count: 3
 # Cop supports --auto-correct.
 # Configuration parameters: MultiSpaceAllowedForOperators.
-Style/SpaceAroundOperators:
+Layout/SpaceAroundOperators:
   Enabled: false
 
 # Offense count: 5

data/CHANGELOG.md

@@ -1,14 +1,23 @@
-## 2.5.3 (April 25, 2017)
+## 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.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)
 

data/CONTRIBUTING.md

@@ -1,11 +1,11 @@
 # Contributing
 
 We love pull requests from everyone. By participating in this project, you
-agree to abide by our [code of conduct](https://github.com/ejholmes/restforce/blob/master/CODE_OF_CONDUCT.md).
+agree to abide by our [code of conduct](https://github.com/restforce/restforce/blob/master/CODE_OF_CONDUCT.md).
 
 Fork, then clone the repo:
 
-    git clone git@github.com:ejholmes/restforce.git
+    git clone git@github.com:restforce/restforce.git
 
 Set up your machine:
 
@@ -23,7 +23,7 @@ Make your change. Add tests for your change. Make the tests pass:
 
     script/test
 
-Push to your fork and [submit a pull request](https://github.com/ejholmes/restforce/compare/).
+Push to your fork and [submit a pull request](https://github.com/restforce/restforce/compare/).
 
 At this point you're waiting on us. We like to at least comment on pull requests
 within a few days. We may suggest

data/Gemfile

@@ -1,9 +1,11 @@
+# frozen_string_literal: true
+
 source 'https://rubygems.org'
 gemspec
 
+gem 'faraday', '~> 0.15.0'
+gem 'jruby-openssl', platforms: :jruby
 gem 'rake'
-gem 'jruby-openssl', :platforms => :jruby
-gem 'faraday', '~> 0.11.0'
 
 group :development do
   gem 'guard-rspec'

data/Guardfile

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 guard 'rspec', cmd: 'bundle exec rspec', all_on_start: false, all_after_pass: false do
   watch(%r{^spec/.+_spec\.rb$})
   watch('spec/spec_helper.rb') { "spec" }
@@ -8,6 +10,6 @@ guard 'rspec', cmd: 'bundle exec rspec', all_on_start: false, all_after_pass: fa
 end
 
 guard :rubocop, all_on_start: false do
-  watch(%r{.+\.rb$})
+  watch(/.+\.rb$/)
   watch(%r{(?:.+/)?\.rubocop\.yml$}) { |m| File.dirname(m[0]) }
 end

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2012 Eric J. Holmes
+Copyright (c) 2018 Eric J. Holmes and Tim Rogers
 
 MIT License
 

data/README.md

@@ -1,6 +1,6 @@
 # Restforce
 
-[![travis-ci](https://travis-ci.org/ejholmes/restforce.png?branch=master)](https://travis-ci.org/ejholmes/restforce) [![Code Climate](https://codeclimate.com/github/ejholmes/restforce.png)](https://codeclimate.com/github/ejholmes/restforce) [![Dependency Status](https://gemnasium.com/ejholmes/restforce.png)](https://gemnasium.com/ejholmes/restforce)
+[![CircleCI](https://circleci.com/gh/restforce/restforce.svg?style=svg)](https://circleci.com/gh/restforce/restforce) [![Code Climate](https://codeclimate.com/github/restforce/restforce.png)](https://codeclimate.com/github/restforce/restforce) [![Dependency Status](https://gemnasium.com/restforce/restforce.png)](https://gemnasium.com/restforce/restforce)
 ![](https://img.shields.io/gem/dt/restforce.svg)
 
 Restforce is a ruby gem for the [Salesforce REST api](http://www.salesforce.com/us/developer/docs/api_rest/index.htm).
@@ -19,13 +19,13 @@ Features include:
 * Support for dependent picklists.
 * Support for decoding [Force.com Canvas](http://www.salesforce.com/us/developer/docs/platform_connectpre/canvas_framework.pdf) signed requests. (NEW!)
 
-[Official Website](http://restforce.org/) | [Documentation](http://rubydoc.info/gems/restforce/frames) | [Changelog](https://github.com/ejholmes/restforce/tree/master/CHANGELOG.md)
+[Official Website](http://restforce.org/) | [Documentation](http://rubydoc.info/gems/restforce/frames) | [Changelog](https://github.com/restforce/restforce/tree/master/CHANGELOG.md)
 
 ## Installation
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 2.5.3'
+    gem 'restforce', '~> 3.0.0'
 
 And then execute:
 
@@ -35,9 +35,9 @@ Or install it yourself as:
 
     $ gem install restforce
 
-__As of [version 2.5.0](https://github.com/ejholmes/restforce/blob/master/CHANGELOG.md#250-dec-5-2016), this gem is only compatible with Ruby 2.0.0 and later.__ To use Ruby 1.9.3, you'll need to manually specify that you wish to use version 2.4.2, or 1.5.3 for Ruby 1.9.2 support.
+__As of [version 3.0.0](https://github.com/restforce/restforce/blob/master/CHANGELOG.md#300-aug-2-2018), this gem is only compatible with Ruby 2.3.0 and later.__ You'll need to use version 2.5.3 or earlier if you're running on Ruby 2.2, 2.1 or 2.0. For Ruby 1.9.3, you'll need to manually specify that you wish to use version 2.4.2.
 
-This gem is versioned using [Semantic Versioning](http://semver.org/), so you can be confident when updating that there will not be breaking changes outside of a major version (following format MAJOR.MINOR.PATCH, so for instance moving from 2.3.0 to 3.0.0 would be allowed to include incompatible API changes). See the [changelog](https://github.com/ejholmes/restforce/tree/master/CHANGELOG.md) for details on what has changed in each version.
+This gem is versioned using [Semantic Versioning](http://semver.org/), so you can be confident when updating that there will not be breaking changes outside of a major version (following format MAJOR.MINOR.PATCH, so for instance moving from 3.1.0 to 4.0.0 would be allowed to include incompatible API changes). See the [changelog](https://github.com/restforce/restforce/tree/master/CHANGELOG.md) for details on what has changed in each version.
 
 ## Usage
 
@@ -63,7 +63,7 @@ It is also important to note that the client object should not be reused across
 ```ruby
 client = Restforce.new(oauth_token: 'access_token',
                        instance_url: 'instance url',
-                       api_version: '38.0')
+                       api_version: '41.0')
 ```
 
 Although the above will work, you'll probably want to take advantage of the (re)authentication middleware by specifying `refresh_token`, `client_id`, `client_secret`, and `authentication_callback`:
@@ -75,7 +75,7 @@ client = Restforce.new(oauth_token: 'access_token',
                        client_id: 'client_id',
                        client_secret: 'client_secret',
                        authentication_callback: Proc.new { |x| Rails.logger.debug x.to_s },
-                       api_version: '38.0')
+                       api_version: '41.0')
 ```
 
 The middleware will use the `refresh_token` automatically to acquire a new `access_token` if the existing `access_token` is invalid.
@@ -108,7 +108,7 @@ client = Restforce.new(username: 'foo',
                        security_token: 'security token',
                        client_id: 'client_id',
                        client_secret: 'client_secret',
-                       api_version: '38.0')
+                       api_version: '41.0')
 ```
 
 You can also set the username, password, security token, client ID, client
@@ -120,7 +120,7 @@ export SALESFORCE_PASSWORD="password"
 export SALESFORCE_SECURITY_TOKEN="security token"
 export SALESFORCE_CLIENT_ID="client id"
 export SALESFORCE_CLIENT_SECRET="client secret"
-export SALESFORCE_API_VERSION="38.0"
+export SALESFORCE_API_VERSION="41.0"
 ```
 
 ```ruby
@@ -138,7 +138,7 @@ client = Restforce.new(username: 'foo',
                        client_id: 'client_id',
                        client_secret: 'client_secret',
                        proxy_uri: 'http://proxy.example.com:123',
-                       api_version: '38.0')
+                       api_version: '41.0')
 ```
 
 You may specify a username and password for the proxy with a URL along the lines of 'http://user:password@proxy.example.com:123'.
@@ -168,19 +168,19 @@ end
 
 By default, the gem defaults to using Version 26.0 (Winter '13) of the Salesforce API. This maintains backwards compatibility for existing users.
 
-__We strongly suggest configuring Restforce to use the most recent API version, currently Version 38.0 (Winter '17) to get the best Salesforce API experience__ - for example, some more recently-added API endpoints will not be available without moving to a more recent
+__We strongly suggest configuring Restforce to use the most recent API version, currently Version 41.0 (Winter '18) to get the best Salesforce API experience__ - for example, some more recently-added API endpoints will not be available without moving to a more recent
 version. If you're trying to use a method that is unavailable with your API version,
 Restforce will raise an `APIVersionError`.
 
 There are three ways to set the API version:
 
-* Passing in an `api_version` option when instantiating `Restforce` (i.e. `Restforce.new(api_version: '38.0')`)
-* Setting the `SALESFORCE_API_VERSION` environment variable (i.e. `export SALESFORCE_API_VERSION="38.0"`)
+* Passing in an `api_version` option when instantiating `Restforce` (i.e. `Restforce.new(api_version: '41.0')`)
+* Setting the `SALESFORCE_API_VERSION` environment variable (i.e. `export SALESFORCE_API_VERSION="41.0"`)
 * Configuring the version globally with `Restforce.configure`:
 
 ```ruby
 Restforce.configure do |config|
-  config.api_version = '38.0'
+  config.api_version = '41.0'
   # ...
 end
 ```
@@ -206,7 +206,7 @@ to include the `sforce-auto-assign` header in all client HTTP requests:
 ```ruby
 client = Restforce.new(oauth_token: 'access_token',
                        instance_url: 'instance url',
-                       api_version: '38.0',
+                       api_version: '41.0',
                        request_headers: { 'sforce-auto-assign' => 'FALSE' })
 
 ```
@@ -473,6 +473,12 @@ document = client.query('select Id, Name, Body from Document').first
 File.open(document.Name, 'wb') { |f| f.write(document.Body) }
 ```
 
+**Note:** The example above is only applicable if your SOQL query returns a single Document record. If more than one record is returned, 
+the Body field contains an URL to retrieve the BLOB content for the first 2000 records returned. Subsequent records contain the BLOB content
+in the Body field. This is confusing and hard to debug. See notes in [Issue #301](https://github.com/restforce/restforce/issues/301#issuecomment-298972959) explaining this detail. 
+**Executive Summary:** Don't retrieve the Body field in a SOQL query; instead, use the BLOB retrieval URL documented 
+in [SObject BLOB Retrieve](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_sobject_blob_retrieve.htm) 
+
 * * *
 
 ### Custom Apex REST endpoints
@@ -645,7 +651,7 @@ Callbacks.
 
 We welcome all contributions - they help us make Restforce the best gem possible.
 
-See our [CONTRIBUTING.md](https://github.com/ejholmes/restforce/blob/master/CONTRIBUTING.md) file for help with getting set up to work on the project locally.
+See our [CONTRIBUTING.md](https://github.com/restforce/restforce/blob/master/CONTRIBUTING.md) file for help with getting set up to work on the project locally.
 
 1. Fork it
 2. Create your feature branch (`git checkout -b my-new-feature`)

data/Rakefile

@@ -1,4 +1,5 @@
-#!/usr/bin/env rake
+# frozen_string_literal: true
+
 require "bundler/gem_tasks"
 
 task default: [:spec]

data/lib/restforce.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'faraday'
 require 'faraday_middleware'
 require 'json'

data/lib/restforce/abstract_client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class AbstractClient
     include Restforce::Concerns::Base

data/lib/restforce/attachment.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class Attachment < Restforce::SObject
     # Public: Returns the body of the attachment.

data/lib/restforce/client.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   Client = Data::Client
 end

data/lib/restforce/collection.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 module Restforce
   class Collection
     include Enumerable
@@ -29,7 +31,7 @@ module Restforce
     def size
       @raw_page['totalSize']
     end
-    alias_method :length, :size
+    alias length size
 
     # Return array of the elements on the current page
     def current_page

data/lib/restforce/concerns/api.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 require 'uri'
 require 'restforce/concerns/verbs'
 
@@ -81,7 +83,7 @@ module Restforce
       def get_updated(sobject, start_time, end_time)
         start_time = start_time.utc.iso8601
         end_time = end_time.utc.iso8601
-        url = "/sobjects/#{sobject}/updated/?start=#{start_time}&end=#{end_time}"
+        url = "sobjects/#{sobject}/updated/?start=#{start_time}&end=#{end_time}"
         api_get(url).body
       end
 
@@ -101,7 +103,7 @@ module Restforce
       def get_deleted(sobject, start_time, end_time)
         start_time = start_time.utc.iso8601
         end_time = end_time.utc.iso8601
-        url = "/sobjects/#{sobject}/deleted/?start=#{start_time}&end=#{end_time}"
+        url = "sobjects/#{sobject}/deleted/?start=#{start_time}&end=#{end_time}"
         api_get(url).body
       end
 
@@ -265,7 +267,7 @@ module Restforce
       rescue *exceptions
         false
       end
-      alias_method :insert, :create
+      alias insert create
 
       # Public: Insert a new record.
       #
@@ -283,7 +285,7 @@ module Restforce
       def create!(sobject, attrs)
         api_post("sobjects/#{sobject}", attrs).body['id']
       end
-      alias_method :insert!, :create!
+      alias insert! create!
 
       # Public: Update a record.
       #
@@ -316,7 +318,7 @@ module Restforce
       # Returns true if the sobject was successfully updated.
       # Raises an exception if an error is returned from Salesforce.
       def update!(sobject, attrs)
-        id = attrs.fetch(attrs.keys.find { |k, v| k.to_s.downcase == 'id' }, nil)
+        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
@@ -363,7 +365,7 @@ module Restforce
       def upsert!(sobject, field, attrs)
         attrs = attrs.dup
         external_id =
-          extract_case_insensitive_string_or_symbol_key_from_hash!(attrs, field)
+          extract_case_insensitive_string_or_symbol_key_from_hash!(attrs, field).to_s
         if field.to_s != "Id" && (external_id.nil? || external_id.strip.empty?)
           raise ArgumentError, 'Specified external ID field missing from provided ' \
                                'attributes'
@@ -378,7 +380,7 @@ module Restforce
             api_patch "sobjects/#{sobject}/#{field}/#{CGI.escape(external_id)}", attrs
           end
 
-        (response.body && response.body['id']) ? response.body['id'] : true
+        response&.body&.fetch('id', nil) ? response.body['id'] : true
       end
 
       # Public: Delete a record.
@@ -448,7 +450,8 @@ module Restforce
                else
                  "sobjects/#{sobject}/#{CGI.escape(id)}"
                end
-        path << "?fields=#{select.join(',')}" if select && select.any?
+
+        path = "#{path}?fields=#{select.join(',')}" if select&.any?
 
         api_get(path).body
       end