kris 0.0.1 → 0.0.2

data/README.md

@@ -5,8 +5,8 @@ IRC bot library - Pluggable, and very simple
 
 [![Gem Version](https://badge.fury.io/rb/kris.png)](http://badge.fury.io/rb/kris)
 [![Dependency Status](https://gemnasium.com/Tomohiro/kris.png)](https://gemnasium.com/Tomohiro/kris)
+[![Stillmaintained](http://stillmaintained.com/Tomohiro/kris.png)](http://stillmaintained.com/Tomohiro/kris)
 [![Code Climate](https://codeclimate.com/badge.png)](https://codeclimate.com/github/Tomohiro/kris)
-[![endorse](http://api.coderwall.com/tomohiro/endorsecount.png)](http://coderwall.com/tomohiro)
 
 
 ---
@@ -16,7 +16,6 @@ Requirements
 --------------------------------------------------------------------------------
 
 - Ruby 1.9.3 or lator
-- Zircon
 
 
 Getting started
@@ -49,7 +48,7 @@ Install
         |-- MyBot
         `-- plugin
             |-- reply.rb
-            `-- crawler.rb
+            `-- hello.rb
 
 
 #### Bootstrap Bot
@@ -67,7 +66,10 @@ Kris::Session.new(
   channel:  '#my-bot-channel',
   nickname: 'MyBot',
   username: 'MyBot',
-  realname: 'MyBot'
+  realname: 'MyBot',
+  # Optional settings is below (Not Required)
+  channels: %(#foo #bar #baz),  # If you want to join another channels with additional
+  plugin_path: '/home/kris/my-bot-plugins'  # If you want to specify a defferent path
 ).start
 ```
 
@@ -78,29 +80,27 @@ Response
 
 ```ruby
 class Reply < Kris::Plugin
-  def response(message)
+  def on_privmsg(message)
     case message.body.downcase
     when /hello/
       reply(message.to, message.from, 'Hello!')
     end
   end
+
+  def on_topic(message)
+    notice(message.to, "Now topic is #{message.body}")
+  end
 end
 ```
 
-Notification
+Scheduled notification
 
 ```ruby
-class Crawler < Kris::Plugin
+class Hello < Kris::Plugin
   def notify
-    crawl_datas do |new_data|
-      notice('#notify-channel', new_data)
-    end
+    sleep 300
+    notice('#notify-channel', 'Hello')
   end
-
-  private
-    def crawl_datas
-      # do something
-    end
 end
 ```
 

data/example/mybot/bot

@@ -6,6 +6,7 @@ bot = Kris::Session.new(
   :server   => 'irc.freenode.net',
   :port     => 6667,
   :channel  => '#MyChannel',
+# :channels => %w(#channel_1 #channel_2 #channel3)   #  If you want join multiple channels.
   :username => 'ExampleBot',
   :nickname => 'ExampleBot',
   :realname => 'ExampleBot'

data/example/mybot/plugin/reply.rb

@@ -1,5 +1,5 @@
 class Reply < Kris::Plugin
-  def response(message)
+  def on_privmsg(message)
     case message.body.downcase
     when /hello/
       reply(message.to, message.from, 'Hello!')

data/kris.gemspec

@@ -6,14 +6,14 @@ require 'kris/version'
 Gem::Specification.new do |gem|
   gem.name          = 'kris'
   gem.version       = Kris::VERSION
-  gem.authors       = ['Tomohiro, TAIRA']
+  gem.authors       = ['Tomohiro TAIRA']
   gem.email         = ['tomohiro.t@gmail.com']
-  gem.description   = 'IRC bot'
-  gem.summary       = 'IRC bot'
+  gem.description   = 'IRC bot library - Pluggable, and very simple'
+  gem.summary       = 'IRC bot library - Pluggable, and very simple'
   gem.homepage      = 'https://github.com/Tomohiro/kris'
 
   gem.files         = `git ls-files`.split($/)
-  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.executables   = gem.files.grep(%r{^bin/}).map { |f| File.basename(f) }
   gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
   gem.require_paths = ['lib']
 

data/lib/kris/plugin.rb

@@ -1,16 +1,21 @@
 module Kris
   class Plugin
     class << self
-      def autoload(robot)
-        Dir.glob(File.expand_path('./plugin/*.rb')).each do |file|
+      def autoload(plugin_path = nil)
+        return unless plugin_path
+
+        plugin_files(plugin_path).each do |file|
           require file
-          klass = eval(filename_classify(File.basename(file, '.rb'))).new(robot)
-          yield klass
+          yield eval(filename_classify(file))
         end
       end
 
-      def filename_classify(filename)
-        filename.split('_').map(&:capitalize).join
+      def filename_classify(file)
+        File.basename(file, '.rb').split('_').map(&:capitalize).join
+      end
+
+      def plugin_files(plugin_path)
+        Dir[File.join(File.expand_path(plugin_path), '*.rb')]
       end
     end
 
@@ -19,25 +24,17 @@ module Kris
     end
 
     def boot
-      @robot.on_privmsg do |message|
-        response(message)
-      end
-
-      Thread.start do
-        loop do
-          notify
-          sleep 1
-        end
-      end
+      load_callbacks
+      start_notification_scheduler
     end
 
     protected
-      # do nothing.
-      # override this method.
-      def response(message); end
+      # Call response method is for backwords compatibility
+      def on_privmsg(message)
+        response(message) if respond_to?(:response)
+      end
 
-      # do nothing.
-      # override this method.
+      # Override this method if you want get scheduled notification.
       def notify; end
 
       def notice(channel, message)
@@ -49,7 +46,29 @@ module Kris
       end
 
       def reply(channel, reply_to, message)
-        privmsg(channel, "#{reply_to}: #{message}")
+        @robot.privmsg(channel, ":#{reply_to}: #{message}")
+      end
+
+    private
+      def load_callbacks
+        Zircon::COMMAND_NAMES.each do |command|
+          method_name = "on_#{command.downcase}"
+          next unless respond_to?(method_name)
+
+          @robot.send(method_name) do |message|
+            send(method_name, message)
+          end
+        end
+      end
+
+      def start_notification_scheduler
+        return unless respond_to?(:notify)
+        Thread.start do
+          loop do
+            notify
+            sleep 1
+          end
+        end
       end
   end
 end

data/lib/kris/session.rb

@@ -2,25 +2,39 @@ require 'zircon'
 require 'kris/zircon/message'
 
 module Kris
-  class Session
+  class Session < Zircon
     def initialize(config)
-      @logger = Logger.new(STDOUT)
-      @robot  = Zircon.new(config)
+      @logger      = Logger.new(STDOUT)
+      @channels    = config.fetch(:channels, nil)
+      @plugin_path = config.fetch(:plugin_path, './plugin')
+      super(config)
     end
 
     def start
       @logger.info('Booting Kris...')
-
-      Plugin.autoload(@robot) do |plugin|
-        @logger.info("#{plugin.class} loaded.")
-        plugin.boot
-      end
-
-      @robot.run!
+      run!
     rescue => e
       @logger.error(e)
     ensure
-      @robot.part
+      part
     end
+
+    protected
+      def run!
+        Plugin.autoload(@plugin_path) do |plugin|
+          @logger.info("#{plugin} loaded.")
+          plugin.new(self).boot
+        end
+
+        login
+        join_to_channels(@channels) if @channels
+        wait_message
+      end
+
+      def join_to_channels(channels)
+        channels.each do |channel|
+          join(channel)
+        end
+      end
   end
 end

data/lib/kris/version.rb

@@ -1,3 +1,3 @@
 module Kris
-  VERSION = '0.0.1'
+  VERSION = '0.0.2'
 end

data/lib/kris/zircon/message.rb

@@ -1,5 +1,9 @@
 class Zircon
   class Message
+    def to
+      params[0].force_encoding('UTF-8')
+    end
+
     def body
       params[1].force_encoding('UTF-8')
     end

data/lib/kris.rb

@@ -1,7 +1,8 @@
-require 'kris/version'
+require 'rubygems'
 require 'logger'
 
 module Kris
-  autoload :Session, 'kris/session'
-  autoload :Plugin,  'kris/plugin'
+  require 'kris/version'
+  require 'kris/session'
+  require 'kris/plugin'
 end

metadata

@@ -1,15 +1,15 @@
 --- !ruby/object:Gem::Specification
 name: kris
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
   prerelease: 
 platform: ruby
 authors:
-- Tomohiro, TAIRA
+- Tomohiro TAIRA
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-01-21 00:00:00.000000000 Z
+date: 2013-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: zircon
@@ -27,7 +27,7 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: '0'
-description: IRC bot
+description: IRC bot library - Pluggable, and very simple
 email:
 - tomohiro.t@gmail.com
 executables: []
@@ -40,7 +40,7 @@ files:
 - README.md
 - Rakefile
 - example/mybot/Gemfile
-- example/mybot/README.markdown
+- example/mybot/README.md
 - example/mybot/bot
 - example/mybot/plugin/reply.rb
 - kris.gemspec
@@ -72,5 +72,5 @@ rubyforge_project:
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: IRC bot
+summary: IRC bot library - Pluggable, and very simple
 test_files: []