impostor 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 / 2008-02-02
+
+* 1 major enhancement
+  * Birthday!

data/Manifest.txt

@@ -0,0 +1,50 @@
+History.txt
+Manifest.txt
+README.txt
+Rakefile
+lib/impostor.rb
+lib/www/impostor.rb
+lib/www/impostor/phpbb2.rb
+lib/www/impostor/wwf79.rb
+lib/www/impostor/wwf80.rb
+test/fixtures/phpbb2-get-new_topic-form-good-response.html
+test/fixtures/phpbb2-get-viewtopic-for-new-topic-good-response.html
+test/fixtures/phpbb2-get-viewtopic-for-new-topic-malformed-response.html
+test/fixtures/phpbb2-index.html
+test/fixtures/phpbb2-logged-in.html
+test/fixtures/phpbb2-login.html
+test/fixtures/phpbb2-not-logged-in.html
+test/fixtures/phpbb2-post-new_topic-good-response.html
+test/fixtures/phpbb2-post-reply-good-response.html
+test/fixtures/phpbb2-post-reply-throttled-response.html
+test/fixtures/phpbb2-too-many-posts.html
+test/fixtures/wwf79-forum_posts.html
+test/fixtures/wwf79-general-new-topic-error.html
+test/fixtures/wwf79-general-posting-error.html
+test/fixtures/wwf79-good-post-forum_posts.html
+test/fixtures/wwf79-index.html
+test/fixtures/wwf79-logged-in.html
+test/fixtures/wwf79-login.html
+test/fixtures/wwf79-new-topic-forum_posts-response.html
+test/fixtures/wwf79-new-topic-post_message_form.html
+test/fixtures/wwf79-not-logged-in.html
+test/fixtures/wwf79-too-many-posts.html
+test/fixtures/wwf79-too-many-topics.html
+test/fixtures/wwf80-general-posting-error.html
+test/fixtures/wwf80-get-new_topic-form-good-response.html
+test/fixtures/wwf80-get-viewtopic-for-new-topic-good-response.html
+test/fixtures/wwf80-index.html
+test/fixtures/wwf80-logged-in.html
+test/fixtures/wwf80-login.html
+test/fixtures/wwf80-new_reply_form.html
+test/fixtures/wwf80-not-logged-in.html
+test/fixtures/wwf80-post-new_topic-good-response.html
+test/fixtures/wwf80-post-reply-good-response.html
+test/fixtures/wwf80-too-many-posts.html
+test/test_helper.rb
+test/test_www_impostor.rb
+test/test_www_impostor_phpbb2.rb
+test/test_www_impostor_wwf79.rb
+test/test_www_impostor_wwf80.rb
+vendor/plugins/impostor/lib/autotest/discover.rb
+vendor/plugins/impostor/lib/autotest/impostor.rb

data/README.txt

@@ -0,0 +1,65 @@
+impostor
+    by Mike Mondragon
+    http://impostor.rubyforge.org/
+
+== DESCRIPTION:
+  
+imPOSTor posts messages to forums
+
+== FEATURES/PROBLEMS:
+
+Makes automatic posts to the following forum applications:
+
+* Web Wiz Forums (WWF) 7.9
+* Web Wiz Forums (WWF) 8.0
+* PHP Bullitin Board (phpBB) 2.0 (2.0.22)
+
+== SYNOPSIS:
+
+# config yaml has options specefic to wwf79, wwf80, phpbb2, etc.
+# read the impostor docs for options to the kind of forum in use
+# config can be keyed by symbols or strings
+config = YAML::load_file('conf/impostor.yml')
+post = WWW::Impostor.new(config)
+message = %q{hello world is to application
+programmers as tea pots are to graphics programmers}
+# your application stores forum and topic ids
+post.post(forum=5,topic=10,message)
+# make a new topic
+subject = "about programmers..."
+post.new_topic(forum=7,subject,message)
+post.logout
+
+== REQUIREMENTS:
+
+* mechanize
+* hpricot
+
+== INSTALL:
+
+* sudo gem install impostor
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Mike Mondragon
+
+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,40 @@
+# -*- ruby -*-
+
+require 'rubygems'
+require 'hoe'
+begin
+  require 'rcov/rcovtask'
+rescue LoadError
+end
+require 'mechanize'
+$LOAD_PATH.unshift 'lib'
+require 'impostor'
+
+Hoe.new('impostor', WWW::Impostor::VERSION) do |p|
+  p.rubyforge_name = 'impostor'
+  p.author = 'Mike Mondragon'
+  p.email = 'mikemondragon@gmail.com'
+  p.summary = 'imPOSTor posts messages to non-RESTful forums and blogs'
+  p.description = p.paragraphs_of('README.txt', 3..6).join("\n\n")
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.changes = p.paragraphs_of('History.txt', 0..1).join("\n\n")
+  p.extra_deps << ['hpricot', '>= 0.5.0']
+  p.extra_deps << ['mechanize', '>= 0.7.0']
+  p.clean_globs << 'coverage'
+end
+
+begin
+  Rcov::RcovTask.new do |t|
+    t.test_files = FileList['test/test_www_impostor*.rb']
+    t.verbose = true
+  end
+rescue NameError
+end
+
+Rake::TestTask.new do |t|
+  t.libs << "test"
+  t.test_files = FileList['test/test_www_impostor*.rb']
+  t.verbose = true
+end
+
+# vim: syntax=Ruby

data/lib/impostor.rb

@@ -0,0 +1,6 @@
+# Copyright (c) 2008 by Mike Mondragon (mikemondragon@gmail.com)
+#
+# Please see the LICENSE file for licensing.
+#
+
+require 'www/impostor'

data/lib/www/impostor/phpbb2.rb

@@ -0,0 +1,260 @@
+require 'rubygems'
+require 'hpricot'
+gem 'mechanize', '>= 0.7.0'
+require 'mechanize'
+require 'cgi'
+
+##
+# phpBB version of the Impostor
+#
+
+class WWW::Impostor
+  
+  class Phpbb2 < WWW::Impostor
+
+    ##
+    # After initializing the parent a mechanize agent is created
+    #
+    # Additional configuration parameters:
+    #
+    # :posting_page
+    #
+    # Typical configuration parameters
+    # { :type => :phpbb2,
+    # :app_root => 'http://example.com/forum/',
+    # :login_page => 'login.php',
+    # :posting_page => 'posting.php',
+    # :user_agent => 'Windows IE 7',
+    # :username => 'myuser',
+    # :password => 'mypasswd' }
+
+    def initialize(config={})
+      super(config)
+      @agent = WWW::Mechanize.new
+      @agent.user_agent_alias = user_agent
+      # jar is a yaml file
+      @agent.cookie_jar.load(cookie_jar) if cookie_jar && File.exist?(cookie_jar)
+      @message = nil
+      @loggedin = false
+    end
+
+    ##
+    # clean up the state of the library and log out
+
+    def logout
+      return false unless @loggedin
+
+      @agent.cookie_jar.save_as(cookie_jar) if cookie_jar
+      save_topics
+
+      @forum = nil
+      @topic = nil
+      @message = nil
+
+      @loggedin = false
+      true
+    end
+
+    ##
+    # make a new topic
+
+    def new_topic(forum=@forum, subject=@subject, message=@message)
+      raise PostError.new("forum not set") unless forum
+      raise PostError.new("topic name not given") unless subject
+      raise PostError.new("message not set") unless message
+
+      login
+      raise PostError.new("not logged in") unless @loggedin
+
+      uri = posting_page
+      uri.query = "mode=newtopic&f=#{forum}"
+
+      # get the submit form
+      begin
+        page = @agent.get(uri)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+
+      form = page.form('post') rescue nil
+      button = form.buttons.with.name('post').first rescue nil
+      raise PostError.new("post form not found") unless button && form
+
+      # set up the form and submit it
+      form.subject = subject
+      form.message = message
+      form['disable_html'] = nil
+      form['disable_bbcode'] = 'on'
+      form['disable_smilies'] = 'on'
+      begin
+        page = @agent.submit(form, button)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+
+      # if the response is correct there will be a meta link that looks something like
+      # <meta http-equiv="refresh" content="3;url=viewtopic.php?p=29#29">
+      #
+      # this link needs to be followed, the page it leads to will give us
+      # the topic id that was created for the topic name that we created
+      a = (page.search("//meta[@http-equiv='refresh']").attr('content') rescue nil)
+      a = (/url=(.*)/.match(a)[1] rescue nil)
+      raise PostError.new('unexpected new topic response from refresh') unless a
+
+      a = URI.join(app_root, a)
+      page = @agent.get(a)
+      link = (page.search("//link[@rel='prev']").first['href'] rescue nil)
+      raise PostError.new('unexpected new topic response from link prev') unless link
+
+      # t=XXX will be our new topic id, i.e.
+      # <link rel="prev" href="http://localhost/phpBB2/viewtopic.php?t=5&amp;view=previous" title="View previous topic"
+      u = (URI.parse(link) rescue nil)
+      topic = (CGI::parse(u.query)['t'][0] rescue nil)
+      topic = topic.to_i
+      raise PostError.new('unexpected new topic ID') unless topic > 0
+
+      # save new topic id and topic name
+      add_subject(forum, topic, subject)
+      @forum=forum; @topic=topic; @subject=subject; @message=message
+      true
+    end
+
+    ##
+    # Attempt to post to the forum
+
+    def post(forum = @forum, topic = @topic, message = @message)
+      raise PostError.new("forum not set") unless forum
+      raise PostError.new("topic not set") unless topic
+      raise PostError.new("message not set") unless message
+
+      login
+      raise PostError.new("not logged in") unless @loggedin
+
+      uri = posting_page
+      uri.query = "mode=reply&t=#{topic}"
+
+      # get the submit form
+      begin
+        page = @agent.get(uri)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+
+      form = page.form('post') rescue nil
+      button = form.buttons.with.name('post').first rescue nil
+      raise PostError.new("post form not found") unless button && form
+
+      # set up the form and submit it
+      form.message = message
+      form['disable_html'] = nil
+      form['disable_bbcode'] = 'on'
+      form['disable_smilies'] = 'on'
+      begin
+        page = @agent.submit(form, button)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+
+      mes = page.search("//span[@class='gen']").last
+      posted = mes.innerText =~ /Your message has been entered successfully./ rescue false
+      if posted
+        @forum=forum; @topic=topic; @subject=get_subject(forum,topic); @message=message
+        return true
+      end
+
+      too_many = (mes.innerText =~ 
+        /You cannot make another post so soon after your last; please try again in a short while./ rescue
+        false)
+      raise ThrottledError.new("too many posts in too short amount of time") if too_many
+
+      # false otherwise, should we raise an exception instead?
+      false
+    end
+
+    ##
+    # Get the posting page for the application (specific to phpBB2)
+  
+    def posting_page
+      URI.join(app_root, config[:posting_page])
+    end
+  
+    ##
+    # does the work of logging into phpbb
+
+    def login
+      return true if @loggedin
+
+      # get the login page
+      page = fetch_login_page
+
+      # return if we are already logged in from a cookie state
+      return true if logged_in?(page)
+
+      # setup the form and submit
+      form, button = login_form_and_button(page)
+      page = post_login(form, button)
+
+      # set up the rest of the state if we are logged in
+      @loggedin = logged_in?(page)
+      load_topics if @loggedin
+
+      @loggedin
+    end
+
+    def version
+      @version ||= self.class.to_s
+    end
+
+    protected
+
+    ##
+    # does the work of posting the login form
+
+    def post_login(form, button)
+      begin
+        page = @agent.submit(form, button)
+      rescue StandardError => err
+        raise LoginError.new(err)
+      end
+    end
+
+    ##
+    # returns the login form and its button from the login page
+
+    def login_form_and_button(page)
+      form = page.forms.first rescue nil
+      raise LoginError.new("unknown login page format") unless form
+      
+      button = page.forms.first.buttons.with.name('login').first
+      form['username'] = username
+      form['password'] = password
+      form['autologin'] = 'on'
+
+      return form, button
+    end
+
+    ##
+    # fetches the login page
+
+    def fetch_login_page
+      begin
+        page = @agent.get(login_page)
+      rescue StandardError => err
+        raise LoginError.new(err)
+      end
+    end
+
+    ##
+    # Checks if the agent is already logged by stored cookie
+
+    def logged_in?(page)
+      mm = page.search("//a[@class='mainmenu']")
+      return false unless mm
+      mm.each do |m|
+        return true if (m.innerText =~ /Log out \[ #{username} \]/ rescue false)
+      end
+      false
+    end
+
+  end
+end

data/lib/www/impostor/wwf79.rb

@@ -0,0 +1,254 @@
+require 'rubygems'
+require 'hpricot'
+gem 'mechanize', '>= 0.7.0'
+require 'mechanize'
+require 'cgi'
+
+##
+# Web Wiz Forums version 7.9 of the Impostor
+#
+
+class WWW::Impostor
+  
+  class Wwf79 < WWW::Impostor
+
+    ##
+    # After initializing the parent a mechanize agent is created
+    #
+    # Additional configuration parameters:
+    #
+    # :forum_posts_page
+    # :post_message_page
+    #
+    # Typical configuration parameters
+    # { :type => :wwf79,
+    # :app_root => 'http://example.com/forum/',
+    # :login_page => 'login_user.asp',
+    # :forum_posts_page => 'forum_posts.asp',
+    # :post_message_page => 'post_message_form.asp'
+    # :user_agent => 'Windows IE 7',
+    # :username => 'myuser',
+    # :password => 'mypasswd' }
+
+    def initialize(config={})
+      super(config)
+      @agent = WWW::Mechanize.new
+      @agent.user_agent_alias = user_agent
+      @agent.cookie_jar.load(cookie_jar) if cookie_jar && File.exist?(cookie_jar)
+      @message = nil
+      @loggedin = false
+    end
+
+    ##
+    # clean up the state of the library and log out
+
+    def logout
+      return false unless @loggedin
+
+      @agent.cookie_jar.save_as(cookie_jar) if cookie_jar
+      save_topics
+
+      @forum = nil
+      @topic = nil
+      @message = nil
+
+      @loggedin = false
+      true
+    end
+
+    ##
+    # create a new topic
+
+    def new_topic(forum=@forum, subject=@subject, message=@message)
+      raise PostError.new("forum not set") unless forum
+      raise PostError.new("topic name not given") unless subject
+      raise PostError.new("message not set") unless message
+
+      login
+      raise PostError.new("not logged in") unless @loggedin
+
+      uri = post_message_page
+      uri.query = "FID=#{forum}"
+
+      # get the submit form
+      begin
+        page = @agent.get(uri)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+      form = page.form('frmAddMessage') rescue nil
+      button = form.buttons.with.name('Submit').first rescue nil
+      raise PostError.new("post form not found") unless button && form
+
+      # set up the form and submit it
+      form.subject = subject
+      form.message = message
+      begin
+        page = @agent.submit(form, button)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+
+      error = page.body =~ /Message Not Posted/
+      if error
+
+        # throttled
+        throttled = "You have exceeded the number of posts permitted in the time span"
+        too_many = page.body =~ /#{throttled}/
+        raise ThrottledError.new(throttled) if too_many
+
+        # general error
+        raise PostError.new("There was an error creating the topic")
+      end
+
+      # look up the new topic id
+      form = page.form('frmAddMessage') rescue nil
+      topic = form['TID'].to_i rescue 0
+      raise PostError.new('unexpected new topic ID') if topic < 1
+
+      # save new topic id and topic name
+      add_subject(forum, topic, subject)
+      @forum=forum; @topic=topic; @subject=subject; @message=message
+      return true
+    end
+
+    ##
+    # Attempt to post to the forum
+
+    def post(forum = @forum, topic = @topic, message = @message)
+      raise PostError.new("forum not set") unless forum
+      raise PostError.new("topic not set") unless topic
+      raise PostError.new("message not set") unless message
+
+      login
+      raise PostError.new("not logged in") unless @loggedin
+
+      uri = forum_posts_page
+      uri.query = "TID=#{topic}&TPN=10000"
+
+      # get the submit form
+      begin
+        page = @agent.get(uri)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+      form = page.form('frmAddMessage') rescue nil
+      button = form.buttons.with.name('Submit').first rescue nil
+      raise PostError.new("post form not found") unless button && form
+
+      # set up the form and submit it
+      form.message = message
+      begin
+        page = @agent.submit(form, button)
+      rescue StandardError => err
+        raise PostError.new(err)
+      end
+
+      error = page.body =~ /Message Not Posted/
+      if error
+
+        # throttled
+        throttled = "You have exceeded the number of posts permitted in the time span"
+        too_many = page.body =~ /#{throttled}/
+        raise ThrottledError.new(throttled) if too_many
+
+        # general error
+        raise PostError.new("There was an error making the post")
+      end
+
+      @forum=forum; @topic=topic; @subject=get_subject(forum,topic); @message=message
+      return true
+    end
+
+    ##
+    # Get the new posts page for the application (specific to WWF7.9)
+  
+    def forum_posts_page
+      URI.join(app_root, config[:forum_posts_page])
+    end
+
+    ##
+    # Get the new topic page for the application (specific to WWF7.9)
+  
+    def post_message_page
+      URI.join(app_root, config[:post_message_page])
+    end
+  
+    ##
+    # does the work of logging into WWF 7.9
+
+    def login
+      return true if @loggedin
+
+      # get the login page
+      page = fetch_login_page
+
+      # return if we are already logged in from a cookie state
+      return true if logged_in?(page)
+
+      # setup the form and submit
+      form, button = login_form_and_button(page)
+      page = post_login(form, button)
+
+      # set up the rest of the state if we are logged in
+      @loggedin = logged_in?(page)
+      load_topics if @loggedin
+
+      @loggedin
+    end
+
+    def version
+      @version ||= self.class.to_s
+    end
+
+    protected
+
+    ##
+    # does the work of posting the login form
+
+    def post_login(form, button)
+      begin
+        page = @agent.submit(form, button)
+      rescue StandardError => err
+        raise LoginError.new(err)
+      end
+    end
+
+    ##
+    # returns the login form and its button from the login page
+
+    def login_form_and_button(page)
+      form = page.forms.with.name('frmLogin').first rescue nil
+      raise LoginError.new("unknown login page format") unless form
+
+      button = WWW::Mechanize::Form::Button.new('Submit', 'Forum Login')
+      form.add_button_to_query(button)
+      form['name'] = username
+      form['password'] = password
+      return form, button
+    end
+
+    ##
+    # fetches the login page
+
+    def fetch_login_page
+      begin
+        page = @agent.get(login_page)
+      rescue StandardError => err
+        raise LoginError.new(err)
+      end
+    end
+
+    ##
+    # Checks if the agent is already logged by stored cookie
+
+    def logged_in?(page)
+      mm = page.search("//a[@class='nav']")
+      return false unless mm
+      mm.each do |m|
+        return true if (m.innerText =~ /Logout \[#{username}\]/ rescue false)
+      end
+      false
+    end
+  end
+end