safubot 0.0.3 → 0.0.4

data/lib/safubot/bot.rb

@@ -8,19 +8,51 @@ module Safubot
 	"#{e.inspect}\n#{e.backtrace.join("\n\t")}"
   end
 
+  ###
+  # An EmbeddedDocument for storing processing/dispatch errors.
+  class Problem
+	include MongoMapper::EmbeddedDocument
+	key :when, Time
+	key :error, String # Exception#to_s
+	key :type, String # Exception class
+	key :backtrace, Array, :default => nil
+  end
+
+  ##
+  # A mixin adding Problem handling.
+  module Problematic
+	##
+	# Adds a timestamped Problem to the list.
+	# @param e Exception from which the Problem is derived.
+	def add_problem(e)
+	  problem = Problem.new(:error => e.to_s, :type => e.class.to_s,
+							 :when => Time.now, :backtrace => e.backtrace)
+	  self.problems.push(problem)
+	end
+
+	##
+	# Fetches the most recent Problem.
+	def last_problem
+	  self.problems.sort { |x,y| x.when <=> y.when }.last
+	end
+  end
+
+
   ##
   # Defines elements of the input queue, agnostic of the transfer medium.
   # May be extended by service-specific modules.
   class Request
 	include MongoMapper::Document
+	include Problematic
 	safe
-	key :errors, Hash # Errors encountered during processing.
+	key :processing, Boolean, :default => false # Currently-processing lock.
 	key :processed, Boolean, :default => false # Have we processed this request?
 	key :success, Boolean, :default => false # Did we *successfully* process this request?
 	key :text, String # The actual content.
 	belongs_to :source, :polymorphic => true # The concrete medium-specific source.
-	belongs_to :user, :polymorphic => true
+	belongs_to :user, :class_name => "Safubot::KnownUser"
 	many :responses, :class_name => "Safubot::Response"
+	many :problems # Hopefully not that many ;)
 	timestamps!
   end
 
@@ -29,11 +61,13 @@ module Safubot
   # May be extended by service-specific modules.
   class Response
 	include MongoMapper::Document
+	include Problematic
 	safe
-	key :errors, Hash # Errors encountered during dispatch by timestamp.
+	key :dispatching, Boolean, :default => false # Dispatch lock.
 	key :dispatched, Boolean, :default => false
 	key :text, String
-	belongs_to :request, :polymorphic => true
+	belongs_to :request, :class_name => "Safubot::Request"
+	many :problems
 	timestamps!
   end
 
@@ -47,27 +81,54 @@ module Safubot
 	attr_reader :opts, :twitter, :xmpp
 
 	##
-	# Records an error and emits a corresponding :request_error event.
+	# Records an error in processing and emits a corresponding :request_error event.
 	# @param req The Request for which the error was encountered.
 	# @param e The caught Exception.
 	def request_error(req, e)
-	  Log.error "Error processing #{req.source.class} '#{req.text}': #{e}\n#{e.backtrace.join("\n\t")}"
-	  req.errors[Time.now] = e
+	  Log.error "Error processing #{req.source.class} '#{req.text}': #{error_report(e)}"
+	  req.add_problem(e)
 	  req.save
 	  emit(:request_error, req, e)
 	end
 
+	##
+	# Records an error in dispatch and emits a corresponding :dispatch_error event.
+	# @param resp The Response for which the error was encountered.
+	# @param e The caught Exception.
+	def dispatch_error(resp, e)
+	  Log.error "Error dispatching #{resp.request.source.class} '#{resp.text}': #{error_report(e)}"
+	  resp.add_problem(e)
+	  resp.save
+	  emit(:dispatch_error, resp, e)
+	end
+
 	## 
 	# Processes an individual request (synchronously).
 	# @param req An unprocessed Request.
 	def process_request(req)
+	  req.reload
+	  if req.processed
+		Log.debug "Request '#{req.text}' has already been processed, ignoring."
+		return
+	  elsif req.processing
+		Log.debug "Request '#{req.text}' is currently in processing, ignoring."
+		return
+	  end
+
 	  begin
+		req.processing = true
+		req.save
 		emit(:request, req)
 	  rescue Exception => e
 		request_error(req, e)
+	  else
+		req.success = true
 	  ensure
-		req.processed = true
-		req.save
+		#if Safubot::mode == :production
+		  req.processing = false
+		  req.processed = true
+		  req.save
+		#end
 	  end
 	end
 
@@ -75,8 +136,26 @@ module Safubot
 	# Performs appropriate dispatch operation for response type.
 	# @param resp An undispatched Response.
 	def dispatch(resp)
+	  resp.reload
+	  if resp.dispatched
+		Log.debug "Response '#{resp.text}' has already been dispatched, ignoring."
+		return
+	  elsif resp.dispatching
+		Log.debug "Response '#{resp.text}' is already in dispatch, ignoring."
+		return
+	  elsif resp.problems.length > 10
+		Log.debug "Response '#{resp.text}' encountered more than ten dispatch errors, ignoring."
+		return
+	  elsif !resp.problems.empty? && (Time.now - resp.last_problem.when) < 1.minute
+		Log.debug "Response '#{resp.text}' encountered a dispatch error <1 minute ago, ignoring."
+		return
+	  end
+
 	  begin
 		source = resp.request.source
+		resp.dispatching = true
+		resp.save
+
 		if Safubot::mode != :production
 		  Log.info "#{source.class} Response to #{source.username}: #{resp.text}"
 		else
@@ -87,15 +166,15 @@ module Safubot
 		  else
 			raise NotImplementedError, "Don't know how to send response to a #{source.class}!"
 		  end
-		end
 
-		resp.dispatched = true
-		resp.save
+		  resp.dispatched = true
+		  resp.save
+		end
 	  rescue Exception => e
-		Log.error "Error dispatching #{source.class} '#{resp.text}': #{e}"
-		resp.errors[Time.now] = e
+		dispatch_error(resp, e)
+	  ensure
+		resp.dispatching = false
 		resp.save
-		emit(:dispatch_error, resp, e)
 	  end
 	end
 
@@ -112,18 +191,12 @@ module Safubot
 	end
 
 	##
-	# Adds a response to the queue.
+	# Adds a response to the queue and dispatches it.
 	# @param req Request to respond to.
 	# @param text Contents of the response.
 	def respond(req, text)
 	  Log.info("#{req.user.name}: #{req.text}\nsafubot: #{text}")
-	  Response.create(:request => req, :text => text)
-	end
-
-	# Respond + push
-	def respond_now(req, text)
-	  respond(req, text)
-	  push
+	  dispatch(Response.create(:request => req, :text => text))
 	end
 
 	# Dispatches all undispatched Responses.
@@ -142,7 +215,6 @@ module Safubot
 		rescue Exception => e
 		  request_error(req, e)
 		end
-
 		push
 	  end
 	end
@@ -174,7 +246,8 @@ module Safubot
 	def enable_twitter(opts={})
 	  @twitter = Twitter::Bot.new(opts)
 	  @twitter.on(:request) do |req|
-		process; push
+		process_request(req)
+		req.responses.where(:dispatched => false).map(&method(:dispatch))
 	  end
 	end
 
@@ -183,7 +256,8 @@ module Safubot
 	  defaults = { :jid => nil, :password => nil }
 	  @xmpp = XMPP::Bot.new(defaults.merge(options))
 	  @xmpp.on(:request) do |req|
-		process; push
+		process_request(req)
+		req.responses.where(:dispatched => false).map(&method(:dispatch))
 	  end
 	end
 

data/lib/safubot/test_helper.rb

@@ -52,6 +52,10 @@ module Safubot
     def make_request
 	  self.request || Request.create(:user => self.user, :text => self.text, :source => self)
     end
+
+	def username
+	  self.user.name
+	end
   end
 
   class Bot

data/lib/safubot/twitter.rb

@@ -170,7 +170,7 @@ module Safubot
 		if source.is_a?(DirectMessage)
 		  @client.direct_message_create(source.raw['sender']['screen_name'], resp.text)
 		elsif source.is_a?(Tweet)
-		  reply("#{source.header_mentions.join(' ')} #{resp.text}")
+		  reply source, resp.text
 		else
 		  raise NotImplementedError, "Don't know how to send response to a #{req.source.class}!"
 		end
@@ -188,7 +188,7 @@ module Safubot
 	  # @param message A raw JSON-derived direct message.
 	  def handle_message(message)
 		return if message.sender.screen_name == @username
-		DirectMessage.from(message).make_request
+		handle_request(DirectMessage.from(message).make_request)
 	  end
 
 	  ##
@@ -198,7 +198,7 @@ module Safubot
 	  def handle_tweet(status)
 		return if status.user.screen_name == @username
 		if status.text.match(/@#{@username}/i)
-		  Tweet.from(status).make_request
+		  handle_request(Tweet.from(status).make_request)
 		else
 		  emit(:timeline, Tweet.from(status))
 		end
@@ -239,8 +239,7 @@ module Safubot
 		@stream = TweetStream::Client.new(@opts)
 
 		@stream.on_direct_message do |message|
-		  req = handle_message(message)
-		  handle_request(req) if req.is_a? Request
+		  handle_message(message)
 		end
 
 		@stream.on_error do |err|
@@ -253,6 +252,7 @@ module Safubot
 
 		@stream.on_inited do
 		  Log.info("TweetStream client is online at @#{@username} :3")
+		  emit(:ready)
 		end
 	  end
 
@@ -260,8 +260,7 @@ module Safubot
 	  def run_stream
 		begin
 		  @stream.userstream do |status|
-			req = handle_tweet(status)
-			handle_request(req) if req.is_a? Request
+			handle_tweet(status)
 		  end
 		rescue Exception => e
 		  if e.is_a?(Interrupt) || e.is_a?(SignalException)

data/lib/safubot/version.rb

@@ -1,3 +1,3 @@
 module Safubot
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/lib/safubot/xmpp.rb

@@ -113,11 +113,13 @@ module Safubot
 	  # Runs the Blather client.
 	  def run_blather
 		begin
-		  EM::run { @client.run }
+		  EM::run { 
+			@client.run 
+		  }
 		rescue Exception => e
 		  if e.is_a?(Interrupt) || e.is_a?(SignalException)
 			stop
-		  else
+		  elsif @state == :running
 			Log.error "XMPP client exited unexpectedly: #{error_report(e)}"
 			Log.error "Restarting XMPP client in 5 seconds."
 			sleep 5; init_blather; run_blather
@@ -155,7 +157,11 @@ module Safubot
 
 	  # Dispatch a Response via XMPP.
 	  def send(resp)
-		tell(resp.request.source.from, resp.text)
+		if @state == :running
+		  tell(resp.request.source.from, resp.text)
+		else
+		  on(:ready) { send(resp) }
+		end
 	  end
 
 	  def initialize(opts)

data/safubot.gemspec

@@ -19,6 +19,7 @@ Gem::Specification.new do |s|
   s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
   s.require_paths = ["lib"]
 
+  s.add_dependency "activesupport", "= 3.1.0" # mongo_mapper seems to need this without specifying it.
   s.add_dependency "eventmachine", "~> 0.12.10"
   s.add_dependency "bson_ext", "~> 1.4.0"
   s.add_dependency "mongo_mapper", "~> 0.10.1"

metadata

@@ -1,144 +1,159 @@
---- !ruby/object:Gem::Specification
+--- !ruby/object:Gem::Specification 
 name: safubot
-version: !ruby/object:Gem::Version
-  version: 0.0.3
+version: !ruby/object:Gem::Version 
   prerelease: 
+  version: 0.0.4
 platform: ruby
-authors:
+authors: 
 - Jaiden Mispy
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-11-29 00:00:00.000000000Z
-dependencies:
-- !ruby/object:Gem::Dependency
+
+date: 2011-12-01 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: activesupport
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        version: 3.1.0
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
   name: eventmachine
-  requirement: &24360180 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.12.10
   type: :runtime
-  prerelease: false
-  version_requirements: *24360180
-- !ruby/object:Gem::Dependency
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
   name: bson_ext
-  requirement: &24349720 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.4.0
   type: :runtime
-  prerelease: false
-  version_requirements: *24349720
-- !ruby/object:Gem::Dependency
+  version_requirements: *id003
+- !ruby/object:Gem::Dependency 
   name: mongo_mapper
-  requirement: &24349000 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.10.1
   type: :runtime
-  prerelease: false
-  version_requirements: *24349000
-- !ruby/object:Gem::Dependency
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
   name: twitter
-  requirement: &24348220 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 2.0.0
   type: :runtime
-  prerelease: false
-  version_requirements: *24348220
-- !ruby/object:Gem::Dependency
+  version_requirements: *id005
+- !ruby/object:Gem::Dependency 
   name: tweetstream
-  requirement: &24347440 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id006 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 1.1.3
   type: :runtime
-  prerelease: false
-  version_requirements: *24347440
-- !ruby/object:Gem::Dependency
+  version_requirements: *id006
+- !ruby/object:Gem::Dependency 
   name: blather
-  requirement: &24346340 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id007 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
+    requirements: 
     - - ~>
-      - !ruby/object:Gem::Version
+      - !ruby/object:Gem::Version 
         version: 0.5.8
   type: :runtime
-  prerelease: false
-  version_requirements: *24346340
-- !ruby/object:Gem::Dependency
+  version_requirements: *id007
+- !ruby/object:Gem::Dependency 
   name: rake
-  requirement: &24345860 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id008 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *24345860
-- !ruby/object:Gem::Dependency
+  version_requirements: *id008
+- !ruby/object:Gem::Dependency 
   name: rspec
-  requirement: &24344780 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id009 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *24344780
-- !ruby/object:Gem::Dependency
+  version_requirements: *id009
+- !ruby/object:Gem::Dependency 
   name: yard
-  requirement: &24343320 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id010 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *24343320
-- !ruby/object:Gem::Dependency
+  version_requirements: *id010
+- !ruby/object:Gem::Dependency 
   name: bundler
-  requirement: &24341920 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id011 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *24341920
-- !ruby/object:Gem::Dependency
+  version_requirements: *id011
+- !ruby/object:Gem::Dependency 
   name: wirble
-  requirement: &24331220 !ruby/object:Gem::Requirement
+  prerelease: false
+  requirement: &id012 !ruby/object:Gem::Requirement 
     none: false
-    requirements:
-    - - ! '>='
-      - !ruby/object:Gem::Version
-        version: '0'
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
   type: :development
-  prerelease: false
-  version_requirements: *24331220
+  version_requirements: *id012
 description: A friendly event-driven chatbot framework. Supports Twitter and XMPP.
-email:
+email: 
 - ^_^@mispy.me
 executables: []
+
 extensions: []
+
 extra_rdoc_files: []
-files:
+
+files: 
 - .gitignore
 - .yardoc/checksums
 - .yardoc/objects/root.dat
@@ -152,6 +167,8 @@ files:
 - doc/Safubot/Evented.html
 - doc/Safubot/KnownUser.html
 - doc/Safubot/Log.html
+- doc/Safubot/Problem.html
+- doc/Safubot/Problematic.html
 - doc/Safubot/Query.html
 - doc/Safubot/Request.html
 - doc/Safubot/Response.html
@@ -196,44 +213,33 @@ files:
 - spec/safubot/known_user_spec.rb
 - spec/safubot/twitter_spec.rb
 - spec/safubot/xmpp_spec.rb
-homepage: ''
+homepage: ""
 licenses: []
+
 post_install_message: 
 rdoc_options: []
-require_paths:
+
+require_paths: 
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement
+required_ruby_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 401033843839902587
-required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
   none: false
-  requirements:
-  - - ! '>='
-    - !ruby/object:Gem::Version
-      version: '0'
-      segments:
-      - 0
-      hash: 401033843839902587
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
 requirements: []
+
 rubyforge_project: safubot
-rubygems_version: 1.8.10
+rubygems_version: 1.8.11
 signing_key: 
 specification_version: 3
 summary: A friendly event-driven chatbot framework. Supports Twitter and XMPP.
-test_files:
-- spec/fixtures/twitter/direct_message
-- spec/fixtures/twitter/tweet
-- spec/fixtures/xmpp/message
-- spec/helper.rb
-- spec/safubot/bot_spec.rb
-- spec/safubot/evented_spec.rb
-- spec/safubot/known_user_spec.rb
-- spec/safubot/twitter_spec.rb
-- spec/safubot/xmpp_spec.rb
+test_files: []
+
 has_rdoc: