#
# Author:: Carter Parks (carterparks) <carter@carterparks.com>
# Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
-# Author:: "NeoLobster" <neolobster@snugglenets.com>
+# Author:: NeoLobster <neolobster@snugglenets.com>
#
# Copyright:: (C) 2007 Carter Parks
# Copyright:: (C) 2007 Giuseppe Bilotta
# 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'
def initialize
super
+ @has_oauth = defined? OAuth
+
class << @registry
def store(val)
val
end
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="")
return "twitter status [nick] => show nick's (or your) status, use 'twitter friends status [nick]' to also show the friends' timeline | twitter update [status] => updates your status on twitter | twitter authorize => Generates an authorization URL which will give you a PIN to authorize the bot to use your twitter account. | twitter pin [pin] => Finishes bot authorization using the PIN provided by the URL from twitter authorize. | twitter deauthorize => Makes the bot forget your Twitter account. | twitter actions [on|off] => enable/disable twitting of actions (/me does ...)"
end
# 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]
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")
+ 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
end
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
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")
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
def pin(m, params)
unless @registry.has_key?(m.sourcenick + "_request_token")
- m.reply "You must first use twitter authorize to get the PIN"
+ m.reply "You must first use twitter authorize to get an authorization URL, which you can use to get a PIN for me to use to verify your Twitter account"
return false
end
@request_token = YAML::load(@registry[m.sourcenick + "_request_token"])
- @access_token = @request_token.get_access_token( { :oauth_verifier => params[:pin] } )
+ begin
+ @access_token = @request_token.get_access_token( { :oauth_verifier => params[:pin] } )
+ rescue
+ m.reply "Error: There was a problem registering your Twitter account. Please make sure you have the right PIN. If the problem persists, use twitter authorize again to get a new PIN"
+ return false
+ end
@registry[m.sourcenick + "_access_token"] = YAML::dump(@access_token)
m.reply "Okay, you're all set"
end
# 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;
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)