faraday 0.6.1 → 0.7.4

data/Gemfile

@@ -1,19 +1,29 @@
-source "http://rubygems.org"
+source 'http://rubygems.org'
 
-# Bundle gems for the local environment. Make sure to
-# put test-only gems in this group so their generators
-# and rake tasks are available in development mode:
-group :development, :test do
-  gem 'patron', '~> 0.4', :platforms => :ruby
-  gem 'sinatra', '~> 1.1'
-  gem 'typhoeus', '~> 0.2', :platforms => :ruby
-  gem 'excon', '~> 0.5.8'
-  gem 'em-http-request', '~> 0.3', :require => 'em-http', :platforms => :ruby
+gem 'addressable', '~> 2.2.6'
+gem 'multipart-post', '~> 1.1.0'
+gem 'rack', ['>= 1.1.0', '<= 1.2.0']
+
+group :development do
+  gem 'sinatra', '~> 1.2'
+end
+
+group :test do
+  gem 'em-http-request', '~> 0.3', :require => 'em-http'
   gem 'em-synchrony', '~> 0.2', :require => ['em-synchrony', 'em-synchrony/em-http'], :platforms => :ruby_19
-  gem 'webmock'
+  gem 'excon', '~> 0.6'
+  gem 'leftright', '~> 0.9', :require => false
+  gem 'patron', '~> 0.4'
+  gem 'rake', '~> 0.8'
+  gem 'test-unit', '~> 2.3'
+  gem 'typhoeus', '~> 0.2'
+  gem 'webmock', '~> 1.6'
   # ActiveSupport::JSON will be used in ruby 1.8 and Yajl in 1.9; this is to test against both adapters
-  gem 'activesupport', '~> 2.3.8', :require => nil, :platforms => [:ruby_18, :jruby]
-  gem 'yajl-ruby', :require => 'yajl', :platforms => :ruby_19
+  gem 'activesupport', '~> 2.3', :require => nil, :platforms => [:ruby_18, :jruby]
+  gem 'yajl-ruby', '~> 0.8', :require => 'yajl', :platforms => :ruby_19
 end
 
-gemspec
+platforms :jruby do
+  gem 'jruby-openssl', '~> 0.7'
+  gem 'ffi-ncurses', '~> 0.3'
+end

data/{LICENSE → LICENSE.md}

@@ -1,4 +1,4 @@
-Copyright (c) 2009-* rick olson, zack hobson
+Copyright (c) 2009 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

@@ -1,11 +1,11 @@
-# faraday
-
+faraday
+=======
 Modular HTTP client library using middleware heavily inspired by Rack.
 
 This mess is gonna get raw, like sushi. So, haters to the left.
 
-## Usage
-
+Usage
+-----
     conn = Faraday.new(:url => 'http://sushi.com') do |builder|
       builder.use Faraday::Request::UrlEncoded  # convert request params as "www-form-urlencoded"
       builder.use Faraday::Request::JSON        # encode request params as json
@@ -18,23 +18,23 @@ This mess is gonna get raw, like sushi. So, haters to the left.
       builder.response :logger
       builder.adapter  :net_http
     end
-    
+
     ## GET ##
 
     response = conn.get '/nigiri/sake.json'     # GET http://sushi.com/nigiri/sake.json
     response.body
 
     conn.get '/nigiri', 'X-Awesome' => true     # custom request header
-    
+
     conn.get do |req|                           # GET http://sushi.com/search?page=2&limit=100
       req.url '/search', :page => 2
       req.params['limit'] = 100
     end
-    
+
     ## POST ##
-    
+
     conn.post '/nigiri', { :name => 'Maguro' }  # POST "name=maguro" to http://sushi.com/nigiri
-    
+
     # post payload as JSON instead of "www-form-urlencoded" encoding:
     conn.post '/nigiri', payload, 'Content-Type' => 'application/json'
 
@@ -50,8 +50,8 @@ If you're ready to roll with just the bare minimum:
     # default stack (net/http), no extra middleware:
     response = Faraday.get 'http://sushi.com/nigiri/sake.json'
 
-## Advanced middleware usage
-
+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.
 
     conn = Faraday.new(:url => 'http://sushi.com') do |builder|
@@ -59,7 +59,7 @@ The order in which middleware is stacked is important. Like with Rack, the first
       builder.request  :multipart
       builder.request  :url_encoded
       builder.request  :json
-      
+
       builder.adapter  :net_http
     end
 
@@ -74,23 +74,23 @@ Because "UrlEncoded" is higher on the stack than JSON encoder, it will get to pr
 Examples:
 
     payload = { :name => 'Maguro' }
-    
+
     # post payload as JSON instead of urlencoded:
     conn.post '/nigiri', payload, 'Content-Type' => 'application/json'
-    
+
     # uploading a file:
     payload = { :profile_pic => Faraday::UploadIO.new('avatar.jpg', 'image/jpeg') }
-    
+
     # "Multipart" middleware detects files and encodes with "multipart/form-data":
     conn.put '/profile', payload
 
-## Writing middleware
-
+Writing middleware
+------------------
 Middleware are classes that respond to `call()`. They wrap the request/response cycle.
 
     def call(env)
       # do something with the request
-      
+
       @app.call(env).on_complete do
         # do something with the response
       end
@@ -111,8 +111,8 @@ The `env` is a hash with symbol keys that contains info about the request and, l
     :body   - the response body
     :response_headers
 
-## Testing
-
+Testing
+-------
     # It's possible to define stubbed request outside a test adapter block.
     stubs = Faraday::Adapter::Test::Stubs.new do |stub|
       stub.get('/tamago') { [200, {}, 'egg'] }
@@ -138,21 +138,21 @@ The `env` is a hash with symbol keys that contains info about the request and, l
     resp.body # => 'urchin'
     resp = test.get '/else' #=> raises "no such stub" error
 
-    # If you like, you can treat your stubs as mocks by verifying that all of 
+    # If you like, you can treat your stubs as mocks by verifying that all of
     # the stubbed calls were made. NOTE that this feature is still fairly
     # experimental: It will not verify the order or count of any stub, only that
     # it was called once during the course of the test.
     stubs.verify_stubbed_calls
 
-## TODO
-
+TODO
+----
 * support streaming requests/responses
 * better stubbing API
 * Support timeouts
 * Add curb, em-http, fast_http
 
-## Note on Patches/Pull Requests
-
+Note on Patches/Pull Requests
+-----------------------------
 * Fork the project.
 * Make your feature addition or bug fix.
 * Add tests for it. This is important so I don't break it in a
@@ -161,6 +161,8 @@ The `env` is a hash with symbol keys that contains info about the request and, l
   (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)
 * Send me a pull request. Bonus points for topic branches.
 
-## Copyright
+Copyright
+---------
+Copyright (c) 2009-2011 rick, hobson. See [LICENSE][license] for details.
 
-Copyright (c) 2009-2011 rick, hobson. See LICENSE for details.
+[license]: https://github.com/technoweenie/faraday/blob/master/LICENSE.md

data/Rakefile

@@ -1,5 +1,5 @@
-require 'rubygems'
-require 'rake'
+#!/usr/bin/env rake
+
 require 'date'
 
 #############################################################################
@@ -52,6 +52,14 @@ Rake::TestTask.new(:test) do |test|
   test.verbose = true
 end
 
+TEST_SERVER = 'http://faradaylive.heroku.com'
+
+desc "Run tests including live tests against #{TEST_SERVER}"
+task :"test:live" do
+  ENV['LIVE'] = TEST_SERVER
+  Rake::Task[:test].invoke
+end
+
 desc "Open an irb session preloaded with this library"
 task :console do
   sh "irb -rubygems -r ./lib/#{name}.rb"

data/config.ru

@@ -0,0 +1,6 @@
+require 'rubygems'
+require 'bundler'
+Bundler.setup
+
+require File.expand_path('../test/live_server', __FILE__)
+run Sinatra::Application

data/faraday.gemspec

@@ -12,8 +12,8 @@ Gem::Specification.new do |s|
   ## If your rubyforge_project name is different, then edit it and comment out
   ## the sub! line in the Rakefile
   s.name              = 'faraday'
-  s.version           = '0.6.1'
-  s.date              = '2011-04-13'
+  s.version           = '0.7.4'
+  s.date              = '2011-07-08'
   s.rubyforge_project = 'faraday'
 
   ## Make sure your summary is short. The description may be as long
@@ -32,10 +32,12 @@ Gem::Specification.new do |s|
   ## require 'NAME.rb' or'/lib/NAME/file.rb' can be as require 'NAME/file.rb'
   s.require_paths = %w[lib]
 
-  s.add_development_dependency('rake', '~> 0.8')
-  s.add_runtime_dependency('addressable', '~> 2.2.4')
-  s.add_runtime_dependency('multipart-post', '~> 1.1.0')
-  s.add_runtime_dependency('rack', ['>= 1.1.0', "< 2"])
+  s.add_development_dependency 'rake', '~> 0.9'
+  s.add_development_dependency 'test-unit', '~> 2.3'
+  s.add_development_dependency 'webmock', '~> 1.6'
+  s.add_runtime_dependency 'addressable', '~> 2.2.6'
+  s.add_runtime_dependency 'multipart-post', '~> 1.1.0'
+  s.add_runtime_dependency 'rack', ['>= 1.1.0', '< 2']
 
   ## Leave this section as-is. It will be automatically generated from the
   ## contents of your Git repository via the gemspec task. DO NOT REMOVE
@@ -43,9 +45,10 @@ Gem::Specification.new do |s|
   # = MANIFEST =
   s.files = %w[
     Gemfile
-    LICENSE
+    LICENSE.md
     README.md
     Rakefile
+    config.ru
     faraday.gemspec
     lib/faraday.rb
     lib/faraday/adapter.rb

data/lib/faraday/adapter/net_http.rb

@@ -15,15 +15,15 @@ module Faraday
 
         http = net_http_class(env).new(url.host, url.inferred_port)
 
-        if http.use_ssl = (url.scheme == 'https' && env[:ssl])
-          ssl = env[:ssl]
+        if http.use_ssl = (url.scheme == 'https' && (ssl = env[:ssl]) && true)
           http.verify_mode = ssl[:verify_mode] || ssl.fetch(:verify, true) ?
                                OpenSSL::SSL::VERIFY_PEER : OpenSSL::SSL::VERIFY_NONE
-          http.cert        = ssl[:client_cert] if ssl[:client_cert]
-          http.key         = ssl[:client_key]  if ssl[:client_key]
-          http.ca_file     = ssl[:ca_file]     if ssl[:ca_file]
-          http.ca_path     = ssl[:ca_path]     if ssl[:ca_path]
-          http.cert_store  = ssl[:cert_store]  if ssl[:cert_store]
+          http.cert         = ssl[:client_cert]  if ssl[:client_cert]
+          http.key          = ssl[:client_key]   if ssl[:client_key]
+          http.ca_file      = ssl[:ca_file]      if ssl[:ca_file]
+          http.ca_path      = ssl[:ca_path]      if ssl[:ca_path]
+          http.cert_store   = ssl[:cert_store]   if ssl[:cert_store]
+          http.verify_depth = ssl[:verify_depth] if ssl[:verify_depth]
         end
 
         http.read_timeout = http.open_timeout = req[:timeout] if req[:timeout]

data/lib/faraday/adapter/patron.rb

@@ -12,11 +12,8 @@ module Faraday
         session = ::Patron::Session.new
 
         response = begin
-          if Connection::METHODS_WITH_BODIES.include? env[:method]
-            session.send(env[:method], env[:url].to_s, env[:body].to_s, env[:request_headers])
-          else
-            session.send(env[:method], env[:url].to_s, env[:request_headers])
-          end
+          data = Connection::METHODS_WITH_BODIES.include?(env[:method]) ? env[:body].to_s : nil
+          session.request(env[:method], env[:url].to_s, env[:request_headers], :data => data)
         rescue Errno::ECONNREFUSED
           raise Error::ConnectionFailed, $!
         end
@@ -25,6 +22,15 @@ module Faraday
 
         @app.call env
       end
+
+      if loaded? && defined?(::Patron::Request::VALID_ACTIONS)
+        # HAX: helps but doesn't work completely
+        # https://github.com/toland/patron/issues/34
+        ::Patron::Request::VALID_ACTIONS.tap do |actions|
+          actions << :patch unless actions.include? :patch
+          actions << :options unless actions.include? :options
+        end
+      end
     end
   end
 end

data/lib/faraday/adapter/test.rb

@@ -17,6 +17,9 @@ module Faraday
       def self.loaded?() false end
 
       class Stubs
+        class NotFound < StandardError
+        end
+
         def initialize
           # {:get => [Stub, Stub]}
           @stack, @consumed = {}, {}
@@ -84,9 +87,29 @@ module Faraday
         end
       end
 
-      class Stub < Struct.new(:path, :body, :block)
-        def matches?(request_path, request_body)
-          request_path == path && (body.to_s.size.zero? || request_body == body)
+      class Stub < Struct.new(:path, :params, :body, :block)
+        def initialize(full, body, block)
+          path, query = full.split('?')
+          params = query ?
+            Rack::Utils.parse_nested_query(query) :
+            {}
+          super path, params, body, block
+        end
+
+        def matches?(request_uri, request_body)
+          request_path, request_query = request_uri.split('?')
+          request_params = request_query ?
+            Rack::Utils.parse_nested_query(request_query) :
+            {}
+          request_path == path &&
+            params_match?(request_params) &&
+            (body.to_s.size.zero? || request_body == body)
+        end
+
+        def params_match?(request_params)
+          params.keys.all? do |key|
+            request_params[key] == params[key]
+          end
         end
 
         def to_s
@@ -109,10 +132,13 @@ module Faraday
         normalized_path = Faraday::Utils.normalize_path(env[:url])
 
         if stub = stubs.match(env[:method], normalized_path, env[:body])
+          env[:params] = (query = env[:url].query) ?
+            Rack::Utils.parse_nested_query(query)  :
+            {}
           status, headers, body = stub.block.call(env)
           save_response(env, status, body, headers)
         else
-          raise "no stubbed request for #{env[:method]} #{normalized_path} #{env[:body]}"
+          raise Stubs::NotFound, "no stubbed request for #{env[:method]} #{normalized_path} #{env[:body]}"
         end
         @app.call(env)
       end

data/lib/faraday/adapter/typhoeus.rb

@@ -21,6 +21,13 @@ module Faraday
           :headers => env[:request_headers],
           :disable_ssl_peer_verification => (env[:ssl] && !env[:ssl].fetch(:verify, true))
 
+        if ssl = env[:ssl]
+          req.ssl_cert   = ssl[:client_cert_file] if ssl[:client_cert_file]
+          req.ssl_key    = ssl[:client_key_file]  if ssl[:client_key_file]
+          req.ssl_cacert = ssl[:ca_file]          if ssl[:ca_file]
+          req.ssl_capath = ssl[:ca_path]          if ssl[:ca_path]
+        end
+
         env_req = env[:request]
         req.timeout = req.connect_timeout = (env_req[:timeout] * 1000) if env_req[:timeout]
         req.connect_timeout = (env_req[:open_timeout] * 1000)          if env_req[:open_timeout]

data/lib/faraday/builder.rb

@@ -12,6 +12,9 @@ module Faraday
       new { |builder| yield builder }
     end
 
+    # Error raised when trying to modify the stack after calling `lock!`
+    class StackLocked < RuntimeError; end
+
     # borrowed from ActiveSupport::Dependencies::Reference &
     # ActionDispatch::MiddlewareStack::Middleware
     class Handler
@@ -31,7 +34,9 @@ module Faraday
       def inspect() @name end
 
       def ==(other)
-        if other.respond_to? :name
+        if other.is_a? Handler
+          self.name == other.name
+        elsif other.respond_to? :name
           klass == other
         else
           @name == other.to_s
@@ -55,6 +60,7 @@ module Faraday
     end
 
     def build(options = {})
+      raise_if_locked
       @handlers.clear unless options[:keep]
       yield self if block_given?
     end
@@ -76,7 +82,17 @@ module Faraday
       @handlers.reverse.inject(inner_app) { |app, handler| handler.build(app) }
     end
 
+    # Locks the middleware stack to ensure no further modifications are possible.
+    def lock!
+      @handlers.freeze
+    end
+
+    def locked?
+      @handlers.frozen?
+    end
+
     def use(klass, *args)
+      raise_if_locked
       block = block_given? ? Proc.new : nil
       @handlers << self.class::Handler.new(klass, *args, &block)
     end
@@ -99,6 +115,7 @@ module Faraday
     ## methods to push onto the various positions in the stack:
 
     def insert(index, *args, &block)
+      raise_if_locked
       index = assert_index(index)
       handler = self.class::Handler.new(*args, &block)
       @handlers.insert(index, handler)
@@ -112,17 +129,23 @@ module Faraday
     end
 
     def swap(index, *args, &block)
+      raise_if_locked
       index = assert_index(index)
       @handlers.delete_at(index)
       insert(index, *args, &block)
     end
 
     def delete(handler)
+      raise_if_locked
       @handlers.delete(handler)
     end
 
     private
 
+    def raise_if_locked
+      raise StackLocked, "can't modify middleware stack after making a request" if locked?
+    end
+
     def use_symbol(mod, key, *args)
       block = block_given? ? Proc.new : nil
       use(mod.lookup_module(key), *args, &block)

data/lib/faraday/connection.rb

@@ -4,10 +4,10 @@ require 'base64'
 
 module Faraday
   class Connection
-    include Addressable, Faraday::Utils
+    include Addressable
 
-    METHODS = Set.new [:get, :post, :put, :delete, :head]
-    METHODS_WITH_BODIES = Set.new [:post, :put]
+    METHODS = Set.new [:get, :post, :put, :delete, :head, :patch, :options]
+    METHODS_WITH_BODIES = Set.new [:post, :put, :patch, :options]
 
     attr_accessor :host, :port, :scheme, :params, :headers, :parallel_manager
     attr_reader   :path_prefix, :builder, :options, :ssl
@@ -22,15 +22,17 @@ module Faraday
         options = url
         url     = options[:url]
       end
-      @headers          = Headers.new
-      @params           = {}
+      @headers          = Utils::Headers.new
+      @params           = Utils::ParamsHash.new
       @options          = options[:request] || {}
       @ssl              = options[:ssl]     || {}
       @parallel_manager = options[:parallel]
+
       self.url_prefix = url if url
       proxy(options[:proxy])
-      merge_params  @params,  options[:params]  if options[:params]
-      merge_headers @headers, options[:headers] if options[:headers]
+
+      @params.update options[:params]   if options[:params]
+      @headers.update options[:headers] if options[:headers]
 
       if block_given?
         @builder = Builder.create { |b| yield b }
@@ -59,6 +61,25 @@ module Faraday
       @builder.build(options, &block)
     end
 
+    # The "rack app" wrapped in middleware. All requests are sent here.
+    #
+    # The builder is responsible for creating the app object. After this,
+    # the builder gets locked to ensure no further modifications are made
+    # to the middleware stack.
+    #
+    # Returns an object that responds to `call` and returns a Response.
+    def app
+      @app ||= begin
+        builder.lock!
+        builder.to_app(lambda { |env|
+          # the inner app that creates and returns the Response object
+          response = Response.new
+          response.finish(env) unless env[:parallel_manager]
+          env[:response] = response
+        })
+      end
+    end
+
     def get(url = nil, headers = nil)
       block = block_given? ? Proc.new : nil
       run_request(:get, url, nil, headers, &block)
@@ -74,6 +95,11 @@ module Faraday
       run_request(:put, url, body, headers, &block)
     end
 
+    def patch(url = nil, body = nil, headers = nil)
+      block = block_given? ? Proc.new : nil
+      run_request(:patch, url, body, headers, &block)
+    end
+
     def head(url = nil, headers = nil)
       block = block_given? ? Proc.new : nil
       run_request(:head, url, nil, headers, &block)
@@ -145,12 +171,11 @@ module Faraday
       self.host        = uri.host
       self.port        = uri.port
       self.path_prefix = uri.path
-      if uri.query && !uri.query.empty?
-        merge_params @params, parse_query(uri.query)
-      end
-      if uri.user && uri.password
-        basic_auth(uri.user, uri.password)
-      end
+
+      @params.merge_query(uri.query)
+      basic_auth(uri.user, uri.password) if uri.user && uri.password
+
+      uri
     end
 
     # Ensures that the path prefix always has a leading / and no trailing /
@@ -167,12 +192,15 @@ module Faraday
         raise ArgumentError, "unknown http method: #{method}"
       end
 
-      Request.run(self, method) do |req|
+      request = Request.create(method) do |req|
         req.url(url)                if url
         req.headers.update(headers) if headers
         req.body = body             if body
         yield req if block_given?
       end
+
+      env = request.to_env(self)
+      self.app.call(env)
     end
 
     # Takes a relative url for a request and combines it with the defaults
@@ -186,15 +214,21 @@ module Faraday
     #   conn.build_url("nigiri?page=2")      # => https://sushi.com/api/nigiri?token=abc&page=2
     #   conn.build_url("nigiri", :page => 2) # => https://sushi.com/api/nigiri?token=abc&page=2
     #
-    def build_url(url, params = nil)
+    def build_url(url, extra_params = nil)
       uri          = URI.parse(url.to_s)
       if @path_prefix && uri.path !~ /^\//
-        uri.path = "#{@path_prefix.size > 1 ? @path_prefix : nil}/#{uri.path}"
+        new_path = @path_prefix.size > 1 ? @path_prefix.dup : ''
+        new_path << "/#{uri.path}" unless uri.path.empty?
+        uri.path = new_path
       end
       uri.host   ||= @host
       uri.port   ||= @port
       uri.scheme ||= @scheme
-      replace_query(uri, params)
+
+      params = @params.dup.merge_query(uri.query)
+      params.update extra_params if extra_params
+      uri.query = params.empty? ? nil : params.to_query
+
       uri
     end
 
@@ -202,18 +236,6 @@ module Faraday
       self.class.new(build_url(''), :headers => headers.dup, :params => params.dup, :builder => builder.dup)
     end
 
-    def replace_query(uri, params)
-      url_params = @params.dup
-      if uri.query && !uri.query.empty?
-        merge_params(url_params, parse_query(uri.query))
-      end
-      if params && !params.empty?
-        merge_params(url_params, params)
-      end
-      uri.query = url_params.empty? ? nil : build_query(url_params)
-      uri
-    end
-
     def proxy_arg_to_uri(arg)
       case arg
         when String then URI.parse(arg)

data/lib/faraday/error.rb

@@ -34,5 +34,7 @@ module Faraday
     class ConnectionFailed < ClientError;   end
     class ResourceNotFound < ClientError;   end
     class ParsingError     < ClientError;   end
+
+    class MissingDependency < StandardError; end
   end
 end

data/lib/faraday/request/json.rb

@@ -3,7 +3,11 @@ module Faraday
     self.mime_type = 'application/json'.freeze
 
     class << self
-      attr_accessor :adapter
+      attr_writer :adapter
+
+      def adapter
+        @adapter or raise Error::MissingDependency, "No JSON adapter available. Install either activesupport or yajl-ruby."
+      end
     end
 
     # loads the JSON encoder either from yajl-ruby or activesupport