excon 0.32.1 → 0.33.0

checksums.yaml

@@ -1,15 +1,15 @@
 ---
 !binary "U0hBMQ==":
   metadata.gz: !binary |-
-    ZjhlZWY0ODAzZTA3MjhjOWE5ZWQwY2Y1ZWY5MmYzMTBmODEyMDBjZg==
+    Y2YwNTZjYTAxYWZmNGIwNjc1NTZiN2EzNTkzYTgzM2YyNGFiYzZiMw==
   data.tar.gz: !binary |-
-    MWE0YmVlNmJiNmM2ZjYyYWVmMGYyNzJhZGRiOGU0MjFlMTgwNzk2ZQ==
+    NjkwYzY3MDg3NzIwNzZmNzU3MTRiMzQxMjc5MjliMTBlYzNlNGMwNQ==
 SHA512:
   metadata.gz: !binary |-
-    ZTJiNzg1Zjc1YmIzZmViZDhmYjFhYmIzM2QwYjllM2E0YmY1ZWJlMzNjNDY2
-    N2E2ZGUwYjJmNjQzOTNhYTg3NjVjYWNkNWRkNGQ3YTZlZjM3ZDFjMDIzZjEw
-    YWQ5ZmUxYzdlZmNlNTA2MzBmMDRlZDEyODc0N2Q1MmQyYjIwMjM=
+    YzZmM2U5MmIxNjRjMzQ0OWI3Yjg1ODE4ODBmN2IzM2RjYjcyNzRjYjlkOGVi
+    YTE1OWJkNTBiNTgwYzUyMjY1NzUxOTIyN2U5NjY1MTNiMzRhYjU1ZDEyOGVi
+    ZTY1YTQ3NWE1MjBmNGFiNzgwMWMxNjdhM2NjOTI1NTA2YjMyODY=
   data.tar.gz: !binary |-
-    NzE1MTI2MmFhYWU4MTczZGUwNzZhZTAyMTcwNjAwM2NiM2ZmN2E2ZGIxMjQ5
-    YzYxM2JjZjU3NDE3NDhhNzlmYjRhMjY1ZGNiNGRlN2IxN2E0NjcyOWU0N2U0
-    MzRlNzk1Yjk5NmNhYjQ0NGQwOTBhOGRmYzc2MDhjYjE2ODRmMWY=
+    MTlhYzI2Y2Y0NWM2Y2ViZTAyM2MzNTdjN2YzMmIwOGQ1MTgzNzQwNDE1ODlj
+    OThhZTg1NDRkYTRhNWUzNzE2NGU5NTRiMjY2Y2Y2MjVkN2E5ZWQzYzUwYjY2
+    NTI3ZmJjYjA1MjA1MzBhZWZiYmU5YTY0YWRmZGM2YTcwOGFhYzI=

data/CONTRIBUTORS.md

@@ -1,6 +1,8 @@
 * Andrew Katz <andrew.katz@outright.com>
 * Anshul Khandelwal <anshul@anshulkhandelwal.com>
+* Ash Wilson <smashwilson@gmail.com>
 * Ben Burkert <ben@benburkert.com>
+* Bo Jeanes <me@bjeanes.com>
 * Brandur <brandur@mutelight.org>
 * Brian D. Burns <iosctr@gmail.com>
 * Brian Hartsock <brian.hartsock@gmail.com>
@@ -29,6 +31,7 @@
 * Jonas Pfenniger <jonas@pfenniger.name>
 * Jonathan Dance <github@wuputah.com>
 * Jonathan Dance <jd@wuputah.com>
+* Jonathan Roes <jroes@jroes.net>
 * Joshua Mckinney <joshmckin@gmail.com>
 * Joshua Napoli <jnapoli@swipely-napoli.home>
 * Joshua Napoli <jnapoli@swipely-napoli.local>
@@ -86,5 +89,6 @@
 * rin_ne <rinrin.ne@gmail.com>
 * rinrinne <rinrin.ne@gmail.com>
 * rkyrychuk <ruslan.kyrychuk@gmail.com>
+* sshaw <skye.shaw@gmail.com>
 * twrodriguez <tw.rodriguez@gmail.com>
 * zimbatm <zimbatm@zimbatm.com>

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    excon (0.32.1)
+    excon (0.33.0)
 
 GEM
   remote: http://rubygems.org/

data/README.md

@@ -137,6 +137,11 @@ connection = Excon.new('http://geemus.com/', :connect_timeout => 360)
 
 # opt-out of nonblocking operations for performance and/or as a workaround
 connection = Excon.new('http://geemus.com/', :nonblock => false)
+
+# use basic authentication by supplying credentials in the URL or as parameters
+connection = Excon.new('http://username:password@secure.geemus.com')
+connection = Excon.new('http://secure.geemus.com',
+  :user => 'username', :password => 'password')
 ```
 
 ## Chunked Requests
@@ -274,7 +279,7 @@ config.after(:each) do
 end
 ```
 
-You can also modify 'Excon.defaults` to set a stub for all requests, so for a test suite you might do this:
+You can also modify `Excon.defaults` to set a stub for all requests, so for a test suite you might do this:
 
 ```ruby
 # Mock by default and stub any request as success

data/changelog.txt

@@ -1,3 +1,9 @@
+0.33.0 05/15/2014
+=================
+
+README clarifications around defaults and basic auth
+case insensitive headers
+
 0.32.1 03/13/2014
 =================
 

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.32.1'
-  s.date              = '2014-03-13'
+  s.version           = '0.33.0'
+  s.date              = '2014-04-15'
   s.rubyforge_project = 'excon'
 
   ## Make sure your summary is short. The description may be as long
@@ -100,6 +100,7 @@ Gem::Specification.new do |s|
     lib/excon/connection.rb
     lib/excon/constants.rb
     lib/excon/errors.rb
+    lib/excon/headers.rb
     lib/excon/middlewares/base.rb
     lib/excon/middlewares/decompress.rb
     lib/excon/middlewares/escape_path.rb

data/lib/excon.rb

@@ -71,6 +71,7 @@ require 'excon/middlewares/mock'
 require 'excon/middlewares/redirect_follower'
 require 'excon/middlewares/response_parser'
 require 'excon/response'
+require 'excon/headers'
 require 'excon/socket'
 require 'excon/ssl_socket'
 require 'excon/unix_socket'

data/lib/excon/connection.rb

@@ -83,6 +83,10 @@ module Excon
 
       if ENV.has_key?('EXCON_DEBUG') || ENV.has_key?('EXCON_STANDARD_INSTRUMENTOR')
         @data[:instrumentor] = Excon::StandardInstrumentor
+
+        if ENV.has_key?('EXCON_DEBUG')
+          @data[:debug_request] = @data[:debug_reponse] = true
+        end
       end
 
       # Use Basic Auth if url contains a login

data/lib/excon/constants.rb

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

data/lib/excon/headers.rb

@@ -0,0 +1,117 @@
+module Excon
+  class Headers < Hash
+
+    SENTINEL = {}
+
+    alias_method :raw_writer, :[]=
+    alias_method :raw_reader, :[]
+    if SENTINEL.respond_to?(:assoc)
+      alias_method :raw_assoc, :assoc
+    end
+    alias_method :raw_delete, :delete
+    alias_method :raw_fetch, :fetch
+    alias_method :raw_has_key?, :has_key?
+    alias_method :raw_include?, :include?
+    alias_method :raw_key?, :key?
+    alias_method :raw_member?, :member?
+    alias_method :raw_rehash, :rehash
+    alias_method :raw_store, :store
+    alias_method :raw_values_at, :values_at
+
+    def [](key)
+      if should_delegate?(key)
+        @downcased[key.downcase]
+      else
+        raw_reader(key)
+      end
+    end
+
+    alias_method :[]=, :store
+    def []=(key, value)
+      raw_writer(key, value)
+      unless @downcased.nil?
+        @downcased[key.downcase] = value
+      end
+    end
+
+    if SENTINEL.respond_to? :assoc
+      def assoc(obj)
+        if should_delegate?(obj)
+          @downcased.assoc(obj.downcase)
+        else
+          raw_assoc(obj)
+        end
+      end
+    end
+
+    def delete(key, &proc)
+      if should_delegate?(key)
+        @downcased.delete(key.downcase, &proc)
+      else
+        raw_delete(key, &proc)
+      end
+    end
+
+    def fetch(key, default = nil, &proc)
+      if should_delegate?(key)
+        if proc
+          @downcased.fetch(key.downcase, &proc)
+        else
+          @downcased.fetch(key.downcase, default)
+        end
+      else
+        if proc
+          raw_fetch(key, &proc)
+        else
+          raw_fetch(key, default)
+        end
+      end
+    end
+
+    alias_method :has_key?, :key?
+    alias_method :has_key?, :member?
+    def has_key?(key)
+      raw_has_key?(key) || begin
+        index_case_insensitive
+        @downcased.has_key?(key.downcase)
+      end
+    end
+
+    def rehash
+      raw_rehash
+      if @downcased
+        @downcased.rehash
+      end
+    end
+
+    def values_at(*keys)
+      raw_values_at(*keys).zip(keys).map do |v, k|
+        if v.nil?
+          index_case_insensitive
+          @downcased[k.downcase]
+        end
+      end
+    end
+
+    private
+
+    def should_delegate?(key)
+      if raw_has_key?(key)
+        false
+      else
+        index_case_insensitive
+        true
+      end
+    end
+
+    def index_case_insensitive
+      if @downcased.nil?
+        @downcased = {}
+        each_pair do |key, value|
+          @downcased[key.downcase] = value
+        end
+      end
+    end
+
+  end
+end

data/lib/excon/response.rb

@@ -42,7 +42,7 @@ module Excon
 
       datum[:response] = {
         :body          => '',
-        :headers       => {},
+        :headers       => Excon::Headers.new,
         :status        => status,
         :remote_ip     => socket.respond_to?(:remote_ip) && socket.remote_ip,
         :local_port    => socket.respond_to?(:local_port) && socket.local_port,
@@ -132,7 +132,7 @@ module Excon
     def initialize(params={})
       @data = {
         :body     => '',
-        :headers  => {}
+        :headers  => Excon::Headers.new
       }.merge(params)
       @body          = @data[:body]
       @headers       = @data[:headers]
@@ -154,12 +154,7 @@ module Excon
     # Retrieve a specific header value. Header names are treated case-insensitively.
     #   @param [String] name Header name
     def get_header(name)
-      headers.each do |key,value|
-        if key.casecmp(name) == 0
-          return value
-        end
-      end
-      nil
+      headers[name]
     end
 
   end # class Response

data/tests/header_tests.rb

@@ -1,6 +1,71 @@
 Shindo.tests('Excon response header support') do
   env_init
 
+  tests('Excon::Headers storage') do
+    headers = Excon::Headers.new
+    headers['Exact-Case'] = 'expected'
+    headers['Another-Fixture'] = 'another'
+
+    tests('stores and retrieves as received').returns('expected') do
+      headers['Exact-Case']
+    end
+
+    tests('enumerates keys as received') do
+      ks = headers.keys
+      tests('contains Exact-Case').returns(true) { ks.include? 'Exact-Case' }
+      tests('contains Another-Fixture').returns(true) { ks.include? 'Another-Fixture' }
+    end
+
+    tests('supports case-insensitive access').returns('expected') do
+      headers['EXACT-CASE']
+    end
+
+    tests('but still returns nil for missing keys').returns(nil) do
+      headers['Missing-Header']
+    end
+
+    tests('Hash methods that should support case-insensitive access') do
+      if {}.respond_to? :assoc
+        tests('#assoc').returns(%w{exact-case expected}) do
+          headers.assoc('exact-Case')
+        end
+      end
+
+      tests('#delete') do
+        tests('with just a key').returns('yes') do
+          headers['Extra'] = 'yes'
+          headers.delete('extra')
+        end
+
+        tests('with a proc').returns('called with notpresent') do
+          headers.delete('notpresent') { |k| "called with #{k}" }
+        end
+      end
+
+      tests('#fetch') do
+        tests('when present').returns('expected') { headers.fetch('exact-CASE') }
+        tests('with a default value').returns('default') { headers.fetch('missing', 'default') }
+        tests('with a default proc').returns('got missing') do
+          headers.fetch('missing') { |k| "got #{k}" }
+        end
+      end
+
+      tests('#has_key?') do
+        tests('when present').returns(true) { headers.has_key?('EXACT-case') }
+        tests('when absent').returns(false) { headers.has_key?('missing') }
+      end
+
+      tests('#values_at') do
+        tests('all present').returns(%w{expected another}) do
+          headers.values_at('exACT-cASE', 'anotheR-fixturE')
+        end
+        tests('some missing').returns(['expected', nil]) do
+          headers.values_at('exact-case', 'missing-header')
+        end
+      end
+    end
+  end
+
   with_rackup('response_header.ru') do
 
     tests('Response#get_header') do

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: excon
 version: !ruby/object:Gem::Version
-  version: 0.32.1
+  version: 0.33.0
 platform: ruby
 authors:
 - dpiddy (Dan Peterson)
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-13 00:00:00.000000000 Z
+date: 2014-04-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -163,6 +163,7 @@ files:
 - lib/excon/connection.rb
 - lib/excon/constants.rb
 - lib/excon/errors.rb
+- lib/excon/headers.rb
 - lib/excon/middlewares/base.rb
 - lib/excon/middlewares/decompress.rb
 - lib/excon/middlewares/escape_path.rb