remi-tweet-tweet 0.1.0

data/README.markdown

@@ -0,0 +1,59 @@
+tweet-tweet
+===========
+
+tweet-tweet is a little script/utility that, when run, will perform any 
+user-defined functions such as popping up new tweets via Growl/etc
+
+Install
+-------
+
+    $ sudo gem sources --add http://gems.github.com
+    $ sudo gem install remi-tweet-tweet
+
+Usage
+-----
+
+    $ tweet-tweet
+
+The first time tweet-tweet is run, it'll ask you for your twitter username and password.
+
+Your username/password are encrypted and stored in ~/.tweettweet/auth
+
+To manually set your username/password or reset them, run:
+
+    $ tweet-tweet-setup
+
+How does it work?
+-----------------
+
+the idea is really simple.  the latest tweets get passed to user-defined 
+functions (which you can define in your ~/.tweettweetrc
+
+to use the functions that come out-of-the-box with tweet-tweet, you can 
+simply require them in your ~/.tweettweetrc, like so:
+
+    require 'tweet-tweet/growl'
+    require 'tweet-tweet/gnome'
+
+    def print_tweet tweet
+      puts "#{ tweet.user.name }: #{ tweet.text }"
+    end    
+
+    TweetTweet.tweeters << :print_tweet
+
+    TweetTweet.tweeters << lambda { |tweet| puts "#{ tweet.user.name } says '#{ tweet.text }'" }
+
+if you don't put anything in ~/.tweettweetrc, 'tweet-tweet/echo' will automatically be 
+required (a simple 'tweeter' which simply prints out the tweets)
+
+tweet-tweet stores your latest tweets in ~/.tweettweet as well as 
+resources like local copies of users' avatars
+
+to run tweet-tweet once, simply:
+
+    $ tweet-tweet
+
+for now, i'm not writing a deamon for tweet-tweet.  it's recommended 
+to run tweet-tweet via `watch`.  to run once every minute:
+
+    $ watch -n 60 tweet-tweet

data/TODO

@@ -0,0 +1 @@
+ * move all encryption randomness to a class to abstract away the OpenSSL usage

data/bin/tweet-tweet

@@ -0,0 +1,3 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../lib/tweet-tweet'
+TweetTweet.run

data/bin/tweet-tweet-setup

@@ -0,0 +1,3 @@
+#! /usr/bin/env ruby
+require File.dirname(__FILE__) + '/../lib/tweet-tweet'
+TweetTweet.set_login_info *TweetTweet.get_login_info

data/lib/tweet-tweet.rb

@@ -0,0 +1,188 @@
+$:.unshift File.dirname(__FILE__)
+
+require 'rubygems'
+
+class TweetTweet
+  BASE_DIR = File.expand_path '~/.tweettweet'
+  RC_FILE  = File.expand_path '~/.tweettweetrc'
+
+  class << self
+    # an array of methods / lambdas / whatever for passing the latest tweets to, one at a time
+    attr_accessor :tweeters
+  end
+
+  # runs 'tweet-tweet'
+  #
+  # gets latest tweets and, for each, passes them to TweetTweet.tweeters
+  def self.run
+    require 'twitter'
+    tweets = Twitter::Base.new(*TweetTweet.login_info).timeline
+    new_tweets = get_new tweets
+    puts "#{ new_tweets.length } new tweets"
+    save_images new_tweets
+    new_tweets.each do |tweet|
+      TweetTweet.tweeters.each do |tweeter|
+        run_tweeter tweeter, tweet
+      end
+    end
+    mark_as_read new_tweets
+  end
+
+  # runs a 'tweeter' given a tweet ... calls anything that responds_to #call, else assumes the name of a method
+  def self.run_tweeter tweeter, tweet
+    if tweeter.respond_to?:call
+      tweeter.call tweet
+    else
+      send tweeter.to_s, tweet
+    end
+  end
+
+  # returns Twitter client
+  def self.twitter
+    require 'twitter'
+    Twitter::Base.new(*TweetTweet.login_info)
+  end
+
+  # returns current twitter timeline
+  def self.timeline
+    twitter.timeline
+  end
+
+  # returns the path on the local filesystem for a particular tweet's avatar
+  def self.path_to_image tweet
+    File.join avatar_image_dir, "#{ tweet.user.screen_name }.jpg"
+  end
+  
+  # saves avatars for tweets if we don't have them already
+  def self.save_images tweets
+    %w( open-uri fileutils ).each { |lib| require lib }
+    FileUtils.mkdir_p avatar_image_dir
+    tweets.each do |tweet|
+      unless File.file?path_to_image(tweet)
+        File.open(path_to_image(tweet),'w'){ |f| f << open(tweet.user.profile_image_url).read }
+      end
+    end
+  end
+
+  # returns the path on the local filesystem for a particular tweet
+  def self.path_to_tweet tweet
+    File.join tweet_dir, tweet.id.to_s
+  end
+
+  # returns an array of tweets that are new (haven't been read before), given an array of tweets
+  def self.get_new tweets
+    tweets.select { |tweet| !File.file? path_to_tweet(tweet) }
+  end
+
+  # takes a list of tweets and marks them all as having been seen so they won't be returned anymore by get_new
+  def self.mark_as_read tweets
+    %w( open-uri fileutils ).each { |lib| require lib }
+    FileUtils.mkdir_p tweet_dir
+    get_new(tweets).each { |tweet| FileUtils.touch path_to_tweet(tweet) }
+  end
+
+  # directory where user's avatars are stored
+  def self.avatar_image_dir
+    File.join TweetTweet::BASE_DIR, 'images'
+  end
+
+  # directory where previously read tweets are stored
+  def self.tweet_dir
+    File.join TweetTweet::BASE_DIR, 'tweets'
+  end
+
+  # file where we persist login information
+  def self.auth_file
+    File.join TweetTweet::BASE_DIR, 'auth'
+  end
+
+  def self.decrypt ciphertext, key, iv
+    require 'openssl'
+
+    cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc')  
+    cipher.decrypt
+    cipher.key = key
+    cipher.iv  = iv
+
+    plaintext =  cipher.update ciphertext
+    plaintext << cipher.final
+    plaintext
+  end
+
+  def self.get_random_key
+    require 'openssl'
+    OpenSSL::Cipher::Cipher.new('aes-256-cbc').random_key
+  end
+  
+  def self.get_random_iv
+    require 'openssl'
+    OpenSSL::Cipher::Cipher.new('aes-256-cbc').random_iv
+  end
+
+  def self.encrypt plaintext, key, iv
+    require 'openssl'
+
+    cipher = OpenSSL::Cipher::Cipher.new('aes-256-cbc')
+    cipher.encrypt
+    cipher.key = key
+    cipher.iv  = iv
+
+    encrypted =  cipher.update plaintext
+    encrypted << cipher.final
+  end
+
+  # gets the currently persisted login information, decrypted
+  def self.login_info
+    TweetTweet.set_login_info(*TweetTweet.get_login_info) unless File.file?TweetTweet::auth_file
+
+    require 'yaml'
+
+    auth = YAML::load(File.read(TweetTweet::auth_file))
+    key, iv = auth[:random]
+
+    username = decrypt auth[:username], key, iv
+    password = decrypt auth[:password], key, iv
+
+    return username, password
+  end
+
+  # prompts user for their login info
+  def self.get_login_info
+    print 'Twitter Username: '
+    username = gets.strip
+
+    print 'Twitter Password: '
+    system "stty -echo"
+    password = gets.strip
+    system "stty echo" 
+    puts ''
+
+    return username, password
+  end
+
+  # encrypts and persists login information
+  def self.set_login_info username, password
+    %w( yaml openssl fileutils ).each { |lib| require lib }
+    
+    key = get_random_key
+    iv  = get_random_iv
+
+    encrypted_username = encrypt username, key, iv
+    encrypted_password = encrypt password, key, iv
+
+    auth = {
+      :username => encrypted_username,
+      :password => encrypted_password,
+      :random   => [ key, iv ]
+    } 
+
+    FileUtils.mkdir_p File.dirname(TweetTweet::auth_file)
+    File.open(TweetTweet::auth_file,'w'){ |f| f << auth.to_yaml }
+  end
+end
+
+TweetTweet.tweeters ||= []
+
+eval File.read(TweetTweet::RC_FILE) if File.file? TweetTweet::RC_FILE
+
+require 'tweet-tweet/echo' if TweetTweet.tweeters.empty?

data/lib/tweet-tweet/echo.rb

@@ -0,0 +1,3 @@
+# simple tweeter to simply echo (puts) tweet
+
+TweetTweet.tweeters << lambda { |tweet| puts "#{ tweet.user.name }: #{ tweet.text }" }

data/lib/tweet-tweet/gnome.rb

@@ -0,0 +1,27 @@
+class TweetTweet::GnomeNotify
+
+  EXPIRATION_IN_SECONDS = 2 
+
+  # Convenience method to send an error notification message
+  #
+  # [stock_icon]   Stock icon name of icon to display
+  # [title]        Notification message title
+  # [message]      Core message for the notification
+  def self.notify icon, title, message
+    options = "-t #{EXPIRATION_IN_SECONDS * 1000} -i '#{icon}'"
+    system "notify-send #{options} '#{title}' '#{message}'"
+  end 
+
+  # method for poping up a new tweet notification
+  def self.tweet tweet
+    notify TweetTweet.path_to_image(tweet), tweet.user.name, tweet.text
+  end
+
+  # make this #callable
+  def self.call tweet
+    self.tweet tweet
+  end
+
+end
+
+TweetTweet.tweeters << TweetTweet::GnomeNotify

data/tweet-tweet.gemspec

@@ -0,0 +1,21 @@
+Gem::Specification.new do |s|
+  s.name = "tweet-tweet"
+  s.version = "0.1.0"
+  s.date = "2008-06-19"
+  s.summary = "Custom Twitter Notifications"
+  s.email = "remi@remitaylor.com"
+  s.homepage = "http://github.com/remi/tweet-tweet"
+  s.description = "Twitter notifier for performing actions when there are new tweets"
+  s.has_rdoc = true
+  s.rdoc_options = ["--quiet", "--title", "domain-finder", "--opname", "index.html", "--line-numbers", "--main", "README", "--inline-source"]
+  s.extra_rdoc_files = ['README']
+  s.authors = ["remi Taylor"]
+
+  s.add_dependency("twitter", ["> 0.0.0"])
+  s.executables = ["tweet-tweet","tweet-tweet-setup"]
+  s.default_executable = "tweet-tweet"
+
+  # generate using: $ ruby -e "puts Dir['**/**'].select{|x| File.file?x}.inspect"
+  s.files = ["bin/tweet-tweet", "bin/tweet-tweet-setup", "lib/tweet-tweet/echo.rb", "lib/tweet-tweet/gnome.rb", "lib/tweet-tweet.rb", "README.markdown", "TODO", "tweet-tweet.gemspec"]
+
+end

metadata

@@ -0,0 +1,78 @@
+--- !ruby/object:Gem::Specification 
+name: remi-tweet-tweet
+version: !ruby/object:Gem::Version 
+  version: 0.1.0
+platform: ruby
+authors: 
+- remi Taylor
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2008-06-19 00:00:00 -07:00
+default_executable: tweet-tweet
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">"
+      - !ruby/object:Gem::Version 
+        version: 0.0.0
+    version: 
+description: Twitter notifier for performing actions when there are new tweets
+email: remi@remitaylor.com
+executables: 
+- tweet-tweet
+- tweet-tweet-setup
+extensions: []
+
+extra_rdoc_files: 
+- README
+files: 
+- bin/tweet-tweet
+- bin/tweet-tweet-setup
+- lib/tweet-tweet/echo.rb
+- lib/tweet-tweet/gnome.rb
+- lib/tweet-tweet.rb
+- README.markdown
+- TODO
+- tweet-tweet.gemspec
+- README
+has_rdoc: true
+homepage: http://github.com/remi/tweet-tweet
+post_install_message: 
+rdoc_options: 
+- --quiet
+- --title
+- domain-finder
+- --opname
+- index.html
+- --line-numbers
+- --main
+- README
+- --inline-source
+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.0.1
+signing_key: 
+specification_version: 2
+summary: Custom Twitter Notifications
+test_files: []
+