salesforce_bulk 0.1.0 → 1.0.0

data/README.rdoc

@@ -2,8 +2,12 @@
 
 ==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).
+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.
@@ -28,7 +32,7 @@ Sample operations:
   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.
+  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)
@@ -51,16 +55,21 @@ Sample operations:
 
   # 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.records.inspect
 
-==Installation
-sudo gem install salesforce_bulk
+Result reporting:
 
-==TODO
-This is a rough early version of the gem. Immediate plans include better error reporting as there currently is none.
+  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)
+  puts result.success? # false
+  puts result.has_errors? # true
+  puts result.errors # An indexed hash detailing the errors 
 
 == Copyright
 
-Copyright (c) 2011 Jorge Valdivia.
+Copyright (c) 2012 Jorge Valdivia.
 
 ===end
 

data/lib/salesforce_bulk.rb

@@ -19,16 +19,16 @@ module SalesforceBulk
       self.do_operation('upsert', sobject, records, external_field, wait)
     end
 
-    def update(sobject, records)
-      self.do_operation('update', sobject, records, nil)
+    def update(sobject, records, wait=false)
+      self.do_operation('update', sobject, records, nil, wait)
     end
     
-    def create(sobject, records)
-      self.do_operation('insert', sobject, records, nil)
+    def create(sobject, records, wait=false)
+      self.do_operation('insert', sobject, records, nil, wait)
     end
 
-    def delete(sobject, records)
-      self.do_operation('delete', sobject, records, nil)
+    def delete(sobject, records, wait=false)
+      self.do_operation('delete', sobject, records, nil, wait)
     end
 
     def query(sobject, query)
@@ -50,7 +50,6 @@ module SalesforceBulk
       if wait or operation == 'query'
         while true
           state = job.check_batch_status()
-          #puts "\nstate is #{state}\n"
           if state != "Queued" && state != "InProgress"
             break
           end
@@ -59,12 +58,26 @@ module SalesforceBulk
         
         if state == 'Completed'
           job.get_batch_result()
+          job
         else
-          return "There is an error in your job."
+          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 "The job has been closed."
+        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/lib/salesforce_bulk/connection.rb

@@ -40,7 +40,8 @@ module SalesforceBulk
       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 = 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]
@@ -55,12 +56,9 @@ module SalesforceBulk
 
       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"
-
       https(host).post(path, xml, headers).body
     end
 
@@ -87,6 +85,28 @@ module SalesforceBulk
       @instance = $~.captures[0]
     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

@@ -2,6 +2,8 @@ module SalesforceBulk
 
   class Job
 
+    attr :result
+
     def initialize(operation, sobject, records, external_field, connection)
 
       @@operation = operation
@@ -11,6 +13,9 @@ module SalesforceBulk
       @@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()
@@ -27,7 +32,7 @@ module SalesforceBulk
       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 = @@connection.parse_response response
 
       @@job_id = response_parsed['id'][0]
     end
@@ -110,16 +115,60 @@ module SalesforceBulk
         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
 
+      parse_results response
+
       response = response.lines.to_a[1..-1].join
-      csvRows = CSV.parse(response)
+      # 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

@@ -1,3 +1,3 @@
 module SalesforceBulk
-  VERSION = "0.1.0"
+  VERSION = "1.0.0"
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_bulk
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors: