salesforce_http_client 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 000076aefa6a457553c8c6787c48c8b9568335c4
-  data.tar.gz: c6094bb78d72d12424124e95f851fff458ec7963
+  metadata.gz: c9ba38a3ed0ffeaae870824b86c6e46a425cfe5d
+  data.tar.gz: cf30e390b6976ca3cd04a0ec4f94c1e2bb18ac5a
 SHA512:
-  metadata.gz: 9584708bccb982bc3b827071a517f3adebb9aebee594107d7328aaf8c12a9a3b58cb80137a7033712b1f931af0c810e79f58c6cfcda1075ee5e458ae90e39a6b
-  data.tar.gz: 26b862c040100bf01340db62776c05a79da2d35887e4fac228d737bcc837bdcd223c56d3a4e337edf18dec069cee0fbb5c89c344b44f87c46096317e7e5cf5c1
+  metadata.gz: 8398bf09ecc579cf7484244805fcb4dbfa54f6bc803b92328d877d54ef7d04af4da144e6f504434283656f3abbf516c34c292232e9ac32d99385ebcbcac73bd0
+  data.tar.gz: 7df72c5581ec65b09ebf6db1274c7bf5a1e8143242353ae731e9e005ea73e9fd5f4a638987783252f71a3fa7d73d5e68f28370b8496d1159d17bc27cf1843321

data/.gitignore

@@ -20,3 +20,4 @@ tmp
 *.o
 *.a
 mkmf.log
+vendor

data/.travis.yml

@@ -0,0 +1,5 @@
+language: ruby
+rvm:
+  - 2.1.3
+script: bundle exec rspec spec
+

data/README.md

@@ -1,6 +1,10 @@
 # SalesforceHttpClient
 
-TODO: Write a gem description
+This gem provides a simple way to download report data from salesforce.com.
+It works well with any ruby applications, include such as Ruby on Rails.
+
+You can access salesfore.com using only your sales force login id (=email) and password. 
+A security token is no need.
 
 ## Installation
 
@@ -16,9 +20,37 @@ Or install it yourself as:
 
     $ gem install salesforce_http_client
 
-## Usage
+## Configuring SalesforceHttpClient
+
+Add configurations to set your salesforce.com login_id/password.
+
+```ruby
+SalesforceHttpClient.configure do |config|
+  config.salesforce_login_id = 'my_login_id_or_email'
+  config.salesforce_password = 'my_password'
+end
+```
+
+If you're using Rails, create an initializer for this:
+
+    config/initializers/salesforce_http_client.rb
+
+## Downloading report from salesforce.com
+
+First, you need find the salesforce ID for your report.
+For example:  http://na1.salesforce.com/000000000000ABC, where '000000000000ABC' is the salesforce ID.
+
+Then, pass the salesforce ID and a file path to  SalesforceHttpClient::Client#download_report(salesforce_id, report_save_path) method.
+
+```ruby
+salesforce_id = '000000000000ABC'
+report_save_path = "tmp/#{salesforce_id}.csv"
+
+sf_client = SalesforceHttpClient::Client.new
+sf_client.download_report(salesforce_id, report_save_path)
+```
 
-TODO: Write usage instructions here
+After a few seconds, you will find your report data(csv format) at report_save_path.
 
 ## Contributing
 

data/lib/salesforce_http_client/salesforce_http_access.rb

@@ -35,15 +35,21 @@ module SalesforceHttpClient
       @logger.info "begin download reports"
       response = @http_client.get report_url(report_id)
       if response.status == 200
-        report_content = response.content
-        report_file = output_save_path
-        @logger.info "save result to file #{report_file}"
-        File.write(report_file, report_content)
+        save_report(response, output_save_path)
       else
         @logger.error "failed to download reports."
       end
     end
 
+    def save_report(response, output_save_path)
+      report_content = response.content
+      report_file = output_save_path
+      @logger.info "save result to file #{report_file}"
+
+      FileUtils.mkdir_p(File.dirname(report_file))
+      File.write(report_file, report_content)
+    end
+
     def salesforce_logout
       @logger.info "try salesforce logout..."
       @http_client.get config.salesforce_logout_url

data/lib/salesforce_http_client/version.rb

@@ -1,3 +1,3 @@
 module SalesforceHttpClient
-  VERSION = "0.1.1"
+  VERSION = "0.1.2"
 end

data/salesforce_http_client.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = SalesforceHttpClient::VERSION
   spec.authors       = ["Apuruni"]
   spec.email         = ["apuruni@gmail.com"]
-  spec.summary       = "a http client for salesforce.com"
-  spec.description   = "allow you to download a report from salesforce.com quickly."
+  spec.summary       = "This gem provides a simple way to download report data from salesforce.com using only your sales force login id (=email) and password."
+  spec.description   = "This gem provides a simple way to download report data from salesforce.com. It works well with any ruby applications, include such as Ruby on Rails.You can access salesfore.com using only your sales force login id (=email) and password. A security token is no need."
   spec.homepage      = "https://github.com/apuruni/salesforce_http_client"
   spec.license       = "MIT"
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_http_client
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Apuruni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-20 00:00:00.000000000 Z
+date: 2015-01-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -164,7 +164,10 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
-description: allow you to download a report from salesforce.com quickly.
+description: This gem provides a simple way to download report data from salesforce.com.
+  It works well with any ruby applications, include such as Ruby on Rails.You can
+  access salesfore.com using only your sales force login id (=email) and password.
+  A security token is no need.
 email:
 - apuruni@gmail.com
 executables: []
@@ -174,6 +177,7 @@ files:
 - ".gitignore"
 - ".rspec"
 - ".rubocop.yml"
+- ".travis.yml"
 - Gemfile
 - Guardfile
 - LICENSE.txt
@@ -213,7 +217,8 @@ rubyforge_project:
 rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
-summary: a http client for salesforce.com
+summary: This gem provides a simple way to download report data from salesforce.com
+  using only your sales force login id (=email) and password.
 test_files:
 - spec/salesforce_http_client/client_spec.rb
 - spec/salesforce_http_client/configuration_spec.rb