impostor 0.2.1 → 1.0.0

data/.gitignore

@@ -1,3 +1,4 @@
 .DS_Store
 coverage/
 pkg/
+coverage.info

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.rvmrc

@@ -0,0 +1 @@
+rvm gemset use impostor

data/Gemfile

@@ -0,0 +1,17 @@
+# -*- ruby -*-
+
+source :gemcutter
+
+gem "hoe", ">=2.8.0"
+gem "mechanize", ">=1.0.0"
+gem "nokogiri", ">=1.4.4"
+
+group :development, :test do
+  gem "mongrel", ">=1.1.5"
+  gem "rspec", ">= 2.3.0"
+  gem "redgreen", ">=1.2.2"
+  gem "vcr", ">=1.5.1"
+  gem "webmock", ">=1.6.2"
+end
+
+# vim: syntax=ruby

data/Gemfile.lock

@@ -0,0 +1,47 @@
+GEM
+  remote: http://rubygems.org/
+  specs:
+    addressable (2.2.4)
+    cgi_multipart_eof_fix (2.5.0)
+    crack (0.1.8)
+    daemons (1.1.0)
+    diff-lcs (1.1.2)
+    fastthread (1.0.7)
+    gem_plugin (0.2.3)
+    hoe (2.9.0)
+      rake (>= 0.8.7)
+    mechanize (1.0.0)
+      nokogiri (>= 1.2.1)
+    mongrel (1.1.5)
+      cgi_multipart_eof_fix (>= 2.4)
+      daemons (>= 1.0.3)
+      fastthread (>= 1.0.1)
+      gem_plugin (>= 0.2.3)
+    nokogiri (1.4.4)
+    rake (0.8.7)
+    redgreen (1.2.2)
+    rspec (2.4.0)
+      rspec-core (~> 2.4.0)
+      rspec-expectations (~> 2.4.0)
+      rspec-mocks (~> 2.4.0)
+    rspec-core (2.4.0)
+    rspec-expectations (2.4.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.4.0)
+    vcr (1.5.1)
+    webmock (1.6.2)
+      addressable (>= 2.2.2)
+      crack (>= 0.1.7)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  hoe (>= 2.8.0)
+  mechanize (>= 1.0.0)
+  mongrel (>= 1.1.5)
+  nokogiri (>= 1.4.4)
+  redgreen (>= 1.2.2)
+  rspec (>= 2.3.0)
+  vcr (>= 1.5.1)
+  webmock (>= 1.6.2)

data/History.txt

@@ -1,3 +1,11 @@
+### 1.0.0 / 2011-02-XX (move over bacon there's something leaner)
+
+* 2 major enhancements
+  * refactored to a modularized architecture with base classes Config, Auth,
+    Post, and Topic using mixins to specify behavior specific to each forum by
+    implementing defined template methods from the base classes
+  * rspec and vcr used for specifying unit and integration behavior
+
 ### 0.2.1 / 2008-09-24 (to screen scrape is to love the internets)
 
 * 1 minor enhancement:

data/Manifest.txt

@@ -1,4 +1,8 @@
 .gitignore
+.rspec
+.rvmrc
+Gemfile
+Gemfile.lock
 History.txt
 Manifest.txt
 README.txt
@@ -6,58 +10,86 @@ Rakefile
 dev_tools/github.rb
 impostor.gemspec
 lib/impostor.rb
-lib/www/impostor.rb
-lib/www/impostor/phpbb2.rb
-lib/www/impostor/phpbb3.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/phpbb3-get-new-topic-form-good-response.html
-test/fixtures/phpbb3-get-reply-form-good-response.html
-test/fixtures/phpbb3-logged-in.html
-test/fixtures/phpbb3-login.html
-test/fixtures/phpbb3-not-logged-in.html
-test/fixtures/phpbb3-post-new_topic-good-response.html
-test/fixtures/phpbb3-post-reply-good-response.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_github.rb
-test/test_helper.rb
-test/test_www_impostor.rb
-test/test_www_impostor_phpbb2.rb
-test/test_www_impostor_phpbb3.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
+lib/impostor/auth.rb
+lib/impostor/config.rb
+lib/impostor/errors.rb
+lib/impostor/phpbb2.rb
+lib/impostor/phpbb3.rb
+lib/impostor/post.rb
+lib/impostor/topic.rb
+lib/impostor/wwf79.rb
+lib/impostor/wwf80.rb
+spec/auth_spec.rb
+spec/base_spec_helper.rb
+spec/caged_net_http.rb
+spec/config_spec.rb
+spec/fixtures/junk.html
+spec/fixtures/phpbb2-get-new_topic-form-good-response.html
+spec/fixtures/phpbb2-get-viewtopic-for-new-topic-good-response.html
+spec/fixtures/phpbb2-get-viewtopic-for-new-topic-malformed-response.html
+spec/fixtures/phpbb2-index.html
+spec/fixtures/phpbb2-logged-in.html
+spec/fixtures/phpbb2-login.html
+spec/fixtures/phpbb2-not-logged-in.html
+spec/fixtures/phpbb2-post-new_topic-good-response.html
+spec/fixtures/phpbb2-post-reply-good-response.html
+spec/fixtures/phpbb2-post-reply-throttled-response.html
+spec/fixtures/phpbb2-too-many-posts.html
+spec/fixtures/phpbb3-get-new-topic-form-good-response.html
+spec/fixtures/phpbb3-get-reply-form-good-response.html
+spec/fixtures/phpbb3-logged-in.html
+spec/fixtures/phpbb3-login.html
+spec/fixtures/phpbb3-not-logged-in.html
+spec/fixtures/phpbb3-post-new_topic-good-response.html
+spec/fixtures/phpbb3-post-reply-good-response.html
+spec/fixtures/vcr_cassettes/phpbb2-should-be-overlimit-creating-topic.yml
+spec/fixtures/vcr_cassettes/phpbb2-should-create-topic.yml
+spec/fixtures/vcr_cassettes/phpbb2-should-login.yml
+spec/fixtures/vcr_cassettes/phpbb2-should-not-create-new-topic.yml
+spec/fixtures/vcr_cassettes/phpbb2-should-not-login.yml
+spec/fixtures/vcr_cassettes/phpbb2-should-not-post.yml
+spec/fixtures/vcr_cassettes/phpbb2-should-overlimit-error-post.yml
+spec/fixtures/vcr_cassettes/phpbb2-should-post.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-be-overlimit-creating-topic.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-create-topic.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-login.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-not-create-new-topic.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-not-login.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-not-post.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-overlimit-error-post.yml
+spec/fixtures/vcr_cassettes/phpbb3-should-post.yml
+spec/fixtures/wwf79-forum_posts.html
+spec/fixtures/wwf79-general-new-topic-error.html
+spec/fixtures/wwf79-general-posting-error.html
+spec/fixtures/wwf79-good-post-forum_posts.html
+spec/fixtures/wwf79-index.html
+spec/fixtures/wwf79-logged-in.html
+spec/fixtures/wwf79-login.html
+spec/fixtures/wwf79-new-topic-forum_posts-response.html
+spec/fixtures/wwf79-new-topic-post_message_form.html
+spec/fixtures/wwf79-not-logged-in.html
+spec/fixtures/wwf79-too-many-posts.html
+spec/fixtures/wwf79-too-many-topics.html
+spec/fixtures/wwf80-general-posting-error.html
+spec/fixtures/wwf80-get-new_topic-form-good-response.html
+spec/fixtures/wwf80-get-viewtopic-for-new-topic-good-response.html
+spec/fixtures/wwf80-index.html
+spec/fixtures/wwf80-logged-in.html
+spec/fixtures/wwf80-login.html
+spec/fixtures/wwf80-new_reply_form.html
+spec/fixtures/wwf80-not-logged-in.html
+spec/fixtures/wwf80-post-new_topic-good-response.html
+spec/fixtures/wwf80-post-reply-good-response.html
+spec/fixtures/wwf80-too-many-posts.html
+spec/impostor_spec_helper.rb
+spec/integration/phpbb2_spec.rb
+spec/integration/phpbb3_spec.rb
+spec/integration_spec_helper.rb
+spec/phpbb2_spec.rb
+spec/phpbb3_spec.rb
+spec/post_spec.rb
+spec/spec_helper.rb
+spec/test_impostor.rb
+spec/topic_spec.rb
+spec/wwf79_spec.rb
+spec/wwf80_spec.rb

data/README.txt

@@ -1,9 +1,10 @@
 impostor
     by Mike Mondragon
+    https://github.com/monde/impostor
     http://impostor.rubyforge.org/
 
 == DESCRIPTION:
-  
+
 imPOSTor posts messages to forums
 
 == FEATURES/PROBLEMS:
@@ -12,45 +13,44 @@ Makes automated 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)
+* PHP Bullitin Board (phpBB) 2.2
 * PHP Bullitin Board (phpBB) 3.0
 
 == SYNOPSIS:
 
 # config yaml has options specific to wwf79, phpbb2, etc.
-# Read the impostor docs for configuration options for the kind of forum to 
+# Read the impostor docs for configuration options for the kind of forum to
 # be accessed.
 # config can be keyed by symbols or strings
 config = YAML::load_file('conf/impostor.yml')
-post = WWW::Impostor.new(config)
+impostor = 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)
+impostor.post(forum=5,topic=10,message)
 # make a new topic
 subject = "about programmers..."
-post.new_topic(forum=7,subject,message)
-post.logout
+impostor.new_topic(forum=7,subject,message)
 
 == REQUIREMENTS:
 
+* hoe
 * mechanize
-* hpricot
+* nokogiri
 
 == SOURCE
 
 git clone git://github.com/monde/impostor.git
-svn co svn://rubyforge.org/var/svn/impostor/trunk impostor
 
 == INSTALL:
 
-* sudo gem install impostor
+* gem install impostor
 
 == LICENSE:
 
 (The MIT License)
 
-Copyright (c) 2008 Mike Mondragon
+Copyright (c) 2008-2011 Mike Mondragon
 
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the

data/Rakefile

@@ -1,40 +1,36 @@
 # -*- ruby -*-
 
-require 'rubygems'
-require 'hoe'
 begin
-  require 'rcov/rcovtask'
+  require 'hoe'
 rescue LoadError
+  require 'rubygems'
+  require 'hoe'
 end
-require 'mechanize'
+require 'rspec/core/rake_task'
+
 $LOAD_PATH.unshift 'lib'
 require 'impostor'
 
-Hoe.new('impostor', WWW::Impostor::VERSION) do |p|
+Hoe.plugin :bundler, :git
+Hoe.spec('impostor') do |p|
+  p.version = Impostor::VERSION
   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', 2..5).join("\n\n")
-  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/)[1..-1]
+  p.url = p.paragraphs_of('README.txt', 0).first.split(/\n/).map{ |line| line.strip }[2]
+  p.readme_file = "README.txt"
+  p.history_file = "History.txt"
   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.extra_deps << ['nokogiri', '>= 1.4.4']
+  p.extra_deps << ['mechanize', '>= 1.0.0']
   p.clean_globs << 'coverage'
+  p.testlib = :rspec
 end
 
-begin
-  Rcov::RcovTask.new do |t|
-    t.test_files = FileList['test/test_www_impostor*.rb']
-    t.verbose = true
-  end
-rescue NameError
-end
+RSpec::Core::RakeTask.new(:spec)
 
-Rake::TestTask.new do |t|
-  t.libs << "test"
-  t.test_files = FileList['test/test_www_impostor*.rb']
-  t.verbose = true
-end
+task :default => :spec
 
 # vim: syntax=Ruby

data/lib/impostor/auth.rb

@@ -0,0 +1,103 @@
+class Impostor::Auth
+
+  attr_reader :config
+  attr_reader :authenticated
+  alias :authenticated? :authenticated
+
+  ##
+  # Auth is initialized with the config of the impostor
+
+  def initialize(config)
+    @config = config
+    self.extend eval("Impostor::#{config.type.to_s.capitalize}::Auth")
+  end
+
+  ##
+  # Login to the impostor's forum.  #login is comprised of the following
+  # template methods to allow implementation for specific forum applications:
+  #
+  # * fetch_login_page
+  # * logged_in?(page)
+  # * get_login_form(page)
+  # * set_username_and_password(form)
+  # * post_login(form)
+
+  def login
+    return true if self.authenticated?
+
+    page = self.fetch_login_page
+    return true if self.logged_in?(page)
+
+    form = self.get_login_form(page)
+    self.set_username_and_password(form)
+    page = self.post_login(form)
+
+    @authenticated = self.logged_in?(page)
+  end
+
+  def login_with_raises
+    return true if self.login
+
+    raise Impostor::LoginError.new("not logged in")
+  end
+
+  ##
+  # logot of the impostor's forum
+
+  def logout
+    return false unless self.authenticated?
+
+    self.config.save_topics
+    self.config.save_cookie_jar
+
+    @authenticated = false
+
+    not self.authenticated?
+  end
+
+  ##
+  # given the state of the page, are we logged in to the forum?
+
+  def logged_in?(page)
+    raise Impostor::MissingTemplateMethodError.new("logged_in? must be implemented")
+  end
+
+  ##
+  # get the page for logging in
+
+  def fetch_login_page
+    begin
+      self.config.agent.get(self.config.login_page)
+    rescue StandardError => err
+      raise Impostor::LoginError.new(err)
+    end
+  end
+
+  ##
+  # returns the login form from the login page
+
+  def get_login_form(page)
+    raise Impostor::MissingTemplateMethodError.new("get_login_form must be implemented")
+  end
+
+  ##
+  # Sets the user name and pass word on the loing form.
+
+  def set_username_and_password(form)
+    raise Impostor::MissingTemplateMethodError.new("set_username_and_password must be implemented")
+  end
+
+  ##
+  # does the work of posting the login form
+
+  def post_login(form)
+    begin
+      config.sleep_before_post
+      page = form.submit
+    rescue StandardError => err
+      raise Impostor::LoginError.new(err)
+    end
+  end
+
+
+end

data/lib/impostor/config.rb

@@ -0,0 +1,171 @@
+class Impostor::Config
+
+  attr_reader :agent
+  attr_reader :topics
+
+  def initialize(config)
+    @config = config
+    validate_keys(:type, :username, :password, :app_root, :login_page)
+    setup_agent
+    load_topics
+  end
+
+  ##
+  # Validates expected keys are in the config
+
+  def validate_keys(*keys)
+    keys.each do |key|
+      val = self.config(key)
+      raise Impostor::ConfigError.new("Missing key '#{key}' in configuration") unless val
+    end
+  end
+
+  ##
+  # Access the current config and key it without regard for symbols or strings
+
+  def config(key)
+    @config[key.to_sym] || @config[key.to_s]
+  end
+
+  ##
+  # Sets up the mechanize agent initialized with cookie jar file specified by
+  # the :cookie_jar configuration parameter if it exists
+
+  def setup_agent
+    @agent = Mechanize.new do |mechanize|
+      if logger = self.config(:logger)
+        if File.exist?(logger.to_s)
+          mechanize.log = Logger.new(logger.to_s)
+        elsif logger == "STDOUT"
+          mechanize.log = Logger.new(STDOUT)
+        else
+          mechanize.log = logger
+        end
+      end
+    end
+    @agent.user_agent_alias = self.user_agent if self.user_agent
+    # jar is a yaml file
+    @agent.cookie_jar.load(cookie_jar) if cookie_jar && File.exist?(cookie_jar)
+  end
+
+  ##
+  # Load the topics that the impostor already knows about
+
+  def load_topics
+    cache = self.topics_cache || ""
+    if File::exist?(cache)
+      @topics = YAML::load_file(cache)
+    else
+      @topics = Hash.new
+    end
+  end
+
+  ##
+  # Add subject to topics hash
+
+  def add_subject(forum, topic, name)
+    forum = forum.to_s
+    topic = topic.to_s
+    if self.topics[forum].nil?
+      self.topics[forum] = {topic, name}
+    else
+      self.topics[forum][topic] = name
+    end
+  end
+
+  ##
+  # Get the topic name (subject) based on forum and topic ids
+
+  def get_subject(forum, topic)
+    forum = forum.to_s
+    topic = topic.to_s
+    self.topics[forum] ? self.topics[forum][topic] : nil
+  end
+
+  ##
+  # Save the topics
+
+  def save_topics
+    cache = self.topics_cache || ""
+    if File::exist?(cache)
+      File.open(cache, 'w') do |out|
+        YAML.dump(self.topics, out)
+      end
+    end
+  end
+
+  ##
+  # Save the cookie jar
+
+  def save_cookie_jar
+    self.agent.cookie_jar.save_as(self.cookie_jar) if self.cookie_jar
+  end
+
+  ##
+  # Gets the application root of the application such as
+  # http://example.com/phpbb or http://example.com/forums
+
+  def app_root
+    self.config(:app_root)
+  end
+
+  ##
+  # Get the topics cache
+
+  def topics_cache
+    self.config(:topics_cache)
+  end
+
+  ##
+  # Get the login page for the application
+
+  def login_page
+    URI.join(app_root, self.config(:login_page))
+  end
+
+  ##
+  # Get the username for the application
+
+  def username
+    self.config(:username)
+  end
+
+  ##
+  # Get the password for the application
+
+  def password
+    self.config(:password)
+  end
+
+  ##
+  # A Mechanize user agent name, see the mechanize documentation
+  # 'Linux Mozilla', 'Mac Safari', 'Windows IE 7', etc.
+
+  def user_agent
+    self.config(:user_agent) || 'Mechanize'
+  end
+
+  ##
+  # is a yaml file for Mechanize::CookieJar
+
+  def cookie_jar
+    self.config(:cookie_jar)
+  end
+
+  ##
+  # The impostor type, as specified in the config
+
+  def type
+    self.config(:type)
+  end
+
+  ##
+  # Some forums require a bit of delay before posting to not have the post be
+  # considered coming from a bot.
+
+  def sleep_before_post
+    sleep self.config(:sleep_before_post).to_i
+  end
+
+end
+