beerbot 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b63fcda572d39a2ff6d91a9c9d8f44cc188e5e01
-  data.tar.gz: 2b9a1a096feac44e1f8866273c067e860b0786be
+  metadata.gz: b0520c21dd31300f06b2ebf9968b47b637b0053a
+  data.tar.gz: 2bf90aba38d40d9de6c8f23148bac96f7b5358b5
 SHA512:
-  metadata.gz: ade4864380a1c71ba8309e104dd5d54b1a2acfca192819ee0b9e92ddc992fc88cd477786111f8e9f254c84a1994d8a43ff889afd510e004bd257286a35ceef22
-  data.tar.gz: 5d3c3c99e58ce189b476d4d308688884427af2889d98cb5f1f4fac1427c09dd2f42fff7fdd79ba3432fa82639397c8ad3962dd5349822dfe4ff492fa709a2d77
+  metadata.gz: 541a57a15d442bd567a71ce3fa000bd4f215fa1bd0ae5596620dc700860ad2db2702906fbbf3f88d877a1f12b62a0524563c211213ca9bfdcc91f0f296e8c3de
+  data.tar.gz: 0272651fdee9bb932ff00c3a3247cdec27f18353a603a0999f0b6b978ca4d6d601263b585672d5f8c19e612f06e0089f56804bfb2da68c35dfc29a72faa54160

data/lib/BeerBot.rb

@@ -1,16 +1,18 @@
 require 'CronR' # For scheduler
 
 require_relative 'BeerBot/00.utils/utils'
-require_relative 'BeerBot/00.utils/paramExpand'
+require_relative 'BeerBot/00.utils/param_expand'
+require_relative 'BeerBot/00.utils/sentence_expand'
 require_relative 'BeerBot/00.utils/DataFile'
 require_relative 'BeerBot/00.utils/InOut'
 require_relative 'BeerBot/00.utils/world/IRCWorld'
 require_relative 'BeerBot/01.connect/IRCConnection'
-require_relative 'BeerBot/01.protocols/botmsg'
-require_relative 'BeerBot/01.protocols/irc'
-require_relative 'BeerBot/02.bot/bot'
-require_relative 'BeerBot/03.more/BotMsgMore'
-require_relative 'BeerBot/06.dispatchers/irc'
+require_relative 'BeerBot/01.bot/botmsg'
+require_relative 'BeerBot/01.bot/BotModule'
+require_relative 'BeerBot/01.bot/Bot'
+require_relative 'BeerBot/01.bot/BotMsgMore'
+require_relative 'BeerBot/02.protocols/irc'
+require_relative 'BeerBot/06.dispatchers/dispatcher'
 require_relative 'BeerBot/70.scheduler/scheduler'
 require_relative 'BeerBot/Config'
 

data/lib/BeerBot/00.utils/param_expand.rb

@@ -0,0 +1,105 @@
+# The files in this directory are part of BeerBot, a a ruby irc bot library.
+# Copyright (C) 2014 Daniel Bush
+# This program is distributed under the terms of the GNU
+# General Public License.  A copy of the license should be
+# enclosed with this project in the file LICENSE.  If not
+# see <http://www.gnu.org/licenses/>.
+
+
+module BeerBot
+
+  module Utils
+
+    module ParamExpand
+
+      # Look for parameters in a string.
+      #
+      # Numeric parameters => "... ::1 ... ::2 "
+      # Key parameters => "... ::foo ... ::bar "
+      # Multi => "... ::foo|::1 ... ::bar|::foo|::1 "
+      # 
+      # (?: ) is a non-capturing group.
+
+      def self.scan_param msg
+        matches = msg.scan(/(?:::[^\W\s:|]*(?:\|::[^\W\s:|]*)*)/)
+        matches.map{|m|
+          a = m.split('|').map{|m2|
+            m2 = m2.sub('::','')
+            case m2
+            when /^\d+$/
+              m2.to_i
+            else
+              m2
+            end
+          }
+          [m,a]
+        }
+      end
+
+      # Expand a string with numeric and key parameters using data
+      # provided.
+      #
+      # Parameters should be preceded with a double-colon in the msg.
+      # Numeric parameters are matched to 'args'.
+      # So ::1 => args[0] etc
+      #
+      # 'expand' will return the expanded string as best it can and an
+      # error object.
+      # The error object will tell you if there weren't enough
+      # parameters in args to satisfy the numeric parameters in the
+      # string.
+      # 
+      # Example:
+      # 
+      #   "::1 ::foo ::bar|::1" using ('a',foo:'b')
+      #   => "a b a"
+
+      def self.expand msg,*args,**kargs
+        errargs = []
+        params = self.scan_param(msg)
+        # Do the big ones first.
+        params = params.sort{|a,b|b[1].size<=>a[1].size}
+        params.each {|i|
+          # pattern: "::1|::foo"
+          # parts: [1,'foo']
+          pattern,parts = i
+          found = false
+          _errargs = []
+          _errkargs = []
+          parts.each {|part|
+            v = nil
+            case part
+            when Fixnum
+              v = args[part-1]
+              _errargs.push(part) unless v
+            else
+              if part == '' then  # pattern is or contains '::' which has part ''.
+                v = ''
+              else
+                v = kargs[part.to_sym]
+                _errkargs.push(part) unless v
+              end
+            end
+            if v then
+              if v == '' then
+                #byebug
+                # Squeeze spaces.  Not perfect, but it'll do.
+                msg = msg.gsub(/ ?#{pattern.gsub('|','\|')} ?/,' ')
+              else
+                msg = msg.gsub(pattern,v.to_s)
+              end
+              found = true
+            end
+          }
+          unless found then
+            errargs += _errargs
+          end
+        }
+        [msg,errargs]
+      end
+
+    end
+
+  end
+
+end

data/lib/BeerBot/00.utils/{paramExpand.rb → sentence_expand.rb}

@@ -29,7 +29,7 @@ module BeerBot
     # The entry from <value> will also undergo the
     # same ':' substitution.
 
-    module ParamExpand
+    module SentenceExpand
 
       # Recursively expand a sentence with parameters starting with
       # ':' using values sampled from params.

data/lib/BeerBot/00.utils/utils.rb

@@ -10,30 +10,6 @@ module BeerBot
 
   module Utils
 
-    # Look for parameters in a string.
-    #
-    # Numeric parameters => "... ::1 ... ::2 "
-    # Key parameters => "... ::foo ... ::bar "
-    # Multi => "... ::foo|::1 ... ::bar|::foo|::1 "
-    # 
-    # (?: ) is a non-capturing group.
-
-    def self.scan_param msg
-      matches = msg.scan(/(?:::[^\W\s:|]*(?:\|::[^\W\s:|]*)*)/)
-      matches.map{|m|
-        a = m.split('|').map{|m2|
-          m2 = m2.sub('::','')
-          case m2
-          when /\d+/
-            m2.to_i
-          else
-            m2
-          end
-        }
-        [m,a]
-      }
-    end
-
     # Return a parser that takes string msg and extracts a specified
     # prefix at beginning.
     #
@@ -53,65 +29,6 @@ module BeerBot
       }
     end
 
-    # Expand a string with numeric and key parameters using data
-    # provided.
-    #
-    # Parameters should be preceded with a double-colon in the msg.
-    # Numeric parameters are matched to 'args'.
-    # So ::1 => args[0] etc
-    #
-    # 'expand' will return the expanded string as best it can and an
-    # error object.
-    # The error object will tell you if there weren't enough
-    # parameters in args to satisfy the numeric parameters in the
-    # string.
-    # 
-    # ("::1 ::foo ::bar|::1",'a',foo:'b') => "a b a"
-
-    def self.expand msg,*args,**kargs
-      errargs = []
-      params = self.scan_param(msg)
-      # Do the big ones first.
-      params = params.sort{|a,b|b[1].size<=>a[1].size}
-      params.each {|i|
-        # pattern: "::1|::foo"
-        # parts: [1,'foo']
-        pattern,parts = i
-        found = false
-        _errargs = []
-        _errkargs = []
-        parts.each {|part|
-          v = nil
-          case part
-          when Fixnum
-            v = args[part-1]
-            _errargs.push(part) unless v
-          else
-            if part == '' then  # pattern is or contains '::' which has part ''.
-              v = ''
-            else
-              v = kargs[part.to_sym]
-              _errkargs.push(part) unless v
-            end
-          end
-          if v then
-            if v == '' then
-              #byebug
-              # Squeeze spaces.  Not perfect, but it'll do.
-              msg = msg.gsub(/ ?#{pattern.gsub('|','\|')} ?/,' ')
-            else
-              msg = msg.gsub(pattern,v.to_s)
-            end
-            found = true
-          end
-        }
-        unless found then
-          errargs += _errargs
-        end
-      }
-      [msg,errargs]
-    end
-
     # Regex that looks for a sed command eg
     # "s/pattern/replacement/flags" in a string.
     #

data/lib/BeerBot/{02.bot/bot.rb → 01.bot/Bot.rb}

@@ -5,25 +5,11 @@
 # enclosed with this project in the file LICENSE.  If not
 # see <http://www.gnu.org/licenses/>.
 
-require_relative '../01.protocols/botmsg.rb'
+require_relative 'botmsg.rb'
+require_relative 'BotModule.rb'
 
 module BeerBot
 
-  BotMsg = BeerBot::Protocol::BotMsg
-
-  # Represents a bot module and may contain a reference to the loaded
-  # ruby module or any errors associated with loading it.
-
-  class BotModule < Hash
-    def initialize name,status:false,mod:nil,modname:nil,errors:[]
-      self[:status] = status
-      self[:name] = name  # The module name.
-      self[:mod] = mod  # The loaded ruby module.
-      self[:modname] = modname
-      self[:errors] = errors
-    end
-  end
-
   # Represents a sequence of BotModule instances.
 
   class Bot < Array
@@ -114,24 +100,37 @@ module BeerBot
       }
     end
 
+    # Process messages addressed directly to the bot.
+
     def cmd msg,from:nil,to:nil,me:false,world:nil
       if @cmd then
-        botmsg = @cmd.call(msg,from:from,to:to,world:world,me:me)
-        return botmsg
+        @cmd.call(msg,from:from,to:to,world:world,me:me)
       else
         self.run(:cmd,msg,from:from,to:to,world:world,me:me)
       end
     end
 
+    # Process messages the bot overhears.
+
     def hear msg,from:nil,to:nil,me:false,world:nil
       if @hear then
-        botmsg = @hear.call(msg,from:from,to:to,me:me,world:world)
-        return botmsg
+        @hear.call(msg,from:from,to:to,me:me,world:world)
       else
         self.run(:hear,msg,from:from,to:to,me:me,world:world)
       end
     end
 
+    # Handle events other than being messaged.
+    #
+    # IRC events like joining channels, changing nicks etc.
+    #
+    # Both event and kargs is dependent on the dispatcher which in
+    # turn is dependent on how the protocol (eg irc) is parsed.
+
+    def event event,**kargs
+      self.run(:event,event,**kargs)
+    end
+
     def help arr,from:nil,to:nil,world:nil,me:false
       m = []
       modname,*topics = arr

data/lib/BeerBot/01.bot/BotModule.rb

@@ -0,0 +1,16 @@
+
+module BeerBot
+  # Represents a bot module and may contain a reference to the loaded
+  # ruby module or any errors associated with loading it.
+
+  class BotModule < Hash
+    def initialize name,status:false,mod:nil,modname:nil,errors:[]
+      self[:status] = status
+      self[:name] = name  # The module name.
+      self[:mod] = mod  # The loaded ruby module.
+      self[:modname] = modname
+      self[:errors] = errors
+    end
+  end
+
+end

data/lib/BeerBot/{03.more → 01.bot}/BotMsgMore.rb

@@ -9,16 +9,17 @@ require_relative '../00.utils/More'
 
 module BeerBot
 
-  # More-based system (see More).
+  # More-based filter that can be applied to botmsg's.
   #
-  # #filter expects a botmsg and returns an array botmsg.
+  # #filter expects a botmsg and returns an array, either of botmsg's
+  # or emtpy.
 
   class BotMsgMore < ::BeerBot::Utils::More
     def filter botmsg
-      return nil unless botmsg
+      arr = BeerBot::BotMsg.to_a(botmsg)
+      # At this point if arr isn't a valid bot msg we'll get [].
       replies = []
       by_to = Hash.new{|h,k| h[k]=[]}
-      arr = BeerBot::Protocol::BotMsg.to_a(botmsg)
 
       arr.inject(by_to){|h,v| h[v[:to]].push(v); h}
       by_to.each_pair{|to,a|

data/lib/BeerBot/01.bot/botmsg.rb

@@ -0,0 +1,105 @@
+# The files in this directory are part of BeerBot, a a ruby irc bot library.
+# Copyright (C) 2013,2014 Daniel Bush
+# This program is distributed under the terms of the GNU
+# General Public License.  A copy of the license should be
+# enclosed with this project in the file LICENSE.  If not
+# see <http://www.gnu.org/licenses/>.
+
+module BeerBot
+
+    # BotMsg's are hashes or arrays of hashes and represent a bot
+    # response (usually to some input eg from an irc server).
+    #
+    # The hash is generally expected to have the following keys:
+    # 
+    #   :msg
+    #   :to
+    #   
+    # but may carry additional ones like
+    # 
+    #   :action (will be used instead of :msg)
+    #
+    # The array-form of the botmsg might look like this:
+    # 
+    #   [msg:'ho!',to:'#chan1']
+    #   
+    # and it is easy to add extra messages this way:
+    # 
+    #   [msg:'ho!',to:'#chan1'] + [msg:'ho again!',to:'#chan1']
+    #   
+    # etc
+
+    module BotMsg
+
+      # Determine if botmsg is a valid botmsg.
+
+      def self.valid? botmsg
+        case botmsg
+        when Hash
+          a = botmsg.has_key?(:to)
+          b = (botmsg.has_key?(:msg) || botmsg.has_key?(:action))
+          a && b
+        when Array
+          botmsg.inject(true){|s,v|
+            # Members must be hash... 
+            break false unless v.kind_of?(Hash)
+            s = s && self.valid?(v);
+            break false unless s;
+            s
+          }
+        when Proc
+          false
+        else
+          false
+        end
+      end
+
+      # Convert botmsg to an array of one or more botmsg hashes.
+      #
+      # Returns array of botmsg hashes or empty array if not given
+      # something that is valid.
+      #
+      # Proc's are executed to retrieve an array or hash.
+      #
+      # Array => Array
+      # Hash  => [Hash]
+      # Proc  => [Hash]
+
+      def self.to_a botmsg
+        case botmsg
+        when Hash
+          return [] unless self.valid?(botmsg)
+          return [botmsg]
+        when Array
+          return [] unless self.valid?(botmsg)
+          return botmsg
+        when Proc
+          return self.to_a(botmsg.call)
+        else
+          return []
+        end
+      end
+
+      # Convert botmsg to an action if it starts with '*'.
+
+      def self.actionify botmsg
+        case botmsg
+        when Hash
+          case botmsg[:msg]
+          when /^\*\s*/
+            botmsg[:action] = botmsg[:msg].sub(/^\*\s*/,'')
+            botmsg[:msg] = nil
+          end
+          botmsg
+        when Array
+          botmsg.map {|b|
+            self.actionify(b)
+          }
+        else
+          botmsg
+        end
+      end
+      
+    end
+    
+end

data/lib/BeerBot/{01.protocols → 02.protocols}/irc.rb

@@ -11,8 +11,11 @@ module BeerBot
 
     module IRC
 
-      # In coming IRC messages are parsed into hashes with several
-      # additional methods.
+      # This class represents an irc message broken down into its
+      # major constituent parts.
+      #
+      # These include the prefix, command, parameters and trailing
+      # components of an irc message.
 
       class IRCMessage < Hash
 
@@ -110,18 +113,24 @@ module BeerBot
 
       end
 
-      # Parse raw irc string and then yield for various events. 
+      # Parse raw irc string and then yield or return a generic
+      # representation of the event.
+      #
+      # Returns [event,*args]
+      #
+      # Parse's job is to take the constituents parts of an irc
+      # message, identify the type of event and return a generic
+      # representation of it.
+      #
+      # So for instance, an irc privmsg (message) is represented as
+      #   [:msg,from,to,msg]
       # 
-      # The lambda receives an incoming irc string, tries to parse
-      # it and act on it.
-      # The lambda should return nil or a botmsg hash.
       # Note that connection readiness and PONG protocol are handled by
       # the irc connection, not here.
 
-      def self.parse str,&block
+      def self.parse str
 
         m = IRCMessage.new(str)
-        #puts "[parse] #{m}"
         result = []
 
         case m[:command]
@@ -180,17 +189,13 @@ module BeerBot
           msg  = m[:trailing].strip
           from = m[:prefix][:nick].strip
           to   = m[:params][0].strip unless m[:params].empty?
-          result = [:privmsg,from,to,msg]
+          result = [:msg,from,to,msg]
 
         else # command we don't handle
           result = [:default,m]
         end
 
-        if block_given? then
-          yield result
-        else
-          result
-        end
+        result
       end
 
       # Return irc-conformat string from a botmsg hash.

data/lib/BeerBot/06.dispatchers/{irc.rb → dispatcher.rb}

@@ -6,8 +6,7 @@
 # see <http://www.gnu.org/licenses/>.
 
 require_relative '../00.utils/utils'
-require_relative '../01.protocols/irc'
-require_relative '../03.more/BotMsgMore'
+require_relative '../01.bot/BotMsgMore'
 
 module BeerBot
 
@@ -16,20 +15,24 @@ module BeerBot
 
   module Dispatchers
 
-    # This dispatcher calls BeerBot::Protocol::IRC.parse on what it
-    # receives and then processes the response.
+    # This dispatcher receives generic events (provided by a parser
+    # for a given protocol eg irc) and does something with them.
     #
-    # There are several ways to specify how the result of parse is
-    # processed.  You can:
+    # Dispatcher#receive receives the messages.
+    # 
+    # There are several ways to specify what the dispatcher should do:
+    # 1) just get the result of #receive
+    # 
+    # Or, override #receive's behaviour:
     # 1) pass in a block at instantiation time
-    # 2) set a block using #set_receive
+    # 2) pass in a block using #set_receive
     # 3) subclass this class and write your own #receive
 
-    class IRCDispatcher
+    class Dispatcher
 
-      IRC   = BeerBot::Protocol::IRC
-      Utils = BeerBot::Utils
-      BotMsgMore    = BeerBot::BotMsgMore
+      Utils      = BeerBot::Utils
+      BotMsg     = BeerBot::BotMsg
+      BotMsgMore = BeerBot::BotMsgMore
       
       attr_accessor :bot,:nick,:prefix,:world,:more
 
@@ -63,44 +66,44 @@ module BeerBot
         end
       end
 
-      def parse irc_str
-        IRC.parse(irc_str)
-      end
-
-      def receive irc_str
-
-        event,*args = self.parse(irc_str)
+      def receive event,args
 
         if @block then
           return self.instance_exec(event,*args,&@block)
         end
 
+        replies = nil
+
         # Otherwise, here is the default behaviour...
 
         case event
         when :unknown
-          #puts "protocol/irc :unknown"
+          replies = @bot.event(event,args:args)
         when :default
-          #puts "protocol/irc :default"
+          replies = @bot.event(event,args:args)
         when :nick
           old,nick = args
           @world.nick(old,nick) if @world
+          replies = @bot.event(event,old:old,nick:nick)
         when :part
           nick,channel = args
           @world.part(nick,channel) if @world
+          replies = @bot.event(event,nick:nick,channel:channel)
         when :join
           nick,channel = args
+          me = (@nickrx === nick)
           @world.join(nick,channel) if @world
+          replies = @bot.event(event,me:me,nick:nick,channel:channel)
         when :chanlist
-          #p "[dispatcher] :chanlist"
           channel,users = args
           if @world then
             users.each {|user|
               @world.join(user,channel)
             }
           end
+          replies = @bot.event(event,channel:channel,users:users)
 
-        when :privmsg
+        when :msg
 
           from,to,msg = args
 
@@ -137,18 +140,17 @@ module BeerBot
           end
 
         else
-          puts "protocol/irc unrecognised event: '#{event}'"
+          puts "[dispatcher] unrecognised event: '#{event}'"
         end
 
         case replies
-        when String # assume irc string
+        when String # assume protocol string eg irc
           replies
         when Hash,Array,Proc
           # more-filter the reply...
           replies = @more.filter(replies)
-          IRC.to_irc(replies)
         else
-          nil
+          []
         end
 
       end

data/lib/RunIRC.rb

@@ -28,7 +28,7 @@ class BeerBot::RunIRC
   IRCConnection = BeerBot::IRCConnection
   IRC           = BeerBot::Protocol::IRC
   Bot           = BeerBot::Bot
-  IRCDispatcher = BeerBot::Dispatchers::IRCDispatcher
+  Dispatcher    = BeerBot::Dispatchers::Dispatcher
   Scheduler     = BeerBot::Scheduler
 
   attr_accessor :config,:bot,:scheduler,:dispatcher,:world,:conn,:postq,:parse,:more
@@ -53,7 +53,7 @@ class BeerBot::RunIRC
     @world = IRCWorld.new(config['nick'])
 
     # Dispatcher which receives messages and interacts with the bot.
-    @dispatcher = IRCDispatcher.new(
+    @dispatcher = Dispatcher.new(
       @bot,
       config['nick'],
       prefix:config['cmd_prefix'],
@@ -68,12 +68,14 @@ class BeerBot::RunIRC
       nick:config['nick'],
       server:config['server'])
 
-    # Dispatcher thread takes stuff from @conn queue and processes
-    # it...
+    # Dispatcher thread takes stuff coming from the irc connection and does
+    # something with it...
 
     @dispatcher_thread = InOut.new(inq:@conn.queue,outq:@conn.writeq) {|input|
       str,raw = input
-      replies = @dispatcher.receive(str)
+      event,*args = IRC.parse(str)
+      replies = @dispatcher.receive(event,args)
+      IRC.to_irc(replies)
     }
     @dispatcher_thread.start!
 
@@ -85,7 +87,7 @@ class BeerBot::RunIRC
     @scheduler_thread = InOut.new(inq:@scheduler.queue,outq:@conn.writeq) {|cron_job|
       puts "<< scheduler #{cron_job.inspect}"
       puts "<< scheduler #{@scheduler.time}"
-      IRC.to_irc(cron_job.job)
+      IRC.to_irc(cron_job.run)
     }
     @scheduler_thread.start!
 

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beerbot
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - Daniel Bush
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-04-20 00:00:00.000000000 Z
+date: 2014-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -88,20 +88,22 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- lib/BeerBot/00.utils/utils.rb
+- lib/BeerBot/00.utils/param_expand.rb
+- lib/BeerBot/00.utils/sentence_expand.rb
 - lib/BeerBot/00.utils/DataFile.rb
 - lib/BeerBot/00.utils/InOut.rb
 - lib/BeerBot/00.utils/More.rb
-- lib/BeerBot/00.utils/paramExpand.rb
-- lib/BeerBot/00.utils/utils.rb
-- lib/BeerBot/00.utils/world/IRCWorld.rb
 - lib/BeerBot/00.utils/world/World.rb
+- lib/BeerBot/00.utils/world/IRCWorld.rb
 - lib/BeerBot/01.connect/Connection.rb
 - lib/BeerBot/01.connect/IRCConnection.rb
-- lib/BeerBot/01.protocols/botmsg.rb
-- lib/BeerBot/01.protocols/irc.rb
-- lib/BeerBot/02.bot/bot.rb
-- lib/BeerBot/03.more/BotMsgMore.rb
-- lib/BeerBot/06.dispatchers/irc.rb
+- lib/BeerBot/01.bot/botmsg.rb
+- lib/BeerBot/01.bot/BotModule.rb
+- lib/BeerBot/01.bot/Bot.rb
+- lib/BeerBot/01.bot/BotMsgMore.rb
+- lib/BeerBot/02.protocols/irc.rb
+- lib/BeerBot/06.dispatchers/dispatcher.rb
 - lib/BeerBot/70.scheduler/scheduler.rb
 - lib/BeerBot/Config.rb
 - lib/BeerBot.rb

data/lib/BeerBot/01.protocols/botmsg.rb

@@ -1,59 +0,0 @@
-# The files in this directory are part of BeerBot, a a ruby irc bot library.
-# Copyright (C) 2013,2014 Daniel Bush
-# This program is distributed under the terms of the GNU
-# General Public License.  A copy of the license should be
-# enclosed with this project in the file LICENSE.  If not
-# see <http://www.gnu.org/licenses/>.
-
-module BeerBot
-
-  module Protocol
-
-    module BotMsg
-
-      # Convert botmsg to an array of one or more botmsg hashes.
-      #
-      # Proc's are executed to retrieve an array or hash.
-      #
-      # Array => Array
-      # Hash  => [Hash]
-      # Proc  => [Hash]
-
-      def self.to_a botmsg
-        case botmsg
-        when Hash
-          return [botmsg]
-        when Array
-          return botmsg
-        when Proc
-          return self.to_a(botmsg.call)
-        else
-          return []
-        end
-      end
-
-      # Convert botmsg to an action if it starts with '*'.
-
-      def self.actionify botmsg
-        case botmsg
-        when Hash
-          case botmsg[:msg]
-          when /^\*\s*/
-            botmsg[:action] = botmsg[:msg].sub(/^\*\s*/,'')
-            botmsg[:msg] = nil
-          end
-          botmsg
-        when Array
-          botmsg.map {|b|
-            self.actionify(b)
-          }
-        else
-          botmsg
-        end
-      end
-      
-    end
-
-    
-  end
-end