salesforcebulk 1.0.0

data/lib/salesforce_bulk/core_extensions/string.rb

@@ -0,0 +1,14 @@
+class String
+  # For converting "true" and "false" string values returned 
+  # by Salesforce Bulk API in batch results to real booleans.
+  def to_b
+    if present?
+      if lstrip.rstrip.casecmp("true") == 0
+        return true
+      elsif lstrip.rstrip.casecmp("false") == 0
+        return false
+      end
+    end
+    self
+  end
+end

data/lib/salesforce_bulk/job.rb

@@ -0,0 +1,70 @@
+module SalesforceBulk
+  class Job
+    
+    attr_accessor :concurrency_mode
+    attr_accessor :external_id_field_name
+    attr_accessor :id
+    attr_accessor :operation
+    attr_accessor :sobject
+    attr_accessor :state
+    attr_accessor :created_by
+    attr_accessor :created_at
+    attr_accessor :completed_at
+    attr_accessor :content_type
+    attr_accessor :queued_batches
+    attr_accessor :in_progress_batches
+    attr_accessor :completed_batches
+    attr_accessor :failed_batches
+    attr_accessor :total_batches
+    attr_accessor :retries
+    attr_accessor :failed_records
+    attr_accessor :processed_records
+    attr_accessor :apex_processing_time
+    attr_accessor :api_active_processing_time
+    attr_accessor :total_processing_time
+    attr_accessor :api_version
+    
+    def self.new_from_xml(data)
+      job = self.new
+      job.id = data['id']
+      job.operation = data['operation']
+      job.sobject = data['object']
+      job.created_by = data['createdById']
+      job.state = data['state']
+      job.created_at = DateTime.parse(data['createdDate'])
+      job.completed_at = DateTime.parse(data['systemModstamp'])
+      job.external_id_field_name = data['externalIdFieldName']
+      job.concurrency_mode = data['concurrencyMode']
+      job.content_type = data['contentType']
+      job.queued_batches = data['numberBatchesQueued'].to_i
+      job.in_progress_batches = data['numberBatchesInProgress'].to_i
+      job.completed_batches = data['numberBatchesCompleted'].to_i
+      job.failed_batches = data['numberBatchesFailed'].to_i
+      job.total_batches = data['totalBatches'].to_i
+      job.retries = data['retries'].to_i
+      job.processed_records = data['numberRecordsProcessed'].to_i
+      job.failed_records = data['numberRecordsFailed'].to_i
+      job.total_processing_time = data['totalProcessingTime'].to_i
+      job.api_active_processing_time = data['apiActiveProcessingTime'].to_i
+      job.apex_processing_time = data['apexProcessingTime'].to_i
+      job.api_version = data['apiVersion'].to_i
+      job
+    end
+    
+    def aborted?
+      state? 'Aborted'
+    end
+    
+    def closed?
+      state? 'Closed'
+    end
+    
+    def open?
+      state? 'Open'
+    end
+    
+    def state?(value)
+      self.state.present? && self.state.casecmp(value) == 0
+    end
+  end
+end

data/lib/salesforce_bulk/query_result_collection.rb

@@ -0,0 +1,48 @@
+module SalesforceBulk
+  class QueryResultCollection < Array
+    
+    attr_reader :client
+    attr_reader :batch_id
+    attr_reader :job_id
+    attr_reader :result_id
+    attr_reader :result_ids
+    
+    def initialize(client, job_id, batch_id, result_id=nil, result_ids=[])
+      @client = client
+      @job_id = job_id
+      @batch_id = batch_id
+      @result_id = result_id
+      @result_ids = result_ids
+      @current_index = result_ids.index(result_id) || 0
+    end
+    
+    def next?
+      @result_ids.present? && @current_index < @result_ids.length - 1
+    end
+    
+    def next
+      if next?
+        replace(@client.query_result(job_id, batch_id, result_ids[@current_index + 1]))
+        @current_index += 1
+        @result_id = @result_ids[@current_index]
+      end
+      
+      self
+    end
+    
+    def previous?
+      @result_ids.present? && @current_index > 0
+    end
+    
+    def previous
+      if previous?
+        replace(@client.query_result(job_id, batch_id, result_ids[@current_index - 1]))
+        @current_index -= 1
+        @result_id = @result_ids[@current_index]
+      end
+      
+      self
+    end
+    
+  end
+end

data/lib/salesforce_bulk/salesforce_error.rb

@@ -0,0 +1,30 @@
+module SalesforceBulk
+  # An exception raised when any non successful request is made through the Salesforce Bulk API.
+  class SalesforceError < StandardError
+    # The Net::HTTPResponse instance from the API call.
+    attr_accessor :response
+    # The status code from the server response body.
+    attr_accessor :error_code
+    
+    def initialize(response)
+      self.response = response
+      
+      data = XmlSimple.xml_in(response.body, 'ForceArray' => false)
+      
+      if data
+        # seems responses for CSV requests use a different XML return format 
+        # (use invalid_error.xml for reference)
+        if !data['exceptionMessage'].nil?
+          message = data['exceptionMessage']
+        else
+          # SOAP error response
+          message = data['Body']['Fault']['faultstring']
+        end
+        
+        self.error_code = response.code
+      end
+      
+      super(message)
+    end
+  end
+end

data/lib/salesforce_bulk/version.rb

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

data/salesforcebulk.gemspec

@@ -0,0 +1,28 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "salesforce_bulk/version"
+
+Gem::Specification.new do |s|
+  s.name        = "salesforcebulk"
+  s.version     = SalesforceBulk::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Javier Julio"]
+  s.email       = ["jjfutbol@gmail.com"]
+  s.homepage    = "https://github.com/javierjulio/salesforce_bulk"
+  s.summary     = %q{Ruby support for the Salesforce Bulk API}
+  s.description = %q{This gem is a simple interface to the Salesforce Bulk API providing support for insert, update, upsert, delete, and query.}
+
+  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"]
+
+  s.add_dependency "active_support"
+  s.add_dependency "xml-simple"
+
+  s.add_development_dependency "mocha"
+  s.add_development_dependency "rake"
+  s.add_development_dependency "shoulda"
+  s.add_development_dependency "webmock"
+
+end

data/test/fixtures/batch_create_request.csv

@@ -0,0 +1,3 @@
+Id__c,Title__c,IsPreview__c
+12345,This is a test video,
+23456,A second test!,true

data/test/fixtures/batch_create_response.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?><batchInfo
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <id>751E00000004ZmUIAU</id>
+ <jobId>750E00000004NRfIAM</jobId>
+ <state>Queued</state>
+ <createdDate>2012-06-02T21:03:56.000Z</createdDate>
+ <systemModstamp>2012-06-02T21:03:56.000Z</systemModstamp>
+ <numberRecordsProcessed>0</numberRecordsProcessed>
+ <numberRecordsFailed>0</numberRecordsFailed>
+ <totalProcessingTime>0</totalProcessingTime>
+ <apiActiveProcessingTime>0</apiActiveProcessingTime>
+ <apexProcessingTime>0</apexProcessingTime>
+</batchInfo>

data/test/fixtures/batch_info_list_response.xml

@@ -0,0 +1,27 @@
+<?xml version="1.0" encoding="UTF-8"?><batchInfoList
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <batchInfo>
+  <id>751E00000004ZRbIAM</id>
+  <jobId>750E00000004N97IAE</jobId>
+  <state>Completed</state>
+  <createdDate>2012-05-31T01:22:47.000Z</createdDate>
+  <systemModstamp>2012-05-31T01:22:47.000Z</systemModstamp>
+  <numberRecordsProcessed>2</numberRecordsProcessed>
+  <numberRecordsFailed>0</numberRecordsFailed>
+  <totalProcessingTime>72</totalProcessingTime>
+  <apiActiveProcessingTime>28</apiActiveProcessingTime>
+  <apexProcessingTime>0</apexProcessingTime>
+ </batchInfo>
+ <batchInfo>
+  <id>751E00000004ZQsIAM</id>
+  <jobId>750E00000004N97IAE</jobId>
+  <state>Completed</state>
+  <createdDate>2012-05-31T01:23:20.000Z</createdDate>
+  <systemModstamp>2012-05-31T01:23:20.000Z</systemModstamp>
+  <numberRecordsProcessed>2</numberRecordsProcessed>
+  <numberRecordsFailed>0</numberRecordsFailed>
+  <totalProcessingTime>72</totalProcessingTime>
+  <apiActiveProcessingTime>28</apiActiveProcessingTime>
+  <apexProcessingTime>0</apexProcessingTime>
+ </batchInfo>
+</batchInfoList>

data/test/fixtures/batch_info_response.xml

@@ -0,0 +1,13 @@
+<?xml version="1.0" encoding="UTF-8"?><batchInfo
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <id>751E00000004ZRbIAM</id>
+ <jobId>750E00000004N97IAE</jobId>
+ <state>Completed</state>
+ <createdDate>2012-05-31T01:22:47.000Z</createdDate>
+ <systemModstamp>2012-05-31T01:22:47.000Z</systemModstamp>
+ <numberRecordsProcessed>2</numberRecordsProcessed>
+ <numberRecordsFailed>0</numberRecordsFailed>
+ <totalProcessingTime>72</totalProcessingTime>
+ <apiActiveProcessingTime>28</apiActiveProcessingTime>
+ <apexProcessingTime>0</apexProcessingTime>
+</batchInfo>

data/test/fixtures/batch_result_list_response.csv

@@ -0,0 +1,3 @@
+"Id","Success","Created","Error"
+"a00E0000002V30LIAS","true","false",""
+"a00E0000002V30MIAS","true","false",""

data/test/fixtures/config.yml

@@ -0,0 +1,7 @@
+---
+username: MyUsername
+password: MyPassword
+token: MySecurityToken
+debugging: true
+host: myhost.mydomain.com
+version: 88.0

data/test/fixtures/invalid_batch_error.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<error xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+<exceptionCode>InvalidBatch</exceptionCode>
+<exceptionMessage>Records not processed</exceptionMessage>
+</error>

data/test/fixtures/invalid_error.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?><error
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <exceptionCode>UnsupportedContentType</exceptionCode>
+ <exceptionMessage>Unsupported content type: text/cs; charset=UTF-8</exceptionMessage>
+</error>

data/test/fixtures/invalid_job_error.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?><error
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <exceptionCode>InvalidJob</exceptionCode>
+ <exceptionMessage>Unable to find object: Video__c</exceptionMessage>
+</error>

data/test/fixtures/invalid_session_error.xml

@@ -0,0 +1,5 @@
+<?xml version="1.0" encoding="UTF-8"?><error
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <exceptionCode>InvalidSessionId</exceptionCode>
+ <exceptionMessage>Invalid session id</exceptionMessage>
+</error>

data/test/fixtures/job_abort_request.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload"><state>Aborted</state></jobInfo>

data/test/fixtures/job_abort_response.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?><jobInfo
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <id>750E00000004N1NIAU</id>
+ <operation>upsert</operation>
+ <object>VideoEvent__c</object>
+ <createdById>005E00000017spfIAA</createdById>
+ <createdDate>2012-05-30T00:16:04.000Z</createdDate>
+ <systemModstamp>2012-05-30T00:16:04.000Z</systemModstamp>
+ <state>Aborted</state>
+ <externalIdFieldName>Id__c</externalIdFieldName>
+ <concurrencyMode>Parallel</concurrencyMode>
+ <contentType>CSV</contentType>
+ <numberBatchesQueued>0</numberBatchesQueued>
+ <numberBatchesInProgress>0</numberBatchesInProgress>
+ <numberBatchesCompleted>0</numberBatchesCompleted>
+ <numberBatchesFailed>0</numberBatchesFailed>
+ <numberBatchesTotal>0</numberBatchesTotal>
+ <numberRecordsProcessed>0</numberRecordsProcessed>
+ <numberRetries>0</numberRetries>
+ <apiVersion>24.0</apiVersion>
+ <numberRecordsFailed>0</numberRecordsFailed>
+ <totalProcessingTime>0</totalProcessingTime>
+ <apiActiveProcessingTime>0</apiActiveProcessingTime>
+ <apexProcessingTime>0</apexProcessingTime>
+</jobInfo>

data/test/fixtures/job_close_request.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload"><state>Closed</state></jobInfo>

data/test/fixtures/job_close_response.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?><jobInfo
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <id>750E00000004MzbIAE</id>
+ <operation>upsert</operation>
+ <object>VideoEvent__c</object>
+ <createdById>005E00000017spfIAA</createdById>
+ <createdDate>2012-05-29T23:51:53.000Z</createdDate>
+ <systemModstamp>2012-05-29T23:51:53.000Z</systemModstamp>
+ <state>Closed</state>
+ <externalIdFieldName>Id__c</externalIdFieldName>
+ <concurrencyMode>Parallel</concurrencyMode>
+ <contentType>CSV</contentType>
+ <numberBatchesQueued>0</numberBatchesQueued>
+ <numberBatchesInProgress>0</numberBatchesInProgress>
+ <numberBatchesCompleted>0</numberBatchesCompleted>
+ <numberBatchesFailed>0</numberBatchesFailed>
+ <numberBatchesTotal>0</numberBatchesTotal>
+ <numberRecordsProcessed>0</numberRecordsProcessed>
+ <numberRetries>0</numberRetries>
+ <apiVersion>24.0</apiVersion>
+ <numberRecordsFailed>0</numberRecordsFailed>
+ <totalProcessingTime>0</totalProcessingTime>
+ <apiActiveProcessingTime>0</apiActiveProcessingTime>
+ <apexProcessingTime>0</apexProcessingTime>
+</jobInfo>

data/test/fixtures/job_create_request.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload"><operation>upsert</operation><object>VideoEvent__c</object><externalIdFieldName>Id__c</externalIdFieldName><contentType>CSV</contentType></jobInfo>

data/test/fixtures/job_create_response.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<jobInfo xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <id>750E00000004MzbIAE</id>
+ <operation>upsert</operation>
+ <object>VideoEvent__c</object>
+ <createdById>005E00000017spfIAA</createdById>
+ <createdDate>2012-05-29T21:50:47.000Z</createdDate>
+ <systemModstamp>2012-05-29T21:50:47.000Z</systemModstamp>
+ <state>Open</state>
+ <externalIdFieldName>Id__c</externalIdFieldName>
+ <concurrencyMode>Parallel</concurrencyMode>
+ <contentType>CSV</contentType>
+ <numberBatchesQueued>0</numberBatchesQueued>
+ <numberBatchesInProgress>0</numberBatchesInProgress>
+ <numberBatchesCompleted>0</numberBatchesCompleted>
+ <numberBatchesFailed>0</numberBatchesFailed>
+ <numberBatchesTotal>0</numberBatchesTotal>
+ <numberRecordsProcessed>0</numberRecordsProcessed>
+ <numberRetries>0</numberRetries>
+ <apiVersion>24.0</apiVersion>
+ <numberRecordsFailed>0</numberRecordsFailed>
+ <totalProcessingTime>0</totalProcessingTime>
+ <apiActiveProcessingTime>0</apiActiveProcessingTime>
+ <apexProcessingTime>0</apexProcessingTime>
+</jobInfo>

data/test/fixtures/job_info_response.xml

@@ -0,0 +1,25 @@
+<?xml version="1.0" encoding="UTF-8"?><jobInfo
+   xmlns="http://www.force.com/2009/06/asyncapi/dataload">
+ <id>750E00000004N1mIAE</id>
+ <operation>upsert</operation>
+ <object>VideoEvent__c</object>
+ <createdById>005E00000017spfIAA</createdById>
+ <createdDate>2012-05-30T04:08:30.000Z</createdDate>
+ <systemModstamp>2012-05-30T04:08:30.000Z</systemModstamp>
+ <state>Open</state>
+ <externalIdFieldName>Id__c</externalIdFieldName>
+ <concurrencyMode>Parallel</concurrencyMode>
+ <contentType>CSV</contentType>
+ <numberBatchesQueued>0</numberBatchesQueued>
+ <numberBatchesInProgress>0</numberBatchesInProgress>
+ <numberBatchesCompleted>0</numberBatchesCompleted>
+ <numberBatchesFailed>0</numberBatchesFailed>
+ <numberBatchesTotal>0</numberBatchesTotal>
+ <numberRecordsProcessed>0</numberRecordsProcessed>
+ <numberRetries>0</numberRetries>
+ <apiVersion>24.0</apiVersion>
+ <numberRecordsFailed>0</numberRecordsFailed>
+ <totalProcessingTime>0</totalProcessingTime>
+ <apiActiveProcessingTime>0</apiActiveProcessingTime>
+ <apexProcessingTime>0</apexProcessingTime>
+</jobInfo>

data/test/fixtures/login_error.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="UTF-8"?><soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:sf="urn:fault.partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"><soapenv:Body><soapenv:Fault><faultcode>sf:INVALID_LOGIN</faultcode><faultstring>INVALID_LOGIN: Invalid username, password, security token; or user locked out.</faultstring><detail><sf:LoginFault xsi:type="sf:LoginFault"><sf:exceptionCode>INVALID_LOGIN</sf:exceptionCode><sf:exceptionMessage>Invalid username, password, security token; or user locked out.</sf:exceptionMessage></sf:LoginFault></detail></soapenv:Fault></soapenv:Body></soapenv:Envelope>

data/test/fixtures/login_request.xml

@@ -0,0 +1 @@
+<?xml version="1.0" encoding="utf-8"?><env:Envelope xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:env="http://schemas.xmlsoap.org/soap/envelope/"><env:Body><n1:login xmlns:n1="urn:partner.soap.sforce.com"><n1:username>MyUsername</n1:username><n1:password>MyPasswordMySecurityToken</n1:password></n1:login></env:Body></env:Envelope>

data/test/fixtures/login_response.xml

@@ -0,0 +1,39 @@
+<?xml version="1.0" encoding="utf-8"?>
+<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns="urn:partner.soap.sforce.com" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance">
+    <soapenv:Body>
+        <loginResponse>
+            <result>
+                <metadataServerUrl>https://na9-api.salesforce.com/services/Soap/m/24.0/00DE0000000YSKp</metadataServerUrl>
+                <passwordExpired>false</passwordExpired>
+                <sandbox>false</sandbox>
+                <serverUrl>https://na9-api.salesforce.com/services/Soap/u/24.0/00DE0000000YSKp</serverUrl>
+                <sessionId>00DE0000000YSKp!AQ4AQNQhDKLMORZx2NwZppuKfure.ChCmdI3S35PPxpNA5MHb3ZVxhYd5STM3euVJTI5.39s.jOBT.3mKdZ3BWFDdIrddS8O</sessionId>
+                <userId>005E00000017spfIAA</userId>
+                <userInfo>
+                    <accessibilityMode>false</accessibilityMode>
+                    <currencySymbol>$</currencySymbol>
+                    <orgAttachmentFileSizeLimit>5242880</orgAttachmentFileSizeLimit>
+                    <orgDefaultCurrencyIsoCode>USD</orgDefaultCurrencyIsoCode>
+                    <orgDisallowHtmlAttachments>false</orgDisallowHtmlAttachments>
+                    <orgHasPersonAccounts>false</orgHasPersonAccounts>
+                    <organizationId>00DE0000000YSKpMAO</organizationId>
+                    <organizationMultiCurrency>false</organizationMultiCurrency>
+                    <organizationName>Gmail</organizationName>
+                    <profileId>00eE0000000oANhIAM</profileId>
+                    <roleId xsi:nil="true" />
+                    <sessionSecondsValid>7200</sessionSecondsValid>
+                    <userDefaultCurrencyIsoCode xsi:nil="true" />
+                    <userEmail>jjfutbol@gmail.com</userEmail>
+                    <userFullName>Javier Julio</userFullName>
+                    <userId>005E00000017spfIAA</userId>
+                    <userLanguage>en_US</userLanguage>
+                    <userLocale>en_US</userLocale>
+                    <userName>jjfutbol@gmail.com</userName>
+                    <userTimeZone>America/Panama</userTimeZone>
+                    <userType>Standard</userType>
+                    <userUiSkin>Theme3</userUiSkin>
+                </userInfo>
+            </result>
+        </loginResponse>
+    </soapenv:Body>
+</soapenv:Envelope>