salesforce_bulk_api 0.0.10 → 0.0.11

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6ec5f79187db5cdcfcc991dbb8220e0bc0a23346
-  data.tar.gz: 0873d30f2a3faca6f54d3c2faf3da52c90a963bc
+  metadata.gz: 99c3f558cf30c25184d78f67c158fac104d3deca
+  data.tar.gz: 4298337ac2a86b50e959eee7c9707a8de423778d
 SHA512:
-  metadata.gz: 4a32896b615d513aa141dcc43f377e07971e1278eea1d89a6fd264184696b5384884d467d870adfa1f22f2bc935138bdaa2204d1724c7074d6a6f5fe116a38f0
-  data.tar.gz: fe6f1c0cb8f62f21265da9ff3bd5727a2e68dd28d022abd43c6d904b906f0cd2323399995acbe20f63ac9969e0a013f8b36ebb6c60ed37fa43e2bf5bb8d6e3ff
+  metadata.gz: 035074901c3cbc3aeb06cb47b008c094e1e02b62b0c784021d9b434e8608c8d9bd89472580bf993397420c5849122821c3df3c540ac1d420f97d57178c5b74a4
+  data.tar.gz: 6b804db79f5ca0b6aa8be4233f72d842c08ab0e1465edfbc606c25615d33a3a5233419cae594b990fcbcefc7c4660afef43aca6b94417f907f7748e18dbe5274

data/README.md

@@ -82,6 +82,22 @@ 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
 
+Helpful methods:
+
+    # Check status of a job via #job_from_id
+	job = salesforce.job_from_id('a00A0001009zA2m') # Returns a SalesforceBulkApi::Job instance
+	puts "status is: #{job.check_job_status.inspect}"
+
+
+Listening to events:
+
+    # A job is created
+    # Useful when you need to store the job_id before any work begins, then if you fail during a complex load scenario, you can wait for your
+    # previous job(s) to finish.
+  salesforce.on_job_created do |job|
+    puts "Job #{job.job_id} created!"
+  end
+
 ## Installation
 
     sudo gem install salesforce_bulk_api

data/lib/salesforce_bulk_api.rb

@@ -9,13 +9,14 @@ require 'salesforce_bulk_api/job'
 require 'salesforce_bulk_api/connection'
 
 module SalesforceBulkApi
-  
+
   class Api
 
-    @@SALESFORCE_API_VERSION = '23.0'
+    @@SALESFORCE_API_VERSION = '32.0'
 
     def initialize(client)
       @connection = SalesforceBulkApi::Connection.new(@@SALESFORCE_API_VERSION,client)
+      @listeners = { job_created: [] }
     end
 
     def upsert(sobject, records, external_field, get_response = false, send_nulls = false, no_null_list = [], batch_size = 10000, timeout = 1500)
@@ -38,16 +39,30 @@ module SalesforceBulkApi
       self.do_operation('query', sobject, query, nil, true, timeout, batch_size)
     end
 
+    ##
+    # Allows you to attach a listener that accepts the created job (which has a useful #job_id field).  This is useful
+    # for recording a job ID persistently before you begin batch work (i.e. start modifying the salesforce database),
+    # so if the load process you are writing needs to recover, it can be aware of previous jobs it started and wait
+    # for them to finish.
+    def on_job_created(&block)
+      @listeners[:job_created] << block
+    end
+
+    def job_from_id(job_id)
+      SalesforceBulkApi::Job.new(job_id: job_id, connection: @connection)
+    end
+
     #private
 
     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)
+      job = SalesforceBulkApi::Job.new(operation: operation, sobject: sobject, records: records, external_field: external_field, connection: @connection)
 
       job.create_job(batch_size, send_nulls, no_null_list)
+      @listeners[:job_created].each {|callback| callback.call(job)}
       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
+  end
+end

data/lib/salesforce_bulk_api/connection.rb

@@ -75,7 +75,7 @@ require 'timeout'
 
     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?
+      @instance = @server_url.split(".salesforce.com")[0].split("://")[1] if @instance.nil? || @instance.empty?
       return @instance
     end
 

data/lib/salesforce_bulk_api/job.rb

@@ -1,8 +1,12 @@
 module SalesforceBulkApi
 
   class Job
+    attr_reader :job_id
 
-    def initialize(operation, sobject, records, external_field, connection)
+    class SalesforceException < StandardError; end
+
+    def initialize(operation: nil, sobject: nil, records: nil, external_field: nil, connection: nil, job_id: nil)
+      @job_id         = job_id
       @operation      = operation
       @sobject        = sobject
       @external_field = external_field
@@ -12,6 +16,8 @@ module SalesforceBulkApi
       @XML_HEADER     = '<?xml version="1.0" encoding="utf-8" ?>'
     end
 
+
+
     def create_job(batch_size, send_nulls, no_null_list)
       @batch_size = batch_size
       @send_nulls = send_nulls
@@ -32,6 +38,9 @@ module SalesforceBulkApi
       response = @connection.post_xml(nil, path, xml, headers)
       response_parsed = XmlSimple.xml_in(response)
 
+      # response may contain an exception, so raise it
+      raise SalesforceException.new("#{response_parsed['exceptionMessage'][0]} (#{response_parsed['exceptionCode'][0]})") if response_parsed['exceptionCode']
+
       @job_id = response_parsed['id'][0]
 
     end
@@ -112,6 +121,8 @@ module SalesforceBulkApi
           sobject_xml += "<#{k}>"
           if r[k].respond_to?(:encode)
             sobject_xml += r[k].encode(:xml => :text)
+          elsif r[k].respond_to?(:iso8601) # timestamps
+            sobject_xml += r[k].iso8601.to_s
           else
             sobject_xml += r[k].to_s
           end

data/lib/salesforce_bulk_api/version.rb

@@ -1,3 +1,3 @@
 module SalesforceBulkApi
-  VERSION = '0.0.10'
+  VERSION = '0.0.11'
 end

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_bulk_api
 version: !ruby/object:Gem::Version
-  version: 0.0.10
+  version: 0.0.11
 platform: ruby
 authors:
 - Yatish Mehta
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-08-12 00:00:00.000000000 Z
+date: 2015-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '1.13'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - "~>"
       - !ruby/object:Gem::Version
         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'
 - !ruby/object:Gem::Dependency
   name: databasedotcom
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: Salesforce Bulk API with governor limits taken care of
@@ -101,8 +101,8 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .gitignore
-- .rspec
+- ".gitignore"
+- ".rspec"
 - Gemfile
 - README.md
 - Rakefile
@@ -123,21 +123,20 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: salesforce_bulk_api
-rubygems_version: 2.1.11
+rubygems_version: 2.4.5
 signing_key: 
 specification_version: 4
 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
-has_rdoc: