rtbot 0.1.0

data/.document

@@ -0,0 +1,5 @@
+README.rdoc
+lib/**/*.rb
+bin/*
+features/**/*.feature
+LICENSE

data/.gitignore

@@ -0,0 +1,24 @@
+## MAC OS
+.DS_Store
+
+## TEXTMATE
+*.tmproj
+tmtags
+
+## EMACS
+*~
+\#*
+.\#*
+
+## VIM
+*.swp
+
+## PROJECT::GENERAL
+coverage
+rdoc
+pkg
+
+## PROJECT::SPECIFIC
+*.yml
+*.last_id
+*.log

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2010 John Daniels
+
+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/README.rdoc

@@ -0,0 +1,29 @@
+= RTBot
+
+RTBot is a simple way to make a Twitter retweeting bot.
+
+You just call the 'rtbot' script and pass it the path to a YAML file with the configuration for the bot.
+It does a Twitter search and retweets anything that matches.
+
+After I wrote a script to do this the second time, I decided to make the third time much easier.
+
+See config.yml.example for details on the configuration file.
+
+= Example
+
+Command:
+
+ rtbot --config=/home/john/bots/scotfail.yml
+
+scotfail.yml:
+
+ consumer_key: 'actualconsumerkey' # consumer key from your Twitter app
+ consumer_secret: 'actualconsumersecret' # consumer secret from your Twitter app
+ access_token: 'actualaccesstoken' # access token from your Twitter app
+ access_token_secret: 'actualaccesstokensecret' # access token secret from your Twitter app
+ bot_name: 'scotfail' # Username of Twitter bot - used to prevent self-retweeting.
+ search_query: '#scotfail' # The Twitter search term
+
+== Copyright
+
+Copyright (c) 2010 John Daniels. See LICENSE for details.

data/Rakefile

@@ -0,0 +1,54 @@
+require 'rubygems'
+require 'rake'
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gem|
+    gem.name = "rtbot"
+    gem.summary = %Q{A simple Twitter RTing bot.}
+    gem.description = %Q{Provides an rtbot script which you can configure to make a very simply Twitter retweeting bot.}
+    gem.email = "john@semantici.st"
+    gem.homepage = "http://github.com/johnd/rtbot"
+    gem.authors = ["John Daniels"]
+    gem.add_dependency "twitter", ">= 0"
+    gem.add_dependency "activesupport", ">= 2"
+    # gem is a Gem::Specification... see http://www.rubygems.org/read/chapter/20 for additional settings
+  end
+  Jeweler::GemcutterTasks.new
+rescue LoadError
+  puts "Jeweler (or a dependency) not available. Install it with: gem install jeweler"
+end
+
+require 'rake/testtask'
+Rake::TestTask.new(:test) do |test|
+  test.libs << 'lib' << 'test'
+  test.pattern = 'test/**/test_*.rb'
+  test.verbose = true
+end
+
+begin
+  require 'rcov/rcovtask'
+  Rcov::RcovTask.new do |test|
+    test.libs << 'test'
+    test.pattern = 'test/**/test_*.rb'
+    test.verbose = true
+  end
+rescue LoadError
+  task :rcov do
+    abort "RCov is not available. In order to run rcov, you must: sudo gem install spicycode-rcov"
+  end
+end
+
+task :test => :check_dependencies
+
+task :default => :test
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "rtbot #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.1.0

data/bin/rtbot

@@ -0,0 +1,25 @@
+#!/usr/bin/env ruby
+# RTBot
+
+require 'rubygems'
+require "#{File.dirname(__FILE__)}/../lib/rtbot"
+require 'getoptlong'
+
+opts = GetoptLong.new(['--config', '-c', GetoptLong::REQUIRED_ARGUMENT])
+
+yaml_file_path = nil
+
+opts.each do | opt, arg |
+  if opt == '--config'
+    if arg == ''
+      puts "Config File arugment is required."
+      exit 0
+    else
+      yaml_file_path = arg
+    end
+  end
+end
+
+rtbot = RTBot.new(yaml_file_path)
+rtbot.run!
+exit

data/config.yml.example

@@ -0,0 +1,6 @@
+consumer_key: 'abc123def456ghi789' # consumer key from your Twitter app
+consumer_secret: 'abc123def456ghi789jkl012mno345pqr678' # consumer secret from your Twitter app
+access_token: '12345678-abc123def456ghi789jkl012mno345pqr678' # access token from your Twitter app
+access_token_secret: 'abc123def456ghi789' # access token secret from your Twitter app
+bot_name: 'scotfail' # Username of Twitter bot - used to prevent self-retweeting.
+search_query: '#scotfail' # The Twitter search term

data/lib/rtbot.rb

@@ -0,0 +1,73 @@
+require 'twitter'
+require 'active_support'
+
+class RTBot
+  
+  def initialize(yaml_file_path)
+    @config = YAML.load(File.read(yaml_file_path))
+    @config['last_id_path'] = "#{File.basename(yaml_file_path, File.extname(yaml_file_path))}.last_id" unless @config['last_id_path']
+    @config['log_path'] = "#{File.basename(yaml_file_path, File.extname(yaml_file_path))}.log" unless @config['log_path']
+    
+    if File.exists?(@config['last_id_path'])
+      @last_read_id = File.new(@config['last_id_path'], 'r').gets
+    else
+      @last_read_id = 1
+    end
+    
+  end
+  
+  def test_run
+    log = File.new(@config['log_path'], 'a')
+    
+    log.puts "Test run at #{Time.now}"
+    
+    search.each do | tweet |
+      log.puts tweet_text = "RT @#{tweet.from_user}: #{tweet.text}".first(139)
+    end  
+    
+    log.close
+    
+  end
+  
+  def run!
+    @log = File.new(@config['log_path'], 'a')
+    
+    tweet authenticate, search
+    
+    @log.close
+  end
+  
+  
+  
+  private
+  
+  def authenticate
+    oauth = Twitter::OAuth.new(@config['consumer_key'], @config['consumer_secret'])
+    oauth.authorize_from_access(@config['access_token'], @config['access_token_secret'])
+    return oauth
+  end
+  
+  def search
+    Twitter::Search.new(@config['search_query']).since(@last_read_id).since_date(Date.today.strftime("%Y-%m-%d")).from(@config['bot_name'],true).to_a.reverse
+  end
+  
+  def tweet(oauth,results)
+    
+    
+    @log.puts Time.now
+    
+    results.each do | tweet |
+      client = Twitter::Base.new(oauth)
+      
+      @log.puts tweet_text = "RT @#{tweet.from_user}: #{tweet.text}".first(139)
+      client.update(tweet_text)
+      @last_read_id = tweet.id
+    end
+    
+    output = File.new(@config['last_id_path'], 'w')
+    output.write @last_read_id
+    output.close
+    
+  end
+  
+end

data/test/helper.rb

@@ -0,0 +1,10 @@
+require 'rubygems'
+require 'test/unit'
+require 'shoulda'
+
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+require 'rtbot'
+
+class Test::Unit::TestCase
+end

data/test/test_rtbot.rb

@@ -0,0 +1,7 @@
+require 'helper'
+
+class TestRtbot < Test::Unit::TestCase
+  should "probably rename this file and start testing for real" do
+    flunk "hey buddy, you should probably rename this file and start testing for real"
+  end
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification 
+name: rtbot
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- John Daniels
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-07-26 00:00:00 +01:00
+default_executable: rtbot
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 2
+        version: "2"
+  type: :runtime
+  version_requirements: *id002
+description: Provides an rtbot script which you can configure to make a very simply Twitter retweeting bot.
+email: john@semantici.st
+executables: 
+- rtbot
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+- README.rdoc
+files: 
+- .document
+- .gitignore
+- LICENSE
+- README.rdoc
+- Rakefile
+- VERSION
+- bin/rtbot
+- config.yml.example
+- lib/rtbot.rb
+- test/helper.rb
+- test/test_rtbot.rb
+has_rdoc: true
+homepage: http://github.com/johnd/rtbot
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+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: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.6
+signing_key: 
+specification_version: 3
+summary: A simple Twitter RTing bot.
+test_files: 
+- test/helper.rb
+- test/test_rtbot.rb