fakeweb 1.1.2 → 1.2.0

data/test/{unit/test_fake_web_open_uri.rb → test_fake_web_open_uri.rb}

@@ -1,38 +1,18 @@
-# FakeWeb - Ruby Helper for Faking Web Requests
-# Copyright 2006 Blaine Cook <romeda@gmail.com>.
-# 
-# FakeWeb is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-# 
-# FakeWeb is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-# 
-# You should have received a copy of the GNU General Public License
-# along with FakeWeb; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-
-$:.unshift "#{File.dirname(__FILE__)}/../../lib"
-
-require 'test/unit'
-require 'open-uri'
-require 'fake_web'
+require File.join(File.dirname(__FILE__), "test_helper")
 
 class TestFakeWebOpenURI < Test::Unit::TestCase
 
   def setup
     FakeWeb.clean_registry
-    FakeWeb.register_uri('http://mock/test_example.txt', :file => File.dirname(__FILE__) + '/../fixtures/test_example.txt')
   end
 
   def test_content_for_registered_uri
+    FakeWeb.register_uri('http://mock/test_example.txt', :file => File.dirname(__FILE__) + '/fixtures/test_example.txt')
     assert_equal 'test example content', FakeWeb.response_for('http://mock/test_example.txt').body
   end
   
   def test_mock_open
+    FakeWeb.register_uri('http://mock/test_example.txt', :file => File.dirname(__FILE__) + '/fixtures/test_example.txt')
     assert_equal 'test example content', open('http://mock/test_example.txt').read
   end
   
@@ -42,6 +22,7 @@ class TestFakeWebOpenURI < Test::Unit::TestCase
   end
   
   def test_real_open
+    setup_expectations_for_real_apple_hot_news_request
     resp = open('http://images.apple.com/main/rss/hotnews/hotnews.rss')
     assert_equal "200", resp.status.first
     body = resp.read
@@ -73,6 +54,7 @@ class TestFakeWebOpenURI < Test::Unit::TestCase
   end
 
   def test_mock_open_with_block
+    FakeWeb.register_uri('http://mock/test_example.txt', :file => File.dirname(__FILE__) + '/fixtures/test_example.txt')
     open('http://mock/test_example.txt') do |f|
       assert 'test example content', f.readlines
     end

data/test/test_helper.rb

@@ -0,0 +1,52 @@
+$:.unshift "#{File.dirname(__FILE__)}/../lib"
+
+require 'test/unit'
+require 'open-uri'
+require 'fake_web'
+require 'rubygems'
+require 'mocha'
+
+module FakeWebTestHelper
+
+  # Sets several expectations (using Mocha) that a real HTTP request makes it
+  # past FakeWeb to the socket layer. You can use this when you need to check
+  # that a request isn't handled by FakeWeb.
+  def setup_expectations_for_real_request(options = {})
+    # Socket handling
+    if options[:port] == 443
+      socket = mock("SSLSocket")
+      OpenSSL::SSL::SSLSocket.expects(:===).with(socket).returns(true).at_least_once
+      OpenSSL::SSL::SSLSocket.expects(:new).with(socket, instance_of(OpenSSL::SSL::SSLContext)).returns(socket).at_least_once
+      socket.stubs(:sync_close=).returns(true)
+      socket.expects(:connect).with().at_least_once
+    else
+      socket = mock("TCPSocket")
+      Socket.expects(:===).with(socket).returns(true)
+    end
+
+    TCPSocket.expects(:open).with(options[:host], options[:port]).returns(socket).at_least_once
+    socket.stubs(:closed?).returns(false)
+    socket.stubs(:close).returns(true)
+
+    # Request/response handling
+    request_parts = ["#{options[:method]} #{options[:path]} HTTP/1.1", "Host: #{options[:host]}"]
+    socket.expects(:write).with(all_of(includes(request_parts[0]), includes(request_parts[1]))).returns(100)
+
+    # TODO: handle long response bodies that use more than one #sysread call
+    socket.expects(:sysread).at_least_once.returns("HTTP/1.1 #{options[:response_code]} #{options[:response_message]}\nContent-Length: #{options[:response_body].length}\n\n#{options[:response_body]}").then.raises(EOFError)
+  end
+
+
+  # A helper that calls #setup_expectations_for_real_request for you, using
+  # defaults for our commonly used test request to images.apple.com.
+  def setup_expectations_for_real_apple_hot_news_request(options = {})
+    defaults = { :host => "images.apple.com", :port => 80, :method => "GET",
+                 :path => "/main/rss/hotnews/hotnews.rss",
+                 :response_code => 200, :response_message => "OK",
+                 :response_body => "<title>Apple Hot News</title>" }
+    setup_expectations_for_real_request(defaults.merge(options))
+  end
+
+end
+
+Test::Unit::TestCase.send(:include, FakeWebTestHelper)

data/test/test_query_string.rb

@@ -0,0 +1,37 @@
+require File.join(File.dirname(__FILE__), "test_helper")
+
+class TestFakeWebQueryString < Test::Unit::TestCase
+
+  def setup
+    FakeWeb.clean_registry
+  end
+
+  def test_register_uri_with_query_params
+    FakeWeb.register_uri('http://example.com/?a=1&b=1', :string => 'foo')
+    assert FakeWeb.registered_uri?('http://example.com/?a=1&b=1')
+  end
+
+  def test_register_uri_with_query_params_and_check_in_different_order
+    FakeWeb.register_uri('http://example.com/?a=1&b=1', :string => 'foo')
+    assert FakeWeb.registered_uri?('http://example.com/?b=1&a=1')
+  end
+
+  def test_registered_uri_gets_recognized_with_empty_query_params
+    FakeWeb.register_uri('http://example.com/', :string => 'foo')
+    assert FakeWeb.registered_uri?('http://example.com/?')
+  end
+
+  def test_register_uri_with_empty_query_params_and_check_with_none
+    FakeWeb.register_uri('http://example.com/?', :string => 'foo')
+    assert FakeWeb.registered_uri?('http://example.com/')
+  end
+
+  def test_registry_sort_query_params
+    assert_equal "a=1&b=2", FakeWeb::Registry.instance.send(:sort_query_params, "b=2&a=1")
+  end
+
+  def test_registry_sort_query_params_sorts_by_value_if_keys_collide
+    assert_equal "a=1&a=2&b=2", FakeWeb::Registry.instance.send(:sort_query_params, "a=2&b=2&a=1")
+  end
+
+end

metadata

@@ -1,65 +1,77 @@
 --- !ruby/object:Gem::Specification 
 name: fakeweb
 version: !ruby/object:Gem::Version 
-  version: 1.1.2
+  version: 1.2.0
 platform: ruby
 authors: 
 - Blaine Cook
+- Chris Kampmeier
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-03-11 00:00:00 -07:00
+date: 2009-03-07 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: rake
-  type: :runtime
+  name: mocha
+  type: :development
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-- !ruby/object:Gem::Dependency 
-  name: rcov
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
+        version: 0.9.5
     version: 
 description: 
-email: romeda@gmail.com
+email: chris@kampers.net
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README
-- COPYING
+- CHANGELOG
+- LICENSE.txt
+- README.rdoc
 files: 
-- test/fixtures
-- test/fixtures/test_example.txt
-- test/fixtures/test_request
-- test/unit
-- test/unit/test_examples.rb
-- test/unit/test_fake_web.rb
-- test/unit/test_fake_web_open_uri.rb
-- lib/fake_net_http.rb
-- lib/fake_web.rb
 - CHANGELOG
-- COPYING
+- LICENSE.txt
+- README.rdoc
 - Rakefile
-- README
+- lib
+- lib/fake_web
+- lib/fake_web.rb
+- lib/fake_web/ext
+- lib/fake_web/ext/net_http.rb
+- lib/fake_web/registry.rb
+- lib/fake_web/responder.rb
+- lib/fake_web/response.rb
+- lib/fake_web/stub_socket.rb
+- lib/fakeweb.rb
+- test
+- test/fixtures
+- test/fixtures/google_response_from_curl
+- test/fixtures/google_response_with_transfer_encoding
+- test/fixtures/google_response_without_transfer_encoding
+- test/fixtures/test_example.txt
+- test/fixtures/test_txt_file
+- test/test_allow_net_connect.rb
+- test/test_fake_web.rb
+- test/test_fake_web_open_uri.rb
+- test/test_helper.rb
+- test/test_query_string.rb
 has_rdoc: true
-homepage: http://fakeweb.rubyforge.org/
+homepage: http://github.com/chrisk/fakeweb
 post_install_message: 
-rdoc_options: []
-
+rdoc_options: 
+- --main
+- README.rdoc
+- --title
+- FakeWeb API Documentation
+- --charset
+- utf-8
+- --line-numbers
+- --inline-source
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
@@ -80,6 +92,16 @@ rubyforge_project: fakeweb
 rubygems_version: 1.3.1
 signing_key: 
 specification_version: 2
-summary: A test helper that makes it simple to test HTTP interaction
-test_files: []
-
+summary: A tool for faking responses to HTTP requests
+test_files: 
+- test/fixtures
+- test/fixtures/google_response_from_curl
+- test/fixtures/google_response_with_transfer_encoding
+- test/fixtures/google_response_without_transfer_encoding
+- test/fixtures/test_example.txt
+- test/fixtures/test_txt_file
+- test/test_allow_net_connect.rb
+- test/test_fake_web.rb
+- test/test_fake_web_open_uri.rb
+- test/test_helper.rb
+- test/test_query_string.rb

data/README

@@ -1,55 +0,0 @@
-= Name
-
-FakeWeb - Helper for Faking Web Requests
-
-= Synopsis
-
-  :include:test/unit/test_examples.rb
-
-= Description
-
-FakeWeb is a helper for faking web requests. This makes testing easier,
-because you can decouple your test environment from live services without
-modifying code. It allows for a range of request behaviour, from simple
-stubbing of HTTP responses to re-playing complete recorded responses.
-
-In addition to the conceptual advantage of having idempotent request behaviour, 
-FakeWeb makes tests run faster than if they were made to remote (or even local)
-web servers. It also makes it possible to run tests without a network
-connection or in situations where the server is behind a firewall or has
-host based access controls.
-
-FakeWeb is tested with
-Net::HTTP[http://www.ruby-doc.org/stdlib/libdoc/net/http/rdoc/index.html] and
-OpenURI[http://www.ruby-doc.org/stdlib/libdoc/open-uri/rdoc/]. It should work
-with any web client library that uses Net::HTTP for its underlying requests
-(e.g., Flickr.rb[http://redgreenblu.com/flickr/],
-Ruby/Amazon[http://www.caliban.org/ruby/ruby-amazon.shtml],
-soap4r[http://dev.ctor.org/soap4r/], etc.)
-
-= Known Issues
-
-* The port-specific nature of requests is ignored; requests to <tt>test.com</tt> and
-  <tt>test.com:8080</tt> are treated identically.
-* Request bodies are ignored, including GET, PUT, and POST parameters. If you
-  need different responses for different request bodies, you need to request
-  different URLs, and register different responses for each.
-
-= Copyright
-
-FakeWeb - Ruby Helper for Faking Web Requests
-Copyright 2006 Blaine Cook <romeda@gmail.com>.
-
-FakeWeb is free software; you can redistribute it and/or modify
-it under the terms of the GNU General Public License as published by
-the Free Software Foundation; either version 2 of the License, or
-(at your option) any later version.
-
-FakeWeb is distributed in the hope that it will be useful,
-but WITHOUT ANY WARRANTY; without even the implied warranty of
-MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-GNU General Public License for more details.
-
-You should have received a copy of the GNU General Public License
-along with FakeWeb; if not, write to the Free Software
-Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA

data/lib/fake_net_http.rb

@@ -1,69 +0,0 @@
-# FakeWeb - Ruby Helper for Faking Web Requests
-# Copyright 2006 Blaine Cook <romeda@gmail.com>.
-# 
-# FakeWeb is free software; you can redistribute it and/or modify
-# it under the terms of the GNU General Public License as published by
-# the Free Software Foundation; either version 2 of the License, or
-# (at your option) any later version.
-# 
-# FakeWeb is distributed in the hope that it will be useful,
-# but WITHOUT ANY WARRANTY; without even the implied warranty of
-# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
-# GNU General Public License for more details.
-# 
-# You should have received a copy of the GNU General Public License
-# along with FakeWeb; if not, write to the Free Software
-# Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
-
-require 'net/http'
-require 'net/https'
-require 'stringio'
-
-module Net #:nodoc:
-
-  class BufferedIO #:nodoc:
-    def initialize( io, debug_output = nil )
-      @debug_output = debug_output
-      @io = case io
-      when Socket, IO: io
-      when String
-        File.exists?(io) ?  File.open(io, "r") : StringIO.new(io)
-      end
-      raise "Unable to create local socket" unless @io
-      connect
-    end
-
-    def connect(*args)
-      @rbuf = ''
-    end
-
-    def rbuf_fill
-      @rbuf << @io.sysread(1024)
-    end
-  end
-  
-  class HTTP #:nodoc:
-
-    def HTTP.socket_type #:nodoc:
-      FakeWeb::SocketDelegator
-    end
-
-    alias :original_net_http_request :request
-    alias :original_net_http_connect :connect
-    
-    def request(req, body = nil, &block)
-      prot = use_ssl ? "https" : "http"
-      uri = "#{prot}://#{self.address}#{req.path}"
-      if FakeWeb.registered_uri?(uri)
-        @socket = Net::HTTP.socket_type.new
-        return FakeWeb.response_for(uri, &block)
-      else
-        original_net_http_connect
-        return original_net_http_request(req, body, &block)
-      end
-    end
-
-    def connect
-    end
-  end
-end

data/test/fixtures/test_request

@@ -1,21 +0,0 @@
-HTTP/1.1 200 OK
-Cache-Control: private
-Content-Type: text/html
-Set-Cookie: PREF=ID=c1e3135f3180fabf:TM=1148188144:LM=1148188144:S=x9CJYC71XSKRA32Q; expires=Sun, 17-Jan-2038 19:14:07 GMT; path=/; domain=.google.com
-Server: GWS/2.1
-Transfer-Encoding: chunked
-Date: Sun, 21 May 2006 05:09:04 GMT
-
-<html><head><meta http-equiv="content-type" content="text/html; charset=ISO-8859-1"><title>Google</title><style><!--
-body,td,a,p,.h{font-family:arial,sans-serif;}
-.h{font-size: 20px;}
-.q{color:#0000cc;}
--->
-</style>
-<script>
-<!--
-function sf(){document.f.q.focus();}
-// -->
-</script>
-</head><body bgcolor=#ffffff text=#000000 link=#0000cc vlink=#551a8b alink=#ff0000 onLoad=sf() topmargin=3 marginheight=3><center><table border=0 cellspacing=0 cellpadding=0 width=100%><tr><td align=right nowrap><font size=-1><a href="/url?sa=p&pref=ig&pval=2&q=http://www.google.com/ig%3Fhl%3Den">Personalized Home</a>&nbsp;|&nbsp;<a href="https://www.google.com/accounts/Login?continue=http://www.google.com/&hl=en">Sign in</a></font></td></tr><tr height=4><td><img alt="" width=1 height=1></td></tr></table><img src="/intl/en/images/logo.gif" width=276 height=110 alt="Google"><br><br>
-<form action=/search name=f><table border=0 cellspacing=0 cellpadding=4><tr><td nowrap><font size=-1><b>Web</b>&nbsp;&nbsp;&nbsp;&nbsp;<a id=1a class=q href="/imghp?hl=en&tab=wi&ie=UTF-8">Images</a>&nbsp;&nbsp;&nbsp;&nbsp;<a id=2a class=q href="http://groups.google.com/grphp?hl=en&tab=wg&ie=UTF-8">Groups</a>&nbsp;&nbsp;&nbsp;&nbsp;<a id=4a class=q href="http://news.google.com/nwshp?hl=en&tab=wn&ie=UTF-8">News</a>&nbsp;&nbsp;&nbsp;&nbsp;<a id=5a class=q href="http://froogle.google.com/frghp?hl=en&tab=wf&ie=UTF-8">Froogle</a>&nbsp;&nbsp;&nbsp;&nbsp;<a id=7a class=q href="/maphp?hl=en&tab=wl&ie=UTF-8">Maps</a>&nbsp;&nbsp;&nbsp;&nbsp;<b><a href="/intl/en/options/" class=q>more&nbsp;&raquo;</a></b></font></td></tr></table><table cellspacing=0 cellpadding=0><tr><td width=25%>&nbsp;</td><td align=center><input type=hidden name=hl value=en><input type=hidden name=ie value="ISO-8859-1"><input maxlength=2048 size=55 name=q value="" title="Google Search"><br><input type=submit value="Google Search" name=btnG><input type=submit value="I'm Feeling Lucky" name=btnI></td><td valign=top nowrap width=25%><font size=-2>&nbsp;&nbsp;<a href=/advanced_search?hl=en>Advanced Search</a><br>&nbsp;&nbsp;<a href=/preferences?hl=en>Preferences</a><br>&nbsp;&nbsp;<a href=/language_tools?hl=en>Language Tools</a></font></td></tr></table></form><br><br><font size=-1><a href="/intl/en/ads/">Advertising&nbsp;Programs</a> - <a href=/services/>Business Solutions</a> - <a href=/intl/en/about.html>About Google</a></font><p><font size=-2>&copy;2006 Google</font></p></center></body></html>

data/test/unit/test_examples.rb

@@ -1,45 +0,0 @@
-$:.unshift "#{File.dirname(__FILE__)}/../../lib"
-
-require 'test/unit'
-require 'fake_web'
-require 'open-uri'
-
-class FakeWebExampleTest < Test::Unit::TestCase
-  def test_request
-    FakeWeb.register_uri('http://example.com/test_me', :string => "Hello World!")
-    content = Net::HTTP.get(URI.parse('http://example.com/test_me'))
-    assert_equal "Hello World!", content
-  end
-
-  def test_request_with_response
-    FakeWeb.register_uri('http://www.google.com/', :response => `curl -is http://www.google.com/`)
-    Net::HTTP.start('www.google.com') do |req|
-      response = req.get('/')
-      if response.code == 200
-        assert_equal "OK", response.message
-        assert response.body.include?('<title>Google')
-      elsif response.code == 302
-        # Google redirects foreign sites to ccTLDs.
-        assert_equal "Found", response.message
-        assert response.body.include?('The document has moved')
-      end
-    end
-  end
-
-  def test_request_with_custom_status
-    FakeWeb.register_uri('http://example.com/', :string => "Nothing to be found 'round here",
-                                                :status => ['404', 'Not Found'])
-    Net::HTTP.start('example.com') do |req|
-      response = req.get('/')
-      assert_equal "404", response.code
-      assert_equal "Not Found", response.message
-      assert_equal "Nothing to be found 'round here", response.body
-    end
-  end
-
-  def test_open_uri
-    FakeWeb.register_uri('http://example.com/', :string => "Hello, World!")
-    content = open('http://example.com/').string
-    assert_equal "Hello, World!", content
-  end
-end