http 0.5.0 → 0.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c4a4097ace9b95df3f64533b0ccd6f464ec13218
-  data.tar.gz: 17d5aeee9dfe9466b8dbe6bc25326f1e32e10b6c
+  metadata.gz: 2283ed9a55615bac08d7583ed41495c24ea37ba3
+  data.tar.gz: a960101f10e0d3beda0cf7b458db420621b1afc9
 SHA512:
-  metadata.gz: c60e3a6f5dc1f0de1526d215830546f34fe9ca734964cdbc31e8b7481df77b7db60cfb1e89be92899454e202ba0b3e0ef2968a1a417a475c47905d6c2bce1b88
-  data.tar.gz: 0f36ac697d7a130d27c8a3b5f134938fd7fc525e5a02d13ee81ca05f30153e63701b02fa242a78f1bd3f3a7c91923951473763e38d6b60356e44decd03faaf60
+  metadata.gz: 5057731fa424ae08bf7e9e70e0eaa97eb66d1b1f9bb68622b1b49f086759a0d230c45467ee8e9130dfcb4a52bc5b0d107e7cd54b5bb11ee52c384defb3a3d76e
+  data.tar.gz: 5bfcac350c4bb47424922e225a67f320826029936cdbdb17a474554ef36ca1be4ae1bbc791dcd410f5b8e302f4f05e192452beb7748cdec8fded74032ca6c103

data/README.md

@@ -117,7 +117,7 @@ HTTP[:accept => 'application/json'].
 Content Negotiation
 -------------------
 
-As important a concept as content negotiation is HTTP, it sure should be easy,
+As important a concept as content negotiation is to HTTP, it sure should be easy,
 right? But usually it's not, and so we end up adding ".json" onto the ends of
 our URLs because the existing mechanisms make it too hard. It should be easy:
 

data/examples/parallel_requests_with_celluloid.rb

@@ -0,0 +1,38 @@
+#!/usr/bin/env ruby
+#
+# Example of using the HTTP Gem with Celluloid::IO
+# Make sure to 'gem install celluloid-io' before running
+#
+# Run as: bundle exec examples/parallel_requests_with_celluloid.rb
+#
+
+require 'celluloid/io'
+require 'http'
+
+class HttpFetcher
+  include Celluloid::IO
+
+  def fetch(url)
+    # Note: For SSL support specify:
+    # ssl_socket_class: Celluloid::IO::SSLSocket
+    HTTP.get(url, socket_class: Celluloid::IO::TCPSocket).response
+  end
+end
+
+fetcher = HttpFetcher.new
+
+urls = %w(http://www.ruby-lang.org/ http://www.rubygems.org/ http://celluloid.io/)
+
+# Kick off a bunch of future calls to HttpFetcher to grab the URLs in parallel
+futures = urls.map { |u| [u, fetcher.future.fetch(u)] }
+
+# Consume the results as they come in
+futures.each do |url, future|
+  # Wait for HttpFetcher#fetch to complete for this request
+  response = future.value
+  puts "Got #{url}: #{response.inspect}"
+end
+
+# Suppress Celluloid's shutdown messages
+# Otherwise the example is a bit noisy :|
+exit!

data/lib/http/client.rb

@@ -1,4 +1,5 @@
 require 'http/options'
+require 'http/redirector'
 require 'uri'
 
 module HTTP
@@ -32,32 +33,22 @@ module HTTP
       proxy = opts.proxy
 
       method_body = body(opts, headers)
-      if opts.params
+      if opts.params && !opts.params.empty?
         uri="#{uri}?#{URI.encode_www_form(opts.params)}"
       end
 
       request = HTTP::Request.new method, uri, headers, proxy, method_body
+      opts.callbacks[:request].each { |c| c.call(request) }
+
+      response = perform request, opts
+
       if opts.follow
-        code = 302
-        while code == 302 or code == 301
-          # if the uri isn't fully formed complete it
-          if not uri.match(/\./)
-            uri = "#{method}://#{host}#{uri}"
-          end
-          host = URI.parse(uri).host
-          opts.headers["Host"] = host
-          method_body = body(opts, headers)
-          request = HTTP::Request.new method, uri, headers, proxy, method_body
-          response = perform request, opts
-          code = response.code
-          uri = response.headers["Location"]
+        response = Redirector.new(opts.follow).perform request, response do |req|
+          perform req, opts
         end
       end
 
-      opts.callbacks[:request].each { |c| c.call(request) }
-      response = perform request, opts
       opts.callbacks[:response].each { |c| c.call(response) }
-
       format_response method, response, opts.response
     end
 

data/lib/http/redirector.rb

@@ -0,0 +1,61 @@
+module HTTP
+  class Redirector
+    # Notifies that we reached max allowed redirect hops
+    class TooManyRedirectsError < RuntimeError; end
+
+    # Notifies that following redirects got into an endless loop
+    class EndlessRedirectError < TooManyRedirectsError; end
+
+    # HTTP status codes which indicate redirects
+    REDIRECT_CODES = [300, 301, 302, 303, 307, 308].freeze
+
+    # :nodoc:
+    def initialize(max_redirects)
+      @max_redirects = max_redirects
+    end
+
+    # Follows redirects until non-redirect response found
+    def perform(request, response, &block)
+      reset(request, response)
+      follow(&block)
+    end
+
+  private
+
+    # Reset redirector state
+    def reset(request, response)
+      @request, @response = request, response
+      @visited = []
+    end
+
+    # Follow redirects
+    def follow
+      while REDIRECT_CODES.include?(@response.code)
+        @visited << @request.uri.to_s
+
+        fail TooManyRedirectsError if too_many_hops?
+        fail EndlessRedirectError  if endless_loop?
+
+        uri = @response.headers['Location']
+        fail StateError, 'no Location header in redirect' unless uri
+
+        @request  = @request.redirect(uri)
+        @response = yield @request
+      end
+
+      @response
+    end
+
+    # Check if we reached max amount of redirect hops
+    def too_many_hops?
+      return false if @max_redirects.is_a?(TrueClass)
+      @max_redirects.to_i < @visited.count
+    end
+
+    # Check if we got into an endless loop
+    def endless_loop?
+      # pretty naive condition
+      2 < @visited.count(@visited.last)
+    end
+  end
+end

data/lib/http/request.rb

@@ -54,6 +54,14 @@ module HTTP
       @proxy, @body, @version = proxy, body, version
     end
 
+    # Returns new Request with updated uri
+    def redirect(uri)
+      uri = @uri.merge uri.to_s
+      req = self.class.new(method, uri, headers, proxy, body, version)
+      req.headers.merge!('Host' => req.uri.host)
+      req
+    end
+
     # Obtain the given header
     def [](header)
       @headers[canonicalize_header(header)]

data/lib/http/version.rb

@@ -1,3 +1,3 @@
 module HTTP
-  VERSION = "0.5.0" unless defined?(HTTP::VERSION)
+  VERSION = "0.5.1" unless defined?(HTTP::VERSION)
 end

data/spec/http/request_spec.rb

@@ -16,4 +16,51 @@ describe HTTP::Request do
       expect(subject.headers).to eq("Accept" => "text/html", "Host" => "example.com")
     end
   end
+
+  describe '#redirect' do
+    let(:headers)   { {:accept => 'text/html'} }
+    let(:proxy)     { {:proxy_username => 'douglas', :proxy_password => 'adams'} }
+    let(:body)      { 'The Ultimate Question' }
+    let(:request)   { HTTP::Request.new(:post, 'http://example.com/', headers, proxy, body) }
+
+    subject(:redirected) { request.redirect 'http://blog.example.com/' }
+
+    its(:uri)     { should eq URI.parse 'http://blog.example.com/' }
+
+    its(:method)  { should eq request.method }
+    its(:body)    { should eq request.body }
+    its(:proxy)   { should eq request.proxy }
+
+    it 'presets new Host header' do
+      expect(redirected.headers['Host']).to eq 'blog.example.com'
+    end
+
+    context 'with relative URL given' do
+      subject(:redirected) { request.redirect '/blog' }
+
+      its(:uri)     { should eq URI.parse 'http://example.com/blog' }
+
+      its(:method)  { should eq request.method }
+      its(:body)    { should eq request.body }
+      its(:proxy)   { should eq request.proxy }
+
+      it 'keeps Host header' do
+        expect(redirected.headers['Host']).to eq 'example.com'
+      end
+    end
+
+    context 'with relative URL that misses leading slash given' do
+      subject(:redirected) { request.redirect 'blog' }
+
+      its(:uri)     { should eq URI.parse 'http://example.com/blog' }
+
+      its(:method)  { should eq request.method }
+      its(:body)    { should eq request.body }
+      its(:proxy)   { should eq request.proxy }
+
+      it 'keeps Host header' do
+        expect(redirected.headers['Host']).to eq 'example.com'
+      end
+    end
+  end
 end

data/spec/http_spec.rb

@@ -117,6 +117,16 @@ describe HTTP do
       expect(response).to match(/<!doctype html>/)
     end
 
+    it "should include previous host" do
+      response = HTTP.with_follow(true).get("#{test_endpoint}relative-redirect-302")
+      expect(response).to match(/<!doctype html>/)
+    end
+
+    it "should parse redirects with params" do
+      response = HTTP.with_follow(true).get("#{test_endpoint}relative-redirect-with-params-302")
+      expect(response).to match(/Params!/)
+    end
+
   end
 
   context "head requests" do

data/spec/support/example_server.rb

@@ -34,6 +34,14 @@ class ExampleService < WEBrick::HTTPServlet::AbstractServlet
     when "/redirect-302"
       response.status = 302
       response["Location"] = "http://127.0.0.1:#{PORT}/"
+    when "/relative-redirect-302"
+      response.request_uri = nil
+      response.status = 302
+      response["Location"] = "/"
+    when "/relative-redirect-with-params-302"
+      response.request_uri = nil
+      response.status = 302
+      response["Location"] = "/params?foo=bar"
     else
       response.status = 404
     end

metadata

@@ -1,69 +1,69 @@
 --- !ruby/object:Gem::Specification
 name: http
 version: !ruby/object:Gem::Version
-  version: 0.5.0
+  version: 0.5.1
 platform: ruby
 authors:
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-14 00:00:00.000000000 Z
+date: 2014-05-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: http_parser.rb
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.11'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '2.11'
 - !ruby/object:Gem::Dependency
   name: json
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - ">="
       - !ruby/object:Gem::Version
         version: '0'
 description: HTTP so awesome it will lure Catherine Zeta Jones into your unicorn petting
@@ -74,17 +74,17 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
-- .coveralls.yml
-- .gitignore
-- .rspec
-- .travis.yml
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
 - CHANGES.md
 - Gemfile
 - Guardfile
 - LICENSE.txt
 - README.md
 - Rakefile
-- examples/celluloid.rb
+- examples/parallel_requests_with_celluloid.rb
 - http.gemspec
 - lib/http.rb
 - lib/http/chainable.rb
@@ -93,6 +93,7 @@ files:
 - lib/http/mime_type.rb
 - lib/http/mime_types/json.rb
 - lib/http/options.rb
+- lib/http/redirector.rb
 - lib/http/request.rb
 - lib/http/request_stream.rb
 - lib/http/response.rb
@@ -124,17 +125,17 @@ require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.3
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: HTTP should be easy

data/examples/celluloid.rb

@@ -1,12 +0,0 @@
-#!/usr/bin/env ruby
-#
-# Example of using the HTTP Gem with Celluloid::IO
-# Make sure to 'gem install celluloid-io' before running
-#
-# Run as: bundle exec examples/celluloid.rb
-#
-
-require 'celluloid/io'
-require 'http'
-
-puts HTTP.get("https://www.google.com/", :socket_class => Celluloid::IO::TCPSocket, :ssl_socket_class => Celluloid::IO::SSLSocket)