dragoon 0.0.1

data/.gitignore

@@ -0,0 +1,6 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+tags
+gem_link

data/Gemfile

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

data/README.md

@@ -0,0 +1,27 @@
+Dragoon
+============
+
+An IRC bot that notifies you of keyword occurences in your favorite chatrooms. You can listen to multiple channels but right now, i've only tested it on freenode.net. Support for multiple networks will be done soon.
+
+
+Dependencies
+-----------
+
+- growl
+- growlnotify
+
+P.S. You can still run the program even without growl, you'll only see the keywords being highlighted and there won't be any growl notificaiton, that's all.
+
+Usage
+-----
+
+1. `git clone git://github.com/redgetan/dragoon.git`
+2. Create a configuration file under config/ directory and name it "config.yml". See "config.yml.example" for reference.
+3. If you have growl support, make sure it's turned on
+4. To start the program, type `./bin/dragoon`
+
+P.S. will gemify this soon so you only have to do 'gem install dragoon', then 'dragoon'
+
+Screenshot
+---------
+http://farm8.staticflickr.com/7027/6733543233_6f354d61d0_b.jpg

data/Rakefile

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

data/TODO

@@ -0,0 +1,48 @@
+TODO
+----------
+- [x]  config.yml.example
+- [x]    network: irc.freenode.net
+- [x]    channels: #ubuntu, #ruby, #ffmpeg
+- [x]    keywords: and, how, why, help
+- [x]  connect to network
+- [ ]    - multiple networks
+- [x]  login
+- [x]  join channels
+- [x]  Event Parsing
+- [x]  during msg events (PRIVMSG)
+- [x]    - parse message
+- [x]    - highligh keywords
+- [x]    -   feature
+- [ ]    -     add ignore case
+- [x]    -   tests
+- [x]    - colorize channel
+- [x]    -   feature
+- [x]    -   tests
+- [ ]  channel view
+- [ ]    - enter a command (i.e view #ubuntu)
+- [ ]      - shows only messages belonging to a specific channel
+- [ ]  command line options
+- [ ]    - help
+- [ ]    - verbose mode (list all msgs sent to me msgs that i send to server)
+
+
+Problems encountered
+--------------
+Cannot join certain channels
+ - :calvino.freenode.net 477 pacman23 ##java :Cannot join channel (+r) - you need to be identified with services
+
+Helpful links
+-------------
+ - http://www.irchelp.org/irchelp/rfc/
+ - http://www.irchelp.org/irchelp/misc/ccosmos.html (Advanced IRC Guide)
+ - http://www.irchelp.org/irchelp/text/rfc1459.txt
+ - http://www.devarticles.com/c/a/Delphi-Kylix/Building-an-IRC-Client/
+ - http://www.jibble.org/pircbot.php
+ - http://www.scribd.com/doc/28253878/EventMachine-scalable-non-blocking-i-o-in-ruby
+ - http://www.paperplanes.de/2011/4/25/eventmachine-how-does-it-work.html (EM vs lower level socket prog, ie select, poll)
+ - http://cia.vc/doc/
+
+Existing IRC clients/bots to get ideas from
+-------------------------------------------
+ - https://github.com/cinchrb/cinch
+ - https://github.com/RISCFuture/autumn

data/bin/dragoon

@@ -0,0 +1,10 @@
+#!/usr/bin/env ruby
+
+$LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}/../lib")
+
+require 'dragoon'
+
+client = Dragoon::Bot.new
+client.run
+
+

data/config/config.yml

@@ -0,0 +1,4 @@
+nickname:  fenix45
+networks:  [ irc.freenode.net ]
+channels:  [ '#ubuntu', '#ruby', '#rubyonrails', '#linux', '#javascript', '#programming' ]
+keywords:  [ why, how, who, and ]

data/config/config.yml.example

@@ -0,0 +1,4 @@
+nickname:  fenix45
+networks:  [ irc.freenode.net ]
+channels:  [ '#ubuntu', '#ruby', '#rubyonrails', '#linux', '#javascript', '#programming' ]
+keywords:  [ why, how, who, and ]

data/dragoon.gemspec

@@ -0,0 +1,23 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "dragoon/version"
+
+Gem::Specification.new do |s|
+  s.name        = "dragoon"
+  s.version     = Dragoon::VERSION
+  s.authors     = ["Reginald Tan"]
+  s.email       = ["redge.tan@gmail.com"]
+  s.homepage    = "https://github.com/redgetan/dragoon"
+  s.summary     = %q{IRC bot for keyword notification }
+  s.description = %q{An IRC bot that alerts you whenever certain keywords appear in your favorite channels }
+
+  s.rubyforge_project = "dragoon"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_development_dependency "rspec"
+  s.add_runtime_dependency "term/ansicolor"
+end

data/lib/dragoon.rb

@@ -0,0 +1,106 @@
+require 'socket'
+require 'ostruct'
+require 'forwardable'
+require 'yaml'
+
+require 'term/ansicolor'
+
+require 'dragoon/commands'
+require 'dragoon/event'
+require 'dragoon/event_manager'
+require 'dragoon/color'
+require 'dragoon/core_ext'
+
+
+module Dragoon
+  class Bot
+    extend Forwardable
+
+    include Commands
+    include Color
+
+    attr_accessor :nickname, :networks, :channels, :keywords
+
+    def_delegators :@event_manager, :on, :dispatch
+
+    DEFAULT_PORT = 6667
+
+    def initialize(&blk)
+      @event_manager = EventManager.new
+      load_config
+      init_callbacks
+    end
+
+    def load_config
+      begin
+        config = YAML.load_file(File.expand_path(File.join(File.dirname(__FILE__), "./../config/config.yml")))
+      rescue => e
+        $stderr.puts e.message
+        exit 1
+      end
+      @nickname = config["nickname"]
+      @networks = config["networks"]
+      @channels = config["channels"]
+      @keywords = config["keywords"]
+    end
+
+    def init_callbacks
+      on :startup do |msg|
+        puts msg.text
+        if msg.text =~ /.*Found your hostname.*/
+          # login
+          user(self.nickname)
+          nick(self.nickname)
+        end
+      end
+
+      on :ping do |msg|
+        pong(msg.server) # keep alive
+      end
+
+      on :mode do |msg|
+        puts "*** Logged in as #{@nickname}"
+        join_channels
+      end
+
+      on :join do |msg|
+        puts "*** Listening on channel #{colorize(msg.channel)}" if self.nickname == msg.nickname
+      end
+
+      on :err do |msg|
+        puts "err: #{msg.text}" unless msg.error_code == '470' # channel forwarding
+      end
+
+      on :privmsg do |msg|
+        if system("which growlnotify > /dev/null")
+          if keyword = self.keywords.detect { |keyword| msg.text.include?(keyword) }
+            system("growlnotify " +
+                   "-t \"#{keyword}\" " +
+                   "-m \"#{escape_double_quotes(msg.privmsg)}\"")
+          end
+        end
+        puts "#{colorize(msg.channel)}  <#{msg.nickname}>  #{highlight_keywords(msg.privmsg,self.keywords)}"
+      end
+    end
+
+    def run
+      @socket = connect
+      while line = @socket.gets
+        @event = Event.parse(line)
+        dispatch(@event)
+      end
+    end
+
+    def connect
+      puts "*** Connecting to #{@networks.first} on port #{DEFAULT_PORT}"
+      TCPSocket.new(@networks.first, DEFAULT_PORT)
+    end
+
+    def escape_double_quotes(text)
+      text.gsub("\"", "\\\"")
+    end
+
+  end
+end
+
+#http://www.nightmare.com/medusa/async_sockets.html

data/lib/dragoon/color.rb

@@ -0,0 +1,38 @@
+module Dragoon
+  module Color
+
+    # borrowed from Term::ANSIColors
+    COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/
+    # :yellow is reserved for highlight keywords
+    @@color_list = [:red, :green, :blue, :magenta, :cyan, :white]
+
+    def colorize(text)
+      @c_table ||= {}
+      color = @c_table.fetch(text) rescue @c_table[text] = next_color
+      text.send color
+    end
+
+    def next_color
+      @@color_list.push(@@color_list.shift).first
+    end
+
+    def highlight_keywords(text,keywords)
+      keywords.sort_by(&:length).reverse.inject(text) do |result, keyword|
+        result.gsub(keyword) { |word|
+          to_left_of_word, to_right_of_word = $`, $'
+
+          # check if inside exisitng highlighted word via ANSI ESCAPE
+          if to_left_of_word =~ /#{COLORED_REGEXP}\S+$/ && to_right_of_word =~ /^\S+#{COLORED_REGEXP}/
+            word
+          else
+            highlight(word)
+          end
+        }
+      end
+    end
+
+    def highlight(word)
+      word.black.on_yellow
+    end
+  end
+end

data/lib/dragoon/commands.rb

@@ -0,0 +1,31 @@
+module Dragoon
+  module Commands
+
+    def nick(text)
+      write "NICK #{text}"
+    end
+
+    def user(text)
+      write "USER #{text} #{text} #{text} #{text}"
+    end
+
+    def pong(text)
+      write "PONG #{text}"
+    end
+
+    def join(text)
+      write "JOIN #{text}"
+    end
+
+    def join_channels
+      @channels.each { |channel| join(channel) }
+    end
+
+    private
+
+      def write(text)
+        @socket.write "#{text}\r\n"
+      end
+
+  end
+end

data/lib/dragoon/core_ext.rb

@@ -0,0 +1,3 @@
+class String
+  include Term::ANSIColor
+end

data/lib/dragoon/event.rb

@@ -0,0 +1,43 @@
+module Dragoon
+  class Event
+
+    class Message < OpenStruct
+    end
+
+    attr_reader :name, :message
+
+    def initialize(name, message)
+      @name = name
+      @message = message
+    end
+
+    def self.parse(line)
+      case line
+      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))
+      when /^:(\S+)!(\S+)@(\S+) JOIN (\S+)/
+        self.new(:join, Message.new(:text => line,
+                                    :nickname => $1,
+                                    :user => $2,
+                                    :hostname => $3,
+                                    :channel => $4))
+      when /^:(\S+)!(\S+)@(\S+) PRIVMSG (\S+) :(.+)/
+        self.new(:privmsg, Message.new(:text => line,
+                                       :nickname => $1,
+                                       :user => $2,
+                                       :hostname => $3,
+                                       :channel => $4,
+                                       :privmsg => $5))
+      when /^:\S+ (4\d{2}|5\d{2}) .*/
+        self.new(:err, Message.new(:text => line, :error_code => $1))
+      else
+        self.new(:unknown, Message.new(:text => line))
+      end
+    end
+
+  end
+end

data/lib/dragoon/event_manager.rb

@@ -0,0 +1,20 @@
+module Dragoon
+  class EventManager
+
+    attr_reader :handlers
+
+    def dispatch(event)
+      if @handlers.include?(event.name) && event.name != :unknown
+        @handlers[event.name].call(event.message)
+      end
+    end
+
+    # register callbacks for certain events
+    # valid events are found on constant VALID_EVENTS
+    def on(event_name, &callback)
+      @handlers = {} if @handlers.nil?
+      @handlers[event_name] = callback
+    end
+
+  end
+end

data/lib/dragoon/version.rb

@@ -0,0 +1,3 @@
+module Dragoon
+  VERSION = "0.0.1"
+end

data/spec/colors_spec.rb

@@ -0,0 +1,99 @@
+require 'spec_helper'
+
+# borrowed from Term::ANSIColors
+COLORED_REGEXP = /\e\[(?:(?:[349]|10)[0-7]|[0-9])?m/
+
+describe Dragoon::Color do
+  before(:each) do
+    class Client
+      include Dragoon::Color
+    end
+    @client = Client.new
+  end
+
+  describe "#colorize" do
+    context "single word" do
+      before(:each) do
+        @text = "#scala"
+      end
+
+      it "should assign text a permanent color" do
+        colored = @client.colorize(@text)
+        colored.should match COLORED_REGEXP
+        3.times { colored.should == @client.colorize(@text) }
+      end
+    end
+
+    context "multiple words" do
+      before(:each) do
+        @words = %w[ #ruby #java #scala #c #c++ #music #movies #video #opencv #webgl #webkit #processingjs #coffee]
+      end
+
+      it "should assign text a permanent color" do
+        @words.each do |text|
+          colored = @client.colorize(text)
+          colored.should match COLORED_REGEXP
+          3.times { colored.should == @client.colorize(text) }
+        end
+      end
+    end
+  end
+
+  describe "#highlight" do
+    context "a keyword overlaps with another" do
+      context "on the TAIL" do
+        before(:each) do
+          @text = "Should I use textmate or vim?"
+          @keywords = %w[ textmate ate ]
+        end
+
+        it "should highlight only longest keyword" do
+          result = @client.highlight_keywords(@text, @keywords)
+          result.should ==
+            "Should I use #{@client.highlight('textmate')} or vim?"
+        end
+      end
+
+      context "on the HEAD" do
+        before(:each) do
+          @text = "I'll be surprised if he believes in it."
+          @keywords = %w[ be believe ]
+        end
+
+        it "should highlight only longest keyword" do
+          result = @client.highlight_keywords(@text, @keywords)
+          result.should ==
+           "I'll #{@client.highlight("be")} surprised if " +
+           "he #{@client.highlight("believe")}s in it."
+
+        end
+      end
+
+      context "on the MIDDLE" do
+        before(:each) do
+          @keywords = %w[ computer put ]
+          @text = "Please put the computer down"
+        end
+
+        it "should highlight only longest keyword" do
+          result = @client.highlight_keywords(@text, @keywords)
+          result.should ==
+            "Please #{@client.highlight("put")} the " +
+            "#{@client.highlight("computer")} down"
+        end
+      end
+    end
+
+    context "no keyword overlaps" do
+      before(:each) do
+        @keywords = %w[ game linux need ]
+        @text = "I basically need to simulate the game port."
+      end
+
+      it "should highlight keywords" do
+        @client.highlight_keywords(@text, @keywords).should ==
+          "I basically \e[43m\e[30mneed\e[0m\e[0m to simulate the \e[43m\e[30mgame\e[0m\e[0m port."
+      end
+    end
+  end
+end

data/spec/event_manager_spec.rb

@@ -0,0 +1,46 @@
+require 'spec_helper'
+
+describe Dragoon::EventManager do
+
+  before(:each) do
+    @event_manager = Dragoon::EventManager.new
+  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" }
+        @event = Dragoon::Event.parse(":felix21 MODE felix21 :+i")
+        @event_manager.on @event.name, &@callback
+      end
+
+      it "should run the corresponding callback" do
+        @callback.should_receive(:call)
+        @event_manager.dispatch(@event)
+      end
+    end
+  end
+
+  describe "#on" do
+    it "should register that event" do
+      callback = lambda { puts "this is a callback" }
+      @event_manager.on(:mode, &callback)
+      @event_manager.handlers[:mode].should == callback
+    end
+  end
+
+end

data/spec/event_spec.rb

@@ -0,0 +1,64 @@
+require 'spec_helper'
+
+describe Dragoon::Event do
+
+  describe "#get_event" do
+    it "should process startup event" do
+      msg = ":zelazny.freenode.net NOTICE * :*** Found your hostname"
+      event = Dragoon::Event.parse(msg)
+      event.name.should == :startup
+      event.message.text.should == msg
+    end
+
+    it "should process ping event" do
+      msg = "PING :zelazny.freenode.net"
+      event = Dragoon::Event.parse(msg)
+      event.name.should == :ping
+      event.message.text.should == "PING :zelazny.freenode.net"
+      event.message.server.should == "zelazny.freenode.net"
+    end
+
+    it "should process mode event" do
+      msg = ":favor212 MODE favor212 :+i"
+      event = Dragoon::Event.parse(msg)
+      event.name.should == :mode
+      event.message.text.should == ":favor212 MODE favor212 :+i"
+    end
+
+    it "should process join event" do
+      msg = ":zigcat_Fox!~zigcat_fox@hostname JOIN #time_to_show_off"
+      event = Dragoon::Event.parse(msg)
+      event.name.should == :join
+      event.message.text.should == ":zigcat_Fox!~zigcat_fox@hostname JOIN #time_to_show_off"
+      event.message.nickname.should == "zigcat_Fox"
+      event.message.user.should == "~zigcat_fox"
+      event.message.hostname.should == "hostname"
+      event.message.channel.should == "#time_to_show_off"
+    end
+
+    it "should process privmsg event" do
+      msg = ":nick!~user@hostname PRIVMSG #ruby :array << 0 if array.size.odd?"
+      event = Dragoon::Event.parse(msg)
+      event.name.should == :privmsg
+      event.message.text.should == ":nick!~user@hostname PRIVMSG #ruby :array << 0 if array.size.odd?"
+      event.message.nickname.should == "nick"
+      event.message.user.should == "~user"
+      event.message.hostname.should == "hostname"
+      event.message.channel.should == "#ruby"
+      event.message.privmsg.should == "array << 0 if array.size.odd?"
+    end
+
+    it "should process error reply event" do
+      msg1 = ":asimov.freenode.net 477 zigcat_Fox ##java :Cannot join channel (+r) - you need to be identified with services"
+      msg2 = ":kornbluth.freenode.net 461 fenix45 USER :Not enough parameters"
+      event = Dragoon::Event.parse(msg1)
+      event.name.should == :err
+      event.message.error_code.should == '477'
+      event = Dragoon::Event.parse(msg2)
+      event.name.should == :err
+      event.message.error_code.should == '461'
+    end
+  end
+end
+
+

data/spec/spec_helper.rb

@@ -0,0 +1,4 @@
+$LOAD_PATH.unshift("#{File.expand_path(File.dirname(__FILE__))}/../lib")
+
+require 'dragoon'
+

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification 
+name: dragoon
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Reginald Tan
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2012-01-22 00:00:00 Z
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :development
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: term/ansicolor
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  type: :runtime
+  version_requirements: *id002
+description: "An IRC bot that alerts you whenever certain keywords appear in your favorite channels "
+email: 
+- redge.tan@gmail.com
+executables: 
+- dragoon
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- Gemfile.lock
+- README.md
+- Rakefile
+- TODO
+- bin/dragoon
+- config/config.yml
+- config/config.yml.example
+- 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/version.rb
+- spec/colors_spec.rb
+- spec/event_manager_spec.rb
+- spec/event_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/redgetan/dragoon
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: dragoon
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: IRC bot for keyword notification
+test_files: 
+- spec/colors_spec.rb
+- spec/event_manager_spec.rb
+- spec/event_spec.rb
+- spec/spec_helper.rb
+has_rdoc: