salesforcebulk 1.3.0 → 1.4.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 068978c964a5939788a560b11f5d9e1cbddbee46
-  data.tar.gz: 5dc3e83dad93a4f155174277bfe267ce860ea32c
+  metadata.gz: b6f6595658ab7d407acd1f74cb96b8b40ae9a303
+  data.tar.gz: d9750c85f6cad1d42a6c81f108d6de8fb1558748
 SHA512:
-  metadata.gz: 784d8d30a9572dc5cd89df6d15a6ea9edc21b501b0392351cbd3cad7b9df8fb123338494a8636d3be7a80f29905293a649735e193d070119c5f2e66b4c56bc7e
-  data.tar.gz: 80b34920216f0f3c20a502d9b0044dfa22d55d67fcf3ae65340d649d4178e6d3924878a21b9b21aaabdb9ecf81b87c4869097bf839c4608f9a7f5423946e6228
+  metadata.gz: abe409976e507aa19ff46d3519088e84656f039aa1521def05daa495f114fe4c04bf4835f47baabcc69bf12da52ee3198cd1a950a0fd30eb472bea336acf2dab
+  data.tar.gz: 87ec0fa2cd572bdf23f624099bfa6ea43c512835672bff6e2aead8be09f4d05a7dce574fcbfaa9cc2285d99c18aaa2a39ff8469eb2726be02aad74636607993e

data/README.md

@@ -153,6 +153,10 @@ Note: By reviewing the API docs and response format my understanding was that th
 
 ## Version History
 
+**1.4.0** (June 1, 2014)
+
+* Added state_message to Batch class (#11 - thanks [@bethesque](https://github.com/bethesque))
+
 **1.3.0** (April 28, 2014)
 
 * Added support for multiple subdomains (#10 - thanks [@lucianapazos](https://github.com/lucianapazos))

data/lib/salesforce_bulk/batch.rb

@@ -1,6 +1,6 @@
 module SalesforceBulk
   class Batch
-    
+
     attr_accessor :apex_processing_time
     attr_accessor :api_active_processing_time
     attr_accessor :completed_at
@@ -10,13 +10,15 @@ module SalesforceBulk
     attr_accessor :job_id
     attr_accessor :processed_records
     attr_accessor :state
+    attr_accessor :state_message
     attr_accessor :total_processing_time
-    
+
     def self.new_from_xml(data)
       batch = self.new
       batch.id = data['id']
       batch.job_id = data['jobId']
       batch.state = data['state']
+      batch.state_message = data['stateMessage']
       batch.created_at = DateTime.parse(data['createdDate'])
       batch.completed_at = DateTime.parse(data['systemModstamp'])
       batch.processed_records = data['numberRecordsProcessed'].to_i
@@ -26,23 +28,23 @@ module SalesforceBulk
       batch.apex_processing_time = data['apex_processing_time'].to_i
       batch
     end
-    
+
     def in_progress?
       state? 'InProgress'
     end
-    
+
     def queued?
       state? 'Queued'
     end
-    
+
     def completed?
       state? 'Completed'
     end
-    
+
     def failed?
       state? 'Failed'
     end
-    
+
     def state?(value)
       self.state.present? && self.state.casecmp(value) == 0
     end

data/lib/salesforce_bulk/version.rb

@@ -1,3 +1,3 @@
 module SalesforceBulk
-  VERSION = "1.3.0"
+  VERSION = "1.4.0"
 end

data/test/fixtures/batch_info_response.xml

@@ -3,6 +3,7 @@
  <id>751E00000004ZRbIAM</id>
  <jobId>750E00000004N97IAE</jobId>
  <state>Completed</state>
+ <stateMessage>Success</stateMessage>
  <createdDate>2012-05-31T01:22:47.000Z</createdDate>
  <systemModstamp>2012-05-31T01:22:47.000Z</systemModstamp>
  <numberRecordsProcessed>2</numberRecordsProcessed>

data/test/lib/test_batch.rb

@@ -1,27 +1,28 @@
 require 'test_helper'
 
 class TestBatch < Test::Unit::TestCase
-  
+
   def setup
     options = {
-      :username => 'myusername', 
+      :username => 'myusername',
       :password => 'mypassword'
     }
-    
+
     @client = SalesforceBulk::Client.new(options)
     bypass_authentication(@client)
     @batch = SalesforceBulk::Batch.new
     @headers = {"Content-Type" => "text/csv; charset=UTF-8", 'X-Sfdc-Session' => '123456789'}
     @headersWithXml = {'Content-Type' => 'application/xml', 'X-Sfdc-Session' => '123456789'}
   end
-  
+
   test "initialize from XML" do
     xml = fixture("batch_info_response.xml")
     batch = SalesforceBulk::Batch.new_from_xml(XmlSimple.xml_in(xml, 'ForceArray' => false))
-    
+
     assert_equal batch.id, '751E00000004ZRbIAM'
     assert_equal batch.job_id, '750E00000004N97IAE'
     assert_equal batch.state, 'Completed'
+    assert_equal batch.state_message, 'Success'
     assert_equal batch.created_at, DateTime.parse('2012-05-31T01:22:47.000Z')
     assert_equal batch.completed_at, DateTime.parse('2012-05-31T01:22:47.000Z')
     assert_equal batch.processed_records, 2
@@ -30,50 +31,50 @@ class TestBatch < Test::Unit::TestCase
     assert_equal batch.api_active_processing_time, 28
     assert_equal batch.apex_processing_time, 0
   end
-  
+
   test "state?" do
     @batch.state = "Completed"
     assert @batch.state?('Completed')
-    
+
     @batch.state = "COMPLETED"
     assert @batch.state?('completed')
-    
+
     @batch.state = "Failed"
     assert !@batch.state?('Queued')
   end
-  
+
   test "state is marked queued" do
     @batch.state = "Queued"
     assert @batch.queued?
-    
+
     @batch.state = nil
     assert !@batch.queued?
   end
-  
+
   test "state is marked in progress" do
     @batch.state = "InProgress"
     assert @batch.in_progress?
-    
+
     @batch.state = nil
     assert !@batch.in_progress?
   end
-  
+
   test "state is marked completed" do
     @batch.state = "Completed"
     assert @batch.completed?
-    
+
     @batch.state = nil
     assert !@batch.completed?
   end
-  
+
   test "state is marked failed" do
     @batch.state = "Failed"
     assert @batch.failed?
-    
+
     @batch.state = nil
     assert !@batch.failed?
   end
-  
+
   test "should add a batch to a job and return a successful response" do
     request = fixture("batch_create_request.csv")
     response = fixture("batch_create_response.xml")
@@ -87,13 +88,13 @@ class TestBatch < Test::Unit::TestCase
     if RUBY_VERSION < '1.9'
       data.first.stubs(:keys).returns([:Id__c, :Title__c, :IsPreview__c])
     end
-    
+
     stub_request(:post, "#{api_url(@client)}job/#{job_id}/batch").with(:body => request, :headers => @headers).to_return(:body => response, :status => 200)
-    
+
     batch = @client.add_batch(job_id, data)
-    
+
     assert_requested :post, "#{api_url(@client)}job/#{job_id}/batch", :body => request, :headers => @headers, :times => 1
-    
+
     assert_equal batch.id, batch_id
     assert_equal batch.job_id, job_id
     assert_equal batch.state, 'Queued'
@@ -105,29 +106,29 @@ class TestBatch < Test::Unit::TestCase
     assert_equal batch.api_active_processing_time, 0
     assert_equal batch.apex_processing_time, 0
   end
-  
+
   test "should raise ArgumentError when given data array length exceeding 10000" do
     data = (1..10100).map { |index| {:Id => index} }
-    
+
     assert_raise ArgumentError do
       @client.add_batch("750E00000004NRfIAM", data)
     end
   end
-  
+
   test "should retrieve info for all batches in a job in a single request" do
     response = fixture("batch_info_list_response.xml")
     job_id = "750E00000004N97IAE"
-    
+
     stub_request(:get, "#{api_url(@client)}job/#{job_id}/batch").with(:headers => @headersWithXml).to_return(:body => response, :status => 200)
-    
+
     batches = @client.batch_info_list(job_id)
-    
+
     assert_requested :get, "#{api_url(@client)}job/#{job_id}/batch", :headers => @headersWithXml, :times => 1
-    
+
     assert_kind_of Array, batches
     assert_kind_of SalesforceBulk::Batch, batches.first
     assert_equal batches.length, 2
-    
+
     batch = batches.first
     assert_equal batch.id, "751E00000004ZRbIAM"
     assert_equal batch.job_id, job_id
@@ -139,7 +140,7 @@ class TestBatch < Test::Unit::TestCase
     assert_equal batch.total_processing_time, 72
     assert_equal batch.api_active_processing_time, 28
     assert_equal batch.apex_processing_time, 0
-    
+
     batch = batches.last
     assert_equal batch.id, "751E00000004ZQsIAM"
     assert_equal batch.job_id, job_id
@@ -152,18 +153,18 @@ class TestBatch < Test::Unit::TestCase
     assert_equal batch.api_active_processing_time, 28
     assert_equal batch.apex_processing_time, 0
   end
-  
+
   test "should retrieve batch info" do
     response = fixture("batch_info_response.xml")
     job_id = "750E00000004N97IAE"
     batch_id = "751E00000004ZRbIAM"
-    
+
     stub_request(:get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}").with(:headers => @headersWithXml).to_return(:body => response, :status => 200)
-    
+
     batch = @client.batch_info(job_id, batch_id)
-    
+
     assert_requested :get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}", :headers => @headersWithXml, :times => 1
-    
+
     assert_equal batch.id, batch_id
     assert_equal batch.job_id, job_id
     assert_equal batch.state, 'Completed'
@@ -175,22 +176,22 @@ class TestBatch < Test::Unit::TestCase
     assert_equal batch.api_active_processing_time, 28
     assert_equal batch.apex_processing_time, 0
   end
-  
+
   test "should return batch result for a non-querying job" do
     response = fixture("batch_result_list_response.csv")
     job_id = "750E00000004NRa"
     batch_id = "751E00000004ZmK"
-    
-    # Batches that are created using CSV will always return 
+
+    # Batches that are created using CSV will always return
     # results in CSV format despite requesting with XML content type.
     # Thus the content type header is ignored.
-    
+
     stub_request(:get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}/result").to_return(:body => response, :status => 200)
-    
+
     results = @client.batch_result(job_id, batch_id)
-    
+
     assert_requested :get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}/result", :times => 1
-    
+
     assert_kind_of SalesforceBulk::BatchResultCollection, results
     assert_kind_of Array, results
     assert_equal results.length, 2
@@ -201,51 +202,51 @@ class TestBatch < Test::Unit::TestCase
     assert_equal results.first.error?, false
     assert_equal results.first.error, ''
   end
-  
+
   test "retrieve result id for a query operation" do
     response = fixture("query_result_list_response.xml")
     job_id = "750E00000004NnR"
     batch_id = "751E00000004aEY"
     result_id = "752E0000000TNaq"
-    
+
     stub_request(:get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}/result").with(:headers => @headersWithXml).to_return(:body => response, :status => 200)
-    
+
     @client.expects(:query_result).with(job_id, batch_id, result_id).returns([])
-    
+
     result = @client.batch_result(job_id, batch_id)
-    
+
     assert_requested :get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}/result", :headers => @headersWithXml, :times => 1
     assert_kind_of SalesforceBulk::QueryResultCollection, result
     assert_equal result.job_id, job_id
     assert_equal result.batch_id, batch_id
     assert_equal result.result_id, result_id
   end
-  
+
   test "retrieve and parse a query result successfully" do
     response = fixture("query_result_response.csv")
     job_id = "750E00000004NnR"
     batch_id = "751E00000004aEY"
     result_id = "752E0000000TNaq"
-    
+
     stub_request(:get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}/result/#{result_id}").with(:headers => @headers).to_return(:body => response, :status => 200)
-    
+
     result = @client.query_result(job_id, batch_id, result_id)
-    
+
     assert_requested :get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}/result/#{result_id}", :headers => @headers, :times => 1
     assert_kind_of Array, result
     assert result.length == 4
   end
-  
+
   test "should raise SalesforceError on invalid batch response" do
     response = fixture("invalid_batch_error.xml")
     job_id = "750E00000004NnR"
     batch_id = "751E00000004aEY"
-    
+
     stub_request(:get, "#{api_url(@client)}job/#{job_id}/batch/#{batch_id}/result").with(:headers => @headersWithXml).to_return(:body => response, :status => 400)
-    
+
     assert_raise SalesforceBulk::SalesforceError do
       @client.batch_result(job_id, batch_id)
     end
   end
-  
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salesforcebulk
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.4.0
 platform: ruby
 authors:
 - Javier Julio
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-28 00:00:00.000000000 Z
+date: 2014-06-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport