ircbot 0.1.5 → 0.2.0

data/.gitignore

@@ -0,0 +1,5 @@
+!.gitignore
+*.gem
+*~
+.bundle
+/vendor

data/Gemfile

@@ -0,0 +1,3 @@
+source 'https://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,71 @@
+PATH
+  remote: .
+  specs:
+    ircbot (0.2.0)
+      chawan
+      data_objects
+      dm-core
+      dm-migrations
+      dm-postgres-adapter
+      dm-sqlite-adapter
+      dm-timestamps
+      do_sqlite3
+      dsl_accessor (>= 0.4.0)
+      extlib (>= 0.9.14)
+      net-irc (>= 0.0.9)
+      night-time
+      pg
+      sqlite3
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    addressable (2.2.8)
+    blankslate (2.1.2.4)
+    chawan (0.0.4)
+    data_objects (0.10.8)
+      addressable (~> 2.1)
+    diff-lcs (1.1.3)
+    dm-core (1.2.0)
+      addressable (~> 2.2.6)
+    dm-do-adapter (1.2.0)
+      data_objects (~> 0.10.6)
+      dm-core (~> 1.2.0)
+    dm-migrations (1.2.0)
+      dm-core (~> 1.2.0)
+    dm-postgres-adapter (1.2.0)
+      dm-do-adapter (~> 1.2.0)
+      do_postgres (~> 0.10.6)
+    dm-sqlite-adapter (1.2.0)
+      dm-do-adapter (~> 1.2.0)
+      do_sqlite3 (~> 0.10.6)
+    dm-timestamps (1.2.0)
+      dm-core (~> 1.2.0)
+    do_postgres (0.10.8)
+      data_objects (= 0.10.8)
+    do_sqlite3 (0.10.8)
+      data_objects (= 0.10.8)
+    dsl_accessor (0.4.1)
+      blankslate (>= 2.1.2)
+      optionize (>= 0.1.0)
+    extlib (0.9.15)
+    net-irc (0.0.9)
+    night-time (1.0.1)
+    optionize (0.1.1)
+    pg (0.14.0)
+    rspec (2.10.0)
+      rspec-core (~> 2.10.0)
+      rspec-expectations (~> 2.10.0)
+      rspec-mocks (~> 2.10.0)
+    rspec-core (2.10.1)
+    rspec-expectations (2.10.0)
+      diff-lcs (~> 1.1.3)
+    rspec-mocks (2.10.1)
+    sqlite3 (1.3.6)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  ircbot!
+  rspec (>= 2.9.0)

data/README

@@ -23,7 +23,11 @@ Config
 Usage
 =====
 
-  ircbot -f config/xxx.yml
+  (installed gem)
+  % ircbot -f config/xxx.yml
+
+  (in source dir)
+  % ruby -Ku -rubygems -Ilib bin/ircbot -f config/xxx.yml
 
 
 Plugin
@@ -34,9 +38,10 @@ 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]
-
+              args: [text, nick, message object]
+    * setup : used for initializer
     * help  : used from "plugins" plugin
+    * [ANY] : any methods can be invoked by "<NICK>.<PLUGN_NAME>.<METHOD_NAME>"
 
   Accessor methods:
 
@@ -45,6 +50,14 @@ Plugin
     * config  : hash of given config file
 
 
+Setup
+=====
+
+  Install gems via bundler like this.
+
+    % bundle install --path vendor
+
+
 Example
 =======
 
@@ -83,6 +96,62 @@ Advanced
   BPlugin#reply will be never invoked.
 
 
+Daemons
+=======
+
+  Plugin initializer automatically calls "setup" method.
+  So you can start daemon in it.
+
+  plugins/time_signal.rb:
+
+    class TimeSignalPlugin < Ircbot::Plugin
+      def setup
+        @daemon = Thread.new {
+          sleep 60
+          self.bot.broadcast Time.now
+        }
+      end
+
+      def stop
+        @daemon.kill
+        return "Stopped time signal"
+      end
+    end
+
+  When the bot name is 'airi', this will act as following.
+
+    05:11 <airi> Mon Apr 09 05:11:22 +0900 2012
+    05:12 <airi> Mon Apr 09 05:12:22 +0900 2012
+    05:12 <maiha> airi.time_signal.stop
+    05:12 <airi> Stopped time signal
+
+
+PluginAttributes
+================
+
+  When you want to give options or attributes to plugins,
+  write it into config.plugins as Array(Hash)
+
+  config/xxx.yml
+    plugins:
+      - irc
+      -
+        name: watchdog
+        db: "postgres://localhost/ircbot"
+
+  This will generate two plugins
+    1. Ircbot::Plugin(name:irc)
+    2. Ircbot::Plugin(name:watchdog, attrs=>{name=>watchdog,db=>postgres...})
+
+  And the given options can be found in plugin by [] method.
+
+    class Watchdog < Ircbot::Plugin
+      def setup
+        db = self[:db]
+        puts "connecting to #{db}"
+        ...
+
+
 Required
 ========
 

data/bin/ircbot

@@ -1,5 +1,8 @@
 #!/usr/bin/env ruby
 
+require 'rubygems'
+require "bundler/setup"
+
 require 'ircbot'
 
 config = nil

data/config/samples/postgres.yml

@@ -0,0 +1,19 @@
+host: localhost
+port: 6667
+nick: sama-zu
+user: samazu
+real: sama~zu
+channels: "#test"
+plugins:
+  - irc
+  - plugins
+  -
+    name: watchdog
+    db: "postgres://localhost/ircbot"
+  - 
+    name: reminder
+    db: "postgres://localhost/ircbot"
+  - summary
+reminder
+multiline: true
+timeout: 500

data/config/{sama-zu.yml → samples/sama-zu.yml}

@@ -4,6 +4,6 @@ nick: sama-zu
 user: samazu
 real: sama~zu
 channels: "#test"
-plugins: irc plugins
+plugins: irc plugins watchdog reminder summary
 multiline: true
 timeout: 500

data/ircbot.gemspec

@@ -22,6 +22,19 @@ Gem::Specification.new do |s|
   s.add_dependency "dsl_accessor", ">= 0.4.0"
   s.add_dependency "extlib", ">= 0.9.14"
   s.add_dependency "net-irc", ">= 0.0.9"
+  s.add_dependency 'chawan'
+  s.add_dependency 'night-time'
+
+  s.add_dependency 'pg'
+  s.add_dependency 'sqlite3'
+
+  s.add_dependency 'dm-core'
+  s.add_dependency 'dm-migrations'
+  s.add_dependency 'dm-timestamps'
+  s.add_dependency 'do_sqlite3'
+  s.add_dependency 'data_objects'
+  s.add_dependency 'dm-sqlite-adapter'
+  s.add_dependency 'dm-postgres-adapter'
 
   s.add_development_dependency "rspec", ">= 2.9.0"
 end

data/lib/ircbot.rb

@@ -18,8 +18,10 @@ $LOAD_PATH.unshift __DIR__ unless
 require "ircbot/framework"
 require "ircbot/version"
 
-Ircbot.push_path(:plugin, Ircbot.system_root + 'plugins')
 Ircbot.push_path(:config, Ircbot.system_root + 'config')
+Ircbot.push_path(:plugin, Ircbot.system_root + 'plugins')
+Ircbot.push_path(:plugin, Ircbot.root + 'plugins')
+$:.unshift((Ircbot.root + 'plugins').to_s)
 Ircbot.toplevel_binding = binding
 
 ######################################################################

data/lib/ircbot/client.rb

@@ -17,3 +17,9 @@ require "ircbot/client/config/channels"
 require "ircbot/client/config/plugins"
 require "ircbot/client/timeout"
 require "ircbot/client/plugins"
+
+######################################################################
+### Irctob::Utils
+
+require "ircbot/utils/watcher"
+require "ircbot/utils/html_parser"

data/lib/ircbot/client/config.rb

@@ -53,6 +53,15 @@ module Ircbot
       @config = Config.new(hash)
     end
 
+    def trim(text, size = 120)
+      a = text.to_s.split(//)
+      if a.size > size
+        return a[0..size].join + "..."
+      else
+        return text.to_s
+      end
+    end
+
     attr_reader :config
   end
 end

data/lib/ircbot/client/plugins.rb

@@ -19,10 +19,23 @@ module Ircbot
       text = decode(m.params[1].to_s)
       args = [text, m.prefix.nick, m]
 
+      plugins_call_command(args, m)
       plugins_call_replies(args, m)
     }
 
     private
+      def plugins_call_command(args, m)
+        case m.message.to_s          # text
+        when /^#{config.nick}\.(#{plugins.active_names.join('|')})\./
+          plugin = plugins[$1]
+          command, arg = $'.to_s.split(/\b/, 2)
+          args = [arg.to_s.strip]
+          if plugin.class.command?(command)
+            plugins_call_action(command, plugin, args, m, :reply=>true)
+          end
+        end
+      end
+
       def plugins_call_replies(args, m)
         text = catch(:done) do
           plugins.active.each do |plugin|
@@ -54,7 +67,7 @@ module Ircbot
 
       def plugins_rescue_action(type, plugin, e)
         p [e.class, e.message, type, plugin]
-        at = e.backtraces rescue '(no backtraces)'
+        at = e.backtrace rescue '(no backtraces)'
         puts at
       end
 

data/lib/ircbot/core_ext/message.rb

@@ -12,7 +12,10 @@ class Net::IRC::Message
 
   def reply(client, text)
     to = (client.config.nick == params[0]) ? prefix.nick : params[0]
-    client.privmsg to, text.to_s unless text.to_s.empty?
+    unless text.to_s.empty?
+      text = client.trim(text)
+      client.privmsg to, text
+    end
   end
 end
 

data/lib/ircbot/plugin.rb

@@ -19,10 +19,19 @@ module Ircbot
     attr_accessor :running
     attr_accessor :plugin_name
 
+    def self.command?(name)
+      @commands ||= (public_instance_methods - Plugin.public_instance_methods).inject({"setup"=>1, "help"=>1}) {|h,k| h[k.to_s] = 1; h }
+      !! @commands[name.to_s]
+    end
+
     def initialize(plugins = nil)
       @plugins = plugins || Plugins.new
       @message = InitialMessage.new(self.class.name)
       @running = false
+      @attrs   = Mash.new
+    end
+
+    def setup
     end
 
     ######################################################################
@@ -31,6 +40,10 @@ module Ircbot
     delegate :plugin!, :client, :bot, :config, :to=>"@plugins"
     delegate :debug, :to=>"@plugins"
 
+    def [](key)
+      @attrs[key]
+    end
+
     def plugin_name
       @plugin_name ||= Extlib::Inflection.foreign_key(self.class.name).sub(/(_plugin)?_id$/,'')
     end
@@ -43,6 +56,10 @@ module Ircbot
       "%s%s" % [running ? '*' : '', plugin_name]
     end
 
+    def attrs=(hash)
+      @attrs = Mash.new(hash)
+    end
+
     ######################################################################
     ### Operations
 

data/lib/ircbot/plugins.rb

@@ -11,8 +11,9 @@ module Ircbot
     def initialize(client = nil, plugins = nil)
       @client  = client  || Client::Standalone.new
       @plugins = Dictionary.new
+      @cache   = {}
 
-      load_plugins Array(plugins)
+      load Array(plugins)
     end
 
     ######################################################################
@@ -24,9 +25,35 @@ module Ircbot
       plugins.values.__send__(:each, &block)
     end
 
+    ######################################################################
+    ### Caching
+
+    def clear_cache
+      @cache = {}
+    end
+
+    def cache(key = nil, &block)
+      key = key.to_s
+      return @cache ||= {} if key.empty?
+
+      if @cache.has_key?(key)
+        @cache[key]
+      else
+        @cache[key] = block.call
+      end
+    end
+
     ######################################################################
     ### Accessors
 
+    def active_names
+      cache(:active_names) { active.map(&:plugin_name) }
+    end
+
+    def active
+      cache(:active) { select(&:running) }
+    end
+
     def plugin!(plugin)
       case plugin
       when String, Symbol
@@ -52,22 +79,29 @@ module Ircbot
 
     def start(plugin)
       plugin!(plugin).running = true
+      changed!
     end
 
     def stop(plugin)
       plugin!(plugin).running = false
+      changed!
     end
 
     def delete(plugin)
       name = plugin.is_a?(Plugin) ? plugin.name : plugin.to_s
       plugin!(name)
       @plugins.delete(name)
+      changed!
+    end
+
+    def changed!
+      clear_cache
     end
 
     ######################################################################
     ### IO
 
-    def load_plugins(plugin)
+    def load(plugin)
       case plugin
       when Array
         plugin.each do |name|
@@ -77,6 +111,7 @@ module Ircbot
         plugin.plugins = self
         plugins[plugin.plugin_name] = plugin
         plugin.running = true
+        plugin.setup
       when Class
         if plugin.ancestors.include?(Ircbot::Plugin)
           self << plugin.new(self)
@@ -84,44 +119,64 @@ module Ircbot
           raise ArgumentError, "#{plugin} is not Ircbot::Plugin"
         end
       when String, Symbol
+        self << {"name" => plugin.to_s}
+      when Hash
         begin
-          name = plugin.to_s
-          self << load(name)
+          attrs = Mash.new(plugin)
+          name  = attrs["name"]
+          if name.blank?
+            raise "no names: #{attrs.inspect}"
+          end
+          plugin = eval_plugin(name)
+          plugin.attrs = attrs
+          self << plugin
         rescue Exception => e
-          broadcast "Plugin error(#{name}): #{e}[#{e.class}]"
+          invalid_plugin_found "Plugin error(#{name}): #{e}[#{e.class}]"
         end
       else
         raise NotImplementedError, "#<< for #{plugin.class}"
       end
+      changed!
       return self
     end
-    alias :<< :load_plugins
+    alias :<< :load
+
+    def eval_plugin(name)
+      class_name = plugin_class_name(name)
+
+      if Object.const_defined?(class_name)
+        Object.send(:remove_const, class_name)
+      end
 
-    def load(name)
       path = Ircbot.glob_for(:plugin, name).first or
         raise PluginNotFound, name.to_s
 
       script = path.read{}
-      eval(script, Ircbot.toplevel_binding)
+      Dir.chdir(path.parent) do
+        eval(script, Ircbot.toplevel_binding)
+      end
 
-      class_name = Extlib::Inflection.camelize(name) + "Plugin"
       return Object.const_get(class_name).new
 
     rescue NameError => e
       raise LoadError, "Expected #{path} to define #{class_name} (#{e})"
     end
 
-    def active
-      select(&:running)
-    end
-
     def inspect
       plugins.values.inspect
     end
 
+    def invalid_plugin_found(text)
+      broadcast text
+    end
+
     private
       def broadcast(text)
         p text
       end
+
+      def plugin_class_name(name)
+        Extlib::Inflection.camelize(name) + "Plugin"
+      end
   end
 end