salesforcebulk 1.4.0 → 4.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: b6f6595658ab7d407acd1f74cb96b8b40ae9a303
-  data.tar.gz: d9750c85f6cad1d42a6c81f108d6de8fb1558748
+SHA256:
+  metadata.gz: f820b68636330723af5423eac1fd9c0bbbc09cb22fe14651bf82f9b9a76108bf
+  data.tar.gz: af753d04858e10b980c5c140ab2e0bd251f33edd4e9382f96c0112d40a16f0e4
 SHA512:
-  metadata.gz: abe409976e507aa19ff46d3519088e84656f039aa1521def05daa495f114fe4c04bf4835f47baabcc69bf12da52ee3198cd1a950a0fd30eb472bea336acf2dab
-  data.tar.gz: 87ec0fa2cd572bdf23f624099bfa6ea43c512835672bff6e2aead8be09f4d05a7dce574fcbfaa9cc2285d99c18aaa2a39ff8469eb2726be02aad74636607993e
+  metadata.gz: 880925281c6aded2a647d9ad59eed9d9f5d2459c8093e9616f8569ee675b7562e8504663e64421e7d4d8ba3e7c73db0be534de75fe41af082b15cfcd5f08fa3e
+  data.tar.gz: 7987781dfd889b6b27f0ae32bf13e49f83a3e1f8c1872c42ca47bb0c33605b13aeeb7d71002b8d02f9072a44d8f76b665b29254ffc8ae022832d4fa48a85aa88

data/README.md

@@ -1,25 +1,34 @@
 # SalesforceBulk
 
+[![Gem Version](https://badge.fury.io/rb/salesforcebulk.svg)](https://badge.fury.io/rb/salesforcebulk)
+[![Tests](https://github.com/javierjulio/salesforce_bulk/actions/workflows/ci.yml/badge.svg)](https://github.com/javierjulio/salesforce_bulk/actions/workflows/ci.yml)
+
 ## 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).
 
 ## Installation
 
 Install SalesforceBulk from RubyGems:
 
-    gem install salesforcebulk
+```
+gem install salesforcebulk
+```
 
 Or include it in your project's `Gemfile` with Bundler:
 
-    gem 'salesforcebulk'
+```ruby
+gem 'salesforcebulk'
+```
 
 ## Contribute
 
-To contribute, fork this repo, create a topic branch, make changes, then send a pull request. Pull requests without accompanying tests will *not* be accepted. If you need help creating tests let me know and I'll help out. To setup the project and run tests in your fork, just do:
+To contribute, fork this repo, create a topic branch, add changes and tests, then send a pull request. To setup the project and run tests in your fork, just do:
 
-    bundle install
-    rake
+```
+bundle install
+bundle exec rake
+```
 
 ## Configuration and Initialization
 
@@ -27,29 +36,14 @@ 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
-
-Optional keys include `login_host` (default is 'login.salesforce.com') and `version` (default is '24.0').
-
-### Configuring from a YAML file
-
-Create a YAML file with the content below. Only `username` and `password` is required.
+```ruby
+require 'salesforce_bulk'
 
-    ---
-    username: MyUsername
-    password: MyPassword
-    login_host: login.salesforce.com # default
-    version: 24.0 # default
+client = SalesforceBulk::Client.new(username: 'MyUsername', password: 'MyPasswordWithSecurtyToken')
+client.authenticate
+```
 
-Then in a Ruby script:
-
-    require 'salesforce_bulk'
-    
-    client = SalesforceBulk::Client.new("config/salesforce_bulk.yml")
-    client.authenticate
+Optional keys include `login_host` (default is 'login.salesforce.com') and `version` (default is '24.0').
 
 ## Usage Examples
 
@@ -57,57 +51,69 @@ An important note about the data in any of the examples below: each hash in a da
 
 ### Basic Overall Example
 
-    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
+```ruby
+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
 
 When adding a job you can specify the following operations for the first argument:
-- :delete
-- :insert
-- :update
-- :upsert
-- :query
+- `:delete`
+- `:insert`
+- `:update`
+- `:upsert`
+- `:query`
 
 When using the :upsert operation you must specify an external ID field name:
 
-    job = client.add_job(:upsert, :MyObject__c, :external_id_field_name => :MyId__c)
+```ruby
+job = client.add_job(:upsert, :MyObject__c, :external_id_field_name => :MyId__c)
+```
 
 For any operation you should be able to specify a concurrency mode. The default is `Parallel`. The only other choice is `Serial`.
 
-    job = client.add_job(:upsert, :MyObject__c, :concurrency_mode => :Serial, :external_id_field_name => :MyId__c)
+```ruby
+job = client.add_job(:upsert, :MyObject__c, :concurrency_mode => :Serial, :external_id_field_name => :MyId__c)
+```
 
 ### Retrieving Job Information (e.g. Status)
 
 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?
+```ruby
+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
 
 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?
+```ruby
+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
+```ruby
+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
+```
 
 ### Retrieving Batch Results (for Delete, Insert, Update and Upsert)
 
@@ -115,11 +121,13 @@ 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
+```ruby
+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
+```
 
 ### Retrieving Query based Batch Results
 
@@ -127,77 +135,44 @@ To verify that a batch completed successfully or failed call the `batch_info` or
 
 Query results are handled differently as its possible that a single batch could return multiple results if objects returned are large enough. Note: I haven't been able to replicate this behavior but in a fork by @WWJacob has [discovered that multiple results can be returned](https://github.com/WWJacob/salesforce_bulk/commit/8f9e68c390230e885823e45cd2616ac3159697ef).
 
-    # 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
+```ruby
+# returns a QueryResultCollection object (an Array)
+results = client.batch_result(jobId, batchId)
 
-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.
+while results.any?
 
-## Contribution Suggestions/Ideas
+    # Assuming query was: SELECT Id, Name, CustomField__c FROM Account
+    results.each do |result|
+    puts result[:Id], result[:Name], result[:CustomField__c]
+    end
 
-- Support for other Ruby platforms
-- Clean up/reorganize tests better
-- Rdocs
+    puts "Another set is available." if results.next?
 
-## Version History
+    results.next
 
-**1.4.0** (June 1, 2014)
+end
+```
 
-* Added state_message to Batch class (#11 - thanks [@bethesque](https://github.com/bethesque))
+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.
 
-**1.3.0** (April 28, 2014)
+## Releasing
 
-* Added support for multiple subdomains (#10 - thanks [@lucianapazos](https://github.com/lucianapazos))
-* Added dependency version requirements to gemspec
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-**1.2.0** (October 10, 2012)
+## Contribution Suggestions/Ideas
 
-* Added Ruby 1.8.7 support (thanks [@dlee](https://github.com/dlee))
+- Support for other Ruby platforms
+- Clean up/reorganize tests better
+- Rdocs
 
-**1.1.0** (August 20, 2012)
+### Releasing
 
-* Added travis setup. Support for Ruby 1.9.2 and 1.9.3 specified.
-* Removed `token` property on Client object. Specify token in `password` field.
-* Accepted pull request for 1.9.3 improvements.
-* Description updates in README.
+To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
 
-**1.0.0** (August 17, 2012)
+## Contributing
 
-* Initial public release.
+Bug reports and pull requests are welcome on GitHub at https://github.com/javierjulio/salesforce_bulk. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
 
 ## License
 
-(The MIT license)
-
-Copyright (c) 2012 Javier Julio
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/lib/salesforce_bulk.rb

@@ -1,15 +1,7 @@
-require 'net/https'
+require 'net/http'
 require 'xmlsimple'
-if RUBY_VERSION < '1.9'
-	require 'fastercsv'
-else
-	require 'csv'
-end
-require 'active_support'
-require 'active_support/core_ext/object/blank'
-require 'active_support/core_ext/hash/keys'
+require 'csv'
 require 'salesforce_bulk/version'
-require 'salesforce_bulk/core_extensions/string'
 require 'salesforce_bulk/salesforce_error'
 require 'salesforce_bulk/client'
 require 'salesforce_bulk/job'

data/lib/salesforce_bulk/batch.rb

@@ -46,7 +46,7 @@ module SalesforceBulk
     end
 
     def state?(value)
-      self.state.present? && self.state.casecmp(value) == 0
+      !self.state.nil? && self.state.casecmp(value) == 0
     end
   end
 end

data/lib/salesforce_bulk/batch_result.rb

@@ -1,37 +1,37 @@
 module SalesforceBulk
   class BatchResult
-    
+
     # A boolean indicating if record was created. If updated value is false.
     attr_accessor :created
-    
+
     # The error message.
     attr_accessor :error
-    
+
     # The record's unique id.
     attr_accessor :id
-    
-    # If record was created successfully. If false then an error message is provided. 
+
+    # If record was created successfully. If false then an error message is provided.
     attr_accessor :success
-    
+
     def initialize(id, success, created, error)
       @id = id
       @success = success
       @created = created
       @error = error
     end
-    
+
     def error?
-      error.present?
+      !error.nil? && error.respond_to?(:empty?) && !error.empty?
     end
-    
+
     def created?
       created
     end
-    
+
     def successful?
       success
     end
-    
+
     def updated?
       !created && success
     end

data/lib/salesforce_bulk/client.rb

@@ -1,46 +1,45 @@
 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
-    
+
+    # The ID for authenticated session
+    attr_reader :session_id
+
     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)
-      
+
+      assert_valid_keys(options, :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
+      # Clear session attributes just in case client already had a session
+      @session_id = nil
+      self.instance_host = nil
+
       xml = '<?xml version="1.0" encoding="utf-8"?>'
       xml += '<env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema"'
       xml += ' xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"'
@@ -52,63 +51,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)
-      
+
+      assert_valid_keys(options, :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 +116,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)
+      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 +134,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
+
+      if ['application/xml', 'text/xml'].include? response.content_type
         result = XmlSimple.xml_in(response.body)
-        
-        if result['result'].present?
+
+        if !result['result'].nil? && !result['result'].empty?
           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])
+          result << BatchResult.new(row[0], to_boolean(row[1]), to_boolean(row[2]), 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, :converters => [:all, lambda{|s| to_boolean(s) 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,43 +208,65 @@ 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
+
+    private
+
+    def assert_valid_keys(options, *valid_keys)
+      valid_keys.flatten!
+      options.each_key do |k|
+        unless valid_keys.include?(k)
+          raise ArgumentError.new("Unknown key: #{k.inspect}. Valid keys are: #{valid_keys.map(&:inspect).join(', ')}")
+        end
+      end
+    end
+
+    def to_boolean(value)
+      if !value.nil?
+        if value.strip.casecmp("true") == 0
+          return true
+        elsif value.strip.casecmp("false") == 0
+          return false
+        end
+      end
+      value
+    end
   end
 end