balinterdi-hashtag_retweet_bot 0.1.1 → 0.1.3

data/README.markdown

@@ -1,16 +1,20 @@
 # Hashtag retweet bot
 
-A bot that retweets all tweets tagged by a certain tag. Ideal for conferences, meetup groups, communities, etc.
+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 balinterdi-hashtag_retweet_bot --source http://gems.github.com
 
-Create the database that will hold the tweets:
+Create the database:
 
-    mysqladmin create my_conference
+    mysqladmin create my_conference_db
 
-Create a directory where you will run the bot from:
+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 _bot.yml_ for the login/password of the twitter account.
 
     mkdir -p bot_for_my_conference/config
     cd config/bot_for_my_conference
@@ -27,16 +31,37 @@ Put the database connection attributes in _database.yml_:
     username: root
     host: localhost
     password:
-    database: my_conference
+    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 to run the bot:
+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:
 
-    hashtag_retweet_bot my_conference
+[@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 by [Jaime Iniesta](http://github.com/jaimeiniesta). Some improvements and gemification by [Balint Erdi](http://github.com/balinterdi).
+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).
 
-Please send feedback and bug reports to <balint@bucionrails.com>
+Please send feedback and bug reports to <balint.erdi@gmail.com>

data/Rakefile

@@ -2,11 +2,11 @@ require 'rubygems'
 require 'rake'
 require 'echoe'
 
-Echoe.new('hashtag_retweet_bot', '0.1.1') do |p|
+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/balinterdi/hashtag_retweet_bot"
-  p.author         = "Balint Erdi"
-  p.email          = "balint@bucionrails.com"
+  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"]

data/bin/hashtag_retweet_bot

@@ -2,15 +2,20 @@
 
 require File.join(File.dirname(__FILE__), '..', 'lib', 'bot')
 
-if ARGV.length != 1
-  puts "Usage: hashtag_retweet_bot [tag_to_watch]"
+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.first
+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
-  bot = HashtagRetweetBot.new(tag)
+  puts "Launching the twitterbot to track \##{tag} every #{seconds} seconds"
+  bot = HashtagRetweetBot.new(tag, seconds.to_i)
   bot.run
 end

data/hashtag_retweet_bot.gemspec

@@ -2,18 +2,18 @@
 
 Gem::Specification.new do |s|
   s.name = %q{hashtag_retweet_bot}
-  s.version = "0.1.1"
+  s.version = "0.1.3"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Balint Erdi"]
-  s.date = %q{2009-07-08}
+  s.authors = ["Balint Erdi", "Jaime Iniesta"]
+  s.date = %q{2009-08-16}
   s.default_executable = %q{hashtag_retweet_bot}
   s.description = %q{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)}
-  s.email = %q{balint@bucionrails.com}
+  s.email = %q{jaimeiniesta@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/balinterdi/hashtag_retweet_bot}
+  s.homepage = %q{http://github.com/jaimeiniesta/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}

data/lib/bot.rb

@@ -13,11 +13,13 @@ end
 #  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)
+  def initialize(tag, seconds=180)
     @tag = tag
+    @seconds = seconds
   end
 
   def run
@@ -30,7 +32,6 @@ class HashtagRetweetBot
         begin
           # fetch the feed
           feed = get_tweets_tagged_with(@tag)
-          puts "XXX Feed entries length: #{feed.entries.length}"
           feed.entries.reverse.each do |entry|
             tweet = Tweets.find_or_create_by_twitter_id(
                       :twitter_id => entry.id,
@@ -57,7 +58,7 @@ class HashtagRetweetBot
           end
         rescue
         end
-        sleep(60)
+        sleep(@seconds)
       end
     end
 

metadata

@@ -1,15 +1,16 @@
 --- !ruby/object:Gem::Specification 
 name: balinterdi-hashtag_retweet_bot
 version: !ruby/object:Gem::Version 
-  version: 0.1.1
+  version: 0.1.3
 platform: ruby
 authors: 
 - Balint Erdi
+- Jaime Iniesta
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2009-07-08 00:00:00 -07:00
+date: 2009-08-16 00:00:00 -07:00
 default_executable: hashtag_retweet_bot
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -73,7 +74,7 @@ dependencies:
         version: 0.0.12
     version: 
 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)
-email: balint@bucionrails.com
+email: jaimeiniesta@gmail.com
 executables: 
 - hashtag_retweet_bot
 extensions: []
@@ -92,7 +93,8 @@ files:
 - Rakefile
 - README.markdown
 has_rdoc: false
-homepage: http://github.com/balinterdi/hashtag_retweet_bot
+homepage: http://github.com/jaimeiniesta/hashtag_retweet_bot
+licenses: 
 post_install_message: 
 rdoc_options: 
 - --line-numbers
@@ -118,7 +120,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: hashtag_retweet_bot
-rubygems_version: 1.2.0
+rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
 summary: 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)