relayer 0.0.2

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,165 @@
+                   GNU LESSER GENERAL PUBLIC LICENSE
+                       Version 3, 29 June 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+
+  This version of the GNU Lesser General Public License incorporates
+the terms and conditions of version 3 of the GNU General Public
+License, supplemented by the additional permissions listed below.
+
+  0. Additional Definitions.
+
+  As used herein, "this License" refers to version 3 of the GNU Lesser
+General Public License, and the "GNU GPL" refers to version 3 of the GNU
+General Public License.
+
+  "The Library" refers to a covered work governed by this License,
+other than an Application or a Combined Work as defined below.
+
+  An "Application" is any work that makes use of an interface provided
+by the Library, but which is not otherwise based on the Library.
+Defining a subclass of a class defined by the Library is deemed a mode
+of using an interface provided by the Library.
+
+  A "Combined Work" is a work produced by combining or linking an
+Application with the Library.  The particular version of the Library
+with which the Combined Work was made is also called the "Linked
+Version".
+
+  The "Minimal Corresponding Source" for a Combined Work means the
+Corresponding Source for the Combined Work, excluding any source code
+for portions of the Combined Work that, considered in isolation, are
+based on the Application, and not on the Linked Version.
+
+  The "Corresponding Application Code" for a Combined Work means the
+object code and/or source code for the Application, including any data
+and utility programs needed for reproducing the Combined Work from the
+Application, but excluding the System Libraries of the Combined Work.
+
+  1. Exception to Section 3 of the GNU GPL.
+
+  You may convey a covered work under sections 3 and 4 of this License
+without being bound by section 3 of the GNU GPL.
+
+  2. Conveying Modified Versions.
+
+  If you modify a copy of the Library, and, in your modifications, a
+facility refers to a function or data to be supplied by an Application
+that uses the facility (other than as an argument passed when the
+facility is invoked), then you may convey a copy of the modified
+version:
+
+   a) under this License, provided that you make a good faith effort to
+   ensure that, in the event an Application does not supply the
+   function or data, the facility still operates, and performs
+   whatever part of its purpose remains meaningful, or
+
+   b) under the GNU GPL, with none of the additional permissions of
+   this License applicable to that copy.
+
+  3. Object Code Incorporating Material from Library Header Files.
+
+  The object code form of an Application may incorporate material from
+a header file that is part of the Library.  You may convey such object
+code under terms of your choice, provided that, if the incorporated
+material is not limited to numerical parameters, data structure
+layouts and accessors, or small macros, inline functions and templates
+(ten or fewer lines in length), you do both of the following:
+
+   a) Give prominent notice with each copy of the object code that the
+   Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the object code with a copy of the GNU GPL and this license
+   document.
+
+  4. Combined Works.
+
+  You may convey a Combined Work under terms of your choice that,
+taken together, effectively do not restrict modification of the
+portions of the Library contained in the Combined Work and reverse
+engineering for debugging such modifications, if you also do each of
+the following:
+
+   a) Give prominent notice with each copy of the Combined Work that
+   the Library is used in it and that the Library and its use are
+   covered by this License.
+
+   b) Accompany the Combined Work with a copy of the GNU GPL and this license
+   document.
+
+   c) For a Combined Work that displays copyright notices during
+   execution, include the copyright notice for the Library among
+   these notices, as well as a reference directing the user to the
+   copies of the GNU GPL and this license document.
+
+   d) Do one of the following:
+
+       0) Convey the Minimal Corresponding Source under the terms of this
+       License, and the Corresponding Application Code in a form
+       suitable for, and under terms that permit, the user to
+       recombine or relink the Application with a modified version of
+       the Linked Version to produce a modified Combined Work, in the
+       manner specified by section 6 of the GNU GPL for conveying
+       Corresponding Source.
+
+       1) Use a suitable shared library mechanism for linking with the
+       Library.  A suitable mechanism is one that (a) uses at run time
+       a copy of the Library already present on the user's computer
+       system, and (b) will operate properly with a modified version
+       of the Library that is interface-compatible with the Linked
+       Version.
+
+   e) Provide Installation Information, but only if you would otherwise
+   be required to provide such information under section 6 of the
+   GNU GPL, and only to the extent that such information is
+   necessary to install and execute a modified version of the
+   Combined Work produced by recombining or relinking the
+   Application with a modified version of the Linked Version. (If
+   you use option 4d0, the Installation Information must accompany
+   the Minimal Corresponding Source and Corresponding Application
+   Code. If you use option 4d1, you must provide the Installation
+   Information in the manner specified by section 6 of the GNU GPL
+   for conveying Corresponding Source.)
+
+  5. Combined Libraries.
+
+  You may place library facilities that are a work based on the
+Library side by side in a single library together with other library
+facilities that are not Applications and are not covered by this
+License, and convey such a combined library under terms of your
+choice, if you do both of the following:
+
+   a) Accompany the combined library with a copy of the same work based
+   on the Library, uncombined with any other library facilities,
+   conveyed under the terms of this License.
+
+   b) Give prominent notice with the combined library that part of it
+   is a work based on the Library, and explaining where to find the
+   accompanying uncombined form of the same work.
+
+  6. Revised Versions of the GNU Lesser General Public License.
+
+  The Free Software Foundation may publish revised and/or new versions
+of the GNU Lesser General Public License from time to time. Such new
+versions will be similar in spirit to the present version, but may
+differ in detail to address new problems or concerns.
+
+  Each version is given a distinguishing version number. If the
+Library as you received it specifies that a certain numbered version
+of the GNU Lesser General Public License "or any later version"
+applies to it, you have the option of following the terms and
+conditions either of that published version or of any later version
+published by the Free Software Foundation. If the Library as you
+received it does not specify a version number of the GNU Lesser
+General Public License, you may choose any version of the GNU Lesser
+General Public License ever published by the Free Software Foundation.
+
+  If the Library as you received it specifies that a proxy can decide
+whether future versions of the GNU Lesser General Public License shall
+apply, that proxy's public statement of acceptance of any version is
+permanent authorization for you to choose that version for the
+Library.

data/README.md

@@ -0,0 +1,16 @@
+[Relayer](http://github.com/brianewing/relayer) is a dead simple, high-performance, event-driven IRC library written in Ruby.
+-----------------------------------------------------------------------------------------------------------------------------
+
+It uses IO#select to achieve asynchronous IO, and has been tested to handle many hundreds of concurrent IRC connections from one instance.
+
+Sample usage:
+
+```Ruby
+echo = Relayer::IRCClient.new(:hostname => 'irc.esper.net', :nick => 'EchoBot', :channels => ['#echo'])
+
+echo.events.channel_msg do |irc, event|
+  irc.message event[:channel], event[:message]
+end
+
+Relayer::start! echo
+```

data/Rakefile

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

data/lib/relayer.rb

@@ -0,0 +1 @@
+require "relayer/relayer"

data/lib/relayer/client.rb

@@ -0,0 +1,124 @@
+require "relayer/events"
+require "relayer/protocol"
+require "relayer/version"
+
+module Relayer
+  class IRCClient
+    attr_accessor :events
+    attr_accessor :nick
+    attr_accessor :protocol
+    
+    def initialize(options = {})
+      @ssl = options[:ssl]
+      
+      @hostname = options[:hostname]
+      @port = options[:port]
+      
+      @ping_reply = options[:ping_reply]
+      @version_reply = options[:version_reply]
+      
+      @version_string = options[:version_string]
+      
+      @nick = options[:nick]
+      @nick_pass = options[:pass]
+      @ident = options[:ident]
+      @real_name = options[:real_name]
+      
+      @first_channels = options[:channels] || []
+      default_options!
+      
+      @users = {}
+      @channels = {}
+      
+      @protocol = IRCProtocol.new(self)
+      @events = IRCEvents.new(@protocol, self)
+
+      @mutex = Mutex.new
+      
+      default_handlers!
+    end
+    
+    def version_string
+      @version_string || "Relayer IRC Library v#{Relayer::VERSION}"
+    end
+    
+    def register
+      @protocol.user(@ident, @real_name)
+      @protocol.nick(@nick)
+    end
+    
+    def default_handlers!
+      @events.ping do |irc, event|
+        @protocol.pong event[:token]
+      end
+      
+      @events.connected do
+        unless @nick_pass.nil?
+          @protocol.message('NickServ', "identify #{@nick_pass}")
+        end
+
+        @first_channels.each do |channel|
+          @protocol.join(channel)
+        end
+      end
+      
+      @events.ctcp do |irc, event|
+        @protocol.ctcp_reply :version, event[:actor], version_string if event[:query] == :version
+      end
+    end
+    
+    def default_options!
+      if @ssl.nil?
+        @ssl = false
+      end
+      
+      unless @port
+        @port = 6697 if @ssl
+        @port ||= 6667
+      end
+      
+      @nick ||= "Relayer"
+      @ident ||= "relayer"
+      @real_name ||= "Relayer"
+      
+      @hostname ||= 'irc.freenode.net'
+    end
+    
+    def start
+      @socket = IRCSocket.new(self, @hostname, @port, @ssl)
+      register
+    end
+    
+    def readable
+      @socket.read
+    end
+    
+    def writable
+      @mutex.synchronize do
+        @socket.write
+      end
+    end
+    
+    def process_raw(line)
+      @protocol.process_line(line)
+    end
+    
+    def send_raw(line)
+      @mutex.synchronize do
+        @socket.send line
+      end
+    end
+    
+    def user(hostmask)
+      parts = IRC::User.parse_hostmask(hostmask)
+      
+      nickname = parts[:nick].downcase
+      @users[nickname] ||= IRC::User.new(hostmask) if IRC::User.is_user?(hostmask)
+    end
+    
+    def channel(channel)
+      channel = channel.downcase
+      @channels[channel] ||= IRC::Channel.new(channel) if IRC::Channel.is_channel?(channel)
+    end
+  end
+end

data/lib/relayer/event/event.rb

@@ -0,0 +1,7 @@
+class Relayer::Event::Event
+  attr_accessor :time
+  
+  def time!
+    @time = Time.now
+  end
+end

data/lib/relayer/event/message_event.rb

@@ -0,0 +1,13 @@
+require "relayer/event/event"
+
+module Relayer::Event
+  class Message < Event
+    attr_accessor :sender, :message, :channel
+    
+    def initialize(sender, message, channel)
+      @sender = sender
+      @message = message
+      @channel = channel
+    end
+  end
+end

data/lib/relayer/events.rb

@@ -0,0 +1,31 @@
+module Relayer
+  class IRCEvents
+    def initialize(protocol, client)
+      @protocol = protocol
+      @client = client
+      
+      @handlers = {
+        :ping => [],
+        :connected => [],
+        :channel_msg => [],
+        :ctcp => []
+      }
+    end
+    
+    def method_missing(event, *args, &handler)
+      raise ArgumentError if handler.nil?
+      
+      if @handlers.has_key? event
+        @handlers[event].push handler
+      else
+        raise NoMethodError
+      end
+    end
+    
+    def dispatch(event, args)
+      @handlers[event].each do |handler|
+        handler.call(@protocol, args)
+      end
+    end
+  end
+end

data/lib/relayer/irc/channel.rb

@@ -0,0 +1,18 @@
+module Relayer::IRC
+  class Channel
+    attr_accessor :users
+    
+    def self.is_channel?(channel)
+      channel[0] == '#'
+    end
+    
+    def to_s
+      @channel
+    end
+    
+    def initialize(channel)
+      @channel = channel
+      @users = []
+    end
+  end
+end

data/lib/relayer/irc/user.rb

@@ -0,0 +1,36 @@
+module Relayer::IRC
+  class User
+    IRC_HOSTMASK_REGEX = /^([^\!@]+)(\!([^\!@]+))(@(.+))$/
+    
+    attr_accessor :nick, :ident, :hostname, :hostmask
+    
+    def self.is_user?(hostmask)
+      not IRC_HOSTMASK_REGEX.match(hostmask).nil?
+    end
+    
+    def to_s
+      @nick
+    end
+    
+    def self.parse_hostmask(hostmask)
+      match = IRC_HOSTMASK_REGEX.match hostmask
+      return if match.nil?
+      
+      raw, nick, ident_tmp, ident, hostname_tmp, hostname = match.to_a
+      return :nick => nick, :ident => ident, :hostname => hostname
+    end
+    
+    def parse_hostmask!
+      parts = User.parse_hostmask @hostmask
+      
+      @nick = parts[:nick]
+      @ident = parts[:ident]
+      @hostname = parts[:hostname]
+    end
+    
+    def initialize(hostmask)
+      @hostmask = hostmask
+      parse_hostmask!
+    end
+  end
+end

data/lib/relayer/protocol.rb

@@ -0,0 +1,118 @@
+require "relayer/irc/user"
+require "relayer/irc/channel"
+
+module Relayer
+  class IRCProtocolException < Exception; end
+  
+  class IRCProtocol
+    IRC_LINE_REGEX = /^(:([^ ]+) )?([A-Z0-9]+) ([^:]+)? ?(:(.*))?$/
+    
+    def initialize(client)
+      @client = client
+      @registration_commands = []
+    end
+    
+    def dispatch(event, args = {})
+      @client.events.dispatch(event, args)
+    end
+    
+    def process_line(line)
+      match = IRC_LINE_REGEX.match(line)
+      raise IRCProtocolException if match.nil?
+      
+      raw, actor_tmp, actor, command, args, ext_tmp, extended_arg = match.to_a
+      
+      if Relayer::IRC::User.is_user? actor
+        actor = @client.user(actor)
+      else
+        actor = nil #todo: implement server actors
+      end
+      
+      args = args.split unless args.nil?
+      command = command.downcase.to_sym unless command.nil?
+      
+      if actor.nil?
+        # match server-only commands like 'PING'
+        case command
+          when :ping
+            dispatch :ping, :token => extended_arg
+        end
+        
+        if ("001".."004").include? command.to_s
+          @registration_commands.push command.to_s
+          
+          dispatch :connected if registered?
+        end
+      else
+        case command
+          when :privmsg
+            to = args[0]
+            
+            message = extended_arg
+            
+            is_ctcp = message.start_with?("\001") and message.end_with?("\001")
+            message = message[1..-2] if is_ctcp
+            
+            if is_ctcp
+              query_args = message.split
+              query = query_args.shift.downcase.to_sym
+              
+              dispatch :ctcp, :actor => actor, :channel => @client.channel(to), :query => query, :args => query_args
+            elsif IRC::Channel.is_channel?(to)
+              dispatch :channel_msg, :actor => actor, :channel => @client.channel(to), :message => extended_arg
+            elsif to.downcase == @nick.downcase
+              dispatch :private_msg, :actor => actor, :message => extended_arg
+            end
+        end
+      end
+    end
+    
+    def registered?
+      (("001".."004").to_a - @registration_commands).empty?
+    end
+    
+    def send_command(command, *args)
+      if args.last.include?(' ')
+        arg = args.pop
+        arg.insert(0, ':')
+        args.push(arg)
+      end
+      
+      @client.send_raw "#{command.to_s.upcase} #{args.join ' '}"
+    end
+    
+    def pong(token = false)
+      send_command :pong, token
+    end
+    
+    def ctcp(label, to)
+      extended_arg = "\001#{label.to_s.upcase}\001"
+      
+      send_command :privmsg, to, extended_arg
+    end
+    
+    def ctcp_reply(label, to, data)
+      data = " #{data}" if data
+      extended_arg = "\001#{label.to_s.upcase}#{data}\001"
+      
+      send_command :notice, to, extended_arg
+    end
+    
+    def message(channel, message)
+      send_command :privmsg, channel, message
+    end
+    
+    def nick(nickname)
+      send_command :nick, nickname
+    end
+    
+    def join(channel)
+      channel = "\##{channel}" unless channel[0] == '#'
+      send_command :join, channel
+    end
+    
+    def user(ident, real_name)
+      send_command :user, ident, '0', '*', real_name
+    end
+  end
+end

data/lib/relayer/relayer.rb

@@ -0,0 +1,19 @@
+require "relayer/client"
+require "relayer/socket"
+require "relayer/version"
+
+module Relayer
+  def Relayer::start!(bots)
+    if bots.respond_to? :each
+      bots.each do |bot|
+        bot.start
+      end
+    else
+      bots.start
+    end
+    
+    unless IRCSocketSelector.started?
+      IRCSocketSelector.start!
+    end
+  end
+end

data/lib/relayer/socket.rb

@@ -0,0 +1,75 @@
+require "socket"
+require "openssl"
+
+module Relayer
+  class IRCSocket
+    def initialize(client, host, port, ssl = false)
+      @client = client
+      @socket = TCPSocket.new(host, port)
+
+      if ssl
+        @socket = OpenSSL::SSL::SSLSocket.new(@socket)
+        @socket.sync_close = true # close both wrapper and irc socket on close
+        @socket.connect
+      end
+      
+      IRCSocketSelector.add_irc_socket(@socket, @client)
+    end
+    
+    def read
+      data = @socket.gets
+      data = data.sub "\r", ''
+      
+      lines = data.split "\r\n"
+      
+      lines.each do |line|
+        @client.process_raw line
+      end
+    end
+    
+    def send(line)
+      @socket.puts line
+    end
+    
+    def close
+      @socket.close
+    end
+  end
+  
+  class IRCSocketSelector
+    @@sockets = {}
+    @@started = false
+    
+    def self.instance
+      @@instance ||= IRCSocketSelector.new
+    end
+    
+    def self.add_irc_socket(socket, client)
+      @@sockets[socket] = client
+    end
+    
+    def self.select
+      sockets = @@sockets.keys
+      
+      readable, writable, exceptioned = IO.select(sockets, nil, nil)
+      
+      readable.each do |socket|
+        client = @@sockets[socket]
+        client.readable
+      end
+    end
+    
+    def self.started?
+      @@started
+    end
+    
+    def self.start!
+      return if @@sockets.empty?
+      
+      @@started = true
+      while true
+        IRCSocketSelector.select
+      end
+    end
+  end
+end

data/lib/relayer/version.rb

@@ -0,0 +1,3 @@
+module Relayer
+  VERSION = "0.0.2"
+end

data/relayer.gemspec

@@ -0,0 +1,26 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "relayer/version"
+
+Gem::Specification.new do |s|
+  s.name        = "relayer"
+  s.version     = Relayer::VERSION
+  s.authors     = ["Brian Ewing"]
+  s.email       = ["me@brianewing.co.uk"]
+  s.homepage    = "http://brianewing.me/pages/relayer"
+  s.summary     = "Dead simple, high-performance, event-driven IRC library"
+  s.description = "Relayer is a dead simple, high-performance, event-driven IRC library"
+
+  s.rubyforge_project = "relayer"
+
+  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.license = "LGPL"
+
+  # specify any dependencies here; for example:s
+  # s.add_development_dependency "rspec"
+  # s.add_runtime_dependency "rest-client"
+end

data/test.rb

@@ -0,0 +1,10 @@
+require './lib/relayer'
+
+echo = Relayer::IRCClient.new(:hostname => 'irc.alphachat.net', :nick => 'EchoBot', :channels => ['#lobby'])
+
+echo.events.channel_msg do |irc, event|
+  msg = event[:message].sub('!say ', '')
+  irc.message(event[:channel], msg) unless msg.blank?
+end
+
+Relayer::start! echo

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: relayer
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+  prerelease: 
+platform: ruby
+authors:
+- Brian Ewing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-12-03 00:00:00.000000000 Z
+dependencies: []
+description: Relayer is a dead simple, high-performance, event-driven IRC library
+email:
+- me@brianewing.co.uk
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/relayer.rb
+- lib/relayer/client.rb
+- lib/relayer/event/event.rb
+- lib/relayer/event/message_event.rb
+- lib/relayer/events.rb
+- lib/relayer/irc/channel.rb
+- lib/relayer/irc/user.rb
+- lib/relayer/protocol.rb
+- lib/relayer/relayer.rb
+- lib/relayer/socket.rb
+- lib/relayer/version.rb
+- relayer.gemspec
+- test.rb
+homepage: http://brianewing.me/pages/relayer
+licenses:
+- LGPL
+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: relayer
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: Dead simple, high-performance, event-driven IRC library
+test_files: []