irc 0.0.1

data/README.markdown

@@ -0,0 +1,50 @@
+Usage
+=====
+
+## Quickstart
+``` ruby
+require 'irc'
+
+host    'localhost'
+nick    'MyBot'
+channel '#MyChannel', '#OtherChannel'
+
+# Say hi when somebody joins the channel:
+on :join do
+  say "Hi #{nick}!"
+end
+
+# Tell the time and date:
+match /^!(?:time|now)/ do
+  reply Time.now.strftime("it is %l:%M %P on %A, %B %-d, %Y.").gsub(/[ ]+/, ' ' )
+end
+
+start!
+```
+Then, `ruby newbot.rb`
+
+
+## Subclass
+
+You can also `require 'irc/base'` and subclass `IRC::Bot`:
+``` ruby
+require 'irc/base'
+
+class MyBot < IRC::Bot
+ host    'localhost'
+ nick    'MyBot'
+ channel '#MyChannel'
+
+ start!
+end
+```
+
+You can re-load the bot to update its callbacks without disconnecting:
+``` ruby
+# mention_match requires messages to start with the name of the bot
+mention_match /reload!/ do
+  self.class.reset!
+
+  load __FILE__
+end
+```

data/lib/irc.rb

@@ -0,0 +1,17 @@
+require 'irc/base'
+
+class NewBot < IRC::Bot
+
+end
+
+module IRC
+  module Delegator
+    NewBot.public_methods.each do |method_name|
+      define_method method_name do |*args, &block|
+        NewBot.send method_name, *args, &block
+      end
+    end
+  end
+end
+
+extend IRC::Delegator

data/lib/irc/base.rb

@@ -0,0 +1,6 @@
+require 'irc/extensions'
+
+require 'irc/connection'
+require 'irc/callback'
+require 'irc/message'
+require 'irc/bot'

data/lib/irc/bot.rb

@@ -0,0 +1,114 @@
+module IRC
+  class Bot
+    attr_reader :message
+
+    def initialize message
+      @message = message
+    end
+
+    def stop
+      Thread.current.kill
+    end
+
+    def say something, recipients = nil
+      message.connection.privmsg something, recipients || self.class.channels
+    end
+
+    def reply something, mention = true
+      if message.middle == self.class.nick
+        say something, message.nick
+      elsif mention
+        say "#{message.nick}, #{something}", message.middle
+      else
+        say something, message.middle
+      end
+    end
+
+    def store namespace = nil
+      @store ||= IRC::Store.store
+
+      if namespace
+        (@namespace ||= {})[namespace] ||= Redis::Namespace.new(namespace, redis: @store)
+      else
+        @store
+      end
+    end
+
+    def conjugate noun, lookup = nil
+      lookup ||= {
+        'me'  => nick, 
+        'you' => self.class.nick,
+        nick  => 'you'
+      }
+      noun.gsub /[\w]+/i, lookup
+    end
+
+    def method_missing method_name, *args
+      message.public_send method_name, *args
+    end
+
+    class << self
+      attr_accessor :nick, :host, :port, :channels
+
+      def start!
+        @connection ||= Connection.new @host, @port
+
+        on(:ping) { connection.pong params }
+
+        @connection.nick @nick
+        @connection.join @channels
+
+        @connection.listen
+      end
+
+      def reset!
+        Callback.reset!
+        @channels = []
+      end
+
+      def host _host = nil
+        puts "   host: '#{_host}'"
+        @host = _host || @host
+      end
+
+      def port _port = nil
+        puts "   port: '#{_port}'"
+        @port = _port || @port
+      end
+
+      def nick _nick = nil
+        puts "   nick: '#{_nick}'"  if _nick
+        @nick = _nick || @nick
+      end
+
+      def store _store, options = nil
+        require 'irc/store'
+
+        case _store
+        when :redis
+          IRC::Store.options = options
+        end
+      end
+
+      def channel *_channels
+        _channels.each do |c|
+          puts "channel: '#{c}'"
+          (@channels ||= []) << c
+        end
+      end
+
+      def match regex, &block
+        on(:privmsg, regex, &block)
+      end
+
+      def mention_match regex, &block
+        r = /^#{@nick}[,: ]*/ + regex
+        on(:privmsg, r, &block)
+      end
+
+      def on action, regex = nil, &block
+        Callback.add(action, regex, self, &block)
+      end
+    end # class << Bot
+  end # class Bot
+end # module IRC

data/lib/irc/callback.rb

@@ -0,0 +1,57 @@
+module IRC
+  class Callback
+    attr_accessor :action, :regex
+
+    def initialize action, regex = nil, factory = nil, &block
+      @action  = action
+      @regex   = regex || //
+      @block   = block
+      @factory = factory
+    end
+
+    def call! message
+      if match = @regex.match(message.content)
+        (class << message; self; end).send :attr_accessor, *@regex.names
+        @regex.names.each do |name|
+          message.instance_variable_set("@#{name}", match[name])
+        end
+
+        Thread.new do
+        # begin
+          if @factory
+            @factory.new(message).instance_eval(&@block)
+          else
+            puts "calling #{@block}"
+            @block.call(message, match)
+          end
+        end
+      end
+    end
+
+    class << self
+      attr_accessor :callbacks
+
+      def handle message
+        callbacks[message.action].each do |callback|
+          callback.call! message
+        end
+      end
+
+      def add action, *args, &block
+        callback = new(action, *args, &block)
+
+        callbacks[action] << callback
+        callbacks[:all]   << callback
+      end
+
+      def callbacks
+        @callbacks ||= Hash.new {|hash,key| hash[key] = []}
+      end
+
+      def reset!
+        @callbacks = nil
+        callbacks
+      end
+    end # class << Callback
+  end # class Callback
+end

data/lib/irc/connection.rb

@@ -0,0 +1,91 @@
+require 'socket'
+require 'thread'
+
+module IRC
+  class Connection
+    def initialize host = nil, port = 6667
+      @host = host
+      @port = port
+    end
+
+    def mutex
+      @mutex ||= Mutex.new
+    end
+
+    def disconnected?
+      !@socket || @socket.closed?
+    end
+
+    def connected?
+      !disconnected?
+    end
+
+    def write *strings
+      # mutex do
+        strings.each do |string|
+          puts '-> ' + string
+          socket.print string + "\r\n"
+        end
+      # end
+    end
+
+    def join *channels
+      channels.flatten.each do |channel|
+        @channel = channel
+        write "JOIN #{channel}"
+      end
+    end
+
+    def part *channels
+      channels.flatten.each do |channel|
+        write "PART #{channel}"
+      end
+    end
+
+    def nick _nick, realname = nil
+      realname ||= _nick
+      write "NICK #{_nick}"
+      write "USER #{_nick} localhost #{@host} :#{realname}"
+    end
+
+    def privmsg content, *recipients
+      recipients = @channel unless recipients.any?
+      recipients = [recipients].flatten.join(',')
+
+      msg = "PRIVMSG #{recipients} :#{content}"
+      write msg.slice!(0,500)
+      privmsg msg, recipients if msg != ''
+    end
+
+    def quit message = nil
+      write "QUIT :#{message}"
+    end
+
+    def pong value
+      write "PONG #{value}"
+    end
+
+    def disconnect
+      quit
+      socket.close
+    end
+
+    def socket
+      @socket ||= TCPSocket.open(@host, @port)
+    end
+    Thread.abort_on_exception = true
+
+    def listen
+      unless @listening
+        loop do
+          @listening = true
+          socket.lines "\r\n" do |line|
+            message = Message.new(line, self)
+            Callback.handle message
+          end
+          @listening = false
+        end
+      end
+    end
+  end # class Connection
+end

data/lib/irc/extensions.rb

@@ -0,0 +1,33 @@
+class Array
+  def to_sentence
+    case length
+    when 0
+      ''
+    when 1
+      self[0].to_s
+    when 2
+      "#{self[0]} and #{self[1]}"
+    else
+      "#{self[0..-2].join(', ')}, and #{self.last}"
+    end
+  end
+end
+
+class String
+  def pluralize number = 2
+    case number
+    when 0
+      "no #{self}s"
+    when 1
+      "1 #{self}"
+    else
+      "#{number} #{self}s"
+    end
+  end
+end
+
+class Regexp
+  def +(r)
+    Regexp.new(source + r.source)
+  end
+end

data/lib/irc/message.rb

@@ -0,0 +1,46 @@
+module IRC
+  class Message
+    REGEX = /^
+      (:
+        (?<prefix>
+          (
+            (?<servername>(?<nick>[a-z][a-z0-9_\-\[\]\\`\^\{\}\.\|]*))
+          )
+          (!(?<user>[a-z0-9~\.]+))?
+          (@(?<host>[a-z0-9\.]+))?
+        )
+        [\ ]+
+      )?
+      (?<command>[a-z]+|[0-9]{3})
+      (?<params>
+        (\ +(?<middle>[^:\r\n\ ][^\r\n\ ]*))*
+        (\ *:(?<trailing>.+))?
+      )
+      \r\n$
+    /xi
+
+    attr_reader   :raw
+    attr_accessor :connection
+    attr_accessor *REGEX.names
+
+    def initialize message_string, connection
+      @raw = message_string
+
+      @connection = connection
+      @match = REGEX.match(message_string) || {}
+
+      REGEX.names.each do |name|
+        instance_variable_set("@#{name}", @match[name])
+      end
+
+    end
+
+    def action
+      @action ||= (command || '').downcase.intern
+    end
+
+    def content
+      @content ||= trailing || middle
+    end
+  end # class Message
+end

data/lib/irc/store.rb

@@ -0,0 +1,24 @@
+require 'redis'
+require 'redis-namespace'
+
+module IRC
+  class Store
+    attr_reader :store
+
+    def initialize options = {}
+      options = {:host => 'localhost', :port => 6379}.merge(options)
+      @store = Redis.new options
+    end
+
+    def method_missing method_name, *args, &block
+      store.send method_name, *args, &block
+    end
+
+    class << self
+      attr_accessor :options
+      def store
+        self.new options
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,53 @@
+--- !ruby/object:Gem::Specification
+name: irc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jeff Peterson
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-10-02 00:00:00.000000000 Z
+dependencies: []
+description: a simple ruby irc (bot framework)
+email: jeff@petersonj.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- README.markdown
+- lib/irc.rb
+- lib/irc/base.rb
+- lib/irc/bot.rb
+- lib/irc/callback.rb
+- lib/irc/connection.rb
+- lib/irc/extensions.rb
+- lib/irc/message.rb
+- lib/irc/store.rb
+homepage: http://github.com/jeffpeterson/irc
+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.24
+signing_key: 
+specification_version: 3
+summary: a simple ruby irc (bot) framework
+test_files: []