http 0.8.11 → 0.8.12

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: ccf72f7e0ec682293d3f7b779753ac63ec02df76
-  data.tar.gz: bb91b282c3603b0e5d3f5f068149ea331483aab0
+  metadata.gz: 2bb012bd8ce0fdf45a88171c20552f819279e316
+  data.tar.gz: 094be455227c7e42aba8157819b9336b9744b9d1
 SHA512:
-  metadata.gz: 62b0ed844e8152f5b6fa3d46897993a22a3fdff4661e80761a7482efaae4ad7a8d7d1739e6b823fe1c20c2de1dfe7579399860ea616b9ad463382fa89f54d901
-  data.tar.gz: 0c6bb166ab12fce3ffa7a871e9c26e19701609db68409617af217f59d4d3b13e61e4bace493bd21a2486608e08911cdbfc87a4d23bd6fb083ef1a5502a88e733
+  metadata.gz: 60ce4064cdafe70513e1749ace44afed30c9c08251d3d9ec0d0c1f205d243704403ca8643e96d7792fb23085e4ae755ab04db073c084142f7652f0ef5a594bdf
+  data.tar.gz: a7c7acda4cb5c67cb84ee300d42f5871a413066a78c44188fb8d51de96047124ba4b25ece259b0785c7a806f16e0d7bdc911572d7d6ab292cfd52b1afb4d612c

data/CHANGES.md

@@ -1,3 +1,8 @@
+## 0.8.12 (2015-05-26)
+
+* Fix `HTTP.timeout` API (was loosing previously defined options). (@ixti)
+
+
 ## 0.8.11 (2015-05-22)
 
 * SNI support for HTTPS connections. See #229. (@tarcieri)

data/lib/http.rb

@@ -20,7 +20,7 @@ module HTTP
 
   class << self
     # HTTP[:accept => 'text/html'].get(...)
-    alias_method :[], :with_headers
+    alias_method :[], :headers
   end
 end
 

data/lib/http/cache.rb

@@ -51,8 +51,8 @@ module HTTP
       handle_response(cached_resp, actual_resp, req)
     end
 
-    # @returns [Response] the most useful of the responses after
-    # updating the cache as appropriate
+    # @return [Response] the most useful of the responses after
+    #   updating the cache as appropriate
     def handle_response(cached_resp, actual_resp, req)
       if actual_resp.status.not_modified? && cached_resp
         logger.debug { "<#{req.uri}> not modified, using cached version." }

data/lib/http/cache/headers.rb

@@ -53,23 +53,23 @@ module HTTP
 
       # @return [Boolean] is the vary header set to '*'
       def vary_star?
-        get("Vary").any? { |v| "*" == v.strip }
+        get(HTTP::Headers::VARY).any? { |v| "*" == v.strip }
       end
 
       private
 
       # @return [Boolean] true when cache-control header matches the pattern
       def matches?(pattern)
-        get("Cache-Control").any? { |v| v =~ pattern }
+        get(HTTP::Headers::CACHE_CONTROL).any? { |v| v =~ pattern }
       end
 
       # @return [Numeric] number of seconds until the time in the
       # expires header is reached.
       #
       # ---
-      # Some servers send a "Expire: -1" header which must be treated as expired
+      # Some servers send a "Expires: -1" header which must be treated as expired
       def seconds_til_expires
-        get("Expires").
+        get(HTTP::Headers::EXPIRES).
           map { |e| http_date_to_ttl(e) }.
           max
       end
@@ -89,7 +89,7 @@ module HTTP
 
       # @return [Numeric] the value of the max-age component of cache control
       def explicit_max_age
-        get("Cache-Control").
+        get(HTTP::Headers::CACHE_CONTROL).
           map { |v| (/max-age=(\d+)/i).match(v) }.
           compact.
           map { |m| m[1].to_i }.

data/lib/http/chainable.rb

@@ -1,5 +1,7 @@
 require "base64"
 
+require "http/headers"
+
 module HTTP
   module Chainable
     # Request a get sans response body
@@ -95,7 +97,10 @@ module HTTP
         options["#{k}_timeout".to_sym] = options.delete k
       end
 
-      branch :timeout_class => klass, :timeout_options => options
+      branch default_options.merge(
+        :timeout_class => klass,
+        :timeout_options => options
+      )
     end
 
     # @overload persistent(host)
@@ -195,7 +200,7 @@ module HTTP
     # Accept the given MIME type(s)
     # @param type
     def accept(type)
-      with :accept => MimeType.normalize(type)
+      headers Headers::ACCEPT => MimeType.normalize(type)
     end
 
     # Make a request with the given Authorization header
@@ -204,7 +209,7 @@ module HTTP
       # shim for deprecated auth(:basic, opts).
       # will be removed in 0.8.0
       return basic_auth(opts) if :basic == value
-      with :authorization => value.to_s
+      headers Headers::AUTHORIZATION => value.to_s
     end
 
     # Make a request with the given Basic authorization header

data/lib/http/client.rb

@@ -16,7 +16,6 @@ module HTTP
     extend Forwardable
     include Chainable
 
-    CONNECTION         = "Connection".freeze
     KEEP_ALIVE         = "Keep-Alive".freeze
     CLOSE              = "close".freeze
 
@@ -36,13 +35,6 @@ module HTTP
       body    = make_request_body(opts, headers)
       proxy   = opts.proxy
 
-      # Tell the server to keep the conn open
-      if default_options.persistent?
-        headers[CONNECTION] = KEEP_ALIVE
-      else
-        headers[CONNECTION] = CLOSE
-      end
-
       req = HTTP::Request.new(verb, uri, headers, proxy, body)
       res = perform req, opts
 
@@ -147,11 +139,22 @@ module HTTP
 
     # Creates request headers with cookies (if any) merged in
     def make_request_headers(opts)
+      headers = opts.headers
+
+      # Tell the server to keep the conn open
+      if default_options.persistent?
+        headers[Headers::CONNECTION] = KEEP_ALIVE
+      else
+        headers[Headers::CONNECTION] = CLOSE
+      end
+
       cookies = opts.cookies.values
-      return opts.headers if cookies.empty?
+      unless cookies.empty?
+        cookies = opts.headers.get(Headers::COOKIE).concat(cookies).join("; ")
+        headers[Headers::COOKIE] = cookies
+      end
 
-      cookies = opts.headers.get(Headers::COOKIE).concat(cookies).join("; ")
-      opts.headers.merge(Headers::COOKIE => cookies)
+      headers
     end
 
     # Create the request body object to send
@@ -161,11 +164,11 @@ module HTTP
         opts.body
       when opts.form
         form = HTTP::FormData.create opts.form
-        headers["Content-Type"]   ||= form.content_type
-        headers["Content-Length"] ||= form.content_length
+        headers[Headers::CONTENT_TYPE]   ||= form.content_type
+        headers[Headers::CONTENT_LENGTH] ||= form.content_length
         form.to_s
       when opts.json
-        headers["Content-Type"] ||= "application/json"
+        headers[Headers::CONTENT_TYPE] ||= "application/json"
         MimeType[:json].encode opts.json
       end
     end

data/lib/http/connection.rb

@@ -1,5 +1,7 @@
 require "forwardable"
 
+require "http/client"
+require "http/headers"
 require "http/response/parser"
 
 module HTTP
@@ -51,7 +53,7 @@ module HTTP
 
     # Send a request to the server
     #
-    # @param [Request] Request to send to the server
+    # @param [Request] req Request to send to the server
     # @return [nil]
     def send_request(req)
       if @pending_response
@@ -186,9 +188,9 @@ module HTTP
 
       case @parser.http_version
       when HTTP_1_0 # HTTP/1.0 requires opt in for Keep Alive
-        @keep_alive = @parser.headers[Client::CONNECTION] == HTTP::Client::KEEP_ALIVE
+        @keep_alive = @parser.headers[Headers::CONNECTION] == Client::KEEP_ALIVE
       when HTTP_1_1 # HTTP/1.1 is opt-out
-        @keep_alive = @parser.headers[Client::CONNECTION] != HTTP::Client::CLOSE
+        @keep_alive = @parser.headers[Headers::CONNECTION] != Client::CLOSE
       else # Anything else we assume doesn't supportit
         @keep_alive = false
       end

data/lib/http/headers.rb

@@ -2,6 +2,7 @@ require "forwardable"
 
 require "http/errors"
 require "http/headers/mixin"
+require "http/headers/known"
 
 module HTTP
   # HTTP Headers container.
@@ -16,12 +17,6 @@ module HTTP
     # @see http://tools.ietf.org/html/rfc7230#section-3.2
     HEADER_NAME_RE = /^[A-Za-z0-9!#\$%&'*+\-.^_`|~]+$/
 
-    # Set-Cookie (response) header name
-    SET_COOKIE = "Set-Cookie".freeze
-
-    # Cookie (request) header name
-    COOKIE = "Cookie".freeze
-
     # Class constructor.
     def initialize
       @pile = []

data/lib/http/headers/known.rb

@@ -0,0 +1,78 @@
+module HTTP
+  class Headers
+    # Content-Types that are acceptable for the response.
+    ACCEPT = "Accept".freeze
+
+    # The age the object has been in a proxy cache in seconds.
+    AGE = "Age".freeze
+
+    # Authentication credentials for HTTP authentication.
+    AUTHORIZATION = "Authorization".freeze
+
+    # Used to specify directives that must be obeyed by all caching mechanisms
+    # along the request-response chain.
+    CACHE_CONTROL = "Cache-Control".freeze
+
+    # An HTTP cookie previously sent by the server with Set-Cookie.
+    COOKIE = "Cookie".freeze
+
+    # Control options for the current connection and list
+    # of hop-by-hop request fields.
+    CONNECTION = "Connection".freeze
+
+    # The length of the request body in octets (8-bit bytes).
+    CONTENT_LENGTH = "Content-Length".freeze
+
+    # The MIME type of the body of the request
+    # (used with POST and PUT requests).
+    CONTENT_TYPE = "Content-Type".freeze
+
+    # The date and time that the message was sent (in "HTTP-date" format as
+    # defined by RFC 7231 Date/Time Formats).
+    DATE = "Date".freeze
+
+    # An identifier for a specific version of a resource,
+    # often a message digest.
+    ETAG = "ETag".freeze
+
+    # Gives the date/time after which the response is considered stale (in
+    # "HTTP-date" format as defined by RFC 7231).
+    EXPIRES = "Expires".freeze
+
+    # The domain name of the server (for virtual hosting), and the TCP port
+    # number on which the server is listening. The port number may be omitted
+    # if the port is the standard port for the service requested.
+    HOST = "Host".freeze
+
+    # Allows a 304 Not Modified to be returned if content is unchanged.
+    IF_MODIFIED_SINCE = "If-Modified-Since".freeze
+
+    # Allows a 304 Not Modified to be returned if content is unchanged.
+    IF_NONE_MATCH = "If-None-Match".freeze
+
+    # The last modified date for the requested object (in "HTTP-date" format as
+    # defined by RFC 7231).
+    LAST_MODIFIED = "Last-Modified".freeze
+
+    # Used in redirection, or when a new resource has been created.
+    LOCATION = "Location".freeze
+
+    # Authorization credentials for connecting to a proxy.
+    PROXY_AUTHORIZATION = "Proxy-Authorization".freeze
+
+    # An HTTP cookie.
+    SET_COOKIE = "Set-Cookie".freeze
+
+    # The form of encoding used to safely transfer the entity to the user.
+    # Currently defined methods are: chunked, compress, deflate, gzip, identity.
+    TRANSFER_ENCODING = "Transfer-Encoding".freeze
+
+    # The user agent string of the user agent.
+    USER_AGENT = "User-Agent".freeze
+
+    # Tells downstream proxies how to match future request headers to decide
+    # whether the cached response can be used rather than requesting a fresh
+    # one from the origin server.
+    VARY = "Vary".freeze
+  end
+end

data/lib/http/redirector.rb

@@ -1,5 +1,7 @@
 require "set"
 
+require "http/headers"
+
 module HTTP
   class Redirector
     # Notifies that we reached max allowed redirect hops
@@ -35,9 +37,9 @@ module HTTP
     # @param [Hash] opts
     # @option opts [Boolean] :strict (true) redirector hops policy
     # @option opts [#to_i] :max_hops (5) maximum allowed amount of hops
-    def initialize(options = {})
-      @strict   = options.fetch(:strict, true)
-      @max_hops = options.fetch(:max_hops, 5).to_i
+    def initialize(opts = {})
+      @strict   = opts.fetch(:strict, true)
+      @max_hops = opts.fetch(:max_hops, 5).to_i
     end
 
     # Follows redirects until non-redirect response found
@@ -52,7 +54,7 @@ module HTTP
         fail TooManyRedirectsError if too_many_hops?
         fail EndlessRedirectError  if endless_loop?
 
-        @request  = redirect_to @response.headers["Location"]
+        @request  = redirect_to @response.headers[Headers::LOCATION]
         @response = yield @request
       end
 

data/lib/http/request.rb

@@ -79,14 +79,14 @@ module HTTP
 
       @headers = HTTP::Headers.coerce(headers || {})
 
-      @headers["Host"]        ||= default_host_header_value
-      @headers["User-Agent"]  ||= USER_AGENT
+      @headers[Headers::HOST]        ||= default_host_header_value
+      @headers[Headers::USER_AGENT]  ||= USER_AGENT
     end
 
     # Returns new Request with updated uri
     def redirect(uri, verb = @verb)
       req = self.class.new(verb, @uri.join(uri), headers, proxy, body, version)
-      req["Host"] = req.uri.host
+      req[Headers::HOST] = req.uri.host
       req
     end
 
@@ -108,7 +108,7 @@ module HTTP
 
     # Compute and add the Proxy-Authorization header
     def include_proxy_authorization_header
-      headers["Proxy-Authorization"] = proxy_authorization_header
+      headers[Headers::PROXY_AUTHORIZATION] = proxy_authorization_header
     end
 
     def proxy_authorization_header
@@ -138,10 +138,12 @@ module HTTP
     # Headers to send with proxy connect request
     def proxy_connect_headers
       connect_headers = HTTP::Headers.coerce(
-        "Host" => headers["Host"],
-        "User-Agent" => headers["User-Agent"]
+        Headers::HOST        => headers[Headers::HOST],
+        Headers::USER_AGENT  => headers[Headers::USER_AGENT]
       )
-      connect_headers["Proxy-Authorization"] = proxy_authorization_header if using_authenticated_proxy?
+
+      connect_headers[Headers::PROXY_AUTHORIZATION] = proxy_authorization_header if using_authenticated_proxy?
+
       connect_headers
     end
 

data/lib/http/request/caching.rb

@@ -1,3 +1,4 @@
+require "http/headers"
 require "http/cache/headers"
 
 module HTTP
@@ -76,17 +77,16 @@ module HTTP
       private
 
       # @return [Headers] conditional request headers
-      # @api private
       def conditional_headers_for(cached_response)
         headers = HTTP::Headers.new
 
-        cached_response.headers.get("Etag").
-          each { |etag| headers.add("If-None-Match", etag) }
+        cached_response.headers.get(HTTP::Headers::ETAG).
+          each { |etag| headers.add(HTTP::Headers::IF_NONE_MATCH, etag) }
 
-        cached_response.headers.get("Last-Modified").
-          each { |last_mod| headers.add("If-Modified-Since", last_mod) }
+        cached_response.headers.get(HTTP::Headers::LAST_MODIFIED).
+          each { |last_mod| headers.add(HTTP::Headers::IF_MODIFIED_SINCE, last_mod) }
 
-        headers.add("Cache-Control", "max-age=0") if cache_headers.forces_revalidation?
+        headers.add(HTTP::Headers::CACHE_CONTROL, "max-age=0") if cache_headers.forces_revalidation?
 
         headers
       end

data/lib/http/request/writer.rb

@@ -1,8 +1,16 @@
+require "http/headers"
+
 module HTTP
   class Request
     class Writer
       # CRLF is the universal HTTP delimiter
-      CRLF = "\r\n"
+      CRLF = "\r\n".freeze
+
+      # Chunked data termintaor.
+      ZERO = "0".freeze
+
+      # Chunked transfer encoding
+      CHUNKED = "chunked".freeze
 
       # Types valid to be used as body source
       VALID_BODY_TYPES = [String, NilClass, Enumerable]
@@ -38,9 +46,9 @@ module HTTP
       # Adds the headers to the header array for the given request body we are working
       # with
       def add_body_type_headers
-        if @body.is_a?(String) && !@headers["Content-Length"]
-          @request_header << "Content-Length: #{@body.bytesize}"
-        elsif @body.is_a?(Enumerable) && "chunked" != @headers["Transfer-Encoding"]
+        if @body.is_a?(String) && !@headers[Headers::CONTENT_LENGTH]
+          @request_header << "#{Headers::CONTENT_LENGTH}: #{@body.bytesize}"
+        elsif @body.is_a?(Enumerable) && CHUNKED != @headers[Headers::TRANSFER_ENCODING]
           fail(RequestError, "invalid transfer encoding")
         end
       end
@@ -69,7 +77,7 @@ module HTTP
             @socket << chunk << CRLF
           end
 
-          @socket << "0" << CRLF * 2
+          @socket << ZERO << CRLF << CRLF
         end
       end
 

data/lib/http/response.rb

@@ -78,7 +78,7 @@ module HTTP
     #
     # @return [HTTP::ContentType]
     def content_type
-      @content_type ||= ContentType.parse headers["Content-Type"]
+      @content_type ||= ContentType.parse headers[Headers::CONTENT_TYPE]
     end
 
     # MIME type of response (if any)

data/lib/http/response/caching.rb

@@ -1,3 +1,4 @@
+require "http/headers"
 require "http/cache/headers"
 require "http/response/string_body"
 require "http/response/io_body"
@@ -25,7 +26,7 @@ module HTTP
         expired? || cache_headers.must_revalidate?
       end
 
-      # @returns [Boolean] true iff this response has expired
+      # @return [Boolean] true iff this response has expired
       def expired?
         current_age >= cache_headers.max_age
       end
@@ -52,7 +53,7 @@ module HTTP
       # Algo from https://tools.ietf.org/html/rfc2616#section-13.2.3
       def current_age
         now = Time.now
-        age_value  = headers.get("Age").map(&:to_i).max || 0
+        age_value  = headers.get(HTTP::Headers::AGE).map(&:to_i).max || 0
 
         apparent_age = [0, received_at - server_response_time].max
         corrected_received_age = [apparent_age, age_value].max
@@ -116,18 +117,18 @@ module HTTP
       end
 
       def vary
-        headers.get("Vary").first
+        headers.get(HTTP::Headers::VARY).first
       end
 
       protected
 
       # @return [Time] the time at which the server generated this response.
       def server_response_time
-        headers.get("Date").
+        headers.get(HTTP::Headers::DATE).
           map(&method(:to_time_or_epoch)).
           max || begin
                     # set it if it is not already set
-                    headers["Date"] = received_at.httpdate
+                    headers[HTTP::Headers::DATE] = received_at.httpdate
                     received_at
                   end
       end

data/lib/http/response/status.rb

@@ -78,20 +78,28 @@ module HTTP
         REASONS[code]
       end
 
+      # @return [String] string representation of HTTP status
+      def to_s
+        "#{code} #{reason}".strip
+      end
+
       # Symbolized {#reason}
       #
       # @return [nil] unless code is well-known (see REASONS)
       # @return [Symbol]
-      def symbolize
+      def to_sym
         SYMBOLS[code]
       end
 
+      # @deprecated Will be removed in 1.0.0
+      alias_method :symbolize, :to_sym
+
       # Printable version of HTTP Status, surrounded by quote marks,
       # with special characters escaped.
       #
       # (see String#inspect)
       def inspect
-        "#{code} #{reason}".inspect
+        "#<#{self.class} #{self}>"
       end
 
       SYMBOLS.each do |code, symbol|

data/lib/http/version.rb

@@ -1,3 +1,3 @@
 module HTTP
-  VERSION = "0.8.11"
+  VERSION = "0.8.12".freeze
 end

data/spec/lib/http/response/status_spec.rb

@@ -55,7 +55,7 @@ RSpec.describe HTTP::Response::Status do
   describe "#inspect" do
     it "returns quoted code and reason phrase" do
       status = described_class.new 200
-      expect(status.inspect).to eq '"200 OK"'
+      expect(status.inspect).to eq "#<HTTP::Response::Status 200 OK>"
     end
   end
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 0.8.11
+  version: 0.8.12
 platform: ruby
 authors:
 - Tony Arcieri
@@ -11,7 +11,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-05-23 00:00:00.000000000 Z
+date: 2015-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
@@ -116,6 +116,7 @@ files:
 - lib/http/content_type.rb
 - lib/http/errors.rb
 - lib/http/headers.rb
+- lib/http/headers/known.rb
 - lib/http/headers/mixin.rb
 - lib/http/mime_type.rb
 - lib/http/mime_type/adapter.rb
@@ -195,45 +196,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.6
+rubygems_version: 2.2.3
 signing_key: 
 specification_version: 4
 summary: HTTP should be easy
-test_files:
-- spec/lib/http/cache/headers_spec.rb
-- spec/lib/http/cache_spec.rb
-- spec/lib/http/client_spec.rb
-- spec/lib/http/content_type_spec.rb
-- spec/lib/http/headers/mixin_spec.rb
-- spec/lib/http/headers_spec.rb
-- spec/lib/http/options/body_spec.rb
-- spec/lib/http/options/form_spec.rb
-- spec/lib/http/options/headers_spec.rb
-- spec/lib/http/options/json_spec.rb
-- spec/lib/http/options/merge_spec.rb
-- spec/lib/http/options/new_spec.rb
-- spec/lib/http/options/proxy_spec.rb
-- spec/lib/http/options_spec.rb
-- spec/lib/http/redirector_spec.rb
-- spec/lib/http/request/caching_spec.rb
-- spec/lib/http/request/writer_spec.rb
-- spec/lib/http/request_spec.rb
-- spec/lib/http/response/body_spec.rb
-- spec/lib/http/response/caching_spec.rb
-- spec/lib/http/response/io_body_spec.rb
-- spec/lib/http/response/status_spec.rb
-- spec/lib/http/response/string_body_spec.rb
-- spec/lib/http/response_spec.rb
-- spec/lib/http_spec.rb
-- spec/spec_helper.rb
-- spec/support/black_hole.rb
-- spec/support/capture_warning.rb
-- spec/support/connection_reuse_shared.rb
-- spec/support/dummy_server.rb
-- spec/support/dummy_server/servlet.rb
-- spec/support/http_handling_shared.rb
-- spec/support/proxy_server.rb
-- spec/support/servers/config.rb
-- spec/support/servers/runner.rb
-- spec/support/ssl_helper.rb
+test_files: []
 has_rdoc: