http 0.8.4 → 0.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 9b829e0c5ca1c70ca3f55b33080088ab248c52fc
-  data.tar.gz: 248df6f0b8df5a75bfa872d5f24a263568f63e5a
+  metadata.gz: c22451fa65c5d83ca271a7ac53671dd039f66f6a
+  data.tar.gz: ceea0aa11f428af8569bd18de9b188bce8cf65c1
 SHA512:
-  metadata.gz: b4e37035a7a6b692d103a24e6f75a30509a5d2a92aa1b4c21a2c0a393886c648c5b28df3e36779aa274430243dbde29af69ea4eaff25c5ff4aecd3c880bc0068
-  data.tar.gz: 76fae19bd0b8f31e9825a3514e21f83f006bc205c2e118ec4fec8ebd644900d3bbbf2f7119dc800ac4782b4ba9665be64a588083585d9bf12bae36e97188c69b
+  metadata.gz: 624d636385c6eac2b23ac9c1d11b631b676120344db7904381a85b02f4d19e977d6adfc9d3b42a862ea0567052a3ecac19df8818479ff4922a955847c672f0dd
+  data.tar.gz: 5721fc63432acfc6969bc6c6267d2c54565001b09d60e610113a89ebdf84890ef51a2a5ed3e8bdf2bf9a2c6db699fc364b23a666e3e438555edca5b1ad783445

data/CHANGES.md

@@ -1,5 +1,13 @@
 ## master (unreleased)
 
+* _the future is unwritten_
+
+
+## 0.8.5 (2015-05-06)
+
+* Add simple timeouts configuration API. See #205. (@ixti)
+* Deprecate `Request#request_header`. Use `Request#headline` instead. (@ixti)
+
 
 ## 0.8.4 (2015-04-23)
 

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011-15 Tony Arcieri, Erik Michaels-Ober, Aleksey V. Zapparov
+Copyright (c) 2011-2015 Tony Arcieri, Erik Michaels-Ober, Alexey V. Zapparov, Zachary Anker
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -1,12 +1,12 @@
-![http.rb](https://raw.github.com/httprb/http.rb/master/logo.png)
-==============
+# ![http.rb](https://raw.github.com/httprb/http.rb/master/logo.png)
+
 [![Gem Version](https://badge.fury.io/rb/http.svg)](http://rubygems.org/gems/http)
 [![Build Status](https://secure.travis-ci.org/httprb/http.rb.svg?branch=master)](http://travis-ci.org/httprb/http.rb)
 [![Code Climate](https://codeclimate.com/github/httprb/http.rb.svg?branch=master)](https://codeclimate.com/github/httprb/http.rb)
 [![Coverage Status](https://coveralls.io/repos/httprb/http.rb/badge.svg?branch=master)](https://coveralls.io/r/httprb/http.rb)
 
-About
------
+
+## About
 
 http.rb is an easy-to-use client library for making requests from Ruby. It uses
 a simple method chaining system for building requests, similar to Python's [Requests].
@@ -19,8 +19,8 @@ natively and outsources the parsing to native extensions.
 [requests]: http://docs.python-requests.org/en/latest/
 [http_parser.rb]: https://github.com/tmm1/http_parser.rb
 
-Help and Discussion
--------------------
+
+## Help and Discussion
 
 If you need help or just want to talk about the http.rb,
 visit the http.rb Google Group:
@@ -35,8 +35,8 @@ If you believe you've found a bug, please report it at:
 
 https://github.com/httprb/http.rb/issues
 
-Installation
-------------
+
+## Installation
 
 Add this line to your application's Gemfile:
 
@@ -56,17 +56,18 @@ Inside of your Ruby program do:
 
 ...to pull it in as a dependency.
 
-Documentation
--------------
+
+## Documentation
 
 [Please see the http.rb wiki](https://github.com/httprb/http.rb/wiki)
 for more detailed documentation and usage notes.
 
-Basic Usage
------------
+
+## Basic Usage
 
 Here's some simple examples to get you started:
 
+
 ### GET requests
 
 ```ruby
@@ -100,6 +101,7 @@ The response body can be streamed with `HTTP::Response::Body#readpartial`:
 In practice you'll want to bind the HTTP::Response::Body to a local variable (e.g.
 "body") and call readpartial on it repeatedly until it returns `nil`.
 
+
 ### POST requests
 
 Making POST requests is simple too. Want to POST a form?
@@ -136,6 +138,7 @@ HTTP.post("http://examplc.com/resource", :form => {
 
 It's easy!
 
+
 ### Proxy Support
 
 Making request behind proxy is as simple as making them directly. Just specify
@@ -153,6 +156,7 @@ HTTP.via("proxy-hostname.local", 8080, "username", "password")
   .get("http://example.com/resource")
 ```
 
+
 ### Adding Headers
 
 The HTTP gem uses the concept of chaining to simplify requests. Let's say
@@ -184,6 +188,7 @@ HTTP[:accept => "application/json"]
   .get("https://github.com/httprb/http.rb/commit/HEAD")
 ```
 
+
 ### Authorization Header
 
 With [HTTP Basic Authentication](http://tools.ietf.org/html/rfc2617) using
@@ -209,6 +214,7 @@ HTTP.basic_auth(:user => "user", :pass => "pass")
   .get("https://example.com")
 ```
 
+
 ### Content Negotiation
 
 As important a concept as content negotiation is to HTTP, it sure should be easy,
@@ -222,6 +228,7 @@ HTTP.accept(:json).get("https://github.com/httprb/http.rb/commit/HEAD")
 This adds the appropriate Accept header for retrieving a JSON response for the
 given resource.
 
+
 ### Celluloid::IO Support
 
 http.rb makes it simple to make multiple concurrent HTTP requests from a
@@ -246,6 +253,7 @@ There's a little more to it, but that's the core idea!
 * [Full parallel HTTP fetcher example](https://github.com/httprb/http.rb/wiki/Parallel-requests-with-Celluloid%3A%3AIO)
 * See also: [Celluloid::IO](https://github.com/celluloid/celluloid-io)
 
+
 ### Caching
 
 http.rb provides caching of HTTP request (per
@@ -267,8 +275,18 @@ http.rb's caching is backed by
 [rack-cache's excellent storage subsystem](http://rtomayko.github.io/rack-cache/storage.html). Any
 storage URL supported by rack-cache is supported by http.rb's cache.
 
-Supported Ruby Versions
------------------------
+
+### Timeouts
+
+You can configure http.rb to fail if request (connect / read / write) takes too
+long:
+
+``` ruby
+HTTP.timeout(:connect => 5, :read => 10).get "http://example.com"
+```
+
+
+## Supported Ruby Versions
 
 This library aims to support and is [tested against][travis] the following Ruby
 versions:
@@ -294,8 +312,8 @@ dropped.
 
 [travis]: http://travis-ci.org/httprb/http.rb
 
-Contributing to http.rb
------------------------
+
+## Contributing to http.rb
 
 * Fork http.rb on GitHub
 * Make your changes
@@ -304,8 +322,8 @@ Contributing to http.rb
 * If we like them we'll merge them
 * If we've accepted a patch, feel free to ask for commit access!
 
-Copyright
----------
 
-Copyright (c) 2011-15 Tony Arcieri, Erik Michaels-Ober, Aleksey V. Zapparov.
+## Copyright
+
+Copyright (c) 2011-2015 Tony Arcieri, Erik Michaels-Ober, Alexey V. Zapparov, Zachary Anker
 See LICENSE.txt for further details.

data/http.gemspec

@@ -1,8 +1,9 @@
-# -*- encoding: utf-8 -*-
-require File.expand_path("../lib/http/version", __FILE__)
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "http/version"
 
 Gem::Specification.new do |gem|
-  gem.authors       = ["Tony Arcieri", "Erik Michaels-Ober", "Aleksey V. Zapparov"]
+  gem.authors       = ["Tony Arcieri", "Erik Michaels-Ober", "Alexey V. Zapparov", "Zachary Anker"]
   gem.email         = ["bascule@gmail.com"]
 
   gem.description   = <<-DESCRIPTION.strip.gsub(/\s+/, " ")

data/lib/http/chainable.rb

@@ -72,6 +72,32 @@ module HTTP
       branch(options).request verb, uri
     end
 
+    # @overload(options = {})
+    #   Syntax sugar for `timeout(:per_operation, options)`
+    # @overload(klass, options = {})
+    #   @param [#to_sym] klass
+    #   @param [Hash] options
+    #   @option options [Float] :read Read timeout
+    #   @option options [Float] :write Write timeout
+    #   @option options [Float] :connect Connect timeout
+    def timeout(klass, options = {})
+      klass, options = options, {} if klass.is_a? Hash
+
+      klass = case klass.to_sym
+              when :null          then HTTP::Timeout::Null
+              when :global        then HTTP::Timeout::Global
+              when :per_operation then HTTP::Timeout::PerOperation
+              else fail Error, "Unsupported Timeout class: #{klass}"
+              end
+
+      [:read, :write, :connect].each do |k|
+        next unless options.key? k
+        options["#{k}_timeout".to_sym] = options.delete k
+      end
+
+      branch :timeout_class => klass, :timeout_options => options
+    end
+
     # @overload persistent(host)
     #   Flags as persistent
     #   @param [String] host
@@ -127,11 +153,6 @@ module HTTP
     end
     alias_method :through, :via
 
-    # Alias for with_response(:object)
-    def stream
-      with_response(:object)
-    end
-
     # Make client follow redirects.
     # @param opts
     # @return [HTTP::Client]

data/lib/http/request.rb

@@ -91,7 +91,7 @@ module HTTP
     # Stream the request to a socket
     def stream(socket)
       include_proxy_authorization_header if using_authenticated_proxy? && !@uri.https?
-      Request::Writer.new(socket, body, headers, request_header).stream
+      Request::Writer.new(socket, body, headers, headline).stream
     end
 
     # Is this request using a proxy?
@@ -120,11 +120,14 @@ module HTTP
     end
 
     # Compute HTTP request header for direct or proxy request
-    def request_header
+    def headline
       request_uri = using_proxy? ? uri : uri.omit(:scheme, :authority)
       "#{verb.to_s.upcase} #{request_uri} HTTP/#{version}"
     end
 
+    # @deprecated Will be removed in 1.0.0
+    alias_method :request_header, :headline
+
     # Compute HTTP request header SSL proxy connection
     def proxy_connect_header
       "CONNECT #{@uri.host}:#{@uri.port} HTTP/#{version}"

data/lib/http/request/writer.rb

@@ -7,11 +7,11 @@ module HTTP
       # Types valid to be used as body source
       VALID_BODY_TYPES = [String, NilClass, Enumerable]
 
-      def initialize(socket, body, headers, headerstart) # rubocop:disable ParameterLists
+      def initialize(socket, body, headers, headline) # rubocop:disable ParameterLists
         @body           = body
         @socket         = socket
         @headers        = headers
-        @request_header = [headerstart]
+        @request_header = [headline]
 
         validate_body_type!
       end

data/lib/http/version.rb

@@ -1,3 +1,3 @@
 module HTTP
-  VERSION = "0.8.4"
+  VERSION = "0.8.5"
 end

data/spec/lib/http/request_spec.rb

@@ -138,8 +138,8 @@ RSpec.describe HTTP::Request do
     it { is_expected.to be_a HTTP::Request::Caching }
   end
 
-  describe "#request_header" do
-    subject { request.request_header }
+  describe "#headline" do
+    subject { request.headline }
 
     it { is_expected.to eq "GET /foo?bar=baz#moo HTTP/1.1" }
 

metadata

@@ -1,16 +1,17 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 0.8.4
+  version: 0.8.5
 platform: ruby
 authors:
 - Tony Arcieri
 - Erik Michaels-Ober
-- Aleksey V. Zapparov
+- Alexey V. Zapparov
+- Zachary Anker
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-04-23 00:00:00.000000000 Z
+date: 2015-05-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
@@ -180,45 +181,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.4.5
+rubygems_version: 2.2.2
 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: