Merge pull request #258 from djanowski/shutdown

`Mechanize::start` and `Mechanize#shutdown`

lib/mechanize.rb

@@ -137,6 +137,23 @@ def self.inherited(child) # :nodoc:
     super
   end
 
+  ##
+  # Creates a new Mechanize instance and yields it to the given block.
+  #
+  # After the block executes, the instance is cleaned up. This includes
+  # closing all open connections.
+  #
+  #   Mechanize.start do |m|
+  #     m.get("http://example.com")
+  #   end
+
+  def self.start
+    instance = new
+    yield(instance)
+  ensure
+    instance.shutdown
+  end
+
   ##
   # Creates a new mechanize instance.  If a block is given, the created
   # instance is yielded to the block for setting up pre-connection state such
@@ -1211,6 +1228,22 @@ def set_proxy address, port, user = nil, password = nil
     @agent.set_proxy address, port, user, password
   end
 
+  ##
+  # Clears history and cookies.
+
+  def reset
+    @agent.reset
+  end
+
+  ##
+  # Shuts down this session by clearing browsing state and closing all
+  # persistent connections.
+
+  def shutdown
+    reset
+    @agent.shutdown
+  end
+
   private
 
   ##

lib/mechanize/http/agent.rb

@@ -401,6 +401,11 @@ def connection_for uri
     end
   end
 
+  # Closes all open connections for this agent.
+  def shutdown
+    http.shutdown
+  end
+
   ##
   # Decodes a gzip-encoded +body_io+.  If it cannot be decoded, inflate is
   # tried followed by raising an error.
@@ -694,7 +699,7 @@ def response_authenticate(response, page, uri, request, headers, params,
       message = 'WWW-Authenticate header missing in response'
       raise Mechanize::UnauthorizedError.new(page, nil, message)
     end
-                                               
+
     challenges = @authenticate_parser.parse www_authenticate
 
     unless @auth_store.credentials? uri, challenges then
@@ -798,7 +803,7 @@ def response_content_encoding response, body_io
     begin
       if Tempfile === body_io and
          (StringIO === out_io or out_io.path != body_io.path) then
-        body_io.close! 
+        body_io.close!
       end
     rescue IOError
       # HACK ruby 1.8 raises IOError when closing the stream
@@ -1198,6 +1203,11 @@ def use_tempfile? size
     size >= @max_file_buffer
   end
 
+  def reset
+    @cookie_jar.clear!
+    @history.clear
+  end
+
 end
 
 require 'mechanize/http/auth_store'

test/test_mechanize.rb

@@ -1017,6 +1017,40 @@ def test_set_proxy
     assert_equal URI('http://user:pass@localhost:8080'), http.proxy_uri
   end
 
+  def test_shutdown
+    uri = URI 'http://localhost'
+    jar = Mechanize::CookieJar.new
+    Mechanize::Cookie.parse uri, 'a=b' do |cookie|
+      jar.add uri, cookie
+    end
+
+    @mech.cookie_jar = jar
+
+    @mech.get("http://localhost/")
+
+    assert_match /Hello World/, @mech.current_page.body
+    refute_empty @mech.cookies
+    refute_empty Thread.current[@mech.agent.http.request_key]
+
+    @mech.shutdown
+
+    assert_nil Thread.current[@mech.agent.http.request_key]
+    assert_empty @mech.history
+    assert_empty @mech.cookies
+  end
+
+  def test_start
+    body, id = nil
+
+    Mechanize.start do |m|
+      body = m.get("http://localhost/").body
+      id = m.agent.http.request_key
+    end
+
+    assert_match /Hello World/, body
+    assert_nil Thread.current[id]
+  end
+
   def test_submit_bad_form_method
     page = @mech.get("http://localhost/bad_form_test.html")
     assert_raises ArgumentError do