http 0.7.4 → 0.8.0.pre

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 2dc204ae6f2c91cf31abb8704b2ca61ffde46eaf
-  data.tar.gz: 0daaaf5280369bb67b9c0fa457e89617d6c44c07
+  metadata.gz: a705cb32b18d35b7b100eea0ac6f6687c8e9140e
+  data.tar.gz: fff73981101e4bc7a80faeded4d8bde937dd0fa4
 SHA512:
-  metadata.gz: a120df1c2722cdb5e2021f4c5022c81096d8014f0b78a932335127b7a9c721a7ace19cd64afc5c65846ebd1d890f3db0203e474c248752b693d6775986a32b90
-  data.tar.gz: bfbbcde564743cb8e30147ed58a19f6ae154d6bdd512e106334ce4d8bb4f4c2bd101170f4acb72259896d3a37f64ffed206e9d52e1807d42755732d569759e6d
+  metadata.gz: 32e0571165aff841356c98fdea9135c6e746a36527f7f7db566effb2321d58dc287b26efbd9651c961cb675fc0621333a12cd0608e3b9cc5a57b0259f220d13d
+  data.tar.gz: 7b90b9fba3136f9732667dbae22a561b3f338a11f86e70878494d11b657d7cc64e19403ceb1a5898a844c886e384ae31752cf894527404279d3c5d6b79a4cf96

data/.rspec

@@ -3,4 +3,3 @@
 --format=documentation
 --order random
 --require spec_helper
---warnings

data/.rubocop.yml

@@ -20,8 +20,8 @@ Metrics/ParameterLists:
   Max: 3
   CountKeywordArgs: true
 
-Style/AccessModifierIndentation:
-  EnforcedStyle: outdent
+Metrics/AbcSize:
+  Enabled: false
 
 Style/CollectionMethods:
   PreferredMethods:
@@ -57,5 +57,8 @@ Style/SingleSpaceBeforeFirstArg:
 Style/SpaceInsideHashLiteralBraces:
   EnforcedStyle: no_space
 
+Style/StringLiterals:
+  EnforcedStyle: double_quotes
+
 Style/TrivialAccessors:
   Enabled: false

data/CHANGES.md

@@ -1,14 +1,20 @@
-## 0.7.4 (2015-03-31)
-
-* Re-packed and re-released gem with correct file permissions.
+## 0.8.0.pre (2015-03-26)
+
+* Support for persistent HTTP connections
+* Improve servers used in specs boot up. Issue was initially raised up
+  by @olegkovalenko. See #176.
+* Reflect FormData rename changes (FormData -> HTTP::FormData). (@ixti)
+* `HTTP::Headers` now raises `HTTP::InvalidHeaderNameError` in case of
+  (surprise) invalid HTTP header field name (e.g.`"Foo:Bar"`). See #173.
+  (@ixti)
 
 
 ## 0.7.3 (2015-03-24)
 
-* SECURITY FIX: http.rb failed to call the #post_connection_check method
-  on SSL connections. This method implements hostname verification, and
-  without it http.rb was vulnerable to MitM attacks. The problem was
-  corrected by calling #post_connection_check (CVE-2015-1828)
+* SECURITY FIX: http.rb failed to call the `#post_connection_check` method on
+  SSL connections. This method implements hostname verification, and without it
+  `http.rb` was vulnerable to MitM attacks. The problem was corrected by calling
+  `#post_connection_check` (CVE-2015-1828) (@zanker)
 
 
 ## 0.7.2 (2015-03-02)
@@ -24,6 +30,9 @@
 
 ## 0.7.0 (2015-01-02)
 
+* Add support of multipart form data. See #73, #167. (@ixti)
+* Fix URI path normalization: `https://github.com` -> `https://github.com/`.
+  (@ixti)
 * Fix handling of EOF which caused infinite loop. See #163, #166 and #152. (@mickm, @ixti)
 * Drop Ruby 1.8.7 support. (@ixti)
 * Fix default Host header value. See #150. (@ixti)
@@ -46,6 +55,14 @@
 * Delegate `HTTP::Response#readpartial` to `HTTP::Response::Body` (@ixti)
 
 
+## 0.6.4 (2015-03-25)
+
+* SECURITY FIX: http.rb failed to call the `#post_connection_check` method on
+  SSL connections. This method implements hostname verification, and without it
+  `http.rb` was vulnerable to MitM attacks. The problem was corrected by calling
+  `#post_connection_check` (CVE-2015-1828) (@zanker, backported by @nicoolas25)
+
+
 ## 0.6.3 (2014-11-14)
 
 * Backported EOF fix from master branch. See #166. (@ixti)

data/CONTRIBUTING.md

@@ -0,0 +1,25 @@
+# Help and Discussion
+
+If you need help or just want to talk about the http.rb,
+visit the http.rb Google Group:
+
+https://groups.google.com/forum/#!forum/httprb
+
+You can join by email by sending a message to:
+
+[httprb+subscribe@googlegroups.com](mailto:httprb+subscribe@googlegroups.com)
+
+
+# Reporting bugs
+
+The best way to report a bug is by providing a reproduction script. A half
+working script with comments for the parts you were unable to automate is still
+appreciated.
+
+In any case, specify following info in description of your issue:
+
+- What you're trying to accomplish
+- What you expected to happen
+- What actually happened
+- The exception backtrace(s), if any
+- Version of gem or commit ref you are using

data/Gemfile

@@ -1,37 +1,39 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-gem 'jruby-openssl' if defined? JRUBY_VERSION
-gem 'rake'
+gem "jruby-openssl" if defined? JRUBY_VERSION
+gem "rake"
+
+gem "rack-cache", "~> 1.2"
 
 group :development do
-  gem 'celluloid-io'
-  gem 'guard'
-  gem 'guard-rspec'
-  gem 'pry'
+  gem "celluloid-io"
+  gem "guard"
+  gem "guard-rspec", :require => false
+  gem "pry"
 
   platforms :ruby_19, :ruby_20 do
-    gem 'pry-debugger'
-    gem 'pry-stack_explorer'
+    gem "pry-debugger"
+    gem "pry-stack_explorer"
   end
 end
 
 group :test do
-  gem 'backports'
-  gem 'coveralls'
-  gem 'json',         '>= 1.8.1'
-  gem 'mime-types',   '~> 1.25',  :platforms => [:jruby]
-  gem 'rest-client',  '~> 1.6.0', :platforms => [:jruby]
-  gem 'rspec',        '~> 3.0'
-  gem 'rspec-its'
-  gem 'rubocop',      '~> 0.25.0'
-  gem 'simplecov',    '>= 0.9'
-  gem 'yardstick'
-  gem 'certificate_authority'
+  gem "backports"
+  gem "coveralls"
+  gem "simplecov",    ">= 0.9"
+  gem "json",         ">= 1.8.1"
+  gem "mime-types",   "~> 1.25",  :platforms => [:jruby]
+  gem "rest-client",  "~> 1.6.0", :platforms => [:jruby]
+  gem "rspec",        "~> 3.0"
+  gem "rspec-its"
+  gem "rubocop"
+  gem "yardstick"
+  gem "certificate_authority"
 end
 
 group :doc do
-  gem 'redcarpet'
-  gem 'yard'
+  gem "redcarpet"
+  gem "yard"
 end
 
 # Specify your gem's dependencies in http.gemspec

data/Guardfile

@@ -1,7 +1,7 @@
 # More info at https://github.com/guard/guard#readme
 
-guard :rspec, :cmd => 'bundle exec rspec' do
-  require 'guard/rspec/dsl'
+guard :rspec, :cmd => "GUARD_RSPEC=1 bundle exec rspec --no-profile" do
+  require "guard/rspec/dsl"
   dsl = Guard::RSpec::Dsl.new(self)
 
   # RSpec files

data/README.md

@@ -1,9 +1,9 @@
 ![http.rb](https://raw.github.com/httprb/http.rb/master/logo.png)
 ==============
-[![Gem Version](https://badge.fury.io/rb/http.png)](http://rubygems.org/gems/http)
-[![Build Status](https://secure.travis-ci.org/httprb/http.rb.png?branch=master)](http://travis-ci.org/httprb/http.rb)
-[![Code Climate](https://codeclimate.com/github/httprb/http.rb.png)](https://codeclimate.com/github/httprb/http.rb)
-[![Coverage Status](https://coveralls.io/repos/httprb/http.rb/badge.png?branch=master)](https://coveralls.io/r/httprb/http.rb)
+[![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
 -----
@@ -125,6 +125,15 @@ Or just a plain body?
 HTTP.post('http://example.com/resource', :body => 'foo=42&bar=baz')
 ```
 
+Posting a file?
+
+``` ruby
+HTTP.post('http://examplc.com/resource', :form => {
+  :username => 'ixti',
+  :avatar   => HTTP::FormData::File.new('/home/ixit/avatar.png')
+})
+```
+
 It's easy!
 
 ### Proxy Support
@@ -240,6 +249,27 @@ 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
+[RFC 7234](https://tools.ietf.org/html/rfc7234)) when configured to do
+so.
+
+```ruby
+require 'http'
+
+http = HTTP.with_cache(metastore:   "file:/var/cache/my-app-http/meta",
+                       entitystore: "file:/var/cache/my-app-http/entity")
+
+http.get("http://example.com/")   # makes request
+http.get("http://example.com/")   # skips making request and returns
+                                  # previously cached response
+```
+
+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
 -----------------------
 

data/Rakefile

@@ -1,26 +1,26 @@
 #!/usr/bin/env rake
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
 
-require 'rspec/core/rake_task'
+require "rspec/core/rake_task"
 RSpec::Core::RakeTask.new
 
 task :test => :spec
 
 begin
-  require 'rubocop/rake_task'
+  require "rubocop/rake_task"
   RuboCop::RakeTask.new
 rescue LoadError
   task :rubocop do
-    $stderr.puts 'RuboCop is disabled'
+    $stderr.puts "RuboCop is disabled"
   end
 end
 
-require 'yardstick/rake/measurement'
+require "yardstick/rake/measurement"
 Yardstick::Rake::Measurement.new do |measurement|
-  measurement.output = 'measurement/report.txt'
+  measurement.output = "measurement/report.txt"
 end
 
-require 'yardstick/rake/verify'
+require "yardstick/rake/verify"
 Yardstick::Rake::Verify.new do |verify|
   verify.require_exact_threshold = false
   verify.threshold = 58

data/examples/parallel_requests_with_celluloid.rb

@@ -6,8 +6,8 @@
 # Run as: bundle exec examples/parallel_requests_with_celluloid.rb
 #
 
-require 'celluloid/io'
-require 'http'
+require "celluloid/io"
+require "http"
 
 class HttpFetcher
   include Celluloid::IO

data/http.gemspec

@@ -1,29 +1,29 @@
 # -*- encoding: utf-8 -*-
-require File.expand_path('../lib/http/version', __FILE__)
+require File.expand_path("../lib/http/version", __FILE__)
 
 Gem::Specification.new do |gem|
-  gem.authors       = ['Tony Arcieri', 'Erik Michaels-Ober', 'Aleksey V. Zapparov']
-  gem.email         = ['bascule@gmail.com']
+  gem.authors       = ["Tony Arcieri", "Erik Michaels-Ober", "Aleksey V. Zapparov"]
+  gem.email         = ["bascule@gmail.com"]
 
-  gem.description   = <<-DESCRIPTION.strip.gsub(/\s+/, ' ')
+  gem.description   = <<-DESCRIPTION.strip.gsub(/\s+/, " ")
     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.
   DESCRIPTION
 
-  gem.summary       = 'HTTP should be easy'
-  gem.homepage      = 'https://github.com/httprb/http.rb'
-  gem.licenses      = ['MIT']
+  gem.summary       = "HTTP should be easy"
+  gem.homepage      = "https://github.com/httprb/http.rb"
+  gem.licenses      = ["MIT"]
 
   gem.executables   = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }
   gem.files         = `git ls-files`.split("\n")
   gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
-  gem.name          = 'http'
-  gem.require_paths = ['lib']
+  gem.name          = "http"
+  gem.require_paths = ["lib"]
   gem.version       = HTTP::VERSION
 
-  gem.add_runtime_dependency 'http_parser.rb', '~> 0.6.0'
-  gem.add_runtime_dependency 'http-form_data', '~> 1.0.0'
+  gem.add_runtime_dependency "http_parser.rb", "~> 0.6.0"
+  gem.add_runtime_dependency "http-form_data", "~> 1.0.0"
 
-  gem.add_development_dependency 'bundler', '~> 1.0'
+  gem.add_development_dependency "bundler", "~> 1.0"
 end

data/lib/http.rb

@@ -1,14 +1,15 @@
-require 'http/parser'
+require "http/parser"
 
-require 'http/errors'
-require 'http/chainable'
-require 'http/client'
-require 'http/options'
-require 'http/request'
-require 'http/request/writer'
-require 'http/response'
-require 'http/response/body'
-require 'http/response/parser'
+require "http/errors"
+require "http/chainable"
+require "http/client"
+require "http/connection"
+require "http/options"
+require "http/request"
+require "http/request/writer"
+require "http/response"
+require "http/response/body"
+require "http/response/parser"
 
 # HTTP should be easy
 module HTTP

data/lib/http/cache.rb

@@ -0,0 +1,146 @@
+require "time"
+require "rack-cache"
+
+module HTTP
+  class Cache
+    # NoOp logger.
+    class NullLogger
+      def error(_msg = nil)
+      end
+
+      def debug(_msg = nil)
+      end
+
+      def info(_msg = nil)
+      end
+
+      def warn(_msg = nil)
+      end
+    end
+
+    # @return [Response] a cached response that is valid for the request or
+    #   the result of executing the provided block
+    #
+    # @yield [request, options] on cache miss so that an actual
+    # request can be made
+    def perform(request, options, &request_performer)
+      req = request.caching
+
+      invalidate_cache(req) if req.invalidates_cache?
+
+      get_response(req, options, request_performer)
+    end
+
+    protected
+
+    # @return [Response] the response to the request, either from the
+    # cache or by actually making the request
+    def get_response(req, options, request_performer)
+      cached_resp = cache_lookup(req)
+      return cached_resp if cached_resp && !cached_resp.stale?
+
+      # cache miss
+      logger.debug { "Cache miss for <#{req.uri}>, making request" }
+      actual_req = if cached_resp
+                     req.conditional_on_changes_to(cached_resp)
+                   else
+                     req
+                   end
+      actual_resp = make_request(actual_req, options, request_performer)
+
+      handle_response(cached_resp, actual_resp, req)
+    end
+
+    # @returns [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." }
+        cached_resp.validated!(actual_resp)
+        store_in_cache(req, cached_resp)
+        return cached_resp
+
+      elsif req.cacheable? && actual_resp.cacheable?
+        store_in_cache(req, actual_resp)
+        return actual_resp
+
+      else
+        return actual_resp
+      end
+    end
+
+    # @return [HTTP::Response::Caching] the actual response returned
+    # by request_performer
+    def make_request(req, options, request_performer)
+      req.sent_at = Time.now
+
+      request_performer.call(req, options).caching.tap do |res|
+        res.received_at  = Time.now
+        res.requested_at = req.sent_at
+      end
+    end
+
+    # @return [HTTP::Response::Caching, nil] the cached response for the request
+    def cache_lookup(request)
+      return nil if request.skips_cache?
+
+      rack_resp = metastore.lookup(request, entitystore)
+      return if rack_resp.nil?
+
+      HTTP::Response.new(
+        rack_resp.status, "1.1", rack_resp.headers, stringify(rack_resp.body)
+      ).caching
+    end
+
+    # Store response in cache
+    #
+    # @return [nil]
+    #
+    # ---
+    #
+    # We have to convert the response body in to a string body so
+    # that the cache store reading the body will not prevent the
+    # original requester from doing so.
+    def store_in_cache(request, response)
+      response.body = response.body.to_s
+      metastore.store(request, response, entitystore)
+      nil
+    end
+
+    # Invalidate all response from the requested resource
+    #
+    # @return [nil]
+    def invalidate_cache(request)
+      metastore.invalidate(request, entitystore)
+    end
+
+    # Inits a new instance
+    #
+    # @option opts [String] :metastore   URL to the metastore location
+    # @option opts [String] :entitystore URL to the entitystore location
+    # @option opts [Logger] :logger      logger to use
+    def initialize(opts)
+      @metastore   = storage.resolve_metastore_uri(opts.fetch(:metastore))
+      @entitystore = storage.resolve_entitystore_uri(opts.fetch(:entitystore))
+      @logger = opts.fetch(:logger) { NullLogger.new }
+    end
+
+    attr_reader :metastore, :entitystore, :logger
+
+    def storage
+      @@storage ||= Rack::Cache::Storage.new # rubocop:disable Style/ClassVars
+    end
+
+    def stringify(body)
+      if body.respond_to?(:each)
+        "".tap do |buf|
+          body.each do |part|
+            buf << part
+          end
+        end
+      else
+        body.to_s
+      end
+    end
+  end
+end