salesforce_bulk_api 0.0.6 → 0.0.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 97cff39898ba0d105b249e1e1ba27fdf05e9a518
-  data.tar.gz: b4765152d9a544e7b80401148ff35ed789da0345
+  metadata.gz: e63ba9f2d9be3dfa89bf6d896ee94fe847bc1b57
+  data.tar.gz: e054528cb047b09383e98fe2d54b1e3ad628bb0e
 SHA512:
-  metadata.gz: 13bf15920245ba4187fb5550249884d04537427c3c849194daf3b867cc1c39f9f3a7f3b7a3ee959b4ff0ba31368a9fa5e0ca75314b126c8097d598aa1cb9e9f6
-  data.tar.gz: 3396900591b0ccf7a1d2759ee9a52168063bda97716741f993b5cc7979f182c046cad34bff9d38e193f538e5201a4592b6121d0aba0b1bf89a6b4eef4ebc5c6b
+  metadata.gz: 7d66df90281412848aba6eed1a5a5476d7883d1e774f28b21dcd2d3a3952027a9e527a474ec2cd702e5b1018c678a25892572206524d1cfbcbd064e7a7577495
+  data.tar.gz: 0326e9e4f4389d5052ce92aa04ff2daf65c26df997dc31d8b353f3cca60f1eb5634da45d126fb2db2d3221873353cd78df6ca8bab55d43f14199dd0d0de71c33

data/.gitignore

@@ -1,4 +1,7 @@
 *.gem
 .bundle
 Gemfile.lock
+.ruby-gemset
+.ruby-version
 pkg/*
+auth_credentials.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format progress

data/README.md

@@ -0,0 +1,91 @@
+# Salesforce-Bulk-Api
+[![Gem Version](https://badge.fury.io/rb/salesforce_bulk_api.png)](http://badge.fury.io/rb/salesforce_bulk_api)
+## Overview
+
+Salesforce bulk API is a simple ruby gem for connecting to and using the Salesforce Bulk API. It is actually a re-written code from [salesforce_bulk](https://github.com/jorgevaldivia/salesforce_bulk).Written to suit many more other features as well.
+
+## How to use
+
+Using this gem is simple and straight forward.
+
+To initialize:
+
+   `sudo gem install salesforce_bulk_api`
+
+or add
+
+   `gem salesforce_bulk_api`
+   
+in your Gemfile
+
+There are two ways to authenticate with SalesForce to use the Bulk API: databasedotcom & restforce.
+Please check out the entire documentation of the gem you decide to use to learn the various ways of authentication.
+
+[Databasedotcom](https://github.com/heroku/databasedotcom)
+[Restforce](https://github.com/ejholmes/restforce)
+
+
+You can use username password combo, OmniAuth, Oauth2
+You can use as many records possible in the Array. Governor limits are taken care of inside the gem.
+
+
+	require 'salesforce_bulk_api'
+	client = Databasedotcom::Client.new :client_id =>  SFDC_APP_CONFIG["client_id"], :client_secret => SFDC_APP_CONFIG["client_secret"] #client_id and client_secret respectively
+	client.authenticate :token => "my-oauth-token", :instance_url => "http://na1.salesforce.com"  #=> "my-oauth-token"
+
+    salesforce = SalesforceBulkApi::Api.new(client)
+
+OR
+
+	require 'salesforce_bulk_api'
+	client = Restforce.new(
+	  username:       SFDC_APP_CONFIG['SFDC_USERNAME'],
+	  password:       SFDC_APP_CONFIG['SFDC_PASSWORD'],
+	  security_token: SFDC_APP_CONFIG['SFDC_SECURITY_TOKEN'],
+	  client_id:      SFDC_APP_CONFIG['SFDC_CLIENT_ID'],
+	  client_secret:  SFDC_APP_CONFIG['SFDC_CLIENT_SECRET'].to_i,
+	  host:           SFDC_APP_CONFIG['SFDC_HOST']
+	)
+
+	salesforce = SalesforceBulkApi::Api.new(client)
+
+
+Sample operations:
+
+    # Insert/Create
+    # Add as many fields per record as needed.
+	new_account = Hash["name" => "Test Account", "type" => "Other"] 
+	records_to_insert = Array.new
+	# You can add as many records as you want here, just keep in mind that Salesforce has governor limits.
+	records_to_insert.push(new_account) 
+	result = salesforce.create("Account", records_to_insert)
+	puts "result is: #{result.inspect}"
+
+    # Update
+	updated_account = Hash["name" => "Test Account -- Updated", id => "a00A0001009zA2m"] # Nearly identical to an insert, but we need to pass the salesforce id.
+	records_to_update = Array.new
+	records_to_update.push(updated_account)
+	salesforce.update("Account", records_to_update)
+
+    # Upsert
+	upserted_account = Hash["name" => "Test Account -- Upserted", "External_Field_Name" => "123456"] # Fields to be updated. External field must be included
+	records_to_upsert = Array.new
+	records_to_upsert.push(upserted_account)
+	salesforce.upsert("Account", records_to_upsert, "External_Field_Name") # Note that upsert accepts an extra parameter for the external field name
+
+    # Delete
+	deleted_account = Hash["id" => "a00A0001009zA2m"] # We only specify the id of the records to delete
+	records_to_delete = Array.new
+	records_to_delete.push(deleted_account)
+	salesforce.delete("Account", records_to_delete)
+
+    # Query
+	res = salesforce.query("Account", "select id, name, createddate from Account limit 3") # We just need to pass the sobject name and the query string
+
+## Installation
+
+    sudo gem install salesforce_bulk_api
+	
+## Contribute
+
+Feel to fork and send Pull request

data/Rakefile

@@ -1 +1,3 @@
-require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+task :default => :spec
+RSpec::Core::RakeTask.new

data/example_auth_credentials.yml

@@ -0,0 +1,5 @@
+salesforce:
+  client_id: client_id_here
+  client_secret: client_secret_here
+  user: sf_user@example.com
+  passwordandtoken: passandtokenhere

data/lib/salesforce_bulk_api/connection.rb

@@ -1,4 +1,5 @@
 module SalesforceBulkApi
+require 'timeout'
 
   class Connection
 
@@ -22,12 +23,17 @@ module SalesforceBulkApi
     #private
 
     def login()
-      @session_id=@client.oauth_token
-      @server_url=@client.instance_url
+      client_type = @client.class.to_s
+      case client_type
+      when "Restforce::Data::Client"
+        @session_id=@client.options[:oauth_token]
+        @server_url=@client.options[:instance_url]
+      else
+        @session_id=@client.oauth_token
+        @server_url=@client.instance_url
+      end
       @instance = parse_instance()
-      puts @instance
       @@INSTANCE_HOST = "#{@instance}.salesforce.com"
-      puts @@INSTANCE_HOST
     end
 
     def post_xml(host, path, xml, headers)
@@ -36,7 +42,19 @@ module SalesforceBulkApi
         headers['X-SFDC-Session'] = @session_id;
         path = "#{@@PATH_PREFIX}#{path}"
       end
-      https(host).post(path, xml, headers).body
+      i = 0
+      begin
+        https(host).post(path, xml, headers).body
+      rescue
+        i += 1
+        if i < 3
+          puts "Request fail #{i}: Retrying #{path}"
+          retry
+        else
+          puts "FATAL: Request to #{path} failed three times."
+          raise
+        end
+      end
     end
 
     def get_request(host, path, headers)
@@ -57,6 +75,8 @@ module SalesforceBulkApi
 
     def parse_instance()
       @instance=@server_url.match(/https:\/\/[a-z]{2}[0-9]{1,2}/).to_s.gsub("https://","")
+      @instance = @server_url.split(".salesforce.com")[0].split("://")[1] if @instance.blank?
+      return @instance
     end
 
   end

data/lib/salesforce_bulk_api/job.rb

@@ -3,22 +3,25 @@ module SalesforceBulkApi
   class Job
 
     def initialize(operation, sobject, records, external_field, connection)
-
-      @@operation = operation
-      @@sobject = sobject
-      @@external_field = external_field
-      @@records = records
-      @@connection = connection
-      @@XML_HEADER = '<?xml version="1.0" encoding="utf-8" ?>'
-
+      @operation      = operation
+      @sobject        = sobject
+      @external_field = external_field
+      @records        = records
+      @connection     = connection
+      @batch_ids      = []
+      @XML_HEADER     = '<?xml version="1.0" encoding="utf-8" ?>'
     end
 
-    def create_job()
-      xml = "#{@@XML_HEADER}<jobInfo xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">"
-      xml += "<operation>#{@@operation}</operation>"
-      xml += "<object>#{@@sobject}</object>"
-      if !@@external_field.nil? # This only happens on upsert
-        xml += "<externalIdFieldName>#{@@external_field}</externalIdFieldName>"
+    def create_job(batch_size, send_nulls, no_null_list)
+      @batch_size = batch_size
+      @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>"
+      if !@external_field.nil? # This only happens on upsert
+        xml += "<externalIdFieldName>#{@external_field}</externalIdFieldName>"
       end
       xml += "<contentType>XML</contentType>"
       xml += "</jobInfo>"
@@ -26,103 +29,169 @@ module SalesforceBulkApi
       path = "job"
       headers = Hash['Content-Type' => 'application/xml; charset=utf-8']
 
-      response = @@connection.post_xml(nil, path, xml, headers)
+      response = @connection.post_xml(nil, path, xml, headers)
       response_parsed = XmlSimple.xml_in(response)
-      puts response
-      @@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 = "#{@XML_HEADER}<jobInfo xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">"
       xml += "<state>Closed</state>"
       xml += "</jobInfo>"
 
-      path = "job/#{@@job_id}"
+      path = "job/#{@job_id}"
       headers = Hash['Content-Type' => 'application/xml; charset=utf-8']
 
-      response = @@connection.post_xml(nil, path, xml, headers)
-      response_parsed = XmlSimple.xml_in(response)
-
-      #job_id = response_parsed['id'][0]
+      response = @connection.post_xml(nil, path, xml, headers)
+      XmlSimple.xml_in(response)
     end
 
     def add_query
-      path = "job/#{@@job_id}/batch/"
+      path = "job/#{@job_id}/batch/"
       headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
 
-      response = @@connection.post_xml(nil, path, @@records, headers)
+      response = @connection.post_xml(nil, path, @records, headers)
       response_parsed = XmlSimple.xml_in(response)
 
-      @@batch_id = response_parsed['id'][0]
+      @batch_ids << response_parsed['id'][0]
     end
 
-    def add_batch()
-      keys = @@records.reduce({}) {|h,pairs| pairs.each {|k,v| (h[k] ||= []) << v}; h}.keys
-      headers = keys
-      @@records_dup=@@records.clone
-      super_records=[]
-      (@@records_dup.size/10000).times do
-        super_records<<@@records_dup.pop(10000)
+    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
+
+      @records_dup = @records.clone
+
+      super_records = []
+      (@records_dup.size/@batch_size).to_i.times do
+        super_records << @records_dup.pop(@batch_size)
+      end
+      super_records << @records_dup unless @records_dup.empty?
+
+      super_records.each do |batch|
+        @batch_ids << add_batch(keys, batch)
       end
-      super_records<<@@records_dup
-
-      super_records.each do|batch|
-        xml = "#{@@XML_HEADER}<sObjects xmlns=\"http://www.force.com/2009/06/asyncapi/dataload\">"
-        batch.each do |r|
-          xml += "<sObject>"
-          keys.each do |k|
-            xml += "<#{k}>#{r[k]}</#{k}>"
+    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\">"
+      batch.each do |r|
+        xml += create_sobject(keys, r)
+      end
+      xml += '</sObjects>'
+      path = "job/#{@job_id}/batch/"
+      headers = Hash["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']
+    end
+
+    def create_sobject(keys, r)
+      sobject_xml = '<sObject>'
+      keys.each do |k|
+        if !r[k].to_s.empty?
+          sobject_xml += "<#{k}>"
+          if r[k].respond_to?(:encode)
+            sobject_xml += r[k].encode(:xml => :text)
+          else
+            sobject_xml += r[k].to_s
           end
-          xml += "</sObject>"
+          sobject_xml += "</#{k}>"
+        elsif @send_nulls && !@no_null_list.include?(k)
+          sobject_xml += "<#{k} xsi:nil=\"true\"/>"
         end
-        xml += "</sObjects>"
-
+      end
+      sobject_xml += '</sObject>'
+      sobject_xml
+    end
 
-        path = "job/#{@@job_id}/batch/"
-        headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
-        response = @@connection.post_xml(nil, path, xml, headers)
-        response_parsed = XmlSimple.xml_in(response)
+    def check_job_status
+      path = "job/#{@job_id}"
+      headers = Hash.new
+      response = @connection.get_request(nil, path, headers)
 
-        @@batch_id = response_parsed['id'][0]
-        puts @@batch_id
+      begin
+        response_parsed = XmlSimple.xml_in(response) if response
+        response_parsed
+      rescue StandardError => e
+        puts "Error parsing XML response for #{@job_id}"
+        puts e
+        puts e.backtrace
       end
     end
 
-    def check_batch_status()
-      path = "job/#{@@job_id}/batch/#{@@batch_id}"
+    def check_batch_status(batch_id)
+      path = "job/#{@job_id}/batch/#{batch_id}"
       headers = Hash.new
 
-      response = @@connection.get_request(nil, path, headers)
-      response_parsed = XmlSimple.xml_in(response)
+      response = @connection.get_request(nil, path, headers)
 
-      # puts response_parsed
       begin
-        #puts "check: #{response_parsed.inspect}\n"
+        response_parsed = XmlSimple.xml_in(response) if response
         response_parsed
-      rescue Exception => e
-        #puts "check: #{response_parsed.inspect}\n"
-        nil
+      rescue StandardError => e
+        puts "Error parsing XML response for #{@job_id}, batch #{batch_id}"
+        puts e
+        puts e.backtrace
       end
     end
 
-    def get_batch_result()
-      path = "job/#{@@job_id}/batch/#{@@batch_id}/result"
+    def get_job_result(return_result, timeout)
+      # timeout is in seconds
+      begin
+        state = []
+        Timeout::timeout(timeout, SalesforceBulkApi::JobTimeout) do
+          while true
+            if self.check_job_status['state'][0] == 'Closed'
+              @batch_ids.each do |batch_id|
+                batch_state = self.check_batch_status(batch_id)
+                if batch_state['state'][0] != "Queued" && batch_state['state'][0] != "InProgress"
+                  state << (batch_state)
+                  @batch_ids.delete(batch_id)
+                end
+              end
+              break if @batch_ids.empty?
+            else
+              break
+            end
+          end
+        end
+      rescue SalesforceBulkApi::JobTimeout => e
+        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])})
+        end
+      end
+      state
+    end
+
+    def get_batch_result(batch_id)
+      path = "job/#{@job_id}/batch/#{batch_id}/result"
       headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
 
-      response = @@connection.get_request(nil, path, headers)
+      response = @connection.get_request(nil, path, headers)
+      response_parsed = XmlSimple.xml_in(response)
+      results = response_parsed['result'] unless @operation == 'query'
 
-      if(@@operation == "query") # The query op requires us to do another request to get the results
-        response_parsed = XmlSimple.xml_in(response)
+      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}"
+        path = "job/#{@job_id}/batch/#{batch_id}/result/#{result_id}"
         headers = Hash.new
         headers = Hash["Content-Type" => "application/xml; charset=UTF-8"]
-        response = @@connection.get_request(nil, path, headers)
+        response = @connection.get_request(nil, path, headers)
+        response_parsed = XmlSimple.xml_in(response)
+        results = response_parsed['records']
       end
-
-
+      results
     end
 
   end
+
+  class JobTimeout < StandardError
+  end
 end

data/lib/salesforce_bulk_api/version.rb

@@ -1,3 +1,3 @@
 module SalesforceBulkApi
-  VERSION = "0.0.6"
+  VERSION = '0.0.8'
 end

data/lib/salesforce_bulk_api.rb

@@ -1,14 +1,15 @@
+require 'rubygems'
+require 'bundler'
+Bundler.require()
 require "salesforce_bulk_api/version"
 require 'net/https'
-require 'rubygems'
 require 'xmlsimple'
 require 'csv'
-require "salesforce_bulk_api/version"
 require 'salesforce_bulk_api/job'
 require 'salesforce_bulk_api/connection'
 
 module SalesforceBulkApi
-  # Your code goes here...
+  
   class Api
 
     @@SALESFORCE_API_VERSION = '23.0'
@@ -17,50 +18,36 @@ module SalesforceBulkApi
       @connection = SalesforceBulkApi::Connection.new(@@SALESFORCE_API_VERSION,client)
     end
 
-    def upsert(sobject, records, external_field)
-      self.do_operation('upsert', sobject, records, external_field)
+    def upsert(sobject, records, external_field, get_response = false, send_nulls = false, no_null_list = [], batch_size = 10000, timeout = 1500)
+      self.do_operation('upsert', sobject, records, external_field, get_response, timeout, batch_size, send_nulls, no_null_list)
     end
 
-    def update(sobject, records)
-      self.do_operation('update', sobject, records, nil)
+    def update(sobject, records, get_response = false, send_nulls = false, no_null_list = [], batch_size = 10000, timeout = 1500)
+      self.do_operation('update', sobject, records, nil, get_response, timeout, batch_size, send_nulls, no_null_list)
     end
 
-    def create(sobject, records)
-      self.do_operation('insert', sobject, records, nil)
+    def create(sobject, records, get_response = false, send_nulls = false, batch_size = 10000, timeout = 1500)
+      self.do_operation('insert', sobject, records, nil, get_response, timeout, batch_size, send_nulls)
     end
 
-    def delete(sobject, records)
-      self.do_operation('delete', sobject, records, nil)
+    def delete(sobject, records, get_response = false, batch_size = 10000, timeout = 1500)
+      self.do_operation('delete', sobject, records, nil, get_response, timeout, batch_size)
     end
 
-    def query(sobject, query)
-      self.do_operation('query', sobject, query, nil)
+    def query(sobject, query, batch_size = 10000, timeout = 1500)
+      self.do_operation('query', sobject, query, nil, true, timeout, batch_size)
     end
 
     #private
 
-    def do_operation(operation, sobject, records, external_field)
+    def do_operation(operation, sobject, records, external_field, get_response, timeout, batch_size, send_nulls = false, no_null_list = [])
       job = SalesforceBulkApi::Job.new(operation, sobject, records, external_field, @connection)
 
-      # TODO: put this in one function
-      job_id = job.create_job()
-      batch_id = operation == "query" ? job.add_query() : job.add_batch()
-      job.close_job()
-
-      while true
-        state = job.check_batch_status()
-        if state['state'][0] != "Queued" && state['state'][0] != "InProgress"
-          break
-        end
-        sleep(2) # wait x seconds and check again
-      end
-
-      if state['state'][0] == 'Completed'
-        job.get_batch_result()
-        return state
-      else
-        return "error"
-      end
+      job.create_job(batch_size, send_nulls, no_null_list)
+      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
     end
-  end  # End class
-end
+  end  
+end

data/salesforce_bulk_api.gemspec

@@ -7,21 +7,23 @@ Gem::Specification.new do |s|
   s.version     = SalesforceBulkApi::VERSION
   s.authors     = ["Yatish Mehta"]
   s.email       = ["yatishmehta27@gmail.com"]
+
   s.homepage    = "https://github.com/yatishmehta27/salesforce_bulk_api"
-  s.summary     = %q{It uses the bulk api of salesforce to communicate with teh salesforce CRM}
+  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.rubyforge_project = "salesforce_bulk_api"
-  s.add_dependency(%q<oauth2>, [">= 0.9.1"])
-  s.add_dependency(%q<databasedotcom>, [">= 0"])
+
   s.add_dependency(%q<json>, [">= 0"])
   s.add_dependency(%q<xml-simple>, [">= 0"])
+  
+  s.add_development_dependency "rspec"
+  s.add_development_dependency("webmock", ["~> 1.13"])
+  s.add_development_dependency("vcr", ['~> 2.5'])
+  
   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"]
 
-  # specify any dependencies here; for example:
-  # s.add_development_dependency "rspec"
-  # s.add_runtime_dependency "rest-client"
 end

data/spec/salesforce_bulk_api/salesforce_bulk_api_spec.rb

@@ -0,0 +1,145 @@
+require 'spec_helper'
+require 'yaml'
+require 'databasedotcom'
+
+describe SalesforceBulkApi do
+
+  before :each do
+    auth_hash = YAML.load(File.read('auth_credentials.yml'))
+    @sf_client = Databasedotcom::Client.new(:client_id     => auth_hash['salesforce']['client_id'],
+                                            :client_secret => auth_hash['salesforce']['client_secret'])
+    @sf_client.authenticate(:username => auth_hash['salesforce']['user'], :password => auth_hash['salesforce']['passwordandtoken'])
+    @api = SalesforceBulkApi::Api.new(@sf_client)
+  end
+
+  describe 'upsert' do
+
+    context 'when not passed get_result' do
+      it "doesn't return the batches array" do
+        res = @api.upsert('Account', [{:Id => '0013000000ymMBh', :Website => 'www.test.com'}], 'Id')
+        res['batches'].should be_nil
+      end
+    end
+
+    context 'when passed get_result = true' do
+      it 'returns the batches array' do
+        res = @api.upsert('Account', [{:Id => '0013000000ymMBh', :Website => 'www.test.com'}], 'Id', true)
+        res['batches'][0]['response'].is_a? Array
+        res['batches'][0]['response'][0].should eq({'id'=>['0013000000ymMBhAAM'], 'success'=>['true'], 'created'=>['false']})
+      end
+    end
+
+    context 'when passed send_nulls = true' do
+      it 'sets the nil and empty attributes to NULL' do
+        @api.update('Account', [{:Id => '0013000000ymMBh', :Website => 'abc123', :Other_Phone__c => '5678', :Gold_Star__c => true}], true)
+        res = @api.query('Account', "SELECT Website, Other_Phone__c From Account WHERE Id = '0013000000ymMBh'")
+        res['batches'][0]['response'][0]['Website'][0].should eq 'abc123'
+        res['batches'][0]['response'][0]['Other_Phone__c'][0].should eq '5678'
+        res = @api.upsert('Account', [{:Id => '0013000000ymMBh', :Website => '', :Other_Phone__c => nil, :Gold_Star__c => false, :CRM_Last_Modified__c => nil}], 'Id', true, true)
+        res['batches'][0]['response'][0].should eq({'id'=>['0013000000ymMBhAAM'], 'success'=>['true'], 'created'=>['false']})
+        res = @api.query('Account', "SELECT Website, Other_Phone__c, Gold_Star__c, CRM_Last_Modified__c From Account WHERE Id = '0013000000ymMBh'")
+        res['batches'][0]['response'][0]['Website'][0].should eq({"xsi:nil" => "true"})
+        res['batches'][0]['response'][0]['Other_Phone__c'][0].should eq({"xsi:nil" => "true"})
+        res['batches'][0]['response'][0]['Gold_Star__c'][0].should eq('false')
+        res['batches'][0]['response'][0]['CRM_Last_Modified__c'][0].should 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 => '0013000000ymMBh', :Website => 'abc123', :Other_Phone__c => '5678', :Gold_Star__c => true}], true)
+        res = @api.query('Account', "SELECT Website, Other_Phone__c From Account WHERE Id = '0013000000ymMBh'")
+        res['batches'][0]['response'][0]['Website'][0].should eq 'abc123'
+        res['batches'][0]['response'][0]['Other_Phone__c'][0].should eq '5678'
+        res = @api.upsert('Account', [{:Id => '0013000000ymMBh', :Website => '', :Other_Phone__c => nil, :Gold_Star__c => false, :CRM_Last_Modified__c => nil}], 'Id', true, true, [:Website, :Other_Phone__c])
+        res['batches'][0]['response'][0].should eq({'id'=>['0013000000ymMBhAAM'], 'success'=>['true'], 'created'=>['false']})
+        res = @api.query('Account', "SELECT Website, Other_Phone__c, Gold_Star__c, CRM_Last_Modified__c From Account WHERE Id = '0013000000ymMBh'")
+        res['batches'][0]['response'][0]['Website'][0].should eq('abc123')
+        res['batches'][0]['response'][0]['Other_Phone__c'][0].should eq('5678')
+        res['batches'][0]['response'][0]['Gold_Star__c'][0].should eq('false')
+        res['batches'][0]['response'][0]['CRM_Last_Modified__c'][0].should eq({"xsi:nil" => "true"})
+      end
+    end
+
+  end
+
+  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 => '0013000000ymMBh', :Website => 'www.test.com'}])
+          res['batches'].should be_nil
+        end
+      end
+
+      context 'when passed get_result = true' do
+        it 'returns the batches array' do
+          res = @api.update('Account', [{:Id => '0013000000ymMBh', :Website => 'www.test.com'}], true)
+          res['batches'][0]['response'].is_a? Array
+          res['batches'][0]['response'][0].should eq({'id'=>['0013000000ymMBhAAM'], 'success'=>['true'], 'created'=>['false']})
+        end
+      end
+    end
+
+    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 => '0013000000ymMBh', :Website => 'www.test.com'},{:Id => 'abc123', :Website => 'www.test.com'}])
+          res['batches'].should be_nil
+        end
+      end
+
+      context 'when passed get_result = true with batches' do
+        it 'returns the results array' do
+          res = @api.update('Account', [{:Id => '0013000000ymMBh', :Website => 'www.test.com'}, {:Id => '0013000000ymMBh', :Website => 'www.test.com'}, {:Id => '0013000000ymMBh', :Website => 'www.test.com'}, {:Id => 'abc123', :Website => 'www.test.com'}], true, false, [], 2)
+          res['batches'][0]['response'].should eq([{"id"=>["0013000000ymMBhAAM"], "success"=>["true"], "created"=>["false"]}, {"errors"=>[{"fields"=>["Id"], "message"=>["Account ID: id value of incorrect type: abc123"], "statusCode"=>["MALFORMED_ID"]}], "success"=>["false"], "created"=>["false"]}])
+          res['batches'][1]['response'].should eq([{"id"=>["0013000000ymMBhAAM"], "success"=>["true"], "created"=>["false"]},{"id"=>["0013000000ymMBhAAM"], "success"=>["true"], "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
+      end
+      context 'and there are multiple batches' do
+        it 'returns the query results in a merged hash' do
+          pending 'need dev to create > 10k records in dev organization'
+          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
+        end
+      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
+      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
+      end
+    end
+
+  end
+
+end

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+require 'rubygems'
+require 'bundler/setup'
+#require 'webmock/rspec'
+#require 'vcr'
+require 'salesforce_bulk_api'
+
+RSpec.configure do |c|
+  c.filter_run :focus => true
+  c.run_all_when_everything_filtered = true
+end
+
+# enable this and record the test requests using a SF developer org.
+# VCR.configure do |c|
+#   c.cassette_library_dir = 'spec/cassettes'
+#   c.hook_into :webmock
+# end

metadata

@@ -1,31 +1,31 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_bulk_api
 version: !ruby/object:Gem::Version
-  version: 0.0.6
+  version: 0.0.8
 platform: ruby
 authors:
 - Yatish Mehta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-16 00:00:00.000000000 Z
+date: 2014-01-13 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: oauth2
+  name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
-        version: 0.9.1
+        version: '0'
 - !ruby/object:Gem::Dependency
-  name: databasedotcom
+  name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
@@ -39,13 +39,13 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: json
+  name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
-  type: :runtime
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
@@ -53,19 +53,33 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: xml-simple
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
-  type: :runtime
+        version: '1.13'
+  type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ~>
       - !ruby/object:Gem::Version
-        version: '0'
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '2.5'
 description: Salesforce Bulk API with governor limits taken care of
 email:
 - yatishmehta27@gmail.com
@@ -74,14 +88,18 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
 - Gemfile
-- README.rdoc
+- README.md
 - Rakefile
+- example_auth_credentials.yml
 - lib/salesforce_bulk_api.rb
 - lib/salesforce_bulk_api/connection.rb
 - lib/salesforce_bulk_api/job.rb
 - lib/salesforce_bulk_api/version.rb
 - salesforce_bulk_api.gemspec
+- spec/salesforce_bulk_api/salesforce_bulk_api_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/yatishmehta27/salesforce_bulk_api
 licenses: []
 metadata: {}
@@ -101,8 +119,10 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: salesforce_bulk_api
-rubygems_version: 2.0.0
+rubygems_version: 2.1.11
 signing_key: 
 specification_version: 4
-summary: It uses the bulk api of salesforce to communicate with teh salesforce CRM
-test_files: []
+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

data/README.rdoc

@@ -1,66 +0,0 @@
-= Salesforce-Bulk-Api
-
-==Overview
-
-Salesforce bulk Api is a simple ruby gem for connecting to and using the Salesforce Bulk API. It is actually a re-written code from salesforce_bulk[https://github.com/jorgevaldivia/salesforce_bulk].Written to suit many more other features as well.
-
-==How to use
-
-Using this gem is simple and straight forward.
-
-To initialize:
-  sudo gem install salesforce_bulk_api
-or add
-  gem salesforce_bulk_api
-in your Gemfile
-
-
-Please do check the entire documentation of the databasedotcom gem and it various ways of authentication
-Databasedotcom[https://github.com/heroku/databasedotcom]
-
-You can use username password combo, OmniAuth, Oauth2
-You can as many records possible in the Array. Governor limits are taken care of inside the gem.
-
-
-
-  require 'salesforce_bulk_api'
-  client = Databasedotcom::Client.new :client_id =>  $SFDC_APP_CONFIG["client_id"], :client_secret => $SFDC_APP_CONFIG["client_secret"] #client_id and client_secret respectively
-  client.authenticate :token => "my-oauth-token", :instance_url => "http://na1.salesforce.com"  #=> "my-oauth-token"
-  salesforce = SalesforceBulkApi::Api.new(client)
-
-Sample operations:
-
-  # Insert/Create
-  new_account = Hash["name" => "Test Account", "type" => "Other"] # Add as many fields per record as needed.
-  records_to_insert = Array.new
-  records_to_insert.push(new_account) # You can add as many records as you want here, just keep in mind that Salesforce has governor limits.
-  result = salesforce.create("Account", records_to_insert)
-  puts "result is: #{result.inspect}"
-
-  # Update
-  updated_account = Hash["name" => "Test Account -- Updated", id => "a00A0001009zA2m"] # Nearly identical to an insert, but we need to pass the salesforce id.
-  records_to_update = Array.new
-  records_to_update.push(updated_account)
-  salesforce.update("Account", records_to_update)
-
-  # Upsert
-  upserted_account = Hash["name" => "Test Account -- Upserted", "External_Field_Name" => "123456"] # Fields to be updated. External field must be included
-  records_to_upsert = Array.new
-  records_to_upsert.push(upserted_account)
-  salesforce.upsert("Account", records_to_upsert, "External_Field_Name") # Note that upsert accepts an extra parameter for the external field name
-
-  # Delete
-  deleted_account = Hash["id" => "a00A0001009zA2m"] # We only specify the id of the records to delete
-  records_to_delete = Array.new
-  records_to_delete.push(deleted_account)
-  salesforce.delete("Account", records_to_delete)
-
-  # Query
-  res = salesforce.query("Account", "select id, name, createddate from Account limit 3") # We just need to pass the sobject name and the query string
-
-==Installation
-sudo gem install salesforce_bulk_api
-
-== Copyright
-
-Copyright (c) 2012 Yatish Mehta