mechanized_session 0.0.1 → 0.0.2

data/lib/mechanized_session.rb

@@ -3,6 +3,7 @@ $:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) ||
 require "rubygems"
 gem "mechanize"
 require "mechanize"
+require "logger"
 
 class MechanizedSession
   class Error < StandardError
@@ -18,20 +19,23 @@ class MechanizedSession
     attr_accessor :inner
   end
 
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
   attr_accessor :agent
   attr_accessor :disable_session_check
+  attr_accessor :logger
   attr_reader :logged_in
 
   def self.action(name, &block)
     define_method name do |*args|
       result = nil
+      logger.debug "Executing action :#{name}"
       begin
         self.disable_session_check = true if name == :login
         result = block.call(self, *args)
         check_for_invalid_session! unless name == :login
       rescue StandardError => e
-        if e.is_a?(MechanizedSession::Error)
+        logger.debug "Exception #{e} (#{e.class}) raised in action :#{name}"
+        if e.is_a?(MechanizedSession::Error) || e.is_a?(WWW::Mechanize::ResponseCodeError) && e.response_code.to_s == "401"
           raise e
         else
           ex = MechanizeError.new("Unable to execute action :#{name}, due to '#{e}'")
@@ -48,13 +52,17 @@ class MechanizedSession
 
   def initialize(options)
     create_agent
+    @logger = options[:logger] || Logger.new($stdout)
     if options[:session_data]
+      logger.debug "Initializing session from previous data"
       self.agent.cookie_jar = YAML.load(options[:session_data])
     elsif options[:username]
       result = self.login(options)
       if result == false
+        logger.debug "Login returned false, due to invalid credentials we hope"
         raise InvalidAuthentication
       elsif result == true
+        logger.debug "Login returned true, assuming session established"
         @logged_in = true
       else
         raise "the :login method of #{self.class} must return exactly true or false (depending on the success of the login)"
@@ -63,23 +71,32 @@ class MechanizedSession
   end
 
   def get(uri, &block)
+    logger.debug "GET #{uri}"
     page = agent.get(uri)
+    logger.debug "Successfully got page #{page.uri}"
     check_for_invalid_session! unless disable_session_check?
     yield page if block_given?
     page
   end
 
+  def login(username, password)
+    raise "#{self.class} must declare action :login describing how to log in a session"
+  end
+
+  def session_data
+    agent.cookie_jar.to_yaml
+  end
+
   private
   def disable_session_check?
     @disable_session_check
   end
 
   def check_for_invalid_session!
-    raise InvalidSession if agent.current_page && self.class.requires_login?(agent.current_page)
-  end
-
-  def login(username, password)
-    raise "#{self.class} must declare action :login describing how to log in a session"
+    if agent.current_page && self.class.requires_login?(agent.current_page)
+      logger.info "MechanizedSession is no longer valid"
+      raise InvalidSession
+    end
   end
 
   def self.requires_login?(page)

data/test/test_mechanized_session.rb

@@ -22,6 +22,7 @@ class TestMechanizedSession < Test::Unit::TestCase
   end
 
   def setup
+    @logger = Logger.new(StringIO.new)
     @previous_session_data = <<-YAML
 --- !ruby/object:WWW::Mechanize::CookieJar
 jar:
@@ -57,30 +58,30 @@ jar:
   end
 
   def test_initialize_with_previous_session__sets_cookies
-    session = MechanizedSession.new(:session_data => @previous_session_data)
+    session = MechanizedSession.new(:session_data => @previous_session_data, :logger =>@logger)
     google_cookies = session.agent.cookie_jar.cookies(URI.parse("http://google.com/"))
     assert_equal 2, google_cookies.length
   end
 
   def test_initialize_with_username__calls_login
-    session = ExampleEmptyMechanizedSession.new(:username => "david", :password => "ponies")
+    session = ExampleEmptyMechanizedSession.new(:username => "david", :password => "ponies", :logger => @logger)
     assert session.logged_in
   end
 
   def test_initialize_with_username__calls_login__raises_exception_if_returns_false
     assert_raises(MechanizedSession::InvalidAuthentication) do
-      ExampleEmptyMechanizedSession.new(:username => "bad user", :password => "noponies")
+      ExampleEmptyMechanizedSession.new(:username => "bad user", :password => "noponies", :logger => @logger)
     end
   end
 
   def test_initialize_with_username__calls_login__raises_exception_if_returns_non_true
     assert_raises(RuntimeError) do
-      ExampleEmptyMechanizedSession.new(:username => "bad implementation", :password => "noponies")
+      ExampleEmptyMechanizedSession.new(:username => "bad implementation", :password => "noponies", :logger => @logger)
     end
   end
 
   def test_check_for_invalid_session__raises_error_when_doing_something_that_requires_login
-    session = ExampleEmptyMechanizedSession.new({})
+    session = ExampleEmptyMechanizedSession.new(:logger => @logger)
     assert_raises(MechanizedSession::InvalidSession) {
       session.do_something_requiring_login
     }

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: mechanized_session
 version: !ruby/object:Gem::Version 
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors: 
 - David Stevenson
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-05 00:00:00 -08:00
+date: 2009-12-06 00:00:00 -08:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency