restforce 7.0.0 → 7.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6a22215414b1c1ee4264e25ab13469d1e19b1ec88263ec118b8dc1937a5867d7
-  data.tar.gz: 78fbdda639da07c4f4bdb48656a55a068e6a91d9f17a938d909fb27e747b1840
+  metadata.gz: fe63ad6684261df32867bad2431709006a8507a481261c14cd8fac1aab6dc88c
+  data.tar.gz: fe26e4ac42c9eda729b51d058f52a706d648673cf743b7fcf1f295747b41cd95
 SHA512:
-  metadata.gz: d3e16bc52f787d054849826bacbc6a9f9fcd839847d3afdad7ef889b1f8211179238cba65bf3de1903e4e94d62d88de6be223139a4e40eca60ba8f543b64d945
-  data.tar.gz: 1daae50110e5848ff47ba97fa3ddc36418fab74f4cd10a7f3643c487397cd64681b091efabf037dcd026f2679a9ce91a5df36d5f88545804ba58a5394cce8090
+  metadata.gz: 45e4800621600bc351f7cbe52bbb7847a89351a72c407d5de5cd01ecc2e99576ba2b8707f6ab47a8d95f09a1833934de63ff52b1867e0d4b640884683b2c1e85
+  data.tar.gz: 9aee02914b520b0f68c6d40017f136198e082db951a3a96af693da8537b963471b1ff4b73602588250bed6f8ba10d1c3a3a95eed118204c2c85f8913a178d3fb

data/.github/workflows/faraday.yml

@@ -10,7 +10,7 @@ jobs:
         # For v2.0.x, we test v2.0.0 and v2.0.1 because v2.0.0 has a special behaviour where
         # the Net::HTTP adapter is not included. See
         # https://github.com/lostisland/faraday/blob/main/UPGRADING.md#faraday-20.
-        faraday_version: ['1.1.0', '1.2.0', '1.3.1', '1.4.3', '1.5.1', '1.6.0', '1.7.2', '1.8.0', '1.9.3', '1.10.3', '2.0.0', '2.0.1', '2.1.0', '2.2.0', '2.3.0', '2.4.0', '2.5.2', '2.6.0', '2.7.11']
+        faraday_version: ['1.1.0', '1.2.0', '1.3.1', '1.4.3', '1.5.1', '1.6.0', '1.7.2', '1.8.0', '1.9.3', '1.10.3', '2.0.0', '2.0.1', '2.1.0', '2.2.0', '2.3.0', '2.4.0', '2.5.2', '2.6.0', '2.7.12', '2.8.0']
     env:
       FARADAY_VERSION: ~> ${{ matrix.faraday_version }}
     steps:

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 7.1.0 (Dec 20, 2023)
+
+- Add support for the [OAuth 2.0 Client Credentials authentication flow](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_client_credentials_flow.htm&type=5) (@rh-taro)
+- Add support for `faraday` v2.8.x (@timrogers)
+
 # 7.0.0 (Oct 6, 2023)
 
 __This version contains breaking changes. For help with upgrading, see [`UPGRADING.md`](https://github.com/restforce/restforce/blob/main/UPGRADING.md).__

data/Gemfile

@@ -3,11 +3,11 @@
 source 'https://rubygems.org'
 gemspec
 
-faraday_version = ENV.fetch('FARADAY_VERSION', '~> 2.7.3')
+faraday_version = ENV.fetch('FARADAY_VERSION', '~> 2.8.0')
 
 # Enable us to explicitly pick a Faraday version when running tests
 gem 'faraday', faraday_version
-gem 'faraday-typhoeus', '~> 1.0.0' unless faraday_version.start_with?("~> 1")
+gem 'faraday-typhoeus', '~> 1.1.0' unless faraday_version.start_with?("~> 1")
 gem 'faye' unless RUBY_PLATFORM == 'java'
 gem 'guard-rspec'
 gem 'guard-rubocop'
@@ -17,6 +17,6 @@ gem 'rspec', '~> 3.12.0'
 gem 'rspec-collection_matchers', '~> 1.2.0'
 gem 'rspec-its', '~> 1.3.0'
 gem 'rspec_junit_formatter', '~> 0.6.0'
-gem 'rubocop', '~> 1.56.3'
+gem 'rubocop', '~> 1.59.0'
 gem 'simplecov', '~> 0.22.0'
 gem 'webmock', '~> 3.19.1'

data/README.md

@@ -27,7 +27,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 7.0.0'
+    gem 'restforce', '~> 7.1.0'
 
 And then execute:
 
@@ -59,7 +59,7 @@ so you can do things like `client.query('select Id, (select Name from Children__
 
 Which authentication method you use really depends on your use case. If you're
 building an application where many users from different organizations are authenticated
-through oauth and you need to interact with data in their org on their behalf,
+through OAuth and you need to interact with data in their org on their behalf,
 you should use the OAuth token authentication method.
 
 If you're using the gem to interact with a single org (maybe you're building some
@@ -155,6 +155,17 @@ client = Restforce.new
 
 **Note:** Restforce library does not cache JWT Bearer tokens automatically. This means that every instantiation of the Restforce class will be treated as a new login by Salesforce. Remember that Salesforce enforces [rate limits on login requests](https://help.salesforce.com/s/articleView?id=000312767&type=1). If you are building an application that will instantiate the Restforce class more than this specified rate limit, you might want to consider caching the Bearer token either in-memory or in your own storage by leveraging the `authentication_callback` method. 
 
+## Client Credentials
+
+If you want to authenticate as an application, you can use the [Client Credentials flow](https://help.salesforce.com/s/articleView?id=sf.remoteaccess_oauth_client_credentials_flow.htm&type=5):
+
+```ruby
+client = Restforce.new(client_id: 'client_id',
+                       client_secret: 'client_secret',
+                       api_version: '55.0',
+                       instance_url: 'instance_url')
+```
+
 #### Sandbox Organizations
 
 You can connect to sandbox organizations by specifying a host. The default host is

data/lib/restforce/concerns/authentication.rb

@@ -21,6 +21,8 @@ module Restforce
           Restforce::Middleware::Authentication::Token
         elsif jwt?
           Restforce::Middleware::Authentication::JWTBearer
+        elsif client_credential?
+          Restforce::Middleware::Authentication::ClientCredential
         end
       end
 
@@ -48,6 +50,12 @@ module Restforce
           options[:username] &&
           options[:client_id]
       end
+
+      # Internal: Returns true if client credential flow should be used for
+      # authentication.
+      def client_credential?
+        options[:client_id] && options[:client_secret]
+      end
     end
   end
 end

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

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+module Restforce
+  class Middleware
+    class Authentication
+      class ClientCredential < Restforce::Middleware::Authentication
+        def params
+          { grant_type: 'client_credentials',
+            client_id: @options[:client_id],
+            client_secret: @options[:client_secret] }
+        end
+      end
+    end
+  end
+end

data/lib/restforce/middleware/authentication.rb

@@ -9,6 +9,7 @@ module Restforce
     autoload :Password,  'restforce/middleware/authentication/password'
     autoload :Token,     'restforce/middleware/authentication/token'
     autoload :JWTBearer, 'restforce/middleware/authentication/jwt_bearer'
+    autoload :ClientCredential, 'restforce/middleware/authentication/client_credential'
 
     # Rescue from 401's, authenticate then raise the error again so the client
     # can reissue the request.

data/lib/restforce/version.rb

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

data/restforce.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 3.0'
 
-  gem.add_dependency 'faraday', '< 2.8.0', '>= 1.1.0'
+  gem.add_dependency 'faraday', '< 2.9.0', '>= 1.1.0'
   gem.add_dependency 'faraday-follow_redirects', '<= 0.3.0', '< 1.0.0'
   gem.add_dependency 'faraday-multipart', '>= 1.0.0', '< 2.0.0'
   gem.add_dependency 'faraday-net_http', '< 4.0.0'

data/spec/unit/concerns/authentication_spec.rb

@@ -62,6 +62,17 @@ describe Restforce::Concerns::Authentication do
 
       it { should eq Restforce::Middleware::Authentication::JWTBearer }
     end
+
+    context 'when client_id and client_secret options are provided' do
+      before do
+        client.stub username_password?: false
+        client.stub oauth_refresh?: false
+        client.stub jwt?: false
+        client.stub client_credential?: true
+      end
+
+      it { should eq Restforce::Middleware::Authentication::ClientCredential }
+    end
   end
 
   describe '.username_password?' do
@@ -135,4 +146,26 @@ describe Restforce::Concerns::Authentication do
       it { should_not be true }
     end
   end
+
+  describe '.client_credential?' do
+    subject       { client.client_credential? }
+    let(:options) { {} }
+
+    before do
+      client.stub options: options
+    end
+
+    context 'when oauth client credential options are provided' do
+      let(:options) do
+        { client_id: 'client',
+          client_secret: 'secret' }
+      end
+
+      it { should be_truthy }
+    end
+
+    context 'when oauth client credential options are not provided' do
+      it { should_not be true }
+    end
+  end
 end

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

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+require 'spec_helper'
+
+describe Restforce::Middleware::Authentication::ClientCredential do
+  let(:options) do
+    { host: 'login.salesforce.com',
+      client_id: 'client_id',
+      client_secret: 'client_secret',
+      adapter: :net_http }
+  end
+
+  it_behaves_like 'authentication middleware' do
+    let(:success_request) do
+      stub_login_request(
+        body: "grant_type=client_credentials&" \
+              "client_id=client_id&client_secret=client_secret"
+      ).to_return(
+        status: 200,
+        body: fixture(:auth_success_response),
+        headers: { "Content-Type" => "application/json" }
+      )
+    end
+
+    let(:fail_request) do
+      stub_login_request(
+        body: "grant_type=client_credentials&" \
+              "client_id=client_id&client_secret=client_secret"
+      ).to_return(
+        status: 400,
+        body: fixture(:refresh_error_response),
+        headers: { "Content-Type" => "application/json" }
+      )
+    end
+  end
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 7.0.0
+  version: 7.1.0
 platform: ruby
 authors:
 - Tim Rogers
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-10-06 00:00:00.000000000 Z
+date: 2023-12-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,7 +17,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.8.0
+        version: 2.9.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
@@ -170,6 +170,7 @@ files:
 - lib/restforce/mash.rb
 - lib/restforce/middleware.rb
 - lib/restforce/middleware/authentication.rb
+- lib/restforce/middleware/authentication/client_credential.rb
 - lib/restforce/middleware/authentication/jwt_bearer.rb
 - lib/restforce/middleware/authentication/password.rb
 - lib/restforce/middleware/authentication/token.rb
@@ -257,6 +258,7 @@ files:
 - spec/unit/document_spec.rb
 - spec/unit/error_code_spec.rb
 - spec/unit/mash_spec.rb
+- spec/unit/middleware/authentication/client_credential_spec.rb
 - spec/unit/middleware/authentication/jwt_bearer_spec.rb
 - spec/unit/middleware/authentication/password_spec.rb
 - spec/unit/middleware/authentication/token_spec.rb