faraday 0.8.11 → 0.9.0.rc1

data/.document

@@ -0,0 +1,6 @@
+CONTRIBUTING.md
+LICENSE.md
+README.md
+bin/*
+lib/**/*.rb
+test/**/*.rb

data/CONTRIBUTING.md

@@ -0,0 +1,36 @@
+## 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
+
+# run tests using SSL
+$ SSL=yes script/test
+```
+
+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][semver].  If your patch includes changes to break compatiblitity,
+note that so we can add it to the [Changelog][].
+
+[semver]:    http://semver.org/
+[changelog]: https://github.com/technoweenie/faraday/wiki/Changelog
+[faraday_middleware]: https://github.com/pengwynn/faraday_middleware/wiki

data/Gemfile

@@ -1,22 +1,23 @@
 source 'https://rubygems.org'
 
 gem 'ffi-ncurses', '~> 0.3', :platforms => :jruby
-gem 'jruby-openssl', '~> 0.8.8', :platforms => :jruby
+gem 'jruby-openssl', '~> 0.7', :platforms => :jruby
 gem 'rake'
 
 group :test do
-  gem 'test-unit'
-  gem 'em-http-request', '>= 1.1', :require => 'em-http'
+  gem 'coveralls', :require => false
+  gem 'em-http-request', '>= 1.0', :require => 'em-http'
   gem 'em-synchrony', '>= 1.0', :require => ['em-synchrony', 'em-synchrony/em-http']
-  gem 'excon', '>= 0.27.4'
+  gem 'excon', '>= 0.16.1'
+  gem 'httpclient', '>= 2.2'
   gem 'leftright', '>= 0.9', :require => false
-  gem 'mime-types', '~> 1.25', :platforms => [:jruby, :ruby_18]
+  gem 'minitest', '>= 4.3'
   gem 'net-http-persistent', '>= 2.5', :require => false
   gem 'patron', '>= 0.4.2', :platforms => :ruby
   gem 'rack-test', '>= 0.6', :require => 'rack/test'
   gem 'simplecov'
   gem 'sinatra', '~> 1.3'
-  gem 'typhoeus', '~> 0.3.3', :platforms => [:ruby_18, :ruby_19, :ruby_20, :ruby_21]
+  gem 'typhoeus', '~> 0.3.3', :platforms => :ruby
 end
 
 gemspec

data/LICENSE.md

@@ -1,4 +1,4 @@
-Copyright (c) 2009 rick olson, zack hobson
+Copyright (c) 2009-2013 Rick Olson, Zack Hobson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/README.md

@@ -24,6 +24,17 @@ conn = Faraday.new(:url => 'http://sushi.com') do |faraday|
   faraday.adapter  Faraday.default_adapter  # make requests with Net::HTTP
 end
 
+# set proxy with string
+conn.options.proxy = "http://user:password@example.org/"
+
+# set proxy with hash
+conn.options.proxy = { :uri => 'http://user:passwordexample.org' }
+
+# specify proxy user/pass
+conn.options.proxy = { :uri => 'http://user:pass.org',
+  :user => 'user',
+  :password => 'pass' }
+
 ## GET ##
 
 response = conn.get '/nigiri/sake.json'     # GET http://sushi.com/nigiri/sake.json
@@ -51,8 +62,19 @@ end
 
 conn.get do |req|
   req.url '/search'
-  req.options[:timeout] = 5           # open/read timeout in seconds
-  req.options[:open_timeout] = 2      # connection open timeout in seconds
+  req.options.timeout = 5           # open/read timeout in seconds
+  req.options.open_timeout = 2      # connection open timeout in seconds
+
+  # set proxy with string
+  req.options.proxy = "http://user:password@example.org/"
+
+  # set proxy with hash
+  req.options.proxy = { :uri => 'http://user:passwordexample.org' }
+
+  # specify proxy user/pass
+  req.options.proxy = { :uri => 'http://user:pass.org',
+    :user => 'user',
+    :password => 'pass' }
 end
 ```
 
@@ -175,36 +197,6 @@ stubs.verify_stubbed_calls
 * support streaming requests/responses
 * better stubbing API
 
-## 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][semver].  If your patch includes changes to break compatiblitity,
-note that so we can add it to the [Changelog][].
-
 ## Supported Ruby versions
 
 This library aims to support and is [tested against][travis] the following Ruby
@@ -213,11 +205,11 @@ implementations:
 * MRI 1.8.7
 * MRI 1.9.2
 * MRI 1.9.3
+* MRI 2.0.0
 * [JRuby][]
 * [Rubinius][]
 
-If something doesn't work on one of these interpreters, it should be considered
-a bug.
+If something doesn't work on one of these Ruby versions, it's a bug.
 
 This library may inadvertently work (or seem to work) on other Ruby
 implementations, however support will only be provided for the versions listed
@@ -226,25 +218,20 @@ above.
 If you would like this library to support another Ruby version, 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 personally 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.
+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.
 
 ## Copyright
 
-Copyright (c) 2009-2012 [Rick Olson](mailto:technoweenie@gmail.com), zack hobson.
+Copyright (c) 2009-2013 [Rick Olson](mailto:technoweenie@gmail.com), Zack Hobson.
 See [LICENSE][] for details.
 
-
-  [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
+[travis]:    http://travis-ci.org/lostisland/faraday
+[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
+[jruby]:     http://jruby.org/
+[rubinius]:  http://rubini.us/
+[license]:   LICENSE.md

data/Rakefile

@@ -2,6 +2,8 @@ require 'date'
 require 'fileutils'
 require 'openssl'
 require 'rake/testtask'
+require 'bundler'
+Bundler::GemHelper.install_tasks
 
 task :default => :test
 
@@ -67,21 +69,3 @@ desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -r ./lib/#{name}.rb"
 end
-
-## release management tasks
-
-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"
-  sh "git push origin v#{version}"
-  sh "gem push pkg/#{gem_file}"
-end
-
-desc "Build #{gem_file} into the pkg directory"
-task :build do
-  FileUtils.mkdir_p 'pkg'
-  sh "gem build #{gemspec_file}"
-  sh "mv #{gem_file} pkg"
-end

data/faraday.gemspec

@@ -0,0 +1,34 @@
+lib = "faraday"
+lib_file = File.expand_path("../lib/#{lib}.rb", __FILE__)
+File.read(lib_file) =~ /\bVERSION\s*=\s*["'](.+?)["']/
+version = $1
+
+Gem::Specification.new do |spec|
+  spec.specification_version = 2 if spec.respond_to? :specification_version=
+  spec.required_rubygems_version = '>= 1.3.5'
+
+  spec.name    = lib
+  spec.version = version
+
+  spec.summary = "HTTP/REST API client library."
+
+  spec.authors  = ["Rick Olson"]
+  spec.email    = 'technoweenie@gmail.com'
+  spec.homepage = 'https://github.com/lostisland/faraday'
+  spec.licenses = ['MIT']
+
+  spec.add_dependency 'multipart-post', '~> 1.1'
+  spec.add_development_dependency 'bundler', '~> 1.0'
+
+  spec.files = %w(.document CONTRIBUTING.md Gemfile LICENSE.md README.md Rakefile)
+  spec.files << "#{lib}.gemspec"
+  spec.files += Dir.glob("lib/**/*.rb")
+  spec.files += Dir.glob("test/**/*.rb")
+  spec.files += Dir.glob("script/*")
+
+  dev_null    = File.exist?('/dev/null') ? '/dev/null' : 'NUL'
+  git_files   = `git ls-files -z 2>#{dev_null}`
+  spec.files &= git_files.split("\0") if $?.success?
+
+  spec.test_files = Dir.glob("test/**/*.rb")
+end

data/lib/faraday.rb

@@ -1,25 +1,100 @@
+require 'thread'
+require 'cgi'
+require 'set'
+require 'forwardable'
+
+# Public: This is the main namespace for Faraday.  You can either use it to
+# create Faraday::Connection objects, or access it directly.
+#
+# Examples
+#
+#   Faraday.get "http://faraday.com"
+#
+#   conn = Faraday.new "http://faraday.com"
+#   conn.get '/'
+#
 module Faraday
-  VERSION = "0.8.11"
+  VERSION = "0.9.0.rc1"
 
   class << self
-    attr_accessor :root_path, :lib_path
+    # Public: Gets or sets the root path that Faraday is being loaded from.
+    # This is the root from where the libraries are auto-loaded from.
+    attr_accessor :root_path
+
+    # Public: Gets or sets the path that the Faraday libs are loaded from.
+    attr_accessor :lib_path
+
+    # Public: Gets or sets the Symbol key identifying a default Adapter to use
+    # for the default Faraday::Connection.
     attr_accessor :default_adapter
-    attr_writer   :default_connection
 
-    def new(url = nil, options = {})
+    # Public: Sets the default Faraday::Connection for simple scripts that
+    # access the Faraday constant directly.
+    #
+    #     Faraday.get "https://faraday.com"
+    attr_writer :default_connection
+
+    # Public: Sets the default options used when calling Faraday#new.
+    attr_writer :default_connection_options
+
+    # Public: Initializes a new Faraday::Connection.
+    #
+    # url     - The optional String base URL to use as a prefix for all
+    #           requests.  Can also be the options Hash.
+    # options - The optional Hash used to configure this Faraday::Connection.
+    #           Any of these values will be set on every request made, unless
+    #           overridden for a specific request.
+    #           :url     - String base URL.
+    #           :params  - Hash of URI query unencoded key/value pairs.
+    #           :headers - Hash of unencoded HTTP header key/value pairs.
+    #           :request - Hash of request options.
+    #           :ssl     - Hash of SSL options.
+    #           :proxy   - Hash of Proxy options.
+    #
+    # Examples
+    #
+    #   Faraday.new 'http://faraday.com'
+    #
+    #   # http://faraday.com?page=1
+    #   Faraday.new 'http://faraday.com', :params => {:page => 1}
+    #
+    #   # same
+    #
+    #   Faraday.new :url => 'http://faraday.com',
+    #     :params => {:page => 1}
+    #
+    # Returns a Faraday::Connection.
+    def new(url = nil, options = nil)
       block = block_given? ? Proc.new : nil
+      options = options ? default_connection_options.merge(options) : default_connection_options.dup
       Faraday::Connection.new(url, options, &block)
     end
 
+    # Internal: Requires internal Faraday libraries.
+    #
+    # *libs - One or more relative String names to Faraday classes.
+    #
+    # Returns nothing.
     def require_libs(*libs)
       libs.each do |lib|
         require "#{lib_path}/#{lib}"
       end
     end
 
+    # Public: Updates default adapter while resetting
+    # #default_connection.
+    #
+    # Returns the new default_adapter.
+    def default_adapter=(adapter)
+      @default_connection = nil
+      @default_adapter = adapter
+    end
+
     alias require_lib require_libs
 
   private
+    # Internal: Proxies method calls on the Faraday constant to
+    # #default_connection.
     def method_missing(name, *args, &block)
       default_connection.send(name, *args, &block)
     end
@@ -29,10 +104,20 @@ module Faraday
   self.lib_path = File.expand_path "../faraday", __FILE__
   self.default_adapter = :net_http
 
+  # Gets the default connection used for simple scripts.
+  #
+  # Returns a Faraday::Connection, configured with the #default_adapter.
   def self.default_connection
     @default_connection ||= Connection.new
   end
 
+  # Gets the default connection options used when calling Faraday#new.
+  #
+  # Returns a Faraday::ConnectionOptions.
+  def self.default_connection_options
+    @default_connection_options ||= ConnectionOptions.new
+  end
+
   if (!defined?(RUBY_ENGINE) || "ruby" == RUBY_ENGINE) && RUBY_VERSION < '1.9'
     begin
       require 'system_timer'
@@ -47,101 +132,130 @@ module Faraday
     Timer = Timeout
   end
 
+  # Public: Adds the ability for other modules to register and lookup
+  # middleware classes.
   module MiddlewareRegistry
-    # Internal: Register middleware class(es) on the current module.
+    # Public: Register middleware class(es) on the current module.
+    #
+    # mapping - A Hash mapping Symbol keys to classes. Classes can be expressed
+    #           as fully qualified constant, or a Proc that will be lazily
+    #           called to return the former.
+    #
+    # Examples
+    #
+    #   module Faraday
+    #     class Whatever
+    #       # Middleware looked up by :foo returns Faraday::Whatever::Foo.
+    #       register_middleware :foo => Foo
+    #
+    #       # Middleware looked up by :bar returns Faraday::Whatever.const_get(:Bar)
+    #       register_middleware :bar => :Bar
     #
-    # mapping - A Hash mapping Symbol keys to classes. See
-    #           Faraday.register_middleware for more details.
-    def register_middleware(mapping)
-      (@registered_middleware ||= {}).update(mapping)
+    #       # Middleware looked up by :baz requires 'baz' and returns Faraday::Whatever.const_get(:Baz)
+    #       register_middleware :baz => [:Baz, 'baz']
+    #     end
+    #   end
+    #
+    # Returns nothing.
+    def register_middleware(autoload_path = nil, mapping = nil)
+      if mapping.nil?
+        mapping = autoload_path
+        autoload_path = nil
+      end
+      middleware_mutex do
+        @middleware_autoload_path = autoload_path if autoload_path
+        (@registered_middleware ||= {}).update(mapping)
+      end
     end
 
-    # Internal: Lookup middleware class with a registered Symbol shortcut.
+    # Public: Lookup middleware class with a registered Symbol shortcut.
+    #
+    # key - The Symbol key for the registered middleware.
+    #
+    # Examples
+    #
+    #   module Faraday
+    #     class Whatever
+    #       register_middleware :foo => Foo
+    #     end
+    #   end
+    #
+    #   Faraday::Whatever.lookup_middleware(:foo)
+    #   # => Faraday::Whatever::Foo
     #
     # Returns a middleware Class.
     def lookup_middleware(key)
-      unless defined? @registered_middleware and found = @registered_middleware[key]
-        raise "#{key.inspect} is not registered on #{self}"
-      end
-      found = @registered_middleware[key] = found.call if found.is_a? Proc
-      found.is_a?(Module) ? found : const_get(found)
+      load_middleware(key) ||
+        raise(Faraday::Error.new("#{key.inspect} is not registered on #{self}"))
     end
-  end
 
-  module AutoloadHelper
-    def autoload_all(prefix, options)
-      if prefix =~ /^faraday(\/|$)/i
-        prefix = File.join(Faraday.root_path, prefix)
-      end
-      options.each do |const_name, path|
-        autoload const_name, File.join(prefix, path)
+    def middleware_mutex(&block)
+      @middleware_mutex ||= begin
+        require 'monitor'
+        Monitor.new
       end
+      @middleware_mutex.synchronize(&block)
     end
 
-    # Loads each autoloaded constant.  If thread safety is a concern, wrap
-    # this in a Mutex.
-    def load_autoloaded_constants
-      constants.each do |const|
-        const_get(const) if autoload?(const)
-      end
+    def fetch_middleware(key)
+      defined?(@registered_middleware) && @registered_middleware[key]
     end
 
-    def all_loaded_constants
-      constants.map { |c| const_get(c) }.
-        select { |a| a.respond_to?(:loaded?) && a.loaded? }
+    def load_middleware(key)
+      value = fetch_middleware(key)
+      case value
+      when Module then value
+      when Symbol, String
+        middleware_mutex do
+          @registered_middleware[key] = const_get(value)
+        end
+      when Proc
+        middleware_mutex do
+          @registered_middleware[key] = value.call
+        end
+      when Array
+        middleware_mutex do
+          const, path = value
+          if root = @middleware_autoload_path
+            path = "#{root}/#{path}"
+          end
+          require(path)
+          @registered_middleware[key] = const
+        end
+        load_middleware(key)
+      end
     end
   end
 
-  extend AutoloadHelper
-
-  # Public: register middleware classes under a short name.
-  #
-  # type    - A Symbol specifying the kind of middleware (default: :middleware)
-  # mapping - A Hash mapping Symbol keys to classes. Classes can be expressed
-  #           as fully qualified constant, or a Proc that will be lazily called
-  #           to return the former.
-  #
-  # Examples
-  #
-  #   Faraday.register_middleware :aloha => MyModule::Aloha
-  #   Faraday.register_middleware :response, :boom => MyModule::Boom
-  #
-  #   # shortcuts are now available in Builder:
-  #   builder.use :aloha
-  #   builder.response :boom
-  #
-  # Returns nothing.
-  def self.register_middleware type, mapping = nil
-    type, mapping = :middleware, type if mapping.nil?
-    component = self.const_get(type.to_s.capitalize)
-    component.register_middleware(mapping)
+  def self.const_missing(name)
+    if name.to_sym == :Builder
+      warn "Faraday::Builder is now Faraday::RackBuilder."
+      const_set name, RackBuilder
+    else
+      super
+    end
   end
 
-  autoload_all "faraday",
-    :Middleware      => 'middleware',
-    :Builder         => 'builder',
-    :Request         => 'request',
-    :Response        => 'response',
-    :CompositeReadIO => 'upload_io',
-    :UploadIO        => 'upload_io',
-    :Parts           => 'upload_io'
-
-  require_libs "utils", "connection", "adapter", "error"
+  require_libs "utils", "options", "connection", "rack_builder", "parameters",
+    "middleware", "adapter", "request", "response", "upload_io", "error"
 end
 
-
 # not pulling in active-support JUST for this method.  And I love this method.
 class Object
-  # Yields <code>x</code> to the block, and then returns <code>x</code>.
   # The primary purpose of this method is to "tap into" a method chain,
   # in order to perform operations on intermediate results within the chain.
   #
+  # Examples
+  #
   #   (1..10).tap { |x| puts "original: #{x.inspect}" }.to_a.
   #     tap    { |x| puts "array: #{x.inspect}" }.
   #     select { |x| x%2 == 0 }.
   #     tap    { |x| puts "evens: #{x.inspect}" }.
   #     map    { |x| x*x }.
   #     tap    { |x| puts "squares: #{x.inspect}" }
+  #
+  # Yields self.
+  # Returns self.
   def tap
     yield self
     self