beerbot 0.1.0

data/lib/BeerBot/Config.rb

@@ -0,0 +1,62 @@
+# 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
+
+  # Config should be loaded with the json from a config file before
+  # initialisation of the system.
+  #
+  # It should be available to things like bot modules eg
+  #   BeerBot::Config['datadir']
+  # 
+
+  Config = {}
+
+  class << Config
+
+    def load config
+      self.reject!{true}
+      self.merge!(config)
+    end
+
+    def validate!
+      if not self['datadir'] then
+        raise "'datadir' not set in config."
+      end
+      if not self['moduledir'] then
+        raise "'moduledir' not set in config."
+      end
+      unless File.exists?(self['datadir']) then
+        raise "datadir:'#{self['datadir']}' doesn't exist."
+      end
+      unless File.exists?(self['moduledir']) then
+        raise "config['moduledir']=#{@module_path} doesn't exist, make one (bot modules will go here)!"
+      end
+    end
+
+    # Return path for module data dir -- a place where the module can
+    # stash data.
+
+    def module_data name,&block
+      self.validate!
+      datadir = self['datadir']
+      path = File.join(datadir,'modules',name)
+      if not File.exists?(path) then
+        FileUtils.mkdir_p(path)
+      end
+      if block_given? then
+        Dir.chdir(path) {
+          block.call(path)
+        }
+      else
+        path
+      end
+    end
+
+  end
+
+end

data/lib/RunIRC.rb

@@ -0,0 +1,153 @@
+# 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 'set'
+require 'rubygems'
+require 'pry'
+require 'json'
+require_relative 'BeerBot'
+
+# Run the irc bot.
+#
+# This class creates and coordinates all the high level components
+# needed to run beerbot over irc.
+#
+# See bin/* .
+
+module BeerBot; end
+
+class BeerBot::RunIRC
+
+  Utils         = BeerBot::Utils
+  IRCWorld      = BeerBot::Utils::IRCWorld
+  InOut         = BeerBot::Utils::InOut
+  IRCConnection = BeerBot::IRCConnection
+  IRC           = BeerBot::Protocol::IRC
+  Bot           = BeerBot::Bot
+  IRCDispatcher = BeerBot::Dispatchers::IRCDispatcher
+  Scheduler     = BeerBot::Scheduler
+
+  attr_accessor :config,:bot,:scheduler,:dispatcher,:world,:conn,:postq,:parse,:more
+
+  # Initialize all parts of the system here.
+  #
+  # config should be a hash, normally BeerBot::Config.
+  # 
+  # Note BeerBot::Config should be loaded before we initialize here.
+
+  def initialize config
+
+    @path = File.expand_path(File.dirname(__FILE__)+'/..')
+    @module_path = config['moduledir']
+    @config = config
+
+    # Create the bot.
+    @bot = Bot.new(@module_path,config['modules'])
+
+    # Dispatcher which receives messages and interacts with the bot.
+    @dispatcher = IRCDispatcher.new(
+      @bot,
+      config['nick'],
+      prefix:config['cmd_prefix'],
+      world:@world
+    )
+
+    # Set up scheduler (this doesn't start it yet)...
+    @scheduler = Scheduler.instance(config['timezone'])
+    # Create a world associated with this irc connection.
+    # (lists channels and users we know about)
+    @world = IRCWorld.new(config['nick'])
+
+    # Create but don't open the irc connection.
+    @conn = IRCConnection.new(
+      nick:config['nick'],
+      server:config['server'])
+
+    # Dispatcher thread takes stuff from @conn queue and processes
+    # it...
+
+    @dispatcher_thread = InOut.new(inq:@conn.queue,outq:@conn.writeq) {|input|
+      str,raw = input
+      replies = @dispatcher.receive(str)
+    }
+    @dispatcher_thread.start!
+
+    # Schedule dispatcher thread.
+    #
+    # These are responses that were prepared and scheduled earlier and
+    # which also need to be dispatched.
+
+    @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)
+    }
+    @scheduler_thread.start!
+
+    # 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')
+
+    Pry.config.prompt = Proc.new {|_| "pry> "}
+    @pry_thread = Thread.new {
+      binding.pry
+    }
+
+    # Do stuff once we've identified with the irc server...
+    # 
+    # Join channels.
+    # Start the scheduler.
+
+    @conn.ready? {
+      channels = config['channels']
+      if channels then
+        channels.each{|chan|
+          self.join(chan)
+        }
+      end
+      @scheduler.start
+    }
+  end
+
+  # Start the connection.
+
+  def start
+    @conn.open.join
+  end
+
+  # Convenience method to say something to channel or someone.
+
+  def say to,msg
+    @conn.writeq.enq(IRC.msg(to,msg))
+  end
+
+  # Convenience method to do something (/me).
+
+  def action to,msg
+    @conn.writeq.enq(IRC.action(to,msg))
+  end
+
+  # Convenience method to join a channel.
+
+  def join chan
+    @conn.writeq.enq(IRC.join(chan))
+  end
+
+  # Reload @bot using module list 'modules'.
+  #
+  # You could use
+
+  def reload! modules=[]
+    @config['modules'] = modules
+    @bot = Bot.new(@module_path,modules)
+    @dispatcher.bot = @bot
+  end
+
+end
+

metadata

@@ -0,0 +1,134 @@
+--- !ruby/object:Gem::Specification
+name: beerbot
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Daniel Bush
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-04-20 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: sqlite3
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: CronR
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: 0.1.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: byebug
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: '["Out of the box you get an irc bot, but beerbot could be so much more...",
+  ["Daniel Bush"]]'
+email: dlb.id.au@gmail.com
+executables:
+- run-irc.rb
+extensions: []
+extra_rdoc_files: []
+files:
+- 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/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/70.scheduler/scheduler.rb
+- lib/BeerBot/Config.rb
+- lib/BeerBot.rb
+- lib/RunIRC.rb
+- bin/run-irc.rb
+homepage: http://github.com/danielbush/BeerBot
+licenses:
+- GPL
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.10
+signing_key: 
+specification_version: 4
+summary: An ruby 2.0 bot
+test_files: []