twitter_bot 0.0.1

data/History.txt

@@ -0,0 +1,4 @@
+== 0.0.1 2008-05-14
+
+* 1 major enhancement:
+  * Initial release

data/License.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2008 Integrum Technologies, LLC
+
+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/Manifest.txt

@@ -0,0 +1,36 @@
+History.txt
+License.txt
+Manifest.txt
+PostInstall.txt
+README.txt
+Rakefile
+config/hoe.rb
+config/requirements.rb
+lib/jabber_bot.rb
+lib/twitter_bot.rb
+lib/twitter_bot/version.rb
+rails_generators/twitter_bot/USAGE
+rails_generators/twitter_bot/templates/awesome_twitter_bot.rb
+rails_generators/twitter_bot/templates/twitter_bot
+rails_generators/twitter_bot/templates/twitter_bot.yml
+rails_generators/twitter_bot/templates/twitter_bot_runner.rb
+rails_generators/twitter_bot/twitter_bot_generator.rb
+script/console
+script/destroy
+script/generate
+script/txt2html
+setup.rb
+spec/spec.opts
+spec/spec_helper.rb
+spec/twitter_bot_spec.rb
+tasks/deployment.rake
+tasks/environment.rake
+tasks/rspec.rake
+tasks/website.rake
+test/test_generator_helper.rb
+test/test_twitter_bot_generator.rb
+website/index.html
+website/index.txt
+website/javascripts/rounded_corners_lite.inc.js
+website/stylesheets/screen.css
+website/template.html.erb

data/PostInstall.txt

@@ -0,0 +1 @@
+For more information on twitter_bot, see http://integrum.rubyforge.org

data/README.txt

@@ -0,0 +1,44 @@
+= twitter_bot
+
+* http://integrum.rubyforge.org
+
+== DESCRIPTION:
+
+Enables adding twitter to your app.  Uses Twitter's Jabber interface.
+
+== SYNOPSIS:
+
+  script/generate twitter_bot name
+    name - the name of your twitter bot
+
+  1. Edit config/twitter_bot.yml to add authentication information
+  2. Edit lib/<name>_twitter_bot.rb to specify callback actions
+
+== INSTALL:
+
+* gem install twitter_bot
+
+== LICENSE:
+
+(The MIT License)
+
+Copyright (c) 2008 Integrum Technologies, LLC
+
+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,4 @@
+require 'config/requirements'
+require 'config/hoe' # setup Hoe + all gem configuration
+
+Dir['tasks/**/*.rake'].each { |rake| load rake }

data/config/hoe.rb

@@ -0,0 +1,75 @@
+require 'twitter_bot/version'
+
+AUTHOR = "Jade Meskill, Curtis Miller, Curtis Edmond"  # can also be an array of Authors
+EMAIL = "info@integrumtech.com"
+DESCRIPTION = "Twitter integration for your app using the Twitter Jabber bot"
+GEM_NAME = 'twitter_bot' # what ppl will type to install your gem
+RUBYFORGE_PROJECT = 'integrum' # The unix name for your project
+HOMEPATH = "http://integrum.rubyforge.org"
+DOWNLOAD_PATH = "http://rubyforge.org/projects/integrum/twitter_bot"
+EXTRA_DEPENDENCIES = [
+  ['daemons', '>= 1.0.9'],
+  ['twitter', '>= 0.2.6'],
+  ['xmpp4r', '>= 0.3.2']
+]
+
+@config_file = "~/.rubyforge/user-config.yml"
+@config = nil
+RUBYFORGE_USERNAME = "unknown"
+def rubyforge_username
+  unless @config
+    begin
+      @config = YAML.load(File.read(File.expand_path(@config_file)))
+    rescue
+      puts <<-EOS
+ERROR: No rubyforge config file found: #{@config_file}
+Run 'rubyforge setup' to prepare your env for access to Rubyforge
+ - See http://newgem.rubyforge.org/rubyforge.html for more details
+      EOS
+      exit
+    end
+  end
+  RUBYFORGE_USERNAME.replace @config["username"]
+end
+
+
+REV = nil
+# UNCOMMENT IF REQUIRED:
+# REV = YAML.load(`svn info`)['Revision']
+VERS = TwitterBot::VERSION::STRING + (REV ? ".#{REV}" : "")
+RDOC_OPTS = ['--quiet', '--title', 'twitter_bot documentation',
+    "--opname", "index.html",
+    "--line-numbers",
+    "--main", "README",
+    "--inline-source"]
+
+class Hoe
+  def extra_deps
+    @extra_deps.reject! { |x| Array(x).first == 'hoe' }
+    @extra_deps
+  end
+end
+
+# Generate all the Rake tasks
+# Run 'rake -T' to see list of generated tasks (from gem root directory)
+$hoe = Hoe.new(GEM_NAME, VERS) do |p|
+  p.developer(AUTHOR, EMAIL)
+  p.description = DESCRIPTION
+  p.summary = DESCRIPTION
+  p.url = HOMEPATH
+  p.rubyforge_name = RUBYFORGE_PROJECT if RUBYFORGE_PROJECT
+  p.test_globs = ["test/**/test_*.rb"]
+  p.clean_globs |= ['**/.*.sw?', '*.gem', '.config', '**/.DS_Store']  #An array of file patterns to delete on clean.
+
+  # == Optional
+  p.changes = p.paragraphs_of("History.txt", 0..1).join("\n\n")
+  p.extra_deps = EXTRA_DEPENDENCIES
+
+    #p.spec_extras = {}    # A hash of extra values to set in the gemspec.
+  end
+
+CHANGES = $hoe.paragraphs_of('History.txt', 0..1).join("\\n\\n")
+PATH    = (RUBYFORGE_PROJECT == GEM_NAME) ? RUBYFORGE_PROJECT : "#{RUBYFORGE_PROJECT}/#{GEM_NAME}"
+$hoe.remote_rdoc_dir = File.join(PATH.gsub(/^#{RUBYFORGE_PROJECT}\/?/,''), 'rdoc')
+$hoe.rsync_args = '-av --delete --ignore-errors'
+$hoe.spec.post_install_message = File.open(File.dirname(__FILE__) + "/../PostInstall.txt").read rescue ""

data/config/requirements.rb

@@ -0,0 +1,15 @@
+require 'fileutils'
+include FileUtils
+
+require 'rubygems'
+%w[rake hoe newgem rubigen].each do |req_gem|
+  begin
+    require req_gem
+  rescue LoadError
+    puts "This Rakefile requires the '#{req_gem}' RubyGem."
+    puts "Installation: gem install #{req_gem} -y"
+    exit
+  end
+end
+
+$:.unshift(File.join(File.dirname(__FILE__), %w[.. lib]))

data/lib/jabber_bot.rb

@@ -0,0 +1,41 @@
+require 'xmpp4r/client'
+
+class JabberBot < Jabber::Client
+  include Jabber
+
+  def initialize(jabber_id, jabber_password, options = {})
+    @jabber_id       = jabber_id
+    @jabber_password = jabber_password
+    @options         = options
+
+    jid = JID::new(@jabber_id)
+    super(jid)
+  end
+  
+  def on_message(from, body)
+    raise "on_message not implemented!"
+  end
+  
+  def connect_and_authenticate
+    connect
+    auth(@jabber_password)
+    send(Presence::new)
+  end
+  
+  def run
+    main = Thread.current
+    add_message_callback { |message|
+      next if message.type == :error or message.body.blank?
+      # support exit command if owner is set
+      main.wakeup if @options[:owner_jabber_id] == message.from && message.body == 'exit'
+      # simple callback
+      self.on_message(message.from, message.body, message.first_element('entry'))
+    }
+    Thread.stop
+    close
+  end
+  
+  def say(jabber_id, body)
+    send(Message::new(jabber_id, body).set_type(:chat).set_id('1'))
+  end
+end

data/lib/twitter_bot.rb

@@ -0,0 +1,151 @@
+require File.dirname(__FILE__) + '/../lib/jabber_bot'
+require 'twitter'
+
+class TwitterBot < JabberBot
+  TWITTER_JABBER_ID = 'twitter@twitter.com'
+  attr_accessor :track_phrases
+
+  CONFIG_FILE = File.join(RAILS_ROOT, 'config', 'twitter_bot.yml')
+
+  def initialize
+    raise "File does not exist: '#{CONFIG_FILE}'" unless File.exist?(CONFIG_FILE)
+    
+    twitter_bot_config = YAML.load(File.read(CONFIG_FILE))
+    twitter_config     = twitter_bot_config['twitter']
+    jabber_config      = twitter_bot_config['jabber']
+
+    raise "Please specify the twitter config in '#{CONFIG_FILE}'" if twitter_config.blank?
+    raise "Please specify the jabber config in '#{CONFIG_FILE}'"  if jabber_config.blank?
+
+    @twitter_username = twitter_config['username']
+    @twitter_password = twitter_config['password']
+    jabber_id         = jabber_config['id']
+    jabber_password   = jabber_config['password']
+
+    raise "The twitter username has not been specified in '#{CONFIG_FILE}'" if @twitter_username.blank?
+    raise "The twitter password has not been specified in '#{CONFIG_FILE}'" if @twitter_password.blank?
+    raise "The jabber ID has not been specified in '#{CONFIG_FILE}'"        if jabber_id.blank?
+    raise "The jabber password has not been specified in '#{CONFIG_FILE}'"  if jabber_password.blank?
+
+    @track_phrases = twitter_bot_config['track'] || []
+    @followers     = []
+
+    @twitter = Twitter::Base.new(@twitter_username, @twitter_password)
+    super(jabber_id, jabber_password)
+  end
+
+  def on_directed_tweet(&block); @on_directed_tweet_callback = block; end
+  def on_tweet(&block);          @on_tweet_callback          = block; end
+  def on_track(&block);          @on_track_callback          = block; end
+  def on_follow(&block);         @on_follow_callback         = block; end
+  def on_unfollow(&block);       @on_unfollow_callback       = block; end
+
+  def create_twitter_entry(entry)
+    return if entry.nil?
+    xml = Hpricot.XML(entry.to_s)
+    Twitter::Status.new do |s|
+      s.id         = xml.at('entry/id').innerHTML.split('/').last
+      s.created_at = Time.parse(xml.at('entry/published').innerHTML)
+      s.text       = body
+      s.user       = Twitter.User.new do |u|
+        u.screen_name       = xml.at('author/name').innerHTML
+        u.url               = xml.at('source/link')['href']
+        u.profile_image_url = xml.at('source/icon').innerHTML
+      end
+    end
+  end
+
+  def on_message(from, body, entry = nil)
+    $stdout.flush
+    return unless from == TWITTER_JABBER_ID
+    entry = create_twitter_entry(entry) rescue nil
+
+    callback        = @on_tweet_callback
+    twitter_message = body.split(': ')
+    twitter_body    = twitter_message[1,twitter_message.size].join(': ')
+    twitter_from    = twitter_message.first
+
+    if twitter_from =~ /You aren\'t tracking anything\. Reply with \'track your keywords\' to start\./
+      track_phrases.each { |phrase| say("track #{phrase}") }
+    else
+      if (track_notification = twitter_from.match(/\((.+)\)/))
+        twitter_from = track_notification[1] # Make sure that twitter_from gets set properly in case of event + @<username>
+        # callback = @on_track_callback
+      end
+
+      callback.call(twitter_from, twitter_body, entry) if callback
+    end
+  rescue => e
+    $stderr.puts("error parsing #{body} (#{e})")
+  end
+
+  def runn(options = {})
+    connect_and_authenticate
+    follow_all_followers if options[:follow_all_followers]
+    say("untrack all")
+
+    Thread.new do
+      followers_watcher(options)
+    end
+    run
+  end
+
+  def logger
+    @@logger ||= Logger.new(File.join(RAILS_ROOT, 'log', 'twitter_bot.log'))
+  end
+
+  def follow(username)
+    say("follow #{username}")
+  end
+
+  def say(line)
+    super(TWITTER_JABBER_ID, line)
+  end
+
+  def direct_message(username, message)
+    say("d #{username} #{message}")
+  end
+
+  def determine_phrase_for_body(body)
+    @track_phrases.each do |phrase|
+      phrase_expression = Regexp.new(phrase)
+      if phrase_expression.match(body.downcase)
+        return phrase
+      end
+    end
+    nil
+  end
+
+  def follow_all_followers
+    following  = @twitter.friends.collect   { |user| user.name }
+    @followers = @twitter.followers.collect { |user| user.name }
+    @followers.each do |username|
+      if !following.index(username)
+        follow(username)
+      end
+    end
+  end
+
+  def followers_watcher(options = {})
+    return unless @on_follow_callback || @on_unfollow_callback 
+    options[:followers_check_wait] ||= 120
+    @followers = @twitter.followers.collect { |user| user.name } if @followers.empty?
+    while 1 == 1
+      twitter_followers = @twitter.followers.collect { |user| user.name }
+      twitter_followers.each do |username|
+        if !@followers.index(username)
+          @on_follow_callback.call(username) if @on_follow_callback
+        end
+      end
+      @followers.each do |username|
+        if !twitter_followers.index(username)
+          @on_unfollow_callback.call(username) if @on_unfollow_callback
+        end
+      end
+      @followers = twitter_followers
+      sleep(options[:followers_check_wait])
+    end
+  rescue => e
+    raise e
+  end
+end

data/lib/twitter_bot/version.rb

@@ -0,0 +1,9 @@
+module TwitterBot #:nodoc:
+  module VERSION #:nodoc:
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 1
+
+    STRING = [MAJOR, MINOR, TINY].join('.')
+  end
+end

data/rails_generators/twitter_bot/templates/awesome_twitter_bot.rb

@@ -0,0 +1,25 @@
+require 'drb'
+
+class <%= file_name.classify %>TwitterBot < TwitterBot
+  def runn
+    self.on_tweet do |username, message, entry|
+      logger.info("#{username} said '#{message}'")
+      # Add tweet processing code here, not required
+    end
+
+    self.on_follow do |username|
+      logger.info("#{username} is following us, will follow #{username} too and send welcome message")
+      follow(username)
+      self.direct_message(username, "thanks for following me!")
+      # Add on follow processing here, not required
+    end
+
+    self.on_unfollow do |username|
+      logger.info("#{username} has stopped following us.")
+      # Add on unfollow processing here, not required
+    end
+
+    DRb.start_service("druby://:8997", self)
+    super
+  end
+end