ircbot 0.0.2 → 0.1.0

data/README

@@ -1,47 +1,69 @@
 ircbot
-===
+======
 
-  old fashioned irc bot 
+  An irc bot framework that offers easy-to-use by plugins
 
 
 Config
 ======
 
-  Edit "config/xxx.dat" as your environment.
+  Edit "config/xxx.yml" as your environment.
+
+  * host: irc server host
+  * port: irc server port
+  * nick: nick name for this bot
+  * user: user name for this bot
+  * real: real name for this bot
+  * help: help message for this bot
+  * channels: startup channel names
+  * plugins: plugin names
 
 
 Usage
 =====
 
-  ircbot -f config/xxx.dat
+  ircbot -f config/xxx.yml
 
 
-Command
-=======
+Plugin
+======
 
-  * (nick|realname).COMMAND arg
-     # same as `arg > (nick|realname).COMMAND'
-  * (nick|realname).help
-  * (nick|realname).restart(CPI_NAME = nil)
-  * (nick|realname).register(CPI_NAME)
-  * (nick|realname).remove(CPI_NAME)
+  In ircbot world, we define functions as plugin (Ircbot::Plugin).
 
+  Instance methods:
+    * reply : this method is called when privmsg event is fired,
+              and reply message(the returned string) to the channel.
+        args: [text, nick, message object]
 
-CPI
-===
+    * help  : used from "plugins" plugin
 
-  In ircbot's world, we define modules as cpi.
+  Accessor methods:
 
+    * message : message object same as 3rd argument
+    * direct? : whether the message is directly toward to the bot or not
+    * config  : hash of given config file
 
 
-Notice
-======
+Example
+=======
 
-  Main code and cpi modules should be euc-japan (KCODE=e).
+  When you want echo bot, define the function as plugin first.
 
+  plugins/echo.rb:
 
-Author
-======
+    class EchoPlugin < Ircbot::Plugin
+      def reply(text)
+        text
+      end
+    end
+
+  
+
+Required
+========
+
+  * irc-net gem
 
-  maiha@wota.jp
 
+Authors: maiha@wota.jp
+Links: http://github.com/maiha/ircbot

data/Rakefile

@@ -7,9 +7,11 @@ require 'rake/gempackagetask'
 GEM_NAME = "ircbot"
 AUTHOR = "maiha"
 EMAIL = "maiha@wota.jp"
-HOMEPAGE = "http://github.com/maiha/ircbot"
-SUMMARY = "old fashioned irc bot"
-GEM_VERSION = "0.0.2"
+SUMMARY = "easy irc bot framework"
+
+require File.dirname(__FILE__) + '/lib/ircbot/version'
+GEM_VERSION = Ircbot::VERSION
+HOMEPAGE    = Ircbot::HOMEPAGE
 
 spec = Gem::Specification.new do |s|
   s.rubyforge_project = 'asakusarb'
@@ -20,13 +22,14 @@ spec = Gem::Specification.new do |s|
   s.has_rdoc = true
   s.extra_rdoc_files = ["README", "MIT-LICENSE"]
   s.summary = SUMMARY
-  s.description = s.summary
+  s.description = "An irc bot framework that offers easy-to-use by plugins"
   s.author = AUTHOR
   s.email = EMAIL
   s.homepage = HOMEPAGE
   s.require_path = 'lib'
-  s.add_dependency('activesupport', '>= 2.0.0')
-  s.files = %w(MIT-LICENSE README Rakefile) + Dir.glob("{lib,spec,app,public,stubs}/**/*")
+  s.add_dependency('extlib', '>= 0.9.14')
+  s.add_dependency('net-irc', '>= 0.0.9')
+  s.files = %w(MIT-LICENSE README Rakefile) + Dir.glob("{lib,spec,plugins}/**/*")
 end
 
 Rake::GemPackageTask.new(spec) do |pkg|

data/bin/ircbot

@@ -1,21 +1,12 @@
 #!/usr/bin/env ruby
-# clear ARGV for Irb
 
 require 'ircbot'
 
-$KCODE = 'e'
-
-# Sync
-STDOUT.sync = true
-STDERR.sync = true
-
-debug  = nil
 config = nil
-cpi    = Pathname(Dir.getwd) + "cpi"
+plugin = Pathname(Dir.getwd) + "plugins"
 
 while (arg = ARGV.shift)
   case arg
-  when /^-d$/		; debug  = true
   when /^-f$/		; config = ARGV.shift
   when /^-c$/		; cpi    = ARGV.shift
   else
@@ -28,23 +19,8 @@ unless config
   raise "Specify your config file\nusage: #{$0} -f config/xxx.dat"
 end
 
-# set cpi directory
-Ircbot.push_path :cpi, cpi, "**/*.cpi"
-
-
-module Ircbot
-  class Kicker < Ircbot::ReplyClient
-    rescue_from(SocketError) {
-      raise Ircbot::Recover, 30.minutes
-    }
-
-    rescue_from(Errno::EPIPE, Errno::ECONNRESET, Errno::ETIMEDOUT, IRC::AbnormalTerminated) {
-      raise Ircbot::Recover, 300.minutes
-    }
-  end
-end
-      
+Ircbot.push_path(:plugin, plugin)
 
-irc = Ircbot::ReplyClient.read_config(config, debug)
+irc = Ircbot::Client.from_file(config)
 irc.start
 puts "Bye"

data/lib/ircbot.rb

@@ -1,8 +1,8 @@
-
 require 'nkf'
 require 'pathname'
 require 'rubygems'
-require 'active_support'
+require 'extlib'
+require 'extlib/dictionary'
 
 ######################################################################
 ### Load path
@@ -14,28 +14,25 @@ $LOAD_PATH.unshift __DIR__ unless
   $LOAD_PATH.include?(__DIR__) ||
   $LOAD_PATH.include?(File.expand_path(__DIR__))
 
-require 'ircbot/framework'
+require "ircbot/framework"
+require "ircbot/version"
 
+Ircbot.push_path(:plugin, Ircbot.system_root + 'plugins')
+Ircbot.toplevel_binding = binding
 
 ######################################################################
 ### IRC library
 
-require 'irc/irc'
-require 'irc/agent'
-require 'irc/client'
-
+require "net/irc"
 
 ######################################################################
-### Ircbot library
-
-require 'ircbot/core_ext/rand-polimorphism'
-require 'ircbot/core_ext/writefile'
-require 'ircbot/core_ext/digest'
-require 'ircbot/core_ext/irc'
+### Core ext
 
+require "ircbot/core_ext/delegation" # from activesupport-2.3.5
+require "ircbot/core_ext/extending"  # from activesupport-2.3.5
+require "ircbot/core_ext/message"
 
 ######################################################################
 ### Ircbot 
 
-require 'ircbot/reply_client'
-
+require "ircbot/client"

data/lib/ircbot/client.rb

@@ -0,0 +1,32 @@
+# -*- coding: utf-8 -*-
+
+require "ircbot/plugin"
+require "ircbot/plugins"
+
+module Ircbot
+  class Client < Net::IRC::Client
+
+    # escape from nil black hole
+    def method_missing(name, *args)
+      case name.to_s
+      when /^on_/
+        # nop for calling super from subclass
+      else
+        raise NameError, "undefined local variable or method `#{name}' for #{self}"
+      end
+    end
+
+    class Standalone < Client
+      def initialize(*)
+        super({})
+      end
+    end
+  end
+end
+
+require "ircbot/client/encoding"
+require "ircbot/client/commands"
+require "ircbot/client/config"
+require "ircbot/client/config/channels"
+require "ircbot/client/config/plugins"
+require "ircbot/client/plugins"

data/lib/ircbot/client/commands.rb

@@ -0,0 +1,34 @@
+# -*- coding: utf-8 -*-
+
+module Ircbot
+  class Client
+    ######################################################################
+    ### Convinient access to commands
+
+    def post(command, *params)
+      if params[1]
+        params[1] = encode(params[1]).strip
+        if config.multiline
+          params[1].split(/\n/).compact.each do |text|
+            params[1] = text
+            super(command, *params)
+          end
+          return
+        end
+      end
+        
+      super(command, *params)
+    end
+
+    def notice(channel, text)
+      text = encode(text)
+      post NOTICE, channel, text
+    end
+
+    def privmsg(channel, text)
+      text = encode(text)
+      post PRIVMSG, channel, text
+    end
+  end
+end
+

data/lib/ircbot/client/config.rb

@@ -0,0 +1,55 @@
+# -*- coding: utf-8 -*-
+
+module Ircbot
+  class Client
+    class Config
+      ######################################################################
+      ### Reader
+      def self.read(path)
+        path = Pathname(path)
+        ext  = path.extname.delete(".")
+        ext  = "yml" if ext.empty?
+
+        reader = "read_#{ext}"
+        if respond_to?(reader)
+          Mash.new(__send__(reader, path))
+        else
+          raise NotImplementedError, "Cannot read #{path}: Format(#{ext})is not supported"
+        end
+      end
+
+      def self.read_yml(path)
+        require 'yaml'
+        path = Pathname(path)
+        YAML.load(path.read{})
+      end
+
+      ######################################################################
+      ### Config
+      def initialize(obj)
+        @obj = obj
+      end
+
+      def [](key)
+        __send__(key)
+      end
+
+      private
+        def method_missing(*args)
+          @obj.__send__(*args)
+        end
+    end
+    
+    def self.from_file(path)
+      new(Config.read(path))
+    end
+
+    def initialize(hash)
+      super(hash[:host], hash[:port], hash)
+    end
+
+    def config
+      @config ||= Config.new(opts)
+    end
+  end
+end

data/lib/ircbot/client/config/channels.rb

@@ -0,0 +1,40 @@
+# -*- coding: utf-8 -*-
+
+module Ircbot
+  class Client
+
+    ######################################################################
+    ### Config
+
+    class Config
+      def channels
+        case (val = super)
+        when Array
+          val
+        else
+          val.to_s.split
+        end
+      end
+    end
+
+    ######################################################################
+    ### Event
+
+    def on_rpl_welcome(m)
+      super
+
+      config.channels.each do |channel|
+        post JOIN, channel
+      end
+    end
+
+    ######################################################################
+    ### Command
+
+    def broadcast(text)
+      config.channels.each do |channel|
+        privmsg channel, text
+      end
+    end
+  end
+end

data/lib/ircbot/client/config/plugins.rb

@@ -0,0 +1,16 @@
+# -*- coding: utf-8 -*-
+
+module Ircbot
+  class Client
+    class Config
+      def plugins
+        case (val = super)
+        when Array
+          val
+        else
+          val.to_s.split
+        end
+      end
+    end
+  end
+end

data/lib/ircbot/client/encoding.rb

@@ -0,0 +1,17 @@
+# -*- coding: utf-8 -*-
+
+module Ircbot
+  class Client
+    ######################################################################
+    ### Character conversions
+
+    def decode(text)
+      NKF.nkf('-w', text.to_s)
+    end
+
+    def encode(text)
+      NKF.nkf('-j', text.to_s)
+    end
+  end
+end
+

data/lib/ircbot/client/plugins.rb

@@ -0,0 +1,64 @@
+# -*- coding: utf-8 -*-
+
+module Ircbot
+  class Client
+    ######################################################################
+    ### Accessors
+
+    def plugins
+      @plugins ||= Plugins.new(self, config.plugins)
+    end
+
+    delegate :plugin!, :plugin, :to=>"plugins"
+
+
+    ######################################################################
+    ### Events
+
+    def on_privmsg(m)
+      super
+
+      text = decode(m.params[1].to_s)
+      args = [text, m.prefix.nick, m]
+
+      plugins_call_replies(args, m)
+    end
+
+    private
+      def plugins_call_replies(args, m)
+        text = catch(:halt) do
+          plugins.active.each do |plugin|
+            plugins_call_action(:reply, plugin, args, m, :reply=>true)
+          end
+          return true
+        end
+        m.reply(self, text) if text
+      end
+
+      def plugins_call_logs(args)        
+        raise NotImplementedError, "obsoleted"
+        plugins.active.each do |plugin|
+          plugins_call_action(:log, plugin, args)
+        end
+      end
+
+      def plugins_call_action(type, plugin, args, m, opts = {})
+        plugin.message = m
+        arity = plugin.method(type).arity rescue return
+        reply = plugin.__send__(type, *args[0,arity])
+        m.reply(self, reply) if opts[:reply]
+      rescue Exception => e
+        type = (e.class == RuntimeError) ? 'Error' : "#{e.class}"
+        m.reply(self, "#{type}: #{e.message}")
+        plugins_rescue_action type, plugin, e
+      end
+
+      def plugins_rescue_action(type, plugin, e)
+        p [e.class, e.message, type, plugin]
+        at = e.backtraces rescue '(no backtraces)'
+        puts at
+      end
+
+  end
+end
+