twibot 0.1.0

data/tasks/setup.rb

@@ -0,0 +1,300 @@
+
+require 'rubygems'
+require 'rake'
+require 'rake/clean'
+require 'fileutils'
+require 'ostruct'
+require 'find'
+
+class OpenStruct; undef :gem; end
+
+# TODO: make my own openstruct type object that includes descriptions
+# TODO: use the descriptions to output help on the available bones options
+
+PROJ = OpenStruct.new(
+  # Project Defaults
+  :name => nil,
+  :summary => nil,
+  :description => nil,
+  :changes => nil,
+  :authors => nil,
+  :email => nil,
+  :url => "\000",
+  :version => ENV['VERSION'] || '0.0.0',
+  :exclude => %w(tmp$ bak$ ~$ CVS \.svn/ \.git/ ^pkg/),
+  :release_name => ENV['RELEASE'],
+
+  # System Defaults
+  :ruby_opts => %w(-w),
+  :libs => [],
+  :history_file => 'History.txt',
+  :readme_file => 'README.txt',
+  :ignore_file => '.bnsignore',
+
+  # Announce
+  :ann => OpenStruct.new(
+    :file => 'announcement.txt',
+    :text => nil,
+    :paragraphs => [],
+    :email => {
+      :from     => nil,
+      :to       => %w(ruby-talk@ruby-lang.org),
+      :server   => 'localhost',
+      :port     => 25,
+      :domain   => ENV['HOSTNAME'],
+      :acct     => nil,
+      :passwd   => nil,
+      :authtype => :plain
+    }
+  ),
+
+  # Gem Packaging
+  :gem => OpenStruct.new(
+    :dependencies => [],
+    :development_dependencies => [],
+    :executables => nil,
+    :extensions => FileList['ext/**/extconf.rb'],
+    :files => nil,
+    :need_tar => true,
+    :need_zip => false,
+    :extras => {}
+  ),
+
+  # File Annotations
+  :notes => OpenStruct.new(
+    :exclude => %w(^tasks/setup\.rb$),
+    :extensions => %w(.txt .rb .erb .rdoc) << '',
+    :tags => %w(FIXME OPTIMIZE TODO)
+  ),
+
+  # Rcov
+  :rcov => OpenStruct.new(
+    :dir => 'coverage',
+    :opts => %w[--sort coverage -T],
+    :threshold => 90.0,
+    :threshold_exact => false
+  ),
+
+  # Rdoc
+  :rdoc => OpenStruct.new(
+    :opts => [],
+    :include => %w(^lib/ ^bin/ ^ext/ \.txt$ \.rdoc$),
+    :exclude => %w(extconf\.rb$),
+    :main => nil,
+    :dir => 'doc',
+    :remote_dir => nil
+  ),
+
+  # Rubyforge
+  :rubyforge => OpenStruct.new(
+    :name => "\000"
+  ),
+
+  # Rspec
+  :spec => OpenStruct.new(
+    :files => FileList['spec/**/*_spec.rb'],
+    :opts => []
+  ),
+
+  # Subversion Repository
+  :svn => OpenStruct.new(
+    :root => nil,
+    :path => '',
+    :trunk => 'trunk',
+    :tags => 'tags',
+    :branches => 'branches'
+  ),
+
+  # Test::Unit
+  :test => OpenStruct.new(
+    :files => FileList['test/**/test_*.rb'],
+    :file  => 'test/all.rb',
+    :opts  => []
+  )
+)
+
+# Load the other rake files in the tasks folder
+tasks_dir = File.expand_path(File.dirname(__FILE__))
+post_load_fn = File.join(tasks_dir, 'post_load.rake')
+rakefiles = Dir.glob(File.join(tasks_dir, '*.rake')).sort
+rakefiles.unshift(rakefiles.delete(post_load_fn)).compact!
+import(*rakefiles)
+
+# Setup the project libraries
+%w(lib ext).each {|dir| PROJ.libs << dir if test ?d, dir}
+
+# Setup some constants
+WIN32 = %r/djgpp|(cyg|ms|bcc)win|mingw/ =~ RUBY_PLATFORM unless defined? WIN32
+
+DEV_NULL = WIN32 ? 'NUL:' : '/dev/null'
+
+def quiet( &block )
+  io = [STDOUT.dup, STDERR.dup]
+  STDOUT.reopen DEV_NULL
+  STDERR.reopen DEV_NULL
+  block.call
+ensure
+  STDOUT.reopen io.first
+  STDERR.reopen io.last
+  $stdout, $stderr = STDOUT, STDERR
+end
+
+DIFF = if WIN32 then 'diff.exe'
+       else
+         if quiet {system "gdiff", __FILE__, __FILE__} then 'gdiff'
+         else 'diff' end
+       end unless defined? DIFF
+
+SUDO = if WIN32 then ''
+       else
+         if quiet {system 'which sudo'} then 'sudo'
+         else '' end
+       end
+
+RCOV = WIN32 ? 'rcov.bat' : 'rcov'
+RDOC = WIN32 ? 'rdoc.bat' : 'rdoc'
+GEM  = WIN32 ? 'gem.bat'  : 'gem'
+
+%w(rcov spec/rake/spectask rubyforge bones facets/ansicode).each do |lib|
+  begin
+    require lib
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", true}
+  rescue LoadError
+    Object.instance_eval {const_set "HAVE_#{lib.tr('/','_').upcase}", false}
+  end
+end
+HAVE_SVN = (Dir.entries(Dir.pwd).include?('.svn') and
+            system("svn --version 2>&1 > #{DEV_NULL}"))
+HAVE_GIT = (Dir.entries(Dir.pwd).include?('.git') and
+            system("git --version 2>&1 > #{DEV_NULL}"))
+
+# Add bones as a development dependency
+#
+if HAVE_BONES
+  PROJ.gem.development_dependencies << ['bones', ">= #{Bones::VERSION}"]
+end
+
+# Reads a file at +path+ and spits out an array of the +paragraphs+
+# specified.
+#
+#    changes = paragraphs_of('History.txt', 0..1).join("\n\n")
+#    summary, *description = paragraphs_of('README.txt', 3, 3..8)
+#
+def paragraphs_of( path, *paragraphs )
+  title = String === paragraphs.first ? paragraphs.shift : nil
+  ary = File.read(path).delete("\r").split(/\n\n+/)
+
+  result = if title
+    tmp, matching = [], false
+    rgxp = %r/^=+\s*#{Regexp.escape(title)}/i
+    paragraphs << (0..-1) if paragraphs.empty?
+
+    ary.each do |val|
+      if val =~ rgxp
+        break if matching
+        matching = true
+        rgxp = %r/^=+/i
+      elsif matching
+        tmp << val
+      end
+    end
+    tmp
+  else ary end
+
+  result.values_at(*paragraphs)
+end
+
+# Adds the given gem _name_ to the current project's dependency list. An
+# optional gem _version_ can be given. If omitted, the newest gem version
+# will be used.
+#
+def depend_on( name, version = nil )
+  spec = Gem.source_index.find_name(name).last
+  version = spec.version.to_s if version.nil? and !spec.nil?
+
+  PROJ.gem.dependencies << case version
+    when nil; [name]
+    when %r/^\d/; [name, ">= #{version}"]
+    else [name, version] end
+end
+
+# Adds the given arguments to the include path if they are not already there
+#
+def ensure_in_path( *args )
+  args.each do |path|
+    path = File.expand_path(path)
+    $:.unshift(path) if test(?d, path) and not $:.include?(path)
+  end
+end
+
+# Find a rake task using the task name and remove any description text. This
+# will prevent the task from being displayed in the list of available tasks.
+#
+def remove_desc_for_task( names )
+  Array(names).each do |task_name|
+    task = Rake.application.tasks.find {|t| t.name == task_name}
+    next if task.nil?
+    task.instance_variable_set :@comment, nil
+  end
+end
+
+# Change working directories to _dir_, call the _block_ of code, and then
+# change back to the original working directory (the current directory when
+# this method was called).
+#
+def in_directory( dir, &block )
+  curdir = pwd
+  begin
+    cd dir
+    return block.call
+  ensure
+    cd curdir
+  end
+end
+
+# Scans the current working directory and creates a list of files that are
+# candidates to be in the manifest.
+#
+def manifest
+  files = []
+  exclude = PROJ.exclude.dup
+  comment = %r/^\s*#/
+ 
+  # process the ignore file and add the items there to the exclude list
+  if test(?f, PROJ.ignore_file)
+    ary = []
+    File.readlines(PROJ.ignore_file).each do |line|
+      next if line =~ comment
+      line.chomp!
+      line.strip!
+      next if line.nil? or line.empty?
+
+      glob = line =~ %r/\*\./ ? File.join('**', line) : line
+      Dir.glob(glob).each {|fn| ary << "^#{Regexp.escape(fn)}"}
+    end
+    exclude.concat ary
+  end
+
+  # generate a regular expression from the exclude list
+  exclude = Regexp.new(exclude.join('|'))
+
+  Find.find '.' do |path|
+    path.sub! %r/^(\.\/|\/)/o, ''
+    next unless test ?f, path
+    next if path =~ exclude
+    files << path
+  end
+  files.sort!
+end
+
+# We need a "valid" method thtat determines if a string is suitable for use
+# in the gem specification.
+#
+class Object
+  def valid?
+    return !(self.empty? or self == "\000") if self.respond_to?(:to_str)
+    return false
+  end
+end
+
+# EOF

data/tasks/spec.rake

@@ -0,0 +1,54 @@
+
+if HAVE_SPEC_RAKE_SPECTASK and not PROJ.spec.files.to_a.empty?
+require 'spec/rake/verify_rcov'
+
+namespace :spec do
+
+  desc 'Run all specs with basic output'
+  Spec::Rake::SpecTask.new(:run) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  desc 'Run all specs with text output'
+  Spec::Rake::SpecTask.new(:specdoc) do |t|
+    t.ruby_opts = PROJ.ruby_opts
+    t.spec_opts = PROJ.spec.opts + ['--format', 'specdoc']
+    t.spec_files = PROJ.spec.files
+    t.libs += PROJ.libs
+  end
+
+  if HAVE_RCOV
+    desc 'Run all specs with RCov'
+    Spec::Rake::SpecTask.new(:rcov) do |t|
+      t.ruby_opts = PROJ.ruby_opts
+      t.spec_opts = PROJ.spec.opts
+      t.spec_files = PROJ.spec.files
+      t.libs += PROJ.libs
+      t.rcov = true
+      t.rcov_dir = PROJ.rcov.dir
+      t.rcov_opts = PROJ.rcov.opts + ['--exclude', 'spec']
+    end
+
+    RCov::VerifyTask.new(:verify) do |t| 
+      t.threshold = PROJ.rcov.threshold
+      t.index_html = File.join(PROJ.rcov.dir, 'index.html')
+      t.require_exact_threshold = PROJ.rcov.threshold_exact
+    end
+
+    task :verify => :rcov
+    remove_desc_for_task %w(spec:clobber_rcov)
+  end
+
+end  # namespace :spec
+
+desc 'Alias to spec:run'
+task :spec => 'spec:run'
+
+task :clobber => 'spec:clobber_rcov' if HAVE_RCOV
+
+end  # if HAVE_SPEC_RAKE_SPECTASK
+
+# EOF

data/tasks/svn.rake

@@ -0,0 +1,47 @@
+
+if HAVE_SVN
+
+unless PROJ.svn.root
+  info = %x/svn info ./
+  m = %r/^Repository Root:\s+(.*)$/.match(info)
+  PROJ.svn.root = (m.nil? ? '' : m[1])
+end
+PROJ.svn.root = File.join(PROJ.svn.root, PROJ.svn.path) unless PROJ.svn.path.empty?
+
+namespace :svn do
+
+  # A prerequisites task that all other tasks depend upon
+  task :prereqs
+
+  desc 'Show tags from the SVN repository'
+  task :show_tags => 'svn:prereqs' do |t|
+    tags = %x/svn list #{File.join(PROJ.svn.root, PROJ.svn.tags)}/
+    tags.gsub!(%r/\/$/, '')
+    tags = tags.split("\n").sort {|a,b| b <=> a}
+    puts tags
+  end
+
+  desc 'Create a new tag in the SVN repository'
+  task :create_tag => 'svn:prereqs' do |t|
+    v = ENV['VERSION'] or abort 'Must supply VERSION=x.y.z'
+    abort "Versions don't match #{v} vs #{PROJ.version}" if v != PROJ.version
+
+    svn = PROJ.svn
+    trunk = File.join(svn.root, svn.trunk)
+    tag = "%s-%s" % [PROJ.name, PROJ.version]
+    tag = File.join(svn.root, svn.tags, tag)
+    msg = "Creating tag for #{PROJ.name} version #{PROJ.version}"
+
+    puts "Creating SVN tag '#{tag}'"
+    unless system "svn cp -m '#{msg}' #{trunk} #{tag}"
+      abort "Tag creation failed" 
+    end
+  end
+
+end  # namespace :svn
+
+task 'gem:release' => 'svn:create_tag'
+
+end  # if PROJ.svn.path
+
+# EOF

data/tasks/test.rake

@@ -0,0 +1,40 @@
+
+if test(?e, PROJ.test.file) or not PROJ.test.files.to_a.empty?
+require 'rake/testtask'
+
+namespace :test do
+
+  Rake::TestTask.new(:run) do |t|
+    t.libs = PROJ.libs
+    t.test_files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+                   else PROJ.test.files end
+    t.ruby_opts += PROJ.ruby_opts
+    t.ruby_opts += PROJ.test.opts
+  end
+
+  if HAVE_RCOV
+    desc 'Run rcov on the unit tests'
+    task :rcov => :clobber_rcov do
+      opts = PROJ.rcov.opts.dup << '-o' << PROJ.rcov.dir
+      opts = opts.join(' ')
+      files = if test(?f, PROJ.test.file) then [PROJ.test.file]
+              else PROJ.test.files end
+      files = files.join(' ')
+      sh "#{RCOV} #{files} #{opts}"
+    end
+
+    task :clobber_rcov do
+      rm_r 'coverage' rescue nil
+    end
+  end
+
+end  # namespace :test
+
+desc 'Alias to test:run'
+task :test => 'test:run'
+
+task :clobber => 'test:clobber_rcov' if HAVE_RCOV
+
+end
+
+# EOF

data/test/test_bot.rb

@@ -0,0 +1,177 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper')) unless defined?(Twibot)
+require 'fileutils'
+
+class TestBot < Test::Unit::TestCase
+  test "should not raise errors when initialized" do
+    assert_nothing_raised do
+      Twibot::Bot.new Twibot::Config.new
+    end
+  end
+
+  test "should raise errors when initialized without config file" do
+    assert_raise SystemExit do
+      Twibot::Bot.new
+    end
+  end
+
+  test "should not raise error on initialize when config file exists" do
+    if File.exists?("config")
+      FileUtils.rm("config/bot.yml")
+    else
+      FileUtils.mkdir("config")
+    end
+
+    File.open("config/bot.yml", "w") { |f| f.puts "" }
+
+    assert_nothing_raised do
+      Twibot::Bot.new
+    end
+
+    FileUtils.rm_rf("config")
+  end
+
+  test "should provide configuration settings as methods" do
+    bot = Twibot::Bot.new Twibot::Config.new(:max_interval => 3)
+    assert_equal 3, bot.max_interval
+  end
+
+  test "log should return logger instance" do
+    bot = Twibot::Bot.new(Twibot::Config.default << Twibot::Config.new)
+    assert bot.log.is_a?(Logger)
+  end
+
+  test "logger should respect configured level" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "info"))
+    assert_equal Logger::INFO, bot.log.level
+
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "warn"))
+    assert_equal Logger::WARN, bot.log.level
+  end
+
+  test "receive should return false without handlers" do
+    bot = Twibot::Bot.new(Twibot::Config.new)
+    assert !bot.receive_messages
+    assert !bot.receive_replies
+    assert !bot.receive_tweets
+  end
+
+  test "should receive message" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "error"))
+    bot.add_handler(:message, Twibot::Handler.new)
+    Twitter::Client.any_instance.expects(:messages).with(:received, nil).returns([message("cjno", "Hei der!")])
+
+    assert bot.receive_messages
+  end
+
+  test "should remember last received message" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "error"))
+    bot.add_handler(:message, Twibot::Handler.new)
+    Twitter::Client.any_instance.expects(:messages).with(:received, nil).returns([message("cjno", "Hei der!")])
+    assert_equal 1, bot.receive_messages
+
+    Twitter::Client.any_instance.expects(:messages).with(:received, { :since_id => 1 }).returns([])
+    assert_equal 0, bot.receive_messages
+  end
+
+  test "should receive tweet" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "error"))
+    bot.add_handler(:tweet, Twibot::Handler.new)
+    Twitter::Client.any_instance.expects(:timeline_for).with(:me, nil).returns([tweet("cjno", "Hei der!")])
+
+    assert_equal 1, bot.receive_tweets
+  end
+
+  test "should remember received tweets" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "error"))
+    bot.add_handler(:tweet, Twibot::Handler.new)
+    Twitter::Client.any_instance.expects(:timeline_for).with(:me, nil).returns([tweet("cjno", "Hei der!")])
+    assert_equal 1, bot.receive_tweets
+
+    Twitter::Client.any_instance.expects(:timeline_for).with(:me, { :id => 1 }).returns([])
+    assert_equal 0, bot.receive_tweets
+  end
+
+  test "should not receive reply when tweet does not start with login" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "error", :login => "irbno"))
+    bot.add_handler(:reply, Twibot::Handler.new)
+    Twitter::Client.any_instance.expects(:timeline_for).with(:me, nil).returns([tweet("cjno", "Hei der!")])
+
+    assert_equal 0, bot.receive_replies
+  end
+
+  test "should receive reply when tweet starts with login" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "error", :login => "irbno"))
+    bot.add_handler(:reply, Twibot::Handler.new)
+    Twitter::Client.any_instance.expects(:timeline_for).with(:me, nil).returns([tweet("cjno", "@irbno Hei der!")])
+
+    assert_equal 1, bot.receive_replies
+  end
+
+  test "should remember received replies" do
+    bot = Twibot::Bot.new(Twibot::Config.new(:log_level => "error", :login => "irbno"))
+    bot.add_handler(:reply, Twibot::Handler.new)
+    Twitter::Client.any_instance.expects(:timeline_for).with(:me, nil).returns([tweet("cjno", "@irbno Hei der!")])
+    assert_equal 1, bot.receive_replies
+
+    Twitter::Client.any_instance.expects(:timeline_for).with(:me, { :id => 1 }).returns([])
+    assert_equal 0, bot.receive_replies
+  end
+end
+
+class TestBotMacros < Test::Unit::TestCase
+  test "should provide configure macro" do
+    assert respond_to?(:configure)
+  end
+
+  test "configure should yield configuration" do
+    Twibot::Macros.bot = Twibot::Bot.new Twibot::Config.default
+    bot.prompt = false
+
+    conf = nil
+    assert_nothing_raised { configure { |c| conf = c } }
+    assert conf.is_a?(Twibot::Config)
+  end
+
+  test "should add handler" do
+    handler = add_handler(:message, ":command", :from => :cjno)
+    assert handler.is_a?(Twibot::Handler), handler.class
+  end
+
+  test "should provide twitter macro" do
+    assert respond_to?(:twitter)
+    assert respond_to?(:client)
+  end
+end
+
+class TestBotHandlers < Test::Unit::TestCase
+
+  test "should include handlers" do
+    bot = Twibot::Bot.new(Twibot::Config.new)
+
+    assert_not_nil bot.handlers
+    assert_not_nil bot.handlers[:message]
+    assert_not_nil bot.handlers[:reply]
+    assert_not_nil bot.handlers[:tweet]
+  end
+
+  test "should add handler" do
+    bot = Twibot::Bot.new(Twibot::Config.new)
+    bot.add_handler :message, Twibot::Handler.new
+    assert_equal 1, bot.handlers[:message].length
+
+    bot.add_handler :message, Twibot::Handler.new
+    assert_equal 2, bot.handlers[:message].length
+
+    bot.add_handler :reply, Twibot::Handler.new
+    assert_equal 1, bot.handlers[:reply].length
+
+    bot.add_handler :reply, Twibot::Handler.new
+    assert_equal 2, bot.handlers[:reply].length
+
+    bot.add_handler :tweet, Twibot::Handler.new
+    assert_equal 1, bot.handlers[:tweet].length
+
+    bot.add_handler :tweet, Twibot::Handler.new
+    assert_equal 2, bot.handlers[:tweet].length
+  end
+end

data/test/test_config.rb

@@ -0,0 +1,89 @@
+require File.expand_path(File.join(File.dirname(__FILE__), 'test_helper')) unless defined?(Twibot)
+require 'stringio'
+
+class TestConfig < Test::Unit::TestCase
+  test "default configuration should be a hash" do
+    assert_not_nil Twibot::Config::DEFAULT
+    assert Twibot::Config::DEFAULT.is_a?(Hash)
+  end
+
+  test "should initialize with no options" do
+    assert_hashes_equal({}, Twibot::Config.new.settings)
+  end
+
+  test "add config should return config" do
+    config = Twibot::Config.new
+    assert_equal config, config.add(Twibot::Config.new)
+  end
+
+  test "add config should be aliased to <<" do
+    config = Twibot::Config.new
+    assert config.respond_to?(:<<)
+    assert config << Twibot::Config.new
+  end
+
+  test "missing methods should act as config getters" do
+    config = Twibot::Config.default << Twibot::Config.new
+    assert_equal Twibot::Config::DEFAULT[:min_interval], config.min_interval
+    assert_equal Twibot::Config::DEFAULT[:login], config.login
+  end
+
+  test "missing methods should act as config setters" do
+    config = Twibot::Config.default << Twibot::Config.new
+    assert_equal Twibot::Config::DEFAULT[:min_interval], config.min_interval
+
+    val = config.min_interval
+    config.min_interval = val + 5
+    assert_not_equal Twibot::Config::DEFAULT[:min_interval], config.min_interval
+    assert_equal val + 5, config.min_interval
+  end
+
+  test "default configuration should not override default hash" do
+    config = Twibot::Config.default
+    hash = Twibot::Config::DEFAULT
+
+    config.min_interval = 0
+    config.max_interval = 0
+
+    assert_hashes_not_equal Twibot::Config::DEFAULT, config.to_hash
+    assert_hashes_equal hash, Twibot::Config::DEFAULT
+  end
+
+  test "to_hash should return merged configuration" do
+    config = Twibot::Config.new
+    config.min_interval = 10
+    config.max_interval = 10
+
+    config2 = Twibot::Config.new({})
+    config2.min_interval = 1
+    config << config2
+    options = config.to_hash
+
+    assert_equal 10, options[:max_interval]
+    assert_equal 1, options[:min_interval]
+  end
+end
+
+class TestCliConfig < Test::Unit::TestCase
+  test "should configure from options" do
+    config = Twibot::CliConfig.new %w{--min-interval 10 --max-interval 15}
+    assert_equal 10, config.min_interval
+    assert_equal 15, config.max_interval
+  end
+end
+
+class TestFileConfig < Test::Unit::TestCase
+  test "file config should subclass config" do
+    assert Twibot::FileConfig.new(StringIO.new).is_a?(Twibot::Config)
+  end
+
+  test "should read settings from stream" do
+    config = Twibot::FileConfig.new(StringIO.new <<-YAML)
+min_interval: 10
+max_interval: 20
+    YAML
+
+    assert_equal 10, config.min_interval
+    assert_equal 20, config.max_interval
+  end
+end