neufelry-twitter-sms 0.3.0 → 0.3.1

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/VERSION.yml

@@ -0,0 +1,4 @@
+--- 
+:minor: 3
+:patch: 1
+:major: 0

data/lib/twitter-sms/twitter-sms.rb

@@ -0,0 +1,193 @@
+require 'rubygems'
+require 'twitter'
+require 'tlsmail'
+require 'optparse'
+require 'cgi'
+require 'net/pop'
+
+if RUBY_VERSION < "1.9"
+  raise "Version too low. Please get Ruby 1.9"
+end
+
+SEC_PER_HOUR = 3600 # Seconds per hour (don't like this...)
+
+class TwitterSms
+
+  def initialize(config_file="#{ENV['HOME'] + '/.twitter-sms.conf'}", args=ARGV)
+    load_config(config_file)
+    load_opts(args) # Loaded options are intended to overide defaults
+
+    # 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? unless @config['dont_refresh']
+
+      if @config['active']
+        tweets = update
+        send tweets unless tweets.nil?
+      end
+
+      if @config['keep_alive']
+        putd "Waiting for ~#{@config['wait']/60.0} minutes..."
+        Kernel.sleep @config['wait']
+      end
+    end while @config['keep_alive']
+    tweets # Return the last set of tweets we get
+  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
+      # Start smtp connection to provided bot email
+      Net::SMTP.start('smtp.gmail.com', 587, 'gmail.com',
+                      @bot['email'], @bot['password'], :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
+
+  private
+
+  # Put Debug (prepend time) if debug printouts turned on
+  def putd (message)
+    puts "#{Time.now.strftime("(%b %d - %H:%M:%S)")} #{message}" if @config['debug']
+  end
+
+  def collect_pop_messages
+    Net::POP3.enable_ssl(OpenSSL::SSL::VERIFY_NONE) # maybe verify...
+    Net::POP3.start('pop.gmail.com',995, @bot['email'], @bot['password']) do |pop|
+      pop.each_mail do |mail|
+        process_pop_message(mail)
+      end
+    end
+  end
+
+  def process_pop_message(msg)
+    p mail.inspect
+  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
+    loaded_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                    =  loaded_config['user']
+    @bot                     =  loaded_config['bot']
+
+    config_defaults          = { 'own_tweets' => false,
+                                  'keep_alive' => true,
+                                    'per_hour' => 30,
+                                       'debug' => false,
+                                'dont_refresh' => false,
+                                      'active' => true}
+
+    # Merge specified config onto defaults
+    @config                  = config_defaults.merge(loaded_config['config'])
+
+    set_wait
+    @last_check = Time.now - @config['wait']
+    putd "Loaded config file"
+  end
+
+  # 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]"
+
+      # The problem with this is if the asked for config file doesn't exist
+      opts.on('-c', '--config-file [FILE]',
+              'Location of the config file to be loaded') do |filename|
+        load_config(filename)
+      end
+
+      opts.on('-t', '--times-per-hour [TIMES]',
+              'Indicate the amount of times per hour to check (> 0)') do |times|
+        times = 1 if times <= 0
+        @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
+
+  # Produce the content of the SMTP message to be sent
+  def content(tweet)
+    "From: #{@bot['email']}\n"+
+    "To: #{@user['phone']}\n"+
+    #On date line 2 '\n's are required for proper message
+    "Date: #{Time.parse(tweet.created_at).rfc2822}\n\n"+
+    "#{tweet.user.screen_name}: #{CGI.escapeHTML(tweet.text)}"
+  end
+
+end
+
+def filename(path)
+  path.split('/')[-1]
+end
+

data/test/test_helper.rb

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

data/test/twitter_sms_test.rb

@@ -0,0 +1,7 @@
+require File.dirname(__FILE__) + '/test_helper'
+
+class TwitterSmsTest < 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

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: neufelry-twitter-sms
 version: !ruby/object:Gem::Version 
-  version: 0.3.0
+  version: 0.3.1
 platform: ruby
 authors: 
 - Ryan Neufeld
@@ -39,7 +39,13 @@ extensions: []
 extra_rdoc_files: []
 
 files: 
+- README.md
+- VERSION.yml
 - bin/twitter-sms
+- lib/twitter-sms
+- lib/twitter-sms/twitter-sms.rb
+- test/test_helper.rb
+- test/twitter_sms_test.rb
 has_rdoc: true
 homepage: http://github.com/neufelry/twitter-sms
 post_install_message: