restforce 1.0.0 → 1.0.1

data/README.md

@@ -81,6 +81,21 @@ client = Restforce.new :username => 'foo',
   :client_secret  => 'client_secret'
 ```
 
+You can also set the username, password, security token, client id and client
+secret in environment variables:
+
+```bash
+export SALESFORCE_USERNAME="username"
+export SALESFORCE_PASSWORD="password"
+export SALESFORCE_SECURITY_TOKEN="security token"
+export SALESFORCE_CLIENT_ID="client id"
+export SALESFORCE_CLIENT_SECRET="client secret"
+```
+
+```ruby
+client = Restforce.new
+```
+
 #### Sandbox Orgs
 
 You can connect to sandbox orgs by specifying a host. The default host is
@@ -96,8 +111,8 @@ You can set any of the options passed into Restforce.new globally:
 
 ```ruby
 Restforce.configure do |config|
-  config.client_id     = ENV['SALESFORCE_CLIENT_ID']
-  config.client_secret = ENV['SALESFORCE_CLIENT_SECRET']
+  config.client_id     = 'foo'
+  config.client_secret = 'bar'
 end
 ```
 

data/lib/restforce/client/api.rb

@@ -27,7 +27,7 @@ module Restforce
       #   client.api_delete 'sobjects/Account/001D000000INjVe'
       #
       # Returns the Faraday::Response.
-      define_verbs :get, :post, :put, :delete, :patch
+      define_verbs :get, :post, :put, :delete, :patch, :head
 
       # Public: Get the names of all sobjects on the org.
       #

data/lib/restforce/config.rb

@@ -66,9 +66,35 @@ module Restforce
     # Set to true if you want responses from Salesforce to be gzip compressed.
     attr_accessor :compress
 
-    def initialize
-      @api_version            ||= '26.0'
-      @host                   ||= 'login.salesforce.com'
+    def api_version
+      @api_version ||= '26.0'
+    end
+
+    def username
+      @username ||= ENV['SALESFORCE_USERNAME']
+    end
+
+    def password
+      @password ||= ENV['SALESFORCE_PASSWORD']
+    end
+
+    def security_token
+      @security_token ||= ENV['SALESFORCE_SECURITY_TOKEN']
+    end
+
+    def client_id
+      @client_id ||= ENV['SALESFORCE_CLIENT_ID']
+    end
+
+    def client_secret
+      @client_secret ||= ENV['SALESFORCE_CLIENT_SECRET']
+    end
+
+    def host
+      @host ||= 'login.salesforce.com'
+    end
+
+    def authentication_retries
       @authentication_retries ||= 3
     end
 

data/lib/restforce/version.rb

@@ -1,3 +1,3 @@
 module Restforce
-  VERSION = '1.0.0'
+  VERSION = '1.0.1'
 end

data/spec/lib/config_spec.rb

@@ -1,6 +1,14 @@
 require 'spec_helper'
 
 describe Restforce do
+  before do
+    ENV['SALESFORCE_USERNAME']       = nil
+    ENV['SALESFORCE_PASSWORD']       = nil
+    ENV['SALESFORCE_SECURITY_TOKEN'] = nil
+    ENV['SALESFORCE_CLIENT_ID']      = nil
+    ENV['SALESFORCE_CLIENT_SECRET']  = nil
+  end
+
   after do
     Restforce.instance_variable_set :@configuration, nil
   end
@@ -19,6 +27,30 @@ describe Restforce do
         its(attr) { should be_nil }
       end
     end
+
+    context 'when environment variables are defined' do
+      before do
+        ENV['SALESFORCE_USERNAME']       = 'foo'
+        ENV['SALESFORCE_PASSWORD']       = 'bar'
+        ENV['SALESFORCE_SECURITY_TOKEN'] = 'foobar'
+        ENV['SALESFORCE_CLIENT_ID']      = 'client id'
+        ENV['SALESFORCE_CLIENT_SECRET']  = 'client secret'
+      end
+
+      after do
+        ENV.delete('SALESFORCE_USERNAME')
+        ENV.delete('SALESFORCE_PASSWORD')
+        ENV.delete('SALESFORCE_SECURITY_TOKEN')
+        ENV.delete('SALESFORCE_CLIENT_ID')
+        ENV.delete('SALESFORCE_CLIENT_SECRET')
+      end
+
+      its(:username)       { should eq 'foo' }
+      its(:password)       { should eq 'bar'}
+      its(:security_token) { should eq 'foobar' }
+      its(:client_id)      { should eq 'client id' }
+      its(:client_secret)  { should eq 'client secret' }
+    end
   end
 
   describe '#configure' do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.1
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-12-23 00:00:00.000000000 Z
+date: 2012-12-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: faraday