impostor 0.2.1 → 1.0.0

data/lib/impostor/wwf79.rb

@@ -0,0 +1,186 @@
+##
+# Web Wiz Forums version 7.9 of the Impostor
+#
+
+class Impostor
+
+  module Wwf79
+
+    ##
+    # Additional configuration parameters for a Wwf79 compatible agent:
+    #
+    # :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' }
+
+    module Auth
+
+      def login # :nodoc:
+        Impostor.not_tested("Impostor::Wwf79::Auth", "login")
+        super
+      end
+
+      ##
+      # Checks if the agent is already logged by stored cookie
+
+      def logged_in?(page)
+        mm = page.search("//a[@class='nav']")
+        !! mm.detect { |m| m.text =~ /Logout \[#{self.config.username}\]/ }
+      end
+
+      ##
+      # returns the login form from the login page
+
+      def get_login_form(page)
+        form = page.form('frmLogin')
+        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)
+        button = Mechanize::Form::Button.new('Submit', 'Forum Login')
+        form.add_button_to_query(button)
+        form['name'] = self.config.username
+        form['password'] = self.config.password
+        form
+      end
+
+    end
+
+    module Post
+
+      def post(forum, topic, message) # :nodoc:
+        Impostor.not_tested("Impostor::Wwf79::Post", "post")
+        super
+      end
+
+      ##
+      # 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(:forum_posts_page))
+        uri.query = "TID=#{topic}&TPN=10000"
+        uri
+      end
+
+      ##
+      # return the form used for posting a message from the reply page
+
+      def get_post_form(page)
+        form = page.form('frmAddMessage')
+        raise Impostor::PostError.new("unknown reply page format") unless form
+        form
+      end
+
+      ##
+      # get post id from the result of posting the message form
+      # FIXME this validation is copied into topic module as well
+
+      def get_post_from_result(page)
+        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 Impostor::ThrottledError.new(throttled) if too_many
+
+          # general error
+          raise Impostor::PostError.new("There was an error making the post")
+        end
+
+        kv = page.links.collect{ |l| l.uri }.compact.
+                        collect{ |l| l.query }.compact.
+                        collect{ |q| q.split('&')}.flatten.
+                        detect{|kv| kv =~ /^PID=/ }
+        postid = URI.unescape(kv).split('#').first.split('=').last.to_i
+        raise Impostor::PostError.new("Message did not post.") if postid.zero?
+        postid
+      end
+
+    end
+
+    module Topic
+
+      def new_topic(forum, subject, message) # :nodoc:
+        Impostor.not_tested("Impostor::Wwf79::Topic", "new_topic")
+        super
+      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)
+        uri = URI.join(self.config.app_root, self.config.config(:post_message_page))
+        uri.query = "FID=#{forum}"
+        uri
+      end
+
+      ##
+      # Get the the new topic form on the page
+
+      def get_new_topic_form(page)
+        form = page.form('frmAddMessage')
+        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
+      end
+
+      ##
+      # validate the result of posting the message form
+      # FIXME this validation is copied into post module as well
+
+      def validate_new_topic_result(page)
+        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 Impostor::ThrottledError.new(throttled) if too_many
+
+          # general error
+          raise Impostor::TopicError.new("There was an error making the post")
+        end
+
+        page
+      end
+
+      ##
+      # Get the new topic identifier from the result page
+
+      def get_topic_from_result(page)
+        begin
+          tid = page.form('frmAddMessage')['TID'].to_i
+          raise StandardError.new("new topic id not found") if tid.zero?
+          tid
+        rescue StandardError => err
+          raise Impostor::TopicError.new(err)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/impostor/wwf80.rb

@@ -0,0 +1,190 @@
+##
+# Web Wiz Forums version 8.0 of the Impostor
+#
+
+class Impostor
+
+  module Wwf80
+
+    ##
+    # Additional configuration parameters for a Wwf80 compatible agent:
+    #
+    # :new_reply_page
+    # :new_topic_page
+    #
+    # Typical configuration parameters
+    # { :type => :wwf80,
+    #   :app_root => 'http://example.com/forum/',
+    #   :login_page => 'login_user.asp',
+    #   :new_reply_page => 'new_reply_form.asp',
+    #   :new_topic_page => 'new_topic_form.asp',
+    #   :user_agent => 'Windows IE 7',
+    #   :username => 'myuser',
+    #   :password => 'mypasswd' }
+
+    module Auth
+
+      def login # :nodoc:
+        Impostor.not_tested("Impostor::Wwf80::Auth", "login")
+        super
+      end
+
+      ##
+      # returns the login form from the login page
+
+      def get_login_form(page)
+        form = page.form('frmLogin')
+        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['name'] = self.config.username
+        form['password'] = self.config.password
+        form
+      end
+
+      ##
+      # given the state of the page, are we logged in to the forum?
+
+      def logged_in?(page)
+        mm = page.search("//a[@class='nav']")
+        !! mm.detect { |m| m.text =~ /Logout \[#{self.config.username}\]/ }
+      end
+
+    end
+
+    module Post
+
+      def post(forum, topic, message) # :nodoc:
+        Impostor.not_tested("Impostor::Wwf80::Post", "post")
+        super
+      end
+
+      ##
+      # 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(:new_reply_page))
+        uri.query = "TID=#{topic}"
+        uri
+      end
+
+      ##
+      # return the form used for posting a message from the reply page
+
+      def get_post_form(page)
+        form = page.form('frmMessageForm')
+        raise Impostor::PostError.new("unknown reply page format") unless form
+        form
+      end
+
+      ##
+      # get post id from the result of posting the message form
+      # FIXME this validation is copied into topic module as well
+
+      def get_post_from_result(page)
+        error = page.search("//table[@class='errorTable']")
+        if error
+          msgs = error.search("//td")
+
+          # throttled
+          too_many = msgs.last && msgs.last.text && msgs.last.text =~ /You have exceeded the number of posts permitted in the time span/
+          raise ThrottledError.new(msgs.last.text.gsub(/\s+/m,' ').strip) if too_many
+
+          # general error
+          had_error = error.last && error.last.text && error.last.text =~ /Error: Message Not Posted/
+          raise Impostor::PostError.new(error.last.text.gsub(/\s+/m,' ').strip) if had_error
+        end
+
+        kv = page.links.collect{ |l| l.uri }.compact.
+                        collect{ |l| l.query }.compact.
+                        collect{ |q| q.split('&')}.flatten.
+                        detect{|kv| kv =~ /^PID=/ }
+        postid = URI.unescape(kv).split('#').first.split('=').last.to_i
+        raise Impostor::PostError.new("Message did not post.") if postid.zero?
+        postid
+      end
+
+    end
+
+    module Topic
+
+      def new_topic(forum, subject, message) # :nodoc:
+        Impostor.not_tested("Impostor::Wwf80::Topic", "new_topic")
+        super
+      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)
+        uri = URI.join(self.config.app_root, self.config.config(:new_topic_page))
+        uri.query = "FID=#{forum}"
+        uri
+      end
+
+      ##
+      # Get the the new topic form on the page
+
+      def get_new_topic_form(page)
+        form = page.form('frmMessageForm')
+        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
+      end
+
+      ##
+      # Validate the result of posting the new topic
+      # FIXME this validation is copied into post module as well
+
+      def validate_new_topic_result(page)
+         error = page.search("//table[@class='errorTable']")
+         if error
+           msgs = error.search("//td")
+
+           # throttled
+           too_many = (msgs.last.text =~
+           /You have exceeded the number of posts permitted in the time span/ rescue
+           false)
+           raise ThrottledError.new(msgs.last.text.gsub(/\s+/m,' ').strip) if too_many
+
+           # general error
+           had_error = (error.last.text =~
+           /Error: Message Not Posted/ rescue
+           false)
+           raise TopicError.new(error.last.text.gsub(/\s+/m,' ').strip) if had_error
+         end
+
+         page
+      end
+
+      ##
+      # Get the new topic identifier from the result page
+
+      def get_topic_from_result(page)
+        begin
+          tid = page.form('frmMessageForm')['TID'].to_i
+          raise StandardError.new("new topic id not found") if tid.zero?
+          tid
+        rescue StandardError => err
+          raise Impostor::TopicError.new(err)
+        end
+      end
+
+    end
+
+  end
+end

data/lib/impostor.rb

@@ -1,6 +1,109 @@
-# Copyright (c) 2008 by Mike Mondragon (mikemondragon@gmail.com)
-#
-# Please see the LICENSE file for licensing.
-#
+%W{ mechanize nokogiri cgi }.each do |g|
+  begin
+    require g
+  rescue LoadError
+    require 'rubygems'
+    require g
+  end
+end
+require 'logger'
 
-require 'www/impostor'
+Dir.glob(File.join(File.dirname(__FILE__), 'impostor/**/*.rb')).each {|f| require f }
+
+class Impostor
+
+  ##
+  # imPOSTor posts messages to non-RESTful forums and blogs
+  #
+  # == Example
+  #  require 'rubygems'
+  #  require 'impostor'
+  #
+  #  # 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
+  #  post = Impostor.new(YAML.load_file('config.yml'))
+  #  message = %q!hello world is to application
+  #  programmers as tea pots are to graphics programmers!
+  #  # your application store 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)
+  #
+  #  keys and values that can be set in the impostor configuration
+  #
+  #  :type              - kind of imPOSTor, :phpbb2, :wwf79, :wwf80, etc.
+  #  :username          - forum username
+  #  :password          - forum password
+  #  :topics_cache      - cache of forum topics
+  #  :user_agent        - Mechanize browser user-agent
+  #  :cookie_jar        - saved cookies from Mechanize browser
+  #  :app_root          - url to forum
+  #  :login_page        - forum login page
+  #  :logger            - A logger object or path ot a logger file.
+  #  :sleep_before_post - Number of seconds delay before posting to forum
+  #
+  #  See documentation for each type of imPOSTor for additional configuration
+  #  parameters that are needed for the specific kind of imPOSTor.  A sample
+  #  configuration is provided in the documentation for each.
+
+
+  ##
+  # Gem version of Impostor
+
+  VERSION = '1.0.0'
+
+  ##
+  # Pass in a config hash to initialize
+
+  def initialize(config={})
+    @config = Config.new(config)
+    @auth   = Auth.new(@config)
+    @post   = Post.new(@config, @auth)
+    @topic  = Topic.new(@config, @auth)
+
+    type = @config.type
+    raise ConfigError.new("Missing 'type' key in configuration") unless type
+
+    extend eval("Impostor::#{type.to_s.capitalize}")
+  end
+
+  ##
+  # our version
+
+  def version
+    VERSION
+  end
+
+  ##
+  # Post the message
+
+  def post(forum, topic, message)
+    @post.post(forum, topic, message)
+  end
+
+  ##
+  # Make a new topic
+
+  def new_topic(forum, subject, message)
+    @topic.new_topic(forum, subject, message)
+  end
+
+  ##
+  # Login
+
+  def login
+    @auth.login
+  end
+
+  def self.not_tested(who, what)
+    warn <<WARNMSG
+!!!!! IMPLEMENTATION WARNING !!!!!
+#{who}##{what} did not have real integration test data to work against in the
+refactoring of Impostor from version 0.2.1 to 1.0.0.  Please contact the author
+to help supply live data allowing real integration tests for this method.
+WARNMSG
+  end
+
+end

data/spec/auth_spec.rb

@@ -0,0 +1,148 @@
+require File.join(File.dirname(__FILE__), 'spec_helper')
+
+describe "impostor's authorization routines" do
+
+  describe "the no-op test impostor auth without implemented template methods" do
+
+    it "should logout only if not logged in" do
+      auth = self.auth
+      auth.should_receive(:authenticated?).once.and_return(false)
+      auth.logout.should_not be_true
+    end
+
+    it "should logout" do
+      config = self.config
+      auth = self.auth(config)
+      config.should_receive(:save_topics).once
+      config.should_receive(:save_cookie_jar).once
+      auth.instance_variable_set("@authenticated", true)
+
+      auth.logout.should be_true
+      auth.authenticated?.should_not be_true
+    end
+
+    it "should login at the server only if not logged in" do
+      auth = self.auth
+      auth.should_receive(:authenticated?).once.and_return(true)
+      auth.login.should be_true
+    end
+
+    it "should raise login failure when login fails" do
+      auth = self.auth
+      auth.should_receive(:login).once.and_return(false)
+      lambda { auth.login_with_raises }.should raise_error(
+        Impostor::LoginError,
+        "Impostor error: not logged in (StandardError)"
+      )
+    end
+
+    it "should not raise login failure when login fails" do
+      auth = self.auth
+      auth.should_receive(:login).once.and_return(true)
+      lambda { auth.login_with_raises }.should_not raise_error
+    end
+
+    it "should not login when template methods are not implemented" do
+      config = self.config
+      auth = self.auth(config)
+      login_uri = URI.parse("http://example.com/login")
+      config.agent.should_receive(:get).with(login_uri)
+
+      lambda { auth.login }.should raise_error(
+        Impostor::MissingTemplateMethodError,
+        "Impostor error: logged_in? must be implemented (StandardError)"
+      )
+    end
+
+    it "should raise not implemented error when logged_in? called" do
+      auth = self.auth
+      lambda { auth.logged_in?(nil) }.should raise_error(
+        Impostor::MissingTemplateMethodError,
+        "Impostor error: logged_in? must be implemented (StandardError)"
+      )
+    end
+
+    it "should return a page from fetch_login_page" do
+      config = self.config
+      auth = self.auth(config)
+      login_uri = URI.parse("http://example.com/login")
+      config.agent.should_receive(:get).with(login_uri)
+
+      lambda {
+        auth.fetch_login_page
+      }.should_not raise_error
+    end
+
+    it "should handle an error in fetch_login_page" do
+      config = self.config
+      auth = self.auth(config)
+      login_uri = URI.parse("http://example.com/login")
+      config.agent.should_receive(:get).with(login_uri).and_raise(StandardError)
+
+      lambda {
+        auth.fetch_login_page
+      }.should raise_error( Impostor::LoginError )
+    end
+
+    it "should raise not implemented error when get_login_form called" do
+      auth = self.auth
+      lambda { auth.get_login_form(nil) }.should raise_error(
+        Impostor::MissingTemplateMethodError,
+        "Impostor error: get_login_form must be implemented (StandardError)"
+      )
+    end
+
+    it "should raise not implemented error when set_username_and_password called" do
+      auth = self.auth
+      lambda { auth.set_username_and_password(nil) }.should raise_error(
+        Impostor::MissingTemplateMethodError,
+        "Impostor error: set_username_and_password must be implemented (StandardError)"
+      )
+    end
+
+    it "should raise not implemented error when post_login called" do
+      auth = self.auth
+      form = mock "form"
+      page = mock "page"
+      form.should_receive(:submit).and_return(page)
+      lambda { auth.post_login(form).should == page }.should_not raise_error
+    end
+
+    it "should login via composed template methods" do
+
+      auth = self.auth
+
+      login_page = mock "page"
+      logged_in_page = mock "page"
+      form = mock "form"
+
+      auth.should_receive(:authenticated?).once.and_return(false)
+      auth.should_receive(:fetch_login_page).once.and_return(login_page)
+      auth.should_receive(:logged_in?).with(login_page).once.and_return(false)
+      auth.should_receive(:get_login_form).with(login_page).once.and_return(form)
+      auth.should_receive(:set_username_and_password).with(form).once
+
+      auth.should_receive(:post_login).with(form).once.and_return(logged_in_page)
+      auth.should_receive(:logged_in?).with(logged_in_page).once.and_return(true)
+
+      lambda {
+        auth.login.should be_true
+      }.should_not raise_error
+
+    end
+
+    it "should not login via composed template methods if already logged in" do
+      auth = self.auth
+      auth.should_receive(:authenticated?).once.and_return(true)
+
+      auth.should_not_receive(:fetch_login_page)
+      auth.should_not_receive(:logged_in?)
+      auth.should_not_receive(:login_form)
+
+      lambda {
+         auth.login.should be_true
+      }.should_not raise_error
+    end
+  end
+
+end

data/spec/base_spec_helper.rb

@@ -0,0 +1,12 @@
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require "impostor"
+
+require 'rspec'
+require 'impostor_spec_helper'
+require 'test_impostor'
+
+RSpec.configure do |config|
+  config.mock_with :rspec
+  config.include ImpostorSpecHelper
+end

data/{test/test_helper.rb → spec/caged_net_http.rb}

@@ -1,8 +1,3 @@
-$:.unshift File.join(File.dirname(__FILE__), "..", "lib")
-
-require 'net/http'
-require 'net/https'
-
 # monkey patch Net::HTTP so un caged requests don't go over the wire
 module Net #:nodoc:
   class HTTP #:nodoc:
@@ -17,22 +12,18 @@ module Net #:nodoc:
              :port => self.port, :path => query[0]}
       opts[:query] = query[1] if query[1]
       uri = uri_cls.build(opts)
-      raise ArgumentError.new("#{req.method} method to #{uri} not being handled in testing")
+      if uri.to_s =~ /^http:\/\/localhost\//
+        old_net_http_request(req, body, &block)
+      else
+        raise ArgumentError.new("#{req.method} method to #{uri} not being handled in testing")
+      end
     end
 
     def connect
+      if address.to_s == "localhost"
+        old_net_http_connect
+      end
     end
 
   end
 end
-
-module TestHelper
-
-  ##
-  # helps load pages
-
-  def load_page(file)
-    IO.readlines("#{File.dirname(__FILE__)}/fixtures/#{file}")
-  end
-
-end