dragoon 0.0.7 → 0.0.8

data/README.md

@@ -1,8 +1,9 @@
 Dragoon
 ============
 
-An IRC bot that alerts you whenever certain keywords pop up in your favorite channels. You can listen to multiple channels but right now, you can only connect to one network at a time. And I've only tested it on freenode.net. Support for multiple networks will be done soon.
+An IRC bot that alerts you whenever certain keywords pop up in your favorite channels. Notifications are displayed via growl if supported or text highlights on the terminal.
 
+Listening to multiple network connections is supported via IO.select()
 
 Dependencies
 -----------

data/TODO

@@ -6,7 +6,7 @@ TODO
 - [x]    channels: #ubuntu, #ruby, #ffmpeg
 - [x]    keywords: and, how, why, help
 - [x]  connect to network
-- [ ]    - multiple networks
+- [x]    - multiple networks
 - [x]  login
 - [x]  join channels
 - [x]    - normal channels

data/dragoon.gemspec

@@ -19,6 +19,8 @@ Gem::Specification.new do |s|
   s.require_paths = ["lib"]
 
   s.add_development_dependency "rspec"
+  s.add_development_dependency "pry"
   s.add_dependency "term-ansicolor"
   s.add_dependency "json"
+  s.add_dependency "active_support"
 end

data/lib/dragoon.rb

@@ -4,25 +4,26 @@ require 'forwardable'
 
 require 'term/ansicolor'
 require 'json'
+require 'active_support/core_ext/hash/indifferent_access'
 
-require 'dragoon/commands'
 require 'dragoon/event'
+require 'dragoon/network'
 require 'dragoon/event_manager'
 require 'dragoon/color'
 require 'dragoon/core_ext'
 
+$verbose = true
 
 module Dragoon
   class Bot
     extend Forwardable
-
-    include Commands
     include Color
 
-    attr_accessor :nickname, :network, :channels, :keywords
+    attr_accessor :nickname, :networks, :keywords
 
     def_delegators :@event_manager, :on, :dispatch
 
+    SAMPLE_CONFIG = File.expand_path("#{File.dirname(__FILE__)}/../sample_config")
     CONFIG_FILE = File.expand_path("~/.dragoon")
 
     def initialize
@@ -34,41 +35,18 @@ module Dragoon
     def load_config
       begin
         if File.exist?(CONFIG_FILE)
-          puts("*** Loading config file #{CONFIG_FILE}")
-          config = JSON.parse(File.read(CONFIG_FILE))
-          @network  = config["network"]
-          @port     = config["port"]
-          @nickname = config["nickname"]
-          @password = config["password"]
-          @channels = config["channels"]
-          @keywords = config["keywords"]
+          log("*** Loading config file #{CONFIG_FILE}")
+          config = HashWithIndifferentAccess.new JSON.parse(File.read(CONFIG_FILE))
+          @nickname = config[:nickname]
+          @password = config[:password]
+          @hostname = config[:hostname]
+          @servername = config[:servername]
+          @networks = config[:networks].map { |n| Network.new(n) }
+          @keywords = config[:keywords]
         else
-
-          config = (<<-EOF).gsub(/^\s{10}/,"")
-          {
-            "network": "chat.freenode.net",
-            "port": "6667",
-            "nickname": "fenix#{rand(10)}#{rand(10)}#{rand(10)}",
-            "password": "",
-            "channels": [
-                "#ubuntu",
-                "#ruby",
-                "#rubyonrails",
-                "#linux",
-                "#programming",
-                "#javascript"
-              ],
-            "keywords": [
-                  "and",
-                  "how",
-                  "who"
-                ]
-          }
-          EOF
-
-          File.open(CONFIG_FILE,'w+') {|f| f.write(config) }
-          puts("Config file does not exist...created a default one at #{CONFIG_FILE}".red)
-          puts("Please modify it according to your preference".red)
+          File.open(CONFIG_FILE,'w+') {|f| f.write(File.read(SAMPLE_CONFIG)) }
+          log("Config file does not exist...created a default one at #{CONFIG_FILE}".red)
+          log("Please modify it according to your preference".red)
           exit 1
         end
       rescue => e
@@ -78,40 +56,49 @@ module Dragoon
     end
 
     def init_callbacks
-      on :startup do |msg|
-        puts msg.text
+      on :startup do |msg, source|
+        log msg.text
         if msg.text =~ /.*Found your hostname.*/
           # login
-          pass(@password) if !@password.empty?
-          user(@nickname, 0, 0, @nickname)
-          nick(@nickname)
+          source.socket.write "PASS #{@password}\r\n" if !@password.empty?
+          source.socket.write "USER #{@nickname} #{@hostname} #{@servername} #{@nickname}\r\n"
+          source.socket.write "NICK #{@nickname}\r\n"
         end
       end
 
-      on :ping do |msg|
-        pong(msg.server) # keep alive
+      on :ping do |msg, source|
+        source.socket.write "PONG #{msg.server}\r\n" # keep alive
       end
 
-      on :mode do |msg|
-        puts "*** Logged in as #{msg.nickname}"
-        join_channels
+      on :welcome do |msg, source|
+        log "*** Logged in on #{source.name} as #{msg.nickname}"
+
+        source.channels.each do |channel|
+          source.socket.write "JOIN #{channel}\r\n"
+        end
       end
 
-      on :join do |msg|
-        puts "*** Listening on channel #{colorize(msg.channel)}" if @nickname == msg.nickname
+      on :join do |msg, source|
+        log "*** Listening on channel #{colorize(msg.channel)}" if @nickname == msg.nickname
       end
 
-      on :err do |msg|
-        $stderr.puts msg.text.red unless msg.error_code == '470' # channel forwarding
+      on :err do |msg, source|
+        unless ['470', '422'].include?(msg.error_code) # ignore channel forwarding + motd file missing
+          $stderr.puts msg.text.red
+        end
+
         if msg.error_code == '433' # nick already in use
           print("Enter another nickname: ")
           @nickname = gets.chomp
-          user(@nickname, 0, 0, @nickname)
-          nick(@nickname)
+          print("Enter password (optional): ")
+          @password = gets.chomp
+          source.socket.write "PASS #{@password}\r\n" if !@password.empty?
+          source.socket.write "USER #{@nickname} #{@hostname} #{@servername} #{@nickname}\r\n"
+          source.socket.write "NICK #{@nickname}\r\n"
         end
       end
 
-      on :privmsg do |msg|
+      on :privmsg do |msg, source|
         if growlnotify_supported?
           if keyword = @keywords.detect { |keyword| msg.text.include?(keyword) }
             system("growlnotify " +
@@ -119,42 +106,63 @@ module Dragoon
                    "-m \"#{msg.privmsg.escape_double_quotes}\"")
           end
         end
-        puts "#{colorize(msg.channel)}  <#{msg.nickname}>  #{highlight_keywords(msg.privmsg,@keywords)}"
+        log "#{colorize(msg.channel)}  <#{msg.nickname}>  #{highlight_keywords(msg.privmsg,@keywords)}"
       end
     end
 
     def run
-      @socket = connect
+      log "*** Press Ctrl + c to stop the program"
+      sockets = []
+      @networks.each do |network|
+        socket = connect(network)
+        network.server = socket.peeraddr[2]
+        network.socket = socket
+        sockets << socket
+      end
 
       begin
-        while line = @socket.gets
-          @event = Event.parse(line)
-          dispatch(@event)
-        end
+        while true; listen(sockets); end
       rescue Interrupt
         stop
       end
+    end
 
+    # should pass an array of sockets
+    def listen(sockets)
+      read_fds, write_fds, error_fds = IO.select(sockets, nil, nil, nil)
+      read_fds.each do |socket|
+        line = socket.gets
+        @event = Event.parse(line)
+        dispatch(@event,
+          @networks.select{ |n|
+            n.server == socket.peeraddr[2] &&
+            n.port = socket.peeraddr[1]
+          }.first
+        )
+      end
     end
 
-    def connect
-      puts "*** Connecting to #{@network} on port #{@port}"
-      puts "*** Press Ctrl + c to stop the program"
-      TCPSocket.new(@network, @port)
-    rescue Errno::EADDRNOTAVAIL => e
-      puts "#{e.class} Cannot connect to #{@network} at port #{@port}".red
-      exit
+    def connect(network)
+      log "*** Connecting to #{network.name} on port #{network.port}"
+      TCPSocket.new(network.name, network.port)
+    rescue => e
+      log "#{e.class} Cannot connect to #{network.name} at port #{network.port}".red
+      raise
     end
 
     def stop
       puts
-      puts "*** Program stopped"
-      @socket.close
+      log "*** Program stopped"
+      @networks.each { |network| network.socket.close }
       exit
     end
 
     private
 
+      def log(text)
+        puts text if $verbose
+      end
+
       def growlnotify_supported?
         @growlnotify_supported ||= system("which growlnotify > /dev/null")
       end

data/lib/dragoon/event.rb

@@ -13,12 +13,12 @@ module Dragoon
 
     def self.parse(line)
       case line
-      when /^:\S+ NOTICE \* :\*{3} .*/
+      when /^:\S+ NOTICE .*:\*{3} .*/
         self.new(:startup, Message.new(:text => line))
       when /^PING :(\S+)/
         self.new(:ping, Message.new(:text => line, :server => $1))
-      when /^:(\S+) MODE \S+ :.*/
-        self.new(:mode, Message.new(:text => line, :nickname => $1))
+      when /^:\S+ 001 (\S+) :.*/
+        self.new(:welcome, Message.new(:text => line, :nickname => $1))
       when /^:(\S+)!(\S+)@(\S+) JOIN (\S+)/
         self.new(:join, Message.new(:text => line,
                                     :nickname => $1,

data/lib/dragoon/event_manager.rb

@@ -5,9 +5,9 @@ module Dragoon
 
     attr_reader :handlers
 
-    def dispatch(event)
+    def dispatch(event, source)
       if @handlers.include?(event.name)
-        @handlers[event.name].call(event.message)
+        @handlers[event.name].call(event.message, source)
       end
     end
 

data/lib/dragoon/network.rb

@@ -0,0 +1,14 @@
+module Dragoon
+  class Network
+    attr_accessor :name, :port, :server, :socket, :channels
+
+    def initialize(options={})
+      @name = options[:name]
+      @port = options[:port]
+      @server = options[:server]
+      @socket = options[:socket]
+      @channels = options[:channels]
+    end
+
+  end
+end

data/lib/dragoon/version.rb

@@ -1,3 +1,3 @@
 module Dragoon
-  VERSION = "0.0.7"
+  VERSION = "0.0.8"
 end

data/sample_config

@@ -0,0 +1,32 @@
+{
+  "nickname": "fenix457",
+  "password": "",
+  "hostname": "some_host",
+  "servername": "some_server",
+  "keywords": [
+    "and",
+    "how",
+    "who"
+  ],
+  "networks": [
+    {
+      "name": "irc.freenode.net",
+      "port": 6667,
+      "channels": [
+        "#ubuntu",
+        "#ruby",
+        "#rubyonrails",
+        "#linux",
+        "#programming",
+        "#javascript"
+      ]
+    },
+    {
+      "name": "irc.quartznet.org",
+      "port": 6667,
+      "channels": [
+        "#PlayGames"
+      ]
+    }
+  ]
+}

data/spec/dragoon_spec.rb

@@ -0,0 +1,72 @@
+require 'spec_helper'
+
+describe Dragoon::Bot do
+  before(:all) do
+    @local_servers = []
+    [7777, 7778].each { |port| @local_servers << LocalServer.new(port).run }
+  end
+
+  after(:all) do
+    @local_servers.each { |server| server.stop}
+  end
+
+  before(:each) do
+    @client = Dragoon::Bot.new
+  end
+
+  describe "#connect" do
+    context "network parameters are wrong" do
+      before(:each) do
+        @network = Dragoon::Network.new(:name => 'localhost', :port => 6665, :channels => %w[ #ruby #java])
+      end
+
+      it "should raise error" do
+        lambda {
+          socket = @client.connect(@network)
+        }.should raise_error
+      end
+    end
+
+    context "network parameters are correct" do
+      before(:each) do
+        @network = Dragoon::Network.new(:name => 'localhost', :port => 7777, :channels => %w[ #ruby #java])
+      end
+
+      it "should return the correct TCP Socket" do
+        socket = @client.connect(@network)
+        socket.class.should == TCPSocket
+        socket.peeraddr[1].should == 7777
+        socket.peeraddr[2].should == 'localhost'
+      end
+    end
+  end
+
+  describe "#listen" do
+    context "listening to only 1 network" do
+      before(:each) do
+        @network = Dragoon::Network.new(:name => 'localhost', :port => 7777, :channels => %w[ #ruby #java])
+        @socket = @client.connect(@network)
+      end
+
+      it "should receive data from that network" do
+        @socket.should_receive(:gets)
+        @client.listen([@socket])
+      end
+    end
+
+    context "listening to more than 1 networks" do
+      before(:each) do
+        @networks = []
+        @networks << Dragoon::Network.new(:name => 'localhost', :port => 7777, :channels => %w[ #ruby #java])
+        @networks << Dragoon::Network.new(:name => 'localhost', :port => 7778, :channels => %w[ #ps3 #wii])
+        @sockets = @networks.map { |network| @client.connect(network) }
+      end
+
+      it "should receive data from all networks" do
+        @sockets.each { |socket| socket.should_receive(:gets).at_least(:once) }
+        40.times { @client.listen(@sockets) }
+      end
+    end
+  end
+
+end

data/spec/event_manager_spec.rb

@@ -7,40 +7,33 @@ describe Dragoon::EventManager do
   end
 
   describe "#dispatch" do
-    context "event is unknown" do
-      it "should not do anything" do
-        pending "help from other people"
-        #@event_manager.dispatch(:unknown, ":adams.freenode.net 372 felix21 :- portrayed in his uniquely British irony. He is sorely missed")
-      end
-    end
-
-    context "no handler for an event" do
-      it "should not do anything" do
-        pending "help from other people"
-        #@event_manager.dispatch(:mode, ":felix21 MODE felix21 :+i")
-      end
-    end
-
     context "callback exists for an event" do
       before(:each) do
-        @callback = lambda { puts "hello world" }
+        @callback = lambda { |event, source| puts "hello world" }
         @event = Dragoon::Event.parse(":felix21 MODE felix21 :+i")
+        @network = Dragoon::Network.new
         @event_manager.on @event.name, &@callback
       end
 
       it "should run the corresponding callback" do
         @callback.should_receive(:call)
-        @event_manager.dispatch(@event)
+        @event_manager.dispatch(@event, @network)
+      end
+
+      it "should have message object and network source as parameters to the callback" do
+        @callback.should_receive(:call).with(@event.message, @network)
+        @event_manager.dispatch(@event, @network)
       end
     end
   end
 
   describe "#on" do
     it "should register that event" do
-      callback = lambda { puts "this is a callback" }
+      callback = lambda { |event, source| puts "this is a callback" }
       @event_manager.on(:mode, &callback)
       @event_manager.handlers[:mode].should == callback
     end
+
   end
 
 end

data/spec/event_spec.rb

@@ -5,9 +5,13 @@ describe Dragoon::Event do
   describe "#get_event" do
     it "should process startup event" do
       msg = ":zelazny.freenode.net NOTICE * :*** Found your hostname"
+      msg2 = ":luca002.QuartzNet.Org NOTICE AUTH :*** Found your hostname"
       event = Dragoon::Event.parse(msg)
       event.name.should == :startup
       event.message.text.should == msg
+      event = Dragoon::Event.parse(msg2)
+      event.name.should == :startup
+      event.message.text.should == msg2
     end
 
     it "should process ping event" do
@@ -18,12 +22,12 @@ describe Dragoon::Event do
       event.message.server.should == "zelazny.freenode.net"
     end
 
-    it "should process mode event" do
-      msg = ":favor212 MODE favor212 :+i"
+    it "should process welcome event" do
+      msg = ":luca002.QuartzNet.Org 001 fenix456 :Welcome to the QuartzNet IRC Network fenix456!~fenix456@some_host"
       event = Dragoon::Event.parse(msg)
-      event.name.should == :mode
+      event.name.should == :welcome
       event.message.text.should == msg
-      event.message.nickname.should == "favor212"
+      event.message.nickname.should == "fenix456"
     end
 
     it "should process join event" do

data/spec/spec_helper.rb

@@ -1,4 +1,37 @@
 $LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}/../lib")
 
 require 'dragoon'
+require 'pry'
 
+$verbose = false
+
+# A localserver that will run in the background for test suites' bots to establish tcp connection to
+# It handles multiple connections by further forking child processes as needed
+# NOTE: Make sure you call #stop for all servers at the end of the test suite
+
+class LocalServer
+  attr_reader :pid
+
+  def initialize(port)
+    @port = port
+  end
+
+  def run
+    server = TCPServer.new('localhost', @port)
+    server.listen(5)
+    @pid = fork {
+      while socket = server.accept
+        fork {
+          trap("PIPE") { exit }
+          loop { socket.write("localhost port #{socket.addr[1]} dumping text\r\n") }
+        }
+      end
+    }
+    self
+  end
+
+  def stop
+    `kill -9 #{@pid}`
+  end
+
+end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dragoon
 version: !ruby/object:Gem::Version 
-  hash: 17
+  hash: 15
   prerelease: 
   segments: 
   - 0
   - 0
-  - 7
-  version: 0.0.7
+  - 8
+  version: 0.0.8
 platform: ruby
 authors: 
 - Reginald Tan
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-02-08 00:00:00 Z
+date: 2012-02-12 00:00:00 Z
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
@@ -32,7 +32,7 @@ dependencies:
   type: :development
   version_requirements: *id001
 - !ruby/object:Gem::Dependency 
-  name: term-ansicolor
+  name: pry
   prerelease: false
   requirement: &id002 !ruby/object:Gem::Requirement 
     none: false
@@ -43,10 +43,10 @@ dependencies:
         segments: 
         - 0
         version: "0"
-  type: :runtime
+  type: :development
   version_requirements: *id002
 - !ruby/object:Gem::Dependency 
-  name: json
+  name: term-ansicolor
   prerelease: false
   requirement: &id003 !ruby/object:Gem::Requirement 
     none: false
@@ -59,6 +59,34 @@ dependencies:
         version: "0"
   type: :runtime
   version_requirements: *id003
+- !ruby/object:Gem::Dependency 
+  name: json
+  prerelease: false
+  requirement: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id004
+- !ruby/object:Gem::Dependency 
+  name: active_support
+  prerelease: false
+  requirement: &id005 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id005
 description: "An IRC bot that alerts you whenever certain keywords appear in your favorite channels "
 email: 
 - redge.tan@gmail.com
@@ -79,12 +107,14 @@ files:
 - dragoon.gemspec
 - lib/dragoon.rb
 - lib/dragoon/color.rb
-- lib/dragoon/commands.rb
 - lib/dragoon/core_ext.rb
 - lib/dragoon/event.rb
 - lib/dragoon/event_manager.rb
+- lib/dragoon/network.rb
 - lib/dragoon/version.rb
+- sample_config
 - spec/colors_spec.rb
+- spec/dragoon_spec.rb
 - spec/event_manager_spec.rb
 - spec/event_spec.rb
 - spec/spec_helper.rb
@@ -123,6 +153,7 @@ specification_version: 3
 summary: IRC bot for keyword notification
 test_files: 
 - spec/colors_spec.rb
+- spec/dragoon_spec.rb
 - spec/event_manager_spec.rb
 - spec/event_spec.rb
 - spec/spec_helper.rb

data/lib/dragoon/commands.rb

@@ -1,35 +0,0 @@
-module Dragoon
-  module Commands
-
-    def nick(nickname)
-      write "NICK #{nickname}"
-    end
-
-    def user(username, hostname, servername, realname)
-      write "USER #{username} #{hostname} #{servername} #{realname}"
-    end
-
-    def pass(password)
-      write "PASS #{password}"
-    end
-
-    def pong(server)
-      write "PONG #{server}"
-    end
-
-    def join(channel)
-      write "JOIN #{channel}"
-    end
-
-    def join_channels
-      @channels.each { |channel| join(channel) }
-    end
-
-    private
-
-      def write(text)
-        @socket.write "#{text}\r\n"
-      end
-
-  end
-end