faraday 0.5.7 → 0.6.0

data/lib/faraday/utils.rb

@@ -6,22 +6,64 @@ module Faraday
     extend Rack::Utils
     extend self
 
-    HEADERS = Hash.new do |h, k|
-      if k.respond_to?(:to_str)
-        k
-      else
-        k.to_s.split('_').            # :user_agent => %w(user agent)
-          each { |w| w.capitalize! }. # => %w(User Agent)
-          join('-')                   # => "User-Agent"
+    class Headers < HeaderHash
+      # symbol -> string mapper + cache
+      KeyMap = Hash.new do |map, key|
+        map[key] = if key.respond_to?(:to_str) then key
+        else
+          key.to_s.split('_').            # :user_agent => %w(user agent)
+            each { |w| w.capitalize! }.   # => %w(User Agent)
+            join('-')                     # => "User-Agent"
+        end
+      end
+      KeyMap[:etag] = "ETag"
+      
+      def [](k)
+        super(KeyMap[k])
       end
-    end
 
-    HEADERS.merge! :etag => "ETag"
-    HEADERS.values.each { |v| v.freeze }
+      def []=(k, v)
+        # join multiple values with a comma
+        v = v.to_ary.join(', ') if v.respond_to? :to_ary
+        super(KeyMap[k], v)
+      end
+      
+      alias_method :update, :merge!
+      
+      def parse(header_string)
+        return unless header_string && !header_string.empty?
+        header_string.split(/\r\n/).
+          tap  { |a| a.shift if a.first.index('HTTP/') == 0 }. # drop the HTTP status line
+          map  { |h| h.split(/:\s+/, 2) }.reject { |(k, v)| k.nil? }. # split key and value, ignore blank lines
+          each { |key, value|
+            # join multiple values with a comma
+            if self[key] then self[key] << ', ' << value
+            else self[key] = value
+            end
+          }
+      end
+    end
 
     # Make Rack::Utils build_query method public.
     public :build_query
 
+    # Override Rack's version since it doesn't handle non-String values
+    def build_nested_query(value, prefix = nil)
+      case value
+      when Array
+        value.map { |v| build_nested_query(v, "#{prefix}[]") }.join("&")
+      when Hash
+        value.map { |k, v|
+          build_nested_query(v, prefix ? "#{prefix}[#{escape(k)}]" : escape(k))
+        }.join("&")
+      when NilClass
+        prefix
+      else
+        raise ArgumentError, "value must be a Hash" if prefix.nil?
+        "#{prefix}=#{escape(value)}"
+      end
+    end
+
     # Be sure to URI escape '+' symbols to %2B. Otherwise, they get interpreted
     # as spaces.
     def escape(s)
@@ -37,15 +79,10 @@ module Faraday
       end
     end
 
-    # Turns headers keys and values into strings.  Look up symbol keys in the
-    # the HEADERS hash.
-    #
-    #   h = merge_headers(HeaderHash.new, :content_type => 'text/plain')
-    #   h['Content-Type'] # = 'text/plain'
-    #
+    # Turns headers keys and values into strings
     def merge_headers(existing_headers, new_headers)
       new_headers.each do |key, value|
-        existing_headers[HEADERS[key]] = value.to_s
+        existing_headers[key] = value.to_s
       end
     end
 

data/test/adapters/live_test.rb

@@ -1,12 +1,19 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
 
-if Faraday::TestCase::LIVE_SERVER
+if !Faraday::TestCase::LIVE_SERVER
+  warn "warning: test server is not up; skipping live server tests"
+else
   module Adapters
     class LiveTest < Faraday::TestCase
-      loaded_adapters  = Faraday::Adapter.all_loaded_constants
-      loaded_adapters -= [Faraday::Adapter::ActionDispatch]
-      loaded_adapters << :default
-      loaded_adapters.each do |adapter|
+      adapters = if ENV['ADAPTER']
+        ENV['ADAPTER'].split(':').map { |name| Faraday::Adapter.lookup_module name.to_sym }
+      else
+        loaded_adapters  = Faraday::Adapter.all_loaded_constants
+        loaded_adapters -= [Faraday::Adapter::ActionDispatch]
+        loaded_adapters << :default
+      end
+
+      adapters.each do |adapter|
         define_method "test_#{adapter}_GET_retrieves_the_response_body" do
           assert_equal 'hello world', create_connection(adapter).get('hello_world').body
         end
@@ -19,7 +26,17 @@ if Faraday::TestCase::LIVE_SERVER
         end
 
         define_method "test_#{adapter}_GET_retrieves_the_response_headers" do
-          assert_match /text\/html/, create_connection(adapter).get('hello_world').headers['content-type']
+          response = create_connection(adapter).get('hello_world')
+          assert_match /text\/html/, response.headers['Content-Type'], 'original case fail'
+          assert_match /text\/html/, response.headers['content-type'], 'lowercase fail'
+        end
+
+        # https://github.com/geemus/excon/issues/10
+        unless %[Faraday::Adapter::Excon] == adapter.to_s
+          define_method "test_#{adapter}_GET_handles_headers_with_multiple_values" do
+            response = create_connection(adapter).get('multi')
+            assert_equal 'one, two', response.headers['set-cookie']
+          end
         end
 
         define_method "test_#{adapter}_POST_send_url_encoded_params" do
@@ -43,13 +60,12 @@ if Faraday::TestCase::LIVE_SERVER
         end
 
         define_method "test_#{adapter}_POST_sends_files" do
-          name = File.join(File.dirname(__FILE__), '..', 'live_server.rb')
           resp = create_connection(adapter).post do |req|
             req.url 'file'
-            req.body = {'uploaded_file' => Faraday::UploadIO.new(name, 'text/x-ruby')}
+            req.body = {'uploaded_file' => Faraday::UploadIO.new(__FILE__, 'text/x-ruby')}
           end
-          assert_equal "file live_server.rb text/x-ruby", resp.body
-        end
+          assert_equal "file live_test.rb text/x-ruby", resp.body
+        end unless :default == adapter # isn't configured for multipart
 
         # http://github.com/toland/patron/issues/#issue/9
         if ENV['FORCE'] || adapter != Faraday::Adapter::Patron
@@ -142,13 +158,19 @@ if Faraday::TestCase::LIVE_SERVER
 
       def create_connection(adapter)
         if adapter == :default
-          conn = Faraday.default_connection
-          conn.url_prefix = LIVE_SERVER
-          conn
+          Faraday.default_connection.tap do |conn|
+            conn.url_prefix = LIVE_SERVER
+            conn.headers['X-Faraday-Adapter'] = adapter.to_s
+          end
         else
-          Faraday::Connection.new LIVE_SERVER do |b|
+          Faraday::Connection.new LIVE_SERVER, :headers => {'X-Faraday-Adapter' => adapter.to_s} do |b|
+            b.request :multipart
+            b.request :url_encoded
             b.use adapter
           end
+        end.tap do |conn|
+          target = conn.builder.handlers.last
+          conn.builder.insert_before target, Faraday::Response::RaiseError
         end
       end
 

data/test/adapters/logger_test.rb

@@ -10,7 +10,7 @@ module Adapters
       @logger.level = Logger::DEBUG
 
       @conn = Faraday.new do |b|
-        b.adapter :logger, @logger
+        b.response :logger, @logger
         b.adapter :test do |stubs|
           stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
         end

data/test/adapters/net_http_test.rb

@@ -0,0 +1,33 @@
+require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
+
+module Adapters
+  class NetHttpTest < Faraday::TestCase
+    def setup
+      @connection = Faraday.new('http://disney.com') do |b|
+        b.adapter :net_http
+      end
+    end
+
+    def test_handles_compression_transparently_on_get
+      stub_request(:get, 'disney.com/hello').with { |request|
+        accept_encoding = request.headers['Accept-Encoding']
+        if RUBY_VERSION.index('1.8') == 0
+          # ruby 1.8 doesn't do any gzip/deflate automatically
+          accept_encoding == nil
+        else
+          # test for a value such as "gzip;q=1.0,deflate;q=0.6,identity;q=0.3"
+          accept_encoding =~ /gzip;.+\bdeflate\b/
+        end
+      }
+      @connection.get('/hello')
+    end
+
+    def test_connect_error_gets_wrapped
+      stub_request(:get, 'disney.com/hello').to_raise(Errno::ECONNREFUSED)
+
+      assert_raise Faraday::Error::ConnectionFailed do
+        @connection.get('/hello')
+      end
+    end
+  end
+end

data/test/connection_test.rb

@@ -242,43 +242,4 @@ class TestConnection < Faraday::TestCase
       assert_not_equal conn.send(attr).object_id, duped.send(attr).object_id
     end
   end
-
-  def test_allows_rebuilding_of_connection_handlers
-    conn  = Faraday::Connection.new
-    conn.to_app
-    inner = conn.builder.handlers[0]
-    mware = conn.builder.handlers[1].call({})
-    assert_kind_of Faraday::Adapter::NetHttp, mware
-
-    conn.build do |b|
-      b.adapter :test
-    end
-    mware = conn.builder.handlers[1].call({})
-    assert_kind_of Faraday::Adapter::Test, mware
-    assert_equal   inner,                  conn.builder.handlers[0]
-  end
-
-  def test_allows_extending_of_existing_connection_handlers
-    conn  = Faraday::Connection.new
-    conn.to_app
-    mware = conn.builder.handlers[1].call({})
-    assert_kind_of Faraday::Adapter::NetHttp, mware
-    assert_equal   2,                         conn.builder.handlers.size
-
-    conn.build :keep => true do |b|
-      b.adapter :test
-    end
-    mware = conn.builder.handlers[1].call({})
-    assert_kind_of Faraday::Adapter::Test, mware
-    assert_equal   3,                      conn.builder.handlers.size
-  end
-
-  def test_sets_default_adapter_if_none_set
-    conn  = Faraday::Connection.new
-    assert_equal 0, conn.builder.handlers.size
-
-    app   = conn.to_app
-    mware = conn.builder.handlers[1].call({})
-    assert_kind_of Faraday::Adapter::NetHttp, mware
-  end
 end

data/test/env_test.rb

@@ -1,15 +1,13 @@
 require File.expand_path(File.join(File.dirname(__FILE__), 'helper'))
 
-class TestEnv < Faraday::TestCase
+class EnvTest < Faraday::TestCase
   def setup
     @conn = Faraday.new :url => 'http://sushi.com/api', :headers => {'Mime-Version' => '1.0'}
     @conn.options[:timeout]      = 3
     @conn.options[:open_timeout] = 5
     @conn.ssl[:verify]           = false
     @conn.proxy 'http://proxy.com'
-    @input = {
-      :body    => 'abc',
-      :headers => {'Server' => 'Faraday'}}
+    @input = { :body => 'abc' }
     @env = env_for @conn do |req|
       req.url 'foo.json', 'a' => 1
       req['Server'] = 'Faraday'
@@ -26,8 +24,9 @@ class TestEnv < Faraday::TestCase
   end
 
   def test_request_create_stores_headers
-    assert_kind_of Rack::Utils::HeaderHash, @env[:request_headers]
-    assert_equal @input[:headers].merge('Mime-Version' => '1.0'), @env[:request_headers]
+    headers = @env[:request_headers]
+    assert_equal '1.0', headers['mime-version']
+    assert_equal 'Faraday', headers['server']
   end
 
   def test_request_create_stores_body
@@ -54,3 +53,82 @@ class TestEnv < Faraday::TestCase
     env_setup.to_env_hash(connection, :get)
   end
 end
+
+class HeadersTest < Faraday::TestCase
+  def setup
+    @headers = Faraday::Utils::Headers.new
+  end
+
+  def test_parse_response_headers_leaves_http_status_line_out
+    @headers.parse("HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n")
+    assert_equal %w(Content-Type), @headers.keys
+  end
+
+  def test_parse_response_headers_parses_lower_cased_header_name_and_value
+    @headers.parse("HTTP/1.1 200 OK\r\nContent-Type: text/html\r\n\r\n")
+    assert_equal 'text/html', @headers['content-type']
+  end
+
+  def test_parse_response_headers_parses_lower_cased_header_name_and_value_with_colon
+    @headers.parse("HTTP/1.1 200 OK\r\nContent-Type: text/html\r\nLocation: http://sushi.com/\r\n\r\n")
+    assert_equal 'http://sushi.com/', @headers['location']
+  end
+
+  def test_parse_response_headers_parses_blank_lines
+    @headers.parse("HTTP/1.1 200 OK\r\n\r\nContent-Type: text/html\r\n\r\n")
+    assert_equal 'text/html', @headers['content-type']
+  end
+end
+
+class ResponseTest < Faraday::TestCase
+  def setup
+    @env = {
+      :status => 404, :body => 'yikes',
+      :response_headers => Faraday::Utils::Headers.new('Content-Type' => 'text/plain')
+    }
+    @response = Faraday::Response.new @env
+  end
+  
+  def test_finished
+    assert @response.finished?
+  end
+  
+  def test_error_on_finish
+    assert_raises RuntimeError do
+      @response.finish({})
+    end
+  end
+  
+  def test_not_success
+    assert !@response.success?
+  end
+  
+  def test_status
+    assert_equal 404, @response.status
+  end
+  
+  def test_body
+    assert_equal 'yikes', @response.body
+  end
+  
+  def test_headers
+    assert_equal 'text/plain', @response.headers['Content-Type']
+    assert_equal 'text/plain', @response['content-type']
+  end
+  
+  def test_apply_request
+    @response.apply_request :body => 'a=b', :method => :post
+    assert_equal 'yikes', @response.body
+    assert_equal :post, @response.env[:method]
+  end
+  
+  def test_marshal
+    @response = Faraday::Response.new
+    @response.on_complete { }
+    @response.finish @env.merge(:custom => 'moo')
+    
+    loaded = Marshal.load Marshal.dump(@response)
+    assert_nil loaded.env[:custom]
+    assert_equal %w[body response_headers status], loaded.env.keys.map { |k| k.to_s }.sort
+  end
+end

data/test/helper.rb

@@ -1,8 +1,13 @@
-require 'rubygems'
-gem 'rack',        '>= 1.2.1'
-gem 'addressable', '>= 2.2.2'
-
 require 'test/unit'
+unless ENV['BUNDLE_GEMFILE']
+  require 'rubygems'
+  require 'bundler'
+  Bundler.setup
+end
+
+require 'webmock/test_unit'
+WebMock.disable_net_connect!(:allow_localhost => true)
+
 if ENV['LEFTRIGHT']
   begin
     require 'leftright'
@@ -11,14 +16,18 @@ if ENV['LEFTRIGHT']
   end
 end
 
-$LOAD_PATH.unshift(File.dirname(__FILE__))
-$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+unless $LOAD_PATH.include? 'lib'
+  $LOAD_PATH.unshift(File.dirname(__FILE__))
+  $LOAD_PATH.unshift(File.join($LOAD_PATH.first, '..', 'lib'))
+end
 require 'faraday'
 
 begin
   require 'ruby-debug'
-  Debugger.start
 rescue LoadError
+  # ignore
+else
+  Debugger.start
 end
 
 module Faraday
@@ -31,6 +40,6 @@ module Faraday
 
     def test_default
       assert true
-    end
+    end unless defined? ::MiniTest
   end
 end

data/test/live_server.rb

@@ -1,39 +1,41 @@
 require 'sinatra'
+set :logging, false
 
 get '/hello_world' do
   'hello world'
 end
 
 get '/json' do
+  content_type 'application/json'
   "[1,2,3]"
 end
 
 post '/file' do
-  "file %s %s" % [
-    params[:uploaded_file][:filename],
-    params[:uploaded_file][:type]]
+  if params[:uploaded_file].respond_to? :each_key
+    "file %s %s" % [
+      params[:uploaded_file][:filename],
+      params[:uploaded_file][:type]]
+  else
+    status 400
+  end
 end
 
-post '/hello' do
-  "hello #{params[:name]}"
+%w[get post].each do |method|
+  send(method, '/hello') do
+    "hello #{params[:name]}"
+  end
 end
 
-get '/hello' do
-  "hello #{params[:name]}"
-end
-
-post '/echo_name' do
-  params[:name].inspect
-end
-
-put '/echo_name' do
-  params[:name].inspect
+%w[post put].each do |method|
+  send(method, '/echo_name') do
+    params[:name].inspect
+  end
 end
 
 delete '/delete_with_json' do
   %/{"deleted":true}/
 end
 
-delete '/delete_with_params' do
-  params[:deleted]
+get '/multi' do
+  [200, { 'Set-Cookie' => %w[ one two ] }, '']
 end