Add Faraday extensions

Author: oriolgual

lib/faraday/connection.rb

@@ -0,0 +1,10 @@
+require 'faraday'
+require_relative 'request/digest_authentication'
+
+module Faraday
+  class Connection
+    def digest_auth(user, password)
+      self.builder.insert(0, Faraday::Request::DigestAuth, user, password)
+    end
+  end
+end

lib/faraday/request/digest_authentication.rb

@@ -0,0 +1,45 @@
+require 'faraday'
+require 'net/http/digest_auth'
+
+module Faraday
+  class Request::DigestAuth < Faraday::Middleware
+    def initialize(app, user, password)
+      super(app)
+      @user, @password = user, password
+    end
+
+    def call(env)
+      response = handshake(env)
+      return response unless response.status == 401
+
+      env[:request_headers]['Authorization'] = header(response)
+      @app.call(env)
+    end
+
+    private
+    def handshake(env)
+      env_without_body = env.dup
+      env_without_body.delete(:body)
+
+      @app.call(env_without_body)
+    end
+
+    def header(response)
+      uri = response.env[:url]
+      uri.user = @user
+      uri.password = @password
+
+      realm = response.headers['www-authenticate']
+      method = response.env[:method].to_s.upcase
+
+      digest_auth_header(uri, realm, method)
+    end
+
+    def digest_auth_header(uri, realm, method)
+      digest_auth = Net::HTTP::DigestAuth.new
+      digest_auth.auth_header(uri, realm, method)
+    end
+  end
+end
+
+Faraday.register_middleware :request, digest: Faraday::Request::DigestAuth

test/faraday/connection_test.rb

@@ -0,0 +1,29 @@
+require_relative '../test_helper'
+require 'faraday/connection'
+
+module Faraday
+  describe Connection do
+    describe 'digest_auth' do
+      let(:connection) do
+        Faraday.new('http://api.example.org/') do |builder|
+          builder.request :url_encoded
+          builder.adapter :net_http
+        end
+      end
+
+      it 'inserts the DigestAuth middleware at the top' do
+        connection.digest_auth('user', 'password')
+
+        connection.builder.handlers.first.klass.must_equal Faraday::Request::DigestAuth
+      end
+
+      it 'passes the user and password to the middleware' do
+        connection.digest_auth('user', 'password')
+
+        Faraday::Request::DigestAuth.expects(:new).with(anything, 'user', 'password').returns(stub_everything)
+
+        connection.get('/')
+      end
+    end
+  end
+end

test/faraday/digest_authentication_test.rb

@@ -0,0 +1,41 @@
+require_relative '../test_helper'
+require 'faraday/request/digest_authentication'
+
+module Faraday
+  describe Request::DigestAuth do
+    let(:connection) do
+      Faraday.new('http://api.example.org/') do |builder|
+        builder.request :digest, 'USER', 'PASS'
+        builder.adapter :net_http
+      end
+    end
+
+    describe 'when the server does not return a 401' do
+      it 'does nothing' do
+        stub_request(:get, 'http://api.example.org/productions/1').
+          to_return(status: 500, body: 'Foo body')
+
+        response = connection.get('/productions/1')
+        response.body.must_equal 'Foo body'
+      end
+    end
+
+    describe 'when the server returns a 401' do
+      let(:first_call_headers) { 'Digest realm="MyApp", algorithm=MD5' }
+      let(:second_call_headers) { 'Digest username="USER", realm="MyApp", uri="/", algorithm="MD5"' }
+      it 'authenticates using digest' do
+        stub_request(:get, 'http://api.example.org/productions/1').
+          with(body: nil).
+          to_return(status: 401, headers: {'www-authenticate' => first_call_headers})
+
+        stub_request(:get, 'http://api.example.org/productions/1').
+          with(body: "{\"foo\":1}",
+               headers: {'Authorization' => %r{second_call_headers}}).
+               to_return(body: '{"resource": "This is the resource"}',
+                         headers: {content_type: 'application/json'})
+
+        connection.get('/productions/1')
+      end
+    end
+  end
+end