faraday 0.8.1 → 0.8.2

data/Gemfile

@@ -1,13 +1,13 @@
 source 'https://rubygems.org'
 
 group :development do
-  gem 'sinatra', '~> 1.2'
+  gem 'sinatra', '~> 1.3'
 end
 
 group :test do
   gem 'em-http-request', '~> 1.0', :require => 'em-http'
   gem 'em-synchrony', '~> 1.0', :require => ['em-synchrony', 'em-synchrony/em-http'], :platforms => :ruby_19
-  gem 'excon', '~> 0.6'
+  gem 'excon', '>= 0.14.1'
   gem 'net-http-persistent', '~> 2.5', :require => false
   gem 'leftright', '~> 0.9', :require => false
   gem 'rack-test', '~> 0.6', :require => 'rack/test'
@@ -15,7 +15,7 @@ end
 
 platforms :ruby do
   gem 'patron', '~> 0.4', '> 0.4.1'
-  gem 'typhoeus', '~> 0.3', '> 0.3.2'
+  gem 'typhoeus', '~> 0.3.3'
 end
 
 platforms :jruby do

data/README.md

@@ -1,6 +1,4 @@
-# Faraday [![Build Status](https://secure.travis-ci.org/technoweenie/faraday.png?branch=master)][travis] [![Dependency Status](https://gemnasium.com/technoweenie/faraday.png?travis)][gemnasium]
-[travis]: http://travis-ci.org/technoweenie/faraday
-[gemnasium]: https://gemnasium.com/technoweenie/faraday
+# Faraday
 
 Faraday is an HTTP client lib that provides a common interface over many
 adapters (such as Net::HTTP) and embraces the concept of Rack middleware when
@@ -8,11 +6,11 @@ processing the request/response cycle.
 
 Faraday supports these adapters:
 
-* Net/HTTP
-* Excon
-* Typhoeus
-* Patron
-* EventMachine
+* Net::HTTP
+* [Excon][]
+* [Typhoeus][]
+* [Patron][]
+* [EventMachine][]
 
 It also includes a Rack adapter for hitting loaded Rack applications through
 Rack::Test, and a Test adapter for stubbing requests by hand.
@@ -20,15 +18,10 @@ Rack::Test, and a Test adapter for stubbing requests by hand.
 ## Usage
 
 ```ruby
-conn = Faraday.new(:url => 'http://sushi.com') do |builder|
-  builder.use Faraday::Request::UrlEncoded  # convert request params as "www-form-urlencoded"
-  builder.use Faraday::Response::Logger     # log the request to STDOUT
-  builder.use Faraday::Adapter::NetHttp     # make http requests with Net::HTTP
-
-  # or, use shortcuts:
-  builder.request  :url_encoded
-  builder.response :logger
-  builder.adapter  :net_http
+conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
+  faraday.request  :url_encoded             # form-encode POST params
+  faraday.response :logger                  # log requests to STDOUT
+  faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
 end
 
 ## GET ##
@@ -36,7 +29,7 @@ end
 response = conn.get '/nigiri/sake.json'     # GET http://sushi.com/nigiri/sake.json
 response.body
 
-conn.get '/nigiri', { :name => 'Maguro' } # GET /nigiri?name=Maguro
+conn.get '/nigiri', { :name => 'Maguro' }   # GET /nigiri?name=Maguro
 
 conn.get do |req|                           # GET http://sushi.com/search?page=2&limit=100
   req.url '/search', :page => 2
@@ -54,7 +47,7 @@ conn.post do |req|
   req.body = '{ "name": "Unagi" }'
 end
 
-## Options ##
+## Per-request options ##
 
 conn.get do |req|
   req.url '/search'
@@ -63,25 +56,26 @@ conn.get do |req|
 end
 ```
 
-If you're ready to roll with just the bare minimum:
+If you don't need to set up anything, you can roll with just the bare minimum:
 
 ```ruby
-# default stack (net/http), no extra middleware:
+# using the default stack:
 response = Faraday.get 'http://sushi.com/nigiri/sake.json'
 ```
 
 ## Advanced middleware usage
+
 The order in which middleware is stacked is important. Like with Rack, the
 first middleware on the list wraps all others, while the last middleware is the
-innermost one, so that's usually the adapter.
+innermost one, so that must be the adapter.
 
 ```ruby
-conn = Faraday.new(:url => 'http://sushi.com') do |builder|
+Faraday.new(...) do |conn|
   # POST/PUT params encoders:
-  builder.request :multipart
-  builder.request :url_encoded
+  conn.request :multipart
+  conn.request :url_encoded
 
-  builder.adapter :net_http
+  conn.adapter :net_http
 end
 ```
 
@@ -99,18 +93,17 @@ process it.
 Examples:
 
 ```ruby
-payload = { :name => 'Maguro' }
-
 # uploading a file:
-payload = { :profile_pic => Faraday::UploadIO.new('avatar.jpg', 'image/jpeg') }
+payload[:profile_pic] = Faraday::UploadIO.new('/path/to/avatar.jpg', 'image/jpeg')
 
 # "Multipart" middleware detects files and encodes with "multipart/form-data":
 conn.put '/profile', payload
 ```
 
 ## Writing middleware
-Middleware are classes that respond to `call()`. They wrap the request/response
-cycle.
+
+Middleware are classes that implement a `call` instance method. They hook into
+the request/response cycle.
 
 ```ruby
 def call(env)
@@ -142,7 +135,7 @@ later, response. Some keys are:
 :response_headers
 ```
 
-## Testing
+## Using Faraday for testing
 
 ```ruby
 # It's possible to define stubbed request outside a test adapter block.
@@ -178,36 +171,51 @@ stubs.verify_stubbed_calls
 ```
 
 ## TODO
+
 * support streaming requests/responses
 * better stubbing API
 
-## Note on Patches/Pull Requests
-1. Fork the project.
-2. Make your feature addition or bug fix.
-3. Add tests for it. This is important so I don't break it in a future version
-   unintentionally.
-4. Commit, do not mess with rakefile, version, or history. (if you want to have
-   your own version, that is fine but bump version in a commit by itself I can
-   ignore when I pull)
-5. Send us a pull request. Bonus points for topic branches.
+## Contributing
+
+You can run the test suite against a live server by running `script/test`. It
+automatically starts a test server in background. Only tests in
+`test/adapters/*_test.rb` require a server, though.
+
+``` sh
+# run the whole suite
+$ script/test
+
+# run only specific files
+$ script/test excon typhoeus
+```
+
+We will accept middleware that:
+
+1. is useful to a broader audience, but can be implemented relatively
+   simple; and
+2. which isn't already present in [faraday_middleware][] project.
+
+We will accept adapters that:
+
+1. support SSL & streaming;
+1. are proven and may have better performance than existing ones; or
+2. if they have features not present in included adapters.
 
 We are pushing towards a 1.0 release, when we will have to follow [Semantic
-Versioning](http://semver.org/).  If your patch includes changes to break
-compatiblitity, note that so we can add it to the [Changelog](https://github.com/technoweenie/faraday/wiki/Changelog).
+Versioning][semver].  If your patch includes changes to break compatiblitity,
+note that so we can add it to the [Changelog][].
+
+## Supported Ruby versions
 
-## Supported Ruby Versions
 This library aims to support and is [tested against][travis] the following Ruby
 implementations:
 
-* Ruby 1.8.7
-* Ruby 1.9.2
-* Ruby 1.9.3
-* JRuby[]
+* MRI 1.8.7
+* MRI 1.9.2
+* MRI 1.9.3
+* [JRuby][]
 * [Rubinius][]
 
-[jruby]: http://jruby.org/
-[rubinius]: http://rubini.us/
-
 If something doesn't work on one of these interpreters, it should be considered
 a bug.
 
@@ -223,7 +231,20 @@ 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.
 
 ## Copyright
+
 Copyright (c) 2009-2012 [Rick Olson](mailto:technoweenie@gmail.com), zack hobson.
 See [LICENSE][] for details.
 
-[license]: https://github.com/technoweenie/faraday/blob/master/LICENSE.md
+
+  [license]:   https://github.com/technoweenie/faraday/blob/master/LICENSE.md
+  [travis]:    http://travis-ci.org/technoweenie/faraday
+  [jruby]:     http://jruby.org/
+  [rubinius]:  http://rubini.us/
+  [semver]:    http://semver.org/
+  [changelog]: https://github.com/technoweenie/faraday/wiki/Changelog
+  [excon]:     https://github.com/geemus/excon#readme
+  [typhoeus]:  https://github.com/typhoeus/typhoeus#readme
+  [patron]:    http://toland.github.com/patron/
+
+  [eventmachine]:       https://github.com/igrigorik/em-http-request#readme
+  [faraday_middleware]: https://github.com/pengwynn/faraday_middleware/wiki

data/Rakefile

@@ -28,16 +28,9 @@ end
 
 ## standard tasks
 
-Rake::TestTask.new(:test) do |test|
-  test.libs << 'lib' << 'test'
-  test.pattern = 'test/**/*_test.rb'
-  test.verbose = true
-end
-
-desc "Run tests including live tests against a local server on port 4567"
-task :"test:local" do
-  ENV['LIVE'] = '1'
-  Rake::Task[:test].invoke
+desc "Run all tests"
+task :test do
+  exec 'script/test'
 end
 
 desc "Open an irb session preloaded with this library"
@@ -51,7 +44,7 @@ desc "Commit, create tag v#{version} and build and push #{gem_file} to Rubygems"
 task :release => :build do
   sh "git commit --allow-empty -a -m 'Release #{version}'"
   sh "git tag v#{version}"
-  sh "git push origin master"
+  sh "git push origin"
   sh "git push origin v#{version}"
   sh "gem push pkg/#{gem_file}"
 end

data/faraday.gemspec

@@ -3,7 +3,7 @@ Gem::Specification.new do |s|
   s.required_rubygems_version = Gem::Requirement.new(">= 1.3.5") if s.respond_to? :required_rubygems_version=
 
   s.name    = 'faraday'
-  s.version = '0.8.1'
+  s.version = '0.8.2'
 
   s.summary     = "HTTP/REST API client library."
   # TODO: s.description
@@ -16,7 +16,6 @@ Gem::Specification.new do |s|
   s.add_development_dependency 'rake'
   s.add_development_dependency 'simplecov'
   s.add_development_dependency 'test-unit'
-  s.add_development_dependency 'webmock'
 
   # = MANIFEST =
   s.files = %w[
@@ -54,6 +53,7 @@ Gem::Specification.new do |s|
     lib/faraday/response/raise_error.rb
     lib/faraday/upload_io.rb
     lib/faraday/utils.rb
+    script/test
     test/adapters/default_test.rb
     test/adapters/em_http_test.rb
     test/adapters/em_synchrony_test.rb

data/lib/faraday.rb

@@ -1,5 +1,5 @@
 module Faraday
-  VERSION = "0.8.1"
+  VERSION = "0.8.2"
 
   class << self
     attr_accessor :root_path, :lib_path

data/lib/faraday/adapter/excon.rb

@@ -6,22 +6,49 @@ module Faraday
       def call(env)
         super
 
-        conn = ::Excon.new(env[:url].to_s)
+        opts = {}
         if env[:url].scheme == 'https' && ssl = env[:ssl]
-          ::Excon.ssl_verify_peer = !!ssl.fetch(:verify, true)
-          ::Excon.ssl_ca_path = ssl[:ca_file] if ssl[:ca_file]
+          opts[:ssl_verify_peer] = !!ssl.fetch(:verify, true)
+          opts[:ssl_ca_path] = ssl[:ca_path] if ssl[:ca_path]
+          opts[:ssl_ca_file] = ssl[:ca_file] if ssl[:ca_file]
         end
 
+        if ( req = env[:request] )
+          if req[:timeout]
+            opts[:read_timeout]      = req[:timeout]
+            opts[:connect_timeout]   = req[:timeout]
+            opts[:write_timeout]     = req[:timeout]
+          end
+
+          if req[:open_timeout]
+            opts[:connect_timeout]   = req[:open_timeout]
+            opts[:write_timeout]     = req[:open_timeout]
+          end
+        end
+
+        conn = ::Excon.new(env[:url].to_s, opts)
+
         resp = conn.request \
           :method  => env[:method].to_s.upcase,
           :headers => env[:request_headers],
-          :body    => env[:body]
+          :body    => read_body(env)
 
         save_response(env, resp.status.to_i, resp.body, resp.headers)
 
         @app.call env
-      rescue ::Excon::Errors::SocketError
-        raise Error::ConnectionFailed, $!
+      rescue ::Excon::Errors::SocketError => err
+        if err.message =~ /\btimeout\b/
+          raise Error::TimeoutError, err
+        else
+          raise Error::ConnectionFailed, err
+        end
+      rescue ::Excon::Errors::Timeout => err
+        raise Error::TimeoutError, err
+      end
+
+      # TODO: support streaming requests
+      def read_body(env)
+        env[:body].respond_to?(:read) ? env[:body].read : env[:body]
       end
     end
   end

data/lib/faraday/adapter/net_http.rb

@@ -17,7 +17,8 @@ module Faraday
         Net::HTTPBadResponse,
         Net::HTTPHeaderSyntaxError,
         Net::ProtocolError,
-        SocketError
+        SocketError,
+        Zlib::GzipFile::Error,
       ]
 
       NET_HTTP_EXCEPTIONS << OpenSSL::SSL::SSLError if defined?(OpenSSL)

data/lib/faraday/adapter/rack.rb

@@ -13,7 +13,7 @@ module Faraday
     #   end
     #
     #   Faraday.new do |conn|
-    #     conn.adapter :rack, MyRackApp
+    #     conn.adapter :rack, MyRackApp.new
     #   end
     class Rack < Faraday::Adapter
       dependency 'rack/test'

data/script/test

@@ -0,0 +1,99 @@
+#!/usr/bin/env ruby -rubygems -w
+# Runs the test suite against a local server spawned automatically in a
+# thread. After tests are done, the server is shut down.
+#
+# If filename arguments are given, only those files are run. If arguments given
+# are not filenames, they are taken as words that filter the list of files to run.
+#
+# Examples
+#
+#   $ script/test
+#   $ script/test test/env_test.rb
+#   $ script/test excon typhoeus
+
+require 'bundler'
+begin
+  Bundler.setup
+rescue Bundler::GemNotFound
+  $stderr.print "Error: "
+  $stderr.puts $!.message
+  warn "Run `bundle install` to install missing gems."
+  exit 1
+end
+
+host      = '127.0.0.1'
+logfile   = 'log/test.log'
+test_glob = 'test/**/*_test.rb'
+
+require 'fileutils'
+FileUtils.mkdir_p 'log'
+
+# find available port
+require 'socket'
+port = begin
+  server = TCPServer.new(host, 0)
+  server.addr[1]
+ensure
+  server.close if server
+end
+
+server = nil
+
+# start test server in a separate thread
+thread = Thread.new do
+  old_verbose, $VERBOSE = $VERBOSE, nil
+  begin
+    require File.expand_path('../../test/live_server', __FILE__)
+  ensure
+    $VERBOSE = old_verbose
+  end
+  require 'webrick'
+  log_io = File.open logfile, 'w'
+  webrick_opts = {
+    :Port => port, :Logger => WEBrick::Log::new(log_io),
+    :AccessLog => [[log_io, "[%{X-Faraday-Adapter}i] %m  %U  ->  %s %b"]]
+  }
+  Rack::Handler::WEBrick.run(Faraday::LiveServer, webrick_opts) {|serv| server = serv }
+end
+
+# find files to test
+test_files = Dir[test_glob]
+if ARGV.any?
+  all_files, test_files = test_files, []
+  args, extra_args = ARGV, []
+  if idx = args.index('--')
+     extra_args = args[(idx+1)..-1]
+     args = args[0, idx]
+  end
+  for arg in args
+    re = /(\b|_)#{arg}(\b|_)/
+    test_files.concat all_files.select { |f| f =~ re }
+  end
+  test_files.concat extra_args
+end
+
+require 'net/http'
+conn = Net::HTTP.new host, port
+conn.open_timeout = conn.read_timeout = 0.05
+
+# test if test server is accepting requests
+responsive = lambda { |path|
+  begin
+    res = conn.start { conn.get(path) }
+    res.is_a?(Net::HTTPSuccess)
+  rescue Errno::ECONNREFUSED, Errno::EBADF, Timeout::Error
+    false
+  end
+}
+
+require 'timeout'
+Timeout.timeout 40 do
+  # block until test server is ready
+  thread.join 0.05 until responsive.call('/echo')
+end
+
+ENV['LIVE'] = "http://#{host}:#{port}"
+system 'ruby', '-Ilib:test', '-S', 'testrb', *test_files
+
+server.respond_to?(:stop!) ? server.stop! : server.stop
+thread.join

data/test/adapters/excon_test.rb

@@ -5,19 +5,6 @@ module Adapters
 
     def adapter() :excon end
 
-    # https://github.com/geemus/excon/issues/98
-    if defined?(RUBY_ENGINE) and "rbx" == RUBY_ENGINE
-      warn "Warning: Skipping Excon tests on Rubinius"
-    else
-      Integration.apply(self, :NonParallel) do
-        # https://github.com/eventmachine/eventmachine/pull/289
-        undef :test_timeout
-
-        # FIXME: this test fails on Travis with
-        # "Faraday::Error::ClientError: the server responded with status 400"
-        undef :test_POST_sends_files if ENV['CI']
-      end
-    end
-
+    Integration.apply(self, :NonParallel)
   end
 end

data/test/adapters/integration.rb

@@ -8,7 +8,7 @@ module Adapters
   # `#adapter_options` optional. extra arguments for building an adapter
   module Integration
     def self.apply(base, *extras)
-      if Faraday::TestCase::LIVE_SERVER
+      if base.live_server?
         ([:Common] + extras).each {|name| base.send(:include, self.const_get(name)) }
         yield if block_given?
       elsif !defined? @warned
@@ -179,7 +179,10 @@ module Adapters
           end
         end
 
-        Faraday::Connection.new(Faraday::TestCase::LIVE_SERVER, options, &builder_block).tap do |conn|
+        server = self.class.live_server
+        url = 'http://%s:%d' % [server.host, server.port]
+
+        Faraday::Connection.new(url, options, &builder_block).tap do |conn|
           conn.headers['X-Faraday-Adapter'] = adapter.to_s
           adapter_handler = conn.builder.handlers.last
           conn.builder.insert_before adapter_handler, Faraday::Response::RaiseError

data/test/adapters/net_http_persistent_test.rb

@@ -5,7 +5,10 @@ module Adapters
 
     def adapter() :net_http_persistent end
 
-    Integration.apply(self, :NonParallel)
+    Integration.apply(self, :NonParallel) do
+      # https://github.com/drbrain/net-http-persistent/issues/33
+      undef :test_timeout
+    end
 
   end
 end

data/test/adapters/net_http_test.rb

@@ -10,35 +10,6 @@ module Adapters
 
     Integration.apply(self, *behaviors)
 
-    def test_connection_errors_get_wrapped
-      connection = Faraday.new('http://disney.com') do |b|
-        b.adapter :net_http
-      end
-
-      exceptions = [
-        EOFError,
-        Errno::ECONNABORTED,
-        Errno::ECONNREFUSED,
-        Errno::ECONNRESET,
-        Errno::EINVAL,
-        Net::HTTPBadResponse,
-        Net::HTTPHeaderSyntaxError,
-        Net::ProtocolError,
-        SocketError
-      ]
-
-      exceptions << OpenSSL::SSL::SSLError if defined?(OpenSSL)
-
-      exceptions.each do |exception_class|
-        stub_request(:get, 'disney.com/hello').to_raise(exception_class)
-
-        assert_raise(Faraday::Error::ConnectionFailed,
-                     "Failed to wrap #{exception_class} exceptions") do
-          connection.get('/hello')
-        end
-      end
-    end
-
     def test_configure_ssl
       http = Net::HTTP.new 'disney.com', 443
       # this should not raise an error

data/test/adapters/rack_test.rb

@@ -7,7 +7,7 @@ module Adapters
     def adapter() :rack end
 
     def adapter_options
-      [FaradayTestServer]
+      [Faraday::LiveServer]
     end
 
     # no Integration.apply because this doesn't require a server as a separate process

data/test/helper.rb

@@ -9,7 +9,6 @@ unless ENV['CI']
 end
 
 require 'test/unit'
-require 'stringio'
 
 if ENV['LEFTRIGHT']
   begin
@@ -29,14 +28,34 @@ else
   Debugger.start
 end
 
+require 'stringio'
+require 'uri'
+
 module Faraday
-  class TestCase < Test::Unit::TestCase
-    LIVE_SERVER = case ENV['LIVE']
-      when /^http/ then ENV['LIVE']
-      when nil     then nil
-      else 'http://127.0.0.1:4567'
+  module LiveServerConfig
+    def live_server=(value)
+      @@live_server = case value
+      when /^http/
+        URI(value)
+      when /./
+        URI('http://127.0.0.1:4567')
+      end
+    end
+
+    def live_server?
+      defined? @@live_server
     end
 
+    # Returns an object that responds to `host` and `port`.
+    def live_server
+      live_server? and @@live_server
+    end
+  end
+
+  class TestCase < Test::Unit::TestCase
+    extend LiveServerConfig
+    self.live_server = ENV['LIVE']
+
     def test_default
       assert true
     end unless defined? ::MiniTest
@@ -52,6 +71,3 @@ module Faraday
     end
   end
 end
-
-require 'webmock/test_unit'
-WebMock.disable_net_connect!(:allow => Faraday::TestCase::LIVE_SERVER)

data/test/live_server.rb

@@ -1,8 +1,10 @@
 require 'sinatra/base'
 
-class FaradayTestServer < Sinatra::Base
-  set :logging => false,
-      :show_exceptions => false
+module Faraday
+class LiveServer < Sinatra::Base
+  set :environment, :test
+  disable :logging
+  disable :protection
 
   [:get, :post, :put, :patch, :delete, :options].each do |method|
     send(method, '/echo') do
@@ -44,7 +46,8 @@ class FaradayTestServer < Sinatra::Base
     "#{e.class}\n#{e.to_s}\n#{e.backtrace.join("\n")}"
   end
 end
+end
 
 if $0 == __FILE__
-  FaradayTestServer.run!
+  Faraday::LiveServer.run!
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: faraday
 version: !ruby/object:Gem::Version
-  version: 0.8.1
+  version: 0.8.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-05-29 00:00:00.000000000 Z
+date: 2012-08-12 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: multipart-post
@@ -75,22 +75,6 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-- !ruby/object:Gem::Dependency
-  name: webmock
-  requirement: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
 description: 
 email: technoweenie@gmail.com
 executables: []
@@ -131,6 +115,7 @@ files:
 - lib/faraday/response/raise_error.rb
 - lib/faraday/upload_io.rb
 - lib/faraday/utils.rb
+- script/test
 - test/adapters/default_test.rb
 - test/adapters/em_http_test.rb
 - test/adapters/em_synchrony_test.rb
@@ -172,7 +157,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: 1.3.5
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.24
+rubygems_version: 1.8.23
 signing_key: 
 specification_version: 2
 summary: HTTP/REST API client library.
@@ -198,4 +183,3 @@ test_files:
 - test/middleware_stack_test.rb
 - test/request_middleware_test.rb
 - test/response_middleware_test.rb
-has_rdoc: