salesforce_bulk_quickfix 1.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.project
+*~

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in salesforce_bulk.gemspec
+gemspec

data/README.rdoc

@@ -0,0 +1,75 @@
+= salesforce-bulk
+
+==Overview
+
+Salesforce bulk is a simple ruby gem for connecting to and using the Salesforce Bulk API (http://www.salesforce.com/us/developer/docs/api_asynch/index.htm). There are already some gems out there that provide connectivity to the Salesforce SOAP and Rest APIs, if your needs are simple, I recommend using those, specifically raygao's asf-rest-adapter (https://github.com/raygao/asf-rest-adapter) or databasedotcom (https://rubygems.org/gems/databasedotcom).
+ 
+==Installation
+
+sudo gem install salesforce_bulk
+
+==How to use
+
+Using this gem is simple and straight forward.
+
+To initialize:
+
+  require 'salesforce_bulk'
+  salesforce = SalesforceBulk::Api.new("YOUR_SALESFORCE_USERNAME", "YOUR_SALESFORCE_PASSWORD+YOUR_SALESFORCE_TOKEN")
+
+To use sandbox:
+  salesforce = SalesforceBulk::Api.new("YOUR_SALESFORCE_SANDBOX_USERNAME", "YOUR_SALESFORCE_PASSWORD+YOUR_SALESFORCE_SANDBOX_TOKEN", true)
+
+Note: the second parameter is a combination of your Salesforce token and password. So if your password is xxxx and your token is yyyy, the second parameter will be xxxxyyyy
+
+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
+  
+  OR
+  
+  salesforce.upsert("Account", records_to_upsert, "External_Field_Name", true) # last parameter indicates whether to wait until the batch finishes
+
+  # 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
+  puts res.result.records.inspect
+
+Result reporting:
+
+  new_account = Hash["type" => "Other"] # Missing required field "name."
+  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, true) # Result reporting can only be used if wait is set to true
+  puts result.success? # false
+  puts result.has_errors? # true
+  puts result.result.errors # An indexed hash detailing the errors 
+
+== Copyright
+
+Copyright (c) 2012 Jorge Valdivia.
+
+===end
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/salesforce_bulk/connection.rb

@@ -0,0 +1,114 @@
+module SalesforceBulk
+
+  class Connection
+
+    @@XML_HEADER = '<?xml version="1.0" encoding="utf-8" ?>'
+    @@API_VERSION = nil
+    @@LOGIN_HOST = 'login.salesforce.com'
+    @@INSTANCE_HOST = nil # Gets set in login()
+
+    def initialize(username, password, api_version, in_sandbox)
+      @username = username
+      @password = password
+      @session_id = nil
+      @server_url = nil
+      @instance = nil
+      @@API_VERSION = api_version
+      @@LOGIN_PATH = "/services/Soap/u/#{@@API_VERSION}"
+      @@PATH_PREFIX = "/services/async/#{@@API_VERSION}/"
+      @@LOGIN_HOST = 'test.salesforce.com' if in_sandbox
+
+      login()
+    end
+
+    #private
+
+    def login()
+
+      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\""
+      xml += "    xmlns:env=\"http://schemas.xmlsoap.org/soap/envelope/\">"
+      xml += "  <env:Body>"
+      xml += "    <n1:login xmlns:n1=\"urn:partner.soap.sforce.com\">"
+      xml += "      <n1:username>#{@username}</n1:username>"
+      xml += "      <n1:password>#{@password}</n1:password>"
+      xml += "    </n1:login>"
+      xml += "  </env:Body>"
+      xml += "</env:Envelope>"
+      
+      headers = Hash['Content-Type' => 'text/xml; charset=utf-8', 'SOAPAction' => 'login']
+
+      response = post_xml(@@LOGIN_HOST, @@LOGIN_PATH, xml, headers)
+      # response_parsed = XmlSimple.xml_in(response)
+      response_parsed = parse_response response
+
+      @session_id = response_parsed['Body'][0]['loginResponse'][0]['result'][0]['sessionId'][0]
+      @server_url = response_parsed['Body'][0]['loginResponse'][0]['result'][0]['serverUrl'][0]
+      @instance = parse_instance()
+
+      @@INSTANCE_HOST = "#{@instance}.salesforce.com"
+    end
+
+    def post_xml(host, path, xml, headers)
+
+      host = host || @@INSTANCE_HOST
+
+      if host != @@LOGIN_HOST # Not login, need to add session id to header
+        headers['X-SFDC-Session'] = @session_id;
+        path = "#{@@PATH_PREFIX}#{path}"
+      end
+
+      https(host).post(path, xml, headers).body
+    end
+
+    def get_request(host, path, headers)
+      host = host || @@INSTANCE_HOST
+      path = "#{@@PATH_PREFIX}#{path}"
+
+      if host != @@LOGIN_HOST # Not login, need to add session id to header
+        headers['X-SFDC-Session'] = @session_id;
+      end
+
+      https(host).get(path, headers).body
+    end
+
+    def https(host)
+      req = Net::HTTP.new(host, 443)
+      req.use_ssl = true
+      req.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      req
+    end
+
+    def parse_instance()
+      #@server_url =~ /https:\/\/([a-z]{2,2}[0-9]{1,2})-api/
+      #@instance = $~.captures[0]
+      # JOHN RYAN: had to do this fix quick after a Salesforce API change
+      @server_url = @instance
+    end
+
+    def parse_response response
+      response_parsed = XmlSimple.xml_in(response)
+
+      if response.downcase.include?("faultstring") || response.downcase.include?("exceptionmessage")
+        begin
+          
+          if response.downcase.include?("faultstring")
+            error_message = response_parsed["Body"][0]["Fault"][0]["faultstring"][0]
+          elsif response.downcase.include?("exceptionmessage")
+            error_message = response_parsed["exceptionMessage"][0]
+          end
+
+        rescue
+          raise "An unknown error has occured within the salesforce_bulk gem. This is most likely caused by bad request, but I am unable to parse the correct error message. Here is a dump of the response for your convenience. #{response}"
+        end
+
+        raise error_message
+      end
+
+      response_parsed
+    end
+
+  end
+
+end

data/lib/salesforce_bulk/job.rb

@@ -0,0 +1,174 @@
+module SalesforceBulk
+
+  class Job
+
+    attr :result
+
+    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" ?>'
+
+      # @result = {"errors" => [], "success" => nil, "records" => [], "raw" => nil, "message" => 'The job has been queued.'}
+      @result = JobResult.new
+
+    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>"
+      end
+      xml += "<contentType>CSV</contentType>"
+      xml += "</jobInfo>"
+
+      path = "job"
+      headers = Hash['Content-Type' => 'application/xml; charset=utf-8']
+
+      response = @@connection.post_xml(nil, path, xml, headers)
+      response_parsed = @@connection.parse_response response
+
+      @@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>"
+
+      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]
+    end
+
+    def add_query
+      path = "job/#{@@job_id}/batch/"
+      headers = Hash["Content-Type" => "text/csv; charset=UTF-8"]
+      
+      response = @@connection.post_xml(nil, path, @@records, headers)
+      response_parsed = XmlSimple.xml_in(response)
+
+      @@batch_id = response_parsed['id'][0]
+    end
+
+    def add_batch()
+      keys = @@records.first.keys
+      
+      output_csv = keys.to_csv
+
+      @@records.each do |r|
+        fields = Array.new
+        keys.each do |k|
+          fields.push(r[k])
+        end
+
+        row_csv = fields.to_csv
+        output_csv += row_csv
+      end
+
+      path = "job/#{@@job_id}/batch/"
+      headers = Hash["Content-Type" => "text/csv; charset=UTF-8"]
+      
+      response = @@connection.post_xml(nil, path, output_csv, headers)
+      response_parsed = XmlSimple.xml_in(response)
+
+      @@batch_id = response_parsed['id'][0]
+    end
+
+    def check_batch_status()
+      path = "job/#{@@job_id}/batch/#{@@batch_id}"
+      headers = Hash.new
+
+      response = @@connection.get_request(nil, path, headers)
+      response_parsed = XmlSimple.xml_in(response)
+
+      begin
+        #puts "check: #{response_parsed.inspect}\n"
+        response_parsed['state'][0]
+      rescue Exception => e
+        #puts "check: #{response_parsed.inspect}\n"
+
+        nil
+      end
+    end
+
+    def get_batch_result()
+      path = "job/#{@@job_id}/batch/#{@@batch_id}/result"
+      headers = Hash["Content-Type" => "text/xml; charset=UTF-8"]
+
+      response = @@connection.get_request(nil, path, headers)
+
+      if(@@operation == "query") # The query op requires us to do another request to get the results
+        response_parsed = XmlSimple.xml_in(response)
+        result_id = response_parsed["result"][0]
+
+        path = "job/#{@@job_id}/batch/#{@@batch_id}/result/#{result_id}"
+        headers = Hash.new
+        headers = Hash["Content-Type" => "text/xml; charset=UTF-8"]
+        
+        response = @@connection.get_request(nil, path, headers)
+
+      end
+
+      parse_results response
+
+      response = response.lines.to_a[1..-1].join
+      # csvRows = CSV.parse(response, :headers => true)
+    end
+
+    def parse_results response
+      @result.success = true
+      @result.raw = response.lines.to_a[1..-1].join
+      csvRows = CSV.parse(response, :headers => true)
+
+      csvRows.each_with_index  do |row, index|
+        if @@operation != "query"
+          row["Created"] = row["Created"] == "true" ? true : false
+          row["Success"] = row["Success"] == "true" ? true : false
+        end
+
+        @result.records.push row
+        if row["Success"] == false
+          @result.success = false 
+          @result.errors.push({"#{index}" => row["Error"]}) if row["Error"]
+        end
+      end
+
+      @result.message = "The job has been closed."
+
+    end
+
+  end
+
+  class JobResult
+    attr_writer :errors, :success, :records, :raw, :message
+    attr_reader :errors, :success, :records, :raw, :message
+
+    def initialize
+      @errors = []
+      @success = nil
+      @records = []
+      @raw = nil
+      @message = 'The job has been queued.'
+    end
+
+    def success?
+      @success
+    end
+
+    def has_errors?
+      @errors.count > 0
+    end
+  end
+
+end

data/lib/salesforce_bulk/version.rb

@@ -0,0 +1,3 @@
+module SalesforceBulk
+  VERSION = "1.0.1"
+end

data/lib/salesforce_bulk.rb

@@ -0,0 +1,83 @@
+require 'net/https'
+require 'xmlsimple'
+require 'csv'
+require "salesforce_bulk/version"
+require 'salesforce_bulk/job'
+require 'salesforce_bulk/connection'
+
+module SalesforceBulk
+  # Your code goes here...
+  class Api
+
+    @@SALESFORCE_API_VERSION = '24.0'
+
+    def initialize(username, password, in_sandbox=false)
+      @connection = SalesforceBulk::Connection.new(username, password, @@SALESFORCE_API_VERSION, in_sandbox)
+    end
+
+    def upsert(sobject, records, external_field, wait=false)
+      self.do_operation('upsert', sobject, records, external_field, wait)
+    end
+
+    def update(sobject, records, wait=false)
+      self.do_operation('update', sobject, records, nil, wait)
+    end
+    
+    def create(sobject, records, wait=false)
+      self.do_operation('insert', sobject, records, nil, wait)
+    end
+
+    def delete(sobject, records, wait=false)
+      self.do_operation('delete', sobject, records, nil, wait)
+    end
+
+    def query(sobject, query)
+      self.do_operation('query', sobject, query, nil)
+    end
+
+    def do_operation(operation, sobject, records, external_field, wait=false)
+      job = SalesforceBulk::Job.new(operation, sobject, records, external_field, @connection)
+
+      # TODO: put this in one function
+      job_id = job.create_job()
+      if(operation == "query")
+        batch_id = job.add_query()
+      else
+        batch_id = job.add_batch()
+      end
+      job.close_job()
+
+      if wait or operation == 'query'
+        while true
+          state = job.check_batch_status()
+          if state != "Queued" && state != "InProgress"
+            break
+          end
+          sleep(2) # wait x seconds and check again
+        end
+        
+        if state == 'Completed'
+          job.get_batch_result()
+          job
+        else
+          job.result.message = "There is an error in your job. The response returned a state of #{state}. Please check your query/parameters and try again."
+          job.result.success = false
+          return job
+
+        end
+      else
+        return job
+      end
+
+    end
+
+    def parse_batch_result result
+      begin
+        CSV.parse(result, :headers => true)
+      rescue
+        result
+      end
+    end
+
+  end  # End class
+end # End module

data/salesforce_bulk.gemspec

@@ -0,0 +1,27 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "salesforce_bulk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "salesforce_bulk_quickfix"
+  s.version     = SalesforceBulk::VERSION
+  s.authors     = ["Jorge Valdivia, John Ryan"]
+  s.email       = ["jorge@valdivia.me;johnny@patchapps.com"]
+  s.homepage    = "https://github.com/jorgevaldivia/salesforce_bulk"
+  s.summary     = %q{Ruby support for the Salesforce Bulk API}
+  s.description = %q{This gem provides a super simple interface for the Salesforce Bulk API. It provides support for insert, update, upsert, delete, and query.}
+
+  s.rubyforge_project = "salesforce_bulk_quickfix"
+
+  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"
+
+  s.add_dependency "xml-simple"
+
+end

metadata

@@ -0,0 +1,72 @@
+--- !ruby/object:Gem::Specification
+name: salesforce_bulk_quickfix
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jorge Valdivia, John Ryan
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-06-17 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: xml-simple
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: This gem provides a super simple interface for the Salesforce Bulk API.
+  It provides support for insert, update, upsert, delete, and query.
+email:
+- jorge@valdivia.me;johnny@patchapps.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- README.rdoc
+- Rakefile
+- lib/salesforce_bulk.rb
+- lib/salesforce_bulk/connection.rb
+- lib/salesforce_bulk/job.rb
+- lib/salesforce_bulk/version.rb
+- salesforce_bulk.gemspec
+homepage: https://github.com/jorgevaldivia/salesforce_bulk
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: salesforce_bulk_quickfix
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Ruby support for the Salesforce Bulk API
+test_files: []
+has_rdoc: