restforce 1.1.0 → 1.2.0

data/README.md

@@ -96,6 +96,19 @@ export SALESFORCE_CLIENT_SECRET="client secret"
 ```ruby
 client = Restforce.new
 ```
+### Proxy Support
+
+You can specify a http proxy using the :proxy_uri option, as follows:
+
+```ruby
+client = Restforce.new :username => 'foo',
+  :password       => 'bar',
+  :security_token => 'security token'
+  :client_id      => 'client_id',
+  :client_secret  => 'client_secret',
+  :proxy_uri      => 'http://proxy.example.com:123'
+```
+This paramter also will accept 'http://user@password:proxy.example.com:123' or using the environemnt variable PROXY_URI.
 
 #### Sandbox Orgs
 

data/lib/restforce/client.rb

@@ -18,7 +18,7 @@ module Restforce
 
     OPTIONS = [:username, :password, :security_token, :client_id, :client_secret, :host, :compress,
        :api_version, :oauth_token, :refresh_token, :instance_url, :cache, :authentication_retries,
-       :timeout]
+       :timeout, :proxy_uri]
 
     # Public: Creates a new client instance
     #
@@ -52,6 +52,8 @@ module Restforce
     #        :compress               - Set to true to have Salesforce compress the response (default: false).
     #        :timeout                - Faraday connection request read/open timeout. (default: nil).
     #
+    #        :proxy_uri              - Proxy URI: 'http://proxy.example.com:port' or 'http://user@pass:proxy.example.com:port'
+    #
     # Examples
     #
     #   # Initialize a new client using password authentication:

data/lib/restforce/client/connection.rb

@@ -57,7 +57,9 @@ module Restforce
       def connection_options
         { :request => {
             :timeout => @options[:timeout],
-            :open_timeout => @options[:timeout] } }
+            :open_timeout => @options[:timeout] }, 
+          :proxy => @options[:proxy_uri]
+        }
       end
 
       # Internal: Returns true if the middlware stack includes the

data/lib/restforce/config.rb

@@ -72,6 +72,8 @@ module Restforce
     # Faraday adapter to use. Defaults to Faraday.default_adapter.
     attr_accessor :adapter
 
+    attr_accessor :proxy_uri
+
     def api_version
       @api_version ||= '26.0'
     end
@@ -96,6 +98,10 @@ module Restforce
       @client_secret ||= ENV['SALESFORCE_CLIENT_SECRET']
     end
 
+    def proxy_uri
+      @proxy_uri ||= ENV['PROXY_URI']
+    end
+
     def host
       @host ||= 'login.salesforce.com'
     end

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '1.1.0'
+  VERSION = '1.2.0'
 end

data/spec/lib/config_spec.rb

@@ -24,7 +24,8 @@ describe Restforce do
       its(:authentication_retries) { should eq 3 }
       its(:adapter)                { should eq Faraday.default_adapter }
       [:username, :password, :security_token, :client_id, :client_secret,
-       :oauth_token, :refresh_token, :instance_url, :compress, :timeout].each do |attr|
+       :oauth_token, :refresh_token, :instance_url, :compress, :timeout,
+       :proxy_uri].each do |attr|
         its(attr) { should be_nil }
       end
     end
@@ -36,6 +37,7 @@ describe Restforce do
         ENV['SALESFORCE_SECURITY_TOKEN'] = 'foobar'
         ENV['SALESFORCE_CLIENT_ID']      = 'client id'
         ENV['SALESFORCE_CLIENT_SECRET']  = 'client secret'
+        ENV['PROXY_URI']                 = 'proxy'
       end
 
       after do
@@ -44,6 +46,7 @@ describe Restforce do
         ENV.delete('SALESFORCE_SECURITY_TOKEN')
         ENV.delete('SALESFORCE_CLIENT_ID')
         ENV.delete('SALESFORCE_CLIENT_SECRET')
+        ENV.delete('PROXY_URI')
       end
 
       its(:username)       { should eq 'foo' }
@@ -51,12 +54,14 @@ describe Restforce do
       its(:security_token) { should eq 'foobar' }
       its(:client_id)      { should eq 'client id' }
       its(:client_secret)  { should eq 'client secret' }
+      its(:proxy_uri)      { should eq 'proxy' }
     end
   end
 
   describe '#configure' do
     [:username, :password, :security_token, :client_id, :client_secret, :compress, :timeout,
-     :oauth_token, :refresh_token, :instance_url, :api_version, :host, :authentication_retries].each do |attr|
+     :oauth_token, :refresh_token, :instance_url, :api_version, :host, :authentication_retries,
+     :proxy_uri].each do |attr|
       it "allows #{attr} to be set" do
         Restforce.configure do |config|
           config.send("#{attr}=", 'foobar')

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.2.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-03-04 00:00:00.000000000 Z
+date: 2013-03-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday
@@ -252,7 +252,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3130418594951849244
+      hash: 1651043006991876016
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -261,7 +261,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: 3130418594951849244
+      hash: 1651043006991876016
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23