rumpy 0.9.12 → 0.9.14

data/README.rdoc

@@ -30,6 +30,7 @@ Our goal is 'DO NOT REINVENT THE WHEEL'.
     @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.
   * Write 3 methods:

data/lib/rumpy.rb

@@ -3,11 +3,12 @@ require 'xmpp4r/client'
 require 'xmpp4r/roster'
 require 'xmpp4r/version'
 require 'active_record'
-require 'active_record/validations'
 require 'logger'
 
 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
@@ -22,6 +23,8 @@ module Rumpy
     true
   end
 
+  # Determine the name of pid_file, read pid from this file
+  # and try to kill process with this pid
   def self.stop(botclass)
     pf = pid_file botclass.new
     return false unless File.exist? pf
@@ -35,25 +38,33 @@ module Rumpy
     true
   end
 
+  # Create new instance of `botclass` and start it without detaching
   def self.run(botclass)
     botclass.new.start
   end
 
+  # Determine the name of file where thid pid will stored to
   def self.pid_file(bot)
     pid_file = bot.pid_file
     pid_file = bot.class.to_s.downcase + '.pid' if pid_file.nil?
     pid_file
   end
 
+  # include this module into your bot's class
   module Bot
     attr_reader :pid_file
 
+    # one and only public function, defined in this module
+    # simply initializes bot's variables, connection, etc.
+    # and starts bot
     def start
-      @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"
+      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
@@ -67,12 +78,22 @@ module Rumpy
       connect
       @logger.debug 'clear wrong users'
       clear_users
+
       set_subscription_callback
       set_message_callback
       set_iq_callback
+
+      start_backend_thread
+
       @logger.info 'Bot is going ONLINE'
       @client.send Jabber::Presence.new.set_priority(@priority).set_status(@status)
 
+      Thread.stop
+    end
+
+    private
+
+    def start_backend_thread
       Thread.new do
         begin
           loop do
@@ -90,11 +111,8 @@ module Rumpy
           $logger.error e.backtrace
         end
       end if self.respond_to? :backend_func
-      Thread.stop
     end
 
-    private
-
     def init
 
       xmppconfig  = YAML::load_file @config_path + '/xmpp.yml'
@@ -127,10 +145,6 @@ module Rumpy
       def @main_model.find_by_jid(jid)
         super jid.strip.to_s
       end
-
-      @mutexes = Hash.new do |h, k|
-        h[k] = Mutex.new
-      end
     end
 
     def connect
@@ -144,7 +158,7 @@ module Rumpy
     def clear_users
       @main_model.find_each do |user|
         items = @roster.find user.jid
-        if items.count != 1 then
+        if items.count.zero? then
           @logger.info "deleting from database user with jid #{user.jid}"
           user.destroy
         end
@@ -160,6 +174,7 @@ module Rumpy
           user.destroy
         end
       end
+      @main_model.connection_pool.release_connection
     end
 
     def set_subscription_callback
@@ -207,10 +222,7 @@ module Rumpy
               pars_results = parser_func msg.body
               @logger.debug "parsed message: #{pars_results.inspect}"
 
-              message = ""
-              @mutexes[user.jid].synchronize do
-                message = do_func user, pars_results
-              end
+              message = do_func user, pars_results
               send_msg msg.from, message
             else
               @logger.debug "uknown user #{msg.from}"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: rumpy
 version: !ruby/object:Gem::Version 
-  hash: 35
+  hash: 39
   prerelease: false
   segments: 
   - 0
   - 9
-  - 12
-  version: 0.9.12
+  - 14
+  version: 0.9.14
 platform: ruby
 authors: 
 - Tsokurov A.G.
@@ -16,7 +16,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-08-10 00:00:00 +03:00
+date: 2011-08-14 00:00:00 +03:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency