salesforce_bulk_query 0.0.2 → 0.0.3

checksums.yaml

@@ -1,7 +1,15 @@
 ---
-SHA1:
-  metadata.gz: a199495e5a1f919e25c9c2f6f129a9d2010b240a
-  data.tar.gz: ffca70b80c504a2c43224e828bc0d059cc23477e
+!binary "U0hBMQ==":
+  metadata.gz: !binary |-
+    OGU3ZjE1MWI1MzE4NjAxMGU2Yzg1NDM4YTM3OGQ0ZmZlMjE1Mjg2MA==
+  data.tar.gz: !binary |-
+    NGM4Y2ZmZTM3ODUwYjk4OGVmZjgwNmY0OTQzNjc5MTk0YWFiYTIyMA==
 SHA512:
-  metadata.gz: 7149c8f12a7fcacc181f1ec39d9d987b68db9dbbf1beada5ab3a0774343bfd9e7aced0d828a7ac78978bd2d2baca5b1cf8309a27098d9b7a452bb277cfd2f5e7
-  data.tar.gz: 669dab096fd60a81c1bdb0a0a1b0811ebdc57519f23a0f44b8000ef94e75911a3ff51660abe5cc7a0bc0aeb9c9a5a5b37f9d800149428f3afa7c1d5c4aaaf737
+  metadata.gz: !binary |-
+    MDcwODI4Njk4ZmMwNjdjMTRlMDVjNWExMjMxZjA1MzQwNTk0Y2QwZjEyODcw
+    ZGZiYjBmMmVmYTU2OWFkZGEwODIzOWRlN2I0MTYyNGFiODQwZWU3MTNiOTI3
+    ZmUxMWVkMmZmZWUwMTJhMzUzZWU1ODViZmY3YTUxY2M0MjBhZDE=
+  data.tar.gz: !binary |-
+    ZTViZTk4M2Y5MTg0ZTI2M2ViYmIxYzQ5ZDg1NzJjZGI4ZmRiMjJhNzczZTRk
+    OGI0YmYzY2I4OWVhNzA5ZWJjOWQwOThkYTYwMGFmZDlkMjVmYmFiZjQ5MTU1
+    YTQ0ZWFlYzA5NWY1OTJmODA4Y2FmMjQ2YjBkNzIyZmIxYTg0ZDE=

data/README.md

@@ -15,7 +15,9 @@ or add
 
 to your Gemfile.
 
-Before using the library, make sure you have the right account in your Salesforce organization that has access to API and that you won't run out of the [API limits](http://www.salesforce.com/us/developer/docs/api_asynchpre/Content/asynch_api_concepts_limits.htm#batch_proc_time_title)
+Before using the library, make sure you have the right account in your Salesforce organization that has access to API and that you won't run out of the [API limits](http://www.salesforce.com/us/developer/docs/api_asynchpre/Content/asynch_api_concepts_limits.htm#batch_proc_time_title). 
+
+You will also need a Salesforce connected app for the `client_id` and `client_sercret` params, see [the guide](https://help.salesforce.com/HTViewHelpDoc?id=connected_app_create.htm&language=en_US). The app needs to have OAuth settings enabled (even if you plan to use just username-password-token authentication). The required permissions are _Access and manage your data (api)_, _Perform requests on your behalf at any time (refresh token, offline access)_. The other parameters such as redirect url don't need to be set.
 
 For doing most of the API calls, the library uses [Restforce](https://github.com/ejholmes/restforce) Code example:
 
@@ -42,7 +44,7 @@ For doing most of the API calls, the library uses [Restforce](https://github.com
     bulk_api = SalesforceBulkQuery::Api.new(restforce)
 
     # query the api
-    result = bulk_client.query("Task", "SELECT Id, Name FROM Task")
+    result = bulk_api.query("Task", "SELECT Id, Name FROM Task")
 
     # the result is files 
     puts "All the downloaded stuff is in csvs: #{result[:filenames]}"
@@ -80,7 +82,7 @@ There are a few optional settings you can pass to the `Api` methods:
 * `check_interval`: how often the results should be checked in secs. 
 * `time_limit`: maximum time the query can take. If this time limit is exceeded, available results are downloaded and the list of subqueries that didn't finished is returned. In seconds. The limti should be understood as limit for waiting. When the limit is reached the function downloads data that is ready which can take some additonal time. 
 * `created_from`, `created_to`: limits for the CreatedDate field. Note that queries can't contain any WHERE statements as we're doing some manipulations to create subqueries and we don't want things to get too difficult. So this is the way to limit the query yourself. The format is like `"1999-01-01T00:00:00.000Z"`
-* `single_batch`: If true, the queries are not divided into subqueries as described above. Instead one batch job is created with the given query. 
+* `single_batch`: If true, the queries are not divided into subqueries as described above. Instead one batch job is created with the given query. This is faster for small amount of data, but will fail with a timeout if you have a lot of data. 
 
 See specs for exact usage.
 

data/lib/salesforce_bulk_query/query.rb

@@ -1,4 +1,5 @@
 require 'salesforce_bulk_query/job'
+require 'date'
 
 module SalesforceBulkQuery
 

data/lib/salesforce_bulk_query/version.rb

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

metadata

@@ -1,97 +1,97 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_bulk_query
 version: !ruby/object:Gem::Version
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors:
 - Petr Cvengros
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-02 00:00:00.000000000 Z
+date: 2014-07-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.8'
 - !ruby/object:Gem::Dependency
   name: xml-simple
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.1'
 - !ruby/object:Gem::Dependency
   name: multi_json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.9'
 - !ruby/object:Gem::Dependency
   name: restforce
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '1.4'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '2.14'
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ~>
       - !ruby/object:Gem::Version
         version: '0.9'
 description: A library for downloading data from Salesforce Bulk API. We only focus
@@ -103,7 +103,7 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- ".gitignore"
+- .gitignore
 - Gemfile
 - LICENSE
 - README.md
@@ -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,3 +143,4 @@ signing_key:
 specification_version: 4
 summary: Downloading data from Salesforce Bulk API made easy and scalable.
 test_files: []
+has_rdoc: