openstax_active_force 1.0.0

data/spec/active_force/sobject/includes_spec.rb

@@ -0,0 +1,290 @@
+require 'spec_helper'
+
+module ActiveForce
+  describe SObject do
+    let(:client){ double "client" }
+
+    before do
+      ActiveForce.sfdc_client = client
+    end
+
+    describe '.includes' do
+      context 'belongs_to' do
+        it 'queries the API for the associated record' do
+          soql = Territory.includes(:quota).where(id: '123').to_s
+          expect(soql).to eq "SELECT Id, Quota__c, Name, Quota__r.Bar_Id__c FROM Territory WHERE (Id = '123')"
+        end
+
+        it "queries the API once to retrieve the object and its related one" do
+          response = [build_restforce_sobject({
+            "Id"       => "123",
+            "Quota__c" => "321",
+            "Quota__r" => {
+              "Bar_Id__c" => "321"
+            }
+          })]
+          allow(client).to receive(:query).once.and_return response
+          territory = Territory.includes(:quota).find "123"
+          expect(territory.quota).to be_a Quota
+          expect(territory.quota.id).to eq "321"
+        end
+
+        it "queries the API once to retrieve the object and its related one" do
+          response = [build_restforce_sobject({
+            "Id"       => "123",
+            "Quota__c" => "321",
+            "Quota__r" => {
+              "Bar_Id__c" => "321"
+            }
+          })]
+          allow(client).to receive(:query).once.and_return response
+          territory = Territory.includes(:quota).find "123"
+          expect(territory.quota).to be_a Quota
+          expect(territory.quota.id).to eq "321"
+        end
+
+        context 'with namespaced SObjects' do
+          it 'queries the API for the associated record' do
+            soql = Salesforce::Territory.includes(:quota).where(id: '123').to_s
+            expect(soql).to eq "SELECT Id, QuotaId, WidgetId, Quota__r.Id FROM Territory WHERE (Id = '123')"
+          end
+
+          it "queries the API once to retrieve the object and its related one" do
+            response = [build_restforce_sobject({
+              "Id"       => "123",
+              "QuotaId"  => "321",
+              "WidgetId" => "321",
+              "Quota__r" => {
+                "Id" => "321"
+              }
+            })]
+            allow(client).to receive(:query).once.and_return response
+            territory = Salesforce::Territory.includes(:quota).find "123"
+            expect(territory.quota).to be_a Salesforce::Quota
+            expect(territory.quota.id).to eq "321"
+          end
+
+          context 'when the relationship table name is different from the actual table name' do
+            it 'formulates the correct SOQL' do
+              soql = Salesforce::Opportunity.includes(:owner).where(id: '123').to_s
+              expect(soql).to eq "SELECT Id, OwnerId, AccountId, Business_Partner__c, Owner.Id FROM Opportunity WHERE (Id = '123')"
+            end
+
+            it "queries the API once to retrieve the object and its related one" do
+              response = [build_restforce_sobject({
+                "Id"       => "123",
+                "OwnerId"  => "321",
+                "AccountId"  => "432",
+                "Owner" => {
+                  "Id" => "321"
+                }
+              })]
+              allow(client).to receive(:query).once.and_return response
+              opportunity = Salesforce::Opportunity.includes(:owner).find "123"
+              expect(opportunity.owner).to be_a Salesforce::User
+              expect(opportunity.owner.id).to eq "321"
+            end
+          end
+
+          context 'when the class name does not match the SFDC entity name' do
+            let(:expected_soql) do
+              "SELECT Id, QuotaId, WidgetId, Tegdiw__r.Id FROM Territory WHERE (Id = '123')"
+            end
+
+            it 'queries the API for the associated record' do
+              soql = Salesforce::Territory.includes(:widget).where(id: '123').to_s
+              expect(soql).to eq expected_soql
+            end
+
+            it "queries the API once to retrieve the object and its related one" do
+              response = [build_restforce_sobject({
+                "Id"        => "123",
+                "WidgetId"  => "321",
+                "Tegdiw__r" => {
+                  "Id" => "321"
+                }
+              })]
+              expected = expected_soql + ' LIMIT 1'
+              allow(client).to receive(:query).once.with(expected).and_return response
+              territory = Salesforce::Territory.includes(:widget).find "123"
+              expect(territory.widget).to be_a Salesforce::Widget
+              expect(territory.widget.id).to eq "321"
+            end
+          end
+
+          context 'child to several parents' do
+            it 'queries the API for associated records' do
+              soql = Salesforce::Territory.includes(:quota, :widget).where(id: '123').to_s
+              expect(soql).to eq "SELECT Id, QuotaId, WidgetId, Quota__r.Id, Tegdiw__r.Id FROM Territory WHERE (Id = '123')"
+            end
+
+            it "queries the API once to retrieve the object and its assocations" do
+              response = [build_restforce_sobject({
+                "Id"       => "123",
+                "QuotaId"  => "321",
+                "WidgetId" => "321",
+                "Quota__r" => {
+                  "Id" => "321"
+                },
+                "Tegdiw__r" => {
+                  "Id" => "321"
+                }
+              })]
+              allow(client).to receive(:query).once.and_return response
+              territory = Salesforce::Territory.includes(:quota, :widget).find "123"
+              expect(territory.quota).to be_a Salesforce::Quota
+              expect(territory.quota.id).to eq "321"
+              expect(territory.widget).to be_a Salesforce::Widget
+              expect(territory.widget.id).to eq "321"
+            end
+          end
+        end
+
+        context 'when there is no associated record' do
+          it "queries the API once to retrieve the object and its related one" do
+            response = [build_restforce_sobject({
+              "Id"       => "123",
+              "Quota__c" => "321",
+              "Quota__r" => nil
+            })]
+            allow(client).to receive(:query).once.and_return response
+            territory = Territory.includes(:quota).find "123"
+            expect(territory.quota).to be_nil
+            expect(territory.quota).to be_nil
+          end
+        end
+      end
+
+      context 'has_many' do
+        context 'with standard objects' do
+          it 'formulates the correct SOQL query' do
+            soql = Account.includes(:opportunities).where(id: '123').to_s
+            expect(soql).to eq "SELECT Id, OwnerId, (SELECT Id, AccountId FROM Opportunities) FROM Account WHERE (Id = '123')"
+          end
+
+          it 'builds the associated objects and caches them' do
+            response = [build_restforce_sobject({
+              'Id' => '123',
+              'Opportunities' => build_restforce_collection([
+                {'Id' => '213', 'AccountId' => '123'},
+                {'Id' => '214', 'AccountId' => '123'}
+              ])
+            })]
+            allow(client).to receive(:query).once.and_return response
+            account = Account.includes(:opportunities).find '123'
+            expect(account.opportunities).to be_an Array
+            expect(account.opportunities.all? { |o| o.is_a? Opportunity }).to eq true
+          end
+        end
+
+        context 'with custom objects' do
+          it 'formulates the correct SOQL query' do
+            soql = Quota.includes(:prez_clubs).where(id: '123').to_s
+            expect(soql).to eq "SELECT Id, Bar_Id__c, (SELECT Id, QuotaId FROM PrezClubs__r) FROM Quota__c WHERE (Bar_Id__c = '123')"
+          end
+
+          it 'builds the associated objects and caches them' do
+            response = [build_restforce_sobject({
+              'Id' => '123',
+              'PrezClubs__r' => build_restforce_collection([
+                {'Id' => '213', 'QuotaId' => '123'},
+                {'Id' => '214', 'QuotaId' => '123'}
+              ])
+            })]
+            allow(client).to receive(:query).once.and_return response
+            account = Quota.includes(:prez_clubs).find '123'
+            expect(account.prez_clubs).to be_an Array
+            expect(account.prez_clubs.all? { |o| o.is_a? PrezClub }).to eq true
+          end
+        end
+
+        context 'mixing standard and custom objects' do
+          it 'formulates the correct SOQL query' do
+            soql = Quota.includes(:territories, :prez_clubs).where(id: '123').to_s
+            expect(soql).to eq "SELECT Id, Bar_Id__c, (SELECT Id, Quota__c, Name FROM Territories), (SELECT Id, QuotaId FROM PrezClubs__r) FROM Quota__c WHERE (Bar_Id__c = '123')"
+          end
+
+          it 'builds the associated objects and caches them' do
+            response = [build_restforce_sobject({
+              'Id' => '123',
+              'PrezClubs__r' => build_restforce_collection([
+                {'Id' => '213', 'QuotaId' => '123'},
+                {'Id' => '214', 'QuotaId' => '123'}
+              ]),
+              'Territories' => build_restforce_collection([
+                {'Id' => '213', 'Quota__c' => '123'},
+                {'Id' => '214', 'Quota__c' => '123'}
+              ])
+            })]
+            allow(client).to receive(:query).once.and_return response
+            account = Quota.includes(:territories, :prez_clubs).find '123'
+            expect(account.prez_clubs).to be_an Array
+            expect(account.prez_clubs.all? { |o| o.is_a? PrezClub }).to eq true
+            expect(account.territories).to be_an Array
+            expect(account.territories.all? { |o| o.is_a? Territory }).to eq true
+          end
+        end
+
+        context 'with namespaced SObjects' do
+          it 'formulates the correct SOQL query' do
+            soql = Salesforce::Quota.includes(:prez_clubs).where(id: '123').to_s
+            expect(soql).to eq "SELECT Id, (SELECT Id, QuotaId FROM PrezClubs__r) FROM Quota__c WHERE (Id = '123')"
+          end
+
+          it 'builds the associated objects and caches them' do
+            response = [build_restforce_sobject({
+              'Id' => '123',
+              'PrezClubs__r' => build_restforce_collection([
+                {'Id' => '213', 'QuotaId' => '123'},
+                {'Id' => '214', 'QuotaId' => '123'}
+              ])
+            })]
+            allow(client).to receive(:query).once.and_return response
+            account = Salesforce::Quota.includes(:prez_clubs).find '123'
+            expect(account.prez_clubs).to be_an Array
+            expect(account.prez_clubs.all? { |o| o.is_a? Salesforce::PrezClub }).to eq true
+          end
+        end
+
+        context 'when there are no associated records returned by the query' do
+          it 'caches the response' do
+            response = [build_restforce_sobject({
+              'Id' => '123',
+              'Opportunities' => nil
+            })]
+            allow(client).to receive(:query).once.and_return response
+            account = Account.includes(:opportunities).find '123'
+            expect(account.opportunities).to eq []
+            expect(account.opportunities).to eq []
+          end
+        end
+      end
+
+      describe 'mixing belongs_to and has_many' do
+        it 'formulates the correct SOQL query' do
+          soql = Account.includes(:opportunities, :owner).where(id: '123').to_s
+          expect(soql).to eq "SELECT Id, OwnerId, (SELECT Id, AccountId FROM Opportunities), Owner__r.Id FROM Account WHERE (Id = '123')"
+        end
+
+        it 'builds the associated objects and caches them' do
+          response = [build_restforce_sobject({
+            'Id' => '123',
+            'Opportunities' => build_restforce_collection([
+              {'Id' => '213', 'AccountId' => '123'},
+              {'Id' => '214', 'AccountId' => '123'}
+            ]),
+            'Owner__r' => {
+              'Id' => '321'
+            }
+          })]
+          allow(client).to receive(:query).once.and_return response
+          account = Account.includes(:opportunities).find '123'
+          expect(account.opportunities).to be_an Array
+          expect(account.opportunities.all? { |o| o.is_a? Opportunity }).to eq true
+          expect(account.owner).to be_a Owner
+          expect(account.owner.id).to eq '321'
+        end
+      end
+    end
+  end
+end

data/spec/active_force/sobject/table_name_spec.rb

@@ -0,0 +1,27 @@
+require 'spec_helper'
+
+describe ActiveForce::SObject do
+  describe '#table_name' do
+    it 'Use the class name adding "__c"' do
+      expect(Custom.table_name).to eq('Custom__c')
+    end
+
+    it 'with standard SObject types it does not add the "__c"' do
+      expect(Account.table_name).to eq('Account')
+    end
+
+    it 'can be enforced in the class definition' do
+      expect(EnforcedTableName.table_name).to eq('Forced__c')
+    end
+
+    context 'with a namespace' do
+      it "the namespace is not included" do
+        expect(Foo::Bar.table_name).to eq('Bar__c')
+      end
+
+      it 'standard types are inferred correctly' do
+        expect(Foo::Account.table_name).to eq('Account')
+      end
+    end
+  end
+end