restforce 7.3.0 → 7.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 6654e481c857ecb9ac254b03727287038371662899d1ef0a136c49c1cd5e86d6
-  data.tar.gz: 5a78a982b7bc65c3332320682d44bc7f2a46a234b9afc5360bca79fa0c8eddeb
+  metadata.gz: bf5c1ca9f3040291c2e30d35f51d3be42e8d6cd2e73bc5e5ea108fddd015066a
+  data.tar.gz: fda0b60d481bb9200a2b682f282796d44f636ac07b5c4929e3e360e76c6a500e
 SHA512:
-  metadata.gz: 62fdf7157d265d3d8af5b37ecec52a98f1462a1dcc62e72471b2ddb29380821a90b0e38cb5cd111dc4b925182af169bda56f131e0798277e1f2c55f1132ec5d8
-  data.tar.gz: a62df632fca2528e5dd991dbf4ab95f5cb7cc201819dbfeed5dfb4d021bdf47b567a10eda7ed9cc2e7436acbf89951cd7f85e0d57bd421438a7b9870aa2ed8fb
+  metadata.gz: 23235274ac40e162128bd2dc86d4da182129e9b406e665241978aa7affce65ac656a7502ace2c94d14120a3c421debb2b7bbdf3919764a543cbc5a2570b16de2
+  data.tar.gz: 86fd5160d648437fb041bb914401c98f942b20fec3c2badc952a5915c55fbffcd6b94ba8a170a6925827744a3003b7552005629575b57df933115fa2f7e75625

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.12', '2.8.1', '2.9.0']
+        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.1', '2.9.2', '2.10.0']
     env:
       FARADAY_VERSION: ~> ${{ matrix.faraday_version }}
     steps:

data/CHANGELOG.md

@@ -1,3 +1,11 @@
+## 7.4.0 (July 10, 2024)
+
+- Add support for `faraday` v2.10.x (@ryan-mcneil)
+
+# 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)

data/Gemfile

@@ -3,7 +3,7 @@
 source 'https://rubygems.org'
 gemspec
 
-faraday_version = ENV.fetch('FARADAY_VERSION', '~> 2.9.0')
+faraday_version = ENV.fetch('FARADAY_VERSION', '~> 2.10.0')
 
 # Enable us to explicitly pick a Faraday version when running tests
 gem 'faraday', faraday_version
@@ -17,6 +17,6 @@ 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.65.0'
 gem 'simplecov', '~> 0.22.0'
-gem 'webmock', '~> 3.20.0'
+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.3.0'
+    gem 'restforce', '~> 7.4.0'
 
 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
@@ -842,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/error_code.rb

@@ -666,7 +666,7 @@ module Restforce
            "defined. If you're sure that this is a valid Salesforce error, then " \
            "please create an issue on GitHub at <#{GITHUB_ISSUE_URL}>."
 
-      super(constant_name)
+      super
     end
   end
 end

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.3.0'
+  VERSION = '7.4.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.10.0', '>= 1.1.0'
+  gem.add_dependency 'faraday', '< 2.11.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/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.3.0
+  version: 7.4.0
 platform: ruby
 authors:
 - Tim Rogers
@@ -9,7 +9,7 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-02-14 00:00:00.000000000 Z
+date: 2024-07-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -17,7 +17,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0
@@ -27,7 +27,7 @@ dependencies:
     requirements:
     - - "<"
       - !ruby/object:Gem::Version
-        version: 2.10.0
+        version: 2.11.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 1.1.0