4 # :title: Twitter Status Update for rbot
6 # Author:: Carter Parks (carterparks) <carter@carterparks.com>
7 # Author:: Giuseppe "Oblomov" Bilotta <giuseppe.bilotta@gmail.com>
8 # Author:: NeoLobster <neolobster@snugglenets.com>
10 # Copyright:: (C) 2007 Carter Parks
11 # Copyright:: (C) 2007 Giuseppe Bilotta
13 # Users can setup their twitter username and password and then begin updating
19 error "OAuth module could not be loaded, twits will not be submitted and protected twits will not be accessible"
25 class TwitterPlugin < Plugin
26 Config.register Config::StringValue.new('twitter.key',
28 :desc => "Twitter OAuth Consumer Key")
30 Config.register Config::StringValue.new('twitter.secret',
32 :desc => "Twitter OAuth Consumer Secret")
34 Config.register Config::IntegerValue.new('twitter.status_count',
35 :default => 1, :validate => Proc.new { |v| v > 0 && v <= 10},
36 :desc => "Maximum number of status updates shown by 'twitter status'")
38 Config.register Config::IntegerValue.new('twitter.friends_status_count',
39 :default => 3, :validate => Proc.new { |v| v > 0 && v <= 10},
40 :desc => "Maximum number of status updates shown by 'twitter friends status'")
45 @has_oauth = defined? OAuth
57 def report_oauth_missing(m, failed_action)
58 m.reply [failed_action, "I cannot authenticate to Twitter (OAuth not available)"].join(' because ')
61 def report_key_missing(m, failed_action)
62 m.reply [failed_action, "no Twitter Consumer Key/Secret is defined"].join(' because ')
65 def help(plugin, topic="")
66 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 ...)"
69 # update the status on twitter
70 def get_status(m, params)
71 friends = params[:friends]
73 if @registry.has_key?(m.sourcenick + "_access_token")
74 @access_token = YAML::load(@registry[m.sourcenick + "_access_token"])
75 nick = params[:nick] || @access_token.params[:screen_name]
79 m.reply "You are not authorized with Twitter. Please use 'twitter authorize' first to use this feature."
81 report_oauth_missing(m, "I cannot retrieve your friends status")
89 m.reply "you should specify the username of the twitter to use, or identify using 'twitter authorize'"
93 count = friends ? @bot.config['twitter.friends_status_count'] : @bot.config['twitter.status_count']
94 user = URI.escape(nick)
95 if @has_oauth and @registry.has_key?(m.sourcenick + "_access_token")
97 #no change to count variable
98 uri = "https://api.twitter.com/1/statuses/friends_timeline.xml?count=#{count}"
99 response = @access_token.get(uri).body
101 uri = "https://api.twitter.com/1/statuses/user_timeline.xml?screen_name=#{user}&count=#{count}"
102 response = @access_token.get(uri).body
105 #unauthorized user, will try to get from public timeline the old way
106 uri = "http://twitter.com/statuses/user_timeline/#{user}.xml?count=#{count}"
107 response = @bot.httputil.get(uri, :cache => false)
115 rex = REXML::Document.new(response)
116 rex.root.elements.each("status") { |st|
117 # month, day, hour, min, sec, year = st.elements['created_at'].text.match(/\w+ (\w+) (\d+) (\d+):(\d+):(\d+) \S+ (\d+)/)[1..6]
118 # debug [year, month, day, hour, min, sec].inspect
119 # time = Time.local(year.to_i, month, day.to_i, hour.to_i, min.to_i, sec.to_i)
120 time = Time.parse(st.elements['created_at'].text)
122 # Sometimes, time can be in the future; invert the relation in this case
123 delta = ((time > now) ? time - now : now - time)
124 msg = st.elements['text'].to_s + " (#{Utils.secs_to_string(delta.to_i)} ago via #{st.elements['source'].to_s})"
127 author = Utils.decode_html_entities(st.elements['user'].elements['name'].text) + ": " rescue ""
129 texts << author+Utils.decode_html_entities(msg).ircify_html
132 # friends always return the latest 20 updates, so we clip the count
138 m.reply "could not parse status for #{nick}'s friends"
140 m.reply "could not parse status for #{nick}"
145 m.reply "No status updates!"
147 m.reply texts.reverse.join("\n")
152 rep = "could not get status for #{nick}'s friends"
153 rep << ", try asking in private" unless m.private?
155 rep = "could not get status for #{nick}"
162 def deauthorize(m, params)
163 if @registry.has_key?(m.sourcenick + "_request_token")
164 @registry.delete(m.sourcenick + "_request_token")
166 if @registry.has_key?(m.sourcenick + "_access_token")
167 @registry.delete(m.sourcenick + "_access_token")
169 m.reply "Done! You can reauthorize this account in the future by using 'twitter authorize'"
172 def authorize(m, params)
173 failed_action = "we can't complete the authorization process"
175 report_oauth_missing(m, failed_action)
179 #remove all old authorization data
180 if @registry.has_key?(m.sourcenick + "_request_token")
181 @registry.delete(m.sourcenick + "_request_token")
183 if @registry.has_key?(m.sourcenick + "_access_token")
184 @registry.delete(m.sourcenick + "_access_token")
187 key = @bot.config['twitter.key']
188 secret = @bot.config['twitter.secret']
189 if key.empty? or secret.empty?
190 report_key_missing(m, failed_action)
194 @consumer = OAuth::Consumer.new(key, secret, {
195 :site => "https://api.twitter.com",
196 :request_token_path => "/oauth/request_token",
197 :access_token_path => "/oauth/access_token",
198 :authorize_path => "/oauth/authorize"
201 @request_token = @consumer.get_request_token
202 rescue OAuth::Unauthorized
203 m.reply _("My authorization failed! Did you block me? Or is my Twitter Consumer Key/Secret pair incorrect?")
206 @registry[m.sourcenick + "_request_token"] = YAML::dump(@request_token)
207 m.reply "Go to this URL to get your authorization PIN, then use 'twitter pin <pin>' to finish authorization: " + @request_token.authorize_url
211 unless @registry.has_key?(m.sourcenick + "_request_token")
212 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"
215 @request_token = YAML::load(@registry[m.sourcenick + "_request_token"])
217 @access_token = @request_token.get_access_token( { :oauth_verifier => params[:pin] } )
219 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"
222 @registry[m.sourcenick + "_access_token"] = YAML::dump(@access_token)
223 m.reply "Okay, you're all set"
226 # update the status on twitter
227 def update_status(m, params)
229 report_oauth_missing(m, "I cannot update your status")
233 unless @registry.has_key?(m.sourcenick + "_access_token")
234 m.reply "You must first authorize your Twitter account before tweeting."
237 @access_token = YAML::load(@registry[m.sourcenick + "_access_token"])
239 uri = "https://api.twitter.com/statuses/update.json"
240 msg = params[:status].to_s
243 m.reply "your status message update is too long, please keep it under 140 characters"
247 response = @access_token.post(uri, { :status => msg })
250 reply_method = params[:notify] ? :notify : :reply
251 if response.class == Net::HTTPOK
252 m.__send__(reply_method, "status updated")
254 m.__send__(reply_method, "could not update status")
258 # ties a nickname to a twitter username and password
259 def identify(m, params)
260 @registry[m.sourcenick + "_username"] = params[:username].to_s
261 @registry[m.sourcenick + "_password"] = params[:password].to_s
262 m.reply "you're all set up!"
265 # update on ACTION if the user has enabled the option
266 # Possible TODO: move the has_oauth check further down and alert
267 # the user the first time we do not update because of the missing oauth
269 return unless @has_oauth
270 return unless m.action?
271 return unless @registry[m.sourcenick + "_actions"]
272 update_status(m, :status => m.message, :notify => true)
275 # show or toggle action twitting
276 def actions(m, params)
279 @registry[m.sourcenick + "_actions"] = true
282 @registry.delete(m.sourcenick + "_actions")
285 if @registry[m.sourcenick + "_actions"]
286 m.reply _("actions will be twitted")
288 m.reply _("actions will not be twitted")
294 # create an instance of our plugin class and register for the "length" command
295 plugin = TwitterPlugin.new
296 plugin.map 'twitter update *status', :action => "update_status", :threaded => true
297 plugin.map 'twitter authorize', :action => "authorize", :public => false
298 plugin.map 'twitter deauthorize', :action => "deauthorize", :public => false
299 plugin.map 'twitter pin :pin', :action => "pin", :public => false
300 plugin.map 'twitter actions [:toggle]', :action => "actions", :requirements => { :toggle => /^on|off$/ }
301 plugin.map 'twitter status [:nick]', :action => "get_status", :threaded => true
302 plugin.map 'twitter :friends [status] [:nick]', :action => "get_status", :requirements => { :friends => /^friends?$/ }, :threaded => true