salesforce_http_client 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 6c38ff36a429e3f256e1afe166e9a3fb200c21a0
-  data.tar.gz: 5e6e4e779c1cc7e7d9d105938b9a1f46ee455f89
+  metadata.gz: ca610c378d7eab64f6860210db9105cc791524d8
+  data.tar.gz: 0a35fb07028a40e27d7ec625f4e19d4b574b483d
 SHA512:
-  metadata.gz: 137985ed6c8b5f5f95c741e973a01201dc4a8020cce47d70d4436a17a48c201817b276df545ed9b972f6d4d79d1e48cba96e6e1b2131a3c47c83550b96ed3d34
-  data.tar.gz: 09827e7788467bf5f7670fa58d0fc9f613f5cc355045919c2b4e713c8861622c1f3546dd5927f62b28c2af9dd18d86f0bcf737ca057164eea53f136c7ef01791
+  metadata.gz: e9fa5620a4c8cceaf18fe01e7ec37de1982ad21287f4d678faf1092a457ebf5364010818fc44bf9be3f54852cf662570fc5a2236e101a68459461162004959a2
+  data.tar.gz: 7de758e095cd6bc8f4eb16b6fbb0353ba37000d7f1bb5d546c0c89a53a10f4a4bb9934e20a0648aab5dd7411976a9bb6d6e1cae2bbb417b1da504b5ef7985c0a

data/.gitignore

@@ -14,7 +14,6 @@ rdoc
 spec/reports
 test/tmp
 test/version_tmp
-tmp
 *.bundle
 *.so
 *.o

data/README.md

@@ -3,9 +3,11 @@
 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. 
+You can access salesfore.com using only your salesforce login id (=email) and password. 
 A security token is no need.
 
+Data will be saved in CSV format.
+
 [![Gem Version](https://badge.fury.io/rb/salesforce_http_client.svg)](http://badge.fury.io/rb/salesforce_http_client)
 [![Build Status](https://travis-ci.org/apuruni/salesforce_http_client.svg?branch=master)](https://travis-ci.org/apuruni/salesforce_http_client)
 [![Coverage Status](https://coveralls.io/repos/apuruni/salesforce_http_client/badge.svg?branch=master)](https://coveralls.io/r/apuruni/salesforce_http_client?branch=master)
@@ -27,11 +29,18 @@ Or install it yourself as:
 ## Configuring SalesforceHttpClient
 
 Add configurations to set your salesforce.com login_id/password.
+You must check your salesforce.com instance to get the right domain for your account.
+For example:  https://na12.salesforce.com/000000000000ABC, where 'http://na12.salesforce.com/' is the salesforce.com instance domain.
 
 ```ruby
+require 'fileutils'
+require 'httpclient'
+
 SalesforceHttpClient.configure do |config|
   config.salesforce_login_id = 'my_login_id_or_email'
   config.salesforce_password = 'my_password'
+  # this parameter must be set if you are not using the default (ap.salesforce.com) instance domain of this gem.
+  config.salesforce_instance_domain = 'https://na12.salesforce.com'
 end
 ```
 

data/lib/salesforce_http_client/configuration.rb

@@ -15,6 +15,7 @@ module SalesforceHttpClient
     attr_accessor :salesforce_login_id
     attr_accessor :salesforce_password
 
+    attr_accessor :salesforce_instance_domain
     attr_accessor :salesforce_report_url_format
     attr_accessor :salesforce_report_id_param
 
@@ -29,10 +30,12 @@ module SalesforceHttpClient
     end
 
     def initialize
+      @salesforce_instance_domain = "https://ap.salesforce.com"
+
       @salesforce_login_url = "https://login.salesforce.com/"
-      @salesforce_logout_url = "https://ap.salesforce.com/secur/logout.jsp"
+      @salesforce_logout_url = ->() { @salesforce_instance_domain + "/secur/logout.jsp" }
 
-      @salesforce_report_url_format = 'https://ap.salesforce.com/#{report_id}?export=1&enc=UTF-8&xf=csv'
+      @salesforce_report_url_format = ->() { @salesforce_instance_domain + '/#{report_id}?export=1&enc=UTF-8&xf=csv' }
       @salesforce_report_id_param = '#{report_id}'
 
       @http_timeout = 5 * 60 * 1000
@@ -42,11 +45,27 @@ module SalesforceHttpClient
     end
 
     def report_url(report_id)
-      @salesforce_report_url_format.gsub(@salesforce_report_id_param, report_id)
+      if @salesforce_report_url_format.is_a? Proc
+        url_format = @salesforce_report_url_format.call
+      else
+        url_format = salesforce_report_url_format
+      end
+
+      url_format.gsub(@salesforce_report_id_param, report_id)
+    end
+
+    def logout_url
+      if @salesforce_logout_url.is_a? Proc
+        @salesforce_logout_url.call
+      else
+        @salesforce_logout_url
+      end
     end
 
     def cookie_store_file_path
-      File.join(@tmp_dir, 'cookie_store.dat')
+      file_path = File.join(@tmp_dir, 'cookie_store.dat')
+      FileUtils.mkdir_p(File.dirname(file_path))
+      file_path
     end
 
     private

data/lib/salesforce_http_client/salesforce_http_access.rb

@@ -52,7 +52,7 @@ module SalesforceHttpClient
 
     def salesforce_logout
       @logger.info "try salesforce logout..."
-      @http_client.get config.salesforce_logout_url
+      @http_client.get config.logout_url
       @logger.info "salesforce logged out."
     end
   end

data/lib/salesforce_http_client/version.rb

@@ -1,3 +1,3 @@
 module SalesforceHttpClient
-  VERSION = "0.1.3"
+  VERSION = "0.2.0"
 end

data/spec/salesforce_http_client/client_spec.rb

@@ -10,21 +10,23 @@ module SalesforceHttpClient
     end
 
     describe '#download_report' do
+      let(:sf_domain) { 'https://ap.salesforce.com' }
+      let(:report_id) { 'a' }
       before do
         stub_request(:get, "https://login.salesforce.com/")
           .to_return(status: 200, body: "", headers: {})
 
         stub_request(:post, "https://login.salesforce.com/")
           .with(body: { "pw" => "test_password", "un" => "test_login_id" })
-          .to_return(status: 302, body: "", headers: { 'Location' => 'https://ap.salesforce.com/secur/frontdoor.jsp?sid=00D10000000ZIju%21ARkAQBU5ixFxxAzNvQTreC6rOQ9QSt_cMxFbwmVoVNbWtl.xxHasjFO8v100wa6b0kv.c9Q9RzYuwss9F5TodikF.ELZAHwq&apv=1&cshc=0000001shFs0000000ZIju&display=page' })
+          .to_return(status: 302, body: "", headers: { 'Location' => "#{sf_domain}" + '/secur/frontdoor.jsp?sid=00D10000000ZIju%21ARkAQBU5ixFxxAzNvQTreC6rOQ9QSt_cMxFbwmVoVNbWtl.xxHasjFO8v100wa6b0kv.c9Q9RzYuwss9F5TodikF.ELZAHwq&apv=1&cshc=0000001shFs0000000ZIju&display=page' })
 
-        stub_request(:get, "https://ap.salesforce.com/secur/frontdoor.jsp?apv=1&cshc=0000001shFs0000000ZIju&display=page&sid=00D10000000ZIju!ARkAQBU5ixFxxAzNvQTreC6rOQ9QSt_cMxFbwmVoVNbWtl.xxHasjFO8v100wa6b0kv.c9Q9RzYuwss9F5TodikF.ELZAHwq")
+        stub_request(:get, "#{sf_domain}/secur/frontdoor.jsp?apv=1&cshc=0000001shFs0000000ZIju&display=page&sid=00D10000000ZIju!ARkAQBU5ixFxxAzNvQTreC6rOQ9QSt_cMxFbwmVoVNbWtl.xxHasjFO8v100wa6b0kv.c9Q9RzYuwss9F5TodikF.ELZAHwq")
           .to_return(status: 200, body: "", headers: {})
 
-        stub_request(:get, "https://ap.salesforce.com/a?enc=UTF-8&export=1&xf=csv")
+        stub_request(:get, "#{sf_domain}/#{report_id}?enc=UTF-8&export=1&xf=csv")
           .to_return(status: 200, body: "", headers: {})
 
-        stub_request(:get, "https://ap.salesforce.com/secur/logout.jsp")
+        stub_request(:get, "#{sf_domain}/secur/logout.jsp")
           .to_return(status: 200, body: "", headers: {})
       end
 
@@ -39,6 +41,29 @@ module SalesforceHttpClient
 
         client = SalesforceHttpClient::Client.new
         client.download_report("a", output_file)
+
+        expect(File.exist?(output_file)).to be_truthy
+      end
+
+      context 'north american instance' do
+        let(:sf_domain) { 'https://na12.salesforce.com' }
+        let(:report_id) { 'b' }
+
+        it 'can download report use customized url format' do
+          Configuration.configure do |config|
+            config.salesforce_login_id = 'test_login_id'
+            config.salesforce_password = 'test_password'
+            config.salesforce_instance_domain = 'https://na12.salesforce.com'
+          end
+
+          output_file = "tmp/report_b.csv"
+          File.delete(output_file) if File.exist?(output_file)
+
+          client = SalesforceHttpClient::Client.new
+          client.download_report("b", output_file)
+
+          expect(File.exist?(output_file)).to be_truthy
+        end
       end
     end
   end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: salesforce_http_client
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - Apuruni
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-01-25 00:00:00.000000000 Z
+date: 2015-04-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: httpclient
@@ -209,6 +209,8 @@ files:
 - spec/salesforce_http_client/version_spec.rb
 - spec/salesforce_http_client_spec.rb
 - spec/spec_helper.rb
+- tmp/.gitkeep
+- tmp/cookie_store.dat
 homepage: https://github.com/apuruni/salesforce_http_client
 licenses:
 - MIT