rumpy 0.9.10 → 0.9.11

data/README.rdoc

@@ -23,14 +23,15 @@ Our goal is 'DO NOT REINVENT THE WHEEL'.
 * Start writing your class:
   * Mix in Rumpy::Bot module:
     include Rumpy::Bot
-  * Define 3 instance variables:
+  * 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'.
-    @err_file     ::  Optional variable, sets location of the file for errors. If not set, standard error stream will be used.
-    @bot_name     ::  Optional name of the bot. If not set, it will equal the name of bot's class.
-    @bot_version  ::  Optional version of the bot. If not set, it will equal 1.0.0.
+    @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
+    @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.

data/lib/rumpy.rb

@@ -4,6 +4,7 @@ require 'xmpp4r/roster'
 require 'xmpp4r/version'
 require 'active_record'
 require 'active_record/validations'
+require 'logger'
 
 module Rumpy
 
@@ -48,23 +49,29 @@ module Rumpy
     attr_reader :pid_file
 
     def start
-      @err_file = if @err_file then
-                   File.open(@err_file, 'w')
-                 else
-                   $stderr
-                 end
+      @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"
       Signal.trap :TERM do |signo|
-        @err_file.close
+        @logger.info 'terminating'
+        @logger.close
         exit
       end
 
+      @logger.info 'starting bot'
+      @logger.debug 'initializing some variables'
       init
+      @logger.debug 'establishing xmpp connection'
       connect
+      @logger.debug 'clear wrong users'
       clear_users
       start_subscription_callback
       start_message_callback
+      @logger.info 'Bot is going ONLINE'
       @client.send Jabber::Presence.new.set_priority(@priority).set_status(@status)
-      Jabber::Version::SimpleResponder.new(@client, @bot_name || self.class.to_s, @bot_version || '1.0.0', RUBY_PLATFORM)
+
       Thread.new do
         begin
           loop do
@@ -72,9 +79,14 @@ module Rumpy
               send_msg *result
             end
           end
+        rescue ActiveRecord::StatementInvalid
+          @logger.warn 'Statement Invalid catched'
+          @logger.info 'Reconnecting to database'
+          @main_model.connection.reconnect!
+          retry
         rescue => e
-          $err_file.puts e.inspect
-          $err_file.puts e.backtrace
+          $logger.error e.inspect
+          $logger.error e.backtrace
         end
       end if self.respond_to? :backend_func
       Thread.stop
@@ -85,22 +97,32 @@ module Rumpy
     def init
 
       xmppconfig  = YAML::load_file @config_path + '/xmpp.yml'
+      @logger.info 'loaded xmpp.yml'
+      @logger.debug "xmpp.yml: #{xmppconfig.inspect}"
       @lang       = YAML::load_file @config_path + '/lang.yml'
+      @logger.info 'loaded lang.yml'
+      @logger.debug "lang.yml: #{@lang.inspect}"
       @jid        = Jabber::JID.new xmppconfig['jid']
       @priority   = xmppconfig['priority']
       @status     = xmppconfig['status']
       @password   = xmppconfig['password']
       @client     = Jabber::Client.new @jid
+      Jabber::Version::SimpleResponder.new(@client, @bot_name || self.class.to_s, @bot_version || '1.0.0', RUBY_PLATFORM)
 
       if @models_path then
         dbconfig  = YAML::load_file @config_path + '/database.yml'
+        @logger.info 'loaded database.yml'
+        @logger.debug "database.yml: #{dbconfig.inspect}"
         ActiveRecord::Base.establish_connection dbconfig
+        @logger.info 'database connection established'
         Dir[@models_path].each do |file|
           self.class.require file
+          @logger.info "added models file '#{file}'"
         end
       end
 
       @main_model = Object.const_get @main_model.to_s.capitalize
+      @logger.info "main model set to #{@main_model}"
       def @main_model.find_by_jid(jid)
         super jid.strip.to_s
       end
@@ -115,19 +137,25 @@ module Rumpy
       @client.auth @password
       @roster = Jabber::Roster::Helper.new @client
       @roster.wait_for_roster
+      @logger.info 'xmpp connection established'
     end
 
     def clear_users
       @main_model.find_each do |user|
         items = @roster.find user.jid
-        user.destroy if items.count != 1
+        if items.count != 1 then
+          @logger.info "deleting from database user with jid #{user.jid}"
+          user.destroy
+        end
       end
       @roster.items.each do |jid, item|
         user = @main_model.find_by_jid jid
         if user.nil? then
+          @logger.info "deleting from roster user with jid #{jid}"
           item.remove
           next
         elsif item.subscription != :both then
+          @logger.info "deleting from roster&database user with jid #{jid}"
           item.remove
           user.destroy
         end
@@ -140,15 +168,24 @@ module Rumpy
         @roster.accept_subscription jid
         @client.send Jabber::Presence.new.set_type(:subscribe).set_to(jid)
         send_msg jid, @lang['hello']
+        @logger.info "#{jid} wanna subscribe"
       end
       @roster.add_subscription_callback do |item, presence|
-        case presence.type
-        when :unsubscribed, :unsubscribe
-          item.remove
-          remove_jid item.jid
-        when :subscribed
-          add_jid item.jid
-          send_msg item.jid, @lang['authorized']
+        begin
+          case presence.type
+          when :unsubscribed, :unsubscribe
+            @logger.info "#{item.jid} wanna unsubscribe"
+            item.remove
+            remove_jid item.jid
+          when :subscribed
+            add_jid item.jid
+            send_msg item.jid, @lang['authorized']
+          end
+        rescue ActiveRecord::StatementInvalid
+          @logger.warn 'Statement Invalid catched'
+          @logger.info 'Reconnecting to database'
+          @main_model.connection.reconnect!
+          retry
         end
       end
     end
@@ -158,7 +195,9 @@ module Rumpy
         begin
           if msg.type != :error and msg.body and msg.from then
             if user = @main_model.find_by_jid(msg.from) then
+              @logger.debug "get normal message from #{msg.from}"
               pars_results = parser_func msg.body
+              @logger.debug "parsed message: #{pars_results.inspect}"
 
               message = ""
               @mutexes[user.jid].synchronize do
@@ -166,21 +205,29 @@ module Rumpy
               end
               send_msg msg.from, message
             else
+              @logger.debug "uknown user #{msg.from}"
               send_msg msg.from, @lang['stranger']
               items = @roster.find msg.from.strip.to_s
               items.first.last.remove unless items.empty?
             end
           end
+        rescue ActiveRecord::StatementInvalid
+          @logger.warn 'Statement Invalid catched!'
+          @logger.info 'Reconnecting to database'
+          @main_model.connection.reconnect!
+          retry
         rescue => e
-          @err_file.puts e.inspect
-          @err_file.puts e.backtrace
+          @logger.error e.inspect
+          @logger.error e.backtrace
         end
       end
       @client.add_iq_callback do |iq|
-        if iq.type == :get then
+        @logger.debug "got iq #{iq.inspect}"
+        if iq.type == :get then # hack for pidgin (STOP USING IT)
           response = Jabber::Iq.new :error, iq.from
           response.id = iq.id
           if iq.elements["time"] == "<time xmlns='urn:xmpp:time'/>" then
+            @logger.debug 'this is time request, okay'
             response.set_type :result
             response.root.add REXML::Element.new('time')
             response.elements['time'].attributes['xmlns'] = 'urn:xmpp:time'
@@ -190,6 +237,7 @@ module Rumpy
             response.elements['time'].add REXML::Element.new('utc')
             response.elements['time/utc'].text = tm.utc.xmlschema
            end
+          @logger.debug "sending response: #{response}"
           @client.send response
         end
       end
@@ -199,6 +247,7 @@ module Rumpy
       return if destination.nil? or text.nil?
       msg = Jabber::Message.new destination, text
       msg.type = :chat
+      @logger.debug "sending message: #{msg}"
       @client.send msg
     end
 
@@ -206,11 +255,15 @@ module Rumpy
       user = @main_model.new
       user.jid = jid.strip.to_s
       user.save
+      @logger.info "added new user: #{jid}"
     end
 
     def remove_jid(jid)
       user = @main_model.find_by_jid jid
-      user.destroy unless user.nil?
+      unless user.nil?
+        @logger.info "removing user #{jid}"
+        user.destroy
+      end
     end
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rumpy
 version: !ruby/object:Gem::Version 
-  hash: 47
+  hash: 45
   prerelease: false
   segments: 
   - 0
   - 9
-  - 10
-  version: 0.9.10
+  - 11
+  version: 0.9.11
 platform: ruby
 authors: 
 - Tsokurov A.G.
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-19 00:00:00 +03:00
+date: 2011-07-20 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency