restforce 5.2.4 → 5.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: dfdaff5160d8845afd9c6ed3c384c7edf7d9ecb2593d562bae4d9a4812904137
-  data.tar.gz: 8510146b906c8f7f0869a467db96d9bd3416446338a9d237d8c2e633c911cc35
+  metadata.gz: 54463ffbbbc7f62bb17637d0bd80f9ed54061333fff5a843e40c152613fbf34b
+  data.tar.gz: 22c2bf1bc1c516a1f31262901ef0c50c8a4417b2dc0c3838178649b220b481cd
 SHA512:
-  metadata.gz: 592471696b0c585cb73bc26cca75267cfc7a2f3543f86449edd4e3ffc5401975cd4ded7cc7a20b63b5854434c06e6e63c48e0f49bf51839b8b8bee15e02113e8
-  data.tar.gz: 71c9272a0799c6e899bbdd56a0380b6ae5b7112d11e56fb3860a10ca0ba0b1dfb9cf58bb25b0bf59ad8f8b38f50360f5f8ccbed4090afa194a67a19a7ae28318
+  metadata.gz: 82ecf32cf2ac55f42c20222a9d53d63ff595f96b591d46de3a0160b87d12a6c31a537c99dd6b08992f7ec1f58a21ba100ea14557660e57bd350eab965f5ef768
+  data.tar.gz: d33636c9271830f8acb4da01201c042ee9147e11cf4514ebc5a144311da350f2e3379469531801fe8e276ddfff2145c7f04f19a19cd77e304da56190b97cc270

data/.github/dependabot.yml

@@ -4,16 +4,7 @@ updates:
   directory: "/"
   schedule:
     interval: daily
-  open-pull-requests-limit: 10
-  ignore:
-  - dependency-name: rubocop
-    versions:
-    - 1.10.0
-    - 1.11.0
-    - 1.12.0
-    - 1.12.1
-    - 1.9.0
-  - dependency-name: webmock
-    versions:
-    - 3.12.0
-    - 3.12.1
+- package-ecosystem: 'github-actions'
+  directory: '/'
+  schedule:
+    interval: 'daily'

data/.github/workflows/build.yml

@@ -0,0 +1,26 @@
+name: 'Build'
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        ruby_version: ['2.6', '2.7', '3.0', '3.1', '3.2.0-preview1']
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: ${{ matrix.ruby_version }}
+      - name: Install dependencies
+        run: bundle install
+      - name: Lint Ruby files
+        run: bundle exec rubocop
+      - name: Run RSpec tests
+        run: bundle exec rspec

data/.github/workflows/faraday.yml

@@ -0,0 +1,26 @@
+name: 'Test against supported Faraday minor versions'
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+jobs:
+  lint-and-test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        faraday_version: ['1.8.0', '1.9.0', '1.10.0']
+    env:
+      FARADAY_VERSION: ~> ${{ matrix.faraday_version }}
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v3
+      - name: Setup Ruby ${{ matrix.ruby_version }}
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+          ruby-version: 3.1
+      - name: Install dependencies
+        run: bundle install
+      - name: Run RSpec tests
+        run: bundle exec rspec

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+# 5.3.0 (May 30, 2022)
+
+* Add support for Faraday v1.9.x and v1.10.0 (@magni-, @timrogers)
+* Follow redirects during authentication to support Lightning URLs (e.g. `*.lightning.force.com` instead of `*.my.salesforce.com`) (@nhocki)
+
 # 5.2.4 (Mar 16, 2022)
 
 * Fix `Restforce::Collection#size` for Salesforce APIs that use the `size` property to return the total number of results, instead of `totalSize` (@kwong-yw)

data/Gemfile

@@ -3,6 +3,8 @@
 source 'https://rubygems.org'
 gemspec
 
+# Enable us to explicitly pick a Faraday version when running tests
+gem 'faraday', ENV.fetch('FARADAY_VERSION', '~> 1.8.0')
 gem 'faye' unless RUBY_PLATFORM == 'java'
 gem 'guard-rspec'
 gem 'guard-rubocop'
@@ -12,6 +14,6 @@ gem 'rspec', '~> 3.11.0'
 gem 'rspec-collection_matchers', '~> 1.2.0'
 gem 'rspec-its', '~> 1.3.0'
 gem 'rspec_junit_formatter', '~> 0.5.1'
-gem 'rubocop', '~> 1.26.0'
+gem 'rubocop', '~> 1.30.0'
 gem 'simplecov', '~> 0.21.2'
 gem 'webmock', '~> 3.14.0'

data/README.md

@@ -1,7 +1,7 @@
 # Restforce
 
-[![CircleCI](https://circleci.com/gh/restforce/restforce.svg?style=svg)](https://circleci.com/gh/restforce/restforce) [![Code Climate](https://codeclimate.com/github/restforce/restforce.png)](https://codeclimate.com/github/restforce/restforce) [![Dependency Status](https://gemnasium.com/restforce/restforce.png)](https://gemnasium.com/restforce/restforce)
-![](https://img.shields.io/gem/dt/restforce.svg)
+[![CircleCI](https://circleci.com/gh/restforce/restforce.svg?style=svg)](https://circleci.com/gh/restforce/restforce)
+![Downloads](https://img.shields.io/gem/dt/restforce.svg)
 
 Restforce is a ruby gem for the [Salesforce REST api](http://www.salesforce.com/us/developer/docs/api_rest/index.htm).
 
@@ -27,7 +27,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 5.2.4'
+    gem 'restforce', '~> 5.3.0'
 
 And then execute:
 

data/lib/restforce/config.rb

@@ -91,29 +91,31 @@ module Restforce
       end
     end
 
-    option :api_version, default: lambda { ENV['SALESFORCE_API_VERSION'] || '26.0' }
+    option :api_version, default: lambda { ENV.fetch('SALESFORCE_API_VERSION', '26.0') }
 
     # The username to use during login.
-    option :username, default: lambda { ENV['SALESFORCE_USERNAME'] }
+    option :username, default: lambda { ENV.fetch('SALESFORCE_USERNAME', nil) }
 
     # The password to use during login.
-    option :password, default: lambda { ENV['SALESFORCE_PASSWORD'] }
+    option :password, default: lambda { ENV.fetch('SALESFORCE_PASSWORD', nil) }
 
     # The security token to use during login.
-    option :security_token, default: lambda { ENV['SALESFORCE_SECURITY_TOKEN'] }
+    option :security_token, default: lambda {
+                                       ENV.fetch('SALESFORCE_SECURITY_TOKEN', nil)
+                                     }
 
     # The OAuth client id
-    option :client_id, default: lambda { ENV['SALESFORCE_CLIENT_ID'] }
+    option :client_id, default: lambda { ENV.fetch('SALESFORCE_CLIENT_ID', nil) }
 
     # The OAuth client secret
-    option :client_secret, default: lambda { ENV['SALESFORCE_CLIENT_SECRET'] }
+    option :client_secret, default: lambda { ENV.fetch('SALESFORCE_CLIENT_SECRET', nil) }
 
     # 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' }
+    option :host, default: lambda { ENV.fetch('SALESFORCE_HOST', 'login.salesforce.com') }
 
     option :oauth_token
     option :refresh_token
@@ -139,7 +141,7 @@ module Restforce
     # Faraday adapter to use. Defaults to Faraday.default_adapter.
     option :adapter, default: lambda { Faraday.default_adapter }
 
-    option :proxy_uri, default: lambda { ENV['SALESFORCE_PROXY_URI'] }
+    option :proxy_uri, default: lambda { ENV.fetch('SALESFORCE_PROXY_URI', nil) }
 
     # A Proc that is called with the response body after a successful authentication.
     option :authentication_callback

data/lib/restforce/file_part.rb

@@ -1,9 +1,20 @@
 # frozen_string_literal: true
 
-begin
-  require 'faraday/file_part'
-rescue LoadError
+case Faraday::VERSION
+when /\A0\./
   require 'faraday/upload_io'
+when /\A1\.[0-8]\./
+  # Faraday 1.x versions before 1.9 - not matched by
+  # the previous clause - use `FilePart` (which must be explicitly
+  # required)
+  require 'faraday/file_part'
+when /\A1\./
+  # Later 1.x versions from 1.9 onwards automatically include the
+  # `faraday-multipart` gem, which includes `Faraday::FilePart`
+  require 'faraday/multipart'
+else
+  raise "Unexpected Faraday version #{Faraday::VERSION} - not sure how to set up " \
+        "multipart support"
 end
 
 module Restforce

data/lib/restforce/middleware/authentication.rb

@@ -49,6 +49,7 @@ module Restforce
       @connection ||= Faraday.new(faraday_options) do |builder|
         builder.use Faraday::Request::UrlEncoded
         builder.use Restforce::Middleware::Mashify, nil, @options
+        builder.use FaradayMiddleware::FollowRedirects
         builder.response :json
 
         if Restforce.log?

data/lib/restforce/version.rb

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

data/restforce.gemspec

@@ -12,7 +12,6 @@ Gem::Specification.new do |gem|
 
   gem.files         = `git ls-files`.split($OUTPUT_RECORD_SEPARATOR)
   gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
-  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.name          = "restforce"
   gem.require_paths = ["lib"]
   gem.version       = Restforce::VERSION
@@ -25,7 +24,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.6'
 
-  gem.add_dependency 'faraday', '< 1.9.0', '>= 0.9.0'
+  gem.add_dependency 'faraday', '<= 1.10.0', '>= 0.9.0'
   gem.add_dependency 'faraday_middleware', ['>= 0.8.8', '<= 2.0']
   gem.add_dependency 'hashie', '>= 1.2.0', '< 6.0'
   gem.add_dependency 'jwt', ['>= 1.5.6']

data/spec/unit/concerns/api_spec.rb

@@ -312,8 +312,11 @@ describe Restforce::Concerns::API do
         let(:attrs) { { id: '1234', StageName: "Call Scheduled" } }
 
         it 'sends an HTTP PATCH, and returns true' do
-          client.should_receive(:api_patch).
-            with('sobjects/Whizbang/1234', StageName: "Call Scheduled")
+          client.should_receive(:api_patch) do |*args|
+            expect(args).to eq(["sobjects/Whizbang/1234",
+                                { StageName: "Call Scheduled" }])
+          end
+
           expect(result).to be true
         end
       end
@@ -322,8 +325,12 @@ describe Restforce::Concerns::API do
         let(:attrs) { { id: '1234/?abc', StageName: "Call Scheduled" } }
 
         it 'sends an HTTP PATCH, and encodes the ID' do
-          client.should_receive(:api_patch).
-            with('sobjects/Whizbang/1234%2F%3Fabc', StageName: "Call Scheduled")
+          client.should_receive(:api_patch) do |*args|
+            expect(args).to eq(['sobjects/Whizbang/1234%2F%3Fabc', {
+                                 StageName: "Call Scheduled"
+                               }])
+          end
+
           expect(result).to be true
         end
       end

data/spec/unit/config_spec.rb

@@ -44,7 +44,7 @@ describe Restforce do
           'SALESFORCE_PROXY_URI'      => 'proxy',
           'SALESFORCE_HOST'           => 'test.host.com',
           'SALESFORCE_API_VERSION'    => '37.0' }.
-          each { |var, value| ENV.stub(:[]).with(var).and_return(value) }
+          each { |var, value| ENV.stub(:fetch).with(var, anything).and_return(value) }
       end
 
       its(:username)       { should eq 'foo' }

metadata

@@ -1,23 +1,23 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 5.2.4
+  version: 5.3.0
 platform: ruby
 authors:
 - Tim Rogers
 - Eric J. Holmes
-autorequire:
+autorequire: 
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
@@ -25,9 +25,9 @@ dependencies:
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "<"
+    - - "<="
       - !ruby/object:Gem::Version
-        version: 1.9.0
+        version: 1.10.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
@@ -93,9 +93,10 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/unhandled-salesforce-error.md"
 - ".github/dependabot.yml"
+- ".github/workflows/build.yml"
+- ".github/workflows/faraday.yml"
 - ".gitignore"
 - ".rubocop.yml"
 - ".rubocop_todo.yml"
@@ -240,7 +241,7 @@ metadata:
   source_code_uri: https://github.com/restforce/restforce
   changelog_uri: https://github.com/restforce/restforce/blob/master/CHANGELOG.md
   rubygems_mfa_required: 'true'
-post_install_message:
+post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
@@ -255,85 +256,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.3
-signing_key:
+rubygems_version: 3.1.6
+signing_key: 
 specification_version: 4
 summary: A lightweight Ruby client for the Salesforce REST API
-test_files:
-- spec/fixtures/auth_error_response.json
-- spec/fixtures/auth_success_response.json
-- spec/fixtures/blob.jpg
-- spec/fixtures/expired_session_response.json
-- spec/fixtures/reauth_success_response.json
-- spec/fixtures/refresh_error_response.json
-- spec/fixtures/refresh_success_response.json
-- spec/fixtures/services_data_success_response.json
-- spec/fixtures/sobject/create_success_response.json
-- spec/fixtures/sobject/delete_error_response.json
-- spec/fixtures/sobject/describe_sobjects_success_response.json
-- spec/fixtures/sobject/get_deleted_success_response.json
-- spec/fixtures/sobject/get_updated_success_response.json
-- spec/fixtures/sobject/list_sobjects_success_response.json
-- spec/fixtures/sobject/list_view_results_success_response.json
-- spec/fixtures/sobject/org_query_response.json
-- spec/fixtures/sobject/query_aggregate_success_response.json
-- spec/fixtures/sobject/query_empty_response.json
-- spec/fixtures/sobject/query_error_response.json
-- spec/fixtures/sobject/query_paginated_first_page_response.json
-- spec/fixtures/sobject/query_paginated_last_page_response.json
-- spec/fixtures/sobject/query_success_response.json
-- spec/fixtures/sobject/recent_success_response.json
-- spec/fixtures/sobject/search_error_response.json
-- spec/fixtures/sobject/search_success_response.json
-- spec/fixtures/sobject/sobject_describe_error_response.json
-- spec/fixtures/sobject/sobject_describe_success_response.json
-- spec/fixtures/sobject/sobject_find_error_response.json
-- spec/fixtures/sobject/sobject_find_success_response.json
-- spec/fixtures/sobject/sobject_select_success_response.json
-- spec/fixtures/sobject/upsert_created_success_response.json
-- spec/fixtures/sobject/upsert_error_response.json
-- 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
-- spec/support/client_integration.rb
-- spec/support/concerns.rb
-- spec/support/event_machine.rb
-- spec/support/fixture_helpers.rb
-- spec/support/matchers.rb
-- spec/support/middleware.rb
-- spec/support/mock_cache.rb
-- spec/unit/abstract_client_spec.rb
-- spec/unit/attachment_spec.rb
-- spec/unit/collection_spec.rb
-- spec/unit/concerns/api_spec.rb
-- spec/unit/concerns/authentication_spec.rb
-- spec/unit/concerns/base_spec.rb
-- spec/unit/concerns/batch_api_spec.rb
-- spec/unit/concerns/caching_spec.rb
-- spec/unit/concerns/canvas_spec.rb
-- spec/unit/concerns/composite_api_spec.rb
-- spec/unit/concerns/connection_spec.rb
-- spec/unit/concerns/streaming_spec.rb
-- spec/unit/config_spec.rb
-- spec/unit/data/client_spec.rb
-- spec/unit/document_spec.rb
-- spec/unit/error_code_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
-- spec/unit/middleware/authorization_spec.rb
-- spec/unit/middleware/custom_headers_spec.rb
-- spec/unit/middleware/gzip_spec.rb
-- spec/unit/middleware/instance_url_spec.rb
-- spec/unit/middleware/logger_spec.rb
-- spec/unit/middleware/mashify_spec.rb
-- spec/unit/middleware/raise_error_spec.rb
-- spec/unit/signed_request_spec.rb
-- spec/unit/sobject_spec.rb
-- spec/unit/tooling/client_spec.rb
+test_files: []

data/.circleci/config.yml

@@ -1,61 +0,0 @@
-version: 2
-
-references:
-  steps: &steps
-    - checkout
-
-    - run:
-        name: Update Bundler
-        command: gem install bundler
-
-    - run:
-        name: Install dependencies from .gemspec
-        command: bundle install --jobs=4 --retry=3 --path vendor/bundle
-
-    - run:
-        name: Run RSpec tests
-        command: |
-          mkdir /tmp/test-results
-          
-          bundle exec rspec --format progress \
-                          --format RspecJunitFormatter \
-                          --out /tmp/test-results/rspec.xml \
-                          --format progress \
-                          spec/**/*_spec.rb
-
-    - run:
-        name: Check code style with Rubocop
-        command: bundle exec rubocop
-
-    - store_test_results:
-        path: /tmp/test-results
-    - store_artifacts:
-        path: /tmp/test-results
-        destination: test-results
-
-jobs:
-  build-ruby31:
-    docker:
-       - image: cimg/ruby:3.1
-    steps: *steps
-  build-ruby30:
-    docker:
-       - image: cimg/ruby:3.0
-    steps: *steps
-  build-ruby27:
-    docker:
-       - image: cimg/ruby:2.7
-    steps: *steps
-  build-ruby26:
-    docker:
-       - image: cimg/ruby:2.6
-    steps: *steps
-
-workflows:
-  version: 2
-  tests:
-    jobs:
-      - build-ruby31
-      - build-ruby30
-      - build-ruby27
-      - build-ruby26