blackwinter-twitter2jabber 0.0.4

data/README

@@ -0,0 +1,43 @@
+= twitter2jabber - Twitter-to-Jabber gateway.
+
+== VERSION
+
+This documentation refers to twitter2jabber version 0.0.4
+
+
+== DESCRIPTION
+
+Twitter-to-Jabber gateway.
+
+Based on a script[http://da.nmilne.com/?p=353] by dkam. See also his
+Jitter[http://github.com/dkam/jitter] project.
+
+
+== LINKS
+
+<b></b>
+Documentation::     <http://twitter2jabber.rubyforge.org/>
+Source code::       <http://github.com/blackwinter/twitter2jabber>
+Rubyforge project:: <http://rubyforge.org/projects/twitter2jabber>
+
+
+== AUTHORS
+
+* Jens Wille <mailto:ww@blackwinter.de>
+
+
+== LICENSE AND COPYRIGHT
+
+Copyright (C) 2009 Jens Wille
+
+twitter2jabber is free software: you can redistribute it and/or modify it
+under the terms of the GNU General Public License as published by the Free
+Software Foundation, either version 3 of the License, or (at your option)
+any later version.
+
+twitter2jabber is distributed in the hope that it will be useful, but WITHOUT
+ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
+FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+
+You should have received a copy of the GNU General Public License along with
+twitter2jabber. If not, see <http://www.gnu.org/licenses/>.

data/Rakefile

@@ -0,0 +1,26 @@
+require %q{lib/twitter2jabber/version}
+
+begin
+  require 'hen'
+
+  Hen.lay! {{
+    :rubyforge => {
+      :project  => %q{twitter2jabber},
+      :package  => %q{twitter2jabber},
+      :rdoc_dir => nil
+    },
+
+    :gem => {
+      :version      => Twitter2Jabber::VERSION,
+      :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,
+      :dependencies => %w[twitter xmpp4r-simple highline]
+    }
+  }}
+rescue LoadError
+  abort "Please install the 'hen' gem first."
+end
+
+### Place your custom Rake tasks here.

data/TODO

@@ -0,0 +1,4 @@
+- 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

@@ -0,0 +1,169 @@
+#! /usr/bin/ruby
+
+#--
+###############################################################################
+#                                                                             #
+# twitter2jabber - Twitter-to-Jabber gateway.                                 #
+#                                                                             #
+# Copyright (C) 2009 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <ww@blackwinter.de>                                          #
+#                                                                             #
+# twitter2jabber is free software; you can redistribute it and/or modify it   #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# twitter2jabber is distributed in the hope that it will be useful, but       #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with twitter2jabber. If not, see <http://www.gnu.org/licenses/>.            #
+#                                                                             #
+###############################################################################
+#++
+
+require 'optparse'
+require 'yaml'
+
+require 'rubygems'
+require 'highline/import'
+
+$: << File.join(File.dirname(__FILE__), '..', 'lib')
+
+require 'twitter2jabber'
+
+USAGE = "Usage: #{$0} [-h|--help] [options]"
+
+def ask(prompt)
+  super
+rescue Interrupt
+  puts
+  exit
+end
+
+options = {
+  :config       => 'config.yaml',
+  :user         => nil,
+  :jid          => nil,
+  :recipients   => [],
+  :formats      => nil,
+  :template_dir => nil,
+  :loop         => false,
+  :pause        => nil,
+  :verbose      => false,
+  :debug        => false
+}
+
+OptionParser.new { |opts|
+  opts.banner = USAGE
+
+  opts.separator ' '
+  opts.separator 'Options:'
+
+  opts.on('-c', '--config YAML', "Path to config file [Default: #{options[:config]}]") { |c|
+    options[:config] = c
+  }
+
+  opts.separator ' '
+
+  opts.on('-u', '--user NAME', 'Twitter user') { |u|
+    options[:user] = u
+  }
+
+  opts.on('-j', '--jid ID', 'Jabber ID') { |j|
+    options[:jid] = j
+  }
+
+  opts.separator ' '
+
+  opts.on('-r', '--recipients LIST', 'Comma-separated list of Jabber IDs') { |r|
+    options[:recipients] += r.split(',')
+  }
+
+  opts.on('-R', '--recipients-from-file FILE', 'File with one Jabber ID per line') { |r|
+    options[:recipients] += File.readlines(r).map { |l| l.chomp }
+  }
+
+  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
+  }
+
+  opts.on('-p', '--pause SECONDS', Integer, 'Number of seconds to pause between loops') { |p|
+    options[:pause] = p
+  }
+
+  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
+  }
+
+  opts.on('--version', 'Print program version and exit') {
+    puts "#{File.basename($0)} v#{Twitter2Jabber::VERSION}"
+    exit
+  }
+}.parse!
+
+config = begin
+  YAML.load_file(options[:config])
+rescue Errno::ENOENT
+  {}
+end
+
+# twitter config
+config[:twitter] ||= {}
+config[:twitter][:user] = options[:user] if options[:user]
+config[:twitter][:user] ||= ask('Twitter user: ')
+config[:twitter][:pass] ||= ask("Password for Twitter user #{config[:twitter][:user]}: ") { |q| q.echo = false }
+
+# jabber config
+config[:jabber] ||= {}
+config[:jabber][:user] = options[:jid] if options[:jid]
+config[:jabber][:user] ||= ask('Jabber ID: ')
+config[:jabber][:pass] ||= ask("Password for Jabber ID #{config[:jabber][:user]}: ") { |q| q.echo = false }
+
+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)
+
+  if options[:loop]
+    twitter2jabber.loop(recipients, options[:pause] || config[:pause])
+  else
+    twitter2jabber.run(recipients)
+  end
+rescue RuntimeError => err
+  abort err
+end

data/lib/twitter2jabber/version.rb

@@ -0,0 +1,27 @@
+class Twitter2Jabber
+
+  module Version
+
+    MAJOR = 0
+    MINOR = 0
+    TINY  = 4
+
+    class << self
+
+      # Returns array representation.
+      def to_a
+        [MAJOR, MINOR, TINY]
+      end
+
+      # Short-cut for version string.
+      def to_s
+        to_a.join('.')
+      end
+
+    end
+
+  end
+
+  VERSION = Version.to_s
+
+end

data/lib/twitter2jabber.rb

@@ -0,0 +1,299 @@
+#--
+###############################################################################
+#                                                                             #
+# twitter2jabber - Twitter-to-Jabber gateway.                                 #
+#                                                                             #
+# Copyright (C) 2009 Jens Wille                                               #
+#                                                                             #
+# Authors:                                                                    #
+#     Jens Wille <ww@blackwinter.de>                                          #
+#                                                                             #
+# twitter2jabber is free software; you can redistribute it and/or modify it   #
+# under the terms of the GNU General Public License as published by the Free  #
+# Software Foundation; either version 3 of the License, or (at your option)   #
+# any later version.                                                          #
+#                                                                             #
+# twitter2jabber is distributed in the hope that it will be useful, but       #
+# WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY  #
+# or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for #
+# more details.                                                               #
+#                                                                             #
+# You should have received a copy of the GNU General Public License along     #
+# with twitter2jabber. If not, see <http://www.gnu.org/licenses/>.            #
+#                                                                             #
+###############################################################################
+#++
+
+require 'time'
+require 'erb'
+
+require 'rubygems'
+require 'twitter'
+require 'xmpp4r-simple'
+
+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
+
+  def self.run(options, recipients = [], &block)
+    new(options).run(recipients, &block)
+  end
+
+  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
+    @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 = {}, flag = true, &block)
+    deliver_tweets(recipients, seen, &block) if flag
+    post_messages
+  end
+
+  def loop(recipients = [], pause = nil, &block)
+    pause ||= DEFAULT_PAUSE
+
+    # jabber/twitter ratio
+    ratio = 10
+    pause /= ratio
+
+    # 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]
+
+      msg = format_tweet(tweet)
+
+      recipients.each { |recipient|
+        deliver(recipient, msg)
+      }
+
+      sleep 1
+    }
+  end
+
+  def post_messages
+    jabber.received_messages { |msg|
+      next unless msg.type == :chat
+
+      logj msg.id
+
+      handle_command(msg.body, msg.from)
+    }
+  end
+
+  private
+
+  def twitter_connect(options)
+    auth   = Twitter::HTTPAuth.new(options[:user], options[:pass])
+    client = Twitter::Base.new(auth)
+
+    # 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)
+    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|
+      tweet.created_at = Time.parse(tweet.created_at)
+    }
+  rescue Twitter::CantConnect
+    sleep pause
+    retry
+  end
+
+  def format_tweet(tweet)
+    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/config.yaml

@@ -0,0 +1,15 @@
+---
+:twitter:
+  :user: foo
+  :pass: bar
+
+:jabber:
+  :user: quix
+  :pass: quux
+
+:recipients:
+  - one
+  - two
+  - three
+
+:pause: 123

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

@@ -0,0 +1,104 @@
+--- !ruby/object:Gem::Specification 
+name: blackwinter-twitter2jabber
+version: !ruby/object:Gem::Version 
+  version: 0.0.4
+platform: ruby
+authors: 
+- Jens Wille
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-08-02 00:00:00 -07:00
+default_executable: twitter2jabber
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: twitter
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: xmpp4r-simple
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+- !ruby/object:Gem::Dependency 
+  name: highline
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: Twitter-to-Jabber gateway.
+email: jens.wille@uni-koeln.de
+executables: 
+- twitter2jabber
+extensions: []
+
+extra_rdoc_files: 
+- COPYING
+- ChangeLog
+- README
+files: 
+- lib/twitter2jabber.rb
+- lib/twitter2jabber/version.rb
+- bin/twitter2jabber
+- COPYING
+- Rakefile
+- README
+- ChangeLog
+- TODO
+- sample/config.yaml
+- sample/templates
+- sample/templates/tweet.html
+- sample/templates/tweet.txt
+has_rdoc: false
+homepage: http://twitter2jabber.rubyforge.org/
+licenses: 
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- twitter2jabber Application documentation
+- --main
+- README
+- --charset
+- UTF-8
+- --all
+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: twitter2jabber
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: Twitter-to-Jabber gateway.
+test_files: []
+