http 0.5.1 → 0.6.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2283ed9a55615bac08d7583ed41495c24ea37ba3
-  data.tar.gz: a960101f10e0d3beda0cf7b458db420621b1afc9
+  metadata.gz: b647051e277907433baf4b118a8b63a3d04aa67b
+  data.tar.gz: 30e721ae9be7d37ad8e9359ad0d52dce0f6a8d16
 SHA512:
-  metadata.gz: 5057731fa424ae08bf7e9e70e0eaa97eb66d1b1f9bb68622b1b49f086759a0d230c45467ee8e9130dfcb4a52bc5b0d107e7cd54b5bb11ee52c384defb3a3d76e
-  data.tar.gz: 5bfcac350c4bb47424922e225a67f320826029936cdbdb17a474554ef36ca1be4ae1bbc791dcd410f5b8e302f4f05e192452beb7748cdec8fded74032ca6c103
+  metadata.gz: 2531298e15fc793c052a03e524875151c91d8eb111fdb9c6886546009cf827dab8d51eb8158052cdaaa1edcb968a63c4be89350fc357cc1972a20c04693429c3
+  data.tar.gz: ecf369955e78188f2d6eff9c159b55beb9d160a9ce36f6acb5472b5d1c9cd5b374b848582901861389da4ba0e0b8ead5d7f92b1d223ec1ed30212839f321aa3f

data/.gitignore

@@ -1,18 +1,18 @@
 *.gem
-*.rbc
 .bundle
 .config
+.rvmrc
 .yardoc
 Gemfile.lock
 InstalledFiles
 _yardoc
 coverage
-doc/
+doc
 lib/bundler/man
+measurement
 pkg
 rdoc
 spec/reports
 test/tmp
 test/version_tmp
 tmp
-.rvmrc

data/.rspec

@@ -1,4 +1,5 @@
---color
---format documentation
 --backtrace
+--color
+--format=documentation
+--order random
 --warnings

data/.rubocop.yml

@@ -0,0 +1,101 @@
+AllCops:
+  Includes:
+    - 'Gemfile'
+    - 'Rakefile'
+    - 'http.gemspec'
+
+# Avoid long parameter lists
+ParameterLists:
+  Max: 3
+  CountKeywordArgs: true
+
+MethodLength:
+  CountComments: false
+  Max: 31 # TODO: lower to 15
+
+ClassLength:
+  CountComments: false
+  Max: 132 # TODO: lower to 100
+
+CyclomaticComplexity:
+  Max: 13 # TODO: lower to 6
+
+# Avoid more than `Max` levels of nesting.
+BlockNesting:
+  Max: 3
+
+# Do not force public/protected/private keyword to be indented at the same
+# level as the def keyword. My personal preference is to outdent these keywords
+# because I think when scanning code it makes it easier to identify the
+# sections of code and visually separate them. When the keyword is at the same
+# level I think it sort of blends in with the def keywords and makes it harder
+# to scan the code and see where the sections are.
+AccessModifierIndentation:
+  Enabled: false
+
+# Limit line length
+LineLength:
+  Enabled: false
+
+# Disable documentation checking until a class needs to be documented once
+Documentation:
+  Enabled: false
+
+# Not all trivial readers/writers can be defined with attr_* methods
+TrivialAccessors:
+  Enabled: false
+
+# Enforce Ruby 1.8-compatible hash syntax
+HashSyntax:
+  EnforcedStyle: hash_rockets
+
+# No spaces inside hash literals
+SpaceInsideHashLiteralBraces:
+  EnforcedStyle: no_space
+
+# Allow dots at the end of lines
+DotPosition:
+  Enabled: false
+
+# Don't require magic comment at the top of every file
+Encoding:
+  Enabled: false
+
+# Enforce outdenting of access modifiers (i.e. public, private, protected)
+AccessModifierIndentation:
+  EnforcedStyle: outdent
+
+EmptyLinesAroundAccessModifier:
+  Enabled: true
+
+# Align ends correctly
+EndAlignment:
+  AlignWith: variable
+
+# Indentation of when/else
+CaseIndentation:
+  IndentWhenRelativeTo: end
+  IndentOneStep: false
+
+# Use the old lambda literal syntax
+Lambda:
+  Enabled: false
+
+DoubleNegation:
+  Enabled: false
+
+PercentLiteralDelimiters:
+  PreferredDelimiters:
+    '%':  ()
+    '%i': ()
+    '%q': ()
+    '%Q': ()
+    '%r': '{}'
+    '%s': ()
+    '%w': '[]'
+    '%W': '[]'
+    '%x': ()
+
+Semicolon:
+  Exclude:
+    - 'spec/support/'

data/.travis.yml

@@ -1,16 +1,27 @@
+before_install:
+  - gem update bundler
+  - bundle --version
+  - gem update --system 2.1.11
+  - gem --version
+bundler_args: --without development
+language: ruby
 rvm:
   - 1.8.7
+  - 1.9.2
   - 1.9.3
   - 2.0.0
-  - ree
+  - 2.1.0
+  - rbx-2
   - ruby-head
-  - jruby-18mode
-  - jruby-19mode
-  - jruby-head
-  - rbx-18mode
-  - rbx-19mode
-
 matrix:
+  include:
+    - rvm: jruby-18mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-19mode
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
+    - rvm: jruby-head
+      env: JRUBY_OPTS="$JRUBY_OPTS --debug"
   allow_failures:
-    - rvm: ruby-head
     - rvm: jruby-head
+    - rvm: ruby-head
+  fast_finish: true

data/Gemfile

@@ -1,12 +1,30 @@
 source 'http://rubygems.org'
 
+gem 'rake', '~> 10.1.1'
 gem 'jruby-openssl' if defined? JRUBY_VERSION
-gem 'coveralls', :require => false
-
-# Specify your gem's dependencies in http.gemspec
-gemspec
 
 group :development do
-  gem 'guard-rspec'
-  gem 'celluloid-io' if RUBY_VERSION >= "1.9.3"
+  gem 'pry'
+  platforms :ruby_19, :ruby_20 do
+    gem 'pry-debugger'
+    gem 'pry-stack_explorer'
+  end
+  platforms :ruby_19, :ruby_20, :ruby_21 do
+    gem 'celluloid-io'
+    gem 'guard-rspec'
+  end
+end
+
+group :test do
+  gem 'backports'
+  gem 'coveralls', :require => false
+  gem 'json', '>= 1.8.1', :platforms => [:jruby, :rbx, :ruby_18, :ruby_19]
+  gem 'mime-types', '~> 1.25', :platforms => [:jruby, :ruby_18]
+  gem 'rspec', '>= 2.14'
+  gem 'rubocop', '>= 0.19', :platforms => [:ruby_19, :ruby_20, :ruby_21]
+  gem 'simplecov', :require => false
+  gem 'yardstick'
 end
+
+# Specify your gem's dependencies in http.gemspec
+gemspec

data/LICENSE.txt

@@ -1,4 +1,4 @@
-Copyright (c) 2011 Tony Arcieri, Carl Lerche
+Copyright (c) 2014 Tony Arcieri, Erik Michaels-Ober
 
 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,17 +1,27 @@
-The HTTP Gem*
+![The HTTP Gem](https://raw.github.com/tarcieri/http/master/logo.png)
 ==============
 [![Gem Version](https://badge.fury.io/rb/http.png)](http://rubygems.org/gems/http)
 [![Build Status](https://secure.travis-ci.org/tarcieri/http.png?branch=master)](http://travis-ci.org/tarcieri/http)
 [![Code Climate](https://codeclimate.com/github/tarcieri/http.png)](https://codeclimate.com/github/tarcieri/http)
 [![Coverage Status](https://coveralls.io/repos/tarcieri/http/badge.png?branch=master)](https://coveralls.io/r/tarcieri/http)
 
-*NOTE: this gem has the worst name in the history of SEO. But perhaps we can fix
-that if we all refer to it as "The HTTP Gem". Entering that phrase into Google
-actually pulls it up as #4 for me!
+SEO Note
+--------
+
+This Gem has the worst name in the history of SEO. But perhaps we can fix that if we
+all refer to it as "The HTTP Gem", or even better, the "Ruby HTTP Gem".
+
+About
+-----
 
 The HTTP Gem is an easy-to-use client library for making requests from Ruby. It uses
-a simple method chaining system for building requests, similar to libraries
-like JQuery or Python's [Requests](http://docs.python-requests.org/en/latest/).
+a simple method chaining system for building requests, similar to Python's [Requests]
+
+Under the hood, The HTTP Gem uses [http_parser.rb], a fast HTTP parsing native
+extension based on the Node.js parser and a Java port thereof.
+
+[requests]: http://docs.python-requests.org/en/latest/
+[http_parser.rb]: https://github.com/tmm1/http_parser.rb
 
 Installation
 ------------
@@ -34,24 +44,64 @@ Inside of your Ruby program do:
 
 ...to pull it in as a dependency.
 
-Making Requests
----------------
+Documentation
+-------------
+
+[Please see the HTTP Gem Wiki](https://github.com/tarcieri/http/wiki)
+for more detailed documentation and usage notes.
+
+Support
+-------
+
+For help with The HTTP Gem, either open a [Github Issue] or discuss it
+on the Celluloid mailing list:
 
-Let's start with getting things:
+http://groups.google.com/group/celluloid-ruby
+
+You can also find us on IRC at #celluloid on freenode
+
+[Github Issue]: https://github.com/tarcieri/http/issues
+
+Basic Usage
+-----------
+
+Here's some simple examples to get you started:
+
+### GET requests
 
 ```ruby
->> HTTP.get("http://www.google.com")
+>> HTTP.get("http://www.google.com").to_s
 => "<html><head><meta http-equiv=\"content-type\" content=..."
 ```
 
-That's it! The result is the response body as a string. To obtain an HTTP::Response object
-instead of the response body, chain `.response` on the end of the request:
+That's all it takes! To obtain an `HTTP::Response` object instead of the response
+body, all we have to do is omit the #to_s on the end:
 
 ```ruby
->> HTTP.get("http://www.google.com").response
+>> HTTP.get("http://www.google.com")
 => #<HTTP/1.0 200 OK @headers={"Content-Type"=>"text/html; charset=UTF-8", "Date"=>"Fri, ...>
+ => #<HTTP::Response/1.1 200 OK @headers={"Content-Type"=>"text/html; ...>
 ```
 
+We can also obtain an `HTTP::ResponseBody` object for this response:
+
+```ruby
+>> HTTP.get("http://www.google.com").body
+ => #<HTTP::ResponseBody:814d7aac @streaming=false>
+```
+
+The response body can be streamed with `HTTP::ResponseBody#readpartial`:
+
+```ruby
+>> HTTP.get("http://www.google.com").body.readpartial
+ => "<!doctype html><html "
+```
+
+In practice you'll want to bind the HTTP::ResponseBody 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?
 
 ```ruby
@@ -66,21 +116,33 @@ HTTP.get "http://example.com/resource", :params => {:foo => "bar"}
 Want to POST with a specific body, JSON for instance?
 
 ```ruby
-HTTP.post "http://example.com/resource", :body => JSON.dump(:foo => '42')
+HTTP.post "http://example.com/resource", :json => { :foo => '42' })
+```
+
+It's easy!
+
+
+### Proxy Support
+
+Making request behind proxy is as simple as making them directly. Just specify
+hostname (or IP address) of your proxy server and it's port, and here you go:
+
+```ruby
+HTTP.via("proxy-hostname.local", 8080)
+  .get "http://example.com/resource"
 ```
 
-Or have it serialize JSON for you:
+Proxy needs authentication? No problem:
 
 ```ruby
-HTTP.post "http://example.com/resource", :json => {:foo => '42'}
+HTTP.via("proxy-hostname.local", 8080, "username", "password")
+  .get "http://example.com/resource"
 ```
 
-It's easy!
 
-Adding Headers
---------------
+### Adding Headers
 
-The HTTP library uses the concept of chaining to simplify requests. Let's say
+The HTTP gem uses the concept of chaining to simplify requests. Let's say
 you want to get the latest commit of this library from Github in JSON format.
 One way we could do this is by tacking a filename on the end of the URL:
 
@@ -102,7 +164,7 @@ HTTP.with_headers(:accept => 'application/json').
 This requests JSON from Github. Github is smart enough to understand our
 request and returns a response with Content-Type: application/json. If you
 happen to have a library loaded which defines the JSON constant and implements
-JSON.parse, the HTTP library will attempt to parse the JSON response.
+JSON.parse, the HTTP gem will attempt to parse the JSON response.
 
 Shorter aliases exists for HTTP.with_headers:
 
@@ -114,8 +176,7 @@ HTTP[:accept => 'application/json'].
   get("https://github.com/tarcieri/http/commit/HEAD")
 ```
 
-Content Negotiation
--------------------
+### Content Negotiation
 
 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
@@ -128,15 +189,69 @@ HTTP.accept(:json).get("https://github.com/tarcieri/http/commit/HEAD")
 This adds the appropriate Accept header for retrieving a JSON response for the
 given resource.
 
-Contributing to HTTP
---------------------
 
-* Fork HTTP on github
+### Celluloid::IO Support
+
+The HTTP Gem makes it simple to make multiple concurrent HTTP requests from a
+Celluloid::IO actor. Here's a parallel HTTP fetcher with the HTTP Gem and
+Celluloid::IO:
+
+```ruby
+require 'celluloid/io'
+require 'http'
+
+class HttpFetcher
+  include Celluloid::IO
+
+  def fetch(url)
+    HTTP.get(url, socket_class: Celluloid::IO::TCPSocket).response
+  end
+end
+```
+
+There's a little more to it, but that's the core idea!
+
+* [Full parallel HTTP fetcher example](https://github.com/tarcieri/http/wiki/Parallel-requests-with-Celluloid%3A%3AIO)
+* See also: [Celluloid::IO](https://github.com/celluloid/celluloid-io)
+
+
+Supported Ruby Versions
+-----------------------
+
+This library aims to support and is [tested against][travis] the following Ruby
+versions:
+
+* Ruby 1.8.7
+* Ruby 1.9.2
+* Ruby 1.9.3
+* Ruby 2.0.0
+* Ruby 2.1.0
+
+If something doesn't work on one of these versions, it's a bug.
+
+This library may inadvertently work (or seem to work) on other Ruby versions,
+however support will only be provided for the versions listed above.
+
+If you would like this library to support another Ruby version or
+implementation, you may volunteer to be a maintainer. Being a maintainer
+entails making sure all tests run and pass on that implementation. When
+something breaks on your implementation, you will be responsible for providing
+patches in a timely fashion. If critical issues for a particular implementation
+exist at the time of a major release, support for that Ruby version may be
+dropped.
+
+[travis]: http://travis-ci.org/tarcieri/http
+
+
+Contributing to The HTTP Gem
+----------------------------
+
+* Fork the HTTP gem on github
 * Make your changes and send me a pull request
-* If I like them I'll merge them
-* If I've accepted a patch, feel free to ask for a commit bit!
+* If we like them we'll merge them
+* If we've accepted a patch, feel free to ask for commit access!
 
 Copyright
 ---------
 
-Copyright (c) 2013 Tony Arcieri. See LICENSE.txt for further details.
+Copyright (c) 2014 Tony Arcieri, Erik Michaels-Ober. See LICENSE.txt for further details.