mechanized_session 0.0.2 → 0.1.0

data/README.rdoc

@@ -1,32 +1,66 @@
 = mechanized_session
 
-* http://github.com/#{github_username}/#{project_name}
+* http://github.com/dsboulder/mechanized_session
 
 == DESCRIPTION:
 
-FIX (describe your package)
+A gem which uses the `mechanize` gem to make it easier to execute remote requests that require an authenticated session.
+It allows the programmer to provide a `:login` action callback which is executed whenever mechanized_session determines that the
+session has gone bad or authentication is required.  The programmer also provides other actions which perform useful tasks.
 
-== FEATURES/PROBLEMS:
-
-* FIX (list of features or problems)
+To use this with rails, check out `acts_as_other_website`.
 
 == SYNOPSIS:
 
-  FIX (code sample of usage)
+class SomeSiteSession < MechanizedSession
+  action :login do |session, options|
+    session.get('http://www.google.com/login') do |page|
+      next_page = page.form_with(:action =>"/login") do |form|
+        form["email"] = options[:username]
+        form["password"] = options[:password]
+      end.click_button
+      return false if next_page.uri.path.include?("/login")
+    end
+    true
+  end
+
+  action :get_widgets do |session|
+    links = []
+    session.get('http://www.google.com/ig") do |page|  # might throw InvalidSession if not logged in
+      links += page.links
+    end
+    links
+  end
+
+  def self.requires_login?(page)  # explaining to mechanized_session when a page was a redirect to the login page 
+    page.uri.path.downcase.include?("/login")
+  end
+end
+
+@session = SomeSiteSession.new
+begin
+  @session.get_widgets
+rescue InvalidSession => e
+  # deal with invalid session, ask the user for credentials
+  @session = SomeSiteSession.new(:username => "bob", :password => "password")
+  retry
+end
 
 == REQUIREMENTS:
 
-* FIX (list of requirements)
+* mechanize gem
 
 == INSTALL:
 
-* FIX (sudo gem install, anything else)
+* sudo gem install mechanized_session
+
+See blog post at: http://flouri.sh/2009/12/7/introducing-mechanized_session-and-acts_as_other_website
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2009 FIXME full name
+Copyright (c) 2009 David Stevenson
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -14,7 +14,7 @@ $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']]
+   self.extra_deps         = [['mechanize','>= 1.0.0']]
 
 end
 

data/lib/mechanized_session.rb

@@ -19,7 +19,7 @@ class MechanizedSession
     attr_accessor :inner
   end
 
-  VERSION = '0.0.2'
+  VERSION = '0.1.0'
   attr_accessor :agent
   attr_accessor :disable_session_check
   attr_accessor :logger
@@ -79,6 +79,33 @@ class MechanizedSession
     page
   end
 
+  def post(uri, params = {}, &block)
+    logger.debug "POST #{uri} #{params.inspect}"
+    page = agent.post(uri, params)
+    logger.debug "Successfully got page #{page.uri}"
+    check_for_invalid_session! unless disable_session_check?
+    yield page if block_given?
+    page
+  end
+
+  def put(uri, entity, &block)
+    logger.debug "PUT #{uri} #{entity.inspect}"
+    page = agent.put(uri, entity)
+    logger.debug "Successfully got page #{page.uri}"
+    check_for_invalid_session! unless disable_session_check?
+    yield page if block_given?
+    page
+  end
+
+  def delete(uri, params = {}, &block)
+    logger.debug "DELETE #{uri} #{params.inspect}"
+    page = agent.delete(uri, params)
+    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
@@ -87,6 +114,10 @@ class MechanizedSession
     agent.cookie_jar.to_yaml
   end
 
+  def basic_auth
+    nil
+  end
+
   private
   def disable_session_check?
     @disable_session_check
@@ -104,6 +135,10 @@ class MechanizedSession
   end
 
   def create_agent
-    self.agent = WWW::Mechanize.new
+    self.agent = Mechanize.new
+    self.agent.log = logger
+    if auth = basic_auth
+      self.agent.auth(*auth)
+    end
   end
-end
+end

metadata

@@ -1,7 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: mechanized_session
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
 platform: ruby
 authors: 
 - David Stevenson
@@ -9,30 +15,63 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-12-06 00:00:00 -08:00
+date: 2010-10-02 00:00:00 -07:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: mechanize
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
   type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: rubyforge
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 0.9.3
-    version: 
+        hash: 7
+        segments: 
+        - 2
+        - 0
+        - 4
+        version: 2.0.4
+  type: :development
+  version_requirements: *id002
 - !ruby/object:Gem::Dependency 
   name: hoe
-  type: :development
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.3.3
-    version: 
-description: FIX (describe your package)
+        hash: 21
+        segments: 
+        - 2
+        - 6
+        - 1
+        version: 2.6.1
+  type: :development
+  version_requirements: *id003
+description: |-
+  A gem which uses the `mechanize` gem to make it easier to execute remote requests that require an authenticated session.
+  It allows the programmer to provide a `:login` action callback which is executed whenever mechanized_session determines that the
+  session has gone bad or authentication is required.  The programmer also provides other actions which perform useful tasks.
+  
+  To use this with rails, check out `acts_as_other_website`.
 email: 
 - stellar256@hotmail.com
 executables: []
@@ -56,7 +95,7 @@ files:
 - test/test_helper.rb
 - test/test_mechanized_session.rb
 has_rdoc: true
-homepage: http://github.com/#{github_username}/#{project_name}
+homepage: http://github.com/dsboulder/mechanized_session
 licenses: []
 
 post_install_message: 
@@ -66,24 +105,30 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
       version: "0"
-  version: 
 requirements: []
 
 rubyforge_project: mechanized_session
-rubygems_version: 1.3.5
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: FIX (describe your package)
+summary: A gem which uses the `mechanize` gem to make it easier to execute remote requests that require an authenticated session
 test_files: 
 - test/test_helper.rb
 - test/test_mechanized_session.rb