hashtag_retweet_bot 0.2.0

data/Manifest

@@ -0,0 +1,8 @@
+bin/hashtag_retweet_bot
+create_db_table.rb
+feed.rb
+hashtag_retweet_bot.gemspec
+lib/bot.rb
+Manifest
+Rakefile
+README.markdown

data/README.markdown

@@ -0,0 +1,77 @@
+# Hashtag retweet bot
+
+A bot that retweets all tweets tagged by a certain hashtag. Ideal for conferences, meetup groups, communities, etc.
+
+As an example, let's say you want to retweet every tweet found with the hashtag #icecream every 5 minutes (300 seconds). This ruby gem will let you do it as easily as running:
+
+    hashtag_retweet_bot icecream 300
+
+## Installation
+
+    gem install hashtag_retweet_bot
+
+Create the database:
+
+    mysqladmin create my_conference_db
+
+Create a directory where you will run the bot from, and a config directory with 2 files in it: _database.yml_ for your database settings and either
+* _oauth.yml_ to make the bot use OAuth (RECOMMENDED)
+* _bot.yml_ for the login/password of the twitter account (DEPRECATED)
+
+    mkdir -p bot_for_my_conference/config
+    cd config/bot_for_my_conference
+    touch database.yml
+    
+If you want to use OAuth, register a new application on Twitter and put in consumer key (token) and secret in _oauth.yml_:
+    consumer:
+      token: my_apps_consumer_key
+      secret: my_apps_consumer_secrets
+      
+Don't worry now about request and access token/secret pairs, the bot will guide you the first time you launch it. And every time access token/secret will become invalid and need re-creating (as of June 2010, Twitter is not expiring access tokens, but they can be invalidated by removing the app).
+
+If you want to use HTTP Auth (it's DEPRECATED by Twitter and will be no longer supported after August 2010), put the credentials for the twitter account in _bot.yml_:
+
+    login: my_conference_bot
+    password: secret
+
+Put the database connection attributes in _database.yml_:
+
+    adapter: mysql
+    username: root
+    host: localhost
+    password:
+    database: my_conference_db
+
+And create the table on the database that will hold the tweets:
+
+    hashtag_retweet_bot create_db_table
+
+## Run it
+
+Now the only thing left to do is running the bot, telling it what tag to follow, like that:
+
+    hashtag_retweet_bot tag_to_follow
+
+This will launch the bot with a default pause of 180 seconds. If you want a different time schedule you can specify other value for the seconds parameter, but I've experienced Twitter connection problems when trying to update every 60 seconds or less:
+
+    hashtag_retweet_bot tag_to_follow seconds_between_updates
+
+Example:
+
+    hashtag_retweet_bot icecream
+    hashtag_retweet_bot icecream 240
+
+## Live examples
+
+Some twitterbots using hashtag_retweet_bot:
+
+* [@euruko_bot](http://twitter.com/euruko_bot)
+* [@confrorbot](http://twitter.com/confrorbot)
+* [The bot for the Budapest Ruby User Group](http://twitter.com/budapestrb)
+
+## Credits
+
+Original idea and script by [Mark Connell](http://github.com/mconnell) for Scotland on Rails 2009. Customization for Euruko '09, and some improvements by [Jaime Iniesta](http://github.com/jaimeiniesta). Some improvements and gemification by [Balint Erdi](http://github.com/balinterdi).
+Customization for Euruko '10 and further work (OAuth support, refactoring etc.) by [Tomasz Stachewicz](http://github.com/tomash) 
+
+Please send feedback and bug reports to <balint.erdi@gmail.com>

data/Rakefile

@@ -0,0 +1,15 @@
+require 'rubygems'
+require 'rake'
+require 'echoe'
+
+Echoe.new('hashtag_retweet_bot', '0.1.3') do |p|
+  p.description    = "Script that listens to a tag and retweets messages with that tag. Originally made for Scotland on Rails '09 by Mark Connell (http://github.com/rubaidh)"
+  p.url            = "http://github.com/jaimeiniesta/hashtag_retweet_bot"
+  p.author         = "Jaime Iniesta"
+  p.email          = "jaimeiniesta@gmail.com"
+  p.ignore_pattern = ["tmp/*", "config/*", "script/*", "*.txt", "pkg"]
+  p.development_dependencies = ["twibot >=0.1.7", "activerecord", "pauldix-feedzirra >=0.0.12"]
+  p.runtime_dependencies = ["twibot >=0.1.7", "activerecord", "pauldix-feedzirra >=0.0.12"]
+end
+
+Dir["#{File.dirname(__FILE__)}/tasks/*.rake"].sort.each { |ext| load ext }

data/bin/hashtag_retweet_bot

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+
+require File.join(File.dirname(__FILE__), '..', 'lib', 'bot')
+
+if ARGV.length < 1
+  puts "Usage: hashtag_retweet_bot [tag_to_watch] [seconds_between_updates]"
+  puts "If you haven't created the database table, run:"
+  puts "hashtag_retweet_bot create_db_table"
+  exit
+end
+
+tag = ARGV[0]
+seconds = ARGV[1] || 180
+if tag.downcase == 'create_db_table'
+  puts "Creating the database"
+  require File.join(File.dirname(__FILE__), '..', 'create_db_table')
+else
+  puts "Launching the twitterbot to track \##{tag} every #{seconds} seconds"
+  bot = HashtagRetweetBot.new(tag, seconds.to_i)
+  bot.run
+end

data/create_db_table.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'active_record'
+require 'yaml'
+
+adapter_attrs = YAML.load(File.open('config/database.yml') { |f| f.read })
+ActiveRecord::Base.establish_connection(adapter_attrs)
+
+ActiveRecord::Schema.define do
+  create_table(:tweets, :force => true) do |t|
+    t.string      :twitter_id
+    t.datetime    :published
+    t.string      :link
+    t.string      :title
+    t.string      :content
+    t.string      :author_name
+    t.string      :author_uri
+    t.boolean     :tweeted
+  end
+end

data/feed.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'feedzirra' # feed helper
+
+feed = Feedzirra::Feed.fetch_and_parse("http://search.twitter.com/search.atom?q=+%23euruko")
+
+feed.entries.each do |entry|
+
+  puts "entry #{entry.inspect}"
+
+end

data/hashtag_retweet_bot.gemspec

@@ -0,0 +1,50 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{hashtag_retweet_bot}
+  s.version = "0.2.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Balint Erdi", "Jaime Iniesta", "Tomasz Stachewicz"]
+  s.date = %q{2010-06-19}
+  s.default_executable = %q{hashtag_retweet_bot}
+  s.description = %q{Script that listens to a tag and retweets messages with that tag. Supports both OAuth and HTTPAuth authentication strategies. Retweets using Twitter's native RT feature. Originally made for Scotland on Rails '09 by Mark Connell (http://github.com/rubaidh). Refactored and reworked after Euruko '10 by Tomasz Stachewicz (http://github.com/tomash)}
+  s.email = %q{t.stachewicz@gmail.com}
+  s.executables = ["hashtag_retweet_bot"]
+  s.extra_rdoc_files = ["bin/hashtag_retweet_bot", "lib/bot.rb", "README.markdown"]
+  s.files = ["bin/hashtag_retweet_bot", "create_db_table.rb", "feed.rb", "hashtag_retweet_bot.gemspec", "lib/bot.rb", "Manifest", "Rakefile", "README.markdown"]
+  s.homepage = %q{http://github.com/tomash/hashtag_retweet_bot}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Hashtag_retweet_bot", "--main", "README.markdown"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{hashtag_retweet_bot}
+  s.rubygems_version = %q{1.3.3}
+  s.summary = %q{Script that listens to a tag and retweets messages with that tag.}
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<twitter>, [">= 0.9.7"])
+      s.add_runtime_dependency(%q<activerecord>, [">= 0"])
+      s.add_runtime_dependency(%q<feedzirra>, [">= 0.0.23"])
+      s.add_development_dependency(%q<twitter>, [">= 0.9.7"])
+      s.add_development_dependency(%q<activerecord>, [">= 0"])
+      s.add_development_dependency(%q<feedzirra>, [">= 0.0.23"])
+    else
+      s.add_dependency(%q<twitter>, [">= 0.9.7"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<feedzirra>, [">= 0.0.23"])
+      s.add_dependency(%q<twitter>, [">= 0.9.7"])
+      s.add_dependency(%q<activerecord>, [">= 0"])
+      s.add_dependency(%q<feedzirra>, [">= 0.0.23"])
+    end
+  else
+    s.add_dependency(%q<twitter>, [">= 0.9.7"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<feedzirra>, [">= 0.0.23"])
+    s.add_dependency(%q<twitter>, [">= 0.9.7"])
+    s.add_dependency(%q<activerecord>, [">= 0"])
+    s.add_dependency(%q<feedzirra>, [">= 0.0.23"])
+  end
+end

data/lib/bot.rb

@@ -0,0 +1,123 @@
+require "rubygems"
+
+require 'active_record' # db
+require 'feedzirra' # feed helper
+require 'yaml'
+require 'twitter'
+require File.join(File.dirname(__FILE__), 'hash')
+
+class Tweets < ActiveRecord::Base
+end
+
+###
+#  What we want the bot to do
+###
+#  1. Listen to an rss feed and store that stuff
+#  2. Work out which tweets need to be tweeted by the bot
+#  3. send the tweets and mark them as 'tweeted'
+#  4. repeat ad nauseam every x seconds (as indicated, 180 is recommended)
+#
+
+class HashtagRetweetBot
+  def initialize(tag, seconds=180)
+    @tag = tag
+    @seconds = seconds
+    @client = nil
+  end
+  
+  def authorize
+    if(File.exist?('config/oauth.yml'))
+      puts "Found config/oauth.yml, using OAuth."
+      authorize_using_oauth
+    elsif(File.exist?('config/bot.yml'))
+      puts "Using HTTP Auth (DEPRECATED)."
+      authorize_using_httpauth
+    else
+      puts "No config file (neither oauth.yml nor bot.yml) found in config/, exiting..."
+      exit
+    end
+  end
+  
+  def authorize_using_oauth
+    oauth_config = YAML.load(File.open('config/oauth.yml') { |f| f.read }).symbolize_keys!
+    oauth = Twitter::OAuth.new(oauth_config[:consumer][:token], oauth_config[:consumer][:secret])
+    oauth.authorize_from_access(oauth_config[:access][:token], oauth_config[:access][:secret])
+    
+    @client = Twitter::Base.new(oauth)
+    puts "Logged in successfully using OAuth, bot should be working now."
+    #@client.update("Heyo from OAuth app at #{Time.now}")
+  rescue Twitter::Unauthorized
+    puts "It seems the access token are no longer valid, we need to get new ones."
+    regenerate_oauth(oauth_config)
+  end
+  
+  def authorize_using_httpauth
+    http_config = YAML.load(File.open('config/bot.yml') { |f| f.read }).symbolize_keys!
+    httpauth = Twitter::HTTPAuth.new(http_config[:login], http_config[:password])
+    @client = Twitter::Base.new(httpauth)
+    puts "Logged in successfully using HTTP Auth, bot should be working now."
+    #@client.update("Heyo from HTTP Auth app at #{Time.now}")
+  end
+  
+  def regenerate_oauth(oauth_config)
+    oauth = Twitter::OAuth.new(oauth_config[:consumer][:token], oauth_config[:consumer][:secret])
+    request_token = oauth.request_token
+    puts request_token.authorize_url
+    puts "Visit the above link, grant access and type in PIN: "
+    STDOUT.flush
+    pin = STDIN.gets.chomp
+    access_token = request_token.get_access_token(:oauth_verifier => pin)
+    
+    oauth_config[:access] = {:token => access_token.token, :secret => access_token.secret}
+    
+    File.open('config/oauth.yml', 'w') { |f| YAML.dump(oauth_config, f)}
+    puts "New access token saved, please re-run the bot."
+  end
+    
+
+  def run
+    authorize
+
+    adapter_attrs = YAML.load(File.open('config/database.yml') { |f| f.read })
+    ActiveRecord::Base.establish_connection(adapter_attrs)
+
+    feed_thread = Thread.new do
+      while(true != false)
+        begin
+          # fetch the feed
+          feed = get_tweets_tagged_with(@tag)
+          feed.entries.reverse.each do |entry|
+            tweet = Tweets.find_or_create_by_twitter_id(
+                      :twitter_id => entry.id,
+                      :published  => entry.published,
+                      :title      => entry.title,
+                      :content    => entry.content,
+                      :link       => entry.url
+                    )
+
+            if tweet.tweeted.blank?
+              id_extractor = /\d+$/ 
+              tid = id_extractor.match(tweet.twitter_id).to_s
+              @client.retweet(tid)
+              puts "retweeted #{tid} at #{Time.now.to_s(:long)}" # poor mans logging
+              tweet.update_attribute(:tweeted, true)
+            end
+          end
+        rescue => exception
+          puts exception.to_s
+          #puts exception.backtrace
+        end
+        sleep(@seconds)
+      end
+    end
+
+    feed_thread.join
+  end
+
+  private
+  def get_tweets_tagged_with(tag)
+    Feedzirra::Feed.fetch_and_parse("http://search.twitter.com/search.atom?q=+%23#{tag}")
+  end
+
+end # class
+

metadata

@@ -0,0 +1,158 @@
+--- !ruby/object:Gem::Specification 
+name: hashtag_retweet_bot
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 2
+  - 0
+  version: 0.2.0
+platform: ruby
+authors: 
+- Balint Erdi
+- Jaime Iniesta
+- Tomasz Stachewicz
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-06-19 00:00:00 +02:00
+default_executable: hashtag_retweet_bot
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 7
+        version: 0.9.7
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: feedzirra
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 23
+        version: 0.0.23
+  type: :runtime
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 9
+        - 7
+        version: 0.9.7
+  type: :development
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: activerecord
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
+  name: feedzirra
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 0
+        - 23
+        version: 0.0.23
+  type: :development
+  version_requirements: *id006
+description: Script that listens to a tag and retweets messages with that tag. Supports both OAuth and HTTPAuth authentication strategies. Retweets using Twitter's native RT feature. Originally made for Scotland on Rails '09 by Mark Connell (http://github.com/rubaidh). Refactored and reworked after Euruko '10 by Tomasz Stachewicz (http://github.com/tomash)
+email: t.stachewicz@gmail.com
+executables: 
+- hashtag_retweet_bot
+extensions: []
+
+extra_rdoc_files: 
+- bin/hashtag_retweet_bot
+- lib/bot.rb
+- README.markdown
+files: 
+- bin/hashtag_retweet_bot
+- create_db_table.rb
+- feed.rb
+- hashtag_retweet_bot.gemspec
+- lib/bot.rb
+- Manifest
+- Rakefile
+- README.markdown
+has_rdoc: true
+homepage: http://github.com/tomash/hashtag_retweet_bot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Hashtag_retweet_bot
+- --main
+- README.markdown
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: hashtag_retweet_bot
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: Script that listens to a tag and retweets messages with that tag.
+test_files: []
+