vetinari 0.1.0 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 8caa318b353a259ce354a4f33ac6512929a70ddc
-  data.tar.gz: 6b0c114d8756323c6c93c7945e44b5c1392ee852
+  metadata.gz: a7b2a839017a8a6ad9cb366e4983223d18d79125
+  data.tar.gz: e9283985e9363ac330abaf31f07965ec26ef3049
 SHA512:
-  metadata.gz: edd9ea43bb5a3636a2a4dec5246c205c40d18c310d24782e4d43cfce515fa89558c83ae2f261b823053d45456265f38aca52e0d9d7a2ade0969894ba1f3a601d
-  data.tar.gz: ce1804db1898b39dfc6869dac32f98b3c2b1a9846e02a8ef8881c504e7b48bcaa71101b3ddad80a3d72009be0f106bcf14e1de00336cce6f9e223f5852d3d7d8
+  metadata.gz: e8faa48002d977fe10bed20ed4aa6e0f39669c0abdae838be9e13fa7d713e42c2361c63e0c499211e13bc68f63eb488ab14347d1110dc7a022f3a5beb6e19e43
+  data.tar.gz: 2c6726ab26892d11914ec986ae1ec5e7afe57c5dd35fa1164c9004c98dd4c19645a27dfb013d84c06db7f71681c5d4805b15cf0650f8f1b809a4ef34c522abde

data/Gemfile

@@ -1,2 +1,4 @@
 source 'https://rubygems.org'
 gemspec
+
+gem 'celluloid', github: 'celluloid/celluloid'

data/README.md

@@ -1,4 +1,4 @@
-# Vetinari [![Gem Version](https://badge.fury.io/rb/vetinari.png)](http://badge.fury.io/rb/vetinari)
+# Vetinari [![Gem Version](https://badge.fury.io/rb/vetinari.png)](http://badge.fury.io/rb/vetinari) [![Dependency Status](https://gemnasium.com/tbuehlmann/vetinari.png)](https://gemnasium.com/tbuehlmann/vetinari)
 Vetinari is a Domain Specific Language for writing IRC Bots using the [Celluloid::IO](https://github.com/celluloid/celluloid-io "Celluloid::IO") library.
 
 ## Requirements

data/lib/vetinari/bot.rb

@@ -346,6 +346,14 @@ module Vetinari
         env[:user].renamed_to(env.delete(:new_nick))
       end
 
+      on :topic do |env|
+        # TODO: Update existing users with user/host information.
+        env.delete(:user)
+        env.delete(:host)
+        env[:channel] = @channels[env.delete(:channel)]
+        env[:user] = @users[env.delete(:nick)]
+      end
+
       # Response to MODE command, giving back the channel modes.
       on 324 do |env|
         split = env[:params].split(/ /)

data/lib/vetinari/callback.rb

@@ -27,6 +27,10 @@ module Vetinari
       @container.remove(@event, @uuid)
     end
 
+    def remove_and_terminate
+      @container.remove(@event, @uuid, true)
+    end
+
     def inspect
       event   = @event.inspect
       options = @options.inspect

data/lib/vetinari/callback_container.rb

@@ -35,12 +35,16 @@ module Vetinari
       callback
     end
 
-    def remove(event, uuid)
+    def remove(event, uuid, terminate = false)
       @mutex.synchronize do
         if @callbacks.key?(event)
           hash = @callbacks[event].delete(uuid)
 
           if hash
+            if terminate && hash[:callback].alive?
+              hash[:callback].async.terminate
+            end
+
             # https://github.com/celluloid/celluloid/issues/197
             # callback.soft_terminate
 

data/lib/vetinari/channel.rb

@@ -4,9 +4,9 @@ module Vetinari
   #
   # Example:
   # {'ponder' => {:user => #<User nick="Ponder">, :modes => ['v', 'o']}}
-  #
-  # TODO: Actor?
   class Channel
+    include Celluloid
+
     attr_reader :name, :users, :users_with_modes, :modes, :lists
 
     def initialize(name, bot)
@@ -95,11 +95,50 @@ module Vetinari
     end
 
     def join(key = nil)
+      if @bot.channels.has_channel?(@name)
+        return Future.new { :already_joined }
+      end
+
+      condition = Celluloid::Condition.new
+      callbacks = Set.new
+
+      callbacks << @bot.on(:join) do |env|
+        if env[:channel].name == @name
+          condition.signal :joined
+          callbacks.each { |cb| cb.remove_and_terminate }
+        end
+      end
+
+      raw_messages = {
+        475 => :locked,
+        471 => :full,
+        474 => :banned,
+        473 => :invite_only
+      }
+
+      raw_messages.each do |raw, msg|
+        callbacks << @bot.on(raw) do |env|
+          channel_name = env[:params].split(' ')[1]
+
+          if channel_name == @name
+            condition.signal msg
+            callbacks.each { |cb| cb.remove_and_terminate }
+          end
+        end
+      end
+
+      after(5) do
+        condition.signal :timeout
+        callbacks.each { |cb| cb.remove_and_terminate }
+      end
+
       if key
         @bot.raw "JOIN #{@name} #{key}"
       else
         @bot.raw "JOIN #{@name}"
       end
+
+      Future.new { condition.wait }
     end
 
     def part(message = nil)

data/lib/vetinari/irc.rb

@@ -7,7 +7,41 @@ module Vetinari
     end
 
     def rename(nick)
+      if nick.length > @config.isupport['NICKLEN']
+        nick = nick.slice(0, @config.isupport['NICKLEN'])
+      end
+
+      return Celluloid::Future.new { nick } if @user.nick == nick
+
+      condition = Celluloid::Condition.new
+      callbacks = Set.new
+
+      callbacks << on(:nick_change) do |env|
+        if env[:user].bot?
+          condition.signal env[:user].nick
+          callbacks.each { |cb| cb.remove_and_terminate }
+        end
+      end
+
+      raw_messages = {
+        432 => :erroneous_nickname,
+        433 => :nickname_in_use
+      }
+
+      raw_messages.each do |raw, msg|
+        callbacks << on(raw) do |env|
+          condition.signal(msg)
+          callbacks.each { |cb| cb.remove_and_terminate }
+        end
+      end
+
+      after(5) do
+        condition.signal(:timeout)
+        callbacks.each { |cb| cb.remove_and_terminate }
+      end
+
       raw "NICK :#{nick}"
+      Celluloid::Future.new { condition.wait }
     end
 
     def away(message = nil)
@@ -33,9 +67,19 @@ module Vetinari
     end
 
     def join(channel_name, key = nil)
-      unless @channels.has_channel?(channel_name)
-        channel = Channel.new(channel_name, @actor)
-        channel.join key
+      channel = Channel.new(channel_name, @actor)
+      channel.join(key)
+    end
+
+    def message(receiver, message)
+      channel = @config.isupport['CHANTYPES'].any? do |chantype|
+        receiver.start_with?(chantype)
+      end
+
+      if channel
+        Channel.new(receiver, @actor).message(message)
+      else
+        User.new(receiver, @actor).message(message)
       end
     end
   end

data/lib/vetinari/version.rb

@@ -1,3 +1,3 @@
 module Vetinari
-  VERSION = Gem::Version.new('0.1.0')
+  VERSION = Gem::Version.new('0.2.0')
 end

data/spec/callback_spec.rb

@@ -16,4 +16,13 @@ describe 'Callback' do
     cb.remove
     expect(callbacks[:channel]).to have(1).callback
   end
+
+  it 'can be removed and terminated' do
+    cb = subject.on(:channel)
+    expect(callbacks[:channel]).to have(2).callback
+    expect(cb.alive?).to be_true
+    cb.remove_and_terminate
+    expect(callbacks[:channel]).to have(1).callback
+    expect(cb.alive?).to be_false
+  end
 end

data/spec/join_spec.rb

@@ -0,0 +1,75 @@
+require 'spec_helper'
+
+describe 'Bot#join' do
+  subject { Vetinari::Bot.new { |c| c.verbose = false } }
+
+  before(:each) do
+    subject.parse(':server 001 Vetinari :Welcome message')
+    subject.parse(':server 376 Vetinari :End of /MOTD command.')
+  end
+
+  it 'returns a Future' do
+    expect(subject.join('#mended_drum')).to be_a(Celluloid::Future)
+  end
+
+  it 'returns :joined if joined' do
+    future = subject.join('#mended_drum')
+
+    Thread.new do
+      subject.parse(':Vetinari!foo@bar JOIN #mended_drum')
+    end
+
+    expect(future.value).to be(:joined)
+  end
+
+  it 'returns :already_joined if already in the channel' do
+    subject.parse(':Vetinari!foo@bar JOIN #mended_drum')
+    future = subject.join('#mended_drum')
+    expect(future.value).to be(:already_joined)
+  end
+
+  it 'returns :locked if channel is locked' do
+    future = subject.join('#mended_drum')
+
+    Thread.new do
+      subject.parse(':server 475 Vetinari #mended_drum :Cannot join channel (+k) - bad key')
+    end
+    
+    expect(future.value).to be(:locked)
+  end
+
+  it 'returns :full if channel is full' do
+    future = subject.join('#mended_drum')
+
+    Thread.new do
+      subject.parse(':server 471 Vetinari #mended_drum :Cannot join channel (+l) - channel is full, try again later')
+    end
+    
+    expect(future.value).to be(:full)
+  end
+
+  it 'returns :banned if the bot is banned from the channel' do
+    future = subject.join('#mended_drum')
+
+    Thread.new do
+      subject.parse(':server 474 Vetinari #mended_drum :Cannot join channel (+b) - you are banned')
+    end
+    
+    expect(future.value).to be(:banned)
+  end
+
+  it 'returns :banned if the bot is banned from the channel' do
+    future = subject.join('#mended_drum')
+
+    Thread.new do
+      subject.parse(':server 473 Vetinari #mended_drum :Cannot join channel (+i) - you must be invited')
+    end
+    
+    expect(future.value).to be(:invite_only)
+  end
+
+  it 'returns :timeout if no answer comes from the server' do
+    future = subject.join('#mended_drum')
+    expect(future.value).to be(:timeout)
+  end
+end

data/spec/rename_spec.rb

@@ -0,0 +1,60 @@
+require 'spec_helper'
+
+describe 'Bot#rename' do
+  subject { Vetinari::Bot.new { |c| c.verbose = false } }
+
+  before(:each) do
+    subject.parse(':server 001 Vetinari :Welcome message')
+    subject.parse(':server 376 Vetinari :End of /MOTD command.')
+    subject.parse(':server 005 Vetinari NICKLEN=10')
+  end
+
+  it 'returns a Future' do
+    expect(subject.rename('Havelock')).to be_a(Celluloid::Future)
+  end
+
+  it 'returns the current nickname if no changes would happen' do
+    future = subject.rename('Vetinari')
+    expect(future.value).to be_a(String)
+    expect(future.value).to eq('Vetinari')
+  end
+
+  it 'returns String if renamed' do
+    future = subject.rename('Havelock')
+
+    Thread.new do
+      subject.parse(':Vetinari!foo@bar NICK :Havelock')
+    end
+
+    expect(future.value).to be_a(String)
+    expect(future.value).to eq('Havelock')
+  end
+
+  it 'returns :erroneous_nickname if nickname is erroneous' do
+    future = subject.rename('NickServ')
+
+    Thread.new do
+      subject.parse(':server 432 Vetinari NickServ :Erroneous Nickname')
+    end
+
+    expect(future.value).to be_a(Symbol)
+    expect(future.value).to eq(:erroneous_nickname)
+  end
+
+it 'returns :nickname_in_use if nickname is taken' do
+    future = subject.rename('TheLibrarian')
+
+    Thread.new do
+      subject.parse(':server 433 Vetinari TheLibrarian :Nickname is already in use.')
+    end
+
+    expect(future.value).to be_a(Symbol)
+    expect(future.value).to eq(:nickname_in_use)
+  end
+
+  it 'slices the nick if it is too long' do
+    bare = subject.bare_object
+    expect(bare).to receive(:raw).with('NICK :1234567890').once
+    subject.rename('1234567890over')
+  end
+end

data/vetinari.gemspec

@@ -26,5 +26,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 1.3'
   spec.add_development_dependency 'pry', '~> 0.9'
   spec.add_development_dependency 'rake', '~> 10.0'
-  spec.add_development_dependency 'rspec', '~> 2.13'
+  spec.add_development_dependency 'rspec', '2.14.0.rc1'
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: vetinari
 version: !ruby/object:Gem::Version
-  version: 0.1.0
+  version: 0.2.0
 platform: ruby
 authors:
 - Tobias Bühlmann
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-05-14 00:00:00.000000000 Z
+date: 2013-05-30 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: celluloid-io
@@ -70,16 +70,16 @@ dependencies:
   name: rspec
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: 2.14.0.rc1
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ~>
+    - - '='
       - !ruby/object:Gem::Version
-        version: '2.13'
+        version: 2.14.0.rc1
 description: |2
       Vetinari is a multithreaded IRC Bot Framework using the Celluloid::IO
       library.
@@ -119,6 +119,8 @@ files:
 - spec/channel_spec.rb
 - spec/default_callbacks_spec.rb
 - spec/isupport_spec.rb
+- spec/join_spec.rb
+- spec/rename_spec.rb
 - spec/spec_helper.rb
 - spec/user_management_spec.rb
 - spec/user_spec.rb
@@ -153,6 +155,8 @@ test_files:
 - spec/channel_spec.rb
 - spec/default_callbacks_spec.rb
 - spec/isupport_spec.rb
+- spec/join_spec.rb
+- spec/rename_spec.rb
 - spec/spec_helper.rb
 - spec/user_management_spec.rb
 - spec/user_spec.rb