faraday 0.7.0 → 0.7.1

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 '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'
-  gem 'typhoeus', '~> 0.2', :platforms => :ruby
-  gem 'excon', '~> 0.6'
-  gem 'em-http-request', '~> 0.3', :require => 'em-http', :platforms => :ruby
+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', :require => nil, :platforms => [:ruby_18, :jruby]
-  gem 'yajl-ruby', :require => 'yajl', :platforms => :ruby_19
+  gem 'activesupport', '~> 3.0', :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

@@ -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.7.0'
-  s.date              = '2011-05-10'
+  s.version           = '0.7.1'
+  s.date              = '2011-06-09'
   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.rb

@@ -1,5 +1,5 @@
 module Faraday
-  VERSION = "0.7.0"
+  VERSION = "0.7.1"
 
   class << self
     attr_accessor :default_adapter

data/lib/faraday/adapter/patron.rb

@@ -22,12 +22,15 @@ module Faraday
 
         @app.call env
       end
-    end
 
-    # HAX: helps but doesn't work completely
-    # https://github.com/toland/patron/issues/34
-    valid_actions = ::Patron::Request::VALID_ACTIONS
-    valid_actions << :patch unless valid_actions.include? :patch
-    valid_actions << :options unless valid_actions.include? :options
+      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/builder.rb

@@ -34,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

data/lib/faraday/response.rb

@@ -14,7 +14,7 @@ module Faraday
       # Calls the `parse` method if defined
       def on_complete(env)
         if respond_to? :parse
-          env[:body] = parse(env[:body])
+          env[:body] = parse(env[:body]) unless [204,304].index env[:status]
         end
       end
     end
@@ -72,7 +72,7 @@ module Faraday
     end
 
     def success?
-      status == 200
+      (200..299).include?(status)
     end
 
     # because @on_complete_callbacks cannot be marshalled

data/lib/faraday/utils.rb

@@ -18,7 +18,7 @@ module Faraday
         end
       end
       KeyMap[:etag] = "ETag"
-      
+
       def [](k)
         super(KeyMap[k])
       end
@@ -28,9 +28,9 @@ module Faraday
         v = v.to_ary.join(', ') if v.respond_to? :to_ary
         super(KeyMap[k], v)
       end
-      
+
       alias_method :update, :merge!
-      
+
       def parse(header_string)
         return unless header_string && !header_string.empty?
         header_string.split(/\r\n/).

data/test/adapters/live_test.rb

@@ -1,7 +1,7 @@
 require File.expand_path(File.join(File.dirname(__FILE__), '..', 'helper'))
 
 if !Faraday::TestCase::LIVE_SERVER
-  warn "warning: test server is not up; skipping live server tests"
+  warn "warning: test server not specified; skipping live server tests"
 else
   module Adapters
     class LiveTest < Faraday::TestCase
@@ -84,7 +84,11 @@ else
             end
             assert_equal %({"first"=>"zack"}), resp.body
           end
+        end
 
+        # https://github.com/toland/patron/issues/9
+        # https://github.com/dbalatero/typhoeus/issues/84
+        if ENV['FORCE'] || !%w[Faraday::Adapter::Patron Faraday::Adapter::Typhoeus].include?(adapter.to_s)
           define_method "test_#{adapter}_PUT_retrieves_the_response_headers" do
             assert_match /text\/html/, create_connection(adapter).put('echo_name').headers['content-type']
           end

data/test/adapters/test_middleware_test.rb

@@ -27,6 +27,20 @@ module Adapters
       assert_equal 'hello', @conn.get("/hello").body
     end
 
+    def test_middleware_with_get_params
+      @stubs.get('/param?a=1') { [200, {}, 'a'] }
+      assert_equal 'a', @conn.get('/param?a=1').body
+    end
+
+    def test_middleware_ignores_unspecified_get_params
+      @stubs.get('/optional?a=1') { [200, {}, 'a'] }
+      assert_equal 'a', @conn.get('/optional?a=1&b=1').body
+      assert_equal 'a', @conn.get('/optional?a=1').body
+      assert_raise Faraday::Adapter::Test::Stubs::NotFound do
+        @conn.get('/optional')
+      end
+    end
+
     def test_middleware_allow_different_outcomes_for_the_same_request
       @stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'hello'] }
       @stubs.get('/hello') { [200, {'Content-Type' => 'text/html'}, 'world'] }
@@ -34,8 +48,21 @@ module Adapters
       assert_equal 'world', @conn.get("/hello").body
     end
 
+    def test_yields_env_to_stubs
+      @stubs.get '/hello' do |env|
+        assert_equal '/hello',     env[:url].path
+        assert_equal 'foo.com',    env[:url].host
+        assert_equal '1',          env[:params]['a']
+        assert_equal 'text/plain', env[:request_headers]['Accept']
+        [200, {}, 'a']
+      end
+
+      @conn.headers['Accept'] = 'text/plain'
+      assert_equal 'a', @conn.get('http://foo.com/hello?a=1').body
+    end
+
     def test_raises_an_error_if_no_stub_is_found_for_request
-      assert_raise RuntimeError do
+      assert_raise Faraday::Adapter::Test::Stubs::NotFound do
         @conn.get('/invalid'){ [200, {}, []] }
       end
     end

data/test/helper.rb

@@ -1,12 +1,5 @@
+require 'rubygems'
 require 'test/unit'
-unless ENV['BUNDLE_GEMFILE']
-  require 'rubygems'
-  require 'bundler'
-  Bundler.setup
-end
-
-require 'webmock/test_unit'
-WebMock.disable_net_connect!(:allow_localhost => true)
 
 if ENV['LEFTRIGHT']
   begin
@@ -43,3 +36,6 @@ module Faraday
     end unless defined? ::MiniTest
   end
 end
+
+require 'webmock/test_unit'
+WebMock.disable_net_connect!(:allow => Faraday::TestCase::LIVE_SERVER)

data/test/middleware_stack_test.rb

@@ -87,6 +87,13 @@ class MiddlewareStackTest < Faraday::TestCase
     assert !duped_connection.builder.locked?
   end
 
+  def test_handler_comparison
+    build_stack Apple
+    assert_equal @builder.handlers.first, Apple
+    assert_equal @builder.handlers[0,1], [Apple]
+    assert_equal @builder.handlers.first, Faraday::Builder::Handler.new(Apple)
+  end
+
   private
 
   # make a stack with test adapter that reflects the order of middleware

data/test/request_middleware_test.rb

@@ -74,8 +74,8 @@ class RequestMiddlewareTest < Faraday::TestCase
     assert_kind_of Faraday::CompositeReadIO, response.body
     assert_equal "multipart/form-data;boundary=%s" % Faraday::Request::Multipart::DEFAULT_BOUNDARY,
       response.headers['Content-Type']
-    
-    response.body.send(:ios).map(&:read).each do |io|
+
+    response.body.send(:ios).map{|io| io.read}.each do |io|
       if re = regexes.detect { |r| io =~ r }
         regexes.delete re
       end

data/test/response_middleware_test.rb

@@ -45,3 +45,30 @@ class ResponseMiddlewareTest < Faraday::TestCase
     assert_equal '<BODY></BODY>', @conn.get('ok').body
   end
 end
+
+class ResponseNoBodyMiddleWareTest < Faraday::TestCase
+  def setup
+    @conn = Faraday.new do |b|
+      b.response :raise_error
+      b.adapter :test do |stub|
+        stub.get('not modified') { [304, nil, nil] }
+        stub.get('no content') { [204, nil, nil] }
+      end
+    end
+    @conn.builder.insert(0, NotCalled)
+  end
+
+  class NotCalled < Faraday::Response::Middleware
+    def parse(body)
+      raise "this should not be called"
+    end
+  end
+
+  def test_204
+    assert_equal nil, @conn.get('no content').body
+  end
+
+  def test_304
+    assert_equal nil, @conn.get('not modified').body
+  end
+end

metadata

@@ -1,8 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: faraday
 version: !ruby/object:Gem::Version 
-  prerelease: 
-  version: 0.7.0
+  hash: 1
+  prerelease: false
+  segments: 
+  - 0
+  - 7
+  - 1
+  version: 0.7.1
 platform: ruby
 authors: 
 - Rick Olson
@@ -10,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-05-10 00:00:00 -07:00
+date: 2011-06-09 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -21,45 +26,97 @@ dependencies:
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: "0.8"
+        hash: 25
+        segments: 
+        - 0
+        - 9
+        version: "0.9"
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: addressable
+  name: test-unit
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        version: 2.2.4
-  type: :runtime
+        hash: 5
+        segments: 
+        - 2
+        - 3
+        version: "2.3"
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: multipart-post
+  name: webmock
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 1
+        - 6
+        version: "1.6"
+  type: :development
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: addressable
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 11
+        segments: 
+        - 2
+        - 2
+        - 6
+        version: 2.2.6
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: multipart-post
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
   type: :runtime
-  version_requirements: *id003
+  version_requirements: *id005
 - !ruby/object:Gem::Dependency 
   name: rack
   prerelease: false
-  requirement: &id004 !ruby/object:Gem::Requirement 
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
+        hash: 19
+        segments: 
+        - 1
+        - 1
+        - 0
         version: 1.1.0
     - - <
       - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 2
         version: "2"
   type: :runtime
-  version_requirements: *id004
+  version_requirements: *id006
 description: HTTP/REST API client library.
 email: technoweenie@gmail.com
 executables: []
@@ -70,9 +127,10 @@ extra_rdoc_files: []
 
 files: 
 - Gemfile
-- LICENSE
+- LICENSE.md
 - README.md
 - Rakefile
+- config.ru
 - faraday.gemspec
 - lib/faraday.rb
 - lib/faraday/adapter.rb
@@ -121,17 +179,25 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
 required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 17
+      segments: 
+      - 1
+      - 3
+      - 5
       version: 1.3.5
 requirements: []
 
 rubyforge_project: faraday
-rubygems_version: 1.6.2
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 2
 summary: HTTP/REST API client library.