beerbot 0.2.0.pre.1 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 87f292c599a9b6b747cf3946ba5693c3eac5e6fc
-  data.tar.gz: 0a3a0612f3cedbb8c52508dba7cf67af4f5cae6f
+  metadata.gz: 7a0dc4eb8b5c748b98024c4ce5f25f0f21b8218a
+  data.tar.gz: 6d76393e5ef06f338e6cae31d091d00d36a4b658
 SHA512:
-  metadata.gz: e3d16c56405388a6183dc99057dc1953c18f3df825e295ca07f4c851ddff2d3103449f89d8e56ad9a12b56fa7c3f67a0f3d53cb1ce90f088e29e5fa74107eb66
-  data.tar.gz: 4b629d26bd44bd7a0a9e1590f07ed74f41323b3575a9415db57518a28d7c8c24d9f91a7f1163ec83bb5e7ec5a31a4715b16f23b7f172c65896c152281040cb6f
+  metadata.gz: 5396eca45c494e31575d230b6f16402190cd0efa80ecf6045ac0a102655318a1899d4490c2f0f1f2682186b8086a2c4ba1c2adf4dde04d9f77af77ce4b220fc0
+  data.tar.gz: 64f103ff21e97a574385f0fc1d07e93eed17c3732b1e3af15e9c8a06a01013d231080a5775a1540549f27edd8a1fd7d4b8d10684c246b08389f0333c819df63d

data/bin/beerbot-run-irc.rb

@@ -13,7 +13,14 @@
 #   ruby -Ilib bin/beerbot-run-irb.rb path/to/conf.json
 
 raise "Needs ruby 2" if /^1/===RUBY_VERSION
-require_relative '../lib/RunIRC'
+require 'beerbot'
+require 'json'
+
+Bot           = BeerBot::Bot
+Dispatcher    = BeerBot::Dispatcher
+IRCConnection = BeerBot::IRCConnection
+Scheduler     = BeerBot::Scheduler
+codec         = BeerBot::Codecs::IRC
 
 if ARGV.size == 0 then
   puts "Usage: ruby beerbot.rb path/to/ircconf.json"
@@ -21,10 +28,40 @@ if ARGV.size == 0 then
   exit 1
 end
 
+# Get our configuration...
+
 conffile = ARGV[0]
 config = BeerBot::Config.new
 config.load JSON.load(File.read(conffile))
 config.validate!
 
-$runirc = BeerBot::RunIRC.new(config)
-$runirc.start
+# Create the connection (not opened yet)...
+
+conn = IRCConnection.new(
+  nick:config['nick'],
+  server:config['server']
+)
+
+# Create the bot.
+
+bot = Bot.new
+bot.load!(config['modules'], config['moduledir'])
+config.bot = bot
+
+# Dispatcher which handles events and messages (protocol/codec
+# independent).
+
+dispatcher = Dispatcher.new(
+  bot,
+  config['nick'],
+  prefix:config['cmd_prefix'],
+  config:config
+)
+
+# Set up scheduler.
+
+scheduler = Scheduler.instance(config['timezone'])
+config.scheduler = scheduler
+
+$kernel = BeerBot::Kernel.new(config, conn, codec, bot, dispatcher, scheduler)
+$kernel.start

data/lib/beerbot.rb

@@ -6,10 +6,11 @@ require_relative 'beerbot/01.connect/IRCConnection'
 require_relative 'beerbot/01.bot/botmsg'
 require_relative 'beerbot/01.bot/BotModule'
 require_relative 'beerbot/01.bot/Bot'
-require_relative 'beerbot/02.protocols/irc'
-require_relative 'beerbot/06.dispatchers/dispatcher'
+require_relative 'beerbot/02.codecs/irc'
+require_relative 'beerbot/06.dispatcher'
 require_relative 'beerbot/70.scheduler/scheduler'
-require_relative 'beerbot/Config'
+require_relative 'beerbot/config'
+require_relative 'beerbot/kernel'
 
 module BeerBot
   module Modules

data/lib/beerbot/01.bot/Bot.rb

@@ -44,8 +44,14 @@ module BeerBot
 
     # Purge existing modules from this array and load modules with
     # names in module_names in module_path on disk into memory.
+    #
+    # MODULE NAMES and MODULE PATH:
+    # 
+    # Best understood like this:
+    #   "#{module_path}/#{name}/*" = location of modules
+    #   modname = "::BeerBot::Modules::#{name}"
 
-    def load! module_names,module_path
+    def load! module_names, module_path
       @module_path = module_path
       @module_names = module_names
       self.reject!{true} unless self.empty?  # ick :)
@@ -99,9 +105,10 @@ module BeerBot
     # Call :meth on valid (loaded) modules and maybe accumulate result
     # or return first valid response...
     #
-    # Returns array-based botmsg.  The array could be empty, which
-    # means nothing was returned (or we couldn't interpret the output
-    # of the bot modules).
+    # Converts return value to ARRAY FORMAT if not already.
+    # 
+    # The array could be empty, which means nothing was returned (or
+    # we couldn't interpret the output of the bot modules).
     # 
     # We expect each bot_module to return nil or a botmsg (Hash, Array
     # or Proc that returns the first two).

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

@@ -5,11 +5,16 @@ module BeerBot
 
   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.
+
+      # See Bot#load!
+      self[:name] = name
       self[:modname] = modname
+      self[:mod] = mod  # The loaded ruby module.
+
       self[:errors] = errors
+
     end
   end
 

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

@@ -100,11 +100,13 @@ module BeerBot
         end
       end
 
-      # Transform all replies from bot modules to ARRAY FORMAT.
+      # Transform a botmsg (aka SINGLE RETURN FORMAT) or ARRAY FORMAT
+      # to ARRAY FORMAT (described below).
       #
-      # A module may reply in either format. But we convert it here. The
-      # single return format is the simplest, which is why we have 2
-      # formats.
+      # Background:
+      # Bot modules may reply in either format. But we convert it
+      # here. The single return format is the simplest, which is why
+      # we have 2 formats.
       # 
       # ARRAY FORMAT
       # 
@@ -113,6 +115,7 @@ module BeerBot
       # where bool  = true  => "use <reply> and keep going"
       #             = false => "use <reply> but stop here"
       # where reply = whatever the bot returns.
+      # 
       # NOTE: any other type of array will assumed to be in
       # single return form...
       #

data/lib/beerbot/{02.protocols → 02.codecs}/irc.rb

@@ -7,7 +7,7 @@
 
 module BeerBot
 
-  module Protocol
+  module Codecs
 
     # IRC Protcol module.
     #
@@ -32,7 +32,7 @@ module BeerBot
       # Note that connection readiness and PONG protocol are handled by
       # the irc connection, not here.
 
-      def self.parse str
+      def self.decode str
 
         m = IRCMessage.new(str)
         result = []
@@ -100,7 +100,7 @@ module BeerBot
           channel = m[:params][2]
           users = m[:trailing].split(/\s+/)
           result = [:chanlist,channel,users]
-          #puts "[parse/353] #{result}"
+          #puts "[decode/353] #{result}"
 
         when '366'  # end of 353
           result = [:chanlistend]
@@ -235,7 +235,7 @@ module BeerBot
       #
       # Generates nil if it can't handle 'botmsg'.
 
-      def self.to_irc botmsg
+      def self.encode botmsg
         case botmsg
         when Hash
           to = botmsg[:to]
@@ -249,11 +249,11 @@ module BeerBot
           end
         when Array
           botmsg.map{|reply|
-            self.to_irc reply
+            self.encode reply
           }
         when Proc
           #p botmsg.call
-          self.to_irc(botmsg.call)
+          self.encode(botmsg.call)
         else
           nil
         end

data/lib/beerbot/06.dispatcher.rb

@@ -0,0 +1,139 @@
+# 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/>.
+
+require_relative '00.utils/utils'
+
+module BeerBot
+
+
+  # A dispatcher's main task is to receive incoming generic events
+  # (not protocol specific) and return a botmsg or empty array.
+  # 
+  # This is done via the Dispatcher#receive.
+  # 
+  # Dispatcher#receive takes:
+  # 1) event - a symbol representing an event eg :msg, :join etc
+  # 2) args  - an array representing arguments
+  # 'event' and 'args' are intended to be protocol-neutral.
+  # 
+  # This class is basically a glorified struct with a receive method
+  # that is the default way to dispatch to an instance of Bot.
+  # 
+  # You have several options if you want to customize...
+  # 1) subclass if you want to pre or post filter
+  # 2) override #receive with your own singleton receive (see tests)
+  # 3) make a new Dispatcher-like class
+
+  class Dispatcher
+
+    Utils      = BeerBot::Utils
+    BotMsg     = BeerBot::BotMsg
+    
+    attr_accessor :bot,:nick,:prefix,:config
+
+    def initialize bot,nick,prefix:',',config:nil
+      @bot = bot
+      @nick = nick
+      @prefix = prefix
+      @config = config
+      @get_nick_cmd   = Utils.make_prefix_parser(nick)
+      @nickrx         = Regexp.new("^#{nick}$",'i')
+      @get_prefix_cmd = Utils.make_prefix_parser(prefix)
+    end
+
+    # Receive generic events emitted by a protocol class and
+    # dispatch to an instance of Bot.
+    #
+    # eg the output from BeerBot::Codecs::IRC.decode .
+
+    def receive event,args
+
+      replies = nil
+
+      # Otherwise, here is the default behaviour...
+
+      case event
+      when :unknown
+        replies = @bot.event(event,args:args,config:@config)
+      when :default
+        replies = @bot.event(event,args:args,config:@config)
+
+      when :nick
+        old,nick = args
+        replies = @bot.event(event,old:old,nick:nick,config:@config)
+
+      when :quit
+        nick,msg = args
+        replies = @bot.event(event,nick:nick,msg:msg,config:@config)
+      when :part
+        nick,channel = args
+        replies = @bot.event(event,nick:nick,channel:channel,config:@config)
+      when :join
+        nick,channel = args
+        me = (@nickrx === nick)
+        replies = @bot.event(event,me:me,nick:nick,channel:channel,config:@config)
+      when :chanlist
+        channel,users = args
+        replies = @bot.event(event,channel:channel,users:users,config:@config)
+      when :chanlistend
+      # ignore
+
+      when :action
+        from,to,action = args
+        me = (@nickrx === to)
+        replies = @bot.action(action,from:from,to:to,me:me,config:@config)
+
+      when :msg
+        from,to,msg = args
+
+        # Somebody messaging us privately:
+        me = (@nickrx === to)
+
+        # Somebody talking to us on channel: "Beerbot: ..."
+        cmd = @get_nick_cmd.call(msg)
+        if not cmd then
+          # Somebody commanding us on channel: ",command ..."
+          cmd = @get_prefix_cmd.call(msg)
+        end
+
+        if cmd then
+          case cmd
+          # dispatch help...
+          when /^\s*help(?:\s+(.*))?$/
+            if $1.nil? then
+              args = []
+            else
+              args = $1.strip.split(/\s+/)
+            end
+            replies = @bot.help(args,from:from,to:to,me:me,config:@config)
+          # dispatch cmd...
+          else
+            replies = @bot.cmd(cmd,from:from,to:to,me:me,config:@config)
+          end
+        else
+          # We're just hearing something on a channel...
+          replies = @bot.hear(msg,from:from,to:to,me:me,config:@config)
+        end
+
+      else
+        puts "[dispatcher] unrecognised event: '#{event}'"
+      end
+
+      case replies
+      when String # assume protocol string eg irc
+        replies
+      when Hash,Array,Proc
+        BotMsg.to_a(replies)
+      else
+        []
+      end
+
+    end
+
+  end
+
+end

data/lib/beerbot/70.scheduler/scheduler.rb

@@ -7,6 +7,9 @@
 
 module BeerBot
   module Scheduler
+
+    CronR = ::CronR
+
     def self.instance timezone=nil
       @instance ||= CronR::Cron.new
       if timezone then
@@ -14,5 +17,6 @@ module BeerBot
       end
       @instance
     end
+
   end
 end

data/lib/beerbot/{Config.rb → config.rb}

@@ -43,7 +43,9 @@ module BeerBot
       # Defaults
       self['cmd_prefix'] = ','
       self['nick'] = 'beerbot'
-      self.merge(kargs)
+      kargs.keys.each {|key|
+        self[key.to_s] = kargs[key]
+      }
     end
 
     def load config

data/lib/{RunIRC.rb → beerbot/kernel.rb}

@@ -9,29 +9,27 @@ require 'set'
 require 'rubygems'
 require 'pry'
 require 'json'
-require_relative 'beerbot'
 
-# Run the irc bot.
+require_relative '00.utils/utils'
+require_relative '00.utils/InOut'
+require_relative '01.bot/botmsg'
+
+# Run the bot.
 #
 # This class creates and coordinates all the high level components
-# needed to run beerbot over irc.
+# needed to run beerbot.
 #
 # See bin/* .
 
 module BeerBot; end
 
-class BeerBot::RunIRC
+class BeerBot::Kernel
 
   Utils         = BeerBot::Utils
   InOut         = BeerBot::Utils::InOut
-  IRCConnection = BeerBot::IRCConnection
-  IRC           = BeerBot::Protocol::IRC
-  Bot           = BeerBot::Bot
   BotMsg        = BeerBot::BotMsg
-  Dispatcher    = BeerBot::Dispatchers::Dispatcher
-  Scheduler     = BeerBot::Scheduler
 
-  attr_accessor :config,:bot,:scheduler,:dispatcher,:conn,:postq,:parse,:more
+  attr_accessor :config, :bot, :scheduler, :dispatcher, :conn, :codec
 
   # Initialize all parts of the system here.
   #
@@ -39,43 +37,27 @@ class BeerBot::RunIRC
   # 
   # Note BeerBot::Config should be loaded before we initialize here.
 
-  def initialize config
+  def initialize config, conn, codec, bot, dispatcher, scheduler
 
     @echo = true
     @path = File.expand_path(File.dirname(__FILE__)+'/..')
     @module_path = config['moduledir']
     @config = config
+    @bot = bot
+    @conn = conn
+    @codec = codec
+    @dispatcher = dispatcher
+    @scheduler = scheduler
+
 
-    # Create the bot.
-    @bot = Bot.new
-    @bot.load!(config['modules'],@module_path)
-    config.bot = @bot
-
-    # Dispatcher which receives messages and interacts with the bot.
-    @dispatcher = Dispatcher.new(
-      @bot,
-      config['nick'],
-      prefix:config['cmd_prefix'],
-      config:config
-    )
-
-    # Set up scheduler (this doesn't start it yet)...
-    @scheduler = Scheduler.instance(config['timezone'])
-    config.scheduler = @scheduler
-
-    # Create but don't open the irc connection.
-    @conn = IRCConnection.new(
-      nick:config['nick'],
-      server:config['server'])
-
-    # Dispatcher thread takes stuff coming from the irc connection and does
+    # Dispatcher thread takes stuff coming from the connection and does
     # something with it...
 
     @dispatcher_thread = InOut.new(inq:@conn.queue,outq:@conn.writeq) {|input|
       str,raw = input
-      event,*args = IRC.parse(str)
+      event,*args = @codec.decode(str)
       replies = @dispatcher.receive(event,args)
-      IRC.to_irc(replies)
+      @codec.encode(replies)
     }
     @dispatcher_thread.start!
 
@@ -87,7 +69,7 @@ class BeerBot::RunIRC
     @scheduler_thread = InOut.new(inq:@scheduler.queue,outq:@conn.writeq) {|cron_job|
       puts "<< scheduler #{cron_job.inspect}" if @echo
       puts "<< scheduler #{@scheduler.time}" if @echo
-      IRC.to_irc(cron_job.run)
+      @codec.encode(cron_job.run)
     }
     @scheduler_thread.start!
 
@@ -104,7 +86,7 @@ class BeerBot::RunIRC
       when String # assume protocol string eg irc
         replies
       when Hash,Array,Proc
-        IRC.to_irc(BotMsg.to_a(replies))
+        @codec.encode(BotMsg.to_a(replies))
       else
         []
       end
@@ -114,18 +96,20 @@ class BeerBot::RunIRC
     # Set up a repl in a separate thread.
     # 
     # In pry, you can then do:
-    #   @conn.writeq.enq IRC.join('#chan1')
-    #   @conn.write IRC.join('#chan1')
+    #   @conn.writeq.enq @codec.join('#chan1')
+    #   @conn.write @codec.join('#chan1')
 
     Pry.config.prompt = Proc.new {|_| "pry> "}
     @pry_thread = Thread.new {
       binding.pry
     }
 
+    # Initialize bot and its modules...
+
     @bot.init(@config)
     @bot.update_config(@config)
 
-    # Do stuff once we've identified with the irc server...
+    # Do stuff once we've identified with the server...
     # 
     # Join channels.
     # Start the scheduler.
@@ -159,25 +143,25 @@ class BeerBot::RunIRC
   # Convenience method to say something to channel or someone.
 
   def say to,msg
-    @conn.writeq.enq(IRC.msg(to,msg))
+    @conn.writeq.enq(@codec.msg(to,msg))
   end
 
   # Convenience method to do something (/me).
 
   def action to,msg
-    @conn.writeq.enq(IRC.action(to,msg))
+    @conn.writeq.enq(@codec.action(to,msg))
   end
 
   # Convenience method to join a channel.
 
   def join chan
-    @conn.writeq.enq(IRC.join(chan))
+    @conn.writeq.enq(@codec.join(chan))
   end
 
   # Convenience method to leave a channel.
 
   def leave chan
-    @conn.writeq.enq(IRC.leave(chan))
+    @conn.writeq.enq(@codec.leave(chan))
   end
 
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: beerbot
 version: !ruby/object:Gem::Version
-  version: 0.2.0.pre.1
+  version: 0.2.0
 platform: ruby
 authors:
 - Daniel Bush
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-06-04 00:00:00.000000000 Z
+date: 2014-09-08 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: pry
@@ -44,14 +44,14 @@ dependencies:
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - '='
       - !ruby/object:Gem::Version
-        version: 0.1.4
+        version: 0.1.5
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -94,12 +94,12 @@ files:
 - lib/beerbot/01.bot/BotModule.rb
 - lib/beerbot/01.bot/botmsg.rb
 - lib/beerbot/01.bot/Bot.rb
-- lib/beerbot/02.protocols/irc.rb
-- lib/beerbot/06.dispatchers/dispatcher.rb
+- lib/beerbot/02.codecs/irc.rb
+- lib/beerbot/06.dispatcher.rb
 - lib/beerbot/70.scheduler/scheduler.rb
-- lib/beerbot/Config.rb
+- lib/beerbot/config.rb
+- lib/beerbot/kernel.rb
 - lib/beerbot.rb
-- lib/RunIRC.rb
 - bin/beerbot-run-irc.rb
 homepage: http://github.com/danielbush/BeerBot
 licenses:
@@ -116,13 +116,13 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>'
+  - - '>='
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubyforge_project: 
 rubygems_version: 2.1.10
 signing_key: 
 specification_version: 4
-summary: An ruby 2.0 bot
+summary: A ruby 2.0 bot
 test_files: []

data/lib/beerbot/06.dispatchers/dispatcher.rb

@@ -1,139 +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/>.
-
-require_relative '../00.utils/utils'
-
-module BeerBot
-
-  # Dispatchers receive incoming messages from a protocol object and
-  # dispatches them (usually to an instance of Bot).
-  #
-  # Dispatcher#receive takes:
-  # 1) event - a symbol representing an event eg :msg, :join etc
-  # 2) args  - an array representing arguments
-
-  module Dispatchers
-
-    # This class is basically a glorified struct with a receive method
-    # that is the default way to dispatch to an instance of Bot.
-    # 
-    # You have several options if you want to customize...
-    # 1) subclass if you want to pre or post filter
-    # 2) override #receive with your own singleton receive (see tests)
-    # 3) make a new Dispatcher-like class
-
-    class Dispatcher
-
-      Utils      = BeerBot::Utils
-      BotMsg     = BeerBot::BotMsg
-      
-      attr_accessor :bot,:nick,:prefix,:config
-
-      def initialize bot,nick,prefix:',',config:nil
-        @bot = bot
-        @nick = nick
-        @prefix = prefix
-        @config = config
-        @get_nick_cmd   = Utils.make_prefix_parser(nick)
-        @nickrx         = Regexp.new("^#{nick}$",'i')
-        @get_prefix_cmd = Utils.make_prefix_parser(prefix)
-      end
-
-      # Receive generic events emitted by a protocol class and
-      # dispatch to an instance of Bot.
-      #
-      # eg the output from BeerBot::Protocol::IRC.parse .
-
-      def receive event,args
-
-        replies = nil
-
-        # Otherwise, here is the default behaviour...
-
-        case event
-        when :unknown
-          replies = @bot.event(event,args:args,config:@config)
-        when :default
-          replies = @bot.event(event,args:args,config:@config)
-
-        when :nick
-          old,nick = args
-          replies = @bot.event(event,old:old,nick:nick,config:@config)
-
-        when :quit
-          nick,msg = args
-          replies = @bot.event(event,nick:nick,msg:msg,config:@config)
-        when :part
-          nick,channel = args
-          replies = @bot.event(event,nick:nick,channel:channel,config:@config)
-        when :join
-          nick,channel = args
-          me = (@nickrx === nick)
-          replies = @bot.event(event,me:me,nick:nick,channel:channel,config:@config)
-        when :chanlist
-          channel,users = args
-          replies = @bot.event(event,channel:channel,users:users,config:@config)
-        when :chanlistend
-          # ignore
-
-        when :action
-          from,to,action = args
-          me = (@nickrx === to)
-          replies = @bot.action(action,from:from,to:to,me:me,config:@config)
-
-        when :msg
-          from,to,msg = args
-
-          # Somebody messaging us privately:
-          me = (@nickrx === to)
-
-          # Somebody talking to us on channel: "Beerbot: ..."
-          cmd = @get_nick_cmd.call(msg)
-          if not cmd then
-            # Somebody commanding us on channel: ",command ..."
-            cmd = @get_prefix_cmd.call(msg)
-          end
-
-          if cmd then
-            case cmd
-            # dispatch help...
-            when /^\s*help(?:\s+(.*))?$/
-              if $1.nil? then
-                args = []
-              else
-                args = $1.strip.split(/\s+/)
-              end
-              replies = @bot.help(args,from:from,to:to,me:me,config:@config)
-            # dispatch cmd...
-            else
-              replies = @bot.cmd(cmd,from:from,to:to,me:me,config:@config)
-            end
-          else
-            # We're just hearing something on a channel...
-            replies = @bot.hear(msg,from:from,to:to,me:me,config:@config)
-          end
-
-        else
-          puts "[dispatcher] unrecognised event: '#{event}'"
-        end
-
-        case replies
-        when String # assume protocol string eg irc
-          replies
-        when Hash,Array,Proc
-          BotMsg.to_a(replies)
-        else
-          []
-        end
-
-      end
-
-    end
-
-  end
-
-end