]> git.netwichtig.de Git - user/henk/code/ruby/rbot.git/blobdiff - data/rbot/plugins/twitter.rb
chucknorris: typo
[user/henk/code/ruby/rbot.git] / data / rbot / plugins / twitter.rb
index 1d86472d940abbeb28b0c57456c94662888a64e8..8725ac2cd21de783cbad33c30709de7849aa580b 100644 (file)
 # Users can setup their twitter username and password and then begin updating
 # twitter whenever
 
-require 'oauth'
+begin
+  require 'oauth'
+rescue LoadError
+  error "OAuth module could not be loaded, twits will not be submitted and protected twits will not be accessible"
+end
+
 require 'yaml'
 require 'rexml/rexml'
 
@@ -34,9 +39,34 @@ class TwitterPlugin < Plugin
       :default => 3, :validate => Proc.new { |v| v > 0 && v <= 10},
       :desc => "Maximum number of status updates shown by 'twitter friends status'")
 
+  def twitter_filter(s)
+    loc = Utils.check_location(s, Regexp.new('twitter\.com/#!/.*/status/\d+'))
+    return nil unless loc
+    id = loc.first.match(/\/status\/(\d+)/)[1]
+    xml = @bot.httputil.get('http://api.twitter.com/1/statuses/show.xml?id=' + id)
+    return nil unless xml
+    root = REXML::Document.new(xml).root
+    status = {
+      :date => (Time.parse(root.elements["created_at"].text) rescue "<unknown>"),
+      :id => (root.elements["id"].text rescue "<unknown>"),
+      :text => (root.elements["text"].text.ircify_html rescue "<error>"),
+      :source => (root.elements["source"].text rescue "<unknown>"),
+      :user => (root.elements["user/name"].text rescue "<unknown>"),
+      :user_nick => (root.elements["user/screen_name"] rescue "<unknown>")
+      # TODO other entries
+    }
+    status[:nicedate] = String === status[:date] ? status[:date] : Utils.timeago(status[:date])
+    return {
+      :title => "#{status[:user]}/#{status[:id]}",
+      :content => "#{status[:text]} (#{status[:nicedate]} via #{status[:source]})"
+    }
+  end
+
   def initialize
     super
 
+    @has_oauth = defined? OAuth
+
     class << @registry
       def store(val)
         val
@@ -45,6 +75,16 @@ class TwitterPlugin < Plugin
         val
       end
     end
+
+    @bot.register_filter(:twitter, :htmlinfo) { |s| twitter_filter(s) }
+  end
+
+  def report_oauth_missing(m, failed_action)
+    m.reply [failed_action, "I cannot authenticate to Twitter (OAuth not available)"].join(' because ')
+  end
+
+  def report_key_missing(m, failed_action)
+    m.reply [failed_action, "no Twitter Consumer Key/Secret is defined"].join(' because ')
   end
 
   def help(plugin, topic="")
@@ -54,12 +94,17 @@ class TwitterPlugin < Plugin
   # update the status on twitter
   def get_status(m, params)
     friends = params[:friends]
+
     if @registry.has_key?(m.sourcenick + "_access_token")
       @access_token = YAML::load(@registry[m.sourcenick + "_access_token"])
       nick = params[:nick] || @access_token.params[:screen_name]
     else
       if friends
-        m.reply "You are not authorized with Twitter. Please use 'twitter authorize' first to use this feature."
+        if @has_oauth
+          m.reply "You are not authorized with Twitter. Please use 'twitter authorize' first to use this feature."
+        else
+          report_oauth_missing(m, "I cannot retrieve your friends status")
+        end
         return false
       end
       nick = params[:nick]
@@ -70,21 +115,17 @@ class TwitterPlugin < Plugin
       return false
     end
 
-    count = @bot.config['twitter.friends_status_count']
+    count = friends ? @bot.config['twitter.friends_status_count'] : @bot.config['twitter.status_count']
     user = URI.escape(nick)
-    if @registry.has_key?(m.sourcenick + "_access_token")
+    # receive the public timeline per default (this works even without an access_token)
+    uri = "https://api.twitter.com/1/statuses/user_timeline.xml?screen_name=#{user}&count=#{count}&include_rts=true"
+    if @has_oauth and @registry.has_key?(m.sourcenick + "_access_token")
         if friends
           #no change to count variable
-          uri = "https://api.twitter.com/1/statuses/friends_timeline.xml?count=#{count}"
-          response = @access_token.get(uri).body
-        else
-          count = @bot.config['twitter.status_count']
-          uri = "https://api.twitter.com/1/statuses/user_timeline.xml?screen_name=#{user}&count=#{count}"
-          response = @access_token.get(uri).body
+          uri = "https://api.twitter.com/1/statuses/friends_timeline.xml?count=#{count}&include_rts=true"
         end
+        response = @access_token.get(uri).body
     else
-       #unauthorized user, will try to get from public timeline the old way
-       uri = "http://twitter.com/statuses/user_timeline/#{user}.xml?count=#{count}"
        response = @bot.httputil.get(uri, :cache => false)
     end
     debug response
@@ -122,7 +163,11 @@ class TwitterPlugin < Plugin
         end
         return false
       end
-      m.reply texts.reverse.join("\n")
+      if texts.empty?
+        m.reply "No status updates!"
+      else
+        m.reply texts.reverse.join("\n")
+      end
       return true
     else
       if friends
@@ -147,6 +192,12 @@ class TwitterPlugin < Plugin
   end
 
   def authorize(m, params)
+    failed_action = "we can't complete the authorization process"
+    unless @has_oauth
+      report_oauth_missing(m, failed_action)
+      return false
+    end
+
     #remove all old authorization data
     if @registry.has_key?(m.sourcenick + "_request_token")
       @registry.delete(m.sourcenick + "_request_token")
@@ -157,14 +208,24 @@ class TwitterPlugin < Plugin
 
     key = @bot.config['twitter.key']
     secret = @bot.config['twitter.secret']
-    @consumer = OAuth::Consumer.new(key, secret, {   
+    if key.empty? or secret.empty?
+      report_key_missing(m, failed_action)
+      return false
+    end
+
+    @consumer = OAuth::Consumer.new(key, secret, {
       :site => "https://api.twitter.com",
       :request_token_path => "/oauth/request_token",
       :access_token_path => "/oauth/access_token",
       :authorize_path => "/oauth/authorize"
-      } )
-    @request_token = @consumer.get_request_token
-    @registry[m.sourcenick + "_request_token"] = YAML::dump(@request_token)        
+    } )
+    begin
+      @request_token = @consumer.get_request_token
+    rescue OAuth::Unauthorized
+      m.reply _("My authorization failed! Did you block me? Or is my Twitter Consumer Key/Secret pair incorrect?")
+      return false
+    end
+    @registry[m.sourcenick + "_request_token"] = YAML::dump(@request_token)
     m.reply "Go to this URL to get your authorization PIN, then use 'twitter pin <pin>' to finish authorization: " + @request_token.authorize_url
   end
 
@@ -186,6 +247,11 @@ class TwitterPlugin < Plugin
 
   # update the status on twitter
   def update_status(m, params)
+    unless @has_oauth
+      report_oauth_missing(m, "I cannot update your status")
+      return false
+    end
+
     unless @registry.has_key?(m.sourcenick + "_access_token")
        m.reply "You must first authorize your Twitter account before tweeting."
        return false;
@@ -219,7 +285,10 @@ class TwitterPlugin < Plugin
   end
 
   # update on ACTION if the user has enabled the option
+  # Possible TODO: move the has_oauth check further down and alert
+  # the user the first time we do not update because of the missing oauth
   def ctcp_listen(m)
+    return unless @has_oauth
     return unless m.action?
     return unless @registry[m.sourcenick + "_actions"]
     update_status(m, :status => m.message, :notify => true)