restforce 7.2.0 → 7.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 32f18ed324e748a4cc4b9b6178db20373ddcc219d44c3a98baccfbb50e29c1d5
-  data.tar.gz: a9fbbc98cb0c0929f561e8730bfef4913eca9994a489d337c6e67359bcaa9040
+  metadata.gz: f34ecbdf8bef8fa7068bef79572000b9766bd9c3be35f8aebe87f43630180910
+  data.tar.gz: 8644247ec7b8201da773efef8d87084b2e91f864fe307eb7d9d0de681c4acc21
 SHA512:
-  metadata.gz: 3a26f9c8ccc4c846af46fe3019679afdfb1a82d6ca94979d8d6e119bf87681abd73b15ca1fd6f32d1ad1ce663b8b69d31f0d64d38451c15378cc45c0b99022ef
-  data.tar.gz: cab7aac0506a7963a0b1a4cf56e257c0b09ff7cb15f0e17491cb57d18e2797b676c1463470052fecf4ea3d93645b71780d6318ee59c3306fb2c268da7a15a462
+  metadata.gz: df91e270270256472f9a56a384ddf3884d18cdc227910a08132ed6bed8e26063460a7702a0211ea04e93392ffeffaf655211083edfb9013839e63f9ab1eacaf3
+  data.tar.gz: d348b9e29964e071883c40158da5f97a10766b05dc093309f71338ec72f01def17238fc9a65ad3014088cf45a5d7f5e72b11a9ec8d9ad0c446947650ce783c62

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+# 7.3.1 (Mar 30, 2024)
+
+- Fix `uninitialized constant StringIO` error by explicitly requiring `StringIO` where it's used (@timrogers)
+
+# 7.3.0 (Feb 14, 2024 🧡)
+
+- Add support for making `GET` requests using the Composite API (@shravan097)
+
 # 7.2.0 (Jan 23, 2024)
 
 - Add support for `faraday` v2.9.x (@timrogers)

data/Gemfile

@@ -13,10 +13,10 @@ gem 'guard-rspec'
 gem 'guard-rubocop'
 gem 'jruby-openssl', platforms: :jruby
 gem 'rake'
-gem 'rspec', '~> 3.12.0'
+gem 'rspec', '~> 3.13.0'
 gem 'rspec-collection_matchers', '~> 1.2.0'
 gem 'rspec-its', '~> 1.3.0'
 gem 'rspec_junit_formatter', '~> 0.6.0'
-gem 'rubocop', '~> 1.60.1'
+gem 'rubocop', '~> 1.62.1'
 gem 'simplecov', '~> 0.22.0'
-gem 'webmock', '~> 3.19.1'
+gem 'webmock', '~> 3.23.0'

data/README.md

@@ -27,7 +27,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 7.2.0'
+    gem 'restforce', '~> 7.3.1'
 
 And then execute:
 
@@ -155,7 +155,7 @@ 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
+#### 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):
 
@@ -163,7 +163,7 @@ If you want to authenticate as an application, you can use the [Client Credentia
 client = Restforce.new(client_id: 'client_id',
                        client_secret: 'client_secret',
                        api_version: '55.0',
-                       instance_url: 'instance_url')
+                       host: 'MYDOMAIN.my.salesforce.com')
 ```
 
 #### Sandbox Organizations
@@ -600,7 +600,6 @@ This feature permits the user to send a composite object—that is, a complex
 object with nested children—in a single API call. Up to 25 requests may be
 included in a single composite.
 
-Note that `GET` is not yet implemented for this API.
 
 ```ruby
 # build up an array of requests:
@@ -843,6 +842,18 @@ client.create!("CustomField", {
 })
 ```
 
+## Configuration Precedence
+
+Here's the order of precedence from highest to lowest:
+
+Arguments on new: passing configuration options directly as arguments has the highest precedence. These settings will override any other configuration.
+
+Configuration block: using Restforce.configure to set configuration options is the next in line. They will take precedence over environment variables and defaults but will be overridden by direct arguments on instantiation.
+
+Environment variables: has the lowest precedence. If you set options using environment variables, they will be overridden by any other configuration method.
+
+Defaults: If none of the above methods are used, Restforce falls back to its default configuration values.
+
 ## Contributing
 
 We welcome all contributions - they help us make Restforce the best gem possible.

data/lib/restforce/concerns/composite_api.rb

@@ -93,6 +93,14 @@ module Restforce
           }
         end
 
+        def find(sobject, reference_id, id)
+          requests << {
+            method: 'GET',
+            url: composite_api_path("#{sobject}/#{id}"),
+            referenceId: reference_id
+          }
+        end
+
         private
 
         def composite_api_path(path)

data/lib/restforce/middleware/gzip.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+require 'stringio'
 require 'zlib'
 
 module Restforce

data/lib/restforce/patches/parts.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'stringio'
+
 module Faraday
   module Parts
     module Part

data/lib/restforce/version.rb

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

data/spec/unit/concerns/composite_api_spec.rb

@@ -82,6 +82,23 @@ describe Restforce::Concerns::CompositeAPI do
       end
     end
 
+    it '#find' do
+      client.
+        should_receive(:api_post).
+        with(endpoint, { compositeRequest: [
+          {
+            method: 'GET',
+            url: "/services/data/v38.0/sobjects/Object/00312345",
+            referenceId: 'find_ref'
+          }
+        ], allOrNone: all_or_none, collateSubrequests: false }.to_json).
+        and_return(response)
+
+      client.send(method) do |subrequests|
+        subrequests.find('Object', 'find_ref', '00312345')
+      end
+    end
+
     it 'multiple subrequests' do
       client.
         should_receive(:api_post).

data/spec/unit/config_spec.rb

@@ -70,6 +70,21 @@ describe Restforce do
         expect(Restforce.configuration.send(attr)).to eq 'foobar'
       end
     end
+
+    it 'takes precedence over environment variables' do
+      { 'SALESFORCE_USERNAME'  => 'env_foo',
+        'SALESFORCE_CLIENT_ID' => 'env_client id' }.
+        each { |var, value| ENV.stub(:fetch).with(var, anything).and_return(value) }
+
+      { username: 'config_foo', client_id: nil }.each do |attr, value|
+        Restforce.configure do |config|
+          config.send("#{attr}=", value)
+        end
+      end
+
+      expect(Restforce.configuration.send(:username)).to eq 'config_foo'
+      expect(Restforce.configuration.send(:client_id)).to eq 'env_client id'
+    end
   end
 
   describe '#log?' do
@@ -138,5 +153,17 @@ describe Restforce do
         checker.check!
       end
     end
+
+    it 'shows the precedence over config' do
+      ENV['SALESFORCE_USERNAME'] = 'env_foo'
+      Restforce.configure do |config|
+        config.username = 'config_foo'
+      end
+      client = Restforce.new(username: 'foo')
+
+      expect(client.options[:username]).to eq 'foo'
+
+      Restforce.instance_variable_set :@configuration, nil
+    end
   end
 end

data/spec/unit/middleware/gzip_spec.rb

@@ -1,5 +1,7 @@
 # frozen_string_literal: true
 
+require 'stringio'
+
 require 'spec_helper'
 
 describe Restforce::Middleware::Gzip do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 7.2.0
+  version: 7.3.1
 platform: ruby
 authors:
 - Tim Rogers
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-01-23 00:00:00.000000000 Z
+date: 2024-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday