kris 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+vendor

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in kris.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 - 2013 Tomohiro TAIRA
+
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -0,0 +1,120 @@
+Kris
+================================================================================
+
+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)
+[![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)
+
+
+---
+
+
+Requirements
+--------------------------------------------------------------------------------
+
+- Ruby 1.9.3 or lator
+- Zircon
+
+
+Getting started
+--------------------------------------------------------------------------------
+
+
+### Install the kris
+
+#### RubyGems.org
+
+    gem install kris
+
+
+#### Bundler
+
+Edit a `Gemfile`
+
+    gem 'kris', :git => 'git://github.com/Tomohiro/kris.git'
+
+
+Install
+
+    $ bundle install --path vendor/bundle
+
+
+### Bot project directory structure
+
+    my-bot-project
+        |-- Gemfile
+        |-- MyBot
+        `-- plugin
+            |-- reply.rb
+            `-- crawler.rb
+
+
+#### Bootstrap Bot
+
+    $ vi my-bot-project/MyBot
+
+```ruby
+#!/usr/bin/env ruby
+
+require 'kris'
+
+Kris::Session.new(
+  server:   'chat.freenode.net',
+  port:     6667,
+  channel:  '#my-bot-channel',
+  nickname: 'MyBot',
+  username: 'MyBot',
+  realname: 'MyBot'
+).start
+```
+
+
+### Plugin example
+
+Response
+
+```ruby
+class Reply < Kris::Plugin
+  def response(message)
+    case message.body.downcase
+    when /hello/
+      reply(message.to, message.from, 'Hello!')
+    end
+  end
+end
+```
+
+Notification
+
+```ruby
+class Crawler < Kris::Plugin
+  def notify
+    crawl_datas do |new_data|
+      notice('#notify-channel', new_data)
+    end
+  end
+
+  private
+    def crawl_datas
+      # do something
+    end
+end
+```
+
+
+### Run
+
+    $ bundle exec ruby MyBot
+
+
+
+
+LICENSE
+--------------------------------------------------------------------------------
+
+&copy; 2012 - 2013 Tomohiro TAIRA.
+This project is licensed under the MIT license.
+See LICENSE for details.

data/Rakefile

@@ -0,0 +1 @@
+require 'bundler/gem_tasks'

data/example/mybot/Gemfile

@@ -0,0 +1,3 @@
+source :rubygems
+
+gem 'kris', :git => 'git://github.com/Tomohiro/kris.git'

data/example/mybot/README.markdown

@@ -0,0 +1,7 @@
+# IRC Bot
+
+### Start
+
+    $ cd kris/example/mybot
+    $ bundle install --path vendor/bundle
+    $ bundle exec ./bot

data/example/mybot/bot

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'kris'
+
+bot = Kris::Session.new(
+  :server   => 'irc.freenode.net',
+  :port     => 6667,
+  :channel  => '#MyChannel',
+  :username => 'ExampleBot',
+  :nickname => 'ExampleBot',
+  :realname => 'ExampleBot'
+)
+
+bot.start

data/example/mybot/plugin/reply.rb

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

data/kris.gemspec

@@ -0,0 +1,21 @@
+# encoding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'kris/version'
+
+Gem::Specification.new do |gem|
+  gem.name          = 'kris'
+  gem.version       = Kris::VERSION
+  gem.authors       = ['Tomohiro, TAIRA']
+  gem.email         = ['tomohiro.t@gmail.com']
+  gem.description   = 'IRC bot'
+  gem.summary       = 'IRC bot'
+  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.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.require_paths = ['lib']
+
+  gem.add_runtime_dependency 'zircon'
+end

data/lib/kris.rb

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

data/lib/kris/plugin.rb

@@ -0,0 +1,55 @@
+module Kris
+  class Plugin
+    class << self
+      def autoload(robot)
+        Dir.glob(File.expand_path('./plugin/*.rb')).each do |file|
+          require file
+          klass = eval(filename_classify(File.basename(file, '.rb'))).new(robot)
+          yield klass
+        end
+      end
+
+      def filename_classify(filename)
+        filename.split('_').map(&:capitalize).join
+      end
+    end
+
+    def initialize(robot)
+      @robot = robot
+    end
+
+    def boot
+      @robot.on_privmsg do |message|
+        response(message)
+      end
+
+      Thread.start do
+        loop do
+          notify
+          sleep 1
+        end
+      end
+    end
+
+    protected
+      # do nothing.
+      # override this method.
+      def response(message); end
+
+      # do nothing.
+      # override this method.
+      def notify; end
+
+      def notice(channel, message)
+        @robot.notice(channel, ":#{message}")
+      end
+
+      def privmsg(channel, message)
+        @robot.privmsg(channel, ":#{message}")
+      end
+
+      def reply(channel, reply_to, message)
+        privmsg(channel, "#{reply_to}: #{message}")
+      end
+  end
+end

data/lib/kris/session.rb

@@ -0,0 +1,26 @@
+require 'zircon'
+require 'kris/zircon/message'
+
+module Kris
+  class Session
+    def initialize(config)
+      @logger = Logger.new(STDOUT)
+      @robot  = Zircon.new(config)
+    end
+
+    def start
+      @logger.info('Booting Kris...')
+
+      Plugin.autoload(@robot) do |plugin|
+        @logger.info("#{plugin.class} loaded.")
+        plugin.boot
+      end
+
+      @robot.run!
+    rescue => e
+      @logger.error(e)
+    ensure
+      @robot.part
+    end
+  end
+end

data/lib/kris/version.rb

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

data/lib/kris/zircon/message.rb

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

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification
+name: kris
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Tomohiro, TAIRA
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2013-01-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: zircon
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: IRC bot
+email:
+- tomohiro.t@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.md
+- Rakefile
+- example/mybot/Gemfile
+- example/mybot/README.markdown
+- example/mybot/bot
+- example/mybot/plugin/reply.rb
+- kris.gemspec
+- lib/kris.rb
+- lib/kris/plugin.rb
+- lib/kris/session.rb
+- lib/kris/version.rb
+- lib/kris/zircon/message.rb
+homepage: https://github.com/Tomohiro/kris
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.23
+signing_key: 
+specification_version: 3
+summary: IRC bot
+test_files: []