http 0.3.0 → 0.4.0

data/CHANGES.md

@@ -1,3 +1,10 @@
+0.4.0
+-----
+* Fix bug accessing https URLs
+* Fix several instances of broken redirect handling
+* Add default user agent
+* Many additional minor bugfixes
+
 0.3.0
 -----
 * New implementation based on tmm1's http_parser.rb instead of Net::HTTP

data/README.md

@@ -25,8 +25,15 @@ Http.post "http://example.com/resource", :form => {:foo => "42"}
 ```
 
 Want to POST with a specific body, JSON for instance?
+
+```ruby
+Http.post "http://example.com/resource", :body => JSON.dump(:foo => '42')
+```
+
+Or have it serialize JSON for you:
+
 ```ruby
-Http.post "http://example.com/resource", :body => JSON.dump(:foo => "42")
+Http.post "http://example.com/resource", :json => {:foo => '42'}
 ```
 
 It's easy!

data/http.gemspec

@@ -13,7 +13,7 @@ Gem::Specification.new do |gem|
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
   gem.name          = "http"
   gem.require_paths = ["lib"]
-  gem.version       = Http::VERSION
+  gem.version       = HTTP::VERSION
 
   gem.add_runtime_dependency 'http_parser.rb'
   gem.add_runtime_dependency 'certified'

data/lib/http.rb

@@ -8,12 +8,13 @@ require 'http/client'
 require 'http/mime_type'
 require 'http/options'
 require 'http/request'
+require 'http/request_stream'
 require 'http/response'
 require 'http/response_parser'
 require 'http/uri_backport' if RUBY_VERSION < "1.9.0"
 
 # HTTP should be easy
-module Http
+module HTTP
   extend Chainable
 
   # The method given was not understood
@@ -38,3 +39,5 @@ module Http
     end
   end
 end
+
+Http = HTTP unless defined?(Http)

data/lib/http/chainable.rb

@@ -1,4 +1,4 @@
-module Http
+module HTTP
   module Chainable
     # Request a get sans response body
     def head(uri, options = {})
@@ -54,15 +54,15 @@ module Http
     def on(event, &block)
       branch default_options.with_callback(event, block)
     end
-    
+
     # Make a request through an HTTP proxy
     def via(*proxy)
-      proxy_hash = {}    
+      proxy_hash = {}
       proxy_hash[:proxy_address] = proxy[0] if proxy[0].is_a? String
       proxy_hash[:proxy_port]    = proxy[1] if proxy[1].is_a? Integer
       proxy_hash[:proxy_username]= proxy[2] if proxy[2].is_a? String
       proxy_hash[:proxy_password]= proxy[3] if proxy[3].is_a? String
-      
+
       if proxy_hash.keys.size >=2
         branch default_options.with_proxy(proxy_hash)
       else

data/lib/http/client.rb

@@ -1,6 +1,6 @@
 require 'uri'
 
-module Http
+module HTTP
   # Clients make requests and receive responses
   class Client
     include Chainable
@@ -25,17 +25,23 @@ module Http
     # Make an HTTP request
     def request(method, uri, options = {})
       opts = @default_options.merge(options)
+      host = URI.parse(uri).host
+      opts.headers["Host"] = host
       headers = opts.headers
       proxy = opts.proxy
 
       method_body = body(opts, headers)
-      puts method_body
       request = Request.new method, uri, headers, proxy, method_body
 
       if opts.follow
         code = 302
         while code == 302 or code == 301
-          puts uri
+          # if the uri isn't fully formed complete it
+          if not uri.match /\./
+            uri = "http://#{host}#{uri}"
+          end
+          host = URI.parse(uri).host
+          opts.headers["Host"] = host
           method_body = body(opts, headers)
           request = Request.new method, uri, headers, proxy, method_body
           response = perform request, opts
@@ -57,7 +63,12 @@ module Http
       socket = options[:socket_class].open(uri.host, uri.port) # TODO: proxy support
 
       if uri.is_a?(URI::HTTPS)
-        socket = options[:ssl_socket_class].open(socket, options[:ssl_context])
+        if options[:ssl_context] == nil
+          context = OpenSSL::SSL::SSLContext.new
+        else
+          context = options[:ssl_context]
+        end
+        socket = options[:ssl_socket_class].new(socket, context)
         socket.connect
       end
 

data/lib/http/compat/curb.rb

@@ -62,21 +62,21 @@ module Curl
       perform
     end
   end
-  
+
   class Multi
     def initialize
       @clients = []
       @done = false
     end
-    
+
     def add(client)
       @clients << client
     end
-    
-    
+
+
     def perform
       return if @done
-      
+
       @clients.map do |client|
         Thread.new { client.perform }
       end.each(&:join)
@@ -84,4 +84,4 @@ module Curl
       @done = true
     end
   end
-end
+end

data/lib/http/mime_type.rb

@@ -1,4 +1,4 @@
-module Http
+module HTTP
   # Yes, Http bundles its own MIME type library. Maybe it should be spun off
   # as a separate gem or something.
   class MimeType

data/lib/http/mime_types/json.rb

@@ -16,4 +16,4 @@ json.emit_with do |obj|
   else
     obj
   end
-end
+end

data/lib/http/options.rb

@@ -1,7 +1,7 @@
 require 'socket'
 require 'openssl'
 
-module Http
+module HTTP
   class Options
 
     # How to format the response [:object, :body, :parse_body]
@@ -57,6 +57,8 @@ module Http
       @socket_class     = options[:socket_class]     || self.class.default_socket_class
       @ssl_socket_class = options[:ssl_socket_class] || self.class.default_ssl_socket_class
       @ssl_context      = options[:ssl_context]
+
+      @headers["User-Agent"] ||= "RubyHttpGem/#{Http::VERSION}"
     end
 
     def with_response(response)

data/lib/http/request.rb

@@ -1,4 +1,4 @@
-module Http
+module HTTP
   class Request
     # Method is given as a lowercase symbol e.g. :get, :post
     attr_reader :method
@@ -33,38 +33,9 @@ module Http
 
     # Stream the request to a socket
     def stream(socket)
-      request_header = "#{method.to_s.upcase} #{uri.path} HTTP/#{version}#{CRLF}"
-      @headers.each do |field, value|
-        request_header << "#{field}: #{value}#{CRLF}"
-      end
-
-      case body
-      when NilClass
-        socket << request_header << CRLF
-        return
-      when String
-        request_header << "Content-Length: #{body.length}#{CRLF}" unless @headers['Content-Length']
-        request_header << CRLF
-
-        socket << request_header
-        socket << body.to_s
-      when Enumerable
-        if encoding = @headers['Transfer-Encoding']
-          raise ArgumentError, "invalid transfer encoding" unless encoding == "chunked"
-          request_header << CRLF
-        else
-          request_header << "Transfer-Encoding: chunked#{CRLF * 2}"
-        end
-
-        socket << request_header
-        body.each do |chunk|
-          socket << chunk.bytesize.to_s(16) << CRLF
-          socket << chunk
-        end
-
-        socket << "0" << CRLF * 2
-      else raise TypeError, "invalid body type: #{body.class}"
-      end
+      request_header = "#{method.to_s.upcase} #{uri.path} HTTP/#{version}"
+      rs = Http::RequestStream.new socket, body, @headers, request_header
+      rs.stream
     end
   end
 end

data/lib/http/request_stream.rb

@@ -0,0 +1,73 @@
+module HTTP
+  class RequestStream
+    def initialize(socket, body, headers, headerstart)
+      @body           = body
+      raise ArgumentError, "body of wrong type" unless valid_body_type
+      @socket         = socket
+      @headers        = headers
+      @request_header = [headerstart]
+    end
+
+    def valid_body_type
+      valid_types= [String, NilClass, Enumerable]
+      checks = valid_types.map {|type| @body.is_a? type}
+      checks.any?
+    end
+
+    #Adds headers to the request header from the headers array
+    def add_headers
+      @headers.each do |field, value|
+        @request_header << "#{field}: #{value}"
+      end
+    end
+
+    # Stream the request to a socket
+    def stream
+      self.send_request_header
+      self.send_request_body
+    end
+
+    # 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 and not @headers['Content-Length']
+        @request_header << "Content-Length: #{@body.length}"
+      elsif @body.is_a? Enumerable
+        if encoding = @headers['Transfer-Encoding'] and not encoding == "chunked"
+          raise ArgumentError, "invalid transfer encoding"
+        else
+          @request_header << "Transfer-Encoding: chunked"
+        end
+      end
+    end
+
+    # Joins the headers specified in the request into a correctly formatted
+    # http request header string
+    def join_headers
+      # join the headers array with crlfs, stick two on the end because
+      # that ends the request header
+      @request_header.join(CRLF) + (CRLF)*2
+    end
+
+    def send_request_header
+      self.add_headers
+      self.add_body_type_headers
+      header = self.join_headers
+
+      @socket << header
+    end
+
+    def send_request_body
+      if @body.is_a? String
+        @socket << @body
+      elsif @body.is_a? Enumerable
+        @body.each do |chunk|
+          @socket << chunk.bytesize.to_s(16) << CRLF
+          @socket << chunk
+        end
+
+        @socket << "0" << CRLF * 2
+      end
+    end
+  end
+end

data/lib/http/response.rb

@@ -1,4 +1,4 @@
-module Http
+module HTTP
   class Response
     STATUS_CODES = {
       100 => 'Continue',

data/lib/http/response_parser.rb

@@ -1,4 +1,4 @@
-module Http
+module HTTP
   class Response
     class Parser
       attr_reader :headers

data/lib/http/version.rb

@@ -1,3 +1,3 @@
-module Http
-  VERSION = "0.3.0"
+module HTTP
+  VERSION = "0.4.0"
 end

data/spec/http/compat/curb_spec.rb

@@ -19,14 +19,14 @@ describe Curl do
       end
     end
   end
-  
+
   describe Curl::Multi do
     it "gets resources" do
       requests  = [test_endpoint]
       responses = []
-      
+
       multi = Curl::Multi.new
-      
+
       requests.each do |url|
         response = Curl::Easy.new url, :get
         multi.add response
@@ -37,4 +37,4 @@ describe Curl do
       responses.first.body_str.should match(/<!doctype html>/)
     end
   end
-end
+end

data/spec/http/options/headers_spec.rb

@@ -2,16 +2,17 @@ require 'spec_helper'
 
 describe Http::Options, "headers" do
 
-  let(:opts){ Http::Options.new }
+  let(:opts)       { Http::Options.new }
+  let(:user_agent) { "RubyHttpGem/#{Http::VERSION}" }
 
-  it 'defaults to {}' do
-    opts.headers.should eq({})
+  it 'defaults to just the user agent' do
+    opts.headers.should eq("User-Agent" => user_agent)
   end
 
   it 'may be specified with with_headers' do
     opts2 = opts.with_headers("accept" => "json")
-    opts.headers.should eq({})
-    opts2.headers.should eq("accept" => "json")
+    opts.headers.should eq("User-Agent" => user_agent)
+    opts2.headers.should eq("accept" => "json", "User-Agent" => user_agent)
   end
 
   it 'accepts any object that respond to :to_hash' do

data/spec/http/options/merge_spec.rb

@@ -2,7 +2,8 @@ require 'spec_helper'
 
 describe Http::Options, "merge" do
 
-  let(:opts){ Http::Options.new }
+  let(:opts)       { Http::Options.new }
+  let(:user_agent) { "RubyHttpGem/#{Http::VERSION}" }
 
   it 'supports a Hash' do
     old_response = opts.response
@@ -34,7 +35,7 @@ describe Http::Options, "merge" do
       :response  => :parsed_body,
       :form      => {:bar => 'bar'},
       :body      => "body-bar",
-      :headers   => {:accept  => "xml", :foo => "foo", :bar => 'bar'},
+      :headers   => {:accept  => "xml", :foo => "foo", :bar => 'bar', "User-Agent" => user_agent},
       :proxy     => {:proxy_address => "127.0.0.1", :proxy_port => 8080},
       :callbacks => {:request => ["common"], :response => ["foo", "bar"]},
       :follow => nil

data/spec/http/options/new_spec.rb

@@ -1,6 +1,7 @@
 require 'spec_helper'
 
 describe Http::Options, "new" do
+  let(:user_agent) { "RubyHttpGem/#{Http::VERSION}" }
 
   it 'supports a Options instance' do
     opts = Http::Options.new
@@ -8,7 +9,6 @@ describe Http::Options, "new" do
   end
 
   context 'with a Hash' do
-
     it 'coerces :response correctly' do
       opts = Http::Options.new(:response => :object)
       opts.response.should eq(:object)
@@ -16,9 +16,9 @@ describe Http::Options, "new" do
 
     it 'coerces :headers correctly' do
       opts = Http::Options.new(:headers => {:accept => "json"})
-      opts.headers.should eq(:accept => "json")
+      opts.headers.should eq(:accept => "json", "User-Agent" => user_agent)
     end
-    
+
     it 'coerces :proxy correctly' do
       opts = Http::Options.new(:proxy => {:proxy_address => "127.0.0.1", :proxy_port => 8080})
       opts.proxy.should eq(:proxy_address => "127.0.0.1", :proxy_port => 8080)

data/spec/http/options/proxy_spec.rb

@@ -18,4 +18,4 @@ describe Http::Options, "proxy" do
     opts2 = opts.with_proxy(:proxy_address => "127.0.0.1", :proxy_port => 8080, :proxy_username => "username", :proxy_password => "password")
     opts2.proxy.should eq(:proxy_address => "127.0.0.1", :proxy_port => 8080, :proxy_username => "username", :proxy_password => "password")
   end
-end
+end

data/spec/http/options/response_spec.rb

@@ -15,7 +15,7 @@ describe Http::Options, "response" do
   end
 
   it 'recognizes invalid responses' do
-    lambda{ 
+    lambda{
       opts.with_response(:not_a_valid_response)
     }.should raise_error(ArgumentError, /not_a_valid_response/)
   end

data/spec/http/request_stream_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Http::RequestStream do
+  describe "#initalize" do
+    def construct(body)
+      Http::RequestStream.new(nil, body, [], "")
+    end
+
+    it "doesn't throw on a nil body" do
+      expect {construct []}.to_not raise_error(ArgumentError)
+    end
+
+    it "doesn't throw on a String body" do
+      expect {construct "string body"}.to_not raise_error(ArgumentError)
+    end
+
+    it "doesn't throw on an Enumerable body" do
+      expect {construct ["bees", "cows"]}.to_not raise_error(ArgumentError)
+    end
+
+    it "does throw on a body that isn't string, enumerable or nil" do
+      expect {construct true}.to raise_error(ArgumentError)
+
+    end
+  end
+end

data/spec/http_spec.rb

@@ -11,6 +11,19 @@ describe Http do
       response.should match(/<!doctype html>/)
     end
 
+    it "should be easy to get a https resource" do
+      response = Http.with_headers(:accept => 'application/json').get "https://api.github.com/users/samphippen"
+      response["type"].should == "User"
+    end
+
+    it "can get some real world sites, following redirects if necessary" do
+      sites = ["http://github.com/", "http://xkcd.com/", "http://www.spotify.com/"]
+      sites.each do |site|
+        resp = Http.with_response(:object).with_follow(true).get site
+        resp.status.should == 200
+      end
+    end
+
     context "with_response" do
       it 'allows specifying :object' do
         res = Http.with_response(:object).get test_endpoint

data/spec/spec_helper.rb

@@ -1,3 +1,3 @@
 require 'http'
 require 'support/example_server'
-require 'support/proxy_server'
+require 'support/proxy_server'

data/spec/support/proxy_server.rb

@@ -1,17 +1,17 @@
 require 'webrick/httpproxy'
- 
+
 ProxyServer     = WEBrick::HTTPProxyServer.new(:Port => 8080, :AccessLog => [])
-  
+
 t = Thread.new { ProxyServer.start }
 trap("INT")    { ProxyServer.shutdown; exit }
 
-AuthenticatedProxyServer = WEBrick::HTTPProxyServer.new(:Port => 8081, 
+AuthenticatedProxyServer = WEBrick::HTTPProxyServer.new(:Port => 8081,
                   :ProxyAuthProc => Proc.new do | req, res |
                     WEBrick::HTTPAuth.proxy_basic_auth(req, res, 'proxy') do | user, pass |
                       user == 'username' and pass == 'password'
                     end
                   end)
-                  
+
 
 t = Thread.new { AuthenticatedProxyServer.start }
 trap("INT")    { AuthenticatedProxyServer.shutdown; exit }

metadata

@@ -1,79 +1,102 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: http
-version: !ruby/object:Gem::Version
-  version: 0.3.0
+version: !ruby/object:Gem::Version 
+  hash: 15
   prerelease: 
+  segments: 
+  - 0
+  - 4
+  - 0
+  version: 0.4.0
 platform: ruby
-authors:
+authors: 
 - Tony Arcieri
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-09-01 00:00:00.000000000 Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2012-10-12 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
   name: http_parser.rb
-  requirement: &70356765427900 !ruby/object:Gem::Requirement
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  requirement: *id001
   prerelease: false
-  version_requirements: *70356765427900
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: certified
-  requirement: &70356765427240 !ruby/object:Gem::Requirement
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :runtime
+  requirement: *id002
   prerelease: false
-  version_requirements: *70356765427240
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &70356765442460 !ruby/object:Gem::Requirement
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id003
   prerelease: false
-  version_requirements: *70356765442460
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &70356765441700 !ruby/object:Gem::Requirement
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id004
   prerelease: false
-  version_requirements: *70356765441700
-- !ruby/object:Gem::Dependency
+- !ruby/object:Gem::Dependency 
   name: json
-  requirement: &70356765441120 !ruby/object:Gem::Requirement
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
   type: :development
+  requirement: *id005
   prerelease: false
-  version_requirements: *70356765441120
-description: HTTP so awesome it will lure Catherine Zeta Jones into your unicorn petting
-  zoo
-email:
+description: HTTP so awesome it will lure Catherine Zeta Jones into your unicorn petting zoo
+email: 
 - tony.arcieri@gmail.com
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .rspec
 - .travis.yml
@@ -91,6 +114,7 @@ files:
 - lib/http/mime_types/json.rb
 - lib/http/options.rb
 - lib/http/request.rb
+- lib/http/request_stream.rb
 - lib/http/response.rb
 - lib/http/response_parser.rb
 - lib/http/streaming_body.rb
@@ -106,6 +130,7 @@ files:
 - spec/http/options/proxy_spec.rb
 - spec/http/options/response_spec.rb
 - spec/http/options_spec.rb
+- spec/http/request_stream_spec.rb
 - spec/http/response_spec.rb
 - spec/http_spec.rb
 - spec/spec_helper.rb
@@ -113,29 +138,38 @@ files:
 - spec/support/proxy_server.rb
 homepage: https://github.com/tarcieri/http
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
 requirements: []
+
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.24
 signing_key: 
 specification_version: 3
 summary: HTTP should be easy
-test_files:
+test_files: 
 - spec/http/compat/curb_spec.rb
 - spec/http/options/body_spec.rb
 - spec/http/options/callbacks_spec.rb
@@ -146,9 +180,9 @@ test_files:
 - spec/http/options/proxy_spec.rb
 - spec/http/options/response_spec.rb
 - spec/http/options_spec.rb
+- spec/http/request_stream_spec.rb
 - spec/http/response_spec.rb
 - spec/http_spec.rb
 - spec/spec_helper.rb
 - spec/support/example_server.rb
 - spec/support/proxy_server.rb
-has_rdoc: