salesforce_bulk_api 1.1.0 → 1.3.0

data/lib/salesforce_bulk_api/job.rb

@@ -1,19 +1,19 @@
 module SalesforceBulkApi
-
   class Job
     attr_reader :job_id
 
     class SalesforceException < StandardError; end
 
+    XML_HEADER = '<?xml version="1.0" encoding="utf-8" ?>'.freeze
+
     def initialize(args)
-      @job_id         = args[:job_id]
-      @operation      = args[:operation]
-      @sobject        = args[:sobject]
+      @job_id = args[:job_id]
+      @operation = args[:operation]
+      @sobject = args[:sobject]
       @external_field = args[:external_field]
-      @records        = args[:records]
-      @connection     = args[:connection]
-      @batch_ids      = []
-      @XML_HEADER     = '<?xml version="1.0" encoding="utf-8" ?>'
+      @records = args[:records]
+      @connection = args[:connection]
+      @batch_ids = []
     end
 
     def create_job(batch_size, send_nulls, no_null_list)
@@ -21,35 +21,35 @@ module SalesforceBulkApi
       @send_nulls = send_nulls
       @no_null_list = no_null_list
 
-      xml = "#{@XML_HEADER}<jobInfo xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">"
-      xml += "<operation>#{@operation}</operation>"
-      xml += "<object>#{@sobject}</object>"
+      xml = "#{XML_HEADER}<jobInfo xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">"
+      xml << "<operation>#{@operation}</operation>"
+      xml << "<object>#{@sobject}</object>"
       # This only happens on upsert
       if !@external_field.nil?
-        xml += "<externalIdFieldName>#{@external_field}</externalIdFieldName>"
+        xml << "<externalIdFieldName>#{@external_field}</externalIdFieldName>"
       end
-      xml += "<contentType>XML</contentType>"
-      xml += "</jobInfo>"
+      xml << "<contentType>XML</contentType>"
+      xml << "</jobInfo>"
 
       path = "job"
-      headers = Hash['Content-Type' => 'application/xml; charset=utf-8']
+      headers = {"Content-Type" => "application/xml; charset=utf-8"}
 
       response = @connection.post_xml(nil, path, xml, headers)
       response_parsed = XmlSimple.xml_in(response)
 
       # response may contain an exception, so raise it
-      raise SalesforceException.new("#{response_parsed['exceptionMessage'][0]} (#{response_parsed['exceptionCode'][0]})") if response_parsed['exceptionCode']
+      raise SalesforceException.new("#{response_parsed["exceptionMessage"][0]} (#{response_parsed["exceptionCode"][0]})") if response_parsed["exceptionCode"]
 
-      @job_id = response_parsed['id'][0]
+      @job_id = response_parsed["id"][0]
     end
 
-    def close_job()
-      xml = "#{@XML_HEADER}<jobInfo xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">"
-      xml += "<state>Closed</state>"
-      xml += "</jobInfo>"
+    def close_job
+      xml = "#{XML_HEADER}<jobInfo xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">"
+      xml << "<state>Closed</state>"
+      xml << "</jobInfo>"
 
       path = "job/#{@job_id}"
-      headers = Hash['Content-Type' => 'application/xml; charset=utf-8']
+      headers = {"Content-Type" => "application/xml; charset=utf-8"}
 
       response = @connection.post_xml(nil, path, xml, headers)
       XmlSimple.xml_in(response)
@@ -57,17 +57,19 @@ module SalesforceBulkApi
 
     def add_query
       path = "job/#{@job_id}/batch/"
-      headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
+      headers = {"Content-Type" => "application/xml; charset=UTF-8"}
 
       response = @connection.post_xml(nil, path, @records, headers)
       response_parsed = XmlSimple.xml_in(response)
 
-      @batch_ids << response_parsed['id'][0]
+      @batch_ids << response_parsed["id"][0]
     end
 
     def add_batches
-      raise 'Records must be an array of hashes.' unless @records.is_a? Array
-      keys = @records.reduce({}) {|h, pairs| pairs.each {|k, v| (h[k] ||= []) << v}; h}.keys
+      raise ArgumentError, "Records must be an array of hashes." unless @records.is_a? Array
+      keys = @records.each_with_object({}) { |pairs, h|
+        pairs.each { |k, v| (h[k] ||= []) << v }
+      }.keys
 
       @records_dup = @records.clone
 
@@ -83,86 +85,86 @@ module SalesforceBulkApi
     end
 
     def add_batch(keys, batch)
-      xml = "#{@XML_HEADER}<sObjects xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">"
+      xml = "#{XML_HEADER}<sObjects xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\" xmlns:xsi=\"http://www.w3.org/2001/XMLSchema-instance\">"
       batch.each do |r|
-        xml += create_sobject(keys, r)
+        xml << create_sobject(keys, r)
       end
-      xml += '</sObjects>'
+      xml << "</sObjects>"
       path = "job/#{@job_id}/batch/"
-      headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
+      headers = {"Content-Type" => "application/xml; charset=UTF-8"}
       response = @connection.post_xml(nil, path, xml, headers)
       response_parsed = XmlSimple.xml_in(response)
-      response_parsed['id'][0] if response_parsed['id']
+      response_parsed["id"][0] if response_parsed["id"]
     end
 
     def build_sobject(data)
-      xml = '<sObject>'
+      xml = "<sObject>"
       data.keys.each do |k|
         if k.is_a?(Hash)
-          xml += build_sobject(k)
-        elsif k.to_s.include? '.'
-          relations = k.to_s.split('.')
+          xml << build_sobject(k)
+        elsif k.to_s.include? "."
+          relations = k.to_s.split(".")
           parent = relations[0]
-          child = relations[1..-1].join('.')
-          xml += "<#{parent}>#{build_sobject({ child => data[k] })}</#{parent}>"
+          child = relations[1..].join(".")
+          xml << "<#{parent}>#{build_sobject({child => data[k]})}</#{parent}>"
         elsif data[k] != :type
-          xml += "<#{k}>#{data[k]}</#{k}>"
+          xml << "<#{k}>#{data[k]}</#{k}>"
         end
       end
-      xml += '</sObject>'
+      xml << "</sObject>"
     end
 
     def build_relationship_sobject(key, value)
-      if key.to_s.include? '.'
-        relations = key.to_s.split('.')
+      if key.to_s.include? "."
+        relations = key.to_s.split(".")
         parent = relations[0]
-        child = relations[1..-1].join('.')
+        child = relations[1..].join(".")
         xml = "<#{parent}>"
-        xml += "<sObject>"
-        xml += build_relationship_sobject(child, value)
-        xml += "</sObject>"
-        xml += "</#{parent}>"
+        xml << "<sObject>"
+        xml << build_relationship_sobject(child, value)
+        xml << "</sObject>"
+        xml << "</#{parent}>"
       else
-        xml = "<#{key}>#{value}</#{key}>"
+        "<#{key}>#{value}</#{key}>"
       end
     end
 
     def create_sobject(keys, r)
-      sobject_xml = '<sObject>'
+      sobject_xml = "<sObject>"
       keys.each do |k|
         if r[k].is_a?(Hash)
-          sobject_xml += "<#{k}>"
-          sobject_xml += build_sobject(r[k])
-          sobject_xml += "</#{k}>"
-        elsif k.to_s.include? '.'
-          sobject_xml += build_relationship_sobject(k, r[k])
+          sobject_xml << "<#{k}>"
+          sobject_xml << build_sobject(r[k])
+          sobject_xml << "</#{k}>"
+        elsif k.to_s.include? "."
+          sobject_xml << build_relationship_sobject(k, r[k])
         elsif !r[k].to_s.empty?
-          sobject_xml += "<#{k}>"
-          if r[k].respond_to?(:encode)
-            sobject_xml += r[k].encode(:xml => :text)
+          sobject_xml << "<#{k}>"
+          sobject_xml << if r[k].respond_to?(:encode)
+            r[k].encode(xml: :text)
           elsif r[k].respond_to?(:iso8601) # timestamps
-            sobject_xml += r[k].iso8601.to_s
+            r[k].iso8601.to_s
           else
-            sobject_xml += r[k].to_s
+            r[k].to_s
           end
-          sobject_xml += "</#{k}>"
+          sobject_xml << "</#{k}>"
         elsif @send_nulls && !@no_null_list.include?(k) && r.key?(k)
-          sobject_xml += "<#{k} xsi:nil=\"true\"/>"
+          sobject_xml << "<#{k} xsi:nil=\"true\"/>"
         end
       end
-      sobject_xml += '</sObject>'
+      sobject_xml << "</sObject>"
       sobject_xml
     end
 
     def check_job_status
       path = "job/#{@job_id}"
-      headers = Hash.new
+      headers = {}
       response = @connection.get_request(nil, path, headers)
 
       begin
         response_parsed = XmlSimple.xml_in(response) if response
         response_parsed
-      rescue StandardError => e
+      rescue => e
         puts "Error parsing XML response for #{@job_id}"
         puts e
         puts e.backtrace
@@ -171,14 +173,14 @@ module SalesforceBulkApi
 
     def check_batch_status(batch_id)
       path = "job/#{@job_id}/batch/#{batch_id}"
-      headers = Hash.new
+      headers = {}
 
       response = @connection.get_request(nil, path, headers)
 
       begin
         response_parsed = XmlSimple.xml_in(response) if response
         response_parsed
-      rescue StandardError => e
+      rescue => e
         puts "Error parsing XML response for #{@job_id}, batch #{batch_id}"
         puts e
         puts e.backtrace
@@ -189,15 +191,15 @@ module SalesforceBulkApi
       # timeout is in seconds
       begin
         state = []
-        Timeout::timeout(timeout, SalesforceBulkApi::JobTimeout) do
-          while true
-            job_status = self.check_job_status
-            if job_status && job_status['state'] && job_status['state'][0] == 'Closed'
+        Timeout.timeout(timeout, SalesforceBulkApi::JobTimeout) do
+          loop do
+            job_status = check_job_status
+            if job_status && job_status["state"] && job_status["state"][0] == "Closed"
               batch_statuses = {}
 
               batches_ready = @batch_ids.all? do |batch_id|
-                batch_state = batch_statuses[batch_id] = self.check_batch_status(batch_id)
-                batch_state && batch_state['state'] && batch_state['state'][0] && !['Queued', 'InProgress'].include?(batch_state['state'][0])
+                batch_state = batch_statuses[batch_id] = check_batch_status(batch_id)
+                batch_state && batch_state["state"] && batch_state["state"][0] && !["Queued", "InProgress"].include?(batch_state["state"][0])
               end
 
               if batches_ready
@@ -213,14 +215,14 @@ module SalesforceBulkApi
           end
         end
       rescue SalesforceBulkApi::JobTimeout => e
-        puts 'Timeout waiting for Salesforce to process job batches #{@batch_ids} of job #{@job_id}.'
+        puts "Timeout waiting for Salesforce to process job batches #{@batch_ids} of job #{@job_id}."
         puts e
         raise
       end
 
       state.each_with_index do |batch_state, i|
-        if batch_state['state'][0] == 'Completed' && return_result == true
-          state[i].merge!({'response' => self.get_batch_result(batch_state['id'][0])})
+        if batch_state["state"][0] == "Completed" && return_result == true
+          state[i].merge!({"response" => get_batch_result(batch_state["id"][0])})
         end
       end
       state
@@ -228,35 +230,31 @@ module SalesforceBulkApi
 
     def get_batch_result(batch_id)
       path = "job/#{@job_id}/batch/#{batch_id}/result"
-      headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
+      headers = {"Content-Type" => "application/xml; charset=UTF-8"}
 
       response = @connection.get_request(nil, path, headers)
       response_parsed = XmlSimple.xml_in(response)
-      results = response_parsed['result'] unless @operation == 'query'
+      results = response_parsed["result"] unless @operation == "query"
 
-      if(@operation == 'query') # The query op requires us to do another request to get the results
+      if @operation == "query" # The query op requires us to do another request to get the results
         result_id = response_parsed["result"][0]
         path = "job/#{@job_id}/batch/#{batch_id}/result/#{result_id}"
-        headers = Hash.new
-        headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
+        headers = {"Content-Type" => "application/xml; charset=UTF-8"}
         response = @connection.get_request(nil, path, headers)
         response_parsed = XmlSimple.xml_in(response)
-        results = response_parsed['records']
+        results = response_parsed["records"]
       end
       results
     end
 
     def get_batch_records(batch_id)
       path = "job/#{@job_id}/batch/#{batch_id}/request"
-      headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
+      headers = {"Content-Type" => "application/xml; charset=UTF-8"}
 
       response = @connection.get_request(nil, path, headers)
       response_parsed = XmlSimple.xml_in(response)
-      results = response_parsed['sObject']
-
-      results
+      response_parsed["sObject"]
     end
-
   end
 
   class JobTimeout < StandardError

data/lib/salesforce_bulk_api/version.rb

@@ -1,3 +1,3 @@
 module SalesforceBulkApi
-  VERSION = '1.1.0'
+  VERSION = "1.3.0"
 end

data/lib/salesforce_bulk_api.rb

@@ -1,13 +1,13 @@
-require 'rubygems'
-require 'bundler'
-require 'net/https'
-require 'xmlsimple'
-require 'csv'
+require "rubygems"
+require "bundler"
+require "net/https"
+require "xmlsimple"
+require "csv"
 
-require 'salesforce_bulk_api/version'
-require 'salesforce_bulk_api/concerns/throttling'
-require 'salesforce_bulk_api/job'
-require 'salesforce_bulk_api/connection'
+require "salesforce_bulk_api/version"
+require "salesforce_bulk_api/concerns/throttling"
+require "salesforce_bulk_api/job"
+require "salesforce_bulk_api/connection"
 
 module SalesforceBulkApi
   class Api
@@ -15,27 +15,27 @@ module SalesforceBulkApi
 
     def initialize(client, salesforce_api_version = "46.0")
       @connection = SalesforceBulkApi::Connection.new(salesforce_api_version, client)
-      @listeners = { job_created: [] }
+      @listeners = {job_created: []}
     end
 
     def upsert(sobject, records, external_field, get_response = false, send_nulls = false, no_null_list = [], batch_size = 10000, timeout = 1500)
-      do_operation('upsert', sobject, records, external_field, get_response, timeout, batch_size, send_nulls, no_null_list)
+      do_operation("upsert", sobject, records, external_field, get_response, timeout, batch_size, send_nulls, no_null_list)
     end
 
     def update(sobject, records, get_response = false, send_nulls = false, no_null_list = [], batch_size = 10000, timeout = 1500)
-      do_operation('update', sobject, records, nil, get_response, timeout, batch_size, send_nulls, no_null_list)
+      do_operation("update", sobject, records, nil, get_response, timeout, batch_size, send_nulls, no_null_list)
     end
 
     def create(sobject, records, get_response = false, send_nulls = false, batch_size = 10000, timeout = 1500)
-      do_operation('insert', sobject, records, nil, get_response, timeout, batch_size, send_nulls)
+      do_operation("insert", sobject, records, nil, get_response, timeout, batch_size, send_nulls)
     end
 
     def delete(sobject, records, get_response = false, batch_size = 10000, timeout = 1500)
-      do_operation('delete', sobject, records, nil, get_response, timeout, batch_size)
+      do_operation("delete", sobject, records, nil, get_response, timeout, batch_size)
     end
 
     def query(sobject, query, batch_size = 10000, timeout = 1500)
-      do_operation('query', sobject, query, nil, true, timeout, batch_size)
+      do_operation("query", sobject, query, nil, true, timeout, batch_size)
     end
 
     def counters
@@ -50,8 +50,8 @@ module SalesforceBulkApi
       }
     end
 
-    # Allows you to attach a listener that accepts the created job (which has a useful #job_id field).  This is useful
-    # for recording a job ID persistently before you begin batch work (i.e. start modifying the salesforce database),
+    # Allows you to attach a listener that accepts the created job (which has a useful #job_id field).
+    # This is useful for recording a job ID persistently before you begin batch work (i.e. start modifying the salesforce database),
     # so if the load process you are writing needs to recover, it can be aware of previous jobs it started and wait
     # for them to finish.
     #
@@ -75,22 +75,21 @@ module SalesforceBulkApi
       )
 
       job.create_job(batch_size, send_nulls, no_null_list)
-      @listeners[:job_created].each {|callback| callback.call(job)}
-      operation == "query" ? job.add_query() : job.add_batches()
+      @listeners[:job_created].each { |callback| callback.call(job) }
+      (operation == "query") ? job.add_query : job.add_batches
       response = job.close_job
-      response.merge!({'batches' => job.get_job_result(get_response, timeout)}) if get_response == true
+      response["batches"] = job.get_job_result(get_response, timeout) if get_response == true
       response
     end
 
     private
 
     def get_counters
-      @counters ||= Hash.new(0)
+      @counters ||= Hash.new { |hash, key| hash[key] = 0 }
     end
 
     def count(name)
       get_counters[name] += 1
     end
-
   end
 end

data/salesforce_bulk_api.gemspec

@@ -1,28 +1,30 @@
-# -*- encoding: utf-8 -*-
 $:.push File.expand_path("../lib", __FILE__)
 require "salesforce_bulk_api/version"
 
 Gem::Specification.new do |s|
-  s.name        = 'salesforce_bulk_api'
-  s.version     = SalesforceBulkApi::VERSION
-  s.authors     = ['Yatish Mehta']
-  s.email       = ['hi@example.com']
+  s.name = "salesforce_bulk_api"
+  s.version = SalesforceBulkApi::VERSION
+  s.authors = ["Yatish Mehta"]
+  s.email = ["yatish27@users.noreply.github.com"]
 
-  s.homepage    = 'https://github.com/yatishmehta27/salesforce_bulk_api'
-  s.summary     = %q{It uses the bulk api of salesforce to communicate with Salesforce CRM}
-  s.description = %q{Salesforce Bulk API with governor limits taken care of}
+  s.homepage = "https://github.com/yatishmehta27/salesforce_bulk_api"
+  s.summary = "It uses the bulk api of salesforce to communicate with Salesforce CRM"
+  s.description = "Salesforce Bulk API with governor limits taken care of"
 
-  s.add_dependency('json', ['>= 0'])
-  s.add_dependency('xml-simple', ['>= 0'])
+  s.add_dependency("json", [">= 0"])
+  s.add_dependency("xml-simple", [">= 0"])
+  s.add_dependency("csv", [">= 0"])
+  s.add_dependency("logger", [">= 0"])
 
-  s.add_development_dependency 'rspec'
-  s.add_development_dependency 'restforce', '~>  3.0.0'
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "restforce", "~> 8.0.0"
   s.add_development_dependency "rake", ">= 12.3.3"
-  s.add_development_dependency 'pry'
-
-  s.files         = `git ls-files`.split("\n")
-  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
-  s.require_paths = ['lib']
+  s.add_development_dependency "pry"
+  s.add_development_dependency "rubocop"
+  s.add_development_dependency "rubocop-rake"
+  s.add_development_dependency "dotenv"
 
+  s.files = `git ls-files`.split("\n")
+  s.executables = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
+  s.require_paths = ["lib"]
 end