mechanized_session 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+=== 0.0.1 2009-12-05
+
+* 1 major enhancement:
+  * Initial release

data/Manifest.txt

@@ -0,0 +1,11 @@
+History.txt
+Manifest.txt
+PostInstall.txt
+README.rdoc
+Rakefile
+lib/mechanized_session.rb
+script/console
+script/destroy
+script/generate
+test/test_helper.rb
+test/test_mechanized_session.rb

data/PostInstall.txt

@@ -0,0 +1,7 @@
+
+For more information on mechanized_session, see http://mechanized_session.rubyforge.org
+
+NOTE: Change this information in PostInstall.txt 
+You can also delete it if you don't want it.
+
+

data/README.rdoc

@@ -0,0 +1,48 @@
+= mechanized_session
+
+* http://github.com/#{github_username}/#{project_name}
+
+== DESCRIPTION:
+
+FIX (describe your package)
+
+== FEATURES/PROBLEMS:
+
+* FIX (list of features or problems)
+
+== SYNOPSIS:
+
+  FIX (code sample of usage)
+
+== REQUIREMENTS:
+
+* FIX (list of requirements)
+
+== INSTALL:
+
+* FIX (sudo gem install, anything else)
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2009 FIXME full name
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+'Software'), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED 'AS IS', WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -0,0 +1,26 @@
+require 'rubygems'
+gem 'hoe', '>= 2.1.0'
+require 'hoe'
+require 'fileutils'
+require './lib/mechanized_session'
+
+Hoe.plugin :newgem
+# Hoe.plugin :website
+# Hoe.plugin :cucumberfeatures
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.spec 'mechanized_session' do
+  self.developer 'David Stevenson', 'stellar256@hotmail.com'
+#  self.post_install_message = 'PostInstall.txt' # TODO remove if post-install message not required
+#  self.rubyforge_name       = self.name # TODO this is default value
+   self.extra_deps         = [['mechanize','>= 0.9.3']]
+
+end
+
+require 'newgem/tasks'
+Dir['tasks/**/*.rake'].each { |t| load t }
+
+# TODO - want other tests/tasks run by default? Add them to the list
+# remove_task :default
+# task :default => [:spec, :features]

data/lib/mechanized_session.rb

@@ -0,0 +1,92 @@
+$:.unshift(File.dirname(__FILE__)) unless $:.include?(File.dirname(__FILE__)) || $:.include?(File.expand_path(File.dirname(__FILE__)))
+
+require "rubygems"
+gem "mechanize"
+require "mechanize"
+
+class MechanizedSession
+  class Error < StandardError
+  end
+
+  class InvalidAuthentication < MechanizedSession::Error
+  end
+
+  class InvalidSession < MechanizedSession::Error
+  end
+
+  class MechanizeError < MechanizedSession::Error
+    attr_accessor :inner
+  end
+
+  VERSION = '0.0.1'
+  attr_accessor :agent
+  attr_accessor :disable_session_check
+  attr_reader :logged_in
+
+  def self.action(name, &block)
+    define_method name do |*args|
+      result = nil
+      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)
+          raise e
+        else
+          ex = MechanizeError.new("Unable to execute action :#{name}, due to '#{e}'")
+          ex.inner = e
+          ex.set_backtrace(e.backtrace)
+          raise ex
+        end
+      ensure
+        self.disable_session_check = nil
+      end
+      result
+    end
+  end
+
+  def initialize(options)
+    create_agent
+    if options[:session_data]
+      self.agent.cookie_jar = YAML.load(options[:session_data])
+    elsif options[:username]
+      result = self.login(options)
+      if result == false
+        raise InvalidAuthentication
+      elsif result == true
+        @logged_in = true
+      else
+        raise "the :login method of #{self.class} must return exactly true or false (depending on the success of the login)"
+      end
+    end
+  end
+
+  def get(uri, &block)
+    page = agent.get(uri)
+    check_for_invalid_session! unless disable_session_check?
+    yield page if block_given?
+    page
+  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"
+  end
+
+  def self.requires_login?(page)
+    page.uri.path.downcase.include?("login")
+  end
+
+  def create_agent
+    self.agent = WWW::Mechanize.new
+  end
+end

data/script/console

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+# File: script/console
+irb = RUBY_PLATFORM =~ /(:?mswin|mingw)/ ? 'irb.bat' : 'irb'
+
+libs =  " -r irb/completion"
+# Perhaps use a console_lib to store any extra methods I may want available in the cosole
+# libs << " -r #{File.dirname(__FILE__) + '/../lib/console_lib/console_logger.rb'}"
+libs <<  " -r #{File.dirname(__FILE__) + '/../lib/mechanized_session.rb'}"
+puts "Loading mechanized_session gem"
+exec "#{irb} #{libs} --simple-prompt"

data/script/destroy

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/destroy'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Destroy.new.run(ARGV)

data/script/generate

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+APP_ROOT = File.expand_path(File.join(File.dirname(__FILE__), '..'))
+
+begin
+  require 'rubigen'
+rescue LoadError
+  require 'rubygems'
+  require 'rubigen'
+end
+require 'rubigen/scripts/generate'
+
+ARGV.shift if ['--help', '-h'].include?(ARGV[0])
+RubiGen::Base.use_component_sources! [:rubygems, :newgem, :newgem_theme, :test_unit]
+RubiGen::Scripts::Generate.new.run(ARGV)

data/test/test_helper.rb

@@ -0,0 +1,4 @@
+require 'stringio'
+require 'test/unit'
+require File.dirname(__FILE__) + '/../lib/mechanized_session'
+require 'mocha'

data/test/test_mechanized_session.rb

@@ -0,0 +1,88 @@
+require File.dirname(__FILE__) + '/test_helper.rb'
+require "pp"
+
+class TestMechanizedSession < Test::Unit::TestCase
+  class ExampleEmptyMechanizedSession < MechanizedSession
+    action :login do |session, options|
+      session.get('https://www.google.com/accounts/ManageAccount?hl=en') do |page|
+      end
+      if options[:username] == "bad implementation"
+        nil
+      else
+        @username = options[:username]
+        @password = options[:password]
+        options[:username] == "bad user" ? false : true
+      end
+    end
+    
+    action :do_something_requiring_login do |session|
+      session.get('https://www.google.com/accounts/ManageAccount?hl=en') do |page|
+      end
+    end
+  end
+
+  def setup
+    @previous_session_data = <<-YAML
+--- !ruby/object:WWW::Mechanize::CookieJar
+jar:
+  google.com:
+    /:
+      PREF: !ruby/object:WWW::Mechanize::Cookie
+        comment:
+        comment_url:
+        discard:
+        domain: google.com
+        expires: Mon, 05 Dec 2011 20:13:27 GMT
+        max_age:
+        name: PREF
+        path: /
+        port:
+        secure: false
+        value: ID=81b036b3879502d3:TM=1260044007:LM=1260044007:S=gTZE41MSHOrSwy5S
+        version: 0
+      NID: !ruby/object:WWW::Mechanize::Cookie
+        comment:
+        comment_url:
+        discard:
+        domain: google.com
+        expires: Sun, 06 Jun 2010 20:13:27 GMT
+        max_age:
+        name: NID
+        path: /
+        port:
+        secure: false
+        value: 29=W6XhKG_4rDv709QX6oDGzHQ5y17pISryKo75MZuWOZ59HNZm011Htlk_TYKIdXEwau_4GK3jIjFHALrbDFjoJ7Pz-zmOc5evFZAp71Og7itAVYPDQukb8Z7DwBB9qLzt
+        version: 0
+    YAML
+  end
+
+  def test_initialize_with_previous_session__sets_cookies
+    session = MechanizedSession.new(:session_data => @previous_session_data)
+    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")
+    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")
+    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")
+    end
+  end
+
+  def test_check_for_invalid_session__raises_error_when_doing_something_that_requires_login
+    session = ExampleEmptyMechanizedSession.new({})
+    assert_raises(MechanizedSession::InvalidSession) {
+      session.do_something_requiring_login
+    }
+  end
+end

metadata

@@ -0,0 +1,89 @@
+--- !ruby/object:Gem::Specification 
+name: mechanized_session
+version: !ruby/object:Gem::Version 
+  version: 0.0.1
+platform: ruby
+authors: 
+- David Stevenson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-05 00:00:00 -08:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: mechanize
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.9.3
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: hoe
+  type: :development
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 2.3.3
+    version: 
+description: FIX (describe your package)
+email: 
+- stellar256@hotmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+files: 
+- History.txt
+- Manifest.txt
+- PostInstall.txt
+- README.rdoc
+- Rakefile
+- lib/mechanized_session.rb
+- script/console
+- script/destroy
+- script/generate
+- test/test_helper.rb
+- test/test_mechanized_session.rb
+has_rdoc: true
+homepage: http://github.com/#{github_username}/#{project_name}
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: mechanized_session
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: FIX (describe your package)
+test_files: 
+- test/test_helper.rb
+- test/test_mechanized_session.rb