salesforce_bulk_api 1.1.0 → 1.3.0

data/spec/salesforce_bulk_api/salesforce_bulk_api_spec.rb

@@ -1,193 +1,150 @@
-require 'spec_helper'
-require 'yaml'
-require 'restforce'
+require "spec_helper"
+require "yaml"
+require "restforce"
 
 describe SalesforceBulkApi do
-
-  before :each do
-    auth_hash = YAML.load_file('auth_credentials.yml')
-    sfdc_auth_hash = auth_hash['salesforce']
-
-    @sf_client = Restforce.new(
-      username: sfdc_auth_hash['user'],
-      password: sfdc_auth_hash['passwordandtoken'],
-      client_id: sfdc_auth_hash['client_id'],
-      client_secret: sfdc_auth_hash['client_secret'],
-      host: sfdc_auth_hash['host'])
-    @sf_client.authenticate!
-
-    @account_id = auth_hash['salesforce']['test_account_id']
-
-    @api = SalesforceBulkApi::Api.new(@sf_client)
-  end
-
-  after :each do
-
+  let(:sf_client) do
+    client = Restforce.new(
+      username: ENV["SALESFORCE_USERNAME"],
+      password: ENV["SALESFORCE_PASSWORD"],
+      client_id: ENV["SALESFORCE_CLIENT_ID"],
+      client_secret: ENV["SALESFORCE_CLIENT_SECRET"],
+      host: ENV["SALESFORCE_HOST"],
+      security_token: ENV["SALESFORCE_SECURITY_TOKEN"]
+    )
+    client.authenticate!
+    client
   end
 
-  describe 'upsert' do
+  let(:account_id) { ENV["SALESFORCE_TEST_ACCOUNT_ID"] }
+  let(:api) { SalesforceBulkApi::Api.new(sf_client) }
 
-    context 'when not passed get_result' do
+  describe "upsert" do
+    context "when not passed get_result" do
       it "doesn't return the batches array" do
-        res = @api.upsert('Account', [{:Id => @account_id, :Website => 'www.test.com'}], 'Id')
-        res['batches'].should be_nil
+        res = api.upsert("Account", [{Id: account_id, Website: "www.test.com"}], "Id")
+        expect(res["batches"]).to be_nil
       end
     end
 
-    context 'when passed get_result = true' do
-      it 'returns the batches array' do
-        res = @api.upsert('Account', [{:Id => @account_id, :Website => 'www.test.com'}], 'Id', true)
-        res['batches'][0]['response'].is_a? Array
-
-        res['batches'][0]['response'][0]['id'][0].should start_with(@account_id)
-        res['batches'][0]['response'][0]['success'].should eq ['true']
-        res['batches'][0]['response'][0]['created'].should eq ['false']
+    context "when passed get_result = true" do
+      it "returns the batches array" do
+        res = api.upsert("Account", [{Id: account_id, Website: "www.test.com"}], "Id", true)
+        expect(res["batches"][0]["response"]).to be_a Array
 
+        expect(res["batches"][0]["response"][0]["id"][0]).to start_with(account_id)
+        expect(res["batches"][0]["response"][0]["success"]).to eq ["true"]
+        expect(res["batches"][0]["response"][0]["created"]).to eq ["false"]
       end
     end
 
-    context 'when passed send_nulls = true' do
-      it 'sets the nil and empty attributes to NULL' do
-        @api.update('Account', [{:Id => @account_id, :Website => 'abc123', :Phone => '5678'}], true)
-        res = @api.query('Account', "SELECT Website, Phone From Account WHERE Id = '#{@account_id}'")
-        res['batches'][0]['response'][0]['Website'][0].should eq 'abc123'
-        res['batches'][0]['response'][0]['Phone'][0].should eq '5678'
-        res = @api.upsert('Account', [{:Id => @account_id, :Website => '', :Phone => nil}], 'Id', true, true)
-        res['batches'][0]['response'][0]['id'][0].should start_with(@account_id)
-        res['batches'][0]['response'][0]['success'].should eq ['true']
-        res['batches'][0]['response'][0]['created'].should eq ['false']
-        res = @api.query('Account', "SELECT Website, Phone From Account WHERE Id = '#{@account_id}'")
-        res['batches'][0]['response'][0]['Website'][0].should eq({"xsi:nil" => "true"})
-        res['batches'][0]['response'][0]['Phone'][0].should eq({"xsi:nil" => "true"})
+    context "when passed send_nulls = true" do
+      it "sets the nil and empty attributes to NULL" do
+        api.update("Account", [{Id: account_id, Website: "abc123", Phone: "5678"}], true)
+        res = api.query("Account", "SELECT Website, Phone From Account WHERE Id = '#{account_id}'")
+        expect(res["batches"][0]["response"][0]["Website"][0]).to eq "abc123"
+        expect(res["batches"][0]["response"][0]["Phone"][0]).to eq "5678"
+        res = api.upsert("Account", [{Id: account_id, Website: "", Phone: nil}], "Id", true, true)
+        expect(res["batches"][0]["response"][0]["id"][0]).to start_with(account_id)
+        expect(res["batches"][0]["response"][0]["success"]).to eq ["true"]
+        expect(res["batches"][0]["response"][0]["created"]).to eq ["false"]
+        res = api.query("Account", "SELECT Website, Phone From Account WHERE Id = '#{account_id}'")
+        expect(res["batches"][0]["response"][0]["Website"][0]).to eq({"xsi:nil" => "true"})
+        expect(res["batches"][0]["response"][0]["Phone"][0]).to eq({"xsi:nil" => "true"})
       end
     end
 
-    context 'when passed send_nulls = true and an array of fields not to null' do
-      it 'sets the nil and empty attributes to NULL, except for those included in the list of fields to ignore' do
-        @api.update('Account', [{:Id => @account_id, :Website => 'abc123', :Phone => '5678'}], true)
-        res = @api.query('Account', "SELECT Website, Phone From Account WHERE Id = '#{@account_id}'")
-        res['batches'][0]['response'][0]['Website'][0].should eq 'abc123'
-        res['batches'][0]['response'][0]['Phone'][0].should eq '5678'
-        res = @api.upsert('Account', [{:Id => @account_id, :Website => '', :Phone => nil}], 'Id', true, true, [:Website, :Phone])
-        res['batches'][0]['response'][0]['id'][0].should start_with(@account_id)
-        res['batches'][0]['response'][0]['success'].should eq ['true']
-        res['batches'][0]['response'][0]['created'].should eq ['false']
-        res = @api.query('Account', "SELECT Website, Phone From Account WHERE Id = '#{@account_id}'")
-        res['batches'][0]['response'][0]['Website'][0].should eq('abc123')
-        res['batches'][0]['response'][0]['Phone'][0].should eq('5678')
+    context "when passed send_nulls = true and an array of fields not to null" do
+      it "sets the nil and empty attributes to NULL, except for those included in the list of fields to ignore" do
+        api.update("Account", [{Id: account_id, Website: "abc123", Phone: "5678"}], true)
+        res = api.query("Account", "SELECT Website, Phone From Account WHERE Id = '#{account_id}'")
+        expect(res["batches"][0]["response"][0]["Website"][0]).to eq "abc123"
+        expect(res["batches"][0]["response"][0]["Phone"][0]).to eq "5678"
+        res = api.upsert("Account", [{Id: account_id, Website: "", Phone: nil}], "Id", true, true, [:Website, :Phone])
+        expect(res["batches"][0]["response"][0]["id"][0]).to start_with(account_id)
+        expect(res["batches"][0]["response"][0]["success"]).to eq ["true"]
+        expect(res["batches"][0]["response"][0]["created"]).to eq ["false"]
+        res = api.query("Account", "SELECT Website, Phone From Account WHERE Id = '#{account_id}'")
+        expect(res["batches"][0]["response"][0]["Website"][0]).to eq("abc123")
+        expect(res["batches"][0]["response"][0]["Phone"][0]).to eq("5678")
       end
     end
-
   end
 
-  describe 'update' do
-    context 'when there is not an error' do
-      context 'when not passed get_result' do
+  describe "update" do
+    context "when there is not an error" do
+      context "when not passed get_result" do
         it "doesnt return the batches array" do
-          res = @api.update('Account', [{:Id => @account_id, :Website => 'www.test.com'}])
-          res['batches'].should be_nil
+          res = api.update("Account", [{Id: account_id, Website: "www.test.com"}])
+          expect(res["batches"]).to be_nil
         end
       end
 
-      context 'when passed get_result = true' do
-        it 'returns the batches array' do
-          res = @api.update('Account', [{:Id => @account_id, :Website => 'www.test.com'}], true)
-          res['batches'][0]['response'].is_a? Array
-          res['batches'][0]['response'][0]['id'][0].should start_with(@account_id)
-          res['batches'][0]['response'][0]['success'].should eq ['true']
-          res['batches'][0]['response'][0]['created'].should eq ['false']
+      context "when passed get_result = true" do
+        it "returns the batches array" do
+          res = api.update("Account", [{Id: account_id, Website: "www.test.com"}], true)
+          expect(res["batches"][0]["response"]).to be_a Array
+          expect(res["batches"][0]["response"][0]["id"][0]).to start_with(account_id)
+          expect(res["batches"][0]["response"][0]["success"]).to eq ["true"]
+          expect(res["batches"][0]["response"][0]["created"]).to eq ["false"]
         end
       end
     end
 
-    context 'when there is an error' do
-      context 'when not passed get_result' do
+    context "when there is an error" do
+      context "when not passed get_result" do
         it "doesn't return the results array" do
-          res = @api.update('Account', [{:Id => @account_id, :Website => 'www.test.com'},{:Id => 'abc123', :Website => 'www.test.com'}])
-          res['batches'].should be_nil
+          res = api.update("Account", [{Id: account_id, Website: "www.test.com"}, {Id: "abc123", Website: "www.test.com"}])
+          expect(res["batches"]).to be_nil
         end
       end
 
-      context 'when passed get_result = true with batches' do
-        it 'returns the results array' do
-          res = @api.update('Account', [{:Id => @account_id, :Website => 'www.test.com'}, {:Id => @account_id, :Website => 'www.test.com'}, {:Id => @account_id, :Website => 'www.test.com'}, {:Id => 'abc123', :Website => 'www.test.com'}], true, false, [], 2)
-
-          res['batches'][0]['response'][0]['id'][0].should start_with(@account_id)
-          res['batches'][0]['response'][0]['success'].should eq ['true']
-          res['batches'][0]['response'][0]['created'].should eq ['false']
-          res['batches'][0]['response'][1]['id'][0].should start_with(@account_id)
-          res['batches'][0]['response'][1]['success'].should eq ['true']
-          res['batches'][0]['response'][1]['created'].should eq ['false']
-
-          res['batches'][1]['response'][0]['id'][0].should start_with(@account_id)
-          res['batches'][1]['response'][0]['success'].should eq ['true']
-          res['batches'][1]['response'][0]['created'].should eq ['false']
-          res['batches'][1]['response'][1].should eq({"errors"=>[{"fields"=>["Id"], "message"=>["Account ID: id value of incorrect type: abc123"], "statusCode"=>["MALFORMED_ID"]}], "success"=>["false"], "created"=>["false"]})
+      context "when passed get_result = true with batches" do
+        it "returns the results array" do
+          res = api.update("Account", [{Id: account_id, Website: "www.test.com"}, {Id: account_id, Website: "www.test.com"}, {Id: account_id, Website: "www.test.com"}, {Id: "abc123", Website: "www.test.com"}], true, false, [], 2)
+
+          expect(res["batches"][0]["response"][0]["id"][0]).to start_with(account_id)
+          expect(res["batches"][0]["response"][0]["success"]).to eq ["true"]
+          expect(res["batches"][0]["response"][0]["created"]).to eq ["false"]
+          expect(res["batches"][0]["response"][1]["id"][0]).to start_with(account_id)
+          expect(res["batches"][0]["response"][1]["success"]).to eq ["true"]
+          expect(res["batches"][0]["response"][1]["created"]).to eq ["false"]
+
+          expect(res["batches"][1]["response"][0]["id"][0]).to start_with(account_id)
+          expect(res["batches"][1]["response"][0]["success"]).to eq ["true"]
+          expect(res["batches"][1]["response"][0]["created"]).to eq ["false"]
+          expect(res["batches"][1]["response"][1]).to eq({"errors" => [{"fields" => ["Id"], "message" => ["Account ID: id value of incorrect type: abc123"], "statusCode" => ["MALFORMED_ID"]}], "success" => ["false"], "created" => ["false"]})
         end
       end
     end
-
-  end
-
-  describe 'create' do
-    pending
   end
 
-  describe 'delete' do
-    pending
-  end
-
-  describe 'query' do
-
-    context 'when there are results' do
-      it 'returns the query results' do
-        res = @api.query('Account', "SELECT id, Name From Account WHERE Name LIKE 'Test%'")
-        res['batches'][0]['response'].length.should > 1
-        res['batches'][0]['response'][0]['Id'].should_not be_nil
+  describe "query" do
+    context "when there are results" do
+      it "returns the query results" do
+        res = api.query("Account", "SELECT id, Name From Account WHERE Name LIKE 'Test%'")
+        expect(res["batches"][0]["response"].length).to be > 1
+        expect(res["batches"][0]["response"][0]["Id"]).not_to be_nil
       end
 
-      context 'and there are multiple batches' do
+      context "and there are multiple batches" do
         # need dev to create > 10k records in dev organization
-        it 'returns the query results in a merged hash'
-      end
-    end
-
-    context 'when there are no results' do
-      it 'returns nil' do
-        res = @api.query('Account', "SELECT id From Account WHERE Name = 'ABC'")
-        res['batches'][0]['response'].should eq nil
+        it "returns the query results in a merged hash"
       end
     end
 
-    context 'when there is an error' do
-      it 'returns nil' do
-        res = @api.query('Account', "SELECT id From Account WHERE Name = ''ABC'")
-        res['batches'][0]['response'].should eq nil
+    context "when there are no results" do
+      it "returns nil" do
+        res = api.query("Account", "SELECT id From Account WHERE Name = 'ABC'")
+        expect(res["batches"][0]["response"]).to be_nil
       end
     end
 
-  end
-
-  describe 'counters' do
-    context 'when read operations are called' do
-      it 'increments operation count and http GET count' do
-        @api.counters[:http_get].should eq 0
-        @api.counters[:query].should eq 0
-        @api.query('Account', "SELECT Website, Phone From Account WHERE Id = '#{@account_id}'")
-        @api.counters[:http_get].should eq 1
-        @api.counters[:query].should eq 1
-      end
-    end
-
-    context 'when update operations are called' do
-      it 'increments operation count and http POST count' do
-        @api.counters[:http_post].should eq 0
-        @api.counters[:update].should eq 0
-        @api.update('Account', [{:Id => @account_id, :Website => 'abc123', :Phone => '5678'}], true)
-        @api.counters[:http_post].should eq 1
-        @api.counters[:update].should eq 1
+    context "when there is an error" do
+      it "returns nil" do
+        res = api.query("Account", "SELECT id From Account WHERE Name = ''ABC'")
+        expect(res["batches"][0]["response"]).to be_nil
       end
     end
   end
-
 end

data/spec/spec_helper.rb

@@ -1,8 +1,11 @@
-require 'rubygems'
-require 'bundler/setup'
-require 'salesforce_bulk_api'
+require "rubygems"
+require "bundler/setup"
+require "salesforce_bulk_api"
+
+require "dotenv"
+Dotenv.load
 
 RSpec.configure do |c|
-  c.filter_run :focus => true
+  c.filter_run focus: true
   c.run_all_when_everything_filtered = true
 end

metadata

@@ -1,14 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_bulk_api
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.3.0
 platform: ruby
 authors:
 - Yatish Mehta
-autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-13 00:00:00.000000000 Z
+date: 1980-01-02 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -38,6 +37,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: csv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: logger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -58,14 +85,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 8.0.0
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: 8.0.0
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -94,15 +121,61 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rubocop
+  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'
+- !ruby/object:Gem::Dependency
+  name: rubocop-rake
+  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'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  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: Salesforce Bulk API with governor limits taken care of
 email:
-- hi@example.com
+- yatish27@users.noreply.github.com
 executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".env.sample"
+- ".github/workflows/ci.yml"
 - ".gitignore"
 - ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
 - Gemfile
 - LICENCE
 - README.md
@@ -119,7 +192,6 @@ files:
 homepage: https://github.com/yatishmehta27/salesforce_bulk_api
 licenses: []
 metadata: {}
-post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -134,10 +206,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.5.10
-signing_key:
+rubygems_version: 3.6.7
 specification_version: 4
 summary: It uses the bulk api of salesforce to communicate with Salesforce CRM
-test_files:
-- spec/salesforce_bulk_api/salesforce_bulk_api_spec.rb
-- spec/spec_helper.rb
+test_files: []