twitter2jabber 0.0.2 → 0.0.3

data/README

@@ -2,7 +2,7 @@
 
 == VERSION
 
-This documentation refers to twitter2jabber version 0.0.2
+This documentation refers to twitter2jabber version 0.0.3
 
 
 == DESCRIPTION

data/Rakefile

@@ -15,7 +15,7 @@ begin
       :summary      => %q{Twitter-to-Jabber gateway.},
       :homepage     => %q{http://twitter2jabber.rubyforge.org/},
       :files        => FileList['lib/**/*.rb', 'bin/*'].to_a,
-      :extra_files  => FileList['[A-Z]*', 'sample/*'].to_a,
+      :extra_files  => FileList['[A-Z]*', 'sample/**/*'].to_a,
       :dependencies => %w[twitter xmpp4r-simple highline]
     }
   }}

data/TODO

@@ -1,4 +1,4 @@
-- persistent cache!
-- logging/debug output
-- extended tweet format
-- interrupt handling in loop mode
+- persistent cache! (friends_timeline: since/since_id?)
+- better interrupt handling (in loop mode)
+- daemonize after asking for credentials (in loop mode)
+- additional commands?

data/bin/twitter2jabber

@@ -46,12 +46,16 @@ rescue Interrupt
 end
 
 options = {
-  :config     => 'config.yaml',
-  :user       => nil,
-  :jid        => nil,
-  :recipients => [],
-  :loop       => false,
-  :pause      => nil
+  :config       => 'config.yaml',
+  :user         => nil,
+  :jid          => nil,
+  :recipients   => [],
+  :formats      => nil,
+  :template_dir => nil,
+  :loop         => false,
+  :pause        => nil,
+  :verbose      => false,
+  :debug        => false
 }
 
 OptionParser.new { |opts|
@@ -86,6 +90,17 @@ OptionParser.new { |opts|
 
   opts.separator ' '
 
+  opts.on('-f', '--formats LIST', "Comma-separated list of formats [Default: #{Twitter2Jabber::DEFAULT_FORMATS.join(',')}]") { |f|
+    options[:formats] = f.split(',')
+  }
+
+  opts.on('-t', '--template-dir PATH', 'Path to custom template directory', "[Default: #{Twitter2Jabber::DEFAULT_TEMPLATES}]") { |t|
+    abort "Template directory not found: #{t}" unless File.directory?(t)
+    options[:template_dir] = t
+  }
+
+  opts.separator ' '
+
   opts.on('-l', '--loop', 'Run in a loop') {
     options[:loop] = true
   }
@@ -97,6 +112,14 @@ OptionParser.new { |opts|
   opts.separator ' '
   opts.separator 'Generic options:'
 
+  opts.on('-v', '--verbose', 'Be verbose') {
+    options[:verbose] = true
+  }
+
+  opts.on('-D', '--debug', "Print debug output and don't send or update anything") {
+    options[:debug] = true
+  }
+
   opts.on('-h', '--help', 'Print this help message and exit') {
     puts opts
     exit
@@ -129,6 +152,10 @@ config[:jabber][:pass] ||= ask("Password for Jabber ID #{config[:jabber][:user]}
 recipients = options[:recipients] + (config.delete(:recipients) || [])
 recipients.uniq!
 
+[:formats, :template_dir, :verbose, :debug].each { |key|
+  config[key] = options[key] if options[key]
+}
+
 begin
   twitter2jabber = Twitter2Jabber.new(config)
 

data/lib/twitter2jabber/version.rb

@@ -4,7 +4,7 @@ class Twitter2Jabber
 
     MAJOR = 0
     MINOR = 0
-    TINY  = 2
+    TINY  = 3
 
     class << self
 

data/lib/twitter2jabber.rb

@@ -25,6 +25,7 @@
 #++
 
 require 'time'
+require 'erb'
 
 require 'rubygems'
 require 'twitter'
@@ -34,8 +35,17 @@ require 'twitter2jabber/version'
 
 class Twitter2Jabber
 
+  MAX_LENGTH = 140
+
   DEFAULT_PAUSE = 60
 
+  DEFAULT_FORMATS = %w[txt]
+
+  DEFAULT_TEMPLATES = File.expand_path(File.join(File.dirname(__FILE__), %w[.. sample templates]))
+
+  JABBER_NS = 'http://jabber.org/protocol/xhtml-im'
+  XHTML_NS  = 'http://www.w3.org/1999/xhtml'
+
   def self.loop(options, recipients = [], pause = nil, &block)
     new(options).loop(recipients, pause, &block)
   end
@@ -44,40 +54,65 @@ class Twitter2Jabber
     new(options).run(recipients, &block)
   end
 
-  attr_reader :twitter, :jabber, :filter
+  attr_reader :id, :verbose, :debug, :twitter, :jabber, :filter, :formats, :templates
 
   def initialize(options, &block)
     [:twitter, :jabber].each { |client|
       raise ArgumentError, "#{client} config missing" unless options[client].is_a?(Hash)
     }
 
+    @id = "#{options[:twitter][:user]} -> #{options[:jabber][:user]}"
+
+    @verbose = options[:verbose]
+    @debug   = options[:debug]
+
     @twitter = twitter_connect(options[:twitter])
     @jabber  = jabber_connect(options[:jabber])
 
-    @filter = options[:filter] || block
+    @filter  = options[:filter]  || block
+    @formats = options[:formats] || DEFAULT_FORMATS
+
+    @templates = Dir[
+      File.join(options[:template_dir] || DEFAULT_TEMPLATES, 'tweet.*')
+    ].inject({}) { |hash, template|
+      hash.update(File.extname(template).sub(/\A\./, '') => File.read(template))
+    }
   end
 
-  def run(recipients = [], seen = {}, &block)
-    deliver_tweets(recipients, seen, &block)
+  def run(recipients = [], seen = {}, flag = true, &block)
+    deliver_tweets(recipients, seen, &block) if flag
     post_messages
   end
 
   def loop(recipients = [], pause = nil, &block)
     pause ||= DEFAULT_PAUSE
 
-    seen = Hash.new { |h, k| h[k] = true; false }
+    # jabber/twitter ratio
+    ratio = 10
+    pause /= ratio
 
-    Kernel.loop {
-      run(recipients, seen, &block)
+    # sleep at least one second
+    pause = 1 if pause < 1
+
+    i, seen = 0, Hash.new { |h, k| h[k] = true; false }
+
+    trap(:INT) { i = nil }
+
+    while i
+      i += 1
+
+      run(recipients, seen, i % ratio == 1, &block)
 
       sleep pause
-    }
+    end
   end
 
   def deliver_tweets(recipients, seen = {}, &block)
     get_tweets.each { |tweet|
       next if seen[tweet.id]
 
+      logt tweet.id
+
       # apply filters
       next if filter && !filter[tweet]
       next if block  && !block[tweet]
@@ -85,19 +120,20 @@ class Twitter2Jabber
       msg = format_tweet(tweet)
 
       recipients.each { |recipient|
-        jabber.deliver(recipient, msg)
+        deliver(recipient, msg)
       }
 
       sleep 1
     }
-  rescue Twitter::CantConnect
-    sleep pause
-    retry
   end
 
   def post_messages
     jabber.received_messages { |msg|
-      twitter.update(msg.body) if msg.type == :chat
+      next unless msg.type == :chat
+
+      logj msg.id
+
+      handle_command(msg.body, msg.from)
     }
   end
 
@@ -109,25 +145,155 @@ class Twitter2Jabber
 
     # verify credentials
     client.verify_credentials
+
+    logt "connected #{Time.now}"
+
     client
   rescue Twitter::TwitterError => err
     raise "Can't connect to Twitter with ID '#{options[:user]}': #{err}"
   end
 
   def jabber_connect(options)
-    Jabber::Simple.new(options[:user], options[:pass])
+    client = Jabber::Simple.new(options[:user], options[:pass])
+
+    logj "connected #{Time.now}"
+
+    client
   rescue Jabber::JabberError => err
     raise "Can't connect to Jabber with JID '#{options[:user]}': #{err}"
   end
 
   def get_tweets
     twitter.friends_timeline.sort_by { |tweet|
-      Time.parse(tweet.created_at)
+      tweet.created_at = Time.parse(tweet.created_at)
     }
+  rescue Twitter::CantConnect
+    sleep pause
+    retry
   end
 
   def format_tweet(tweet)
-    "#{tweet.user.name} [#{tweet.created_at}]:\n\n#{tweet.text}"
+    user = tweet.user
+
+    msg = Jabber::Message.new.set_type(:chat)
+
+    formats.each { |format|
+      if template = templates[format]
+        msg.add_element format_element(format) {
+          ERB.new(template).result(binding)
+        }
+      end
+    }
+
+    msg
+  end
+
+  # cf. <http://devblog.famundo.com/articles/2006/10/18/ruby-and-xmpp-jabber-part-3-adding-html-to-the-messages>
+  def format_element(format)
+    body = REXML::Element.new('body')
+    REXML::Text.new(yield, format != 'html', body, true, nil, /.^/)
+
+    case format
+      when 'html'
+        html = REXML::Element.new('html').add_namespace(JABBER_NS)
+        html.add(body.add_namespace(XHTML_NS))
+        html
+      else
+        body
+    end
+  end
+
+  def handle_command(body, from, execute = true)
+    case body
+      when /\Ahe?(?:lp)?\z/i
+        deliver(from, <<-HELP) if execute
+h[e[lp]]            -- Print this help
+
+de[bug]             -- Print debug mode
+de[bug] on|off      -- Turn debug mode on/off
+
+bl[ock] #ID         -- Block ID
+fa[v[orite]] #ID    -- Create favorite #ID
+
+re[ply] #ID: ...    -- Reply to ID
+le[n[gth]] ...      -- Determine length
+...                 -- Update status
+
+(Note: Message body must be shorter than #{MAX_LENGTH} characters)
+        HELP
+      when /\Ade(?:bug)?(?:\s+(on|off))?\z/i
+        if execute
+          flag = $1.downcase if $1
+
+          case flag
+            when 'on'
+              @debug = true
+            when 'off'
+              @debug = false
+          end
+
+          deliver(from, "DEBUG = #{debug ? 'on' : 'off'}")
+        end
+      when /\Abl(?:ock)?\s+#?(\d+)\z/i
+        twitter.block($1) if execute && !debug
+      when /\Afav?(?:orite)?\s+#?(\d+)\z/i
+        twitter.favorite_create($1) if execute && !debug
+      else
+        options = {}
+
+        if execute && body.sub!(/\Alen?(?:gth)?\s+/i, '')
+          if body = handle_command(body, from, false)
+            length = body.length
+            hint   = length <= MAX_LENGTH ? 'OK' : 'TOO LONG'
+
+            deliver(from, "#{length} [#{hint}]: #{body}")
+          end
+
+          return
+        end
+
+        if body.sub!(/\Are(?:ply)?\s+#?(\d+):?\s+/i, '')
+          options[:in_reply_to_status_id] = $1
+        end
+
+        return body unless execute
+
+        if body.length <= MAX_LENGTH
+          update(body, options)
+        else
+          deliver(from, "MSG TOO LONG (> #{MAX_LENGTH}): #{body}")
+        end
+    end
+  end
+
+  def deliver(recipient, msg)
+    if debug
+      logj "#{recipient}: #{msg}", true
+      return
+    end
+
+    jabber.deliver(recipient, msg)
+  end
+
+  def update(msg, options = {})
+    if debug
+      logt "#{msg} (#{options.inspect})", true
+      return
+    end
+
+    twitter.update(msg, options)
+  end
+
+  def log(msg, verbose = verbose)
+    warn "[#{id}] #{msg}" if verbose
+  end
+
+  def logt(msg, verbose = verbose)
+    log("TWITTER #{msg}", verbose)
+  end
+
+  def logj(msg, verbose = verbose)
+    log("JABBER #{msg}", verbose)
   end
 
 end

data/sample/templates/tweet.html

@@ -0,0 +1,7 @@
+<%= user.name %>
+(<a href="http://twitter.com/<%= user.screen_name %>"><%= user.screen_name %></a>)
+[<%= tweet.created_at %>]:
+<br /><br />
+<img src="<%= user.profile_image_url %>" alt="[<%= user.screen_name %>]" />
+<%= tweet.text %>
+| #<%= tweet.id %>

data/sample/templates/tweet.txt

@@ -0,0 +1,3 @@
+<%= user.name %> (<%= user.screen_name %>) [<%= tweet.created_at %>]:
+
+<%= tweet.text %> | #<%= tweet.id %>

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: twitter2jabber
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.0.3
 platform: ruby
 authors: 
 - Jens Wille
@@ -9,7 +9,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2009-07-29 00:00:00 +02:00
+date: 2009-08-02 00:00:00 +02:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -62,6 +62,8 @@ files:
 - ChangeLog
 - TODO
 - sample/config.yaml
+- sample/templates/tweet.html
+- sample/templates/tweet.txt
 has_rdoc: true
 homepage: http://twitter2jabber.rubyforge.org/
 licenses: []