ircbot 0.0.2 → 0.1.0

data/lib/ircbot/version.rb

@@ -0,0 +1,4 @@
+module Ircbot
+  VERSION  = '0.1.0' unless defined?(Ircbot::VERSION)
+  HOMEPAGE = "http://github.com/maiha/ircbot"
+end

data/plugins/echo.rb

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ircbot'
+
+class EchoPlugin < Ircbot::Plugin
+  def help
+    "[Echo] echo back privmsg"
+  end
+
+  def reply(text)
+    return "[#{text}]"
+  end
+end

data/plugins/irc.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ircbot'
+
+class IrcPlugin < Ircbot::Plugin
+  def reply(text)
+    if direct?
+      if text[0] == ?!
+        command, params = text[1..-1].strip.split(/\s+/,2)
+        command = Net::IRC::Constants.const_get(command.to_s.upcase)
+        bot.__send__(:post, command, params)
+        throw :halt
+      end
+    end
+    return nil
+  end
+end
+

data/plugins/plugins.rb

@@ -0,0 +1,59 @@
+#!/usr/bin/env ruby
+
+require 'rubygems'
+require 'ircbot'
+
+class PluginsPlugin < Ircbot::Plugin
+  def help
+    <<-EOF
+[control plugins]
+usage: #{config.nick}.COMMANDS [PLUGIN_NAME]
+commands: load, start, stop, delete
+#{plugins_help}
+    EOF
+  end
+
+  def reply(text)
+    text.strip.gsub(/^#{config.nick}\./) {
+      command, arg = $'.split(/\s+/,2)
+      arg = arg.to_s.strip
+
+      case command.to_s
+      when "load", "register"
+        plugins << Array(arg.split)
+        throw :halt, "Loaded #{arg}"
+
+      when "delete", "remove"
+        plugins.remove arg
+        throw :halt, "Removed #{arg}"
+
+      when "start"
+        plugins.start arg
+        throw :halt, "Started #{arg}"
+
+      when "stop"
+        plugins.stop arg
+        throw :halt, "Stopped #{arg}"
+
+      when "help"
+        if arg.empty?
+          throw :halt, [bot_help, plugins_help].join("\n")
+        else
+          throw :halt, plugins[arg].help
+        end
+      end
+    }
+    return nil
+  end
+
+  private
+    def plugins_help
+      "plugins: %s" % plugins.map(&:to_s).join(', ')
+    end
+
+    def bot_help
+      config.help ||
+        "%s bot [%s (ver:%s)]" % [config.nick, Ircbot::HOMEPAGE, Ircbot::VERSION]
+    end
+end
+

data/spec/config_spec.rb

@@ -0,0 +1,83 @@
+#!/usr/bin/ruby
+
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe Ircbot::Client do
+  it "should provide .new" do
+    Ircbot::Client.should respond_to(:new)
+  end
+
+  describe ".new" do
+    it "should accept a hash" do
+      lambda { 
+        Ircbot::Client.new({})
+      }.should_not raise_error
+    end
+  end
+
+  describe "#config" do
+    before do
+      @config = {
+        :nick => "sama-zu",
+        :user => "samazu",
+        :real => "sama~zu",
+        :host => "localhost",
+        :port => "6667",
+      }
+    end
+
+    subject { Ircbot::Client.new(@config).config }
+
+    its(:nick) { should == "sama-zu" }
+    its(:user) { should == "samazu" }
+    its(:real) { should == "sama~zu" }
+    its(:host) { should == "localhost" }
+    its(:port) { should == "6667" }
+
+    describe "#channels" do
+      it "should return the array when an array is given" do
+        @config[:channels] = ["#ircbot"]
+        subject.channels.should == ["#ircbot"]
+      end
+
+      it "should return array when a string is given" do
+        @config[:channels] = "#ircbot"
+        subject.channels.should == ["#ircbot"]
+      end
+
+      it "should return [] when nil" do
+        @config[:channels] = nil
+        subject.channels.should == []
+      end
+    end
+  end
+
+  ######################################################################
+  ### Initialize from file
+
+  it "should provide .from_file" do
+    Ircbot::Client.should respond_to(:from_file)
+  end
+
+  ######################################################################
+  ### Readers
+
+  describe Ircbot::Client::Config do
+    describe "#read" do
+      it "should delegate to read_yml" do
+#         mock(subject).read_yml(__FILE__)
+#         subject.read(__FILE__)
+      end
+    end
+
+    describe "#read_yml" do
+      it do
+        hash = Ircbot::Client::Config.read(path("sama-zu.yml"))
+        hash.should be_a_kind_of(Mash)
+        hash["nick"].should == "sama-zu"
+        hash[:nick].should == "sama-zu"
+      end
+    end
+  end
+
+end

data/spec/fixtures/sama-zu.yml

@@ -0,0 +1,8 @@
+host: localhost
+port: 6667
+nick: sama-zu
+user: samazu
+real: sama~zu
+help: sama-zu bot (2010/01/09)
+channels: "#test"
+plugins: irc plugins

data/spec/framework_spec.rb

@@ -0,0 +1,18 @@
+#!/usr/bin/ruby
+
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe Ircbot do
+  provide :root
+  provide :root=
+  provide :push_path
+  provide :glob_for
+
+  describe ".glob_for" do
+    it do
+      dir = Pathname(File.dirname(__FILE__))
+      Ircbot.push_path(:spec, dir)
+      Ircbot.glob_for(:spec, "sama-zu").should == [dir + "fixtures" + "sama-zu.yml"]
+    end
+  end
+end

data/spec/its_helper.rb

@@ -0,0 +1,15 @@
+module Spec
+  module Example
+    module Subject
+      module ExampleGroupMethods
+        def its(*args, &block)
+          describe(args.first) do
+            define_method(:subject) { super().send(*args) }
+            it(&block)
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/plugin_spec.rb

@@ -0,0 +1,70 @@
+#!/usr/bin/ruby
+
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe Ircbot::Plugin do
+  class Foo       < Ircbot::Plugin; end
+  class Bar       < Ircbot::Plugin; end
+  class BarPlugin < Ircbot::Plugin; end
+
+  subject { Ircbot::Plugin.new }
+
+  ######################################################################
+  ### plugin name
+
+  provide :plugin_name
+
+  its(:plugin_name) { should == 'plugin' }
+  describe "#plugin_name" do
+    it { Foo.new.plugin_name.should == "foo" }
+    it { Bar.new.plugin_name.should == "bar" }
+    it { BarPlugin.new.plugin_name.should == "bar" }
+  end
+
+  provide :message
+  its(:message) { should be_kind_of(Ircbot::Plugin::InitialMessage) }
+
+  provide :plugins
+  provide :running
+  provide :config
+  provide :client
+  provide :bot
+
+  ######################################################################
+  ### private methods
+
+  provide :plugin
+  provide :plugin!
+  provide :direct?
+
+  ######################################################################
+  ### Not connected
+
+  context "(not connected)" do
+    subject{ Ircbot::Plugin.new }
+
+    its(:plugin , :foo) { should be_kind_of(Ircbot::Plugin::Null) }
+    its(:plugin!, :foo) { lambda {subject}.should raise_error(Ircbot::PluginNotFound) }
+    its(:direct?      ) { should == false }
+  end
+
+  ######################################################################
+  ### Connected
+
+  describe "(connected)" do    
+    before do
+      @client  = Ircbot::Client.new({})
+      @plugins = Ircbot::Plugins.new(@client)
+      @foo     = Foo.new
+      @bar     = Bar.new
+      @plugins << @foo << @bar
+    end
+    subject{ Ircbot::Plugin.new(@plugins) }
+
+    its(:plugin , :foo) { should == @foo }
+    its(:plugin!, :foo) { should == @foo }
+    its(:direct?      ) { should == false }
+  end
+
+end
+

data/spec/plugins_spec.rb

@@ -0,0 +1,30 @@
+#!/usr/bin/ruby
+
+require File.join(File.dirname(__FILE__), 'spec_helper.rb')
+
+describe Ircbot::Plugins do
+
+  ######################################################################
+  ### accessor methods
+
+  provide :client
+  provide :plugins
+  provide :active
+  provide :load_plugins
+  provide :load_plugin
+  provide :[]
+  provide :<<
+  provide :bot
+  provide :start
+  provide :stop
+  provide :delete
+
+  ######################################################################
+  ### Enumerable
+
+  provide :each
+  it "should be enumerable" do
+    subject.class.ancestors.should include(Enumerable)
+  end
+
+end

data/spec/provide_helper.rb

@@ -0,0 +1,36 @@
+######################################################################
+### provide matcher
+Spec::Matchers.define :provide do |expected|
+  match do |obj|
+    (obj.public_methods + obj.protected_methods + obj.private_methods).include?(expected.to_s)
+  end
+end
+
+module Spec
+  module Example
+    module Subject
+      module ExampleGroupMethods
+        # == Examples
+        #
+        #   describe User do
+        #     subject { User.new }
+        #     provide :name
+        #
+        #       [intead of]
+        #
+        #     it "should provide #name" do
+        #       methods = subject.public_methods + subject.protected_methods + subject.private_methods
+        #       methods.should include("name")
+        #     end
+        #   end
+        #
+        def provide(name)
+          it "should provide ##{name}" do
+            subject.should provide(name)
+          end
+        end
+      end
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,16 @@
+
+require 'spec'
+require 'rr'
+
+require File.join(File.dirname(__FILE__), '/../lib/ircbot')
+require File.join(File.dirname(__FILE__), '/its_helper')
+require File.join(File.dirname(__FILE__), '/provide_helper')
+
+
+def path(key)
+  Pathname(File.join(File.dirname(__FILE__) + "/fixtures/#{key}"))
+end
+
+def data(key)
+  path(key).read{}
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification 
 name: ircbot
 version: !ruby/object:Gem::Version 
-  version: 0.0.2
+  version: 0.1.0
 platform: ruby
 authors: 
 - maiha
@@ -9,20 +9,30 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-01-02 00:00:00 +09:00
+date: 2010-01-09 00:00:00 +09:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  name: activesupport
+  name: extlib
   type: :runtime
   version_requirement: 
   version_requirements: !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        version: 2.0.0
+        version: 0.9.14
     version: 
-description: old fashioned irc bot
+- !ruby/object:Gem::Dependency 
+  name: net-irc
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: 0.0.9
+    version: 
+description: An irc bot framework that offers easy-to-use by plugins
 email: maiha@wota.jp
 executables: 
 - ircbot
@@ -35,21 +45,32 @@ files:
 - MIT-LICENSE
 - README
 - Rakefile
-- lib/irc/agent.rb
-- lib/irc/const.rb
-- lib/irc/client.rb
-- lib/irc/localize.rb
-- lib/irc/irc.rb
 - lib/ircbot/framework.rb
-- lib/ircbot/ordered_hash.rb
-- lib/ircbot/reply_client.rb
-- lib/ircbot/core_ext/digest.rb
-- lib/ircbot/core_ext/rand-polimorphism.rb
-- lib/ircbot/core_ext/writefile.rb
-- lib/ircbot/core_ext/irc.rb
-- lib/ircbot/agent_manager.rb
-- lib/ircbot/config_client.rb
+- lib/ircbot/client.rb
+- lib/ircbot/client/config.rb
+- lib/ircbot/client/config/channels.rb
+- lib/ircbot/client/config/plugins.rb
+- lib/ircbot/client/encoding.rb
+- lib/ircbot/client/commands.rb
+- lib/ircbot/client/plugins.rb
+- lib/ircbot/core_ext/extending.rb
+- lib/ircbot/core_ext/message.rb
+- lib/ircbot/core_ext/delegation.rb
+- lib/ircbot/plugins.rb
+- lib/ircbot/version.rb
+- lib/ircbot/plugin.rb
 - lib/ircbot.rb
+- spec/config_spec.rb
+- spec/plugin_spec.rb
+- spec/provide_helper.rb
+- spec/fixtures/sama-zu.yml
+- spec/its_helper.rb
+- spec/spec_helper.rb
+- spec/framework_spec.rb
+- spec/plugins_spec.rb
+- plugins/echo.rb
+- plugins/plugins.rb
+- plugins/irc.rb
 has_rdoc: true
 homepage: http://github.com/maiha/ircbot
 licenses: []
@@ -77,6 +98,6 @@ rubyforge_project: asakusarb
 rubygems_version: 1.3.5
 signing_key: 
 specification_version: 3
-summary: old fashioned irc bot
+summary: easy irc bot framework
 test_files: []