impostor 0.2.1 → 1.0.0

data/lib/impostor/errors.rb

@@ -0,0 +1,67 @@
+class Impostor
+
+  ##
+  # An application error
+
+  class ImpostorError < RuntimeError
+
+    ##
+    # The original exception
+
+    attr_accessor :original_exception
+
+    ##
+    # Creates a new ImpostorError with +message+ and +original_exception+
+
+    def initialize(e = nil)
+      exception = e.nil? || e.is_a?(String) ? StandardError.new(e) : e
+      @original_exception = exception
+      message = "Impostor error: #{exception.message} (#{exception.class})"
+      super message
+    end
+
+  end
+
+  ##
+  # An error for impostor login failure
+
+  class LoginError < ImpostorError; end
+
+  ##
+  # An error for impostor post failure
+
+  class PostError < ImpostorError; end
+
+  ##
+  # An error for impostor when a topic failure
+
+  class TopicError < ImpostorError; end
+
+  ##
+  # An error for impostor when the receiving forum rejects the post due to
+  # a throttling or spam error but which the user can re-attempt at a later
+  # time.
+
+  class ThrottledError < ImpostorError; end
+
+  ##
+  # An error for misconfiguration
+
+  class ConfigError < ImpostorError; end
+
+  ##
+  # An error for template methods that need to be implemented
+
+  class MissingTemplateMethodError < ImpostorError; end
+
+  ##
+  # An exception for when a new topic has been moderated
+
+  class TopicModerated < ImpostorError; end
+
+  ##
+  # An exception for when a new post has been moderated
+
+  class PostModerated < ImpostorError; end
+
+end

data/lib/impostor/phpbb2.rb

@@ -0,0 +1,202 @@
+##
+# phpBB2 version of the Impostor
+#
+
+class Impostor
+
+  module Phpbb2
+
+    ##
+    # Additional configuration parameters for a Phpbb2 compatible agent:
+    #
+    # :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' }
+
+    module Auth
+
+      ##
+      # Checks if the agent is already logged by stored cookie
+
+      def logged_in?(page)
+        mm = page.search( "//a" ).detect{ | a| a.inner_html =~ /Log out \[ #{self.config.username} \]/ } ||
+             page.search( "//a" ).detect{ |a| a['href'] =~ /\/login\.php\?mode=logout/ }
+
+        not mm.nil?
+      end
+
+      ##
+      # returns the login form from the login page
+
+      def get_login_form(page)
+        form = page.forms.detect { |form| form.action =~ /login\.php/ }
+        raise Impostor::LoginError.new("unknown login page format") unless form
+        form
+      end
+
+      ##
+      # Sets the user name and pass word on the loing form.
+
+      def set_username_and_password(form)
+        form['username'] = self.config.username
+        form['password'] = self.config.password
+        form['autologin'] = 'on'
+        form['login'] = 'Log in'
+        form
+      end
+
+    end
+
+    module Post
+
+      ##
+      # return a uri used to fetch the reply page based on the forum, topic, and
+      # message
+
+      def get_reply_uri(forum, topic)
+        uri = URI.join(self.config.app_root, self.config.config(:posting_page))
+        uri.query = "mode=reply&t=#{topic}"
+        uri
+      end
+
+      ##
+      # return the form used for posting a message from the reply page
+
+      def get_post_form(page)
+        form = page.forms.detect { |form| form.action =~ /#{Regexp.escape(self.config.config(:posting_page))}/ }
+        raise Impostor::PostError.new("unknown reply page format#{page_message(page, ', ')}") unless form
+        form
+      end
+
+      ##
+      # set the message to reply with on the reply form
+
+      def set_message(form, message)
+        form.message = message
+        form["post"] = "Submit"
+        form
+      end
+
+      ##
+      # get post id from the result of posting the message form
+
+      def get_post_from_result(page)
+        message = page_message(page)
+        if message =~ /Your message has been entered successfully./
+          kv = page.links.collect{ |l| l.uri }.compact.
+                          collect{ |l| l.query }.compact.
+                          collect{ |q| q.split('&')}.flatten.
+                          detect{|kv| kv =~ /^p=/ }
+          postid = URI.unescape(kv).split('#').first.split('=').last.to_i
+          raise Impostor::PostError.new("Message did not post.") if postid.zero?
+          return postid
+        end
+
+        too_many = message =~ /You cannot make another post so soon after your last/
+
+        if too_many
+          raise Impostor::ThrottledError.new("too many posts in too short amount of time")
+        else
+          raise Impostor::PostError.new("message did not post")
+        end
+      end
+
+      def page_message(page, prepend = '')
+        message = page.search("//span[@class='gen']").last || ''
+        message = message.text if message.respond_to?(:text)
+        prepend = '' if message.empty?
+        "#{prepend}#{message}"
+      end
+
+    end
+
+    module Topic
+
+      ##
+      # return a uri used to fetch the new topic page based on the forum, subject,
+      # and message
+
+      def get_new_topic_uri(forum, subject, message)
+        uri = URI.join(self.config.app_root, self.config.config(:posting_page))
+        uri.query = "mode=newtopic&f=#{forum}"
+        uri
+      end
+
+      ##
+      # Get the the new topic form on the page
+
+      def get_new_topic_form(page)
+        form = page.form('post')
+        raise Impostor::TopicError.new("unknown new topic page format") unless form
+        form
+      end
+
+      ##
+      # Set the subject and message on the new topic form
+
+      def set_subject_and_message(form, subject, message)
+        form.subject = subject
+        form.message = message
+        form["post"] = "Submit"
+        form
+      end
+
+      ##
+      # Validate the result of posting the new topic
+
+      def validate_new_topic_result(page)
+        message = page_message(page)
+        if message !~ /Your message has been entered successfully./
+          if message =~ /You cannot make another post so soon after your last/
+            raise Impostor::ThrottledError.new("too many new topics in too short amount of time")
+          else
+            raise Impostor::TopicError.new("Topic did not post.")
+          end
+        end
+
+        begin
+          # <td align="center"><span class="gen">Your message has been entered successfully.<br /><br />Click <a href="viewtopic.php?p=9#9">Here</a> to view your message<br /><br />Click <a href="viewforum.php?f=1">Here</a> to return to the forum</span></td>
+
+          # TODO the link has the postid specifically for the post, not all
+          # forums make it easy to deduce the post id
+          link = page.links.detect{ |l| l.href =~ /viewtopic\.php/ }
+          link.click
+        rescue StandardError => err
+          raise Impostor::TopicError.new(err)
+        end
+      end
+
+      ##
+      # Get the new topic identifier from the result page
+
+      def get_topic_from_result(page)
+        begin
+          link = page.links.detect{ |l| l.href =~ /viewtopic\.php/ }
+          kv = link.uri.query.split('&').detect{|kv| kv =~ /^t=/ }
+          topicid = URI.unescape(kv).split('#').first.split('=').last.to_i
+        rescue StandardError => err
+          raise Impostor::TopicError.new(err)
+        end
+        raise Impostor::TopicError.new("Failed to create topic.") if topicid.zero?
+
+        topicid
+      end
+
+      def page_message(page, prepend = '')
+        message = page.search("//span[@class='gen']").last || ''
+        message = message.text if message.respond_to?(:text)
+        prepend = '' if message.empty?
+        "#{prepend}#{message}"
+      end
+
+    end
+
+  end
+end

data/lib/impostor/phpbb3.rb

@@ -0,0 +1,199 @@
+##
+# phpBB3 version of the Impostor
+#
+
+class Impostor
+
+  module Phpbb3
+
+    ##
+    # Additional configuration parameters for a Phpbb3 compatible agent:
+    #
+    # :posting_page
+    #
+    # Typical configuration parameters
+    # { :type => :phpbb3,
+    #   :app_root => 'http://example.com/forum/',
+    #   :login_page => 'ucp.php?mode=login',
+    #   :posting_page => 'posting.php',
+    #   :user_agent => 'Windows IE 7',
+    #   :username => 'myuser',
+    #   :password => 'mypasswd' }
+
+    module Auth
+
+      ##
+      # Checks if the agent is already logged by stored cookie
+
+      def logged_in?(page)
+        mm = page.search( "//a" ).detect{ | a| a.inner_html =~ /Logout \[ #{self.config.username} \]/ } ||
+             page.search( "//a" ).detect{ |a| a['href'] =~ /\.\/ucp\.php\?mode=logout/ }
+
+        not mm.nil?
+      end
+
+      ##
+      # returns the login form from the login page
+
+      def get_login_form(page)
+        form = page.forms.detect { |form| form.action =~ /\/ucp\.php\?mode=login/ }
+        raise Impostor::LoginError.new("unknown login page format") unless form
+        form
+      end
+
+      ##
+      # Sets the user name and pass word on the loing form.
+
+      def set_username_and_password(form)
+        form['username'] = self.config.username
+        form['password'] = self.config.password
+        form['login'] = 'Login'
+        form['autologin'] = 'on'
+        form
+      end
+
+    end
+
+    module Post
+
+      ##
+      # return a uri used to fetch the reply page based on the forum, topic, and
+      # message
+
+      def get_reply_uri(forum, topic)
+        uri = URI.join(self.config.app_root, self.config.config(:posting_page))
+        uri.query = "mode=reply&f=#{forum}&t=#{topic}"
+        uri
+      end
+
+      ##
+      # return the form used for posting a message from the reply page
+
+      def get_post_form(page)
+        form = page.forms.detect { |form| form.action =~ /#{Regexp.escape(self.config.config(:posting_page))}/ }
+        raise Impostor::PostError.new("unknown reply page format") unless form
+        form
+      end
+
+      ##
+      # set the message to reply with on the reply form
+
+      def set_message(form, message)
+        form.message = message
+        form["post"] = "Submit"
+        form
+      end
+
+      ##
+      # get post id from the result of posting the message form
+
+      def get_post_from_result(page)
+        error_message = page_error_message(page)
+        if error_message =~ /You cannot make another post so soon after your last/
+          raise Impostor::ThrottledError.new("too many posts in too short amount of time, #{error_message}")
+        elsif !error_message.empty?
+          raise Impostor::PostError.new(error_message)
+        end
+
+        begin
+          kv = page.links.collect{ |l| l.uri }.compact.
+                          collect{ |l| l.query }.compact.
+                          collect{ |q| q.split('&')}.flatten.
+                          detect { |p| p =~ /^p=/ }
+          raise StandardError.new("Message did not post.") if kv.nil?
+          postid = URI.unescape(kv).split('#').first.split('=').last.to_i
+          raise StandardError.new("Message did not post.") if postid.zero?
+          postid
+        rescue StandardError => err
+          raise Impostor::PostError.new(err)
+        end
+      end
+
+      ##
+      # Extract the error from a page
+
+      def page_error_message(page, prepend='')
+        message = page.search(".//p[@class='error']").last || ''
+        message = message.text if message.respond_to?(:text)
+        prepend = '' if message.empty?
+        "#{prepend}#{message}"
+      end
+
+    end
+
+    module Topic
+
+      ##
+      # return a uri used to fetch the new topic page based on the forum, subject,
+      # and message
+
+      def get_new_topic_uri(forum, subject, message)
+        uri = URI.join(self.config.app_root, self.config.config(:posting_page))
+        uri.query = "mode=post&f=#{forum}"
+        uri
+      end
+
+      ##
+      # Get the the new topic form on the page
+
+      def get_new_topic_form(page)
+        form = page.forms.detect { |form| form.action =~ /#{Regexp.escape(self.config.config(:posting_page))}/ }
+        raise Impostor::TopicError.new("unknown new topic page format") unless form
+        form
+      end
+
+      ##
+      # Set the subject and message on the new topic form
+
+      def set_subject_and_message(form, subject, message)
+        form.subject = subject
+        form.message = message
+        form["post"] = "Submit"
+        form
+      end
+
+      ##
+      # Validate the result of posting the new topic
+
+      def validate_new_topic_result(page)
+        error_message = page_error_message(page)
+        if error_message =~ /You cannot make another post so soon after your last/
+          raise Impostor::ThrottledError.new("too many posts in too short amount of time, #{error_message}")
+        elsif !error_message.empty?
+          raise Impostor::PostError.new(error_message)
+        end
+
+        page
+      end
+
+      ##
+      # Get the new topic identifier from the result page
+
+      def get_topic_from_result(page)
+        moderated = page.body =~ /it will need to be approved by a moderator/i
+        raise Impostor::TopicModerated.new("new topic has been moderated") if moderated
+
+        link = page.links.detect{ |l| l.text =~ /View your submitted message/i }
+        link ||= page.links.detect{ |l| l.href =~ /viewtopic\.php/ }
+        raise Impostor::TopicError.new("new topic did not post") unless link
+        topic = link.uri.query.split('&').detect{|a| a =~ /^t=/}
+        raise Impostor::TopicError.new("new topic did not post") unless topic
+        topic = topic.split('=').last.to_i
+        raise Impostor::TopicError.new("new topic did not post") if topic.zero?
+        topic
+      end
+
+      ##
+      # Extract the error from a page
+
+      def page_error_message(page, prepend='')
+        message = page.search(".//p[@class='error']").last || ''
+        message = message.text if message.respond_to?(:text)
+        prepend = '' if message.empty?
+        "#{prepend}#{message}"
+      end
+
+    end
+
+  end
+end

data/lib/impostor/post.rb

@@ -0,0 +1,111 @@
+class Impostor::Post
+
+  attr_reader :config
+  attr_reader :auth
+
+  ##
+  # Post is initialized with the auth of the impostor
+
+  def initialize(config, auth)
+    @config = config
+    @auth = auth
+    self.extend eval("Impostor::#{config.type.to_s.capitalize}::Post")
+  end
+
+  ##
+  # post a message to the forum and topic thread
+  # post is comprised of the following template methods to allow
+  # implementation for specific forum applications
+  #
+  # * validate_post_input(forum, topic, message)
+  # * get_reply_uri(forum, topic)
+  # * get_reply_page(uri)
+  # * get_post_form(page)
+  # * set_message(form, message)
+  # * post_message(form)
+  # * get_post_from_result(page)
+  #
+  # A hash of results is returned, having keys to the :forum, :topic, new :post
+  # id, :message, and :result
+
+  def post(forum, topic, message)
+    self.validate_post_input(forum, topic, message)
+    self.auth.login_with_raises
+    uri = self.get_reply_uri(forum, topic)
+    page = get_reply_page(uri)
+    form = get_post_form(page)
+    set_message(form, message)
+    page = post_message(form)
+    post = get_post_from_result(page)
+
+    { :forum => forum,
+      :topic => topic,
+      :post => post,
+      :message => message,
+      :result => true }
+  end
+
+  ##
+  # validate the inputs forum, topic, and message
+
+  def validate_post_input(forum, topic, message)
+    raise Impostor::PostError.new("forum not set") unless forum
+    raise Impostor::PostError.new("topic not set") unless topic
+    raise Impostor::PostError.new("message not set") unless message
+    true
+  end
+
+  ##
+  # return a uri used to fetch the reply page based on the forum, topic, and
+  # message
+
+  def get_reply_uri(forum, topic)
+    raise Impostor::MissingTemplateMethodError.new("get_reply_uri must be implemented")
+  end
+
+  ##
+  # return the reply page that is fetched with the reply uri
+
+  def get_reply_page(uri)
+    begin
+      page = self.config.agent.get(uri)
+    rescue StandardError => err
+      raise Impostor::PostError.new(err)
+    end
+  end
+
+  ##
+  # return the form used for posting a message from the reply page
+
+  def get_post_form(page)
+    raise Impostor::MissingTemplateMethodError.new("get_post_form must be implemented")
+  end
+
+  ##
+  # set the message to reply with on the reply form
+
+  def set_message(form, message)
+    form.message = message
+    form
+  end
+
+  ##
+  # post the message form
+
+  def post_message(form)
+    begin
+      config.sleep_before_post
+      form.submit
+    rescue StandardError => err
+      raise Impostor::PostError.new(err)
+    end
+  end
+
+  ##
+  # get post id from the result of posting the message form
+
+  def get_post_from_result(page)
+    raise Impostor::MissingTemplateMethodError.new("get_post_from_result must be implemented")
+  end
+
+end

data/lib/impostor/topic.rb

@@ -0,0 +1,115 @@
+class Impostor::Topic
+
+  attr_reader :config
+  attr_reader :auth
+
+  ##
+  # Topic is initialized with the auth of the impostor
+
+  def initialize(config, auth)
+    @config = config
+    @auth = auth
+    self.extend eval("Impostor::#{config.type.to_s.capitalize}::Topic")
+  end
+
+  ##
+  # create a new topic in the forum with the subject title and initial message
+  #
+  # * validate_new_topic_input(forum, subject, message)
+  # * get_new_topic_uri(forum, subject, message)
+  # * get_new_topic_page(uri)
+  # * get_new_topic_form(page)
+  # * set_subject_and_message(form, subject, message)
+  # * post_new_topic(form)
+  # * validate_new_topic_result(page)
+  # * get_topic_from_result(page)
+
+  def new_topic(forum, subject, message)
+    self.validate_topic_input(forum, subject, message)
+    self.auth.login_with_raises
+    uri = self.get_new_topic_uri(forum, subject, message)
+    page = self.get_new_topic_page(uri)
+    form = self.get_new_topic_form(page)
+    self.set_subject_and_message(form, subject, message)
+    page = self.post_new_topic(form)
+    page = self.validate_new_topic_result(page)
+    topic = self.get_topic_from_result(page)
+
+    self.config.add_subject(forum, topic, subject)
+
+    { :forum => forum,
+      :topic => topic,
+      :subject => subject,
+      :message => message,
+      :result => true }
+  end
+
+  ##
+  # validate the inputs forum, topic, and message
+
+  def validate_topic_input(forum, subject, message)
+    raise Impostor::TopicError.new("forum not set") unless forum
+    raise Impostor::TopicError.new("subject not set") unless subject
+    raise Impostor::TopicError.new("message not set") unless message
+    true
+  end
+
+  ##
+  # return a uri used to fetch the new topic page based on the forum, subject,
+  # and message
+
+  def get_new_topic_uri(forum, subject, message)
+    raise Impostor::MissingTemplateMethodError.new("get_new_topic_uri must be implemented")
+  end
+
+  ##
+  # Get the page that has the form for new topics referenced by the uri
+
+  def get_new_topic_page(uri)
+    begin
+      self.config.agent.get(uri)
+    rescue StandardError => err
+      raise Impostor::TopicError.new(err)
+    end
+  end
+
+  ##
+  # Get the the new topic form on the page
+
+  def get_new_topic_form(page)
+    raise Impostor::MissingTemplateMethodError.new("get_new_topic_form must be implemented")
+  end
+
+  ##
+  # Set the subject and message on the new topic form
+
+  def set_subject_and_message(form, subject, message)
+    raise Impostor::MissingTemplateMethodError.new("set_subject_and_message must be implemented")
+  end
+
+  ##
+  # Post the new topic that is contained on the form
+
+  def post_new_topic(form)
+    begin
+      config.sleep_before_post
+      form.submit
+    rescue StandardError => err
+      raise Impostor::TopicError.new(err)
+    end
+  end
+
+  ##
+  # Validate the result of posting the new topic
+
+  def validate_new_topic_result(page)
+    raise Impostor::MissingTemplateMethodError.new("validate_new_topic_result must be implemented")
+  end
+
+  ##
+  # Get the new topic identifier from the result page
+
+  def get_topic_from_result(page)
+    raise Impostor::MissingTemplateMethodError.new("get_topic_from_result must be implemented")
+  end
+end