restforce 5.2.1 → 5.2.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 891d81fbf377945b09db6058467d21da1720d985e70ad060e4bcbe35d5efc9f6
-  data.tar.gz: 2ce207d94d49504e28680d7b854633cc3c2c0b329ed23b04769528799b71785e
+  metadata.gz: dfdaff5160d8845afd9c6ed3c384c7edf7d9ecb2593d562bae4d9a4812904137
+  data.tar.gz: 8510146b906c8f7f0869a467db96d9bd3416446338a9d237d8c2e633c911cc35
 SHA512:
-  metadata.gz: 04e9f867ebadf6a8d61ffad3ebdb14b9924011df9b408efb9f17bb8a65c7ad5a4de1caa18b78dd365b889bf6b32801d7c30d7de02f105be38a3b4111cf83b792
-  data.tar.gz: c72397f42ef4a4f95a053557bf8971e3eeff78994b21ccdc232638ef1847c08e7e1c8e9e33f6055725c9fbc57755de85d474cf6063094ec6e33e211a93ba14d4
+  metadata.gz: 592471696b0c585cb73bc26cca75267cfc7a2f3543f86449edd4e3ffc5401975cd4ded7cc7a20b63b5854434c06e6e63c48e0f49bf51839b8b8bee15e02113e8
+  data.tar.gz: 71c9272a0799c6e899bbdd56a0380b6ae5b7112d11e56fb3860a10ca0ba0b1dfb9cf58bb25b0bf59ad8f8b38f50360f5f8ccbed4090afa194a67a19a7ae28318

data/.circleci/config.yml

@@ -34,23 +34,28 @@ references:
         destination: test-results
 
 jobs:
+  build-ruby31:
+    docker:
+       - image: cimg/ruby:3.1
+    steps: *steps
   build-ruby30:
     docker:
-       - image: circleci/ruby:3.0
+       - image: cimg/ruby:3.0
     steps: *steps
   build-ruby27:
     docker:
-       - image: circleci/ruby:2.7
+       - image: cimg/ruby:2.7
     steps: *steps
   build-ruby26:
     docker:
-       - image: circleci/ruby:2.6
+       - image: cimg/ruby:2.6
     steps: *steps
 
 workflows:
   version: 2
   tests:
     jobs:
+      - build-ruby31
       - build-ruby30
       - build-ruby27
       - build-ruby26

data/CHANGELOG.md

@@ -1,3 +1,17 @@
+# 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)
+
+# 5.2.3 (Jan 17, 2022)
+
+* Add official support for Ruby 3.1 (@timrogers)
+* Fix handling of responses from the Composite API (@robob27)
+* Fix dependencies to correctly declare that the gem doesn't work with [faraday](https://github.com/lostisland/faraday) `v1.9.0` or later (@timrogers)
+
+# 5.2.2 (Dec 16, 2021)
+
+* Handle the `MALFORMED_SEARCH` error returned by Salesforce (@timrogers)
+
 # 5.2.1 (Dec 8, 2021)
 
 * Handle the `OPERATION_TOO_LARGE` error returned by Salesforce (@timrogers)

data/Gemfile

@@ -8,10 +8,10 @@ gem 'guard-rspec'
 gem 'guard-rubocop'
 gem 'jruby-openssl', platforms: :jruby
 gem 'rake'
-gem 'rspec', '~> 3.10.0'
+gem 'rspec', '~> 3.11.0'
 gem 'rspec-collection_matchers', '~> 1.2.0'
 gem 'rspec-its', '~> 1.3.0'
-gem 'rspec_junit_formatter', '~> 0.4.1'
-gem 'rubocop', '~> 1.23.0'
+gem 'rspec_junit_formatter', '~> 0.5.1'
+gem 'rubocop', '~> 1.26.0'
 gem 'simplecov', '~> 0.21.2'
 gem 'webmock', '~> 3.14.0'

data/README.md

@@ -27,7 +27,7 @@ Features include:
 
 Add this line to your application's Gemfile:
 
-    gem 'restforce', '~> 5.2.1'
+    gem 'restforce', '~> 5.2.4'
 
 And then execute:
 

data/lib/restforce/collection.rb

@@ -30,8 +30,12 @@ module Restforce
     # Return the number of items in the Collection without making any additional
     # requests and going through all of the pages of results, one by one. Instead,
     # we can rely on the total count of results which Salesforce returns.
+    #
+    # Most of the Salesforce API returns this in the `totalSize` attribute. For
+    # some reason, the [List View Results](https://developer.salesforce.com/docs/atlas.en-us.api_rest.meta/api_rest/resources_listviewresults.htm)
+    # endpoint (and maybe others?!) uses the `size` attribute.
     def size
-      @raw_page['totalSize']
+      @raw_page['totalSize'] || @raw_page['size']
     end
     alias length size
 

data/lib/restforce/concerns/base.rb

@@ -61,9 +61,9 @@ module Restforce
       def initialize(opts = {})
         raise ArgumentError, 'Please specify a hash of options' unless opts.is_a?(Hash)
 
-        @options = Restforce.configuration.options.map do |option|
+        @options = Restforce.configuration.options.to_h do |option|
           [option, Restforce.configuration.send(option)]
-        end.to_h
+        end
 
         @options.merge! opts
         yield builder if block_given?

data/lib/restforce/concerns/composite_api.rb

@@ -24,12 +24,12 @@ module Restforce
         }
         response = api_post('composite', properties.to_json)
 
-        results = response.body['CompositeResponse']
-        has_errors = results.any? { |result| result['HttpStatusCode'].digits.last == 4 }
+        results = response.body['compositeResponse']
+        has_errors = results.any? { |result| result['httpStatusCode'].digits.last == 4 }
         if all_or_none && has_errors
-          last_error_index = results.rindex { |result| result['HttpStatusCode'] != 412 }
+          last_error_index = results.rindex { |result| result['httpStatusCode'] != 412 }
           last_error = results[last_error_index]
-          raise CompositeAPIError, last_error['Body'][0]['errorCode']
+          raise CompositeAPIError, last_error['body'][0]['errorCode']
         end
 
         results

data/lib/restforce/error_code.rb

@@ -277,6 +277,8 @@ module Restforce
 
     class MalformedQuery < ResponseError; end
 
+    class MalformedSearch < ResponseError; end
+
     class ManagerNotDefined < ResponseError; end
 
     class MassmailRetryLimitExceeded < ResponseError; end
@@ -551,6 +553,7 @@ module Restforce
       "LOGIN_MUST_USE_SECURITY_TOKEN" => LoginMustUseSecurityToken,
       "MALFORMED_ID" => MalformedId,
       "MALFORMED_QUERY" => MalformedQuery,
+      "MALFORMED_SEARCH" => MalformedSearch,
       "MANAGER_NOT_DEFINED" => ManagerNotDefined,
       "MASSMAIL_RETRY_LIMIT_EXCEEDED" => MassmailRetryLimitExceeded,
       "MASS_MAIL_LIMIT_EXCEEDED" => MassMailLimitExceeded,

data/lib/restforce/version.rb

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

data/restforce.gemspec

@@ -25,7 +25,7 @@ Gem::Specification.new do |gem|
 
   gem.required_ruby_version = '>= 2.6'
 
-  gem.add_dependency 'faraday', '<= 2.0', '>= 0.9.0'
+  gem.add_dependency 'faraday', '< 1.9.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/fixtures/sobject/list_view_results_success_response.json

@@ -0,0 +1,151 @@
+{
+  "columns" : [ {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "Name",
+    "hidden" : false,
+    "label" : "Account Name",
+    "selectListItem" : "Name",
+    "sortDirection" : "ascending",
+    "sortIndex" : 0,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "Site",
+    "hidden" : false,
+    "label" : "Account Site",
+    "selectListItem" : "Site",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "BillingState",
+    "hidden" : false,
+    "label" : "Billing State/Province",
+    "selectListItem" : "BillingState",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : "9-0",
+    "descendingLabel" : "0-9",
+    "fieldNameOrPath" : "Phone",
+    "hidden" : false,
+    "label" : "Phone",
+    "selectListItem" : "Phone",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "phone"
+  }, {
+    "ascendingLabel" : "Low to High",
+    "descendingLabel" : "High to Low",
+    "fieldNameOrPath" : "Type",
+    "hidden" : false,
+    "label" : "Type",
+    "selectListItem" : "toLabel(Type)",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "picklist"
+  }, {
+    "ascendingLabel" : "Z-A",
+    "descendingLabel" : "A-Z",
+    "fieldNameOrPath" : "Owner.Alias",
+    "hidden" : false,
+    "label" : "Account Owner Alias",
+    "selectListItem" : "Owner.Alias",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : true,
+    "type" : "string"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "Id",
+    "hidden" : true,
+    "label" : "Account ID",
+    "selectListItem" : "Id",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "id"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "CreatedDate",
+    "hidden" : true,
+    "label" : "Created Date",
+    "selectListItem" : "CreatedDate",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "datetime"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "LastModifiedDate",
+    "hidden" : true,
+    "label" : "Last Modified Date",
+    "selectListItem" : "LastModifiedDate",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "datetime"
+  }, {
+    "ascendingLabel" : null,
+    "descendingLabel" : null,
+    "fieldNameOrPath" : "SystemModstamp",
+    "hidden" : true,
+    "label" : "System Modstamp",
+    "selectListItem" : "SystemModstamp",
+    "sortDirection" : null,
+    "sortIndex" : null,
+    "sortable" : false,
+    "type" : "datetime"
+  } ],
+  "developerName" : "MyAccounts",
+  "done" : true,
+  "id" : "00BD0000005WcCN",
+  "label" : "My Accounts",
+  "records" : [ {
+    "columns" : [ {
+      "fieldNameOrPath" : "Name",
+      "value" : "Burlington Textiles Corp of America"
+    }, {
+      "fieldNameOrPath" : "Site",
+      "value" : null
+    }, {
+      "fieldNameOrPath" : "BillingState",
+      "value" : "NC"
+    }, {
+      "fieldNameOrPath" : "Phone",
+      "value" : "(336) 222-7000"
+    }, {
+      "fieldNameOrPath" : "Type",
+      "value" : "Customer - Direct"
+    }, {
+      "fieldNameOrPath" : "Owner.Alias",
+      "value" : "TUser"
+    }, {
+      "fieldNameOrPath" : "Id",
+      "value" : "001D000000JliSTIAZ"
+    }, {
+      "fieldNameOrPath" : "CreatedDate",
+      "value" : "Fri Aug 01 21:15:46 GMT 2014"
+    }, {
+      "fieldNameOrPath" : "LastModifiedDate",
+      "value" : "Fri Aug 01 21:15:46 GMT 2014"
+    }, {
+      "fieldNameOrPath" : "SystemModstamp",
+      "value" : "Fri Aug 01 21:15:46 GMT 2014"
+    } ]
+  } ],
+  "size" : 1
+}

data/spec/unit/collection_spec.rb

@@ -63,6 +63,24 @@ describe Restforce::Collection do
     end
   end
 
+  describe '#size' do
+    subject(:size) do
+      described_class.new(JSON.parse(fixture(sobject_fixture)), client).size
+    end
+
+    context 'when the query response contains a totalSize field' do
+      let(:sobject_fixture) { 'sobject/query_success_response' }
+
+      it { should eq 1 }
+    end
+
+    context 'when the query response contains a size field' do
+      let(:sobject_fixture) { 'sobject/list_view_results_success_response' }
+
+      it { should eq 1 }
+    end
+  end
+
   describe '#empty?' do
     subject(:empty?) do
       described_class.new(JSON.parse(fixture(sobject_fixture)), client).empty?

data/spec/unit/concerns/composite_api_spec.rb

@@ -128,7 +128,7 @@ describe Restforce::Concerns::CompositeAPI do
   describe '#composite' do
     let(:method) { :composite }
     let(:all_or_none) { false }
-    let(:response) { double('Faraday::Response', body: { 'CompositeResponse' => [] }) }
+    let(:response) { double('Faraday::Response', body: { 'compositeResponse' => [] }) }
     it_behaves_like 'composite requests'
   end
 
@@ -136,7 +136,7 @@ describe Restforce::Concerns::CompositeAPI do
     let(:method) { :composite! }
     let(:all_or_none) { true }
     let(:response) do
-      double('Faraday::Response', body: { 'CompositeResponse' => [] })
+      double('Faraday::Response', body: { 'compositeResponse' => [] })
     end
     it_behaves_like 'composite requests'
   end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 5.2.1
+  version: 5.2.4
 platform: ruby
 authors:
 - Tim Rogers
@@ -9,15 +9,15 @@ authors:
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-08 00:00:00.000000000 Z
+date: 2022-03-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "<="
+    - - "<"
       - !ruby/object:Gem::Version
-        version: '2.0'
+        version: 1.9.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: '2.0'
+        version: 1.9.0
     - - ">="
       - !ruby/object:Gem::Version
         version: 0.9.0
@@ -170,6 +170,7 @@ files:
 - 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
@@ -254,7 +255,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.2.22
+rubygems_version: 3.3.3
 signing_key:
 specification_version: 4
 summary: A lightweight Ruby client for the Salesforce REST API
@@ -273,6 +274,7 @@ test_files:
 - 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