salesforce_bulk 0.0.1 → 0.0.3

data/README.rdoc

@@ -0,0 +1,54 @@
+= 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).
+ 
+==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")
+
+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
+
+== Copyright
+
+Copyright (c) 2011 Jorge Valdivia.
+
+===end
+

data/lib/salesforce_bulk.rb

@@ -51,7 +51,7 @@ module SalesforceBulk
 
       state = job.check_batch_status()
       while true
-        puts "\nstate is #{state}\n"
+        #puts "\nstate is #{state}\n"
         state = job.check_batch_status()
         if state != "Queued"
           break

data/lib/salesforce_bulk/connection.rb

@@ -0,0 +1,90 @@
+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)
+      @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()
+    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)
+
+      @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;
+        #puts "session id is: #{@session_id} --- #{headers.inspect}\n"
+        path = "#{@@PATH_PREFIX}#{path}"
+      end
+
+      #puts "#{host} -- #{path} -- #{headers.inspect}\n"
+
+      http = Net::HTTP.new(host)
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      resp = http.post(path, xml, headers)
+      return resp.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
+
+      http = Net::HTTP.new(host)
+      http.verify_mode = OpenSSL::SSL::VERIFY_NONE
+      resp = http.get(path, headers)
+      return resp.body
+    end
+
+    def parse_instance()
+      @server_url =~ /https:\/\/([a-z]{2,2}[0-9]{1,1})-api/
+      @instance = $~.captures[0]
+    end
+
+  end
+
+end

data/lib/salesforce_bulk/job.rb

@@ -0,0 +1,126 @@
+module SalesforceBulk
+
+  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" ?>'
+
+    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 = XmlSimple.xml_in(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.reduce({}) {|h,pairs| pairs.each {|k,v| (h[k] ||= []) << v}; h}.keys
+      headers = keys.to_csv
+      
+      output_csv = headers
+
+      @@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"]
+        #puts "path is: #{path}\n"
+        
+        response = @@connection.get_request(nil, path, headers)
+        #puts "\n\nres2: #{response.inspect}\n\n"
+
+      end
+
+      response = response.lines.to_a[1..-1].join
+      csvRows = CSV.parse(response)
+    end
+
+  end
+end

data/lib/salesforce_bulk/version.rb

@@ -1,3 +1,3 @@
 module SalesforceBulk
-  VERSION = "0.0.1"
+  VERSION = "0.0.3"
 end

data/salesforce_bulk.gemspec

@@ -7,7 +7,7 @@ Gem::Specification.new do |s|
   s.version     = SalesforceBulk::VERSION
   s.authors     = ["Jorge Valdivia"]
   s.email       = ["jorge@valdivia.me"]
-  s.homepage    = ""
+  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.}
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_bulk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.3
   prerelease: 
 platform: ruby
 authors:
@@ -21,11 +21,14 @@ 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: ''
+homepage: https://github.com/jorgevaldivia/salesforce_bulk
 licenses: []
 post_install_message: 
 rdoc_options: []