rumpy 0.9.22 → 0.9.23

data/lib/rumpy/bot.rb

@@ -0,0 +1,317 @@
+require 'rubygems'
+require 'xmpp4r/client'
+require 'xmpp4r/roster'
+require 'xmpp4r/version'
+require 'active_record'
+require 'logger'
+
+# include this module into your bot's class
+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
+    logger_init
+
+    init
+
+    connect
+
+    set_iq_callback
+    set_subscription_callback
+    set_message_callback
+
+    start_backend_thread
+    start_output_queue_thread
+
+    prepare_users
+
+    @logger.info 'Bot is going ONLINE'
+    @output_queue.enq Jabber::Presence.new(nil, @status, @priority)
+
+    add_signal_trap
+
+    Thread.stop
+  rescue => ex
+    general_error ex
+    exit
+  end # def start
+
+  private
+
+  def logger_init
+    unless @logger
+      @log_file             ||= STDERR
+      @log_level            ||= Logger::INFO
+      @logger                 = Logger.new @log_file, @log_shift_age, @log_shift_size
+      @logger.level           = @log_level
+      @logger.datetime_format = "%Y-%m-%d %H:%M:%S"
+    end
+
+    @logger.info 'starting bot'
+  end
+
+  def init
+    @config_path ||= 'config'
+    @main_model  ||= :user
+
+    @logger.debug 'initializing some variables'
+
+    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_files
+      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'
+      @models_files.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}"
+
+    @queues = Hash.new do |h, k|
+      h[k]  = Queue.new
+    end
+
+    @output_queue = Queue.new
+  end # def init
+
+  def connect
+    @logger.debug 'establishing xmpp connection'
+
+    @client.connect
+    @client.auth @password
+    @roster = Jabber::Roster::Helper.new @client
+    @roster.wait_for_roster
+
+    @logger.info 'xmpp connection established'
+  end
+
+  def set_iq_callback
+    @client.add_iq_callback do |iq|
+      @logger.debug "got iq #{iq}"
+      if iq.type == :get # hack for pidgin (STOP USING IT)
+        response = iq.answer true
+        if iq.elements['time'] == "<time xmlns='urn:xmpp:time'/>"
+          @logger.debug 'this is time request, okay'
+          response.set_type :result
+          tm = Time.now
+          response.elements['time'].add REXML::Element.new('tzo')
+          response.elements['time/tzo'].text = tm.xmlschema[-6..-1]
+          response.elements['time'].add REXML::Element.new('utc')
+          response.elements['time/utc'].text = tm.utc.xmlschema
+        else
+          response.set_type :error
+        end # if iq.elements['time']
+        @output_queue.enq response
+      end
+    end
+  end # def set_iq_callback
+
+  def set_subscription_callback
+    @roster.add_subscription_request_callback do |item, presence|
+      jid = presence.from
+      @roster.accept_subscription jid
+      @output_queue.enq presence.answer.set_type :subscribe
+      @output_queue.enq Jabber::Message.new(jid, @lang['hello']).set_type :chat
+
+      @logger.info "#{jid} just subscribed"
+    end
+    @roster.add_subscription_callback do |item, presence|
+      begin
+        case presence.type
+        when :unsubscribed, :unsubscribe
+          @logger.info "#{item.jid} wanna unsubscribe"
+          @queues[item.jid.strip.to_s].enq :unsubscribe
+          item.remove
+        when :subscribed
+          user = @main_model.new
+          user.jid = item.jid.strip.to_s
+          user.save
+          start_user_thread user
+
+          @logger.info "added new user: #{user.jid}"
+          @output_queue.enq Jabber::Message.new(item.jid, @lang['authorized']).set_type :chat
+        end
+      rescue ActiveRecord::StatementInvalid
+        statement_invalid_error
+        retry
+      rescue ActiveRecord::ConnectionTimeoutError
+        connection_timeout_error
+        retry
+      rescue => ex
+        general_error ex
+      end
+    end
+  end # def set_subscription_callback
+
+  def set_message_callback
+    @client.add_message_callback do |msg|
+      if msg.type != :error && msg.body && msg.from
+        if @roster[msg.from] && @roster[msg.from].subscription == :both
+          @logger.debug "got normal message #{msg}"
+
+          @queues[msg.from.strip.to_s].enq msg
+        else
+          @logger.debug "user not in roster: #{msg.from}"
+
+          @output_queue.enq msg.answer.set_body @lang['stranger']
+        end
+      end
+    end
+  end # def set_message_callback
+
+  def start_backend_thread
+    Thread.new do
+      begin
+        loop do
+          backend_func().each do |result|
+            message = Jabber::Message.new(*result).set_type :chat
+            @output_queue.enq message if message.body && message.to
+          end
+        end
+      rescue ActiveRecord::StatementInvalid
+        statement_invalid_error
+        retry
+      rescue ActiveRecord::ConnectionTimeoutError
+        connection_timeout_error
+        retry
+      rescue => ex
+        general_error ex
+      end # begin
+    end if self.respond_to? :backend_func
+  end # def start_backend_thread
+
+  def start_output_queue_thread
+    Thread.new do
+      @logger.info "Output queue initialized"
+      until (msg = @output_queue.deq) == :halt do
+        if msg.nil?
+          @logger.debug "got nil message. wtf?"
+        else
+          @logger.debug "sending message #{msg}"
+          @client.send msg
+        end
+      end
+      @logger.info "Output queue destroyed"
+    end
+  end # def start_output_queue_thread
+
+  def add_signal_trap
+    Signal.trap :TERM do |signo| # soft stop
+      @logger.info 'Bot is unavailable'
+      @output_queue.enq Jabber::Presence.new.set_type :unavailable
+
+      @queues.each do |user, queue|
+        queue.enq :halt
+      end
+      sleep 1 until @queues.empty?
+
+      @output_queue.enq :halt
+      sleep 1 until @output_queue.empty?
+
+      @client.close
+
+      @logger.info 'terminating'
+      @logger.close
+      exit
+    end
+  end
+
+  def prepare_users
+    @logger.debug 'clear wrong users'
+
+    @roster.items.each do |jid, item|
+      user = @main_model.find_by_jid jid.strip.to_s
+      if user.nil? || item.subscription != :both
+        @logger.info "deleting from roster user with jid #{jid}"
+        item.remove
+      end
+    end
+    @main_model.find_each do |user|
+      items = @roster.find user.jid
+      if items.empty?
+        @logger.info "deleting from database user with jid #{user.jid}"
+        user.destroy
+      else
+        start_user_thread user
+      end
+    end
+
+    @main_model.connection_pool.release_connection
+  end # def prepare_users
+
+  def start_user_thread(user)
+    Thread.new(user) do |user|
+      @logger.debug "thread for user #{user.jid} started"
+
+      until (msg = @queues[user.jid].deq).kind_of? Symbol do
+        begin
+          pars_results = parser_func msg.body
+          @logger.debug "parsed message: #{pars_results.inspect}"
+          answer = do_func user, pars_results
+          @output_queue.enq msg.answer.set_body answer unless answer.nil? or answer.empty?
+        rescue ActiveRecord::StatementInvalid
+          statement_invalid_error
+          retry
+        rescue ActiveRecord::ConnectionTimeoutError
+          connection_timeout_error
+          retry
+        rescue => ex
+          general_error ex
+        end # begin
+
+        @main_model.connection_pool.release_connection
+      end # until (msg = @queues[user.jid].deq).kind_of? Symbol do
+
+      if msg == :unsubscribe
+        @logger.info "removing user #{user.jid}"
+        user.destroy
+      end
+
+      @queues.delete user.jid
+
+    end # Thread.new do
+  end # def start_user_thread(user)
+
+  def statement_invalid_error
+    @logger.warn 'Statement Invalid catched'
+    @logger.info 'Reconnecting to database'
+    @main_model.connection.reconnect!
+  end
+
+  def connection_timeout_error
+    @logger.warn 'ActiveRecord::ConnectionTimeoutError'
+    @logger.info 'sleep and retry again'
+    sleep 3
+  end
+
+  def general_error(exception)
+    @logger.error exception.inspect
+    @logger.error exception.backtrace
+  end
+end # module Rumpy::Bot
+

data/lib/rumpy/version.rb

@@ -0,0 +1,3 @@
+module Rumpy
+  VERSION = '0.9.23'
+end

metadata

@@ -1,99 +1,77 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: rumpy
-version: !ruby/object:Gem::Version 
-  hash: 23
+version: !ruby/object:Gem::Version
+  version: 0.9.23
   prerelease: 
-  segments: 
-  - 0
-  - 9
-  - 22
-  version: 0.9.22
 platform: ruby
-authors: 
+authors:
 - Tsokurov A.G.
 - Pogoda M.V.
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-11-20 00:00:00 Z
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2012-01-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: activerecord
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
+  requirement: &71062650 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">"
-      - !ruby/object:Gem::Version 
-        hash: 7
-        segments: 
-        - 3
-        - 0
-        version: "3.0"
+    requirements:
+    - - ! '>'
+      - !ruby/object:Gem::Version
+        version: '3.0'
   type: :runtime
-  version_requirements: *id001
-- !ruby/object:Gem::Dependency 
-  name: xmpp4r
   prerelease: false
-  requirement: &id002 !ruby/object:Gem::Requirement 
+  version_requirements: *71062650
+- !ruby/object:Gem::Dependency
+  name: xmpp4r
+  requirement: &71062130 !ruby/object:Gem::Requirement
     none: false
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        hash: 1
-        segments: 
-        - 0
-        - 5
-        version: "0.5"
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0.5'
   type: :runtime
-  version_requirements: *id002
+  prerelease: false
+  version_requirements: *71062130
 description: Rumpy is some kind of framework to make up your own jabber bot quickly.
-email: 
+email:
 - mpogoda@lavabit.com
 - me@ximik.net
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
+extra_rdoc_files:
 - README.rdoc
-files: 
+files:
 - lib/rumpy.rb
 - README.rdoc
+- lib/rumpy/bot.rb
+- lib/rumpy/version.rb
 homepage: https://github.com/Ximik/Rumpy
-licenses: 
+licenses:
 - MIT
 post_install_message: 
-rdoc_options: 
+rdoc_options:
 - --main
 - README.rdoc
-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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
-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 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
 rubyforge_project: 
-rubygems_version: 1.8.10
+rubygems_version: 1.8.15
 signing_key: 
 specification_version: 3
 summary: Rumpy == jabber bot framework
 test_files: []
-