beerbot 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 5711f62c9ce4965a324d3578b5555761d8c493ef
+  data.tar.gz: 61bdaff04c5ae69702858f623316671d305b5474
+SHA512:
+  metadata.gz: 5551c5b99e88f48ed52bbc6d3ee3581d8842c9e841551919cdeb2fc37034206239543be1228f47b509d83fe6c7a04a09134b06ff09bbb90d8540a95c96b18497
+  data.tar.gz: 4e189c7c8ac1ba58f3874a8e78cebaf7fdb01b29bc3702830fa43aeec1fd0fbce1afc0495eccc0a26c515be398b27b43e70251245f08d1c0cd146ae1912d6385

data/bin/run-irc.rb

@@ -0,0 +1,24 @@
+#!/usr/bin/env ruby
+
+# 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/>.
+
+raise "Needs ruby 2" if /^1/===RUBY_VERSION
+require_relative '../lib/RunIRC'
+
+if ARGV.size == 0 then
+  puts "Usage: ruby beerbot.rb path/to/ircconf.json"
+  puts "See conf/irc.json"
+  exit 1
+end
+
+conffile = ARGV[0]
+BeerBot::Config.load JSON.load(File.read(conffile))
+BeerBot::Config.validate!
+
+$runirc = BeerBot::RunIRC.new BeerBot::Config
+$runirc.start

data/lib/BeerBot.rb

@@ -0,0 +1,20 @@
+require 'CronR' # For scheduler
+
+require_relative 'BeerBot/00.utils/utils'
+require_relative 'BeerBot/00.utils/paramExpand'
+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/70.scheduler/scheduler'
+require_relative 'BeerBot/Config'
+
+module BeerBot
+  module Modules
+  end
+end

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

@@ -0,0 +1,56 @@
+# 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/>.
+
+require 'json'
+module BeerBot
+  module Utils
+    # A class that loads data from a file and allows you to access it
+    # using the #data method.
+    #
+    # If the file is updated (after >=1 sec), #data will reload.
+    class DataFile
+      attr_reader :reloaded  # true if last call to #data reloaded file
+      def initialize filepath
+        @filepath = filepath
+        @data = File.read(filepath)
+        @mtime = File.stat(filepath).mtime
+        @reloaded = false
+      end
+      def data
+        @reloaded = false
+        return @data unless File.exists?(@filepath)
+        mtime = File.stat(@filepath).mtime
+        return @data if mtime == @mtime
+        puts "Reloading data file #{@filepath}"
+        @mtime = mtime
+        @data = File.read(@filepath)
+        @reloaded = true
+        @data
+      end
+    end
+    # Specialised DataFile that parses json.
+    class JsonDataFile < DataFile
+      attr_reader :json
+      def initialize filepath
+        super
+        @json = JSON.parse(@data)
+      end
+      def data
+        super
+        begin
+          if @reloaded then
+            json = JSON.parse(@data)
+            @json = json
+          end
+        rescue => e
+          return @json
+        end
+        @json
+      end
+    end
+  end
+end

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

@@ -0,0 +1,46 @@
+# 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
+
+    # Represents a thread that waits on an in-queue, processes any
+    # things received and puts them on an out-queue.
+
+    class InOut
+
+      attr_reader :inq,:outq,:run,:thread
+
+      def initialize inq:nil,outq:nil,&block
+        @inq = inq
+        @outq = outq
+        @run = block
+        raise "No block given" unless block_given?
+      end
+
+      def start!
+        @thread = Thread.new {
+          loop {
+            begin
+              thing = @inq.deq
+              response = @run.call(thing)
+              if response then
+                @outq.enq(response)
+              else
+                # TODO
+              end
+            rescue => e
+              puts e
+              puts e.backtrace
+            end
+          }
+        }
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,68 @@
+# 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
+
+    # A hash that buffers things by some key.
+    #
+    # If 'things' exceeds a set number, then these are stored in an
+    # array against the key.
+    #
+    # For irc and other messaging the key should probably
+    # be key :to of one or more botmsg's.
+    # @see BotMsgMore
+
+    class More < Hash
+
+      attr_accessor :size
+
+      def initialize
+        super
+        # Default value is empty array.
+        self.default_proc = lambda {|h,k|
+          h[k] = []
+        }
+      end
+
+      def size
+        @size ||= 5  # lines
+      end
+
+      # Fetch array of items from buffer for key 'key'.
+      #
+      # 'key' should probably be a person or channel you are messaging.
+      #
+      # Should return an array of items (eg of botmsg hashes).
+
+      def more key
+        arr = self[key]
+        self[key] = arr.slice(self.size,arr.size) || []
+        return arr.slice(0,self.size-1)
+      end
+
+      # Filter an array of items allowing only
+      # the first 'n' of these.
+      #
+      # The remainder are stored in this hash and can
+      # be accessed via 'key' using 'self.more'.
+
+      def filter arr,key
+        if arr.size <= self.size then
+          self[key] = [] # reset buffer
+          return arr
+        end
+        self[key] = arr.slice(self.size,size)
+        return arr.slice(0,self.size)
+      end
+
+    end
+
+  end
+
+end

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

@@ -0,0 +1,77 @@
+# 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
+
+    # Randomly generate sentences.
+    #
+    # See spec examples in spec/.
+    # 
+    # Take a spec which is of form
+    #   [<sentence>,<hash>]
+    # where <sentence> is a string and
+    # each entry in <hash>
+    #   <key> => <value>
+    # where <key> is a symbol, and <value>
+    # is an array of <sentence>'s.
+    # 
+    # <sentence> is a sentence or phrase.
+    # If a word starts with ':' it will be looked up
+    # in <hash>, an entry from <value> will be randomly
+    # selected.
+    # The entry from <value> will also undergo the
+    # same ':' substitution.
+
+    module ParamExpand
+
+      # Recursively expand a sentence with parameters starting with
+      # ':' using values sampled from params.
+      # 
+      # Split, map and rejoin a sentence (str).
+      #
+      # After splitting, apply expand on parameter words ":word".
+      #
+      # Watch out, throws error, be prepared.
+
+      def self.expand(str,params,raise_error=false)
+        words = str.split(/\s+/)  # not great, we lose additional spaces
+        words.map {|word|
+          if word[0] == ':' then
+            if word[1] == ':' then
+              word  # let the bot code gsub this; ::from , ::to
+            else
+              self.expand(
+                self.lookup(word[1..-1],params,raise_error),
+                params,raise_error
+              )
+            end
+          else
+            word
+          end
+        }.select{|word| word != nil && word != ""}.join(' ').strip
+      end
+      
+      # Randomly select entry from params.
+
+      def self.lookup(str,params,raise_error=false)
+        if not params.has_key?(str) then
+          if raise_error then
+            raise "'#{str}' has no corresponding symbol in params #{params}"
+          else
+            return ""
+          end
+        end
+        result = params[str].sample
+        result ? result : ""
+      end
+
+    end
+  end
+end

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

@@ -0,0 +1,149 @@
+# 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
+
+    # 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.
+    #
+    # The prefix might be a nick or a command prefix.
+    #
+    # Use this to get commands issued to the bot through a channel.
+    #
+    # TODO: make sure this returns msg without the prefix, or nil
+    # otherwise.
+
+    def self.make_prefix_parser prefix
+      rx = Regexp.new("^#{prefix}\\W?(.*)",'i')
+      lambda {|msg|
+        if m = rx.match(msg) then
+          m[1].strip
+        end
+      }
+    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.
+    #
+    # This regex doesn't handle backslash escapes, so if pattern or
+    # replacement contain '/' use another delimiter eg s#...#...# etc.
+    # 
+    # Non alphanumeric delimiters are allowed.
+    #
+    # Returns: nil or a MatchData instance with symbol keys:
+    #  :sed (the whole sed command), :sep (the separator), :pattern,
+    #  :replacement, :flags
+    #
+    # If you want to combine this regex, call
+    #   sed_regex.source => <string>
+
+    def self.sed_regex
+      %r{
+        ^(?<before>.*)
+        \b
+        (?<sed>
+          s
+          (?<sep>[^A-z0-9\s])
+          (?<pattern>(?!\g<sep>)*.*)
+          \k<sep>
+          (?<replacement>(?!\g<sep>)*.*)
+          \k<sep>
+          (?<flags>[A-z]*)
+        )
+        (?<after>.*)$
+      }x
+    end
+
+  end
+
+end