rumpy 0.9.15 → 0.9.17

data/README.rdoc

@@ -14,29 +14,33 @@ Our goal is 'DO NOT REINVENT THE WHEEL'.
 == Getting started
 
 * Rumpy uses 3 configs:
-  database.yml  ::  Your bot's database preferences.
-  lang.yml      ::  Your bot's responces. Append to existing keys more answers and use them like @lang['someanswer]. **There must be at least 3 keys : hello /used when somebody add bot/, stranger /when somebody trying talk to bot without authorization/, authorized /when bot get authorized/.
-  xmpp.yml      ::  Your bot's account settings.
+  +database.yml+  ::  Your bot's database preferences.
+  +lang.yml+      ::  Your bot's responces. Append to existing keys more answers and use them like @lang['someanswer]. **There must be at least 3 keys : hello /used when somebody add bot/, stranger /when somebody trying talk to bot without authorization/, authorized /when bot get authorized/.
+  +xmpp.yml+      ::  Your bot's account settings.
   Look at Examples section to see this configs.
 * Implement your ActiveRecord models in one directory. You have to implement at least one model, for users.
 * Prepare your database.
 * Start writing your class:
-  * Mix in Rumpy::Bot module:
+  * Mix in Rumpy::Bot module
+
     include Rumpy::Bot
   * Define some instance variables:
-    @models_path  ::  Path to directory, containing all ruby files with models.
-    @config_path  ::  Path to directory, containing all ruby config files
-    @main_model   ::  Symbol, that stands for main model. If your main model is, e.g. User, set @main_model to :user
-    @pid_file     ::  Optional variable, sets location of the file to which pid of detached process will be saved. If not set, it equals NameOfYourBotClass.downcase + '.pid'.
-    @log_file     ::  Optional variable, sets location of the file for errors. Default is STDERR.
-    @log_level    ::  Optional variable, sets the verbosity of log. Possible values are Logger::DEBUG < Logger::INFO < Logger::WARN < Logger::ERROR < Logger::FATAL < Logger::UNKNOWN. Default is Logger::INFO
-    @logger       ::  If you wanna specify more parameters to logger, you always can create logger yourself. If this variable set, @log_file & @log_level are ignored.
-    @bot_name     ::  Optional name of the bot. Default is name of bot's class.
-    @bot_version  ::  Optional version of the bot. Default is 1.0.0.
+    @models_path    ::  Path to directory, containing all ruby files with models.
+    @config_path    ::  Path to directory, containing all ruby config files
+    @main_model     ::  Symbol, that stands for main model. If your main model is, e.g. +User+, set @main_model to +:user+
+    @pid_file       ::  Optional variable, sets location of the file to which pid of detached process will be saved. If not set, it equals +NameOfYourBotClass.downcase+ + '.pid'.
+    @log_file       ::  Optional variable, sets location of the file for errors. Default is +STDERR+.
+    @log_level      ::  Optional variable, sets the logging severity threshold. Possible values are Logger::DEBUG < Logger::INFO < Logger::WARN < Logger::ERROR < Logger::FATAL < Logger::UNKNOWN. Default is Logger::INFO.
+    @log_shift_age  ::  Optional variable, sets number of old log files to keep, or frequency of rotation (daily, weekly or monthly).
+    @log_shift_size ::  Optional variable, sets maximum logfile size.
+    @log_progname   ::  Optional variable, sets logging program name.
+    @log_formatter  ::  Optional variable, sets logging formatter. @log_formatter#call is invoked with 4 arguments; +severity+, +time+, +progname+ and +msg+ for each log.
+    @bot_name       ::  Optional name of the bot. Default is name of bot's class.
+    @bot_version    ::  Optional version of the bot. Default is 1.0.0.
   * Write 3 methods:
-    backend_func() -> [[receiver, message]*] :: This optional method is running all the time in the loop. Returns array of pairs [receiver, message].
-    parser_func(msg) -> pars_result :: This method parses any incoming message and returs results.
-    do_func(usermodel, pars_results) -> msg :: This method uses results from parser_func, doing some stuff with model of user, from whom message was received. Returns message to be send to this user
+    backend_func() -> [[receiver, message]*]    :: This optional method is running all the time in the loop. Returns array of pairs [receiver, message].
+    parser_func(msg) -> +pars_result+           :: This method parses any incoming message and returs results.
+    do_func(usermodel, pars_results) -> +msg+  :: This method uses results from +parser_func+, doing some stuff with model of user, from whom message was received. Returns message to be send to this user
 * Run bot:
   You can run your bot without detaching:
     Rumpy.run YourBotClassName

data/lib/rumpy.rb

@@ -10,9 +10,12 @@ module Rumpy
   # Create new instance of `botclass`, start it in new process,
   # detach this process and save the pid of process in pid_file
   def self.start(botclass)
-    bot = botclass.new
-    pf = pid_file bot
+    bot           = botclass.new
+    pf            = pid_file bot
     return false if File.exist? pf
+
+    bot.log_file  = "#{botclass.to_s.downcase}.log"
+
     pid = fork do
       bot.start
     end
@@ -54,24 +57,17 @@ module Rumpy
   module Bot
     attr_reader :pid_file
 
+    # if @log_file isn't set, initialize it
+    def log_file=(logfile)
+      @log_file ||= logfile
+    end
+
     # one and only public function, defined in this module
     # simply initializes bot's variables, connection, etc.
     # and starts bot
     def start
-      if @logger.nil? then # if user haven't created his own logger
-        @log_file             ||= STDERR
-        @log_level            ||= Logger::INFO
-        @logger                 = Logger.new @log_file
-        @logger.level           = @log_level
-        @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
-      end
-      Signal.trap :TERM do |signo|
-        @logger.info 'terminating'
-        @logger.close
-        exit
-      end
+      logger_init
 
-      @logger.info 'starting bot'
       init
       connect
       prepare_users
@@ -83,13 +79,30 @@ module Rumpy
       start_backend_thread
 
       @logger.info 'Bot is going ONLINE'
-      @client.send Jabber::Presence.new.set_priority(@priority).set_status(@status)
+      send_msg Jabber::Presence.new(nil, @status, @priority)
+
+      add_signal_trap
 
       Thread.stop
+    rescue => e
+      general_error e
+      exit
     end # def start
 
     private
 
+    def logger_init
+      @log_file             ||= STDERR
+      @log_level            ||= Logger::INFO
+      @logger                 = Logger.new @log_file, @log_shift_age, @log_shift_size
+      @logger.level           = @log_level
+      @logger.progname        = @log_progname
+      @logger.formatter       = @log_formatter
+      @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+
+      @logger.info 'starting bot'
+    end
+
     def init
       @logger.debug 'initializing some variables'
 
@@ -156,7 +169,7 @@ module Rumpy
           @logger.info "deleting from database user with jid #{user.jid}"
           user.destroy
         else
-          start_user_thread user.jid
+          start_user_thread user
         end
       end
 
@@ -180,14 +193,22 @@ module Rumpy
             @queues[item.jid.strip.to_s].enq :unsubscribe
             item.remove
           when :subscribed
-            add_jid item.jid
+            user = @main_model.new
+            user.jid = item.jid.strip.to_s
+            user.save
+            start_user_thread user
+
+            @logger.info "added new user: #{user.jid}"
             send_msg Jabber::Message.new(item.jid, @lang['authorized']).set_type :chat
           end
         rescue ActiveRecord::StatementInvalid
-          @logger.warn 'Statement Invalid catched'
-          @logger.info 'Reconnecting to database'
-          @main_model.connection.reconnect!
+          statement_invalid
+          retry
+        rescue ActiveRecord::ConnectionTimeoutError
+          connection_timeout_error
           retry
+        rescue => e
+          general_error e
         end
       end
     end # def set_subscription_callback
@@ -196,7 +217,7 @@ module Rumpy
       @client.add_message_callback do |msg|
         if msg.type != :error and msg.body and msg.from then
           if @roster[msg.from] and @roster[msg.from].subscription == :both then
-            @logger.debug "got normal message from #{msg.from}"
+            @logger.debug "got normal message #{msg}"
 
             @queues[msg.from.strip.to_s].enq msg
           else # if @roster[msg.from] and @roster[msg.from].subscription == :both
@@ -234,50 +255,69 @@ module Rumpy
         begin
           loop do
             backend_func().each do |result|
-              send_msg Jabber::Message.new(*result).set_type :chat
+              message = Jabber::Message.new(*result).set_type :chat
+              send_msg message if message.body and message.to
             end
           end
         rescue ActiveRecord::StatementInvalid
-          @logger.warn 'Statement Invalid catched'
-          @logger.info 'Reconnecting to database'
-          @main_model.connection.reconnect!
+          statement_invalid
+          retry
+        rescue ActiveRecord::ConnectionTimeoutError
+          connection_timeout_error
           retry
         rescue => e
-          $logger.error e.inspect
-          $logger.error e.backtrace
+          general_error e
         end # begin
       end if self.respond_to? :backend_func
     end # def start_backend_thread
 
-    def start_user_thread(userjid)
-      Thread.new(userjid) do |userjid|
+    def add_signal_trap
+      Signal.trap :TERM do |signo| # soft stop
+        @logger.info 'Bot is unavailable'
+        send_msg Jabber::Presence.new.set_type :unavailable
+
+        @queues.each do |user, queue|
+          queue.enq :halt
+        end
+        until @queues.empty?
+          sleep 1
+        end
+        @client.close
+
+        @logger.info 'terminating'
+        @logger.close
+        exit
+      end
+    end
+
+    def start_user_thread(user)
+      Thread.new(user) do |user|
+
         loop do
-          msg = @queues[userjid].deq
+          msg = @queues[user.jid].deq
 
           begin
-            if msg == :unsubscribe then
-              remove_jid userjid
+            if msg.kind_of? Symbol then # :unsubscribe or :halt
+              if msg == :unsubscribe
+                @logger.info "removing user #{user.jid}"
+                user.destroy
+              end
+              @queues.delete user.jid
               break
             end
 
-            user = @main_model.find_by_jid msg.from
-
             pars_results = parser_func msg.body
             @logger.debug "parsed message: #{pars_results.inspect}"
-            send_msg msg.answer.set_body do_func(user, pars_results)
+            message = do_func user, pars_results
+            send_msg msg.answer.set_body message unless message.empty?
           rescue ActiveRecord::StatementInvalid
-            @logger.warn 'Statement Invalid catched!'
-            @logger.info 'Reconnecting to database'
-            @main_model.connection.reconnect!
+            statement_invalid
             retry
           rescue ActiveRecord::ConnectionTimeoutError
-            @logger.warn 'ActiveRecord::ConnectionTimeoutError'
-            @logger.info 'sleep and retry again'
-            sleep 3
+            connection_timeout_error
             retry
           rescue => e
-            @logger.error e.inspect
-            @logger.error e.backtrace
+            general_error e
           end # begin
 
           @main_model.connection_pool.release_connection
@@ -292,23 +332,21 @@ module Rumpy
       @client.send msg
     end
 
-    def add_jid(jid)
-      user = @main_model.new
-      user.jid = jid.strip.to_s
-      user.save
-      start_user_thread user.jid
-      @logger.info "added new user: #{jid}"
+    def statement_invalid
+      @logger.warn 'Statement Invalid catched'
+      @logger.info 'Reconnecting to database'
+      @main_model.connection.reconnect!
     end
 
-    def remove_jid(jid)
-      user = @main_model.find_by_jid jid
-      unless user.nil?
-        @logger.info "removing user #{jid}"
-
-        @queues.delete user.jid
+    def connection_timeout_error
+      @logger.warn 'ActiveRecord::ConnectionTimeoutError'
+      @logger.info 'sleep and retry again'
+      sleep 3
+    end
 
-        user.destroy
-      end
+    def general_error(exception)
+      @logger.error exception.inspect
+      @logger.error exception.backtrace
     end
   end # module Rumpy::Bot
 end # module Rumpy

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rumpy
 version: !ruby/object:Gem::Version 
-  hash: 37
+  hash: 25
   prerelease: false
   segments: 
   - 0
   - 9
-  - 15
-  version: 0.9.15
+  - 17
+  version: 0.9.17
 platform: ruby
 authors: 
 - Tsokurov A.G.
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-15 00:00:00 +03:00
+date: 2011-08-18 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency