salesforcebulk 1.4.0 → 2.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b6f6595658ab7d407acd1f74cb96b8b40ae9a303
-  data.tar.gz: d9750c85f6cad1d42a6c81f108d6de8fb1558748
+  metadata.gz: 7b79868012c05ed38e161bcb12bb95eb0382e5b3
+  data.tar.gz: c3a7e13b192b7b2ceafe17a2214935428d9ff3a9
 SHA512:
-  metadata.gz: abe409976e507aa19ff46d3519088e84656f039aa1521def05daa495f114fe4c04bf4835f47baabcc69bf12da52ee3198cd1a950a0fd30eb472bea336acf2dab
-  data.tar.gz: 87ec0fa2cd572bdf23f624099bfa6ea43c512835672bff6e2aead8be09f4d05a7dce574fcbfaa9cc2285d99c18aaa2a39ff8469eb2726be02aad74636607993e
+  metadata.gz: 0c14b55e95b378444129d266c48fafa0421f033f46250105504a0ac8f5b150e73b6873eedffc566d3abca5b1782e1cd469ac320165a0fb6ff7c28b53473bfa0a
+  data.tar.gz: 8ec9210c38ab0ccb04fa341c85ba88cfd8ffe01631babfcf6ef30fed96a06e82634b3ac27bfbc981bc771f6c24b61d3cccf2dc562de3540d21a7b0b742a70ad2

data/README.md

@@ -2,7 +2,7 @@
 
 ## Overview
 
-SalesforceBulk is an easy to use Ruby gem for connecting to and using the [Salesforce Bulk API](http://www.salesforce.com/us/developer/docs/api_asynch/index.htm). This is a rewrite and separate release of Jorge Valdivia's salesforce_bulk gem (renamed `salesforcebulk`) with full unit tests and full API capability (e.g. adding multiple batches per job). This gem was built on Ruby 1.8.7, 1.9.2, and 1.9.3.
+SalesforceBulk is an easy to use Ruby gem for connecting to and using the [Salesforce Bulk API](http://www.salesforce.com/us/developer/docs/api_asynch/index.htm). This is a rewrite and separate release of Jorge Valdivia's salesforce_bulk gem (renamed `salesforcebulk`) with full unit tests and full API capability (e.g. adding multiple batches per job). This gem was built on Ruby 2.0.0, 2.1.6, and 2.2.2.
 
 ## Installation
 
@@ -21,6 +21,14 @@ To contribute, fork this repo, create a topic branch, make changes, then send a
     bundle install
     rake
 
+To run the test suite on all gemfiles with your current ruby version, use:
+
+    bundle exec rake wwtd:local
+
+To run the full test suite with different gemfiles and ruby versions, use:
+
+    bundle exec rake wwtd
+
 ## Configuration and Initialization
 
 ### Basic Configuration
@@ -28,7 +36,7 @@ To contribute, fork this repo, create a topic branch, make changes, then send a
 When retrieving a password you will also be given a security token. Combine the two into a single value as the API treats this as your real password.
 
     require 'salesforce_bulk'
-    
+
     client = SalesforceBulk::Client.new(username: 'MyUsername', password: 'MyPasswordWithSecurtyToken')
     client.authenticate
 
@@ -47,7 +55,7 @@ Create a YAML file with the content below. Only `username` and `password` is req
 Then in a Ruby script:
 
     require 'salesforce_bulk'
-    
+
     client = SalesforceBulk::Client.new("config/salesforce_bulk.yml")
     client.authenticate
 
@@ -59,13 +67,13 @@ An important note about the data in any of the examples below: each hash in a da
 
     data1 = [{:Name__c => 'Test 1'}, {:Name__c => 'Test 2'}]
     data2 = [{:Name__c => 'Test 3'}, {:Name__c => 'Test 4'}]
-    
+
     job = client.add_job(:insert, :MyObject__c)
-    
+
     # easily add multiple batches to a job
     batch = client.add_batch(job.id, data1)
     batch = client.add_batch(job.id, data2)
-    
+
     job = client.close_job(job.id) # or use the abort_job(id) method
 
 ### Adding a Job
@@ -90,7 +98,7 @@ For any operation you should be able to specify a concurrency mode. The default
 The Job object has various properties such as status, created time, number of completed and failed batches and various other values.
 
     job = client.job_info(jobId) # returns a Job object
-    
+
     puts "Job #{job.id} is closed." if job.closed? # other: open?, aborted?
 
 ### Retrieving Info for a single Batch
@@ -98,13 +106,13 @@ The Job object has various properties such as status, created time, number of co
 The Batch object has various properties such as status, created time, number of processed and failed records and various other values.
 
     batch = client.batch_info(jobId, batchId) # returns a Batch object
-    
+
     puts "Batch #{batch.id} is in progress." if batch.in_progress?
 
 ### Retrieving Info for all Batches
 
     batches = client.batch_info_list(jobId) # returns an Array of Batch objects
-    
+
     batches.each do |batch|
       puts "Batch #{batch.id} completed." if batch.completed? # other: failed?, in_progress?, queued?
     end
@@ -116,7 +124,7 @@ To verify that a batch completed successfully or failed call the `batch_info` or
 The object returned from the following example only applies to the operations: `delete`, `insert`, `update` and `upsert`. Query results are handled differently.
 
     results = client.batch_result(jobId, batchId) # returns an Array of BatchResult objects
-    
+
     results.each do |result|
       puts "Item #{result.id} had an error of: #{result.error}" if result.error?
     end
@@ -129,18 +137,18 @@ Query results are handled differently as its possible that a single batch could
 
     # returns a QueryResultCollection object (an Array)
     results = client.batch_result(jobId, batchId)
-    
+
     while results.any?
-      
+
       # Assuming query was: SELECT Id, Name, CustomField__c FROM Account
       results.each do |result|
         puts result[:Id], result[:Name], result[:CustomField__c]
       end
-      
+
       puts "Another set is available." if results.next?
-      
+
       results.next
-      
+
     end
 
 Note: By reviewing the API docs and response format my understanding was that the API would return multiple results sets for a single batch if the query was to large but this does not seem to be the case in my live testing. It seems to be capped at 10000 records (as it when inserting data) but I haven't been able to verify through the documentation. If you know anything about that your input is appreciated. In the meantime the gem was built to support multiple result sets for a query batch but seems that will change which will simplify that method.
@@ -153,6 +161,16 @@ Note: By reviewing the API docs and response format my understanding was that th
 
 ## Version History
 
+**2.0.0** (April 25, 2015)
+
+* Dropped support for Ruby 1.8 and Ruby 1.9
+* Added support for Ruby 2.0, 2.1 and 2.2
+* Added support for Rails 4.0, 4.1 an 4.2
+* Changed test_helper to avoid requiring test_unit (removed in Ruby 2.2)
+* Replaced Test::Unit::TestCase with ActiveSupport::TestCase
+* Bumped shoulda and losen dependencies on minitest
+* All changes in PR's #13, #14, #15, #16 - thanks [@pschambacher](https://github.com/pschambacher)
+
 **1.4.0** (June 1, 2014)
 
 * Added state_message to Batch class (#11 - thanks [@bethesque](https://github.com/bethesque))

data/lib/salesforce_bulk.rb

@@ -1,10 +1,6 @@
 require 'net/https'
 require 'xmlsimple'
-if RUBY_VERSION < '1.9'
-	require 'fastercsv'
-else
-	require 'csv'
-end
+require 'csv'
 require 'active_support'
 require 'active_support/core_ext/object/blank'
 require 'active_support/core_ext/hash/keys'

data/lib/salesforce_bulk/client.rb

@@ -1,45 +1,42 @@
 module SalesforceBulk
-  if RUBY_VERSION < "1.9"
-    CSV = ::FasterCSV
-  end
 
   # Interface for operating the Salesforce Bulk REST API
   class Client
     # The host to use for authentication. Defaults to login.salesforce.com.
     attr_accessor :login_host
-    
+
     # The instance host to use for API calls. Determined from login response.
     attr_accessor :instance_host
-    
+
     # The Salesforce password
     attr_accessor :password
-    
+
     # The Salesforce username
     attr_accessor :username
-    
+
     # The API version the client is using. Defaults to 24.0.
     attr_accessor :version
-    
+
     def initialize(options={})
       if options.is_a?(String)
         options = YAML.load_file(options)
         options.symbolize_keys!
       end
-      
+
       options = {:login_host => 'login.salesforce.com', :version => 24.0}.merge(options)
-      
+
       options.assert_valid_keys(:username, :password, :login_host, :version)
-      
+
       self.username = options[:username]
       self.password = "#{options[:password]}"
       self.login_host = options[:login_host]
       self.version = options[:version]
-      
+
       @api_path_prefix = "/services/async/#{version}/"
       @valid_operations = [:delete, :insert, :update, :upsert, :query]
       @valid_concurrency_modes = ['Parallel', 'Serial']
     end
-    
+
     def authenticate
       xml = '<?xml version="1.0" encoding="utf-8"?>'
       xml += '<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"'
@@ -52,63 +49,63 @@ module SalesforceBulk
       xml += "</n1:login>"
       xml += "</env:Body>"
       xml += "</env:Envelope>\n"
-      
+
       response = http_post("/services/Soap/u/#{version}", xml, 'Content-Type' => 'text/xml', 'SOAPAction' => 'login')
-      
+
       data = XmlSimple.xml_in(response.body, 'ForceArray' => false)
       result = data['Body']['loginResponse']['result']
-      
+
       @session_id = result['sessionId']
-      
+
       self.instance_host = "#{instance_id(result['serverUrl'])}.salesforce.com"
       self
     end
-    
+
     def abort_job(jobId)
       xml = '<?xml version="1.0" encoding="utf-8"?>'
       xml += '<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">'
       xml += "<state>Aborted</state>"
       xml += "</jobInfo>"
-      
+
       response = http_post("job/#{jobId}", xml)
       data = XmlSimple.xml_in(response.body, 'ForceArray' => false)
       Job.new_from_xml(data)
     end
-    
+
     def add_batch(jobId, data)
       body = data
-      
+
       if data.is_a?(Array)
         raise ArgumentError, "Data set exceeds 10000 record limit by #{data.length - 10000}" if data.length > 10000
-        
+
         keys = data.first.keys
         body = keys.to_csv
-        
+
         data.each do |item|
           item_values = keys.map { |key| item[key] }
           body += item_values.to_csv
         end
       end
-      
-      # Despite the content for a query operation batch being plain text we 
+
+      # Despite the content for a query operation batch being plain text we
       # still have to specify CSV content type per API docs.
       response = http_post("job/#{jobId}/batch", body, "Content-Type" => "text/csv; charset=UTF-8")
       result = XmlSimple.xml_in(response.body, 'ForceArray' => false)
       Batch.new_from_xml(result)
     end
-    
+
     def add_job(operation, sobject, options={})
       operation = operation.to_s.downcase.to_sym
-      
+
       raise ArgumentError.new("Invalid operation: #{operation}") unless @valid_operations.include?(operation)
-      
+
       options.assert_valid_keys(:external_id_field_name, :concurrency_mode)
-      
+
       if options[:concurrency_mode]
         concurrency_mode = options[:concurrency_mode].capitalize
         raise ArgumentError.new("Invalid concurrency mode: #{concurrency_mode}") unless @valid_concurrency_modes.include?(concurrency_mode)
       end
-      
+
       xml = '<?xml version="1.0" encoding="utf-8"?>'
       xml += '<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">'
       xml += "<operation>#{operation}</operation>"
@@ -117,16 +114,16 @@ module SalesforceBulk
       xml += "<concurrencyMode>#{options[:concurrency_mode]}</concurrencyMode>" if options[:concurrency_mode]
       xml += "<contentType>CSV</contentType>"
       xml += "</jobInfo>"
-      
+
       response = http_post("job", xml)
       data = XmlSimple.xml_in(response.body, 'ForceArray' => false)
       job = Job.new_from_xml(data)
     end
-    
+
     def batch_info_list(jobId)
       response = http_get("job/#{jobId}/batch")
       result = XmlSimple.xml_in(response.body, 'ForceArray' => false)
-      
+
       if result['batchInfo'].is_a?(Array)
         result['batchInfo'].collect do |info|
           Batch.new_from_xml(info)
@@ -135,73 +132,73 @@ module SalesforceBulk
         [Batch.new_from_xml(result['batchInfo'])]
       end
     end
-    
+
     def batch_info(jobId, batchId)
       response = http_get("job/#{jobId}/batch/#{batchId}")
       result = XmlSimple.xml_in(response.body, 'ForceArray' => false)
       Batch.new_from_xml(result)
     end
-    
+
     def batch_result(jobId, batchId)
       response = http_get("job/#{jobId}/batch/#{batchId}/result")
-      
+
       if response.body =~ /<.*?>/m
         result = XmlSimple.xml_in(response.body)
-        
+
         if result['result'].present?
           results = query_result(jobId, batchId, result['result'].first)
-          
+
           collection = QueryResultCollection.new(self, jobId, batchId, result['result'].first, result['result'])
           collection.replace(results)
         end
       else
         result = BatchResultCollection.new(jobId, batchId)
-        
+
         CSV.parse(response.body, :headers => true) do |row|
           result << BatchResult.new(row[0], row[1].to_b, row[2].to_b, row[3])
         end
-        
+
         result
       end
     end
-    
+
     def query_result(job_id, batch_id, result_id)
       headers = {"Content-Type" => "text/csv; charset=UTF-8"}
       response = http_get("job/#{job_id}/batch/#{batch_id}/result/#{result_id}", headers)
-      
+
       lines = response.body.lines.to_a
       headers = CSV.parse_line(lines.shift).collect { |header| header.to_sym }
-      
+
       result = []
-      
+
       #CSV.parse(lines.join, :headers => headers, :converters => [:all, lambda{|s| s.to_b if s.kind_of? String }]) do |row|
       CSV.parse(lines.join, :headers => headers) do |row|
         result << Hash[row.headers.zip(row.fields)]
       end
-      
+
       result
     end
-    
+
     def close_job(jobId)
       xml = '<?xml version="1.0" encoding="utf-8"?>'
       xml += '<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">'
       xml += "<state>Closed</state>"
       xml += "</jobInfo>"
-      
+
       response = http_post("job/#{jobId}", xml)
       data = XmlSimple.xml_in(response.body, 'ForceArray' => false)
       Job.new_from_xml(data)
     end
-    
+
     def job_info(jobId)
       response = http_get("job/#{jobId}")
       data = XmlSimple.xml_in(response.body, 'ForceArray' => false)
       Job.new_from_xml(data)
     end
-    
+
     def http_post(path, body, headers={})
       headers = {'Content-Type' => 'application/xml'}.merge(headers)
-      
+
       if @session_id
         headers['X-SFDC-Session'] = @session_id
         host = instance_host
@@ -209,41 +206,41 @@ module SalesforceBulk
       else
         host = self.login_host
       end
-      
+
       response = https_request(host).post(path, body, headers)
-      
+
       if response.is_a?(Net::HTTPSuccess)
         response
       else
         raise SalesforceError.new(response)
       end
     end
-    
+
     def http_get(path, headers={})
       path = "#{@api_path_prefix}#{path}"
-      
+
       headers = {'Content-Type' => 'application/xml'}.merge(headers)
-      
+
       if @session_id
         headers['X-SFDC-Session'] = @session_id
       end
-      
+
       response = https_request(self.instance_host).get(path, headers)
-      
+
       if response.is_a?(Net::HTTPSuccess)
         response
       else
         raise SalesforceError.new(response)
       end
     end
-    
+
     def https_request(host)
       req = Net::HTTP.new(host, 443)
       req.use_ssl = true
       req.verify_mode = OpenSSL::SSL::VERIFY_NONE
       req
     end
-    
+
     def instance_id(url)
       url.match(/:\/\/([a-zA-Z0-9\-\.]{2,}).salesforce/)[1]
     end