excon 0.45.4 → 0.46.0

data/excon.gemspec

@@ -13,8 +13,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'excon'
-  s.version           = '0.45.4'
-  s.date              = '2015-07-13'
+  s.version           = '0.46.0'
+  s.date              = '2016-02-26'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -62,6 +62,7 @@ Gem::Specification.new do |s|
   s.add_development_dependency('rdoc')
   s.add_development_dependency('shindo')
   s.add_development_dependency('sinatra')
+  s.add_development_dependency('sinatra-contrib')
   s.add_development_dependency('json', '>= 1.8.2')
 
   ## Leave this section as-is. It will be automatically generated from the
@@ -104,6 +105,7 @@ Gem::Specification.new do |s|
     lib/excon/extensions/uri.rb
     lib/excon/headers.rb
     lib/excon/middlewares/base.rb
+    lib/excon/middlewares/capture_cookies.rb
     lib/excon/middlewares/decompress.rb
     lib/excon/middlewares/escape_path.rb
     lib/excon/middlewares/expects.rb
@@ -131,6 +133,7 @@ Gem::Specification.new do |s|
     tests/errors_tests.rb
     tests/header_tests.rb
     tests/middlewares/canned_response_tests.rb
+    tests/middlewares/capture_cookies_tests.rb
     tests/middlewares/decompress_tests.rb
     tests/middlewares/escape_path_tests.rb
     tests/middlewares/idempotent_tests.rb
@@ -147,6 +150,7 @@ Gem::Specification.new do |s|
     tests/rackups/proxy.ru
     tests/rackups/query_string.ru
     tests/rackups/redirecting.ru
+    tests/rackups/redirecting_with_cookie.ru
     tests/rackups/request_headers.ru
     tests/rackups/request_methods.ru
     tests/rackups/response_header.ru

data/lib/excon.rb

@@ -30,6 +30,7 @@ require 'excon/response'
 require 'excon/middlewares/decompress'
 require 'excon/middlewares/escape_path'
 require 'excon/middlewares/redirect_follower'
+require 'excon/middlewares/capture_cookies'
 require 'excon/pretty_printer'
 require 'excon/socket'
 require 'excon/ssl_socket'

data/lib/excon/connection.rb

@@ -207,7 +207,7 @@ module Excon
       datum[:headers] = @data[:headers].merge(datum[:headers] || {})
 
       if datum[:scheme] == UNIX
-        datum[:headers]['Host']   ||= '' << datum[:socket]
+        datum[:headers]['Host']   = ''
       else
         datum[:headers]['Host']   ||= '' << datum[:host] << port_string(datum)
       end

data/lib/excon/constants.rb

@@ -1,6 +1,6 @@
 module Excon
 
-  VERSION = '0.45.4'
+  VERSION = '0.46.0'
 
   CR_NL = "\r\n"
 

data/lib/excon/errors.rb

@@ -8,7 +8,7 @@ module Excon
     class SocketError < Error
       attr_reader :socket_error
 
-      def initialize(socket_error=Excon::Error.new)
+      def initialize(socket_error=Excon::Errors::Error.new)
         if socket_error.message =~ /certificate verify failed/
           super("Unable to verify certificate, please set `Excon.defaults[:ssl_ca_path] = path_to_certs`, `ENV['SSL_CERT_DIR'] = path_to_certs`, `Excon.defaults[:ssl_ca_file] = path_to_file`, `ENV['SSL_CERT_FILE'] = path_to_file`, `Excon.defaults[:ssl_verify_callback] = callback` (see OpenSSL::SSL::SSLContext#verify_callback), or `Excon.defaults[:ssl_verify_peer] = false` (less secure).")
         else

data/lib/excon/middlewares/capture_cookies.rb

@@ -0,0 +1,31 @@
+module Excon
+  module Middleware
+    class CaptureCookies < Excon::Middleware::Base
+
+      def extract_cookies_from_set_cookie(set_cookie)
+        set_cookie.split(',').map { |full| full.split(';').first.strip }.join('; ')
+      end
+
+      def get_header(datum, header)
+        _, header_value = datum[:response][:headers].detect do |key, value|
+          key.casecmp(header) == 0
+        end
+        header_value
+      end
+
+      def response_call(datum)
+        cookie = get_header(datum, 'Set-Cookie')
+        if cookie
+          cookie = extract_cookies_from_set_cookie(cookie)
+          unless datum[:headers].key?("Cookie")
+            datum[:headers]["Cookie"] = cookie
+          else
+            original_cookies = datum[:headers]["Cookie"]
+            datum[:headers]["Cookie"] = original_cookies.empty? ? cookie : [original_cookies,cookie].join('; ')
+          end
+        end
+        super(datum)
+      end
+    end
+  end
+end

data/lib/excon/middlewares/decompress.rb

@@ -12,16 +12,17 @@ module Excon
       end
 
       def response_call(datum)
-        unless datum.has_key?(:response_block)
+        body = datum[:response][:body]
+        unless datum.has_key?(:response_block) || body.nil? || body.empty?
           if key = datum[:response][:headers].keys.detect {|k| k.casecmp('Content-Encoding') == 0 }
             encodings = Utils.split_header_value(datum[:response][:headers][key])
             if encoding = encodings.last
               if encoding.casecmp('deflate') == 0
                 # assume inflate omits header
-                datum[:response][:body] = Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(datum[:response][:body])
+                datum[:response][:body] = Zlib::Inflate.new(-Zlib::MAX_WBITS).inflate(body)
                 encodings.pop
               elsif encoding.casecmp('gzip') == 0 || encoding.casecmp('x-gzip') == 0
-                datum[:response][:body] = Zlib::GzipReader.new(StringIO.new(datum[:response][:body])).read
+                datum[:response][:body] = Zlib::GzipReader.new(StringIO.new(body)).read
                 encodings.pop
               end
               datum[:response][:headers][key] = encodings.join(', ')

data/lib/excon/middlewares/redirect_follower.rb

@@ -1,14 +1,21 @@
 module Excon
   module Middleware
     class RedirectFollower < Excon::Middleware::Base
+
+      def get_header(datum, header)
+        _, header_value = datum[:response][:headers].detect do |key, value|
+          key.casecmp(header) == 0
+        end
+        header_value
+      end
+
       def response_call(datum)
         if datum.has_key?(:response)
           case datum[:response][:status]
           when 301, 302, 303, 307, 308
             uri_parser = datum[:uri_parser] || Excon.defaults[:uri_parser]
-            _, location = datum[:response][:headers].detect do |key, value|
-              key.casecmp('Location') == 0
-            end
+
+            location = get_header(datum, 'Location')
             uri = uri_parser.parse(location)
 
             # delete old/redirect response

data/lib/excon/response.rb

@@ -16,17 +16,20 @@ module Excon
     def headers
       @data[:headers]
     end
-    def status=(new_status)
-      @data[:status] = new_status
+    def host
+      @data[:host]
     end
-    def status
-      @data[:status]
+    def local_address
+      @data[:local_address]
     end
-    def status_line
-      @data[:status_line]
+    def local_port
+      @data[:local_port]
     end
-    def status_line=(new_status_line)
-      @data[:status_line] = new_status_line
+    def path
+      @data[:path]
+    end
+    def port
+      @data[:port]
     end
     def reason_phrase=(new_reason_phrase)
       @data[:reason_phrase] = new_reason_phrase
@@ -40,11 +43,17 @@ module Excon
     def remote_ip
       @data[:remote_ip]
     end
-    def local_port
-      @data[:local_port]
+    def status=(new_status)
+      @data[:status] = new_status
     end
-    def local_address
-      @data[:local_address]
+    def status
+      @data[:status]
+    end
+    def status_line
+      @data[:status_line]
+    end
+    def status_line=(new_status_line)
+      @data[:status_line] = new_status_line
     end
 
     def self.parse(socket, datum)
@@ -57,7 +66,10 @@ module Excon
 
       datum[:response] = {
         :body          => '',
+        :host          => datum[:host],
         :headers       => Excon::Headers.new,
+        :path          => datum[:path],
+        :port          => datum[:port],
         :status        => status,
         :status_line   => line,
         :reason_phrase => reason_phrase
@@ -100,25 +112,27 @@ module Excon
           if response_block
             while (chunk_size = socket.readline.chomp!.to_i(16)) > 0
               while chunk_size > 0
-                chunk = socket.read(chunk_size)
+                chunk = socket.read(chunk_size) || raise(EOFError)
                 chunk_size -= chunk.bytesize
                 response_block.call(chunk, nil, nil)
               end
               new_line_size = 2 # 2 == "\r\n".length
               while new_line_size > 0
-                new_line_size -= socket.read(new_line_size).length
+                chunk = socket.read(new_line_size) || raise(EOFError)
+                new_line_size -= chunk.length
               end
             end
           else
             while (chunk_size = socket.readline.chomp!.to_i(16)) > 0
               while chunk_size > 0
-                chunk = socket.read(chunk_size)
+                chunk = socket.read(chunk_size) || raise(EOFError)
                 chunk_size -= chunk.bytesize
                 datum[:response][:body] << chunk
               end
               new_line_size = 2 # 2 == "\r\n".length
               while new_line_size > 0
-                new_line_size -= socket.read(new_line_size).length
+                chunk = socket.read(new_line_size) || raise(EOFError)
+                new_line_size -= chunk.length
               end
             end
           end
@@ -131,13 +145,13 @@ module Excon
           if remaining = content_length
             if response_block
               while remaining > 0
-                chunk = socket.read([datum[:chunk_size], remaining].min)
+                chunk = socket.read([datum[:chunk_size], remaining].min) || raise(EOFError)
                 response_block.call(chunk, [remaining - chunk.bytesize, 0].max, content_length)
                 remaining -= chunk.bytesize
               end
             else
               while remaining > 0
-                chunk = socket.read([datum[:chunk_size], remaining].min)
+                chunk = socket.read([datum[:chunk_size], remaining].min) || raise(EOFError)
                 datum[:response][:body] << chunk
                 remaining -= chunk.bytesize
               end
@@ -160,7 +174,7 @@ module Excon
 
     def self.parse_headers(socket, datum)
       last_key = nil
-      until (data = socket.readline.chomp!).empty?
+      until (data = socket.readline.chomp).empty?
         if !data.lstrip!.nil?
           raise Excon::Errors::ResponseParseError, 'malformed header' unless last_key
           # append to last_key's last value

data/lib/excon/utils.rb

@@ -40,11 +40,12 @@ module Excon
       when Hash
         str << '?'
         datum[:query].sort_by {|k,_| k.to_s }.each do |key, values|
+          key = CGI.escape(key.to_s)
           if values.nil?
-            str << key.to_s << '&'
+            str << key << '&'
           else
             [values].flatten.each do |value|
-              str << key.to_s << '=' << CGI.escape(value.to_s) << '&'
+              str << key << '=' << CGI.escape(value.to_s) << '&'
             end
           end
         end

data/tests/basic_tests.rb

@@ -1,3 +1,5 @@
+require 'json'
+
 Shindo.tests('Excon basics') do
   with_rackup('basic.ru') do
     basic_tests
@@ -246,6 +248,19 @@ Shindo.tests('Excon basics (Unix socket)') do
         response[:status]
       end
     end
+
+    tests('http Host header is empty') do
+      tests('GET /headers').returns("") do
+        connection = Excon::Connection.new({
+          :socket           => file_name,
+          :nonblock         => false,
+          :scheme           => 'unix',
+          :ssl_verify_peer  => false
+        })
+        response = connection.request(:method => :get, :path => '/headers')
+        JSON.parse(response.body)['HTTP_HOST']
+      end
+    end
   end
 end
 

data/tests/middlewares/capture_cookies_tests.rb

@@ -0,0 +1,34 @@
+Shindo.tests("Excon redirecting with cookie preserved") do
+  env_init
+
+  with_rackup('redirecting_with_cookie.ru') do
+    tests('second request will send cookies set by the first').returns('ok') do
+      Excon.get(
+        'http://127.0.0.1:9292',
+        :path         => '/sets_cookie',
+        :middlewares  => Excon.defaults[:middlewares] + [Excon::Middleware::CaptureCookies, Excon::Middleware::RedirectFollower]
+      ).body
+    end
+
+    tests('second request will send multiple cookies set by the first').returns('ok') do
+      Excon.get(
+        'http://127.0.0.1:9292',
+        :path         => '/sets_multi_cookie',
+        :middlewares  => Excon.defaults[:middlewares] + [Excon::Middleware::CaptureCookies, Excon::Middleware::RedirectFollower]
+      ).body
+    end
+  end
+
+  with_rackup('redirecting.ru') do
+    tests("runs normally when there are no cookies set").returns('ok') do
+      Excon.post(
+        'http://127.0.0.1:9292',
+        :path         => '/first',
+        :middlewares  => Excon.defaults[:middlewares] + [Excon::Middleware::CaptureCookies, Excon::Middleware::RedirectFollower],
+        :body => "a=Some_content"
+      ).body
+    end
+  end
+
+  env_restore
+end

data/tests/middlewares/decompress_tests.rb

@@ -29,6 +29,11 @@ Shindo.tests('Excon Decompress Middleware') do
       tests('removes processed encoding from header').returns('') do
         resp[:headers]['Content-Encoding']
       end
+
+      tests('empty response body').returns('') do
+        resp = @connection.request(:body => '')
+        resp[:body]
+      end
     end
 
     tests('deflate') do

data/tests/query_string_tests.rb

@@ -52,12 +52,12 @@ Shindo.tests('Excon query string variants') do
       response = connection.request(:method => :get, :path => '/query', :query => {'foo[]' => ['bar', 'baz'], :me => 'too'})
       query_string = response.body[7..-1] # query string sent
 
-      test("query string sent includes 'foo[]=bar'") do
-        query_string.split('&').include?('foo[]=bar')
+      test("query string sent includes 'foo%5B%5D=bar'") do
+        query_string.split('&').include?('foo%5B%5D=bar')
       end
 
-      test("query string sent includes 'foo[]=baz'") do
-        query_string.split('&').include?('foo[]=baz')
+      test("query string sent includes 'foo%5B%5D=baz'") do
+        query_string.split('&').include?('foo%5B%5D=baz')
       end
 
       test("query string sent includes 'me=too'") do
@@ -65,5 +65,23 @@ Shindo.tests('Excon query string variants') do
       end
     end
 
+    tests(":query => {'foo%=#' => 'bar%=#'}") do
+      response = connection.request(:method => :get, :path => '/query', :query => {'foo%=#' => 'bar%=#'})
+      query_string = response.body[7..-1] # query string sent
+
+      tests("query string sent").returns('foo%25%3D%23=bar%25%3D%23') do
+        query_string
+      end
+    end
+
+    tests(":query => {'foo%=#' => nil}") do
+      response = connection.request(:method => :get, :path => '/query', :query => {'foo%=#' => nil})
+      query_string = response.body[7..-1] # query string sent
+
+      tests("query string sent").returns('foo%25%3D%23') do
+        query_string
+      end
+    end
+
   end
 end

data/tests/rackups/basic.rb

@@ -1,4 +1,5 @@
 require 'sinatra'
+require 'json'
 require File.join(File.dirname(__FILE__), 'webrick_patch')
 
 class Basic < Sinatra::Base
@@ -10,6 +11,11 @@ class Basic < Sinatra::Base
     'x' * value.to_i
   end
 
+  get('/headers') do
+    content_type :json
+    request.env.select{|key, _| key.start_with? 'HTTP_'}.to_json
+  end
+
   post('/body-sink') do
     request.body.read.size.to_s
   end

data/tests/rackups/redirecting_with_cookie.ru

@@ -0,0 +1,40 @@
+require 'sinatra'
+require 'sinatra/cookies'
+require 'json'
+require File.join(File.dirname(__FILE__), 'webrick_patch')
+
+class App < Sinatra::Base
+  helpers Sinatra::Cookies
+  set :environment, :production
+  enable :dump_errors
+
+  get('/sets_cookie') do
+    cookies[:chocolatechip] = "chunky"
+    redirect "/requires_cookie"
+  end
+
+  get('/requires_cookie') do
+    cookie = cookies[:chocolatechip]
+    unless cookie.nil? || cookie != "chunky"
+      "ok"
+    else
+      JSON.pretty_generate(headers)
+    end
+  end
+  
+  get('/sets_multi_cookie') do
+    cookies[:chocolatechip] = "chunky"
+    cookies[:thinmints] = "minty"
+    redirect "/requires_cookie"
+  end
+
+  get('/requires_cookie') do
+    if cookies[:chocolatechip] == "chunky" && cookies[:thinmints] == "minty" 
+      "ok"
+    else
+      JSON.pretty_generate(headers)
+    end
+  end
+end
+
+run App