restforce 2.4.2 → 2.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a04860cc565b2a25a8bce3f899901a2d640483ce
-  data.tar.gz: a58fbbe683f663ae90cecfd6ed2ae0f2f60c49e8
+  metadata.gz: 9e798ab8d32c43d1ae3b424d3e48d7e75cac1450
+  data.tar.gz: 5f79e271ed9e74ad7657dc954d1dccb04f4adb0c
 SHA512:
-  metadata.gz: 494c51656f5c5da46733b19d45133bff8299a574abc638c0e26bdeccc868308a6215c88ff30c8f87a383c3c06ee1aae8a83c3376faed96b6f1c26f4602a14202
-  data.tar.gz: cc4e48d1562a3434d969a01801eb188bfae258ffc0616032362978531ac7a27c512afb206c8bd486b13116a965e8a9492ce1f1b13061a752ffcfa425555e0a22
+  metadata.gz: 5f5758308c6f4ba3be1171f4228772c36700f62726136b6dc2789b4dcce9cf1bbf469e2eeafe6b0e71737525cc00929eec4f7d25ca9ff6bc79b4f9e0fa26b3d2
+  data.tar.gz: b2e7a13436430a980f558e65a05be0176765f15dbbcece508813e25c5d50baf114d7915cc0955bd4533962f0bed05e47617892d4e91b62a0a3e3e05b14b4d227

data/.travis.yml

@@ -1,12 +1,9 @@
 language: ruby
 rvm:
-  - 1.9.3
   - 2.0.0
   - 2.1
   - 2.2
   - 2.3.1
-  - jruby-19mode
-  - rbx-2
   - ruby-2.4.0-preview2
 gemfile:
   - Gemfile.travis
@@ -14,6 +11,3 @@ script:
   - bundle exec rubocop
   - bundle exec rspec spec
 sudo: false
-matrix:
-  allow_failures:
-  - rvm: rbx-2

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## 2.5.0 (Dec 7, 2016)
+
+* __Deprecate support for Ruby 1.9__, since [official support was dropped nearly two years ago](https://www.ruby-lang.org/en/news/2014/01/10/ruby-1-9-3-will-end-on-2015/), and it's causing problems with keeping our dependencies up to date
+* Securely hash Salesforce credentials used in cache keys, so they aren't stored in the clear (@atmos)
+
 ## 2.4.2 (Oct 20, 2016)
 
 * Relax `json` dependency for users of Ruby 2.0.0 onwards to allow a much wider range of versions (@timrogers, with thanks to @ccutrer and @janraasch)

data/Gemfile.travis

@@ -4,3 +4,4 @@ gemspec
 gem 'rake'
 gem 'rack', '~> 1.6.4'
 gem 'jruby-openssl', :platforms => :jruby
+gem 'public_suffix', '2.0.3'

data/README.md

@@ -25,7 +25,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 2.4.2'
+    gem 'restforce', '~> 2.5.0'
 
 And then execute:
 
@@ -35,7 +35,7 @@ Or install it yourself as:
 
     $ gem install restforce
 
-__As of [version 2.0.0](https://github.com/ejholmes/restforce/blob/master/CHANGELOG.md#200-jun-27-2015), this gem is only compatible with Ruby 1.9.3 and later.__ To use Ruby 1.9.2 and below, you'll need to manually specify that you wish to use version 1.5.3.
+__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.
 
 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.
 
@@ -61,24 +61,26 @@ It is also important to note that the client object should not be reused across
 #### OAuth token authentication
 
 ```ruby
-client = Restforce.new :oauth_token => 'access_token',
-  :instance_url  => 'instance url'
+client = Restforce.new(oauth_token: 'access_token',
+                       instance_url: 'instance url',
+                       api_version: '38.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`:
 
 ```ruby
-client = Restforce.new :oauth_token => 'access_token',
-  :refresh_token           => 'refresh token',
-  :instance_url            => 'instance url',
-  :client_id               => 'client_id',
-  :client_secret           => 'client_secret',
-  :authentication_callback => Proc.new {|x| Rails.logger.debug x.to_s}
+client = Restforce.new(oauth_token: 'access_token',
+                       refresh_token: 'refresh token',
+                       instance_url: 'instance url',
+                       client_id: 'client_id',
+                       client_secret: 'client_secret',
+                       authentication_callback: Proc.new { |x| Rails.logger.debug x.to_s },
+                       api_version: '38.0')
 ```
 
 The middleware will use the `refresh_token` automatically to acquire a new `access_token` if the existing `access_token` is invalid.
 
-`authentication_callback` is a proc that handles the response from Salesforce when the `refresh_token` is used to obtain a new `access_token`. This allows the `access_token` to be saved for re-use later, otherwise subsequent API calls will continue the cycle of "auth failure/issue new access_token/auth success".
+`authentication_callback` is a proc that handles the response from Salesforce when the `refresh_token` is used to obtain a new `access_token`. This allows the `access_token` to be saved for re-use later - otherwise subsequent API calls will continue the cycle of "auth failure/issue new access_token/auth success".
 
 The proc is passed one argument, a `Hashie::Mash` of the response from the [Salesforce API](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/intro_understanding_refresh_token_oauth.htm):
 
@@ -101,11 +103,12 @@ The `id` field can be used to [uniquely identify](https://developer.salesforce.c
 If you prefer to use a username and password to authenticate:
 
 ```ruby
-client = Restforce.new :username => 'foo',
-  :password       => 'bar',
-  :security_token => 'security token',
-  :client_id      => 'client_id',
-  :client_secret  => 'client_secret'
+client = Restforce.new(username: 'foo',
+                       password: 'bar',
+                       security_token: 'security token',
+                       client_id: 'client_id',
+                       client_secret: 'client_secret',
+                       api_version: '38.0')
 ```
 
 You can also set the username, password, security token, client ID, client
@@ -117,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="37.0"
+export SALESFORCE_API_VERSION="38.0"
 ```
 
 ```ruby
@@ -129,12 +132,13 @@ client = Restforce.new
 You can specify a HTTP proxy using the `proxy_uri` option, as follows, or by setting the `SALESFORCE_PROXY_URI` environment variable:
 
 ```ruby
-client = Restforce.new :username => 'foo',
-  :password       => 'bar',
-  :security_token => 'security token',
-  :client_id      => 'client_id',
-  :client_secret  => 'client_secret',
-  :proxy_uri      => 'http://proxy.example.com:123'
+client = Restforce.new(username: 'foo',
+                       password: 'bar',
+                       security_token: 'security token',
+                       client_id: 'client_id',
+                       client_secret: 'client_secret',
+                       proxy_uri: 'http://proxy.example.com:123',
+                       api_version: '38.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'.
@@ -145,7 +149,7 @@ You can connect to sandbox orgs by specifying a host. The default host is
 'login.salesforce.com':
 
 ```ruby
-client = Restforce.new :host => 'test.salesforce.com'
+client = Restforce.new(host: 'test.salesforce.com')
 ```
 The host can also be set with the environment variable `SALESFORCE_HOST`.
 
@@ -162,26 +166,26 @@ end
 
 ### API versions
 
-By default, the gem defaults to using version 26.0 (Winter '13) of the Salesforce API.
-Some more recent 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`.
+By default, the gem defaults to using Version 26.0 (Winter '13) of the Salesforce API. This maintains backwards compatibility for existing users.
 
-You can change the `api_version` setting from the default either on a per-client basis:
+__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
+version. If you're trying to use a method that is unavailable with your API version,
+Restforce will raise an `APIVersionError`.
 
-```ruby
-client = Restforce.new api_version: "32.0" # ...
-```
+There are three ways to set the API version:
 
-or, you may set it globally for Restforce as a whole:
+* 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"`)
+* Configuring the version globally with `Restforce.configure`:
 
 ```ruby
 Restforce.configure do |config|
-  config.api_version = "32.0"
+  config.api_version = '38.0'
   # ...
 end
 ```
 
+
 ### Bang! methods
 
 All the CRUD methods (`create`, `update`, `upsert`, `destroy`) have equivalent methods with
@@ -339,7 +343,7 @@ client.picklist_values('Account', 'Type')
 # Given a custom object named Automobile__c with picklist fields
 # `Model__c` and `Make__c`, where options for `Model__c` depends on the value of
 # `Make__c`.
-client.picklist_values('Automobile__c', 'Model__c', :valid_for => 'Honda')
+client.picklist_values('Automobile__c', 'Model__c', valid_for: 'Honda')
 # => [#<Restforce::Mash label="Civic" value="Civic">, ... ]
 ```
 
@@ -418,19 +422,19 @@ info.user_id
 Using the new [Blob Data](http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_insert_update_blob.htm) api feature (500mb limit):
 
 ```ruby
-client.create 'Document', FolderId: '00lE0000000FJ6H',
-  Description: 'Document test',
-  Name: 'My image',
-  Body: Restforce::UploadIO.new(File.expand_path('image.jpg', __FILE__), 'image/jpeg')
+client.create('Document', FolderId: '00lE0000000FJ6H',
+                          Description: 'Document test',
+                          Name: 'My image',
+                          Body: Restforce::UploadIO.new(File.expand_path('image.jpg', __FILE__), 'image/jpeg')
 ```
 
 Using base64 encoded data (37.5mb limit):
 
 ```ruby
-client.create 'Document', FolderId: '00lE0000000FJ6H',
-  Description: 'Document test',
-  Name: 'My image',
-  Body: Base64::encode64(File.read('image.jpg'))
+client.create('Document', FolderId: '00lE0000000FJ6H',
+                          Description: 'Document test',
+                          Name: 'My image',
+                          Body: Base64::encode64(File.read('image.jpg'))
 ```
 
 _See also: [Inserting or updating blob data](http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_insert_update_blob.htm)_
@@ -478,7 +482,7 @@ global class RESTCaseController {
 Then you could query the cases using Restforce:
 
 ```ruby
-client.get '/services/apexrest/FieldCase', :company => 'GenePoint'
+client.get('/services/apexrest/FieldCase', company: 'GenePoint')
 # => #<Restforce::Collection ...>
 ```
 
@@ -494,28 +498,27 @@ pub/sub with Salesforce a trivial task:
 require 'faye'
 
 # Initialize a client with your username/password/oauth token/etc.
-client = Restforce.new :username => 'foo',
-  :password       => 'bar',
-  :security_token => 'security token'
-  :client_id      => 'client_id',
-  :client_secret  => 'client_secret'
+client = Restforce.new(username: 'foo',
+                       password: 'bar',
+                       security_token: 'security token'
+                       client_id: 'client_id',
+                       client_secret: 'client_secret')
 
 # Create a PushTopic for subscribing to Account changes.
-client.create! 'PushTopic', {
-  ApiVersion: '23.0',
-  Name: 'AllAccounts',
-  Description: 'All account records',
-  NotifyForOperations: 'All',
-  NotifyForFields: 'All',
-  Query: "select Id from Account"
-}
-
-EM.run {
+client.create!('PushTopic',
+               ApiVersion: '23.0',
+               Name: 'AllAccounts',
+               Description: 'All account records',
+               NotifyForOperations: 'All',
+               NotifyForFields: 'All',
+               Query: "select Id from Account")
+
+EM.run do
   # Subscribe to the PushTopic.
   client.subscribe 'AllAccounts' do |message|
     puts message.inspect
   end
-}
+end
 ```
 
 Boom, you're now receiving push notifications when Accounts are
@@ -533,7 +536,7 @@ The gem supports easy caching of GET requests (e.g. queries):
 
 ```ruby
 # rails example:
-client = Restforce.new cache: Rails.cache
+client = Restforce.new(cache: Rails.cache)
 
 # or
 Restforce.configure do |config|
@@ -550,6 +553,8 @@ client.without_caching do
 end
 ```
 
+Caching is done on based on your authentication credentials, so cached responses will not be shared between different Salesforce logins.
+
 * * *
 
 ### Logging/Debugging/Instrumenting
@@ -602,6 +607,16 @@ call `Restforce.tooling` instead of `Restforce.new`:
 client = Restforce.tooling(...)
 ```
 
+You can use the Tooling API to add fields to existing objects. For example, add "Twitter Username" to the default "Account" object:
+
+```ruby
+client = Restforce.tooling(...)
+client.create!("CustomField", {
+  "FullName" => "Account.orgnamespace__twitter_username__c",
+  "Metadata" => { type: "Text", label: "Twitter Username", length: 15 },
+})
+```
+
 ## Links
 
 If you need a full Active Record experience, may be you can use

data/lib/restforce/middleware/caching.rb

@@ -12,13 +12,17 @@ module Restforce
     # We don't want to cache requests for different clients, so append the
     # oauth token to the cache key.
     def cache_key(env)
-      super(env) +
-        env[:request_headers][Restforce::Middleware::Authorization::AUTH_HEADER].
-          gsub(/\s/, '')
+      super(env) + hashed_auth_header(env)
     end
 
     def use_cache?
       @options.fetch(:use_cache, true)
     end
+
+    def hashed_auth_header(env)
+      Digest::SHA1.hexdigest(
+        env[:request_headers][Restforce::Middleware::Authorization::AUTH_HEADER]
+      )
+    end
   end
 end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '2.4.2'
+  VERSION = '2.5.0'
 end

data/restforce.gemspec

@@ -16,18 +16,12 @@ Gem::Specification.new do |gem|
   gem.require_paths = ["lib"]
   gem.version       = Restforce::VERSION
 
-  gem.required_ruby_version = '>= 1.9.3'
+  gem.required_ruby_version = '>= 2.0'
 
   gem.add_dependency 'faraday', '~> 0.9.0'
   gem.add_dependency 'faraday_middleware', '>= 0.8.8'
 
-  # Ruby 2.4 requires JSON 2.0, but that doesn't work with old pre-2.0.0 versions of Ruby.
-  # See https://github.com/ejholmes/restforce/issues/260.
-  if RUBY_VERSION =~ /^1.9/
-    gem.add_dependency 'json', ['>= 1.7.5', '< 1.9.0']
-  else
-    gem.add_dependency 'json', '>= 1.7.5'
-  end
+  gem.add_dependency 'json', '>= 1.7.5'
 
   gem.add_dependency 'hashie', ['>= 1.2.0', '< 4.0']
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 2.4.2
+  version: 2.5.0
 platform: ruby
 authors:
 - Eric J. Holmes
@@ -9,138 +9,138 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2016-10-20 00:00:00.000000000 Z
+date: 2016-12-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.8
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 0.8.8
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.5
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: 1.2.0
-    - - <
+    - - "<"
       - !ruby/object:Gem::Version
         version: '4.0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 2.14.0
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.13.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 1.13.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.7.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.31.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: 0.31.0
 - !ruby/object:Gem::Dependency
   name: faye
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: A lightweight ruby client for the Salesforce REST API.
@@ -151,10 +151,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rubocop.yml
-- .rubocop_todo.yml
-- .travis.yml
+- ".gitignore"
+- ".rubocop.yml"
+- ".rubocop_todo.yml"
+- ".travis.yml"
 - CHANGELOG.md
 - CODE_OF_CONDUCT.md
 - CONTRIBUTING.md
@@ -285,17 +285,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: '2.0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.14
+rubygems_version: 2.5.1
 signing_key: 
 specification_version: 4
 summary: A lightweight ruby client for the Salesforce REST API.