em-irc 0.0.1

data/.gitignore

@@ -0,0 +1,18 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+.DS_Store

data/.rspec

@@ -0,0 +1 @@
+--color

data/.rvmrc

@@ -0,0 +1 @@
+rvm use 1.9.3

data/.travis.yml

@@ -0,0 +1,12 @@
+rvm:
+  - 1.9.2
+  - 1.9.3
+bundler_args: --without darwin --without development
+gemfile:
+  - Gemfile
+before_script:
+  - "sudo apt-get -qq -y install ngircd"
+  - "service ngircd stop"
+  - "ngircd -f spec/config/ngircd-unencrypted.conf"
+  - "ngircd -f spec/config/ngircd-encrypted-gnutls.conf"
+script: "bundle exec rake"

data/.yardopts

@@ -0,0 +1 @@
+--no-private --protected - LICENSE

data/Gemfile

@@ -0,0 +1,23 @@
+source 'http://rubygems.org'
+
+# Specify your gem's dependencies in em-irc.gemspec
+gemspec
+
+group :development do
+  gem 'pry'
+  gem 'yard'
+  gem 'redcarpet'
+  gem 'guard'
+  gem 'guard-rspec'
+  gem 'guard-bundler'
+end
+
+group :development, :test do
+  gem 'rake'
+  gem 'rspec', "~> 2"
+end
+
+group :darwin do
+  gem 'rb-fsevent'
+  gem 'growl'
+end

data/Guardfile

@@ -0,0 +1,13 @@
+# A sample Guardfile
+# More info at https://github.com/guard/guard#readme
+
+guard 'bundler' do
+  watch('Gemfile')
+end
+
+guard 'rspec', :version => 2 do
+  watch(%r{^spec/.+_spec\.rb$})
+  watch(%r{^lib/(.+)\.rb$})     { |m| "spec/lib/#{m[1]}_spec.rb" }
+  watch('lib/em-irc.rb')        { "spec" }
+  watch('spec/spec_helper.rb')  { "spec" }
+end

data/LICENSE

@@ -0,0 +1,19 @@
+Copyright (c) 2012 Jerry Cheung.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,100 @@
+# EventMachine IRC Client
+
+[CI Build Status](https://secure.travis-ci.org/jch/em-irc.png?branch=master)
+
+em-irc is an IRC client that uses EventMachine to handle connections to servers.
+
+## Basic Usage
+
+````ruby
+require 'em-irc'
+
+client = EventMachine::IRC::Client.new do |c|
+  c.host = 'irc.freenode.net'
+  c.port = '6667'
+  c.nick = 'jch'
+
+  c.on(:connect) do
+    join('#general')
+    join('#private', 'key')
+  end
+
+  c.on(:join) do |channel|  # called after joining a channel
+    message(channel, "howdy all")
+  end
+
+  c.on(:message) do |source, target, message|  # called when being messaged
+    puts "<#{source}> -> <#{target}>: #{message}"
+  end
+
+  # callback for all messages sent from IRC server
+  c.on(:raw) do |hash|
+    puts "#{hash[:prefix]} #{hash[:command]} #{hash[:params].join(' ')}"
+  end
+end
+
+client.run!  # start EventMachine loop
+````
+
+## Examples
+
+In the examples folder, there are runnable examples.
+
+* cli.rb - takes input from keyboard, outputs to stdout
+* websocket.rb - 
+* echo.rb - bot that echos everything
+* callback.rb - demonstrate how callbacks work
+
+## References
+
+* [RFC 1459 - Internet Relay Chat Protocol](http://tools.ietf.org/html/rfc1459) overview of IRC architecture
+* [RFC 2812 - Internet Relay Chat: Client Protocol](http://tools.ietf.org/html/rfc2812) specifics of client protocol
+* [RFC 2813 - Internet Relay Chat: Server Protocol](http://tools.ietf.org/html/rfc2813) specifics of server protocol
+
+## Development
+
+To run integration specs, you'll need to run a ssl and a non-ssl irc server locally.
+On OSX, you can install a server via [Homebrew](http://mxcl.github.com/homebrew/) with:
+
+```
+bundle
+brew install ngircd
+ngircd -f spec/config/ngircd-unencrypted.conf
+ngircd -f spec/config/ngircd-encrypted-openssl.conf
+bundle exec rake  # or guard
+```
+
+If the server is not starting up correctly, make sure you're ngircd is
+compiled with openssl support rather than gnutls. You can see the server
+boot output by passing the '-n' flag. Also not that travis-ci builds
+are executed with gnutls.
+
+## <a name="license"></a>License
+
+Copyright (c) 2012 Jerry Cheung.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.
+
+## TODO
+
+* can we skip using Dispatcher connection handler class?
+* extract :on, :trigger callback gem that works on instances. [hook](https://github.com/apotonick/hooks), but works with instances
+* would prefer the interface to look synchronous, but work async
+* ssl dispatcher testing
+* speed up integration specs

data/Rakefile

@@ -0,0 +1,6 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"
+Bundler::GemHelper.install_tasks
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec)
+task :default => :spec

data/em-irc.gemspec

@@ -0,0 +1,20 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/em-irc/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Jerry Cheung"]
+  gem.email         = ["jch@whatcodecraves.com"]
+  gem.description   = %q{em-irc is an IRC client that uses EventMachine to handle connections to servers}
+  gem.summary       = %q{em-irc is an IRC client that uses EventMachine to handle connections to servers}
+  gem.homepage      = "http://github.com/jch/em-irc"
+
+  gem.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  gem.files         = `git ls-files`.split("\n")
+  gem.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  gem.name          = "em-irc"
+  gem.require_paths = ["lib"]
+  gem.version       = EventMachine::IRC::VERSION
+
+  gem.add_runtime_dependency 'eventmachine'
+  gem.add_runtime_dependency 'activesupport'
+end

data/examples/logger.rb

@@ -0,0 +1,24 @@
+require File.expand_path '../../lib/em-irc', __FILE__
+require 'logger'
+
+client = EventMachine::IRC::Client.new do
+  host   '127.0.0.1'
+  port   '6667'
+  # logger Logger.new(STDOUT)
+
+  on :connect do
+    puts 'client connected'
+    join("#general")
+  end
+
+  on :message do |source, target, message|
+    puts "#{target} <#{source}> #{message}"
+  end
+
+  # on :raw do |m|
+  #   # puts "raw message: #{m.inspect}"
+  # end
+end
+
+# puts client.callbacks
+client.run!

data/lib/em-irc.rb

@@ -0,0 +1,18 @@
+require 'bundler'
+Bundler.setup :default
+
+require 'active_support/core_ext/hash/keys'
+require 'active_support/core_ext/object/blank'
+require 'active_support/callbacks'
+require 'eventmachine'
+require 'forwardable'
+require 'set'
+
+$:.unshift File.expand_path '..', __FILE__
+
+module EventMachine
+  module IRC
+    autoload :Client,     'em-irc/client'
+    autoload :Dispatcher, 'em-irc/dispatcher'
+  end
+end

data/lib/em-irc/client.rb

@@ -0,0 +1,215 @@
+module EventMachine
+  module IRC
+    class Client
+      # EventMachine::Connection object to IRC server
+      # @private
+      attr_accessor :conn
+
+      # IRC server to connect to. Defaults to 127.0.0.1:6667
+      attr_accessor :host, :port
+
+      attr_accessor :nick
+      attr_accessor :realname
+      attr_accessor :ssl
+
+      # Custom logger
+      attr_accessor :logger
+
+      # Set of channels that this client is connected to
+      # @private
+      attr_reader :channels
+
+      # Hash of callbacks on events. key is symbol event name.
+      # value is array of procs to call
+      # @private
+      attr_reader :callbacks
+
+      # Build a new unconnected IRC client
+      #
+      # @param [Hash] options
+      # @option options [String] :host
+      # @option options [String] :port
+      # @option options [Boolean] :ssl
+      # @option options [String] :nick
+      # @option options [String] :realname
+      #
+      # @yield [client] new instance for decoration
+      def initialize(options = {}, &blk)
+        options.symbolize_keys!
+        options = {
+          host:     '127.0.0.1',
+          port:     '6667',
+          ssl:      false,
+          realname: 'Anonymous Annie',
+          nick:     "guest-#{Time.now.to_i % 1000}"
+        }.merge!(options)
+
+        @host      = options[:host]
+        @port      = options[:port]
+        @ssl       = options[:ssl]
+        @realname  = options[:realname]
+        @nick      = options[:nick]
+        @channels  = Set.new
+        @callbacks = Hash.new
+        @connected = false
+        yield self if block_given?
+      end
+
+      # Creates a Eventmachine TCP connection with :host and :port. It should be called
+      # after callbacks are registered.
+      # @see #on
+      # @return [EventMachine::Connection]
+      def connect
+        self.conn ||= EventMachine::connect(@host, @port, Dispatcher, parent: self)
+      end
+
+      # @return [Boolean]
+      def connected?
+        @connected
+      end
+
+      # Callbacks
+
+      # Register a callback with :name as one of the following, and
+      # a block with the same number of params.
+      #
+      # @example
+      #   on(:join) {|channel| puts channel}
+      #  
+      #   :connect - called after connection to server established
+      #  
+      #   :join
+      #     @param who [String]
+      #     @param channel [String]
+      #     @param names [Array]
+      #  
+      #   :message, :privmsg - called on channel message or nick message
+      #     @param source [String]
+      #     @param target [String]
+      #     @param message [String]
+      #  
+      #   :raw - called for all messages from server
+      #     @param raw_hash [Hash] same format as return of #parse_message
+      def on(name, &blk)
+        # TODO: I thought Hash.new([]) would work, but it gets empted out
+        # TODO: normalize aliases :privmsg, :message, etc
+        (@callbacks[name.to_sym] ||= []) << blk
+      end
+
+      # Trigger a named callback
+      def trigger(name, *args)
+        # TODO: should this be instance_eval(&blk)? prevents it from non-dsl style
+        (@callbacks[name.to_sym] || []).each {|blk| blk.call(*args)}
+      end
+
+      # Sends raw message to IRC server. Assumes message is correctly formatted
+      # TODO: what if connect fails? or disconnects?
+      def send_data(message)
+        return false unless connected?
+        message = message + "\r\n"
+        log Logger::DEBUG, message
+        self.conn.send_data(message)
+      end
+
+      # Client commands
+      # See [RFC 2812](http://tools.ietf.org/html/rfc2812)
+      def renick(nick)
+        send_data("NICK #{nick}")
+      end
+
+      def user(username, mode, realname)
+        send_data("USER #{username} #{mode} * :#{realname}")
+      end
+
+      def join(channel_name, channel_key = nil)
+        send_data("JOIN #{channel_name} #{channel_key}".strip)
+      end
+
+      def pong(servername)
+        send_data("PONG :#{servername}")
+      end
+
+      # @param target [String] nick or channel name
+      # @param message [String]
+      def privmsg(target, message)
+        send_data("PRIVMSG #{target} :#{message}")
+      end
+      alias_method :message, :privmsg
+
+      def quit(message = 'leaving')
+        send_data("QUIT :#{message}")
+      end
+
+      # @return [Hash] h
+      # @option h [String] :prefix
+      # @option h [String] :command
+      # @option h [Array] :params
+      # @private
+      def parse_message(message)
+        # TODO: error handling
+        result = {}
+        parts = message.split(' ')
+        result[:prefix] = parts.shift.gsub(/^:/, '') if parts[0] =~ /^:/
+        result[:command] = parts[0]  # cleanup?
+        result[:params] = parts.slice(1..-1).map {|s| s.gsub(/^:/, '')}
+        result
+      end
+
+      def handle_parsed_message(m)
+        case m[:command]
+        when '001' # welcome message
+        when 'PING'
+          pong(m[:params].first)
+          trigger(:ping, *m[:params])
+        when 'PRIVMSG'
+          trigger(:message, m[:prefix], m[:params].first, m[:params].slice(1..-1).join(' '))
+        when 'QUIT'
+        when 'JOIN'
+          trigger(:join, m[:prefix], m[:params].first)
+        else
+          # noop
+          # {:prefix=>"irc.the.net", :command=>"433", :params=>["*", "one", "Nickname", "already", "in", "use", "irc.the.net", "451", "*", "Connection", "not", "registered"]}
+          # {:prefix=>"irc.the.net", :command=>"432", :params=>["*", "one_1328243723", "Erroneous", "nickname"]}
+        end
+        trigger(:raw, m)
+      end
+
+      # EventMachine Callbacks
+      def receive_data(data)
+        data.split("\r\n").each do |message|
+          parsed = parse_message(message)
+          handle_parsed_message(parsed)
+        end
+      end
+
+      # @private
+      def ready
+        @connected = true
+        renick(@nick)
+        user(@nick, '0', @realname)
+        trigger(:connect)
+      end
+
+      # @private
+      def unbind
+        trigger(:disconnect)
+      end
+
+      def log(*args)
+        @logger.log(*args) if @logger
+      end
+
+      def run!
+        EM.epoll
+        EventMachine.run do
+          trap("TERM") { EM::stop }
+          trap("INT")  { EM::stop }
+          connect
+          log Logger::INFO, "Starting IRC client..."
+        end
+        log Logger::INFO, "Stopping IRC client"
+        @logger.close if @logger
+      end
+    end
+  end
+end

data/lib/em-irc/dispatcher.rb

@@ -0,0 +1,33 @@
+module EventMachine
+  module IRC
+    # EventMachine connection handler class that dispatches connections back to another object.
+    class Dispatcher < EventMachine::Connection
+      extend Forwardable
+      def_delegators :@parent, :receive_data, :unbind
+
+      def initialize(options)
+        raise ArgumentError.new(":parent parameter is required for EM#connect") unless options[:parent]
+        # TODO: if parent doesn't respond to a above methods, do a no-op
+        @parent = options[:parent]
+      end
+
+      # @parent.conn is set back to nil when this is created
+      def post_init
+        @parent.conn = self
+        @parent.ready unless @parent.ssl
+      end
+
+      def connection_completed
+        if @parent.ssl
+          start_tls
+        else
+          @parent.ready
+        end
+      end
+
+      def ssl_handshake_completed
+        @parent.ready if @parent.ssl
+      end
+    end
+  end
+end

data/lib/em-irc/version.rb

@@ -0,0 +1,5 @@
+module EventMachine
+  module IRC
+    VERSION = '0.0.1'
+  end
+end

data/spec/config/gnutls-cert.pem

@@ -0,0 +1,18 @@
+-----BEGIN CERTIFICATE-----
+MIIC4zCCAc2gAwIBAgIETzYPfjALBgkqhkiG9w0BAQUwHjELMAkGA1UEBhMCVVMx
+DzANBgNVBAoTBmVtLWlyYzAeFw0xMjAyMTEwNjQ5MzdaFw0zOTA2MjgwNjQ5NTJa
+MB4xCzAJBgNVBAYTAlVTMQ8wDQYDVQQKEwZlbS1pcmMwggEgMAsGCSqGSIb3DQEB
+AQOCAQ8AMIIBCgKCAQEAzG8N4DlzIqX2lcM5DY9uNh0YrRmG0SJ9C2P5cl/sx+X/
+sEjlqJweGJMDj4Q7PYGhlGux6iSX/4hzZ5/FtZADrlCTGR7wUBLznWug2yHQQa24
+PfA5rtzwKCFUClQbWiDnOuiin7jx0o5gjvpLqq2c9x5iqO+IWJgMxH8LtGmv2dGN
+zaffWBAfTnF7M+96IlZ7zaDLodWrwqX5QOqNAHP3RvhK7PXzaR1QrwcyuwdcV4Or
+MKg+Vky92ixl/90+HqdDCMjhT7Attxrulc9Q2zxk1ZGKPYtbe4YuXDal4Zh5ODgD
+rXXnN1wbYiQfHuOZc18nQ2EHtdfXXmFMxozyPszAKQIDAQABoy8wLTAMBgNVHRMB
+Af8EAjAAMB0GA1UdDgQWBBTmTq5dq1pGlorhDvO4YEnh5U/waTALBgkqhkiG9w0B
+AQUDggEBAFTnrOYZW5/u4XVKrRH40+Y+BlBj6EYHd4ewELJHPXudZzAUuxTm+X9Z
++EQBa72jCFa76tnyUDK/EffL5mdWCoTULIfIcCpJNrY/E9kpCBKL/0ium35f4QpP
+Zc6xzZGZSsJsLSPHyAfdycVv6VGbRw08HCD5U+YSEKLXSpiW9jinQ8Lft0cYki6f
++d4wZCxu75uUrTlfRVsHPnEufRt3jQSxPNOTHy59xQGELnDgq66hn8MRPEIb37Em
+rnyTF3RRR+Zcl4jgot14h0e7WdPhqFvf/l8xO/A17vDhnRFDqwROxITNnj9Ebww3
+8DSCjoUFVQP16iBhrUkDW+blkSxI3+4=
+-----END CERTIFICATE-----

data/spec/config/gnutls-key.pem

@@ -0,0 +1,27 @@
+-----BEGIN RSA PRIVATE KEY-----
+MIIEpAIBAAKCAQEAzG8N4DlzIqX2lcM5DY9uNh0YrRmG0SJ9C2P5cl/sx+X/sEjl
+qJweGJMDj4Q7PYGhlGux6iSX/4hzZ5/FtZADrlCTGR7wUBLznWug2yHQQa24PfA5
+rtzwKCFUClQbWiDnOuiin7jx0o5gjvpLqq2c9x5iqO+IWJgMxH8LtGmv2dGNzaff
+WBAfTnF7M+96IlZ7zaDLodWrwqX5QOqNAHP3RvhK7PXzaR1QrwcyuwdcV4OrMKg+
+Vky92ixl/90+HqdDCMjhT7Attxrulc9Q2zxk1ZGKPYtbe4YuXDal4Zh5ODgDrXXn
+N1wbYiQfHuOZc18nQ2EHtdfXXmFMxozyPszAKQIDAQABAoIBACG9VF9va9qfOcP8
+InmOn08MB0tjnUtSc1Zta2Oz2YV2UU2GrRc3ni9KbXnYBi+U/5YEyNS5XGKpN6QL
+C5t3B2corNZRCQgA0LcS5nXerfB2W3l8IQZZ4sLkw+opI73WFK41ax2MQvuP/Eys
+miSy9DxusIlsGvxwKm9FqSi0kU1pNjxcpQMHk4JLGliOLiFugCUe7CP75LI0i4oT
+5jbsCXvNgpzJ/P2hjzo6LTcpvbKuTZwJbNFPtg16YOGAm+sbom3vpgx36F0a3nqn
+aX2ODPZ13TMkPIbGt2eX7MXUXZrGd4Lnf42YRNemS32LuQJvAv1Ydk2ZCgucgM2f
+qpa//9cCgYEA17qONXG3BLz3YhnTwS3U370Iv4YZiW0F+MQUOvtBuJ1H5ley1vhv
+7FtqLyzkiPrso22mogBdl06iEnAW4ACTF0iVFf86zV6kAu5OCUn/OK6Jq6i6wyK4
+WLQ178sJBfpDPQ9y9a16IJelweE2oOOrQgntdeExhcBgoQueEbDPRmsCgYEA8pi5
+7K8AbPz8yHfjpuG477SkHqyjoBPmf/1bfKm1X4m1mxqOOD1Z+fZl6l46gU06roIu
+mH7uT0MJxINtnAtaHBm2wUu/4lTYfbHl38tpIMOJkFmB8QMLUAaW1JozNGI1105x
+RjCfPpc3jKPx93L9GGYLKlX1BzloSN9qHugg8LsCgYBTRTZ5WLCNiqdu3YtISPmf
+d2c2Dnwy+LtSX9VzQuMGcOd8+SMWKYWCVXLyTMDWQw0utDea1stJiVe0CEI8Ktyc
+Iy8w83juJvbmDrhei4qRhYWslg+pHPDNhJpBOjz8arKjkiAMxu6aQA8CfH1Ksza6
+4fwgAVHNUAm8gDB+oaIQiwKBgQDdsmp+fHMEJrIPtVhKoo7yJ/+vtI8Xc/g6UNtx
+clm4xE09QChmBtMaFm2On6wRi/UrkvZoD99See4MMxtQ9iLT+T/FJ6dke6sYOyHa
+wbYB5g/p5ZJVITYOXOcrxPs0TOftKddkkHyGo4R1N0Gho+jdiit79e+lOXYu2lTN
+h87KjwKBgQCCOgAQ38xWCNOZaQdprijGaP0VVVefj1lKrQQeG+hmiD5YdQdfML+t
+XKnKaBBNVo3wEdSlXIXJs0gD4zN2QTzwk4NTYZX3pzTzX/hpj+A+S3W9x7yRsj0K
+LS4L+gPhPNI/fl/t6s8CPTjx+mDTzyUY/Qlq9H8h8SqkEoMivEB7Pw==
+-----END RSA PRIVATE KEY-----

data/spec/config/ngircd-encrypted-gnutls.conf

@@ -0,0 +1,6 @@
+[Global]
+  Name = irc.the.net
+  Info = Server Info Text
+  SSLPorts = 16697
+  SSLKeyFile = spec/config/gnutls-key.pem
+  SSLCertFile = spec/config/gnutls-cert.pem

data/spec/config/ngircd-encrypted-openssl.conf

@@ -0,0 +1,7 @@
+[Global]
+  Name = irc.the.net
+  Info = Server Info Text
+  SSLPorts = 16697
+  SSLKeyFile = spec/config/openssl-key.pem
+  SSLCertFile = spec/config/openssl-cert.pem
+  SSLKeyFilePassword = asdf

data/spec/config/ngircd-unencrypted.conf

@@ -0,0 +1,5 @@
+[Global]
+	Name = irc.the.net
+	Info = Server Info Text
+	Ports = 16667
+	

data/spec/config/openssl-cert.pem

@@ -0,0 +1,22 @@
+-----BEGIN CERTIFICATE-----
+MIIDmjCCAoKgAwIBAgIJALx9REw11VpDMA0GCSqGSIb3DQEBBQUAMDwxCzAJBgNV
+BAYTAkFVMQowCAYDVQQIFAFcMSEwHwYDVQQKExhJbnRlcm5ldCBXaWRnaXRzIFB0
+eSBMdGQwHhcNMTIwMjExMDY1ODA0WhcNMzkwNjI4MDY1ODA0WjA8MQswCQYDVQQG
+EwJBVTEKMAgGA1UECBQBXDEhMB8GA1UEChMYSW50ZXJuZXQgV2lkZ2l0cyBQdHkg
+THRkMIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEAw6G6SIFPMwPe3mfq
+DmfwCrMYNgPJNeKq/ZENTJpnfLES7OGestfoqtNccNnVhlkBdxBsRJdv0WQVpnLt
+rfCJw/y1928v4HHfJy55Yeap/CLX961LlFo0kbKM2wZnt7y7li2gIUJxhKfY4Jqj
+fp4alAmbWf6I0V3BcStdOjbnDNo1SPkWbpGPbpI/uW2G5u3EbR4elnd5h7NLFHko
+TuZG7z6t7nYXIGQlw2BZULC3Eb7lqR7uEVMDT4fIC09dVcfqRSX/ds571EEZI9W/
+a2BuomsSiuVKoHWpo4ex3W25ENK+XShK/MaLktbe2mOOJUpmgfP/lDrNbgnlh7rP
+y5HDgwIDAQABo4GeMIGbMB0GA1UdDgQWBBRF85veUxti8yTf1qO1z28yL31IcDBs
+BgNVHSMEZTBjgBRF85veUxti8yTf1qO1z28yL31IcKFApD4wPDELMAkGA1UEBhMC
+QVUxCjAIBgNVBAgUAVwxITAfBgNVBAoTGEludGVybmV0IFdpZGdpdHMgUHR5IEx0
+ZIIJALx9REw11VpDMAwGA1UdEwQFMAMBAf8wDQYJKoZIhvcNAQEFBQADggEBAKOs
+xQQY12mnVEy9qGcHhONaCry0RlA9HR4oAU3MMiif8TOSyiruOLzoY78TOUfJVU6T
+r70GjVBtVTr2l1L5NKSXxHEIVBgy5vKQCEjN47MaPrNpDhIBznS5Wgfnr47ybwrR
+BA+Pn2vXLm5BP+7QQwY1LJxnkVTB11ei2x3PZcDyrG8iledFWitVEDZAWf5FXxRl
+avoJrCYZwkyPgbULRfhDb80tJs5Snw1+31xMgPLGWLvfYPraqeLulp12JX8XrYUk
+S+MyuDgxj2F8gaP2ixvHGyV583/EtvSSqUVa+QfSzeqy8Xg5eNzJJUYSApmIEVND
+8HrT37aWv/gsXauXrm8=
+-----END CERTIFICATE-----

data/spec/config/openssl-key.pem

@@ -0,0 +1,30 @@
+-----BEGIN RSA PRIVATE KEY-----
+Proc-Type: 4,ENCRYPTED
+DEK-Info: DES-EDE3-CBC,DC1390A647851FB0
+
+HU95ipOFXkHgGMhgJJU5D519zvX8sT9o0ooSt36a+t4t1yUZ8tJ8czpeup/xjR0K
+ej86uHhNgOjvvAGJ9bIRAgrjmLNqw5HAG017j4bPVKT1UAOtPwPRulC8nmrm8iQb
+bO30ZjC/2w46VvZewipOQTF+8nvrj90ZuiwPGW+JQkMP4PLvfSH38006/OGw5iMI
+lr7BMXmhWg0bw/Ow8kWEVHufUK6RASerb08dwzoxz1z4DT2QbNeaRS6VGoLZ94V/
+oD1f8dR2A5Y513vBROsENbUZibBVhRpPgI3Q+5/SZPilHfXaGUEDFh1umBTcBCPX
+O/zXPMyzrmk5IehdGMq7lFjqK1Betgc0zeWYoB/GLeNZGoP287fTrq1c0Kz9+FcT
+1EpDPjMAgrU16KG5gr7UZ3PZfifJZBzrdF8Ulleju2vb7edYT69D1xruAd+Ih7ge
+AsJmFByQ/++LVidaDTTM/h+ZgVjXuzofLowAXvGr71YKFO7qUTfA/Vq+R08nCYQA
+m5oKr3cXEW1uvjtVxyFk3HLlvgVTveYpSc+yNSCXYT4dT17gEuwg0GU0e2RV5cvQ
+AqSfVj7Gs+sVnrHEbrqFlh2P1l24cEiAY9a+odWFQYN+frbgdqO5JC56AzbV67Ds
+E6H3PSjvm4At3KklSzf8HLAfFZISRZ6kBoF5pRv4f5Np8I/3yrs8QYF7GZ7sY/w4
+EdJHS6GesESpik2PWRYCNfgb7hV893d/pT8W3oRwRQfUjoqIYJfSER+n44gUf7oW
+vj4Z3CPTntwDnqhMcgSg7BWsTI9OLeSPsErSwdKOqXDrnErkVpyRlVR1uJitE4BV
+KDNri7rHxPqR8QmodstBP/eiBYqG27hQIFWXkBvsuZyb8fv3hKfpVUYVRXzQG+r+
+z7VDN05AMAj4iEPh3YAG1cPPYIxaYd/CcmmkIADaCLiLIWPucb0bNJpMlowtMvbc
+zmV10CUofVXpi3lqsIdkrMLYI2dPRx4QF2+COOcngU1PdvY/lTddQh+i6JSRTSKn
+S2pdp+x22/Ipk5IgvxWpmZxTav1SnbZ7k48bZ5MlqQQRNTH0M8j4mhpUUfsup746
+rMo0UbtR/jWAL5dIJzinjupBtdwyyfC5rb23XQeQvLynLW/kqfYUtrt1AkQZDpPV
+aPNMQCqYdC+ly2PuXiXX/0MAE8K0XsgL5Brnui52XXNBnzZLwk4mrUgngKFkaSB6
+nazqLutGw81vYV1TbEcijJMiGBQQaOaii/dSc26NOi/5dIlOlASEyUzjbcE2RX0M
+TsbGYa7cpG1ELzTj5oCTszuTwiOcWg8mZXIrocGJCC6TMsK2p4ptVwQLKLNNhMLy
+CLbIb327a73Pt4sleZ4aVEsc4kwuUjqytoZdWFmTuccV3tJFPgSHpAlQySy3Y0TM
+L6IipocIQqSi+79ymw6FI6D0L2Ka7BDQsfd3pHO0GAFNMO9oye7rhTY9hQJyJNMV
+oq1tBA44VTLbd1zkfIbSUa6GfHuZz6ITJE0+GpI3rfh2qtJFcpeMvOAaZHq/uxBq
+3+yLqxXDAIO0XyBY5R5zExMNkqfrgeDE2dl4rjtn0a8eggwsO5VrBrsr5UkNZ/4o
+-----END RSA PRIVATE KEY-----

data/spec/integration/integration_spec.rb

@@ -0,0 +1,80 @@
+require 'spec_helper'
+
+# add a raw message queue for debugging, might be a good normal feature
+class TestClient < EventMachine::IRC::Client
+  def initialize(options = {})
+    super(options)
+    @received_messages = []
+  end
+
+  def receive_data(data)
+    @received_messages << data
+    super(data)
+  end
+
+  def history
+    "\n" + @received_messages.join("\n") + "\n"
+  end
+end
+
+shared_examples_for "integration" do
+  it 'should work' do
+    dan = client(nick: 'dan')
+    bob = client(nick: 'bob')
+
+    dan.on(:connect) {dan.join('#americano-test')}
+    bob.on(:connect) {bob.join('#americano-test')}
+
+    bob.on(:join) do |who, channel|
+      bob.message(channel, "dan: hello bob")
+      # bob.quit
+      # dan.quit
+    end
+
+    EM.run {
+      dan.connect
+      EM::add_timer(2) {bob.connect}
+      EM::add_timer(5) {EM::stop}
+    }
+
+    # TODO: matchers for commands
+    dan.history.should =~ /Welcome/
+    dan.history.should =~ /JOIN :#americano-test/
+    dan.history.should =~ /dan: hello bob/
+
+    bob.history.should =~ /Welcome/
+    bob.history.should =~ /JOIN :#americano-test/
+  end
+end
+
+# Assumes there is an IRC server running at localhost 6667
+describe EventMachine::IRC::Client, :integration => true do
+  let(:options) do
+    {
+      host: '127.0.0.1',
+      port: '16667'
+    }.merge(@options || {})
+  end
+
+  def client(opts = {})
+    TestClient.new(options.merge(opts))
+  end
+
+  context 'non-ssl' do
+    before :all do
+      raise "unencrypted ircd not on :16667" unless `lsof -i :16667`.chomp.size > 1
+    end
+    it_behaves_like "integration"
+  end
+
+  context 'ssl' do
+    before :all do
+      raise "encrypted ircd not on :16697" unless `lsof -i :16697`.chomp.size > 1
+      @options = {
+        port: '16697',
+        ssl: true
+      }
+    end
+    it_behaves_like "integration"
+  end
+end

data/spec/lib/em-irc/client_spec.rb

@@ -0,0 +1,185 @@
+require 'spec_helper'
+
+describe EventMachine::IRC::Client do
+  context 'configuration' do
+    it 'defaults host to 127.0.0.1' do
+      subject.host.should == '127.0.0.1'
+    end
+
+    it 'defaults realname to random generated name' do
+      subject.realname.should_not be_blank
+    end
+
+    it 'defaults port to 6667' do
+      subject.port.should == '6667'
+    end
+
+    it 'defaults ssl to false' do
+      subject.ssl.should == false
+    end
+
+    it 'defaults channels to an empty set' do
+      subject.channels.should be_empty
+    end
+
+    it 'should not be connected' do
+      subject.should_not be_connected
+    end
+
+    it 'should default a nick' do
+      subject.nick.should_not be_blank
+    end
+
+    it 'should yield self' do
+      client = described_class.new do |c|
+        c.should be_kind_of(described_class)
+      end
+    end
+
+    it 'should allow a custom logger' do
+      subject.logger = Logger.new(STDOUT)
+      subject.logger = nil
+    end
+  end
+
+  context 'connect' do
+    it 'should create an EM TCP connection with host, port, handler, and self' do
+      EventMachine.should_receive(:connect).with('irc.net', '9999', EventMachine::IRC::Dispatcher, parent: subject)
+      subject.host = 'irc.net'
+      subject.port = '9999'
+      subject.connect
+    end
+
+    it 'should be idempotent' do
+      EventMachine.stub(connect: mock('Connection'))
+      EventMachine.should_receive(:connect).exactly(1).times
+      subject.connect
+      subject.connect
+    end
+  end
+
+  context 'send_data' do
+    before do
+      @connection = mock('Connection')
+      subject.stub(conn: @connection)
+      subject.stub(connected?: true)
+    end
+
+    it 'should return false if not connected' do
+      subject.stub(connected?: nil)
+      subject.send_data("NICK jch").should be_false
+    end
+
+    it 'should send message to irc server' do
+      subject.stub(conn: @connection)
+      @connection.should_receive(:send_data).with("NICK jch\r\n")
+      subject.send_data("NICK jch")
+    end
+  end
+
+  context 'ready' do
+    before do
+      subject.stub(conn: mock.as_null_object)
+    end
+
+    it 'should call :connect callback' do
+      m = mock('callback')
+      m.should_receive(:callback)
+      subject.on(:connect) {m.callback}
+      subject.ready
+    end
+
+    it 'should mark client as connected' do
+      subject.ready
+      subject.should be_connected
+    end
+  end
+
+  context 'unbind' do
+    it 'should call :disconnect callback' do
+      m = mock('callback')
+      m.should_receive(:callback)
+      subject.on(:disconnect) {m.callback}
+      subject.unbind
+    end
+  end
+
+  context 'message parsing' do
+    context 'prefix' do
+      it 'should be optional' do
+        parsed = subject.parse_message('NICK jch')
+        parsed[:prefix].should be_nil
+      end
+
+      it 'should start with :' do
+        parsed = subject.parse_message(':jch!host 123 :params')
+        parsed[:prefix].should == 'jch!host'
+      end
+    end
+
+    context 'params' do
+      it 'should remove leading :' do
+        parsed = subject.parse_message('PING :irc.net')
+        parsed[:params] =~ ['irc.net']
+      end
+    end
+  end
+
+  context 'receive_data' do
+    before do
+      subject.stub(:parse_message).and_return(mock.as_null_object)
+      subject.stub(:handle_parsed_message).and_return(mock.as_null_object)
+    end
+
+    it 'should parse messages separated by \r\n' do
+      data = [
+        ":irc.the.net 001 jessie :Welcome to the Internet Relay Network jessie!~jessie@localhost",
+        ":irc.the.net 002 jessie :Your host is irc.the.net, running version ngircd-17.1 (i386/apple/darwin11.2.0)",
+        ":irc.the.net 003 jessie :This server has been started Fri Feb 03 2012 at 14:42:38 (PST)"
+      ].join("\r\n")
+
+      subject.should_receive(:parse_message).exactly(3).times
+      subject.should_receive(:handle_parsed_message).exactly(3).times
+      subject.receive_data(data)
+    end
+
+    it 'should handle parsed messages' do
+    end
+  end
+
+  context 'handle_parsed_message' do
+    it 'should respond to pings' do
+      subject.should_receive(:pong).with("irc.net")
+      subject.handle_parsed_message({prefix: 'irc.net', command: 'PING', params: ['irc.net']})
+    end
+
+    # TODO: do we want a delegate object and callbacks?
+    # it 'should call optional delegate' do
+    #   subject.stub(delegate: mock('Delegate'))
+    #   subject.delegate.should_receive(:message)
+    #   subject.handle_parsed_message({prefix: 'jessie!jessie@localhost', command: 'PRIVMSG', params: ['#general', 'hello world'])
+    # end
+
+    it 'should trigger :raw callbacks' do
+      m = mock('Parsed Response').as_null_object
+      subject.should_receive(:trigger).with(:raw, m)
+      subject.handle_parsed_message(m)
+    end
+  end
+
+  context 'callbacks' do
+    it 'should register multiple' do
+      m = mock('Callback')
+      subject.on(:foo) {m.callback}
+      subject.on(:foo) {m.callback}
+      subject.callbacks[:foo].size.should == 2
+    end
+
+    it 'should trigger with params' do
+      m = mock('Callback')
+      m.should_receive(:callback).with('arg')
+      subject.on(:foo) {|arg| m.callback(arg)}
+      subject.trigger(:foo, 'arg')
+    end
+  end
+end

data/spec/lib/em-irc/dispatcher_spec.rb

@@ -0,0 +1,44 @@
+require 'spec_helper'
+
+shared_examples_for 'dispatcher' do
+  it 'should delegate connection methods to parent' do
+    parent = Class.new do
+      attr_accessor :conn
+      def ssl
+        $ssl
+      end
+
+      def receive_data(data)
+        EventMachine::stop_event_loop
+        raise "Didn't get expected message" unless data == 'message'
+      end
+    end.new
+    parent.should_receive(:ready)
+    parent.should_receive(:unbind)
+    EventMachine.run {
+      EventMachine::start_server('127.0.0.1', '198511', described_class, parent: parent)
+      EventMachine::connect('127.0.0.1', '198511') do |conn|
+        conn.send_data("message")
+      end
+      EventMachine::add_timer(2) {
+        EventMachine::stop_event_loop
+        raise "Never reached receive_data or took too long"
+      }
+    }
+  end
+end
+
+describe EventMachine::IRC::Dispatcher do
+  context 'ssl integration' do
+    before {$ssl = true}
+    it 'behaves like dispatcher' do
+      pending "not sure how to test ssl"
+    end
+    # it_behaves_like "dispatcher"
+  end
+
+  context 'non-ssl integration' do
+    before {$ssl = false}
+    it_behaves_like "dispatcher"
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require File.expand_path '../lib/em-irc', File.dirname(__FILE__)
+Bundler.require :test
+require 'logger'
+
+RSpec.configure do |c|
+end

metadata

@@ -0,0 +1,107 @@
+--- !ruby/object:Gem::Specification
+name: em-irc
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Jerry Cheung
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-02-11 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: eventmachine
+  requirement: &70164206319840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70164206319840
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: &70164206319260 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70164206319260
+description: em-irc is an IRC client that uses EventMachine to handle connections
+  to servers
+email:
+- jch@whatcodecraves.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .rvmrc
+- .travis.yml
+- .yardopts
+- Gemfile
+- Guardfile
+- LICENSE
+- README.md
+- Rakefile
+- em-irc.gemspec
+- examples/logger.rb
+- lib/em-irc.rb
+- lib/em-irc/client.rb
+- lib/em-irc/dispatcher.rb
+- lib/em-irc/version.rb
+- spec/config/gnutls-cert.pem
+- spec/config/gnutls-key.pem
+- spec/config/ngircd-encrypted-gnutls.conf
+- spec/config/ngircd-encrypted-openssl.conf
+- spec/config/ngircd-unencrypted.conf
+- spec/config/openssl-cert.pem
+- spec/config/openssl-key.pem
+- spec/integration/integration_spec.rb
+- spec/lib/em-irc/client_spec.rb
+- spec/lib/em-irc/dispatcher_spec.rb
+- spec/spec_helper.rb
+homepage: http://github.com/jch/em-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.10
+signing_key: 
+specification_version: 3
+summary: em-irc is an IRC client that uses EventMachine to handle connections to servers
+test_files:
+- spec/config/gnutls-cert.pem
+- spec/config/gnutls-key.pem
+- spec/config/ngircd-encrypted-gnutls.conf
+- spec/config/ngircd-encrypted-openssl.conf
+- spec/config/ngircd-unencrypted.conf
+- spec/config/openssl-cert.pem
+- spec/config/openssl-key.pem
+- spec/integration/integration_spec.rb
+- spec/lib/em-irc/client_spec.rb
+- spec/lib/em-irc/dispatcher_spec.rb
+- spec/spec_helper.rb
+has_rdoc: