on_irc 2.0.0

data/.gitignore

@@ -0,0 +1,3 @@
+doc/
+pkg/
+.*.swp

data/LICENSE

@@ -0,0 +1,27 @@
+BSD License
+
+Copyright (c) 2008 Scott Olson
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions
+are met:
+1. Redistributions of source code must retain the above copyright
+   notice, this list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright
+   notice, this list of conditions and the following disclaimer in the
+   documentation and/or other materials provided with the distribution.
+3. The name of the author may not be used to endorse or promote products
+   derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
+IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
+OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
+IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
+INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
+NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
+THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+

data/Rakefile

@@ -0,0 +1,22 @@
+require 'rake'
+
+$LOAD_PATH.unshift('lib')
+
+begin
+  require 'jeweler'
+  Jeweler::Tasks.new do |gemspec|
+    gemspec.name = "on_irc"
+    gemspec.summary = "An event driven IRC library with an easy to use DSL"
+    gemspec.description = "An event driven IRC library with an easy to use DSL"
+    gemspec.email = "scott@scott-olson.org"
+    gemspec.homepage = "http://github.com/tsion/on_irc"
+    gemspec.authors = ["Scott Olson"]
+
+    gemspec.add_dependency "eventmachine"
+  end
+rescue LoadError
+  puts "Jeweler not available. Install it with: sudo gem install jeweler"
+end
+
+Jeweler::GemcutterTasks.new
+

data/VERSION

@@ -0,0 +1 @@
+2.0.0

data/examples/bot.rb

@@ -0,0 +1,49 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), '..', 'lib', 'on_irc')
+
+IRC.configure do
+  nick 'on_irc'
+  ident 'on_irc'
+  realname 'on_irc Ruby IRC library'
+  
+  server :eighthbit do
+    address 'irc.eighthbit.net'
+  end
+  
+  server :freenode do
+    address 'irc.freenode.org'
+  end
+end
+
+
+IRC[:freenode].on :'001' do |e|
+  IRC.send(e.server, :join, '#botters')
+end
+
+IRC[:eighthbit].on :'001' do |e|
+  IRC.send(e.server, :join, '#offtopic')
+end
+
+IRC.on :privmsg do |e|
+  case e.params[1]
+  when '!ping'
+    IRC.send(e.server, :privmsg, e.params[0], e.prefix.split('!').first + ': pong')
+  when /^!echo (.*)/
+    s = $1
+    IRC.send(e.server, :privmsg, e.params[0], e.prefix.split('!').first + ': ' + s)
+  when /^!join (.*)/
+    IRC.send(e.server, :join, $1)
+  end
+end
+
+IRC.on :ping do |e|
+  IRC.send(e.server, :pong, e.params[0])
+end
+
+IRC.on :all do |e|
+  prefix = "(#{e.prefix}) " unless e.prefix.empty?
+  puts "#{e.server}: #{prefix}#{e.command} #{e.params.inspect}"
+end
+
+IRC.connect
+

data/examples/regex_bot.rb

@@ -0,0 +1,98 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), '..', 'lib', 'on_irc')
+
+MAX_BANGS = 3
+CH_USER_MEMORY = {}
+CHANNEL_MEMORY = {}
+
+IRC.configure do
+  nick 'reggie'
+  ident 'reggie'
+  realname 'uses on_irc Ruby IRC library'
+  
+  server :eighthbit do
+    address 'irc.eighthbit.net'
+  end
+  
+#  server :freenode do
+#    address 'irc.freenode.org'
+#  end
+end
+
+IRC[:eighthbit].on :'001' do
+  join '#programming'
+  join '#offtopic'
+end
+
+IRC.on :privmsg do
+  next unless params[0][0,1] == '#' # make sure regex replace only happens in channels
+  channel = params[0]
+  nick = prefix.split('!').first
+  message = params[1]
+
+  CHANNEL_MEMORY[channel] ||= []
+  CH_USER_MEMORY[channel] ||= {}
+  CH_USER_MEMORY[channel][nick] ||= []
+
+  if params[1] =~ %r"^(!*)s/((?:[^\\/]|\\.)*)/((?:[^\\/]|\\.)*)/(?:(\w*))?"
+    bangs   = $1
+    match   = $2
+    replace = $3
+    flags   = $4
+
+    if bangs.length > MAX_BANGS
+      privmsg params[0], "#{nick}: I only support up to #{MAX_BANGS} !'s."
+      privmsg params[0], 'in bed' if rand(1000) == 42
+      next
+    end
+
+    begin
+      match = Regexp.new match
+    rescue RegexpError => err
+      privmsg params[0], "RegexpError: #{err.message}"
+      next
+    end
+
+    target = if bangs.length == 0
+      CHANNEL_MEMORY[channel][1] || ''
+    else
+      CH_USER_MEMORY[channel][nick][-bangs.length] || ''
+    end
+
+    if flags.chars.include? 'g'
+      answer = target.gsub(match, replace)
+    else
+      answer = target.sub(match, replace)
+    end
+
+    if bangs.length > 0 || CHANNEL_MEMORY[channel][0] == nick
+      privmsg(params[0], nick + ' meant: ' + answer)
+    else
+      privmsg(params[0], nick + ' thinks ' + CHANNEL_MEMORY[channel][0] + ' meant: ' + answer)
+    end
+
+  else
+    if message =~ /^\x01(\S+) (.*)\x01$/
+      next unless $1 == 'ACTION'
+
+      message = "* #{nick} #{$2}"
+    end
+
+    CH_USER_MEMORY[channel][nick] << message
+    CH_USER_MEMORY[channel][nick].unshift if CH_USER_MEMORY[channel][nick].length > MAX_BANGS
+
+    CHANNEL_MEMORY[channel] = [nick, message]
+  end
+end
+
+IRC.on :ping do
+  pong params[0]
+end
+
+IRC.on :all do
+  prefix_str = "(#{prefix}) " unless prefix.empty?
+  puts "#{server}: #{prefix_str}#{command} #{params.inspect}"
+end
+
+IRC.connect
+

data/examples/relay.rb

@@ -0,0 +1,47 @@
+#!/usr/bin/env ruby
+require File.join(File.dirname(__FILE__), '..', 'lib', 'on_irc')
+
+IRC.configure do
+  nick 'on_irc-relay'
+  ident 'on_irc'
+  realname 'on_irc Ruby IRC library - relay example'
+  
+  server :eighthbit do
+    address 'irc.eighthbit.net'
+  end
+  
+  server :freenode do
+    address 'irc.freenode.org'
+  end
+end
+
+
+IRC[:freenode].on :'001' do |e|
+  IRC.send(e.server, :join, '#botters')
+end
+
+IRC[:eighthbit].on :'001' do |e|
+  IRC.send(e.server, :join, '#offtopic')
+end
+
+IRC.on :privmsg do |e|
+  case e.params[1]
+  when /^fn> (.*)/
+    msg = $1
+    IRC.send(:freenode, :privmsg, '#botters', "<8b:#{e.prefix.split('!').first}> #{msg}") if e.params[0] == '#offtopic' && e.server == :eighthbit
+  when /^8b> (.*)/
+    msg = $1
+    IRC.send(:eighthbit, :privmsg, '#offtopic', "<fn:#{e.prefix.split('!').first}> #{msg}") if e.params[0] == '#botters' && e.server == :freenode
+  end
+end
+
+IRC.on :ping do |e|
+  IRC.send(e.server, :pong, e.params[0])
+end
+
+IRC.on :all do |e|
+  prefix = "(#{e.prefix}) " unless e.prefix.empty?
+  puts "#{e.server}: #{prefix}#{e.command} #{e.params.inspect}"
+end
+
+IRC.connect

data/lib/on_irc.rb

@@ -0,0 +1,47 @@
+%w[rubygems eventmachine socket strscan].each { |lib| require lib }
+%w[event parser dsl_accessor config_accessor server config connection callback].each do |lib|
+  require File.join(File.dirname(__FILE__), 'on_irc', lib)
+end
+
+module IRC
+  class << self
+    attr_accessor :config, :handlers
+    config_accessor :nick, :ident, :realname, :servers
+    
+    def configure(&block)
+      @config = ConfigDSL.run(&block)
+      @handlers = {}
+    end
+
+    def on(event, &block)
+      @handlers[event.to_s.downcase.to_sym] = Callback.new(block)
+    end
+    
+    def [](server_id)
+      servers[server_id]
+    end
+    
+    def send(server, cmd, *args)
+      cmd = cmd.to_s.upcase
+      args[-1] = ':' + args[-1]
+      IRC[server].connection.command(cmd, *args)
+    end
+
+    def connect
+      EventMachine.run do
+        servers.each do |id, server|
+          server.connection = EM.connect(server.address, server.port, Connection, id)
+        end
+      end
+    end
+
+#   for ssl
+#      require 'openssl'
+#      ssl_context = OpenSSL::SSL::SSLContext.new
+#      ssl_context.verify_mode = OpenSSL::SSL::VERIFY_NONE
+#      @socket = OpenSSL::SSL::SSLSocket.new(socket, ssl_context)
+#      @socket.sync = true
+#      @socket.connect
+  end
+end
+

data/lib/on_irc/callback.rb

@@ -0,0 +1,66 @@
+module IRC
+  class Callback
+    def initialize(block)
+      @block = block
+    end
+
+    def call(event)
+      CallbackDSL.run(event, @block)
+    end
+
+    class CallbackDSL
+      def self.run(event, block)
+        callbackdsl = self.new(event)
+        block.arity < 1 ? callbackdsl.instance_eval(&block) : block.call(callbackdsl)
+      end
+
+      def initialize(event)
+        @event = event
+      end
+
+      # @event accessors
+      def prefix
+        @event.prefix
+      end
+
+      def command
+        @event.command
+      end
+
+      def server
+        @event.server
+      end
+
+      def params
+        @event.params
+      end
+
+      # commands
+      def send(*args)
+        if args[0].is_a?(Symbol) && args[1].is_a?(String)
+          IRC.send(@event.server, *args) # now we don't have to do send(e.server, ...) all the time
+        else
+          IRC.send(*args)
+        end
+      end
+
+      alias raw send
+
+      def privmsg(target, message)
+        send(:privmsg, target, message)
+      end
+
+      alias msg privmsg
+
+      def join(channel)
+        send(:join, channel)
+      end
+
+      def pong(msg)
+        send(:pong, msg)
+      end
+
+    end
+  end
+end
+

data/lib/on_irc/config.rb

@@ -0,0 +1,34 @@
+module IRC  
+  class ConfigError < StandardError; end
+
+  Config = Struct.new(:nick, :ident, :realname, :servers)
+
+  class ConfigDSL
+    dsl_accessor :nick, :ident, :realname
+    attr_accessor :servers
+    
+    def self.run(&block)
+      confdsl = self.new
+      block.arity < 1 ? confdsl.instance_eval(&block) : block.call(confdsl)
+      
+      raise ConfigError, 'no nick' unless confdsl.nick
+      raise ConfigError, 'no servers' unless confdsl.servers
+      
+      conf = Config.new
+      
+      conf.nick = confdsl.nick
+      conf.ident = confdsl.ident || confdsl.nick
+      conf.realname = confdsl.realname || confdsl.nick
+      conf.servers = confdsl.servers
+      
+      conf
+    end
+    
+    def server(id, &block)
+      @servers ||= {}
+      @servers[id] = Server.new Server::ConfigDSL.run(&block)
+      @servers[id]
+    end
+  end
+end
+

data/lib/on_irc/config_accessor.rb

@@ -0,0 +1,17 @@
+# config accessors
+class Module
+  def config_accessor(*symbols)
+    symbols.each do |sym|
+      class_eval %{
+        def #{sym}
+          config.#{sym}
+        end
+        
+        def #{sym}=(val)
+          config.#{sym} = val
+        end
+      }
+    end
+  end
+end
+

data/lib/on_irc/connection.rb

@@ -0,0 +1,52 @@
+module IRC
+  class Connection < EventMachine::Connection
+    include EventMachine::Protocols::LineText2
+    
+    def initialize(server_id)
+      @server = server_id
+    end
+    
+    def config
+      IRC[@server].config
+    end
+    
+    def command(*cmd)
+      send_data(cmd.join(' ') + "\r\n")
+    end
+    
+    def handle_event(event)
+      if IRC[@server].handlers[:all]
+        IRC[@server].handlers[:all].call(event)
+      elsif IRC.handlers[:all]
+        IRC.handlers[:all].call(event)
+      end
+      
+      if IRC[@server].handlers[event.command]
+        IRC[@server].handlers[event.command].call(event)
+      elsif IRC.handlers[event.command]
+        IRC.handlers[event.command].call(event)
+      end
+    end
+    
+    ## EventMachine callbacks
+    def post_init
+      command "USER #{config.ident || IRC.config.ident} * * :#{config.realname || IRC.config.realname}"
+      command "NICK #{config.nick || IRC.config.nick}"
+    end
+    
+    def receive_line(line)
+      parsed_line = Parser.parse(line)
+      event = Event.new(@server, parsed_line[:prefix], parsed_line[:command].downcase.to_sym, parsed_line[:params])
+      
+      handle_event(event)
+    end
+    
+    def unbind
+      EM.add_timer(3) do
+        reconnect(config.address, config.port)
+        post_init
+      end
+    end
+  end
+end
+

data/lib/on_irc/dsl_accessor.rb

@@ -0,0 +1,31 @@
+class Module
+  # taken from http://www.artima.com/rubycs/articles/ruby_as_dsl3.html
+  # used for the IRC.new config DSL
+  def dsl_accessor(*symbols)
+    symbols.each do |sym|
+      class_eval %{
+        def #{sym}(*val)
+          if val.empty?
+            @#{sym}
+          else
+            @#{sym} = val.size == 1 ? val[0] : val
+          end
+        end
+      }
+    end
+  end
+  
+  def bool_dsl_accessor(*symbols)
+    symbols.each do |sym|
+      class_eval %{
+        def #{sym}(val = true)
+          @#{sym} = !!val
+        end
+        
+        def #{sym}?
+          !!@#{sym}
+        end
+      }
+    end
+  end
+end

data/lib/on_irc/event.rb

@@ -0,0 +1,30 @@
+module IRC
+  class Event
+    attr_accessor :server, :prefix, :command, :params
+  
+    def initialize(server, prefix, command, params)
+      @server = server
+      @prefix = prefix
+      @command = command
+      @params = params
+    end
+    
+    
+  end
+end
+
+
+module Kernel
+ # Like instance_eval but allows parameters to be passed.
+  def instance_exec(*args, &block)
+    mname = "__instance_exec_#{Thread.current.object_id.abs}_#{object_id.abs}"
+    Object.class_eval{ define_method(mname, &block) }
+    begin
+      ret = send(mname, *args)
+    ensure
+      Object.class_eval{ undef_method(mname) } rescue nil
+    end
+    ret
+  end
+end
+

data/lib/on_irc/parser.rb

@@ -0,0 +1,33 @@
+module IRC
+  module Parser  
+    def self.parse(line)      
+      prefix = ''
+      command = ''
+      params = []
+      msg = StringScanner.new(line)
+      
+      if msg.peek(1) == ':'
+        msg.pos += 1
+        prefix = msg.scan /\S+/
+        msg.skip /\s+/
+      end
+      
+      command = msg.scan /\S+/
+      
+      until msg.eos?
+        msg.skip /\s+/
+        
+        if msg.peek(1) == ':'
+          msg.pos += 1
+          params << msg.rest
+          msg.terminate
+        else
+          params << msg.scan(/\S+/)
+        end
+      end
+      
+      {:prefix => prefix, :command => command, :params => params}
+    end
+  end
+end
+

data/lib/on_irc/server.rb

@@ -0,0 +1,41 @@
+module IRC
+  class Server
+    attr_accessor :config, :connection, :handlers
+    config_accessor :address, :port, :nick, :ident, :realname, :ssl
+    
+    def initialize(config)
+      @config = config
+      @handlers = {}
+    end
+    
+    def on(event, &block)
+      @handlers[event.to_s.downcase.to_sym] = Callback.new(block)
+    end
+    
+    Config = Struct.new(:address, :port, :nick, :ident, :realname, :ssl)
+    
+    class ConfigDSL
+      dsl_accessor :address, :port, :nick, :ident, :realname
+      bool_dsl_accessor :ssl
+      
+      def self.run(&block)
+        confdsl = self.new
+        block.arity < 1 ? confdsl.instance_eval(&block) : block.call(confdsl)
+        
+        raise ConfigError, 'no address' unless confdsl.address
+        
+        conf = Config.new
+        
+        conf.address = confdsl.address
+        # If not supplied, the port defaults to 6667, or 6697 if ssl is used
+        conf.port = confdsl.port || (confdsl.ssl? ? 6697 : 6667)
+        conf.ssl = confdsl.ssl?
+        conf.nick = confdsl.nick
+        conf.ident = confdsl.ident
+        conf.realname = confdsl.realname
+        
+        conf
+      end
+    end
+  end
+end

data/on_irc.gemspec

@@ -0,0 +1,61 @@
+# Generated by jeweler
+# DO NOT EDIT THIS FILE DIRECTLY
+# Instead, edit Jeweler::Tasks in Rakefile, and run the gemspec command
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{on_irc}
+  s.version = "2.0.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Scott Olson"]
+  s.date = %q{2009-12-13}
+  s.description = %q{An event driven IRC library with an easy to use DSL}
+  s.email = %q{scott@scott-olson.org}
+  s.extra_rdoc_files = [
+    "LICENSE"
+  ]
+  s.files = [
+    ".gitignore",
+     "LICENSE",
+     "Rakefile",
+     "VERSION",
+     "examples/bot.rb",
+     "examples/regex_bot.rb",
+     "examples/relay.rb",
+     "lib/on_irc.rb",
+     "lib/on_irc/callback.rb",
+     "lib/on_irc/config.rb",
+     "lib/on_irc/config_accessor.rb",
+     "lib/on_irc/connection.rb",
+     "lib/on_irc/dsl_accessor.rb",
+     "lib/on_irc/event.rb",
+     "lib/on_irc/parser.rb",
+     "lib/on_irc/server.rb",
+     "on_irc.gemspec"
+  ]
+  s.homepage = %q{http://github.com/tsion/on_irc}
+  s.rdoc_options = ["--charset=UTF-8"]
+  s.require_paths = ["lib"]
+  s.rubygems_version = %q{1.3.5}
+  s.summary = %q{An event driven IRC library with an easy to use DSL}
+  s.test_files = [
+    "examples/regex_bot.rb",
+     "examples/relay.rb",
+     "examples/bot.rb"
+  ]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
+      s.add_runtime_dependency(%q<eventmachine>, [">= 0"])
+    else
+      s.add_dependency(%q<eventmachine>, [">= 0"])
+    end
+  else
+    s.add_dependency(%q<eventmachine>, [">= 0"])
+  end
+end
+

metadata

@@ -0,0 +1,82 @@
+--- !ruby/object:Gem::Specification 
+name: on_irc
+version: !ruby/object:Gem::Version 
+  version: 2.0.0
+platform: ruby
+authors: 
+- Scott Olson
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2009-12-13 00:00:00 -06:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: eventmachine
+  type: :runtime
+  version_requirement: 
+  version_requirements: !ruby/object:Gem::Requirement 
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        version: "0"
+    version: 
+description: An event driven IRC library with an easy to use DSL
+email: scott@scott-olson.org
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE
+files: 
+- .gitignore
+- LICENSE
+- Rakefile
+- VERSION
+- examples/bot.rb
+- examples/regex_bot.rb
+- examples/relay.rb
+- lib/on_irc.rb
+- lib/on_irc/callback.rb
+- lib/on_irc/config.rb
+- lib/on_irc/config_accessor.rb
+- lib/on_irc/connection.rb
+- lib/on_irc/dsl_accessor.rb
+- lib/on_irc/event.rb
+- lib/on_irc/parser.rb
+- lib/on_irc/server.rb
+- on_irc.gemspec
+has_rdoc: true
+homepage: http://github.com/tsion/on_irc
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --charset=UTF-8
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+  version: 
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.5
+signing_key: 
+specification_version: 3
+summary: An event driven IRC library with an easy to use DSL
+test_files: 
+- examples/regex_bot.rb
+- examples/relay.rb
+- examples/bot.rb