cinch 0.3.0 → 0.3.1

data/README.rdoc

@@ -42,7 +42,9 @@ It doesn't take much to work out what's happening here, but I'll explain it anyw
 
 First we run the <em>Cinch::setup</em> block which is required in every application. Cinch is boxed
 with a load of default values, so the <b>only</b> option required in this block is the <em>server</em>
-option. We then define a plugin using the <em>plugin</em> method and pass it a rule (a String in this
+option. 
+
+We then define a plugin using the <em>plugin</em> method and pass it a rule (a String in this
 case). Every plugin must be mapped to a rule. When the rule matches an IRC message its block is
 invoked, the contents of which contains your plugin interface. The variable passed to the block is
 an instance of IRC::Message. This provides us with a couple of helper methods which can be used to
@@ -131,7 +133,7 @@ More examples of this can be found in the /examples directory
 Since version 0.2, Cinch supports named parameter patterns. It means stuff like the this works:
 
  bot.plugin("say :n-digit :text") do |m|
-   m.args[:n].to_i.times {
+   m.args[:n].to_i.times do
      m.reply m.args[:text]
    end
  end

data/lib/cinch.rb

@@ -9,11 +9,15 @@ require 'cinch/rules'
 require 'cinch/base'
 
 module Cinch
-  VERSION = '0.3.0'
+  VERSION = '0.3.1'
 
-  # Setup bot options and return a new Cinch::Base instance
-  def self.setup(ops={}, &blk)
-    Cinch::Base.new(ops, &blk)
+  class << self
+
+    # Setup bot options and return a new Cinch::Base instance
+    def setup(ops={}, &blk)
+      Cinch::Base.new(ops, &blk)
+    end
+    alias_method :configure, :setup
   end
 
 end

data/lib/cinch/base.rb

@@ -40,10 +40,11 @@ module Cinch
       :nick => "Cinch",
       :nick_suffix => '_',
       :username => 'cinch',
-      :realname => "Cinch IRC Microframework",
+      :realname => "Cinch IRC Bot Building Framework",
       :prefix => '!',
       :usermode => 0,
-      :password => nil
+      :password => nil,
+      :ssl => false,
     }
 
     # Options can be passed via a hash, a block, or on the instance
@@ -70,6 +71,7 @@ module Cinch
 
       @rules = Rules.new
       @listeners = {}
+      @listeners[:ctcp] = {}
 
       @custom_patterns = {
         'digit' => "(\\d+?)",
@@ -79,7 +81,7 @@ module Cinch
         'lower' => "([a-z]+?)",
       }
 
-      @irc = IRC::Socket.new(options[:server], options[:port])
+      @irc = IRC::Socket.new(options[:server], options[:port], options[:ssl])
       @parser = IRC::Parser.new
 
       # Default listeners
@@ -93,6 +95,8 @@ module Cinch
       if @options.respond_to?(:channels)
         on("004") { @options.channels.each {|c| @irc.join(c) } }
       end
+
+      on(:ctcp, :version) {|m| m.ctcp_reply "Cinch IRC Bot Building Framework v#{Cinch::VERSION}"}
     end
 
     # Parse command line options
@@ -106,6 +110,7 @@ module Cinch
             op.on("-n nick") {|v| options[:nick] = v }
             op.on("-c command_prefix") {|v| options[:prefix] = v }
             op.on("-v", "--verbose", "Enable verbose mode") {|v| options[:verbose] = true }
+            op.on("--ssl") {|v| options[:ssl] = true }
             op.on("-C", "--channels x,y,z", Array, "Autojoin channels") {|v|
               options[:channels] = v.map {|c| %w(# + &).include?(c[0].chr) ? c : c.insert(0, '#') }
             }
@@ -150,11 +155,25 @@ module Cinch
     # String and not Integer. This is because 001.to_s == "1" so the
     # command will not work as expected.
     def on(*commands, &blk)
-      commands.map {|x| x.to_s.downcase.to_sym }.each do |cmd|
-        if @listeners.key?(cmd)
-          @listeners[cmd] << blk
+      if commands.first == :message
+        rule, options = commands[1..2]
+        options = {} unless options.is_a?(Hash)
+        plugin(rule, options, &blk)
+      elsif commands.first == :ctcp
+        action = commands[1]
+
+        if @listeners[:ctcp].key?(action)
+          @listeners[:ctcp][action] << blk
         else
-          @listeners[cmd] = [blk]
+          @listeners[:ctcp][action] = [blk]
+        end
+      else
+        commands.map {|x| x.to_s.downcase.to_sym }.each do |cmd|
+          if @listeners.key?(cmd)
+            @listeners[cmd] << blk
+          else
+            @listeners[cmd] = [blk]
+          end
         end
       end
     end
@@ -263,6 +282,7 @@ module Cinch
         exit
       end
     end
+    alias :start :run
 
     # Process the next line read from the server
     def process(line)
@@ -275,7 +295,15 @@ module Cinch
       @listeners[:any].each { |l| l.call(message) } if @listeners.key?(:any)
 
       if @listeners.key?(message.symbol)
-        @listeners[message.symbol].each {|l| l.call(message) }
+        if message.symbol == :ctcp
+          action = message.ctcp_action.downcase.to_sym
+
+          if @listeners[:ctcp].include?(action)
+            @listeners[:ctcp][action].each {|l| l.call(message) }
+          end
+        else
+          @listeners[message.symbol].each {|l| l.call(message) }
+        end
       end
 
       if [:privmsg].include?(message.symbol)
@@ -295,7 +323,11 @@ module Cinch
                 prefix = rule.options[:prefix]
               end
             else
-              prefix = options.prefix
+              if [:bot, :botnick, options.nick].include? options.prefix
+                prefix = options.nick + "[:,] "
+              else
+                prefix = options.prefix
+              end
             end
           else
             prefix = nil

data/lib/cinch/irc.rb

@@ -2,6 +2,7 @@ lib = File.dirname(__FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 require 'socket'
+require 'timeout'
 
 require 'irc/parser'
 require 'irc/message'

data/lib/cinch/irc/message.rb

@@ -24,7 +24,7 @@ module Cinch
       attr_reader :params
 
       # Message symbol (lowercase command, ie. :privmsg, :join, :kick)
-      attr_reader :symbol
+      attr_accessor :symbol
       
       # The raw string passed to ::new
       attr_reader :raw
@@ -33,7 +33,7 @@ module Cinch
       attr_reader :data
 
       # Message text
-      attr_reader :text
+      attr_accessor :text
 
       # Arguments parsed from a rule
       attr_accessor :args
@@ -103,6 +103,12 @@ module Cinch
         @irc.privmsg(data[:channel], "#{data[:nick]}: #{text}")
       end
 
+      # Send a CTCP reply
+      def ctcp_reply(text)
+        recipient = data[:channel] || data[:nick]
+        @irc.notice(recipient, "\001#{@data[:ctcp_action]} #{text}\001")
+      end
+
       # The deadly /me action
       def action(text)
         reply("\001ACTION #{text}\001")

data/lib/cinch/irc/parser.rb

@@ -49,31 +49,33 @@ module Cinch
       # Set up some default patterns used directly by this class
       def setup_patterns
         add_pattern :letter, /[a-zA-Z]/
-          add_pattern :hex, /[\dA-Fa-f]/
+        add_pattern :hex, /[\dA-Fa-f]/
 
-          add_pattern :ip4addr, /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/
-          add_pattern :ip6addr, /[\dA-Fa-f](?::[\dA-Fa-f]){7}|0:0:0:0:0:(?:0|[Ff]{4}):#{pattern(:ip4addr)}/
-          add_pattern :hostaddr, /#{pattern(:ip4addr)}|#{pattern(:ip6addr)}/
-          add_pattern :shortname, /[A-Za-z0-9][A-Za-z0-9-]*/
-          add_pattern :hostname, /#{pattern(:shortname)}(?:\.#{pattern(:shortname)})*/
-          add_pattern :host, /#{pattern(:hostname)}|#{pattern(:hostaddr)}/
+        add_pattern :ip4addr, /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/
+        add_pattern :ip6addr, /[\dA-Fa-f](?::[\dA-Fa-f]){7}|0:0:0:0:0:(?:0|[Ff]{4}):#{pattern(:ip4addr)}/
+        add_pattern :hostaddr, /#{pattern(:ip4addr)}|#{pattern(:ip6addr)}/
+        add_pattern :shortname, /[A-Za-z0-9][A-Za-z0-9-]*/
+        add_pattern :hostname, /#{pattern(:shortname)}(?:\.#{pattern(:shortname)})*/
+        add_pattern :host, /#{pattern(:hostname)}|#{pattern(:hostaddr)}/
 
-          add_pattern :user, /[^\x00\x10\x0D\x20@]+/
-          add_pattern :nick, /[A-Za-z\[\]\\`_^{|}][A-Za-z\d\[\]\\`_^{|}-]{0,19}/
+        add_pattern :user, /[^\x00\x10\x0D\x20@]+/
+        add_pattern :nick, /[A-Za-z\[\]\\`_^{|}][A-Za-z\d\[\]\\`_^{|}-]{0,19}/
 
-          add_pattern :userhost, /(#{pattern(:nick)})(?:(?:!(#{pattern(:user)}))?@(#{pattern(:host)}))?/
+        add_pattern :ctcp, /\001(\S+)(?:\s([^\x00\r\n\001]+))?\001$/
 
-          add_pattern :channel, /(?:[#+&]|![A-Z\d]{5})[^\x00\x07\x10\x0D\x20,:]/
+        add_pattern :userhost, /(#{pattern(:nick)})(?:(?:!(#{pattern(:user)}))?@(#{pattern(:host)}))?/
 
-          # Server message parsing patterns
-          add_pattern :prefix, /(?:(\S+)\x20)?/
-          add_pattern :command, /([A-Za-z]+|\d{3})/
-          add_pattern :middle, /[^\x00\x20\r\n:][^\x00\x20\r\n]*/
-          add_pattern :trailing, /[^\x00\r\n]*/
-          add_pattern :params, /(?:((?:#{pattern(:middle)}){0,14}(?::?#{pattern(:trailing)})?))/
-          add_pattern :message, /\A#{pattern(:prefix)}#{pattern(:command)}#{pattern(:params)}\Z/
+        add_pattern :channel, /(?:[#+&]|![A-Z\d]{5})[^\x00\x07\x10\x0D\x20,:]/
 
-          add_pattern :params_scan, /(?!:)([^\x00\x20\r\n:]+)|:([^\x00\r\n]*)/
+        # Server message parsing patterns
+        add_pattern :prefix, /(?:(\S+)\x20)?/
+        add_pattern :command, /([A-Za-z]+|\d{3})/
+        add_pattern :middle, /[^\x00\x20\r\n:][^\x00\x20\r\n]*/
+        add_pattern :trailing, /[^\x00\r\n]*/
+        add_pattern :params, /(?:((?:#{pattern(:middle)}){0,14}(?::?#{pattern(:trailing)})?))/
+        add_pattern :message, /\A#{pattern(:prefix)}#{pattern(:command)}#{pattern(:params)}\Z/
+
+        add_pattern :params_scan, /(?!:)([^\x00\x20\r\n:]+)|:([^\x00\r\n]*)/
       end
       private :setup_patterns
 
@@ -101,6 +103,13 @@ module Cinch
           end
         end
 
+        # Parse CTCP response
+        if m.symbol == :privmsg && data = m.text.match(pattern(:ctcp))
+          m.symbol = :ctcp
+          m.text = data[2]
+          m.add(:ctcp_action, data[1])
+        end
+
         m # Return our IRC::Message
       end
 

data/lib/cinch/irc/socket.rb

@@ -49,6 +49,12 @@ module Cinch
       # The TCPSocket instance
       attr_reader :socket
 
+      # How long to wait before aborting a connection
+      attr_accessor :timeout
+
+      # Maximum attempts to retry failed connection
+      attr_accessor :attempts
+
       # Creates a new IRCSocket and automatically connects
       #
       # === Example
@@ -57,7 +63,7 @@ module Cinch
       #  while data = irc.read
       #    puts data
       #  end
-      def self.open(server, port=6667)
+      def self.open(server, port=6667, ssl=false)
         irc = new(server, port)
         irc.connect
         irc
@@ -67,12 +73,15 @@ module Cinch
       # If an optional code block is given, it will be passed an instance of the IRCSocket.
       # NOTE: Using the block form does not mean the socket will send the applicable QUIT
       # command to leave the IRC server. You must send this yourself.
-      def initialize(server, port=6667)
+      def initialize(server, port=6667, ssl=false)
         @server = server
         @port = port
+        @ssl = ssl
 
         @socket = nil
         @connected = false
+        @timeout = 5
+        @attempts = 5
 
         if block_given?
           connect
@@ -88,13 +97,38 @@ module Cinch
       
       # Connect to an IRC server, returns true on a successful connection, or
       # raises otherwise
-      def connect(server=nil, port=nil)
+      def connect(server=nil, port=nil, ssl=false)
         @server = server if server
         @port = port if port
-
-        @socket = TCPSocket.new(@server, @port)
+        @ssl = ssl if ssl
+  
+        Timeout.timeout(@timeout) do
+          socket = TCPSocket.new(@server, @port)
+
+          if @ssl
+            require 'openssl'
+
+            ssl = OpenSSL::SSL::SSLContext.new
+            ssl.verify_mode = OpenSSL::SSL::VERIFY_NONE
+            @socket = OpenSSL::SSL::SSLSocket.new(socket, ssl)
+            @socket.sync = true
+            @socket.connect
+          else
+            @socket = socket
+          end
+        end
+      rescue Timeout::Error
+        if @attempts == 0
+          puts "Maximum attempts reached. Aborting .."
+          exit 1
+        else
+          puts "Connection timed out. Retrying #{@attempts} more time#{'s' unless @attempts == 1} .."
+          @attempts -= 1
+          connect(server, port)
+        end
       rescue Interrupt
-        raise
+        puts "\nAborting connection .."
+        exit
       rescue Exception
         raise
       else

data/spec/base_spec.rb

@@ -28,6 +28,11 @@ describe "Cinch::Base" do
     it "should add a 433 nick taken listener" do
       @base.listeners.should include :'433'
     end
+    
+    it "should add a ctcp version listener" do 
+      @base.listeners.should include :ctcp
+      @base.listeners[:ctcp].should include :version
+    end
 
     it "should add default custom_patterns" do
       [:digit, :word, :string, :upper, :lower].each do |l|

data/spec/irc/parser_spec.rb

@@ -5,11 +5,11 @@ commands = {
   :ping => "PING :foobar",
   :nick => ":foo!~baz@host.com NICK Baz",
   :join => ":foo!~bar@host.com JOIN #baz",
+  :ctcp => ":foo!~bar@host.com PRIVMSG Baz :\001VERSION\001",
 
   :privmsg => {
     "to a channel" => ":foo!~bar@host.com PRIVMSG #baz :hello world",
     "to a user" => ":foo!~bar@host.com PRIVMSG Baz :hello world",
-    "with an action" => ":foo!~bar@host.com PRIVMSG #baz :\001ACTION hello word\001",
   },
 
   :notice => {

data/spec/options_spec.rb

@@ -29,7 +29,7 @@ describe "Cinch::Base options" do
       :nick => 'Cinch',
       :nick_suffix => '_',
       :username => 'cinch',
-      :realname => 'Cinch IRC Microframework',
+      :realname => 'Cinch IRC Bot Building Framework',
       :usermode => 0,
       :prefix => '!',
       :password => nil,

metadata

@@ -1,12 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: cinch
 version: !ruby/object:Gem::Version 
+  hash: 17
   prerelease: false
   segments: 
   - 0
   - 3
-  - 0
-  version: 0.3.0
+  - 1
+  version: 0.3.1
 platform: ruby
 authors: 
 - Lee 'injekt' Jarvis
@@ -14,16 +15,18 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-05-18 00:00:00 +01:00
+date: 2010-05-26 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
   name: rspec
   prerelease: false
   requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
     requirements: 
     - - "="
       - !ruby/object:Gem::Version 
+        hash: 27
         segments: 
         - 1
         - 3
@@ -83,25 +86,29 @@ rdoc_options:
 require_paths: 
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 57
       segments: 
       - 1
       - 8
-      - 6
-      version: 1.8.6
+      - 7
+      version: 1.8.7
 required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
   requirements: 
   - - ">="
     - !ruby/object:Gem::Version 
+      hash: 3
       segments: 
       - 0
       version: "0"
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.6
+rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
 summary: An IRC Bot Building Framework