active_force 0.24.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0e6bf4ca3441ea8c1d0df00f6a8925f021fa53a3a0ce2e19beda69ecab4b5881
-  data.tar.gz: 940b3627880eb3a67d8387c744246a8bb29cc816ccf828130dd375e1e33b1791
+  metadata.gz: 657c5d9e979b06641cae8f6734a9a0371669dcc3fca816e89c0a23fca20537fb
+  data.tar.gz: c6e3646ea293a22d459faca15f8fbf9b16cbaf4482b7c38dc4e135dac22da6e7
 SHA512:
-  metadata.gz: b7ab1dc49814c642b34b61391a2d8ab99fc2b0854f3113b5c4d5715a67ec681d3061fa2e3e53eea3ec9780525aeba3804c7043901b7652baa67113d2659bd8dc
-  data.tar.gz: d69e76e37be28552a80a9a3e2872a48ff15e04df4178f5ce2b670426be23570a7ca11256e41ed757ba04fc20270bff875730d8aea2927eee7e0129124c5f994e
+  metadata.gz: b9a1fb7822ad1950f32fc86e20e9e00cf29a5f471b2792eda9fe8ae9aae1db6f2b1817ac8fcf6fc9b0ec74ee351e62befb0aab8a6e83a7a5ec09a3761e656f85
+  data.tar.gz: 7f1cb6448305cef1fd185cce72571f1eff55aa3115444edf215dd031711fe6027b51922832392eb02a1e60a82b9d77616bffe271aad638344686122bdeae91c6

data/.circleci/config.yml

@@ -1,4 +1,7 @@
-version: 2
+version: 2.1
+
+orbs:
+  codecov: codecov/codecov@4.0.1
 
 references:
   default_docker_ruby_executor: &default_docker_ruby_executor
@@ -51,49 +54,16 @@ jobs:
           key: active_force-{{ checksum "active_force.gemspec" }}
           paths:
             - ~/active_force/active_force_index/vendor/bundle
-      - run:
-          name: Install Code Climate Test Reporter
-          command: |
-            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-            chmod +x ./cc-test-reporter
       - run:
           name: Run RSpec
           command: |
             mkdir /tmp/test-results
-            ./cc-test-reporter before-build
             TESTFILES=$(circleci tests glob "spec/**/*_spec.rb" | circleci tests split --split-by=timings)
             bundle exec rspec $TESTFILES --profile 10 --format RspecJunitFormatter --out /tmp/test-results/rspec.xml --format progress
-      - run:
-          name: Code Climate Test Coverage
-          command: |
-            ./cc-test-reporter format-coverage -t simplecov -o "coverage/codeclimate.$CIRCLE_NODE_INDEX.json"
-      - persist_to_workspace:
-          root: coverage
-          paths:
-            - codeclimate.*.json
-      - store_test_results:
-          path: /tmp/test-results
-      - store_artifacts:
-          path: /tmp/test-results
-          destination: test-results
+      - codecov/upload
       - store_artifacts:
           path: coverage
-  upload-coverage:
-    working_directory: ~/active_force/active_force_index
-    docker:
-      - *default_docker_ruby_executor
-    steps:
-      - attach_workspace:
-          at: ~/active_force/active_force_index
-      - run:
-          name: Install Code Climate Test Reporter
-          command: |
-            curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-            chmod +x ./cc-test-reporter
-      - run:
-          name: Combine and Upload Coverage
-          command: |
-            ./cc-test-reporter sum-coverage --output - codeclimate.*.json | ./cc-test-reporter upload-coverage --debug --input -
+
 workflows:
   version: 2
   build_and_test:
@@ -102,6 +72,3 @@ workflows:
       - rspec-test:
           requires:
             - build
-      - upload-coverage:
-          requires:
-             - rspec-test

data/.travis.yml

@@ -9,8 +9,6 @@ matrix:
     - rvm:
       - rbx-2
   fast_finish: true
-env:
-  - CODECLIMATE_REPO_TOKEN=1c5ed259429e0bfc5412974d69cfba2780962a87ca8c543d684e33fea37f7e71
 notifications:
   webhooks:
     urls:

data/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 ## Not released
 
+## 0.26.0
+- Add ability to query using Composite Batch Api (https://github.com/Beyond-Finance/active_force/pull/114)
+
+## 0.25.0
+- Add support for Rails 8.x (https://github.com/Beyond-Finance/active_force/pull/108)
+
 ## 0.24.0
 - Add support for nested select statements that are used in conjuction with nested includes (https://github.com/Beyond-Finance/active_force/pull/102)
 

data/LICENSE.txt

@@ -1,3 +1,11 @@
+[Copyright © 2024 Beyond Finance, LLC.]
+
+This library is available as open source under the terms of the
+MIT License (https://opensource.org/license/mit). This library is
+based on the open source code library "https://github.com/heroku/active_force" which was in turn forked from
+"https://github.com/ionia-corporation/active_force" and licensed
+under the MIT License.
+
 Copyright (c) 2013 Eloy Espinaco
 
 MIT License

data/active_force.gemspec

@@ -25,12 +25,13 @@ Gem::Specification.new do |spec|
 
   spec.required_ruby_version = '>= 1.9.3'
 
-  spec.add_dependency 'activemodel', '~> 7.0'
-  spec.add_dependency 'activesupport', '~> 7.0'
+  spec.add_dependency 'activemodel', '>= 7.0'
+  spec.add_dependency 'activesupport', '>= 7.0'
   spec.add_dependency 'restforce',   '>= 5'
   spec.add_development_dependency 'rake', '>= 0'
   spec.add_development_dependency 'rspec', '>= 0'
   spec.add_development_dependency 'rspec_junit_formatter'
   spec.add_development_dependency 'pry', '>= 0'
-  spec.add_development_dependency 'simplecov', '>= 0'
+  spec.add_development_dependency 'simplecov'
+  spec.add_development_dependency 'simplecov-cobertura'
 end

data/lib/active_force/active_query.rb

@@ -1,6 +1,7 @@
 require 'active_support/all'
 require 'active_force/query'
 require 'active_force/select_builder'
+require 'active_force/composite_batch_query'
 require 'forwardable'
 
 module ActiveForce
@@ -245,7 +246,13 @@ module ActiveForce
     end
 
     def result
-      sfdc_client.query(self.to_s)
+      soql = self.to_s
+
+      if soql.length >= ActiveForce.composite_batch_query_threshold
+        CompositeBatchQuery.call(soql, sfdc_client)
+      else
+        sfdc_client.query(soql)
+      end
     end
 
     def build_order_by(args)

data/lib/active_force/composite_batch_query.rb

@@ -0,0 +1,42 @@
+require 'active_support/all'
+
+module ActiveForce
+  class CompositeBatchQuery
+    def self.call(soql, sfdc_client = ActiveForce.sfdc_client)
+      new(soql, sfdc_client).call
+    end
+
+    attr_reader :sfdc_client, :soql
+
+    def initialize(soql, sfdc_client)
+      @sfdc_client = sfdc_client
+      @soql = soql
+    end
+
+    def call
+      results = sfdc_client.batch do |subrequests|
+        subrequests.requests << {
+          method: "GET",
+          url: "v#{subrequests.options[:api_version]}/query?" + {q: soql}.to_query
+        }
+      end
+
+      r = results.first
+
+      process_composite_batch_error_response(r) if r.statusCode >= 300
+
+      r.result
+    end
+
+    private
+
+    def process_composite_batch_error_response(r)
+      response_value = {status: r.statusCode, body: r.result.as_json}
+      error_code = r.result.dig(0, "errorCode")
+      message = "#{error_code}: #{r.result.dig(0, "message")}"
+      message << "\nRESPONSE: #{r.result.to_json}"
+
+      raise Restforce::ErrorCode.get_exception_class(error_code).new(message, response_value)
+    end
+  end
+end

data/lib/active_force/sobject.rb

@@ -26,14 +26,15 @@ module ActiveForce
 
     define_model_callbacks :build, :create, :update, :save, :destroy
 
-    class_attribute :mappings, :table_name
+    class_attribute :mappings, :table_name_store
 
     attr_accessor :id, :title
 
     class << self
       extend Forwardable
       def_delegators :query, :not, :or, :where, :first, :last, :all, :find, :find!, :find_by, :find_by!, :sum, :count, :includes, :limit, :order, :select, :none
-      def_delegators :mapping, :table, :table_name, :custom_table?, :mappings
+      def_delegators :mapping, :table, :custom_table?, :mappings
+      alias_method :table_name=, :table_name_store=
 
       def update(id, attributes)
         prepare_for_update(id, attributes).update
@@ -43,6 +44,10 @@ module ActiveForce
         prepare_for_update(id, attributes).update!
       end
 
+      def table_name
+        table_name_store || mapping.table_name
+      end
+
       private
 
       def prepare_for_update(id, attributes)
@@ -65,6 +70,10 @@ module ActiveForce
       @mapping ||= ActiveForce::Mapping.new name
     end
 
+    def table_name
+      table_name_store || self.class.mapping.table_name
+    end
+
     def self.fields
       mapping.sfdc_names
     end

data/lib/active_force/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module ActiveForce
-  VERSION = '0.24.0'
+  VERSION = '0.26.0'
 end

data/lib/active_force.rb

@@ -9,8 +9,16 @@ module ActiveForce
 
   class << self
     attr_accessor :sfdc_client
+    attr_writer :composite_batch_query_threshold
+
+    def composite_batch_query_threshold
+      @composite_batch_query_threshold ||= 100_000
+
+      return @composite_batch_query_threshold.call if @composite_batch_query_threshold.respond_to?(:call)
+
+      @composite_batch_query_threshold
+    end
   end
 
   self.sfdc_client = Restforce.new
-
 end

data/spec/active_force/active_query_spec.rb

@@ -557,6 +557,26 @@ describe ActiveForce::ActiveQuery do
     end
   end
 
+  describe '#result routing' do
+    after do
+      ActiveForce.instance_variable_set(:@composite_batch_query_threshold, nil)
+    end
+
+    it 'uses sfdc_client.query when SOQL is at or below the threshold' do
+      ActiveForce.composite_batch_query_threshold = 100_000
+      expect(client).to receive(:query).and_return([])
+      expect(ActiveForce::CompositeBatchQuery).not_to receive(:call)
+      active_query.where("Id = 'foo'").to_a
+    end
+
+    it 'uses CompositeBatchQuery.call when SOQL exceeds the threshold' do
+      ActiveForce.composite_batch_query_threshold = 0
+      expect(ActiveForce::CompositeBatchQuery).to receive(:call).and_return([])
+      expect(client).not_to receive(:query)
+      active_query.where("Id = 'foo'").to_a
+    end
+  end
+
   describe "#order" do
     context 'when it is symbol' do 
       it "should add an order condition with actual SF field name" do

data/spec/active_force/composite_batch_query_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe ActiveForce::CompositeBatchQuery do
+  let(:soql) { "SELECT Id FROM Account WHERE Name = 'Test'" }
+  let(:api_version) { '58.0' }
+  let(:sfdc_client) { double(Restforce) }
+  let(:subrequests) do
+    double('subrequests', requests: [], options: { api_version: api_version })
+  end
+
+  describe '.call' do
+    it 'delegates to new(...).call' do
+      result_record = double('result_record')
+      instance = instance_double(described_class)
+      allow(described_class).to receive(:new).with(soql, sfdc_client).and_return(instance)
+      allow(instance).to receive(:call).and_return(result_record)
+
+      expect(described_class.call(soql, sfdc_client)).to eq(result_record)
+    end
+
+    it 'defaults to ActiveForce.sfdc_client when no client is provided' do
+      default_client = double(Restforce)
+      allow(ActiveForce).to receive(:sfdc_client).and_return(default_client)
+
+      instance = instance_double(described_class)
+      allow(described_class).to receive(:new).with(soql, default_client).and_return(instance)
+      allow(instance).to receive(:call).and_return(double('result'))
+
+      expect { described_class.call(soql) }.not_to raise_error
+      expect(described_class).to have_received(:new).with(soql, default_client)
+    end
+  end
+
+  describe '#call' do
+    context 'when the response is successful' do
+      let(:result_record) { double(Restforce::Collection) }
+      let(:batch_result) do
+        double(Restforce::Mash, statusCode: 200, result: result_record)
+      end
+
+      before do
+        allow(sfdc_client).to receive(:batch).and_yield(subrequests).and_return([batch_result])
+      end
+
+      it 'sends a GET batch subrequest with the correct URL' do
+        described_class.call(soql, sfdc_client)
+
+        expected_url = "v#{api_version}/query?" + { q: soql }.to_query
+        expect(subrequests.requests).to include(
+          hash_including(method: 'GET', url: expected_url)
+        )
+      end
+
+      it 'returns the result from the batch response' do
+        expect(described_class.call(soql, sfdc_client)).to eq(result_record)
+      end
+    end
+
+    context 'when the response statusCode is exactly 300' do
+      let(:error_body) do
+        [{ 'errorCode' => 'MULTIPLE_CHOICES', 'message' => 'multiple records found' }]
+      end
+      let(:batch_result) do
+        double('batch_result', statusCode: 300, result: error_body)
+      end
+
+      before do
+        allow(sfdc_client).to receive(:batch).and_yield(subrequests).and_return([batch_result])
+      end
+
+      it 'treats it as an error' do
+        expect {
+          described_class.call(soql, sfdc_client)
+        }.to raise_error(Restforce::ResponseError)
+      end
+    end
+
+    context 'when the response is an error' do
+      let(:error_body) do
+        [{ 'errorCode' => 'MALFORMED_QUERY', 'message' => 'unexpected token' }]
+      end
+      let(:batch_result) do
+        double(Restforce::Mash, statusCode: 400, result: error_body)
+      end
+
+      before do
+        allow(sfdc_client).to receive(:batch).and_yield(subrequests).and_return([batch_result])
+      end
+
+      it 'raises a Restforce error with the correct error code and message' do
+        expect {
+          described_class.call(soql, sfdc_client)
+        }.to raise_error(Restforce::ErrorCode::MalformedQuery) do |error|
+          expect(error.message).to include('MALFORMED_QUERY')
+          expect(error.message).to include('unexpected token')
+          expect(error.message).to include('RESPONSE:')
+        end
+      end
+    end
+  end
+end

data/spec/active_force/sobject_spec.rb

@@ -375,6 +375,20 @@ describe ActiveForce::SObject do
     end
   end
 
+  describe '.table_name' do
+
+    context 'when no explicit table name is set' do
+      it 'derives the table name from the class name' do
+        expect(Whizbang.table_name).to eq('Whizbang__c')
+      end
+    end
+    context 'when explicit table name is set' do
+      it 'returns the explicit table name' do
+        expect(Whizbang2.table_name).to eq('Whiz_bang2__c')
+      end
+    end
+  end
+
   describe '.sum' do
     let(:response) { [Restforce::Mash.new(expr0: 22)] }
 

data/spec/active_force_spec.rb

@@ -4,4 +4,24 @@ describe ActiveForce do
   it 'should have a version number' do
     expect(ActiveForce::VERSION).to_not be_nil
   end
+
+  describe '.composite_batch_query_threshold' do
+    after do
+      ActiveForce.instance_variable_set(:@composite_batch_query_threshold, nil)
+    end
+
+    it 'returns 100_000 by default' do
+      expect(ActiveForce.composite_batch_query_threshold).to eq(100_000)
+    end
+
+    it 'allows setting a custom integer value' do
+      ActiveForce.composite_batch_query_threshold = 25_000
+      expect(ActiveForce.composite_batch_query_threshold).to eq(25_000)
+    end
+
+    it 'supports callable values (proc/lambda)' do
+      ActiveForce.composite_batch_query_threshold = -> { 50_000 }
+      expect(ActiveForce.composite_batch_query_threshold).to eq(50_000)
+    end
+  end
 end

data/spec/spec_helper.rb

@@ -1,7 +1,10 @@
 require 'simplecov'
+require 'simplecov-cobertura'
 SimpleCov.start do
   add_filter '/vendor'
   add_filter '/spec'
+
+  formatter SimpleCov::Formatter::CoberturaFormatter
 end
 
 $LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)

data/spec/support/whizbang.rb

@@ -28,3 +28,7 @@ class Whizbang < ActiveForce::SObject
   end
 
 end
+
+class Whizbang2 < Whizbang
+  self.table_name = 'Whiz_bang2__c'
+end

metadata

@@ -1,44 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: active_force
 version: !ruby/object:Gem::Version
-  version: 0.24.0
+  version: 0.26.0
 platform: ruby
 authors:
 - Eloy Espinaco
 - Pablo Oldani
 - Armando Andini
 - José Piccioni
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-10-01 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activemodel
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
   name: activesupport
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '7.0'
 - !ruby/object:Gem::Dependency
@@ -125,6 +124,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: simplecov-cobertura
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Use SalesForce as an ActiveModel
 email: eloyesp@gmail.com
 executables: []
@@ -134,7 +147,6 @@ files:
 - ".circleci/config.yml"
 - ".github/ISSUE_TEMPLATE/bug_report.md"
 - ".github/ISSUE_TEMPLATE/feature_request.md"
-- ".github/workflows"
 - ".gitignore"
 - ".mailmap"
 - ".rspec"
@@ -160,6 +172,7 @@ files:
 - lib/active_force/bulk/job.rb
 - lib/active_force/bulk/job_result.rb
 - lib/active_force/bulk/records.rb
+- lib/active_force/composite_batch_query.rb
 - lib/active_force/field.rb
 - lib/active_force/mapping.rb
 - lib/active_force/query.rb
@@ -182,6 +195,7 @@ files:
 - spec/active_force/bulk/record_spec.rb
 - spec/active_force/bulk_spec.rb
 - spec/active_force/callbacks_spec.rb
+- spec/active_force/composite_batch_query_spec.rb
 - spec/active_force/field_spec.rb
 - spec/active_force/mapping_spec.rb
 - spec/active_force/query_spec.rb
@@ -205,7 +219,6 @@ metadata:
   bug_tracker_uri: https://github.com/Beyond-Finance/active_force/issues
   changelog_uri: https://github.com/Beyond-Finance/active_force/blob/main/CHANGELOG.md
   source_code_uri: https://github.com/Beyond-Finance/active_force
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -220,8 +233,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.4.10
-signing_key:
+rubygems_version: 3.6.9
 specification_version: 4
 summary: Help you implement models persisting on Sales Force within Rails using RESTForce
 test_files:
@@ -233,6 +245,7 @@ test_files:
 - spec/active_force/bulk/record_spec.rb
 - spec/active_force/bulk_spec.rb
 - spec/active_force/callbacks_spec.rb
+- spec/active_force/composite_batch_query_spec.rb
 - spec/active_force/field_spec.rb
 - spec/active_force/mapping_spec.rb
 - spec/active_force/query_spec.rb

data/.github/workflows

@@ -1,51 +0,0 @@
-on:
-  pull_request:
-    types: [opened, reopened, synchronize]
-  pull_request_review_comment:
-    types: [created, edited, deleted]
-
-name: Metomic Scan
-
-jobs:
-  scan-secrets:
-    name: Scan For Secrets
-    runs-on: ubuntu-latest
-    steps:
-      - name: checkout-repo
-        uses: actions/checkout@v3
-        with:
-          ref: ${{ github.event.pull_request.head.sha }}
-
-      - name: authenticate-with-metomic
-        id: authenticate
-        continue-on-error: ${{ vars.METOMIC_FAIL_ON_CONNECTION_ERROR != 'TRUE' }}
-        run: |
-          curl -s --location --request GET '${{ vars.METOMIC_INTEGRATION_ENDPOINT }}/token' --header 'X-API-Key: ${{ secrets.METOMIC_API_TOKEN }}' -o .metomic_token.json
-          echo METOMIC_ACCESS_TOKEN=$(cat .metomic_token.json | jq -r -c '.accessToken') >> $GITHUB_OUTPUT
-          PASS=$(cat .metomic_token.json | jq -r -c '.accessToken // empty')
-          if [ -z "$PASS" ]; then
-            cat .metomic_token.json
-            echo ""
-            echo "FAIL: failed to fetch auth token from Metomic. Ensure required organisation variables / secrets are set correctly. METOMIC_INTEGRATION_ENDPOINT, METOMIC_API_TOKEN"
-            echo "The correct values for these variables are available from the installations page of the Metomic dashboard"
-            exit 1
-          fi
-
-      - name: checkout-metomic-action
-        id: checkout
-        uses: actions/checkout@v3
-        if: ${{ steps.authenticate.outcome == 'success' }}
-        continue-on-error: ${{ vars.METOMIC_FAIL_ON_CONNECTION_ERROR != 'TRUE' }}
-        with:
-          repository: metomic/metomic-github-integration-action.git
-          path: "./.metomic"
-          ref: "main"
-          token: ${{ steps.authenticate.outputs.METOMIC_ACCESS_TOKEN }}
-
-      - name: scan
-        uses: ./.metomic/.github/actions/scan-secrets
-        if: ${{ steps.authenticate.outputs.METOMIC_ACCESS_TOKEN && steps.checkout.outcome == 'success' }}
-        with:
-          metomic_endpoint: ${{ vars.METOMIC_INTEGRATION_ENDPOINT }}
-          metomic_api_token: ${{ secrets.METOMIC_API_TOKEN }}
-          head_ref: ${{ github.event.pull_request.head.sha }}