em-irc 0.0.1 → 0.0.2

data/.gitignore

@@ -15,4 +15,5 @@ spec/reports
 test/tmp
 test/version_tmp
 tmp
-.DS_Store
+.DS_Store
+.rbx

data/.rvmrc

@@ -1 +1 @@
-rvm use 1.9.3
+rvm use 1.9.3@em-irc

data/.travis.yml

@@ -1,6 +1,10 @@
 rvm:
-  - 1.9.2
   - 1.9.3
+  - 1.9.2
+  - 1.8.7
+  - ree
+  - rbx
+  - ruby-head
 bundler_args: --without darwin --without development
 gemfile:
   - Gemfile
@@ -9,4 +13,4 @@ before_script:
   - "service ngircd stop"
   - "ngircd -f spec/config/ngircd-unencrypted.conf"
   - "ngircd -f spec/config/ngircd-encrypted-gnutls.conf"
-script: "bundle exec rake"
+script: "bundle exec rake spec"

data/Gemfile

@@ -4,7 +4,6 @@ source 'http://rubygems.org'
 gemspec
 
 group :development do
-  gem 'pry'
   gem 'yard'
   gem 'redcarpet'
   gem 'guard'
@@ -13,6 +12,7 @@ group :development do
 end
 
 group :development, :test do
+  gem 'pry'
   gem 'rake'
   gem 'rspec', "~> 2"
 end
@@ -20,4 +20,8 @@ end
 group :darwin do
   gem 'rb-fsevent'
   gem 'growl'
+end
+
+platform :ruby_19 do
+  gem 'guard-yard', :group => :development
 end

data/Guardfile

@@ -5,9 +5,16 @@ guard 'bundler' do
   watch('Gemfile')
 end
 
-guard 'rspec', :version => 2 do
+guard 'rspec', :version => 2, :cli => '--tag ~integration' 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
+
+begin
+  guard 'yard', :stdout => '/dev/null' do
+    watch(%r{lib/.+\.rb})
+  end
+rescue => e
 end

data/README.md

@@ -1,6 +1,6 @@
 # EventMachine IRC Client
 
-[CI Build Status](https://secure.travis-ci.org/jch/em-irc.png?branch=master)
+[![Build Status](https://secure.travis-ci.org/jch/em-irc.png?branch=master)](http://travis-ci.org/jch/em-irc)
 
 em-irc is an IRC client that uses EventMachine to handle connections to servers.
 
@@ -9,26 +9,29 @@ em-irc is an IRC client that uses EventMachine to handle connections to servers.
 ````ruby
 require 'em-irc'
 
-client = EventMachine::IRC::Client.new do |c|
-  c.host = 'irc.freenode.net'
-  c.port = '6667'
-  c.nick = 'jch'
+client = EventMachine::IRC::Client.new do
+  host 'irc.freenode.net'
+  port '6667'
+
+  on(:connect) do
+    nick('jch')
+  end
 
-  c.on(:connect) do
+  on(:nick) do
     join('#general')
     join('#private', 'key')
   end
 
-  c.on(:join) do |channel|  # called after joining a channel
+  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
+  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|
+  on(:raw) do |hash|
     puts "#{hash[:prefix]} #{hash[:command]} #{hash[:params].join(' ')}"
   end
 end
@@ -36,21 +39,34 @@ end
 client.run!  # start EventMachine loop
 ````
 
-## Examples
-
-In the examples folder, there are runnable examples.
+Alternatively, if local variable access is needed, the first block variable is
+the client:
 
-* cli.rb - takes input from keyboard, outputs to stdout
-* websocket.rb - 
-* echo.rb - bot that echos everything
-* callback.rb - demonstrate how callbacks work
+````ruby
+client = EventMachine::IRC::Client.new do |c|
+  # c is the client instance
+end
+````
 
 ## References
 
+* [API Documentation](http://rubydoc.info/gems/em-irc/0.0.1/frames)
 * [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
 
+## Platforms
+
+The following platforms are tentatively supported:
+
+* 1.8.7
+* 1.9.2
+* 1.9.3
+* ree
+* Rubinius
+
+I currently develop ruby 1.9.3, so it'll be the VM that gets the most support.
+
 ## Development
 
 To run integration specs, you'll need to run a ssl and a non-ssl irc server locally.
@@ -89,12 +105,4 @@ 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
+THE SOFTWARE.

data/Rakefile

@@ -2,5 +2,13 @@
 require "bundler/gem_tasks"
 Bundler::GemHelper.install_tasks
 require 'rspec/core/rake_task'
-RSpec::Core::RakeTask.new(:spec)
+
+RSpec::Core::RakeTask.new('spec') do |t|
+  t.rspec_opts = '--tag ~integration'
+end
+
+RSpec::Core::RakeTask.new('spec:ci') do |t|
+  t.pattern = 'spec/integration/*_spec.rb'
+end
+
 task :default => :spec

data/lib/em-irc.rb

@@ -4,6 +4,9 @@ Bundler.setup :default
 require 'active_support/core_ext/hash/keys'
 require 'active_support/core_ext/object/blank'
 require 'active_support/callbacks'
+require 'active_support/deprecation'
+require 'active_support/concern'
+require 'active_support/core_ext/array/extract_options'
 require 'eventmachine'
 require 'forwardable'
 require 'set'
@@ -14,5 +17,7 @@ module EventMachine
   module IRC
     autoload :Client,     'em-irc/client'
     autoload :Dispatcher, 'em-irc/dispatcher'
+    autoload :Commands,   'em-irc/commands'
+    autoload :Responses,  'em-irc/responses'
   end
 end

data/lib/em-irc/client.rb

@@ -1,22 +1,35 @@
+require 'support/dsl_accessor'
+
 module EventMachine
   module IRC
     class Client
+      include DslAccessor
+      include IRC::Commands
+      include IRC::Responses
+
       # 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
+      # @macro dsl_accessor
+      #   Accessor for `$1`
+      # Defaults to '127.0.0.1'
+      dsl_accessor :host
+
+      # @macro dsl_accessor
+      # Defaults to '6667'
+      dsl_accessor :port
+
+      # @macro dsl_accessor
+      dsl_accessor :realname
 
-      attr_accessor :nick
-      attr_accessor :realname
-      attr_accessor :ssl
+      # @macro dsl_accessor
+      dsl_accessor :ssl
 
-      # Custom logger
-      attr_accessor :logger
+      # @macro dsl_accessor
+      dsl_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.
@@ -30,29 +43,33 @@ module EventMachine
       # @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}"
+          :host =>     '127.0.0.1',
+          :port =>     '6667',
+          :ssl =>      false,
+          :realname => 'Anonymous Annie'
         }.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?
+
+        if block_given?
+          if blk.arity == 1
+            yield self
+          else
+            instance_eval(&blk)
+          end
+        end
       end
 
       # Creates a Eventmachine TCP connection with :host and :port. It should be called
@@ -60,7 +77,7 @@ module EventMachine
       # @see #on
       # @return [EventMachine::Connection]
       def connect
-        self.conn ||= EventMachine::connect(@host, @port, Dispatcher, parent: self)
+        self.conn ||= EventMachine::connect(@host, @port, Dispatcher, :parent => self, :ssl => @ssl)
       end
 
       # @return [Boolean]
@@ -68,9 +85,22 @@ module EventMachine
         @connected
       end
 
-      # Callbacks
+      # Start running the client
+      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
+
+      # === Callbacks
 
-      # Register a callback with :name as one of the following, and
+      # Register a callback with `:name` as one of the following, and
       # a block with the same number of params.
       #
       # @example
@@ -97,13 +127,20 @@ module EventMachine
       end
 
       # Trigger a named callback
+      # @private
       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
 
+      # @private
+      def log(*args)
+        @logger.log(*args) if @logger
+      end
+
       # Sends raw message to IRC server. Assumes message is correctly formatted
       # TODO: what if connect fails? or disconnects?
+      # @private
       def send_data(message)
         return false unless connected?
         message = message + "\r\n"
@@ -111,82 +148,20 @@ module EventMachine
         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
+      # === EventMachine Callbacks
       # @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)
+          trigger(:raw, parsed)
         end
       end
 
       # @private
       def ready
         @connected = true
-        renick(@nick)
-        user(@nick, '0', @realname)
+        user('guest', '0', @realname)
         trigger(:connect)
       end
 
@@ -195,20 +170,9 @@ module EventMachine
         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
+      protected
+      def channel?(string)
+        !!(string =~ /^(#|&)/)
       end
     end
   end