neufelry-twitter-sms 0.2

data/README.md

@@ -0,0 +1,32 @@
+twitter-sms: Twitter SMS for the rest of us.
+=======================================
+
+Twitter-sms bridges the gap left by Twitter.com when it removed SMS capability for many countries. Twitter-sms runs in the background and periodically checks Twitter for new tweets; When new tweets are found they are forwarded via a gmail account to your mobile phone's email address. 
+
+All it requires is:
+* A running computer with internet access and Ruby installed. (*nix systems only for the moment.),
+* A google email address (to forward messages from) and,
+* An SMS capable phone with an email-to-sms email address. (i.e. 12345551234@text.provider.net that automatically forwards messages to your phone as SMS)
+
+DISCLAIMER: Please bear in mind that it MAY cost you to receive text message on your email address; I am not responsable for any costs incurred to you using this program.
+
+Setup
+-----
+To use twitter-sms you will need only to create the config file "~/.twitter-sms.conf" and fill it with the necessary YAML mappings.
+
+Here is an example conf:
+
+    bot:
+      email: "twitter.bot@gmail.com"
+      password: p0n33zR0oL
+    user:
+      name: rkneufeld
+      password: p0n33zR0oL
+      phone: "12045555555@text.provider.net"
+    config:
+      per_hour: 12
+      keep_alive: true
+
+This config will cause the script to run forever; sending you the last 5 minutes tweets every 5 minutes. (60 / 5 == 12)
+
+One can also run the script as a cron job; instructions to follow soon...

data/bin/twitter-sms

@@ -0,0 +1,157 @@
+#!/opt/local/bin/ruby
+require 'rubygems'
+require 'twitter'
+require 'tlsmail'
+require 'optparse'
+require 'cgi'
+
+SEC_PER_HOUR = 3600 # Seconds per hour
+
+# Put Debug (prepend time)
+def putd (message)
+  puts "#{Time.now.strftime("(%b %d - %H:%M:%S)")} #{message}"
+end
+
+class TwitterSms
+
+  def initialize(config_file="#{ENV['HOME'] + '/.twitter-sms.conf'}", args=ARGV)
+    load_config(config_file)
+    load_opts(args)
+
+    # Required for gmail smtp (and not a part of standalone Net::SMTP)
+    Net::SMTP.enable_tls(OpenSSL::SSL::VERIFY_NONE)
+  end
+
+  # Run the twitter-sms bot once or repeatedly, depending on config
+  def run
+    begin # do-while
+      load_config if config_stale?
+
+      tweets = update
+      send tweets unless tweets.nil?
+
+      if @config['keep_alive']
+        putd "Waiting for ~#{@config['wait']/60} minutes..."
+        Kernel.sleep @config['wait']
+      end
+    end while @config['keep_alive']
+  end
+
+  # Collect a list of recent tweets on a user's timeline (that are not their own)
+  def update
+    twitter = Twitter::Base.new(@user['name'],@user['password'])
+
+    begin
+      if twitter.rate_limit_status.remaining_hits > 0
+        now         = Time.now
+        tweets      = twitter.timeline(:friends, :since => @last_check)
+        @last_check = now
+
+        # Block own tweets if specified via settings
+        tweets.reject! {|t| t.user.screen_name == @user['name']} unless @config['own_tweets']
+        # Don't send messages from users under no_follow
+        tweets.reject! {|t| @config['no_follow'].member?(t.user.screen_name) }
+        tweets.reverse! # reverse-chronological
+      else
+        putd "Your account has run out of API calls; call not made."
+      end
+    rescue
+      putd "Error occured retreiving timeline. Perhaps Internet is down?"
+    end
+  end
+
+  # Email via Gmail SMTP any tweets to the desired cell phone
+  def send(tweets)
+    putd "Sending received tweets..."
+    begin
+      Net::SMTP.start('smtp.gmail.com', 587, 'gmail.com', @bot['email'], "tweeterbot", :login) do |smtp|
+        tweets.each do |tweet|
+          smtp.send_message(content(tweet),@bot['email'],@user['phone']) rescue putd "Error occured sending message:"
+          putd "\tSent: #{tweet.user.screen_name}: #{tweet.text[0..20]}..."
+        end
+      end
+      putd "Messages sent."
+    rescue
+      putd "Error occured starting smtp. Perhaps account info is incorrect or Internet is down?"
+    end
+  end
+
+  # Parse and store a config file (either as an initial load or as an update)
+  def load_config(config_file=@config_file['name'])
+    # Load config file -- Add try block here
+    config                  =  YAML.load_file(config_file)
+    @config_file            =  { 'name' => config_file,
+                          'modified_at' => File.mtime(config_file) }
+
+
+    # Seperate config hashes into easier to use parts
+    @user                    =  config['user']
+    @bot                     =  config['bot']
+    # Merge specified config onto defaults
+    default                  =  { 'own_tweets' => false,
+                                  'keep_alive' => true,
+                                    'per_hour' => 60}
+    @config                  =  config['config'].merge(default)
+
+    set_wait
+    @last_check = Time.now - @config['wait']
+  end
+
+  private
+
+  # Set wait time based on times per hour
+  def set_wait
+    @config['wait'] = SEC_PER_HOUR / @config['per_hour']
+  end
+
+  def load_opts(args)
+    opts = OptionParser.new do |opts|
+      opts.banner = "Twitter-sms bot help menu:\n"
+      opts.banner += "==========================\n"
+      opts.banner += "Usage #$0 [options]"
+
+      opts.on('-t', '--times-per-hour [TIMES]',
+              'Indicate the amount of times per hour to check (0 < TIMES <= 100)') do |times|
+        times = 100 if times > 100
+        times = 1 if times < 1 # once per hour minimum?
+        @config['per_hour'] = times
+      end
+
+      opts.on('-o', '--own-tweets',
+              "Makes your own tweets send in addition to followed account\'s tweets") do
+        @config['own_tweets'] = true
+      end
+
+      opts.on('-s', '--single-check',
+              'Forces the program to only check once, instead of continually') do
+        @config['keep_alive'] = false
+      end
+
+      opts.on_tail('-h', '--help', 'display this help and exit') do
+        puts opts
+        exit
+      end
+    end
+
+    opts.parse!(args)
+  end
+
+  def config_stale?
+    return File.mtime(@config_file['name']) > @config_file['modified_at']
+  end
+
+  def content(tweet)
+    "From: #{@bot['email']}\n"+
+    "To: #{@user['phone']}\n"+
+    "Date: #{Time.parse(tweet.created_at).rfc2822}\n\n"+
+    "#{tweet.user.screen_name}: #{CGI.escapeHTML(tweet.text)}"
+  end
+
+end
+
+# Run as program only if library is the running program
+if $0.split('/')[-1] == __FILE__.split('/')[-1] # Can anyone fix this idiom for me; I just know its wrong
+  # Add some logic for command line options
+  program = TwitterSms.new
+  program.run
+end

data/example.conf

@@ -0,0 +1,13 @@
+bot:
+  email: "twitter.bot@gmail.com"
+  password: p0n33zR0oL
+user:
+  name: rkneufeld
+  password: p0n33zR0oL
+  phone: "12045555555@text.provider.net"
+config:
+  per_hour: 12
+  keep_alive: true
+  no_follow:
+    - annoying_guy
+    - annoying_girl

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification 
+name: neufelry-twitter-sms
+version: !ruby/object:Gem::Version 
+  version: "0.2"
+platform: ruby
+authors: 
+- Ryan Neufeld
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-01-11 00:00:00 -08:00
+default_executable: 
+dependencies: []
+
+description: Twitter-SMS provides a persistent command line tool to send SMS updates to your mobile phone via a gmail account.
+email: neufelry@gmail.com
+executables: 
+- - twitter-sms
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- README.md
+- example.conf
+has_rdoc: false
+homepage: http://www.github.com/neufelry/twitter-sms
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.2.0
+signing_key: 
+specification_version: 2
+summary: Twitter-SMS lets you send SMS updates to your phone.
+test_files: []
+