htty 1.4.1 → 1.5.0

data/lib/htty/no_header_error.rb

@@ -0,0 +1,10 @@
+module HTTY; end
+
+# Indicates that an header could not be found in a HTTY::Payload
+class HTTY::NoHeaderError < StandardError
+
+  def initialize(key)
+    super "header #{key} not found"
+  end
+
+end

data/lib/htty/payload.rb

@@ -1,4 +1,6 @@
-require File.expand_path("#{File.dirname __FILE__}/ordered_hash")
+require File.expand_path("#{File.dirname __FILE__}/headers")
+require File.expand_path("#{File.dirname __FILE__}/no_header_error")
+require File.expand_path("#{File.dirname __FILE__}/cookies_util")
 
 module HTTY; end
 
@@ -20,6 +22,24 @@ class HTTY::Payload
     @headers.to_a
   end
 
+  def headers_with_key(key)
+    headers.select do |header_key, header_value|
+      key.downcase == header_key.downcase
+    end
+  end
+
+  def header(key, otherwise=:__no_default_value_given)
+    all_headers_with_key = headers_with_key(key)
+    return all_headers_with_key.last.last unless all_headers_with_key.empty?
+    raise otherwise if otherwise.is_a? Exception
+    return otherwise unless otherwise == :__no_default_value_given
+    raise HTTY::NoHeaderError.new(key)
+  end
+
+  def cookies_from(cookies_header_key)
+    HTTY::CookiesUtil.cookies_from_string header(cookies_header_key, nil)
+  end
+
 protected
 
   # Initializes a new HTTY::Payload with attribute values specified in the
@@ -31,17 +51,10 @@ protected
   # * <tt>:headers</tt>
   def initialize(attributes={})
     @body    = attributes[:body]
-    @headers = HTTY::OrderedHash.new
+    @headers = HTTY::Headers.new
     Array(attributes[:headers]).each do |name, value|
       @headers[name] = value
     end
   end
 
-  # @private
-  def initialize_copy(source)
-    super
-    @body    = @body.dup if @body
-    @headers = @headers.dup
-  end
-
 end

data/lib/htty/request.rb

@@ -6,6 +6,7 @@ require File.expand_path("#{File.dirname __FILE__}/cookies_util")
 require File.expand_path("#{File.dirname __FILE__}/no_location_header_error")
 require File.expand_path("#{File.dirname __FILE__}/no_response_error")
 require File.expand_path("#{File.dirname __FILE__}/no_set_cookie_header_error")
+require File.expand_path("#{File.dirname __FILE__}/uri")
 require File.expand_path("#{File.dirname __FILE__}/payload")
 require File.expand_path("#{File.dirname __FILE__}/requests_util")
 require File.expand_path("#{File.dirname __FILE__}/response")
@@ -141,13 +142,6 @@ public
     establish_content_length
   end
 
-  # @private
-  def initialize_copy(source)
-    super
-    @response = @response.dup if @response
-    @uri      = @uri.dup
-  end
-
   # Returns +true+ if _other_request_ is equivalent to the request.
   def ==(other_request)
     return false unless super(other_request)
@@ -229,9 +223,14 @@ public
     self
   end
 
+  # Returns true if has some cookies.
+  def cookies?
+    not cookies.empty?
+  end
+
   # Returns an array of the cookies belonging to the request.
   def cookies
-    HTTY::CookiesUtil.cookies_from_string @headers[COOKIES_HEADER_NAME]
+    cookies_from(COOKIES_HEADER_NAME)
   end
 
   # Removes all #cookies.
@@ -267,14 +266,7 @@ public
   # HTTY::NoLocationHeaderError.
   def follow(response)
     raise HTTY::NoResponseError unless response
-
-    location_header = response.headers.detect do |name, value|
-      name == HTTY::Response::LOCATION_HEADER_NAME
-    end
-    unless location_header && location_header.last
-      raise HTTY::NoLocationHeaderError
-    end
-    address location_header.last
+    response.follow_relative_to(self)
   end
 
   # Establishes a new #uri with the specified _fragment_.
@@ -302,13 +294,29 @@ public
   def header_set(name, value)
     return dup_without_response.header_set(name, value) if response
 
-    name = name.to_s
+    name = name && name.to_s
+    value = value && value.to_s
+
+    # to avoid recursion when rebuild_uri
+    return self if @headers[name] == value
+
     if value.nil?
       @headers.delete name
+      if name.downcase == AUTHORIZATION_HEADER_NAME.downcase
+        return rebuild_uri :userinfo => nil
+      end
       return self
     end
 
-    @headers[name] = value.to_s
+    @headers[name] = value
+    if name.downcase == AUTHORIZATION_HEADER_NAME.downcase
+      HTTY::Headers.credentials_from(value) do |username, password|
+        return rebuild_uri :userinfo => [
+          HTTY::URI.escape_component(username),
+          HTTY::URI.escape_component(password)
+        ].compact.join(':')
+      end
+    end
     self
   end
 
@@ -317,6 +325,14 @@ public
     header_set name, nil
   end
 
+  # Removes all #headers.
+  def headers_unset_all
+    return dup_without_response.headers_unset_all if response
+
+    @headers.clear
+    rebuild_uri :userinfo => nil
+  end
+
   # Returns an array of the headers belonging to the payload. If
   # _include_content_length_ is +false+, then a 'Content Length' header will be
   # omitted. If _include_content_length_ is not specified, then it will be
@@ -333,14 +349,6 @@ public
     super()
   end
 
-  # Removes all #headers.
-  def headers_unset_all
-    return dup_without_response.headers_unset_all if response
-
-    @headers.clear
-    self
-  end
-
   # Establishes a new #uri with the specified _host_.
   def host_set(host)
     rebuild_uri :host => host
@@ -383,8 +391,34 @@ public
   def query_add(name, value=nil)
     entries = current_query_entries
     entries << name + (value.nil? ? '' : "=#{value}")
-    new_query = entries.empty? ? nil : entries.join('&')
-    rebuild_uri :query => new_query
+    query_set_all(entries)
+  end
+
+  # Establishes a new #uri with the specified _value_ for the query-string
+  # parameter specified by _name_. The _value_ is optional.
+  #
+  # If there is more than one query-string parameter named _name_, they are
+  # replaced by a single one with the specified _value_.
+  def query_set(name, value=nil)
+    entries = current_query_entries
+    add_or_replace_field(entries, name, value)
+    query_set_all(entries)
+  end
+
+  # Establishes a new #uri with the query-string parameter specified by by
+  # _query_string_ parameter
+  def query_set_all(query_string)
+    # _query_string_ as an array of parameters is only for internal usage
+    query_string =
+      case query_string
+        when Array
+          query_string.empty? ? nil : query_string.join('&')
+        when String
+          query_string
+        else
+          nil
+      end
+    rebuild_uri :query => query_string
   end
 
   # Establishes a new #uri, removing the last query-string parameter specified
@@ -401,19 +435,7 @@ public
         break
       end
     end
-    rebuild_uri :query => entries.join('&')
-  end
-
-  # Establishes a new #uri with the specified _value_ for the query-string
-  # parameter specified by _name_. The _value_ is optional.
-  #
-  # If there is more than one query-string parameter named _name_, they are
-  # replaced by a single one with the specified _value_.
-  def query_set(name, value=nil)
-    entries = current_query_entries
-    add_or_replace_field(entries, name, value)
-    new_query = entries.empty? ? nil : entries.join('&')
-    rebuild_uri :query => new_query
+    query_set_all(entries)
   end
 
   # Establishes a new #uri without the query-string parameter specified by
@@ -427,7 +449,7 @@ public
     entries.delete_if do |entry|
       entry =~ field_matcher(name)
     end
-    rebuild_uri :query => entries.join('&')
+    query_set_all(entries)
   end
 
   # Establishes a new #uri without a query string.
@@ -484,8 +506,10 @@ protected
     components = URI::HTTP::COMPONENT.inject({}) do |result, c|
       result.merge c => uri.send(c)
     end
+    components = components.merge(changed_components)
+    components[:query] = nil if components[:query] && components[:query].empty?
     self.class.send(:set_up_cookies_and_authentication, self) do
-      @uri = self.class.build_uri(components.merge(changed_components))
+      @uri = self.class.build_uri(components)
     end
   end
 

data/lib/htty/requests_util.rb

@@ -13,28 +13,28 @@ module HTTY::RequestsUtil
   # Makes an HTTP DELETE request with the specified _request_.
   def self.delete(request)
     request(request) do |host|
-      host.delete request.send(:path_query_and_fragment), request.headers
+      host.delete request.send(:path_query_and_fragment), headers_from(request)
     end
   end
 
   # Makes an HTTP GET request with the specified _request_.
   def self.get(request)
     request(request) do |host|
-      host.request_get request.send(:path_query_and_fragment), request.headers
+      host.request_get request.send(:path_query_and_fragment), headers_from(request)
     end
   end
 
   # Makes an HTTP HEAD request with the specified _request_.
   def self.head(request)
     request(request) do |host|
-      host.head request.send(:path_query_and_fragment), request.headers
+      host.head request.send(:path_query_and_fragment), headers_from(request)
     end
   end
 
   # Makes an HTTP OPTIONS request with the specified _request_.
   def self.options(request)
     request(request) do |host|
-      host.options request.send(:path_query_and_fragment), request.headers
+      host.options request.send(:path_query_and_fragment), headers_from(request)
     end
   end
 
@@ -43,7 +43,7 @@ module HTTY::RequestsUtil
     request(request) do |host|
       host.patch request.send(:path_query_and_fragment),
                  request.body,
-                 request.headers
+                 headers_from(request)
     end
   end
 
@@ -52,7 +52,7 @@ module HTTY::RequestsUtil
     request(request) do |host|
       host.post request.send(:path_query_and_fragment),
                 request.body,
-                request.headers
+                headers_from(request)
     end
   end
 
@@ -61,14 +61,14 @@ module HTTY::RequestsUtil
     request(request) do |host|
       host.put request.send(:path_query_and_fragment),
                request.body,
-               request.headers
+               headers_from(request)
     end
   end
 
   # Makes an HTTP TRACE request with the specified _request_.
   def self.trace(request)
     request(request) do |host|
-      host.trace request.send(:path_query_and_fragment), request.headers
+      host.trace request.send(:path_query_and_fragment), headers_from(request)
     end
   end
 
@@ -106,4 +106,18 @@ private
     request
   end
 
+  def self.headers_from(request)
+    return request.headers unless HEADERS_MUST_BE_AN_HASH
+    return {} if request.headers.empty?
+    request.headers.flatten.each_slice(2).reduce({}) do |hash, pair|
+      hash[pair.first] = pair.last
+      hash
+    end
+  end
+
+  # starting from 2.0.0 net/http requires headers to be hashes
+  require 'rubygems' # Not necessary under Ruby v2
+  HEADERS_MUST_BE_AN_HASH =
+    Gem::Version.new(RUBY_VERSION) >= Gem::Version.new('2.0.0')
+
 end

data/lib/htty/response.rb

@@ -23,11 +23,30 @@ class HTTY::Response < HTTY::Payload
   def initialize(attributes={})
     super attributes
     @status = attributes[:status]
+    @already_followed = false
   end
 
   # Returns an array of the cookies belonging to the response.
   def cookies
-    HTTY::CookiesUtil.cookies_from_string @headers[COOKIES_HEADER_NAME]
+    cookies_from(COOKIES_HEADER_NAME)
   end
 
+  def follow_relative_to(request)
+    return request if @already_followed
+    location_uri = URI.parse(location_header = location)
+    if location_uri.absolute?
+      request.address location_header
+    else
+      request.
+        path_set(location_uri.path).
+        query_set_all(location_uri.query).
+        fragment_set(location_uri.fragment)
+    end
+  ensure
+    @already_followed = true
+  end
+
+  def location
+    header(LOCATION_HEADER_NAME, HTTY::NoLocationHeaderError.new)
+  end
 end

data/lib/htty/uri.rb

@@ -0,0 +1,16 @@
+require 'uri'
+
+module HTTY; end
+
+class HTTY::URI
+  # There's a lot of confusion about this, the default implementation
+  # of URI.escape is marked as "obsolete", CGI.escape does another work,
+  # a safe solution seems to use https://github.com/sporkmonger/addressable
+  # without adding a new dependecy I found that encode all not unreserved
+  # characters (unfortunately that doesn't mean all reserved characters) it's
+  # a pretty safe solution, see http://tools.ietf.org/html/rfc3986#section-2.3
+  # URI.escape(a, /[^-_.~a-zA-Z0-9]/)
+  def self.escape_component(component)
+    URI.escape(component, /[^-_.~a-zA-Z0-9]/) unless component.nil?
+  end
+end

data/lib/htty/version.rb

@@ -1,6 +1,6 @@
 module HTTY
 
   # The version of this release of _htty_.
-  VERSION = '1.4.1' unless const_defined?(:VERSION)
+  VERSION = '1.5.0' unless const_defined?(:VERSION)
 
 end

data/spec/integration/htty/cli/commands/query_add_spec.rb

@@ -1,4 +1,4 @@
-require 'rspec'
+require 'spec_helper'
 require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/session")
 require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/cli/commands/query_add")
 
@@ -15,6 +15,12 @@ describe HTTY::CLI::Commands::QueryAdd do
     klass.new :session => session, :arguments => arguments
   end
 
+  describe 'without an argument' do
+    it 'should raise an error' do
+      expect{instance.perform}.to raise_error(ArgumentError)
+    end
+  end
+
   describe 'with key argument only' do
     describe 'without key already present' do
       it 'should add key' do

data/spec/integration/htty/cli/commands/query_remove_spec.rb

@@ -1,4 +1,4 @@
-require 'rspec'
+require 'spec_helper'
 require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/session")
 require File.expand_path("#{File.dirname __FILE__}/../../../../../lib/htty/cli/commands/query_remove")
 
@@ -15,6 +15,24 @@ describe HTTY::CLI::Commands::QueryRemove do
     klass.new :session => session, :arguments => arguments
   end
 
+  describe 'with existing query string with only one key and value' do
+    before :each do
+      session.requests.last.uri.query = 'test=true'
+    end
+
+    describe 'with only key in query string' do
+      it 'should empty the query string' do
+        instance('test').perform
+        session.requests.last.uri.query.should be_nil
+      end
+
+      it 'should not leave a trailing question mark' do
+        instance('test').perform
+        session.requests.last.uri.to_s.should_not end_with('?')
+      end
+    end
+  end
+
   describe 'with existing query string with duplicate keys set' do
     before :each do
       session.requests.last.uri.query = 'test=true&test=false'