restforce 4.0.0 → 4.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9e4311062c172c1fd0706872045d29fed90d5b36df5f6c2656d88c37ac680fb2
-  data.tar.gz: f8b6e07bd7533342229f0bb02ef00a731dda64990927bc2c8d822fbfa46f5a29
+  metadata.gz: f24606173bf2365a1482e7ed764863aed6bf53ffad8f9e6c380144c5567a7541
+  data.tar.gz: fadc63d588d150937b9b4ff102adcdd2ab91691fc26f8bfaa9515b2eb79a4553
 SHA512:
-  metadata.gz: 33d02a24a1fc9e7efd40a318f75a48992215b759bcb33c8860a0e4e49fbc5a2eac13cce908dac4605164af58fa6e43473b753668926e0875deeba63eac4cc51c
-  data.tar.gz: 1a6155b0ec55633ebf061e7e709b7e391fe266563f5476b658040139e977ea00baf356602aacf8c5b2aef313c0b48296bfad984d444fe437249424810b567512
+  metadata.gz: 25baee4f91c29f7f3210b23c9a79f9ac1a9ee12a3a6169e20090e860ec62d51b671ef87b84f8ffc25633a2df933cbed0e5e980fb5ef41c7af08db7aa20de4eda
+  data.tar.gz: 6ab7f0096e6931fb2a59febb88d84a3c51a2000d3e690402b9f42ae9b85073f0b2623100a6a106035a420d448f64969c39415411def1a8c4f5bc690ef281c591

data/.rubocop_todo.yml

@@ -12,7 +12,7 @@
 # SupportedHashRocketStyles: key, separator, table
 # SupportedColonStyles: key, separator, table
 # SupportedLastArgumentHashStyles: always_inspect, always_ignore, ignore_implicit, ignore_explicit
-Layout/AlignHash:
+Layout/HashAlignment:
   Exclude:
     - 'lib/restforce/middleware/logger.rb'
     - 'restforce.gemspec'
@@ -23,7 +23,7 @@ Layout/AlignHash:
 # Cop supports --auto-correct.
 # Configuration parameters: EnforcedStyle, IndentationWidth.
 # SupportedStyles: special_inside_parentheses, consistent, align_braces
-Layout/IndentFirstHashElement:
+Layout/FirstHashElementIndentation:
   Exclude:
     - 'lib/restforce/concerns/connection.rb'
 

data/CHANGELOG.md

@@ -1,3 +1,24 @@
+## 4.3.0 (Feb 10, 2021)
+
+* Add compatability with Faraday versions up to but not including `v1.1.0` (@hongtron)
+
+## 4.2.2 (Jan 23, 2020)
+
+* Fix `NoMethodError: undefined method '[]' for nil:NilClass` error when generating objects to return (@apurkiss)
+
+## 4.2.1 (Dec 4, 2019)
+
+* Handle empty response bodies returned with authentication errors (@sylvandor)
+* Fix Faraday deprecation warning in newer Faraday versions (`v0.17.1` onwards) caused by inheriting from a deprecated class 
+
+## 4.2.0 (Oct 23, 2019)
+
+* Add support for platform events, CDC, generic events, etc. in the Streaming API (@nathanKramer)
+
+## 4.1.0 (Oct 20, 2019)
+
+* Add support for JWT authentication (@nathanKramer, @tagCincy)
+
 ## 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.)

data/Gemfile

@@ -5,6 +5,7 @@ gemspec
 
 gem 'faraday', '~> 0.17.0'
 gem 'jruby-openssl', platforms: :jruby
+gem 'jwt'
 gem 'rake'
 
 group :development do

data/README.md

@@ -25,7 +25,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 4.0.0'
+    gem 'restforce', '~> 4.3.0'
 
 And then execute:
 
@@ -111,6 +111,21 @@ client = Restforce.new(username: 'foo',
                        api_version: '41.0')
 ```
 
+#### JWT Bearer Token
+
+If you prefer to use a [JWT Bearer Token](https://developer.salesforce.com/page/Digging_Deeper_into_OAuth_2.0_on_Force.com#Obtaining_an_Access_Token_using_a_JWT_Bearer_Token) to authenticate:
+
+```ruby
+client = Restforce.new(username: 'foo',
+                       client_id: 'client_id',
+                       instance_url: 'instance_url',
+                       jwt_key: 'certificate_private_key',
+                       api_version: '38.0')
+```
+
+The `jwt_key` option is the private key of the certificate uploaded to your Connected App in Salesforce.
+Choose "use digital signatures" in the Connected App configuration screen to upload your certificate.
+
 You can also set the username, password, security token, client ID, client
 secret and API version in environment variables:
 
@@ -473,11 +488,11 @@ 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, 
+**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) 
+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)
 
 * * *
 
@@ -513,8 +528,10 @@ client.get('/services/apexrest/FieldCase', company: 'GenePoint')
 
 ### Streaming
 
-Restforce supports the [Streaming API](http://wiki.developerforce.com/page/Getting_Started_with_the_Force.com_Streaming_API), and makes implementing
-pub/sub with Salesforce a trivial task:
+Restforce supports the [Streaming API](https://trailhead.salesforce.com/en/content/learn/modules/api_basics/api_basics_streaming), and makes implementing
+pub/sub with Salesforce a trivial task.
+
+Here is an example of creating and subscribing to a `PushTopic`:
 
 ```ruby
 # Restforce uses faye as the underlying implementation for CometD.
@@ -538,7 +555,7 @@ client.create!('PushTopic',
 
 EM.run do
   # Subscribe to the PushTopic.
-  client.subscribe 'AllAccounts' do |message|
+  client.subscription '/topic/AllAccounts' do |message|
     puts message.inspect
   end
 end
@@ -559,7 +576,7 @@ that event ID:
 ```ruby
 EM.run {
   # Subscribe to the PushTopic.
-  client.subscribe 'AllAccounts', replay: 10 do |message|
+  client.subscription '/topic/AllAccounts', replay: 10 do |message|
     puts message.inspect
   end
 }
@@ -574,14 +591,14 @@ There are two magic values for the replay ID accepted by Salesforce:
 
 **Warning**: Only use a replay ID of a event from the last 24 hours otherwise
 Salesforce will not send anything, including newer events. If in doubt, use one
-of the two magic replay IDs mentioned above. 
+of the two magic replay IDs mentioned above.
 
-You might want to store the replay ID in some sort of datastore so you can 
+You might want to store the replay ID in some sort of datastore so you can
 access it, for example between application restarts. In that case, there is the
 option of passing a custom replay handler which responds to `[]` and `[]=`.
 
 Below is a sample replay handler that stores the replay ID for each channel in
-memory using a Hash, stores a timestamp and has some rudimentary logic that 
+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
@@ -633,13 +650,13 @@ of the subscription:
 EM.run {
   # Subscribe to the PushTopic and use the custom replay handler to store any
   # received replay ID.
-  client.subscribe 'AllAccounts', replay: SimpleReplayHandler.new do |message|
+  client.subscription '/topic/AllAccounts', replay: SimpleReplayHandler.new do |message|
     puts message.inspect
   end
 }
-``` 
+```
 
-_See also_: 
+_See also_:
 
 * [Force.com Streaming API docs](http://www.salesforce.com/us/developer/docs/api_streaming/index.htm)
 * [Message Durability docs](https://developer.salesforce.com/docs/atlas.en-us.api_streaming.meta/api_streaming/using_streaming_api_durability.htm)

data/lib/restforce.rb

@@ -3,6 +3,7 @@
 require 'faraday'
 require 'faraday_middleware'
 require 'json'
+require 'jwt'
 
 require 'restforce/version'
 require 'restforce/config'
@@ -47,15 +48,15 @@ module Restforce
   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
+  # Inherit from Faraday::ResourceNotFound for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::ResourceNotFound
   # can continue to do so.
-  NotFoundError       = Class.new(Faraday::Error::ResourceNotFound)
+  NotFoundError       = Class.new(Faraday::ResourceNotFound)
 
-  # Inherit from Faraday::Error::ClientError for backwards-compatibility
-  # Consumers of this library that rescue and handle Faraday::Error::ClientError
+  # Inherit from Faraday::ClientError for backwards-compatibility
+  # Consumers of this library that rescue and handle Faraday::ClientError
   # can continue to do so.
-  ResponseError       = Class.new(Faraday::Error::ClientError)
+  ResponseError       = Class.new(Faraday::ClientError)
   MatchesMultipleError= Class.new(ResponseError)
   EntityTooLargeError = Class.new(ResponseError)
 

data/lib/restforce/concerns/api.rb

@@ -510,7 +510,7 @@ module Restforce
 
       # Internal: Errors that should be rescued from in non-bang methods
       def exceptions
-        [Faraday::Error::ClientError]
+        [Faraday::ClientError]
       end
     end
   end

data/lib/restforce/concerns/authentication.rb

@@ -19,6 +19,8 @@ module Restforce
           Restforce::Middleware::Authentication::Password
         elsif oauth_refresh?
           Restforce::Middleware::Authentication::Token
+        elsif jwt?
+          Restforce::Middleware::Authentication::JWTBearer
         end
       end
 
@@ -38,6 +40,14 @@ module Restforce
           options[:client_id] &&
           options[:client_secret]
       end
+
+      # Internal: Returns true if jwt bearer token flow should be used for
+      # authentication.
+      def jwt?
+        options[:jwt_key] &&
+          options[:username] &&
+          options[:client_id]
+      end
     end
   end
 end

data/lib/restforce/concerns/base.rb

@@ -28,6 +28,8 @@ module Restforce
       #                                   password and oauth authentication
       #        :client_secret           - The oauth client secret to use.
       #
+      #        :jwt_key                 - The private key for JWT authentication
+      #
       #        :host                    - The String hostname to use during
       #                                   authentication requests
       #                                   (default: 'login.salesforce.com').

data/lib/restforce/concerns/connection.rb

@@ -72,9 +72,9 @@ module Restforce
       # Internal: Faraday Connection options
       def connection_options
         { request: {
-            timeout: options[:timeout],
-            open_timeout: options[:timeout]
-},
+          timeout: options[:timeout],
+          open_timeout: options[:timeout]
+        },
           proxy: options[:proxy_uri],
           ssl: options[:ssl] }
       end

data/lib/restforce/concerns/streaming.rb

@@ -5,13 +5,28 @@ module Restforce
     module Streaming
       # Public: Subscribe to a PushTopic
       #
-      # channels - The name of the PushTopic channel(s) to subscribe to.
+      # topics   - The name of the PushTopic channel(s) to subscribe to.
       # block    - A block to run when a new message is received.
       #
       # Returns a Faye::Subscription
-      def subscribe(channels, options = {}, &block)
-        Array(channels).each { |channel| replay_handlers[channel] = options[:replay] }
-        faye.subscribe Array(channels).map { |channel| "/topic/#{channel}" }, &block
+      def legacy_subscribe(topics, options = {}, &block)
+        topics = Array(topics).map { |channel| "/topic/#{channel}" }
+        subscription(topics, options, &block)
+      end
+      alias subscribe legacy_subscribe
+
+      # Public: Subscribe to one or more Streaming API channels
+      #
+      # channels - The name of the Streaming API (cometD) channel(s) to subscribe to.
+      # block    - A block to run when a new message is received.
+      #
+      # Returns a Faye::Subscription
+      def subscription(channels, options = {}, &block)
+        one_or_more_channels = Array(channels)
+        one_or_more_channels.each do |channel|
+          replay_handlers[channel] = options[:replay]
+        end
+        faye.subscribe(one_or_more_channels, &block)
       end
 
       # Public: Faye client to use for subscribing to PushTopics
@@ -49,7 +64,7 @@ module Restforce
 
         def incoming(message, callback)
           callback.call(message).tap do
-            channel = message.fetch('channel').gsub('/topic/', '')
+            channel = message.fetch('channel')
             replay_id = message.fetch('data', {}).fetch('event', {})['replayId']
 
             handler = @replay_handlers[channel]
@@ -64,12 +79,12 @@ module Restforce
           # Leave non-subscribe messages alone
           return callback.call(message) unless message['channel'] == '/meta/subscribe'
 
-          channel = message['subscription'].gsub('/topic/', '')
+          channel = message['subscription']
 
           # Set the replay value for the channel
           message['ext'] ||= {}
           message['ext']['replay'] = {
-            "/topic/#{channel}" => replay_id(channel)
+            channel => replay_id(channel)
           }
 
           # Carry on and send the message to the server

data/lib/restforce/config.rb

@@ -108,6 +108,9 @@ module Restforce
     # The OAuth client secret
     option :client_secret, default: lambda { ENV['SALESFORCE_CLIENT_SECRET'] }
 
+    # The private key for JWT authentication
+    option :jwt_key
+
     # Set this to true if you're authenticating with a Sandbox instance.
     # Defaults to false.
     option :host, default: lambda { ENV['SALESFORCE_HOST'] || 'login.salesforce.com' }

data/lib/restforce/mash.rb

@@ -28,7 +28,7 @@ module Restforce
           # of sobject records.
           Restforce::Collection
         elsif val.key? 'attributes'
-          case (val['attributes']['type'])
+          case val.dig('attributes', 'type')
           when "Attachment"
             Restforce::Attachment
           when "Document"

data/lib/restforce/middleware/authentication.rb

@@ -6,8 +6,9 @@ module Restforce
   # will attempt to either reauthenticate (username and password) or refresh
   # the oauth access token (if a refresh token is present).
   class Middleware::Authentication < Restforce::Middleware
-    autoload :Password, 'restforce/middleware/authentication/password'
-    autoload :Token,    'restforce/middleware/authentication/token'
+    autoload :Password,  'restforce/middleware/authentication/password'
+    autoload :Token,     'restforce/middleware/authentication/token'
+    autoload :JWTBearer, 'restforce/middleware/authentication/jwt_bearer'
 
     # Rescue from 401's, authenticate then raise the error again so the client
     # can reissue the request.
@@ -62,7 +63,10 @@ module Restforce
 
     # Internal: The parsed error response.
     def error_message(response)
-      "#{response.body['error']}: #{response.body['error_description']}"
+      return response.status.to_s unless response.body
+
+      "#{response.body['error']}: #{response.body['error_description']} " \
+        "(#{response.status})"
     end
 
     # Featured detect form encoding.

data/lib/restforce/middleware/authentication/jwt_bearer.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+require 'jwt'
+
+module Restforce
+  class Middleware
+    class Authentication
+      class JWTBearer < Restforce::Middleware::Authentication
+        def params
+          {
+            grant_type: 'urn:ietf:params:oauth:grant-type:jwt-bearer',
+            assertion: jwt_bearer_token
+          }
+        end
+
+        private
+
+        def jwt_bearer_token
+          JWT.encode claim_set, private_key, 'RS256'
+        end
+
+        def claim_set
+          {
+            iss: @options[:client_id],
+            sub: @options[:username],
+            aud: @options[:host],
+            iat: Time.now.utc.to_i,
+            exp: Time.now.utc.to_i + 180
+          }
+        end
+
+        def private_key
+          OpenSSL::PKey::RSA.new(@options[:jwt_key])
+        end
+      end
+    end
+  end
+end

data/lib/restforce/middleware/instance_url.rb

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

data/lib/restforce/version.rb

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

data/restforce.gemspec

@@ -28,13 +28,14 @@ Gem::Specification.new do |gem|
   gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 1.0']
 
   gem.add_dependency 'json', '>= 1.7.5'
+  gem.add_dependency 'jwt', ['>= 1.5.6']
 
-  gem.add_dependency 'hashie', ['>= 1.2.0', '< 4.0']
+  gem.add_dependency 'hashie', '>= 1.2.0', '< 5.0'
 
   gem.add_development_dependency 'faye' unless RUBY_PLATFORM == 'java'
   gem.add_development_dependency 'rspec', '~> 2.14.0'
-  gem.add_development_dependency 'rspec_junit_formatter', '~> 0.3.0'
-  gem.add_development_dependency 'rubocop', '~> 0.75.0'
+  gem.add_development_dependency 'rspec_junit_formatter', '~> 0.4.1'
+  gem.add_development_dependency 'rubocop', '~> 0.77.0'
   gem.add_development_dependency 'simplecov', '~> 0.17.1'
   gem.add_development_dependency 'webmock', '~> 3.7.6'
 end

data/spec/fixtures/test_private.key

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEAy3KYqxZIgVDgFwdA+OQcKMJQu3iUTlyCSk9b3RLBOudnvk8u
+n0ShtKkOKB4b4RZeedcrlKESoak/6NS+M7CDemRT0EagqUiz/ZsZxB2KUp7au+d8
+0KWX99/loBjDttuon8ITDw2WFC9X0+TZqfsXcQ0iV1/9Sf8WHShd8ZqShjJBlEvf
+7u7VdNW8dXrl+4cvpPzspVxg6jVotEpmp875jmGRvshgx0iz0jtfAyxaaKStITC6
+MxufVNDgIYQDl6queh8b9noDLtt17Eq6YnropYN1hOjaLtoLBP7AN2gsXG7N3vqC
+JG619W9X4zCmKztv4oGjymInrS2msC2J02dNGQIDAQABAoIBAAurTARsJ8Z7DA9m
+FBzygIb59kV6eg8wkSyP9rXscHbfdPzeb88k0Z2aILy+VV0IumyEofRJdNce7RJ+
+uVYfprrrbD9C/c4X5HMEZWrxQtDQWb1zXp5dESVfiz0ujnM7kCVxrUQsxFHuETyP
+IMj2JPcQCMs4L0ACSJNtkE3eTs8xko5kwDHZGiLTi5jD1bLgaHl1A+9CTU8LosTy
+hEIrNSZfNidDPU4QSbwoElYZxpDMSbtyHaIk1WHz7zLzWoogK3x5AIQh64wWAQVd
+zzlp2j2jSM7oQ9j+k1aNiUBdDoRX53jmaIwE/1WDW/LT33qAoqRw+5qHeLRoRcfu
+3uj/WI0CgYEA6wnpIUhqqWT+febhXtCr1mAJlAJpzUUQncN6Zk0Kj/kE1V52OqgL
+gtOactII7J3+0zK7KGptqseTank0ghmGNdRBQ7+1JTQhpjLrCm/huKDhl+sBk95u
+opxw/ZTwMFYPwsmZlFcy4uWRjtI+QzaV+2Xk5JF57H8vUiX/+XqseQcCgYEA3Zdw
+zVHpcVPlyiXCbSvwb9IYXiJaQl/Rg96Klxah3MZNyRRKe5IoKUTJwEDuQ1MAHrve
+cWrNLcXhX6r/PzIXSSLe71wgwpn7UcaqWzZJqqN7OIGEeTzYWbB6tGhse7Dw7tWB
+hRkQSE0LPzZqboHz5msRM02sa61qiI5+ASJvIN8CgYEAvT+IoEzv3R89ruBVPQPm
+KMHBVJSw3iArJex8xJxp0c0fMDJUHhyq0BdTd/pYRzVcNm/VtNAlJ2p07zlSpyKo
+JvWV61gUIjWclnbPO+MkK4YWvzzxUz+5c2NlszjWQQU6wYuUBpZDmeBg2E++5F2y
+W+8KY2QjeOJbltiUCCvXbccCgYEAqARYB5aARumyZqBS16xlVqQazeWGQqWcmzx2
+ITGL8XZ7LGgyQZgE06XQw/F3t5yLjsIsXBr7ECXmST/C4gv9E/tYxm04edV/dfYI
+3bhACx6CI8owxCyabwcdQwWam/8B8FX7KwxiCDBCwt9ju/7VDHVKSXgvsEWBbaF9
+cSbG1EkCgYBZFztTUnD/cLMcvLUegN0K+6Qa3x3nRSrlrJ+v51mU1X8G8qNyFO67
+gUq9h4xbCl4Z5ZTuFKXwPM4XaMzfYdrWNS2zl5IG14FXS077GhDKe062b9mFoxtm
+aViCit4Hm8xpLTS8x9KB7yYAiF9sR/GklW1SUCIqnpL9JShkhzjfZw==
+-----END RSA PRIVATE KEY-----

data/spec/integration/abstract_client_spec.rb

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

data/spec/unit/concerns/api_spec.rb

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

data/spec/unit/concerns/authentication_spec.rb

@@ -52,6 +52,16 @@ describe Restforce::Concerns::Authentication do
 
       it { should eq Restforce::Middleware::Authentication::Token }
     end
+
+    context 'when jwt option is provided' do
+      before do
+        client.stub username_password?: false
+        client.stub oauth_refresh?: false
+        client.stub jwt?: true
+      end
+
+      it { should eq Restforce::Middleware::Authentication::JWTBearer }
+    end
   end
 
   describe '.username_password?' do
@@ -100,4 +110,29 @@ describe Restforce::Concerns::Authentication do
       it { should_not be_true }
     end
   end
+
+  describe '.jwt?' do
+    subject       { client.jwt? }
+    let(:options) do
+      {}
+    end
+
+    before do
+      client.stub options: options
+    end
+
+    context 'when jwt options are provided' do
+      let(:options) do
+        { jwt_key: 'JWT_PRIVATE_KEY',
+          username: 'foo',
+          client_id: 'client' }
+      end
+
+      it { should be_true }
+    end
+
+    context 'when jwt options are not provided' do
+      it { should_not be_true }
+    end
+  end
 end

data/spec/unit/concerns/streaming_spec.rb

@@ -4,18 +4,19 @@ require 'spec_helper'
 
 describe Restforce::Concerns::Streaming, event_machine: true do
   describe '.subscribe' do
-    let(:channels)        { %w[channel1 channel2] }
-    let(:topics)          { channels.map { |c| "/topic/#{c}" } }
+    let(:channels) do
+      ['/topic/topic1', '/event/MyCustomEvent__e', '/data/ChangeEvents']
+    end
     let(:subscribe_block) { lambda { 'subscribe' } }
     let(:faye_double)     { double('Faye') }
 
     it 'subscribes to the topics with faye' do
       faye_double.
         should_receive(:subscribe).
-        with(topics, &subscribe_block)
+        with(channels, &subscribe_block)
       client.stub faye: faye_double
 
-      client.subscribe(channels, &subscribe_block)
+      client.subscription(channels, &subscribe_block)
     end
 
     context "replay_handlers" do
@@ -25,24 +26,51 @@ describe Restforce::Concerns::Streaming, event_machine: true do
       }
 
       it 'registers nil handlers when no replay option is given' do
-        client.subscribe(channels, &subscribe_block)
-        client.replay_handlers.should eq('channel1' => nil, 'channel2' => nil)
+        client.subscription(channels, &subscribe_block)
+        client.replay_handlers.should eq(
+          '/topic/topic1' => nil,
+          '/event/MyCustomEvent__e' => nil,
+          '/data/ChangeEvents' => nil
+        )
       end
 
       it 'registers a replay_handler for each channel given' do
-        client.subscribe(channels, replay: -2, &subscribe_block)
-        client.replay_handlers.should eq('channel1' => -2, 'channel2' => -2)
+        client.subscription(channels, replay: -2, &subscribe_block)
+        client.replay_handlers.should eq(
+          '/topic/topic1' => -2,
+          '/event/MyCustomEvent__e' => -2,
+          '/data/ChangeEvents' => -2
+        )
       end
 
       it 'replaces earlier handlers in subsequent calls' do
-        client.subscribe(%w[channel1 channel2], replay: 2, &subscribe_block)
-        client.subscribe(%w[channel2 channel3], replay: 3, &subscribe_block)
+        client.subscription(
+          ['/topic/channel1', '/topic/channel2'],
+          replay: 2,
+          &subscribe_block
+        )
+        client.subscription(
+          ['/topic/channel2', '/topic/channel3'],
+          replay: 3,
+          &subscribe_block
+        )
+
         client.replay_handlers.should eq(
-          'channel1' => 2,
-          'channel2' => 3,
-          'channel3' => 3
+          '/topic/channel1' => 2,
+          '/topic/channel2' => 3,
+          '/topic/channel3' => 3
         )
       end
+
+      context 'backwards compatibility' do
+        it 'it assumes channels are push topics' do
+          client.subscribe(%w[channel1 channel2], replay: -2, &subscribe_block)
+          client.replay_handlers.should eq(
+            '/topic/channel1' => -2,
+            '/topic/channel2' => -2
+          )
+        end
+      end
     end
   end
 
@@ -87,41 +115,41 @@ describe Restforce::Concerns::Streaming, event_machine: true do
     let(:extension) { Restforce::Concerns::Streaming::ReplayExtension.new(handlers) }
 
     it 'sends nil without a specified handler' do
-      output = subscribe(extension, to: "channel1")
+      output = subscribe(extension, to: "/topic/channel1")
       read_replay(output).should eq('/topic/channel1' => nil)
     end
 
     it 'with a scalar replay id' do
-      handlers['channel1'] = -2
-      output = subscribe(extension, to: "channel1")
+      handlers['/topic/channel1'] = -2
+      output = subscribe(extension, to: "/topic/channel1")
       read_replay(output).should eq('/topic/channel1' => -2)
     end
 
     it 'with a hash' do
-      hash_handler = { 'channel1' => -1, 'channel2' => -2 }
+      hash_handler = { '/topic/channel1' => -1, '/topic/channel2' => -2 }
 
-      handlers['channel1'] = hash_handler
-      handlers['channel2'] = hash_handler
+      handlers['/topic/channel1'] = hash_handler
+      handlers['/topic/channel2'] = hash_handler
 
-      output = subscribe(extension, to: "channel1")
+      output = subscribe(extension, to: "/topic/channel1")
       read_replay(output).should eq('/topic/channel1' => -1)
 
-      output = subscribe(extension, to: "channel2")
+      output = subscribe(extension, to: "/topic/channel2")
       read_replay(output).should eq('/topic/channel2' => -2)
     end
 
     it 'with an object' do
       custom_handler = double('custom_handler')
       custom_handler.should_receive(:[]).and_return(123)
-      handlers['channel1'] = custom_handler
+      handlers['/topic/channel1'] = custom_handler
 
-      output = subscribe(extension, to: "channel1")
+      output = subscribe(extension, to: "/topic/channel1")
       read_replay(output).should eq('/topic/channel1' => 123)
     end
 
     it 'remembers the last replayId' do
-      handler = { 'channel1' => 41 }
-      handlers['channel1'] = handler
+      handler = { '/topic/channel1' => 41 }
+      handlers['/topic/channel1'] = handler
       message = {
         'channel' => '/topic/channel1',
         'data' => {
@@ -130,12 +158,12 @@ describe Restforce::Concerns::Streaming, event_machine: true do
       }
 
       extension.incoming(message, ->(m) {})
-      handler.should eq('channel1' => 42)
+      handler.should eq('/topic/channel1' => 42)
     end
 
     it 'when an incoming message has no replayId' do
-      handler = { 'channel1' => 41 }
-      handlers['channel1'] = handler
+      handler = { '/topic/channel1' => 41 }
+      handlers['/topic/channel1'] = handler
 
       message = {
         'channel' => '/topic/channel1',
@@ -143,7 +171,7 @@ describe Restforce::Concerns::Streaming, event_machine: true do
       }
 
       extension.incoming(message, ->(m) {})
-      handler.should eq('channel1' => 41)
+      handler.should eq('/topic/channel1' => 41)
     end
 
     private
@@ -152,7 +180,7 @@ describe Restforce::Concerns::Streaming, event_machine: true do
       output = nil
       message = {
         'channel' => '/meta/subscribe',
-        'subscription' => "/topic/#{options[:to]}"
+        'subscription' => options[:to]
       }
       extension.outgoing(message, ->(m) {
         output = m

data/spec/unit/mash_spec.rb

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

data/spec/unit/middleware/authentication/jwt_bearer_spec.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+describe Restforce::Middleware::Authentication::JWTBearer do
+  let(:jwt_key) { File.read('spec/fixtures/test_private.key') }
+
+  let(:options) do
+    { host: 'login.salesforce.com',
+      client_id: 'client_id',
+      username: 'foo',
+      jwt_key: jwt_key,
+      instance_url: 'https://na1.salesforce.com',
+      adapter: :net_http }
+  end
+
+  it_behaves_like 'authentication middleware' do
+    let(:success_request) do
+      stub_login_request(
+        body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+             "assertion=abc1234567890"
+      ).to_return(status: 200, body: fixture(:auth_success_response))
+    end
+
+    let(:fail_request) do
+      stub_login_request(
+        body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+             "assertion=abc1234567890"
+      ).to_return(status: 400, body: fixture(:refresh_error_response))
+    end
+  end
+
+  context 'allows jwt_key as string' do
+    let(:jwt_key) do
+      File.read('spec/fixtures/test_private.key')
+    end
+
+    let(:options) do
+      { host: 'login.salesforce.com',
+        client_id: 'client_id',
+        username: 'foo',
+        jwt_key: jwt_key,
+        instance_url: 'https://na1.salesforce.com',
+        adapter: :net_http }
+    end
+
+    it_behaves_like 'authentication middleware' do
+      let(:success_request) do
+        stub_login_request(
+          body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+            "assertion=abc1234567890"
+        ).to_return(status: 200, body: fixture(:auth_success_response))
+      end
+
+      let(:fail_request) do
+        stub_login_request(
+          body: "grant_type=grant_type—urn:ietf:params:oauth:grant-type:jwt-bearer&" \
+            "assertion=abc1234567890"
+        ).to_return(status: 400, body: fixture(:refresh_error_response))
+      end
+    end
+  end
+end

data/spec/unit/middleware/authentication_spec.rb

@@ -89,4 +89,25 @@ describe Restforce::Middleware::Authentication do
       connection.ssl[:version].should eq(:TLSv1_2)
     end
   end
+
+  describe '.error_message' do
+    context 'when response.body is present' do
+      let(:response) {
+        Faraday::Response.new(
+          body: { 'error' => 'error', 'error_description' => 'description' },
+          status: 401
+        )
+      }
+
+      subject { middleware.error_message(response) }
+      it { should eq "error: description (401)" }
+    end
+
+    context 'when response.body is nil' do
+      let(:response) { Faraday::Response.new(status: 401) }
+
+      subject { middleware.error_message(response) }
+      it { should eq "401" }
+    end
+  end
 end

data/spec/unit/middleware/raise_error_spec.rb

@@ -18,8 +18,8 @@ describe Restforce::Middleware::RaiseError do
                                               '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
+      it 'raises an error that inherits from Faraday::ResourceNotFound' do
+        expect { on_complete }.to raise_error Faraday::ResourceNotFound
       end
     end
 
@@ -31,8 +31,8 @@ describe Restforce::Middleware::RaiseError do
                                               /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
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError
       end
     end
 
@@ -44,8 +44,8 @@ describe Restforce::Middleware::RaiseError do
                                               '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
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError
       end
     end
 
@@ -66,8 +66,8 @@ describe Restforce::Middleware::RaiseError do
                                               '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
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError
       end
     end
 
@@ -80,8 +80,8 @@ describe Restforce::Middleware::RaiseError do
                                               "(error code missing): #{body}"
       end
 
-      it 'raises an error that inherits from Faraday::Error::ClientError' do
-        expect { on_complete }.to raise_error Faraday::Error::ClientError,
+      it 'raises an error that inherits from Faraday::ClientError' do
+        expect { on_complete }.to raise_error Faraday::ClientError,
                                               "(error code missing): #{body}"
       end
     end

data/spec/unit/sobject_spec.rb

@@ -45,13 +45,10 @@ describe Restforce::SObject do
     destroy: :destroy,
     destroy!: :destroy! }.each do |method, receiver|
     describe ".#{method}" do
-      subject(:send_method) { sobject.send(method) }
+      subject(:send_method) { lambda { sobject.send(method) } }
 
       context 'when an Id was not queried' do
-        it "raises an error" do
-          expect { send_method }.to raise_error ArgumentError,
-                                                /need to query the Id for the record/
-        end
+        it { should raise_error ArgumentError, /need to query the Id for the record/ }
       end
 
       context 'when an Id is present' do

metadata

@@ -1,36 +1,36 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 4.0.0
+  version: 4.3.0
 platform: ruby
 authors:
 - Eric J. Holmes
 - Tim Rogers
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2019-10-09 00:00:00.000000000 Z
+date: 2021-02-10 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
     - - "<="
       - !ruby/object:Gem::Version
         version: '1.0'
+    - - ">="
+      - !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::Version
         version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.9.0
 - !ruby/object:Gem::Dependency
   name: faraday_middleware
   requirement: !ruby/object:Gem::Requirement
@@ -65,6 +65,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.7.5
+- !ruby/object:Gem::Dependency
+  name: jwt
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.5.6
 - !ruby/object:Gem::Dependency
   name: hashie
   requirement: !ruby/object:Gem::Requirement
@@ -74,7 +88,7 @@ dependencies:
         version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -84,7 +98,7 @@ dependencies:
         version: 1.2.0
     - - "<"
       - !ruby/object:Gem::Version
-        version: '4.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: faye
   requirement: !ruby/object:Gem::Requirement
@@ -119,28 +133,28 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.3.0
+        version: 0.4.1
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.77.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.75.0
+        version: 0.77.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -210,6 +224,7 @@ files:
 - lib/restforce/mash.rb
 - lib/restforce/middleware.rb
 - lib/restforce/middleware/authentication.rb
+- lib/restforce/middleware/authentication/jwt_bearer.rb
 - lib/restforce/middleware/authentication/password.rb
 - lib/restforce/middleware/authentication/token.rb
 - lib/restforce/middleware/authorization.rb
@@ -266,6 +281,7 @@ files:
 - spec/fixtures/sobject/upsert_multiple_error_response.json
 - spec/fixtures/sobject/upsert_updated_success_response.json
 - spec/fixtures/sobject/write_error_response.json
+- spec/fixtures/test_private.key
 - spec/integration/abstract_client_spec.rb
 - spec/integration/data/client_spec.rb
 - spec/spec_helper.rb
@@ -291,6 +307,7 @@ files:
 - spec/unit/data/client_spec.rb
 - spec/unit/document_spec.rb
 - spec/unit/mash_spec.rb
+- spec/unit/middleware/authentication/jwt_bearer_spec.rb
 - spec/unit/middleware/authentication/password_spec.rb
 - spec/unit/middleware/authentication/token_spec.rb
 - spec/unit/middleware/authentication_spec.rb
@@ -310,7 +327,7 @@ licenses:
 metadata:
   source_code_uri: https://github.com/restforce/restforce
   changelog_uri: https://github.com/restforce/restforce/blob/master/CHANGELOG.md
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -325,8 +342,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.2.5
+signing_key:
 specification_version: 4
 summary: A lightweight ruby client for the Salesforce REST API.
 test_files:
@@ -364,6 +381,7 @@ test_files:
 - spec/fixtures/sobject/upsert_multiple_error_response.json
 - spec/fixtures/sobject/upsert_updated_success_response.json
 - spec/fixtures/sobject/write_error_response.json
+- spec/fixtures/test_private.key
 - spec/integration/abstract_client_spec.rb
 - spec/integration/data/client_spec.rb
 - spec/spec_helper.rb
@@ -389,6 +407,7 @@ test_files:
 - spec/unit/data/client_spec.rb
 - spec/unit/document_spec.rb
 - spec/unit/mash_spec.rb
+- spec/unit/middleware/authentication/jwt_bearer_spec.rb
 - spec/unit/middleware/authentication/password_spec.rb
 - spec/unit/middleware/authentication/token_spec.rb
 - spec/unit/middleware/authentication_spec.rb