restforce 0.1.1 → 0.1.2

data/README.md

@@ -197,8 +197,6 @@ _See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_ups
 
 ### destroy(sobject, id)
 
-_Alias: delete_
-
 Takes an sobject name and an Id and deletes the record. Returns true if the
 record was successfully deleted.
 
@@ -231,6 +229,26 @@ _See also: http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_des
 
 * * *
 
+### authenticate!
+
+Performs an authentication and returns the response. In general, calling this
+directly shouldn't be required, since the client will handle authentication for
+you automatically. This should only be used if you want to force
+an authentication before using the streaming api, or you want to get some
+information about the user.
+
+```ruby
+response = client.authenticate!
+# => #<Restforce::Mash access_token="..." id="https://login.salesforce.com/id/00DE0000000cOGcMAM/005E0000001eM4LIAU" instance_url="https://na9.salesforce.com" issued_at="1348465359751" scope="api refresh_token" signature="3fW0pC/TEY2cjK5FCBFOZdjRtCfAuEbK1U74H/eF+Ho=">
+
+# Get the user information
+info = client.get(response.id).body
+info.user_id
+# => '005E0000001eM4LIAU'
+```
+
+* * *
+
 ### File Uploads
 
 Using the new [Blob Data](http://www.salesforce.com/us/developer/docs/api_rest/Content/dome_sobject_insert_update_blob.htm) api feature (500mb limit):

data/lib/restforce.rb

@@ -28,5 +28,4 @@ module Restforce
 
   class AuthenticationError < StandardError; end
   class UnauthorizedError < StandardError; end
-  class InstanceURLError < StandardError; end
 end

data/lib/restforce/client.rb

@@ -243,7 +243,6 @@ module Restforce
     rescue *exceptions
       false
     end
-    alias_method :delete, :destroy
 
     # See .destroy
     #
@@ -253,7 +252,6 @@ module Restforce
       api_delete "sobjects/#{sobject}/#{id}"
       true
     end
-    alias_method :delete!, :destroy!
 
     # Public: Runs the block with caching disabled.
     #
@@ -279,10 +277,9 @@ module Restforce
 
     # Public: Force an authentication
     def authenticate!
-      connection.headers['X-ForceAuthenticate'] = true
-      get nil
-    ensure
-      connection.headers.delete('X-ForceAuthenticate')
+      raise 'No authentication middleware present' unless authentication_middleware
+      middleware = authentication_middleware.new nil, self, @options
+      middleware.authenticate!
     end
 
     # Public: Decodes a signed request received from Force.com Canvas.
@@ -322,11 +319,16 @@ module Restforce
     # Returns the Faraday::Response.
     [:get, :post, :put, :delete, :patch].each do |method|
       define_method method do |*args|
+        retries = @options[:authentication_retries]
         begin
           connection.send(method, *args)
-        rescue Restforce::InstanceURLError
-          connection.url_prefix = @options[:instance_url]
-          connection.send(method, *args)
+        rescue Restforce::UnauthorizedError
+          if retries > 0
+            retries -= 1
+            connection.url_prefix = @options[:instance_url]
+            retry
+          end
+          raise
         end
       end
 
@@ -350,7 +352,7 @@ module Restforce
 
     # Internal: Internal faraday connection where all requests go through
     def connection
-      @connection ||= Faraday.new do |builder|
+      @connection ||= Faraday.new(@options[:instance_url]) do |builder|
         builder.use Restforce::Middleware::Mashify, self, @options
         builder.use Restforce::Middleware::Multipart
         builder.request :json
@@ -360,6 +362,7 @@ module Restforce
         builder.use Restforce::Middleware::RaiseError
         builder.response :json
         builder.use Restforce::Middleware::Caching, cache, @options if cache
+        builder.use FaradayMiddleware::FollowRedirects
         builder.use Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
         builder.adapter Faraday.default_adapter
       end

data/lib/restforce/middleware/authentication.rb

@@ -7,40 +7,35 @@ module Restforce
   class Middleware::Authentication < Restforce::Middleware
 
     def call(env)
-      retries = @options[:authentication_retries]
-      request_body = env[:body]
-      request = env[:request]
-      begin
-        return authenticate! if force_authenticate?(env)
-        @app.call(env)
-      rescue Restforce::UnauthorizedError
-        if retries > 0
-          authenticate!
-          env[:body] = request_body
-          env[:request] = request
-          retries -= 1
-          retry
-        end
-        raise
-      end
+      @app.call(env)
+    rescue Restforce::UnauthorizedError
+      authenticate!
+      raise
     end
 
     def authenticate!
-      raise 'must subclass'
+      response = connection.post '/services/oauth2/token' do |req|
+        req.body = URI.encode_www_form params
+      end
+      raise Restforce::AuthenticationError, error_message(response) if response.status != 200
+      @options[:instance_url] = response.body['instance_url']
+      @options[:oauth_token]  = response.body['access_token']
+      response.body
+    end
+
+    def params
+      raise 'not implemented'
     end
 
     def connection
       @connection ||= Faraday.new(:url => "https://#{@options[:host]}") do |builder|
+        builder.use Restforce::Middleware::Mashify, nil, @options
         builder.response :json
         builder.use Restforce::Middleware::Logger, Restforce.configuration.logger, @options if Restforce.log?
         builder.adapter Faraday.default_adapter
       end
     end
 
-    def force_authenticate?(env)
-      env[:request_headers] && env[:request_headers]['X-ForceAuthenticate']
-    end
-
     def error_message(response)
       "#{response.body['error']}: #{response.body['error_description']}"
     end

data/lib/restforce/middleware/authentication/password.rb

@@ -3,19 +3,12 @@ module Restforce
   # Authentication middleware used if username and password flow is used
   class Middleware::Authentication::Password < Restforce::Middleware::Authentication
 
-    def authenticate!
-      response = connection.post '/services/oauth2/token' do |req|
-        req.body = URI.encode_www_form(
-          :grant_type    => 'password',
-          :client_id     => @options[:client_id],
-          :client_secret => @options[:client_secret],
-          :username      => @options[:username],
-          :password      => password
-        )
-      end
-      raise Restforce::AuthenticationError, error_message(response) if response.status != 200
-      @options[:instance_url] = response.body['instance_url']
-      @options[:oauth_token]  = response.body['access_token']
+    def params
+      { :grant_type    => 'password',
+        :client_id     => @options[:client_id],
+        :client_secret => @options[:client_secret],
+        :username      => @options[:username],
+        :password      => password }
     end
 
     def password

data/lib/restforce/middleware/authentication/token.rb

@@ -3,18 +3,11 @@ module Restforce
   # Authentication middleware used if oauth_token and refresh_token are set
   class Middleware::Authentication::Token < Restforce::Middleware::Authentication
 
-    def authenticate!
-      response = connection.post '/services/oauth2/token' do |req|
-        req.body = URI.encode_www_form(
-          :grant_type    => 'refresh_token',
-          :refresh_token => @options[:refresh_token],
-          :client_id     => @options[:client_id],
-          :client_secret => @options[:client_secret]
-        )
-      end
-      raise Restforce::AuthenticationError, error_message(response) if response.status != 200
-      @options[:instance_url] = response.body['instance_url']
-      @options[:oauth_token]  = response.body['access_token']
+    def params
+      { :grant_type    => 'refresh_token',
+        :refresh_token => @options[:refresh_token],
+        :client_id     => @options[:client_id],
+        :client_secret => @options[:client_secret] }
     end
   
   end

data/lib/restforce/middleware/instance_url.rb

@@ -4,22 +4,13 @@ module Restforce
   class Middleware::InstanceURL < Restforce::Middleware
 
     def call(env)
-      # If the instance url isn't set in options, raise a
-      # Restforce::UnauthorizedError to trigger reauthentication.
-      raise Restforce::UnauthorizedError, 'instance url not set' unless @options[:instance_url]
-
-      # If the url_prefix for the connection doesn't match the instance_url
-      # set in the options, we raise an error which gets caught outside of
-      # middleware, where the url_prefix is then set before retrying the
-      # request. It would be ideal if this could all be handled in
-      # middleware...
-      raise Restforce::InstanceURLError unless connection.url_prefix == instance_url
-
+      # If the connection url_prefix isn't set, we must not be authenticated.
+      raise Restforce::UnauthorizedError, 'Connection prefix not set' unless url_prefix_set?
       @app.call(env)
     end
 
-    def instance_url
-      URI.parse(@options[:instance_url])
+    def url_prefix_set?
+      !!(connection.url_prefix && connection.url_prefix.host)
     end
   
   end

data/lib/restforce/sobject.rb

@@ -18,10 +18,7 @@ module Restforce
     #   account.Name = 'Foobar'
     #   account.save
     def save
-      # Remove 'attributes' and parent/child relationships. We only want to
-      # persist the attributes on the sobject.
       ensure_id
-      attrs = self.to_hash.reject { |key, _| key =~ /.*__r/ || key =~ /^attributes$/ }
       @client.update(sobject_type, attrs)
     end
 
@@ -36,6 +33,12 @@ module Restforce
       @client.destroy(sobject_type, self.Id)
     end
 
+    # Public: Returns a hash representation of this object with the attributes
+    # key and parent/child relationships removed.
+    def attrs
+      self.to_hash.reject { |key, _| key =~ /.*__r/ || key =~ /^attributes$/ }
+    end
+
   private
 
     def ensure_id

data/lib/restforce/version.rb

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

data/spec/lib/client_spec.rb

@@ -330,6 +330,7 @@ shared_examples_for 'methods' do
 
     subject { client.authenticate! }
     specify { expect { subject }.to_not raise_error }
+    it { should be_a Hash }
   end
 
   describe '.cache' do
@@ -395,6 +396,64 @@ shared_examples_for 'methods' do
       specify { expect { subject }.to_not raise_error }
     end
   end
+
+  describe 'authentication retries' do
+    context 'when retries reaches 0' do
+      before do
+        @auth_request = stub_api_request('query\?q=SELECT%20some,%20fields%20FROM%20object', status: 401, with: 'expired_session_response')
+        @query_request = stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
+          .with(:body => "grant_type=password&client_id=client_id&client_secret=" \
+          "client_secret&username=foo&password=barsecurity_token")
+          .to_return(:status => 200, :body => fixture(:auth_success_response))
+      end
+
+      subject { client.query('SELECT some, fields FROM object') }
+      specify { expect { subject }.to raise_error Restforce::UnauthorizedError }
+    end
+  end
+
+  describe '.query with caching' do
+    class MockCache
+      def initialize
+        @storage = {}
+      end
+
+      def fetch(key, &block)
+        @storage[key] || begin
+          block.call.tap do |result|
+            @storage[key] = result
+          end
+        end
+      end
+    end
+
+    let(:cache) { MockCache.new }
+    let(:oauth_token) { 'foobar' }
+
+    before do
+      @requests = [].tap do |requests|
+        requests << stub_request(:get, /query\?q=SELECT%20some,%20fields%20FROM%20object/)
+          .with(headers: { 'Authorization' => "OAuth #{oauth_token}" })
+          .to_return(status: 401, body: fixture('expired_session_response'))
+
+        requests << stub_request(:post, "https://login.salesforce.com/services/oauth2/token")
+          .with(:body => "grant_type=password&client_id=client_id&client_secret=" \
+          "client_secret&username=foo&password=barsecurity_token")
+          .to_return(status: 200, body: fixture(:auth_success_response))
+
+        requests << stub_request(:get, /query\?q=SELECT%20some,%20fields%20FROM%20object/)
+          .with(headers: { 'Authorization' => "OAuth 00Dx0000000BV7z!AR8AQAxo9UfVkh8AlV0Gomt9Czx9LjHnSSpwBMmbRcgKFmxOtvxjTrKW19ye6PE3Ds1eQz3z8jr3W7_VbWmEu4Q8TVGSTHxs" })
+          .to_return(status: 200, body: fixture('sobject/query_success_response'))
+      end
+    end
+
+    after do
+      @requests.each { |request| request.should have_been_requested }
+    end
+
+    subject { client.query('SELECT some, fields FROM object') }
+    it { should be_an Array }
+  end
 end
 
 describe 'with mashify middleware' do

data/spec/lib/middleware/authentication_spec.rb

@@ -11,7 +11,7 @@ describe Restforce::Middleware::Authentication do
     it 'raises an error' do
       expect {
         middleware.authenticate!
-      }.to raise_error RuntimeError, 'must subclass'
+      }.to raise_error RuntimeError, 'not implemented'
     end
   end
 
@@ -33,21 +33,8 @@ describe Restforce::Middleware::Authentication do
       end
 
       it 'attempts to authenticate' do
-        app.should_receive(:call).once { |env| env[:body] = 'bar'; env[:request] = 'foo'; raise Restforce::UnauthorizedError.new('something bad') }
+        app.should_receive(:call).once.and_raise(Restforce::UnauthorizedError.new('something bad'))
         middleware.should_receive(:authenticate!)
-        app.should_receive(:call).with(body: 'foo', request: { proxy: nil }).once
-        middleware.call(env)
-      end
-    end
-
-    context 'when the retry limit is reached' do
-      before do
-        app.should_receive(:call).twice.and_raise(Restforce::UnauthorizedError)
-        middleware.should_receive(:authenticate!)
-      end
-
-      let(:retries) { 1 }
-      it 'should raise an exception' do
         expect { middleware.call(env) }.to raise_error Restforce::UnauthorizedError
       end
     end
@@ -79,21 +66,4 @@ describe Restforce::Middleware::Authentication do
       end
     end
   end
-
-  describe '.force_authenticate?' do
-    subject { middleware.force_authenticate?(env) }
-
-    context 'without X-ForceAuthenticate header set' do
-      it { should be_false }
-    end
-
-    context 'with X-ForceAuthenticate header set' do
-      before do
-        env[:request_headers] = {}
-        env[:request_headers]['X-ForceAuthenticate'] = true
-      end
-
-      it { should be_true }
-    end
-  end
 end

data/spec/lib/middleware/instance_url_spec.rb

@@ -3,13 +3,15 @@ require 'spec_helper'
 describe Restforce::Middleware::InstanceURL do
   let(:app)        { double('app') }
   let(:client)     { double('client') }
-  let(:options)    { { :instance_url => instance_url } }
+  let(:options)    { { } }
   let(:middleware) { described_class.new app, client, options }
   
   context 'when the instance url is not set' do
-    let(:instance_url) { nil }
+    before do
+      client.stub_chain(:connection, :url_prefix).and_return(URI.parse('http:/'))
+    end
 
-    it 'raises an error' do
+    it 'raises an exception' do
       expect {
         middleware.call(nil)
       }.to raise_error Restforce::UnauthorizedError
@@ -17,32 +19,13 @@ describe Restforce::Middleware::InstanceURL do
   end
 
   context 'when the instance url is set' do
-    let(:instance_url) { 'https://foo.bar' }
-
     before do
-      client.stub_chain(:connection, :url_prefix).and_return URI.parse(url_prefix)
-    end
-
-    context 'and it does not match the connection url prefix' do
-      let(:url_prefix) { 'https://whiz.bang' }
-
-      it 'raises an error' do
-        expect {
-          middleware.call(nil)
-        }.to raise_error Restforce::InstanceURLError
-      end
+      client.stub_chain(:connection, :url_prefix).and_return(URI.parse('http://foobar.com/'))
     end
 
-    context 'and it matches the connection url prefix' do
-      let(:url_prefix) { 'https://foo.bar' }
-      
-      before do
-        app.should_receive(:call)
-      end
-
-      it 'calls tne next middleware' do
-        middleware.call(nil)
-      end
+    it 'does not raise an exception' do
+      app.should_receive(:call).once
+      middleware.call(nil)
     end
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: restforce
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-22 00:00:00.000000000 Z
+date: 2012-09-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rake