salesforce_bulk_query 0.0.3 → 0.0.4

checksums.yaml

@@ -1,15 +1,7 @@
 ---
-!binary "U0hBMQ==":
-  metadata.gz: !binary |-
-    OGU3ZjE1MWI1MzE4NjAxMGU2Yzg1NDM4YTM3OGQ0ZmZlMjE1Mjg2MA==
-  data.tar.gz: !binary |-
-    NGM4Y2ZmZTM3ODUwYjk4OGVmZjgwNmY0OTQzNjc5MTk0YWFiYTIyMA==
+SHA1:
+  metadata.gz: a35d7475e79ba07b3fa4670c7883efc70a1be3b0
+  data.tar.gz: f2234bbc4b5689aa3e9953092cacc89dc6a1c0fa
 SHA512:
-  metadata.gz: !binary |-
-    MDcwODI4Njk4ZmMwNjdjMTRlMDVjNWExMjMxZjA1MzQwNTk0Y2QwZjEyODcw
-    ZGZiYjBmMmVmYTU2OWFkZGEwODIzOWRlN2I0MTYyNGFiODQwZWU3MTNiOTI3
-    ZmUxMWVkMmZmZWUwMTJhMzUzZWU1ODViZmY3YTUxY2M0MjBhZDE=
-  data.tar.gz: !binary |-
-    ZTViZTk4M2Y5MTg0ZTI2M2ViYmIxYzQ5ZDg1NzJjZGI4ZmRiMjJhNzczZTRk
-    OGI0YmYzY2I4OWVhNzA5ZWJjOWQwOThkYTYwMGFmZDlkMjVmYmFiZjQ5MTU1
-    YTQ0ZWFlYzA5NWY1OTJmODA4Y2FmMjQ2YjBkNzIyZmIxYTg0ZDE=
+  metadata.gz: 41e48bada843cc5c2b1a8bb4a9335bc767a6b36258005d745540673361be303790dbc6fe6a14dacbb90554c6d6069f0539f307b55ea471997c323f1512cc6591
+  data.tar.gz: 39bef5c6e5b77745a14490faa7c860c550bce86026bf3f7b7420b6b41ad1a3c7100c496cd6efea5ad9c30d011543b6b0471b9e08ef33253783049fb1228cc64b

data/README.md

@@ -21,47 +21,49 @@ You will also need a Salesforce connected app for the `client_id` and `client_se
 
 For doing most of the API calls, the library uses [Restforce](https://github.com/ejholmes/restforce) Code example:
 
-    require 'restforce'
-    require 'salesforce_bulk_query'
-
-    # Create a restforce client instance
-    # with basic auth
-    restforce = Restforce.new(
-      :username => 'me',
-      :password => 'password',
-      :security_token => 'token',
-      :client_id => "my sfdc app client id",
-      :client_secret => "my sfdc app client secret"
-    )
-
-    # or OAuth
-    restforce = Restforce.new(
-      :refresh_token => "xyz",
-      :client_id => "my sfdc app client id",
-      :client_secret => "my sfdc app client secret"
-    )
-
-    bulk_api = SalesforceBulkQuery::Api.new(restforce)
-
-    # query the api
-    result = bulk_api.query("Task", "SELECT Id, Name FROM Task")
-
-    # the result is files 
-    puts "All the downloaded stuff is in csvs: #{result[:filenames]}"
-
-    # query is a blocking call and can take several hours
-    # if you want to just start the query asynchronously, use 
-    query = start_query("Task", "SELECT Id, Name FROM Task")
-
-    # get a cofee
-    sleep(1234)
-
-    # check the status
-    status = query.check_status
-    if status[:finished]
-      result = query.get_results
-      puts "All the downloaded stuff is in csvs: #{result[:filenames]}"
-    end
+```ruby
+require 'restforce'
+require 'salesforce_bulk_query'
+
+# Create a restforce client instance
+# with basic auth
+restforce = Restforce.new(
+  :username => 'me',
+  :password => 'password',
+  :security_token => 'token',
+  :client_id => "my sfdc app client id",
+  :client_secret => "my sfdc app client secret"
+)
+
+# or OAuth
+restforce = Restforce.new(
+  :refresh_token => "xyz",
+  :client_id => "my sfdc app client id",
+  :client_secret => "my sfdc app client secret"
+)
+
+bulk_api = SalesforceBulkQuery::Api.new(restforce)
+
+# query the api
+result = bulk_api.query("Task", "SELECT Id, Name FROM Task")
+
+# the result is files 
+puts "All the downloaded stuff is in csvs: #{result[:filenames]}"
+
+# query is a blocking call and can take several hours
+# if you want to just start the query asynchronously, use 
+query = start_query("Task", "SELECT Id, Name FROM Task")
+
+# get a cofee
+sleep(1234)
+
+# check the status
+status = query.check_status
+if status[:finished]
+  result = query.get_results
+  puts "All the downloaded stuff is in csvs: #{result[:filenames]}"
+end
+```
 
 ## How it works
 
@@ -100,7 +102,7 @@ See specs for exact usage.
     # switch off logging in Restforce so you don't get every message twice
     Restforce.log = false
 
-If you're using Restforce as a client (which you probably are) and you want to do logging, Salesforce Bulk Query will use a custom logging middleware for Restforce. This is because the original logging middleware puts all API responses to log, which is not something you would like to do for a few gigabytes CSVs. When you use the :logger parameter it's recommended you swith off the default logging in Restforce, otherwise you'll get all messages twice. 
+If you're using Restforce as a client (which you probably are) and you want to do logging, Salesforce Bulk Query will use a custom logging middleware for Restforce. This is because the original logging middleware puts all API responses to log, which is not something you would like to do for a few gigabytes CSVs. When you use the :logger parameter it's recommended you switch off the default logging in Restforce, otherwise you'll get all messages twice. 
 
 ## Copyright
 

data/lib/salesforce_bulk_query.rb

@@ -84,6 +84,11 @@ module SalesforceBulkQuery
         sleep(check_interval)
       end
 
+      # nice list of files to log
+      if @logger && ! results[:filenames].empty?
+        @logger.info "Download finished. Downloaded files in #{File.dirname(results[:filenames][0])}. Filename size:"
+        @logger.info "\n" + results[:filenames].sort.map{|f| "#{File.basename(f)} #{File.size(f)}"}.join("\n")
+      end
       return results
     end
 

data/lib/salesforce_bulk_query/query.rb

@@ -77,7 +77,8 @@ module SalesforceBulkQuery
 
       return {
         :finished => all_done,
-        :job_statuses => job_statuses
+        :job_statuses => job_statuses,
+        :jobs_done => @jobs_done
       }
     end
 

data/lib/salesforce_bulk_query/version.rb

@@ -1,3 +1,3 @@
 module SalesforceBulkQuery
-  VERSION = '0.0.3'
+  VERSION = '0.0.4'
 end

data/spec/salesforce_bulk_query_spec.rb

@@ -39,7 +39,7 @@ describe SalesforceBulkQuery do
 
   describe "query" do
     context "when you give it no options" do
-      it "downloads the data to a few file", :constraint => 'slow'  do
+      it "downloads the data to a few files", :constraint => 'slow'  do
         result = @api.query("Opportunity", "SELECT Id, Name FROM Opportunity")
         result[:filenames].should have_at_least(2).items
         result[:results].should_not be_empty

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_bulk_query
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
 platform: ruby
 authors:
 - Petr Cvengros
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-01 00:00:00.000000000 Z
+date: 2015-01-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -128,12 +128,12 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '1.9'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ! '>='
+  - - '>='
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
@@ -143,4 +143,3 @@ signing_key:
 specification_version: 4
 summary: Downloading data from Salesforce Bulk API made easy and scalable.
 test_files: []
-has_rdoc: