blur 1.7.3 → 1.8.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a2633b6b5cc955fba7d379cdfd86f6fbfb3b954f
-  data.tar.gz: 86c7b5cedbf4ee9f97efd65580b0b00f8bb59f39
+  metadata.gz: 0fd33b08ea566e3cf592a64b5ecaa68e28bf3715
+  data.tar.gz: 0780c217f54c21a06ba911d178e0323f822ef310
 SHA512:
-  metadata.gz: bd6a9bd936e44ed4b834b83d1a45d1e1c1c7a330491a2302ac9930f6142ceff32117b29fbe8a71267a7c79305b284d3997c3995da85b945c420e6347dfe33823
-  data.tar.gz: 4c0164dc24f398b4fa0fef4fee3351e1a81158da73cfa478a7b91772b0579a5f1f301c45e9e695c88236d4772a7a808028933b785f6c18ac3185f081d063c53a
+  metadata.gz: a7a072a647cf7e8804991dde2b0c82173cfc0931188a46298c5e8b4441ebad34da61cdd160d987123c921da3aaf5c62790cdbac8dd464e9c93a86bc1e5055945
+  data.tar.gz: 741af149e93c26ade44f8b177d1466c5cc6960187a2c22d971343d7d69d7dc922e013e4a050d66a71cac5745b5b385e9664089af5f9bd63f7ea1dce20fa6fe96

data/.yardopts

@@ -0,0 +1,5 @@
+--output-dir documentation/
+--readme README.md
+--title Blur
+--protected
+library/**/*.rb

data/LICENSE

@@ -0,0 +1,13 @@
+Copyright (c) 2014, Mikkel Kroman
+
+Permission to use, copy, modify, and/or distribute this software for any
+purpose with or without fee is hereby granted, provided that the above
+copyright notice and this permission notice appear in all copies.
+
+THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

data/README.md

@@ -0,0 +1,35 @@
+Blur
+====
+Blur is an event-driven IRC-framework written in and for Ruby.
+
+There are a bunch of other well-written, well-running IRC libraries made for
+Ruby, but for me, they don't quite cut it as **the** library I wanted to use for
+my IRC services. That's how Blur came to be.
+
+Blur scales. A lot.
+
+When I stresstested the library on my network, I ended up throttling my VDSL
+connection before Blur even broke a sweat - albeit I only have 20/2.
+
+I managed to connect with 5000 clones before it couldn't resolve the hostname
+anymore, while this is an excellent feature, I would not suggest doing it.
+
+[![Bitdeli Badge](https://d2weczhvl823v0.cloudfront.net/mkroman/blur/trend.png)](https://bitdeli.com/free "Bitdeli Badge")
+[![Build Status](https://travis-ci.org/mkroman/blur.svg?branch=isupport)](https://travis-ci.org/mkroman/blur)
+[![Dependency Status](https://gemnasium.com/mkroman/blur.svg)](https://gemnasium.com/mkroman/blur)
+
+Features
+--------
+  * SSL/TLS encryption
+  * Connect to multiple networks
+  * FiSH (channel-wide) encryptions
+  * Non-blocking connections (no threading)
+  * Extensible with scripts, (re)loadable during runtime
+  * Modular, makes it a piece of cake to extend its IRC-capability
+
+Future Plans
+------------
+  * DCC File-transfers
+  * DH1080 Key-Exchange
+  * ISupport implementation
+  * Better event-handling in scripts

data/library/blur.rb

@@ -9,27 +9,28 @@ require 'openssl'
 require 'eventmachine'
 
 # Require all library files.
+require 'blur/version'
 require 'blur/client'
+require 'blur/evaluable'
+require 'blur/script/dsl'
+require 'blur/extension'
 require 'blur/script'
 require 'blur/network'
 require 'blur/encryption'
 require 'blur/enhancements'
 require 'blur/script/cache'
 require 'blur/network/user'
-require 'blur/script/fantasy'
 require 'blur/network/channel'
 require 'blur/network/command'
+require 'blur/network/isupport'
 require 'blur/network/connection'
-require 'blur/script/messageparsing'
+require 'blur/script/commands'
 
 # Blur is a very modular IRC-framework for ruby.
 #
 # It allows the developer to extend it in multiple ways.
 # It can be by handlers, scripts, communications, and what have you.
 module Blur
-  # The major and minor version-values of Blur.
-  Version = "1.7.3"
-
   # Instantiates a client with given options and then makes the client instance
   # evaluate the given block to form a DSL.
   #

data/library/blur/client.rb

@@ -33,8 +33,6 @@ module Blur
       
       load_scripts
       trap 2, &method(:quit)
-
-      EventMachine.threadpool_size = 1
     end
     
     # Connect to each network available that is not already connected, then
@@ -43,12 +41,12 @@ module Blur
       networks = @networks.select {|network| not network.connected? }
       
       EventMachine.run do
+        EventMachine.error_handler{|e| p e }
+
         networks.each do |network|
           network.delegate = self
           network.connect
         end
-
-        EventMachine.error_handler{|e| p e }
       end
     end
     
@@ -69,6 +67,10 @@ module Blur
     
     # Searches for scripts in working_directory/scripts and then loads them.
     def load_scripts
+      # Load script extensions.
+      Script.load_extensions!
+
+      # Load the scripts.
       script_path = File.dirname $0
       
       Dir.glob("#{script_path}/scripts/*.rb").each do |path|
@@ -83,6 +85,9 @@ module Blur
     #
     # @see Script#unload!
     def unload_scripts
+      # Unload script extensions.
+      Script.unload_extensions!
+
       @scripts.each do |script|
         script.unload!
       end.clear
@@ -98,13 +103,13 @@ module Blur
     #
     # @param [optional, Symbol] signal The signal received by the system, if any.
     def quit signal = :SIGINT
+      unload_scripts
+      
       @networks.each do |network|
         network.transmit :QUIT, "Got SIGINT?"
         network.disconnect
       end
       
-      unload_scripts
-      
       EventMachine.stop
     end
     
@@ -119,16 +124,21 @@ module Blur
     def emit name, *args
       EM.defer do
         @callbacks[name].each do |callback|
-          callback.call *args
+          begin
+            callback.call *args
+          rescue Exception => e
+            log.error "Callback `#{name}' threw an exception - #{exception.message ^ :bold} on line #{exception.line.to_s ^ :bold}"
+            puts exception.backtrace.join "\n"
+          end
         end if @callbacks[name]
 
         scripts = @scripts.select{|script| script.__emissions.include? name }
-        
         scripts.each do |script|
           begin
             script.__send__ name, *args
           rescue Exception => exception
             log.error "#{File.basename(script.__path) << " - " << exception.message ^ :bold} on line #{exception.line.to_s ^ :bold}"
+            puts exception.backtrace.join "\n"
           end
         end
       end

data/library/blur/enhancements.rb

@@ -11,7 +11,9 @@ class Exception
   #
   # @return Fixnum the line of the script the exception was raised on.
   def line
-    backtrace[0].match(Pattern)[1].to_i + 1
+    if result = backtrace[0].match(Pattern)
+      result[1].to_i + 1
+    end
   end
 end
 

data/library/blur/evaluable.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Blur
+  module Evaluable
+    # Evaluate the contents of the input file in the context of +self+.
+    def evaluate_source_file path
+      instance_eval File.read(path), File.basename(path), 0
+      @__evaluated = true
+    rescue Exception => exception
+      puts "#{exception.message ^ :bold} on line #{exception.line.to_s ^ :bold}"
+    end
+  end
+end

data/library/blur/extension.rb

@@ -0,0 +1,42 @@
+# encoding: utf-8
+
+module Blur
+  # +Extension+ provides a sort of modules for scripts, for common functionality.
+  #
+  # Think of it as a kind of scripts for scripts.
+  class Extension
+    include Evaluable
+    include Script::DSL
+    include Logging
+
+    # @return the path in which the script remains.
+    attr_accessor :__path
+    # Can be used inside the script to act with the client itself.
+    # @return [Network::Client] the client delegate.
+    attr_accessor :__client
+
+    # Instantiates a new extension context and evaluates the +path+ extension
+    # file.
+    def initialize path
+      @__path = path
+
+      if evaluate_source_file path
+        log.info "Loaded extension #{@__path}"
+      end
+    end
+
+    # Purely for DSL purposes.
+    #
+    # @example
+    #   Extension :http do
+    #     …
+    #   end
+    def Extension name, &block
+      @__name = name
+      
+      instance_eval &block
+      
+      true
+    end
+  end
+end

data/library/blur/handling.rb

@@ -47,24 +47,24 @@ module Blur
       # Called when the namelist of a channel was received.
       def got_name_reply network, command
         name  = command[2]
-        users = command[3].split.map &Network::User.method(:new)
+        users = command[3].split.map do |nick|
+          # Slice the nick if the first character is a user mode prefix.
+          if network.user_prefixes.include? nick.chr
+            nick.slice! 0
+          end
+
+          Network::User.new nick
+        end
         
-        if channel = network.channel_by_name(name)
+        if channel = find_or_create_channel(name, network)
           users.each do |user|
             user.channel = channel
             user.network = network
 
             channel.users << user
           end
-        else
-          channel = Network::Channel.new name, network, users
 
-          if network.fish? and network.options[:fish].key? name
-            keyphrase = network.options[:fish][name]
-            channel.encryption = Encryption::FiSH.new keyphrase
-          end
-
-          network.channels << channel
+          emit :channel_who_reply, channel
         end
       end
       
@@ -75,21 +75,10 @@ module Blur
       def got_channel_topic network, command
         me, name, topic = command.params
         
-        if channel = network.channel_by_name(name)
+        if channel = find_or_create_channel(name, network)
           emit :topic_change, channel, topic
-          channel.topic = topic
-        else          
-          channel = Network::Channel.new name, network, []
 
-          if network.fish? and network.options[:fish].key? name
-            keyphrase = network.options[:fish][name]
-            channel.encryption = Encryption::FiSH.new keyphrase
-          end
-          
-          emit :topic_change, channel, topic
           channel.topic = topic
-          
-          network.channels << channel
         end
       end
       
@@ -101,15 +90,14 @@ module Blur
       # Called when a user changed nickname.
       #
       # == Callbacks:
-      # Emits :user_rename with the parameters +channel+, +user+ and +nickname+ 
-      # where +nickname+ is the new name.
+      # Emits :user_rename with the parameters +channel+, +user+, +old_nick and +new_nick+ 
       def got_nick network, command
         nick = command.sender.nickname
         
         if channels = network.channels_with_user(nick)
           channels.each do |channel|
             if user = channel.user_by_nick(nick)
-              emit :user_rename, channel, user, command[0]
+              emit :user_rename, channel, user, user.nick, command[0]
               user.nick = command[0]
             end
           end
@@ -268,20 +256,47 @@ module Blur
             end
 
             if user = channel.user_by_nick(nick)
-              emit :user_mode, user, modes
               user.merge_modes modes
+              emit :user_mode, user, modes
             end
           else
-            emit :channel_mode, channel, modes
             channel.merge_modes modes
+            emit :channel_mode, channel, modes
           end
         end
       end
 
+      # Called when the network announces its ISUPPORT parameters.
+      def got_005 network, command
+        params = command.params[1..-2]
+
+        network.isupport.parse *params
+      end
+
       alias_method :got_353, :got_name_reply
       alias_method :got_422, :got_end_of_motd
       alias_method :got_376, :got_end_of_motd
       alias_method :got_332, :got_channel_topic
+
+    private
+
+      def find_or_create_channel name, network, users = []
+        channel = network.channel_by_name name
+
+        if channel.nil?
+          channel = Network::Channel.new name, network, users
+          network.channels << channel
+
+          if network.fish? and network.options[:fish].key? name
+            keyphrase = network.options[:fish][name]
+            channel.encryption = Encryption::FiSH.new keyphrase
+          end
+
+          emit :channel_created, channel
+        end
+
+        channel
+      end
     end
   end
 end

data/library/blur/network.rb

@@ -21,6 +21,8 @@ module Blur
     attr_accessor :delegate
     # @return [Network::Connection] the connection instance.
     attr_accessor :connection
+    # @return [Network::ISupport] the network isupport specs.
+    attr_accessor :isupport
 
     # Check whether or not connection is established.
     def connected?; @connection and @connection.established? end
@@ -45,17 +47,31 @@ module Blur
 
     # Instantiates the network.
     #
-    # @param [Hash] options the network options.
-    # @option options [String] :hostname the remote hostname.
-    # @option options [String] :nickname the nickname to represent.
-    # @option options [optional, String] :username the username to represent.
-    # @option options [optional, String] :realname the “real name” to represent.
-    # @option options [optional, String] :password the password for the network.
-    # @option options [optional, Fixnum] :port the remote port.
-    # @option options [optional, Boolean] :secure use a secure connection.
+    # @param [Hash] options The network options.
+    # @option options [String] :hostname The hostname or IP-address we want to
+    #   connect to.
+    # @option options [String] :nickname The nickname to use.
+    # @option options [optional, String] :username (Copies :nickname)
+    #   The username to use. This is also known as the ident.
+    # @option options [optional, String] :realname (Copies :username)
+    #   The “real name” that we want to use. This is usually what shows up
+    #   as "Name" when you whois a user.
+    # @option options [optional, String] :password The password for the network.
+    #   This is sometimes needed for private networks.
+    # @option options [optional, Fixnum] :port (6697 if ssl, otherwise 6667) 
+    #   The remote port we want to connect to.
+    # @option options [optional, Boolean] :secure Set whether this is a secure
+    #   (SSL-encrypted) connection.
+    # @option options [optional, String] :ssl_cert_file Local path of a
+    #   readable file that contains a X509 CA certificate to validate against.
+    # @option options [optional, String] :ssl_fingerprint Validate that the 
+    #   remote certificate matches the specified fingerprint.
+    # @option options [optional, Boolean] :ssl_no_verify Disable verification
+    #   alltogether.
     def initialize options
       @options  = options
       @channels = []
+      @isupport = ISupport.new self
       
       unless options[:nickname]
         raise ArgumentError, "nickname is missing from the networks option block"
@@ -100,6 +116,27 @@ module Blur
       @channels.select { |channel| channel.user_by_nick nick }
     end
 
+    # Returns a list of user prefixes that a nick might contain.
+    #
+    # @return [Array<String>] a list of user prefixes.
+    def user_prefixes
+      isupport["PREFIX"].values
+    end
+
+    # Returns a list of user modes that also gives a users nick a prefix.
+    #
+    # @return [Array<String>] a list of user modes.
+    def user_prefix_modes
+      isupport["PREFIX"].keys
+    end
+
+    # Returns a list of channel flags (channel mode D).
+    #
+    # @return [Array<String>] a list of channel flags.
+    def channel_flags
+      isupport["CHANMODES"]["D"]
+    end
+
     # Attempt to establish a connection and send initial data.
     #
     # @see Connection
@@ -137,6 +174,7 @@ module Blur
       
       @connection.send_data "#{command}\r\n"
     end
+
     
     # Convert it to a debug-friendly format.
     def to_s

data/library/blur/network/connection.rb

@@ -11,6 +11,8 @@ module Blur
     # @see EventMachine::Protocols::LineAndTextProtocol
     # @see EventMachine::Connection
     class Connection < EM::Protocols::LineAndTextProtocol
+      SSLValidationError = Class.new StandardError
+
       # Check whether or not connection is established.
       def established?; @connected == true end
 
@@ -26,13 +28,18 @@ module Blur
       # Called when a new connection is being set up, all we're going to use
       # it for is to enable SSL/TLS on our connection.
       def post_init
-        start_tls if @network.secure?
+        if @network.secure?
+          verify_peer = (@network.options[:ssl_no_verify] ? false : true)
+
+          start_tls verify_peer: verify_peer
+        end
       end
 
       # Called when a line was received, the connection sends it to the network
       # delegate which then sends it to the client.
       def receive_line line
         command = Command.parse line
+
         @network.got_command command
       end
 
@@ -44,9 +51,56 @@ module Blur
         connected!
       end
 
+      # Validates that the peer certificate has the correct fingerprint as
+      # specified in the :fingerprint :ssl option.
+      #
+      # @note This doesn't support intermediate certificate authorities!
+      # @raise [SSLValidationError] Raised if the specified fingerprint doesn't
+      # match the certificates.
+      def ssl_verify_peer peer_cert
+        ssl_cert_file    = @network.options[:ssl_cert_file]
+        peer_certificate = OpenSSL::X509::Certificate.new peer_cert
+
+        if ssl_cert_file
+          unless File.readable? ssl_cert_file
+            raise SSLValidationError, "Could not read the CA certificate file."
+
+            return false
+          end
+        end
+
+        if fingerprint_verification?
+          fingerprint = @network.options[:ssl_fingerprint].to_s
+          peer_fingerprint = cert_sha1_fingerprint peer_certificate
+
+          if fingerprint != peer_fingerprint
+            raise SSLValidationError,
+              "Expected fingerprint '#{fingerprint}', but got '#{peer_fingerprint}'"
+
+            return false
+          end
+        end
+
+        if certificate_verification?
+          ca_certificate = OpenSSL::X509::Certificate.new File.read ssl_cert_file
+          valid_signature = peer_certificate.verify ca_certificate.public_key
+
+          if not valid_signature
+            raise SSLValidationError, "Certificate verify failed"
+
+            return false
+          end
+        end
+
+        true
+      end
+
       # Called once the connection is finally established.
       def connection_completed
-        @network.connected! unless @network.secure?
+        # We aren't completely connected yet if the connection is encrypted.
+        unless @network.secure?
+          connected!
+        end
       end
 
       # Called just as the connection is being terminated, either by remote or
@@ -65,6 +119,33 @@ module Blur
 
         @network.connected!
       end
+
+      # Returns true if we're expected to verify the certificate fingerprint.
+      def fingerprint_verification?
+        not @network.options[:ssl_fingerprint].nil?
+      end
+
+      # Returns true if we should verify the peer certificate.
+      def certificate_verification?
+        not @network.options[:ssl_cert_file].nil?
+      end
+
+      # Get the hexadecimal representation of the certificates public key.
+      def cert_sha1_fingerprint certificate
+        fingerprint = OpenSSL::Digest::SHA1.hexdigest certificate.to_der
+
+        # Format it the same way OpenSSL does.
+        fingerprint = fingerprint.chars.each_slice(2).map(&:join).join ':'
+        fingerprint.upcase
+      end
+
+      def ssl_fingerprint_error! peer_fingerprint
+        fingerprint = @network.options[:ssl_fingerprint]
+
+        raise SSLValidationError,
+          "Expected fingerprint '#{fingerprint}' but got '#{peer_fingerprint}'"
+      end
+
     end
   end
 end

data/library/blur/network/isupport.rb

@@ -0,0 +1,133 @@
+# encoding: utf-8
+
+module Blur
+  class Network
+    # ISupport class that enables servers to announce what they support.
+    # 
+    # @see https://tools.ietf.org/html/draft-brocklesby-irc-isupport-03
+    class ISupport < Hash
+      # Return the network reference.
+      attr_accessor :network
+
+      # ISUPPORT parameters which should always be casted to numeric values.
+      NumericParams = %w[CHANNELLEN MODES NICKLEN KICKLEN TOPICLEN AWAYLEN
+        MAXCHANNELS MAXBANS MAXPARA MAXTARGETS].freeze
+
+      # Our parsers for parameters that require special treatment.
+      Parsers = {
+        # CHANLIMIT=pfx:num[,pfx:num,...]
+        #
+        # This parameter specifies the maximum number of channels that a client
+        # may join.  The value is a series of "pfx:num" pairs, where 'pfx'
+        # refers to one or more channel prefix characters (as specified in
+        # CHANTYPES), and 'num' indicates how many of these types of channel
+        # the client may join in total. If there is no limit to the number of
+        # certain channel type(s) a client may join, the limit should be
+        # specified as the empty string, for example "#:".
+        %w[CHANLIMIT] => -> (value) do
+          Hash.new.tap do |result|
+            params = value.split ?,
+            mappings = params.map{|param| param.split ?: }
+
+            mappings.each do |prefixes, limit|
+              prefixes.each_char do |prefix|
+                result[prefix] = limit ? limit.to_i : Float::INFINITY
+              end
+            end
+          end
+        end,
+
+        # PREFIX=[(modes)prefixes]
+        #
+        #
+        # The PREFIX parameter specifies a list of channel status flags (the
+        # "modes" section) that clients may have on channels, followed by a
+        # mapping to the equivalent channel status flags ("prefixes"), which
+        # are used in NAMES and WHO replies.  There is a one to one mapping
+        # between each mode and prefix.
+        #
+        # The order of the modes is from that which gives most privileges on
+        #  the channel, to that which gives the least.
+        %w[PREFIX] => -> (value) do
+          Hash.new.tap do |result|
+            if value =~ /^\((.+)\)(.*)/
+              modes, prefix = $~[1..2]
+
+              modes.chars.each_with_index do |char, index|
+                result[char] = prefix[index]
+              end
+            end
+          end
+        end,
+
+        # CHANMODES=A,B,C,D
+        #
+        # The CHANMODES token specifies the modes that may be set on a channel.
+        # These modes are split into four categories, as follows:
+        #
+        # o  Type A: Modes that add or remove an address to or from a list.
+        #    These modes always take a parameter when sent by the server to a
+        #    client; when sent by a client, they may be specified without a
+        #    parameter, which requests the server to display the current
+        #    contents of the corresponding list on the channel to the client.
+        # o  Type B: Modes that change a setting on the channel.  These modes
+        #    always take a parameter.
+        # o  Type C: Modes that change a setting on the channel. These modes
+        #    take a parameter only when set; the parameter is absent when the
+        #    mode is removed both in the client's and server's MODE command.
+        # o  Type D: Modes that change a setting on the channel. These modes
+        #    never take a parameter.
+        %w[CHANMODES] => -> (value) do
+          Hash.new.tap do |r|
+            r["A"], r["B"], r["C"], r["D"] = value.split(?,).map &:chars
+          end
+        end,
+
+        # Cast known params that are numeric, to a numeric value.
+        NumericParams => -> (value) do
+          value.to_i
+        end
+      }
+
+      # Initialize a new ISupport with a network reference.
+      # 
+      # @param network [Network] The parent network.
+      def initialize network
+        @network = network
+
+        # Set default ISUPPORT values.
+        #
+        # @see
+        # https://tools.ietf.org/html/draft-brocklesby-irc-isupport-03#appendix-A
+        self["MODES"]       = 3
+        self["PREFIX"]      = { "o" => "@", "v" => "+" }
+        self["KICKLEN"]     = 200
+        self["NICKLEN"]     = 9
+        self["MAXLIST"]     = { "#" => Float::INFINITY, "&" => Float::INFINITY }
+        self['TOPICLEN']    = 200
+        self["CHANMODES"]   = {}
+        self["CHANTYPES"]   = %w{# &}
+        self["CHANLIMIT"]   = { "#" => Float::INFINITY, "&" => Float::INFINITY }
+        self["CHANNELLEN"]  = 200
+        self["CASEMAPPING"] = "rfc1459"
+      end
+
+      # Parse a list of parameters to see what the server supports.
+      #
+      # @param parameters [Array] The list of parameters.
+      def parse *params
+        params.each do |parameter|
+          name, value = parameter.split ?=
+
+          if value
+            _, parser = Parsers.find{|key, value| key.include? name }
+
+            self[name] = parser.nil? ? value : parser.(value)
+          else
+            self[name] = true
+          end
+        end
+      end
+    end
+  end
+end

data/library/blur/script.rb

@@ -8,19 +8,17 @@ module Blur
   #
   # @todo add examples in the documentation
   # @see Script#Script
-  class Script < Module
+  class Script
     include Logging
+    include Evaluable
+    include DSL
 
+    ExtensionNotFoundError = Class.new StandardError
     Emissions = [:connection_ready, :topic_change, :user_rename, :message,
                  :private_message, :user_entered, :user_left, :user_quit,
-                 :user_kicked, :topic, :user_mode, :channel_mode]
+                 :user_kicked, :topic, :user_mode, :channel_mode,
+                 :channel_created, :channel_who_reply]
 
-    # @return the name of the script.
-    attr_accessor :__name
-    # @return the author of the script.
-    attr_accessor :__author
-    # @return the version of the script.
-    attr_accessor :__version
     # @return the path in which the script remains.
     attr_accessor :__path
     # Can be used inside the script to act with the client itself.
@@ -28,6 +26,27 @@ module Blur
     attr_accessor :__client
     # @return [Array] a list of handled emissions.
     attr_accessor :__emissions
+
+    # A list of extensions.
+    @@__extensions = []
+
+    # Find and evaluate script extensions.
+    def self.load_extensions!
+      root_path = File.dirname $0
+      
+      Dir.glob("#{root_path}/extensions/*.rb").each do |path|
+        extension = Extension.new path
+        extension.__client = self
+        extension.extension_loaded if extension.respond_to? :extension_loaded
+        
+        @@__extensions << extension
+      end
+    end
+
+    # "Unload" all script extensions.
+    def self.unload_extensions!
+      @@__extensions.clear
+    end
     
     # Check to see if the script has been evaluated.
     def evaluated?; @__evaluated end
@@ -38,7 +57,7 @@ module Blur
       @__evaluated = false
       @__emissions = []
       
-      if evaluate and @__evaluated
+      if evaluate_source_file path
         cache.load if Cache.exists? @__name
 
         Emissions.each do |emission|
@@ -58,15 +77,40 @@ module Blur
     #       # …
     #     end
     #   end
-    def Script name, version = [1,0], author = nil, &block
-      @__name    = name
-      @__author  = author
-      @__version = version
+    def Script name, options = {}, &block
+      @__name = name
+
+      extensions = options[:using] || options[:uses] 
+
+      # Automatically used extensions.
+      if extensions
+        extensions.each {|extension_name| using extension_name }
+      end
+
+      # Automatically included modules.
+      if options[:includes]
+        options[:includes].each{|module_name| self.extend module_name }
+      end
       
       instance_eval &block
       
       true
     end
+
+    # Add script extension and define a method with the same name as
+    # the extension.
+    def using *extension_names
+      extension_names.each do |extension_name|
+        if extension = @@__extensions.find{|ext| ext.__name.to_s == extension_name.to_s }
+          extension.extension_used self if extension.respond_to? :extension_used
+          self.metaclass.send :define_method, :"#{extension_name}" do
+            return extension
+          end
+        else
+          raise ExtensionNotFoundError, "Extension not found: #{extension_name}"
+        end
+      end
+    end
     
     # Unload the script and save the cache, if present.
     def unload!
@@ -92,15 +136,5 @@ module Blur
     def inspect
       File.basename @__path
     end
-    
-  private
-  
-    # Attempt to evaluate the contents of the script.
-    def evaluate
-      instance_eval File.read(@__path), File.basename(@__path), 0
-      @__evaluated = true
-    rescue Exception => exception
-      log.error "#{exception.message ^ :bold} on line #{exception.line.to_s ^ :bold}"
-    end
   end
 end

data/library/blur/script/cache.rb

@@ -1,7 +1,7 @@
 # encoding: utf-8
 
 module Blur
-  class Script < Module
+  class Script
     # The +Cache+ class enables data storing inside Blur and it scripts.
     #
     # What it does is simply store a hash, and act like it is that hash.

data/library/blur/script/commands.rb

@@ -0,0 +1,77 @@
+# encoding: utf-8
+
+module Blur
+  class Script
+    # The +Commands+ module is a module that gives the ability to turn a
+    # script into a DSL-like framework.
+    module Commands
+      class Command
+        DefaultOptions = { prefix: '.', hostmask: nil }
+
+        def initialize triggers, options = {}, &block
+          @triggers = Array === triggers ? triggers : [triggers]
+          @options = DefaultOptions.merge options
+          @block = block
+        end
+
+        # Called by the Commands module.
+        #
+        # Calls the command block if the trigger matches the criteria.
+        def received_message user, channel, message
+          prefix = @options[:prefix]
+
+          # Return if the prefix don't match.
+          return unless message.start_with? prefix
+
+          # Return if the hostmask don't match.
+          # FIXME: Maybe use globbing instead of regular expressions?
+          unless @options[:hostmask].nil?
+            hostmask = "#{user.nick}!#{user.name}@#{user.host}"
+
+            return unless hostmask =~ @options[:hostmask]
+          end
+
+          command, args = split_message message
+
+          # Strip the prefix and compare the trigger name.
+          if self.matches_trigger? command
+            @block.call user, channel, args
+          end
+        end
+
+      protected
+
+        def split_message message
+          prefix = @options[:prefix]
+          command, args = message[prefix.length..-1].split $;, 2
+
+          return command, args
+        end
+
+        def matches_trigger? command
+          return @triggers.find{|trigger| trigger.to_s == command }
+        end
+      end
+
+      # Extend +base+ with self.
+      def self.extended base
+        base.instance_variable_set :@__commands, []
+      end
+
+      # Add a new command handler and trigger.
+      def command name, *args, &block
+        @__commands << Command.new(name, *args, &block)
+      end
+      
+      # Handle all calls to the scripts +message+ method, check to see if
+      # the message containts a valid command, serialize it and pass it to
+      # the script as command_name with the parameters +user+, +channel+
+      # and +message+.
+      def message user, channel, line
+        @__commands.each do |command|
+          command.received_message user, channel, line
+        end
+      end
+    end
+  end
+end

data/library/blur/script/dsl.rb

@@ -1,72 +1,52 @@
-# encoding: utf-8
-
-module Blur
-  class Script < Module
-    # The +DSL+ module is a module that gives the ability to turn a
-    # script into a DSL-like framework.
-    #
-    # What it does is automatically test to see if a message starts with a
-    # trigger, and then, if so, it sends the command-part of the message to
-    # the script object itself.
-    #
-    # This way, the plugin-writer doesn't need to have repetetive code like
-    # that in every script.
-    #
-    # @example
-    #   Script :example do
-    #     include Fantasy
-    #
-    #     command :test do |user, channel, message|
-    #       channel.say "I hear you."
-    #     end
-    #   end
-    #
-    #   # And if a user were to send the message ".test my method", it would
-    #   # trigger the test block with the following arguments
-    #   #
-    #   # user    => #<Blur::Network::User … >
-    #   # channel => #<Blur::Network::Channel … >
-    #   # message => ".test my method"
-    module DSL
-      # The prefix that turns it into a possible command.
-      MessageTrigger = "."
-
-      # Extend +klass+ with self.
-      def self.included klass
-        klass.extend self
-      end
-
-      # Called when a script has been loaded, for use in modules extending
-      # the script.
-      def module_init
-        @__dsl_triggers = {}
-      end
-
-      def command name, *args, &block
-        (@__dsl_triggers ||= {})[name] = block
-      end
-      
-      # Handle all calls to the scripts +message+ method, check to see if
-      # the message containts a valid command, serialize it and pass it to
-      # the script as command_name with the parameters +user+, +channel+
-      # and +message+.
-      def message user, channel, line
-        return unless line.start_with? MessageTrigger
-        
-        command, args = line.split $;, 2
-        trigger = strip command
-
-        if handler = @__dsl_triggers[trigger]
-          handler.(user, channel, args)
-        end
-      end
-      
-    protected
-      
-      # Strip all non-word characters from the input command.
-      def strip name
-        name.gsub /\W/, '' if name
-      end
-    end
-  end
-end
+# encoding: utf-8
+
+module Blur
+  class Script
+    module DSL
+      def self.included base
+        base.send :attr_accessor, :__name
+        base.send :attr_accessor, :__author
+        base.send :attr_accessor, :__version
+        base.send :attr_accessor, :__description
+      end
+
+      # Set the author.
+      #
+      # @example
+      #   Author "John Doe <john.doe@gmail.com>"
+      def Author *authors
+        @__author = authors.join ', '
+      end
+
+      # Set the description.
+      #
+      # @example
+      #   Description "This is an example script."
+      def Description description
+        @__description = description
+      end
+
+      # Set the version.
+      #
+      # @example
+      #   Version "1.0"
+      def Version version
+        @__version = version
+      end
+
+      # @return the name of the script.
+      def name; @__name end
+
+      # @return the name of the author(s).
+      def author; @__author end
+
+      # @return the script version.
+      def version; @__version end
+
+      # @return the description.
+      def description; @__description end
+
+      alias_method :Authors, :Author
+    end
+  end
+end

data/library/blur/version.rb

@@ -0,0 +1,13 @@
+# encoding: utf-8
+
+module Blur
+  # The current version of Blur.
+  Version = "1.8.5"
+
+  # Get the current version.
+  #
+  # @return [String] The current version of Blur.
+  def self.version
+    Version
+  end
+end

metadata

@@ -1,41 +1,41 @@
 --- !ruby/object:Gem::Specification
 name: blur
 version: !ruby/object:Gem::Version
-  version: 1.7.3
+  version: 1.8.5
 platform: ruby
 authors:
 - Mikkel Kroman
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-08-02 00:00:00.000000000 Z
+date: 2016-01-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: majic
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>='
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.2'
 - !ruby/object:Gem::Dependency
   name: eventmachine
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - '>'
+    - - "~>"
       - !ruby/object:Gem::Version
         version: '0.12'
 description: 
@@ -44,26 +44,32 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
+- LICENSE
+- README.md
+- library/blur.rb
 - library/blur/client.rb
+- library/blur/encryption.rb
 - library/blur/encryption/base64.rb
 - library/blur/encryption/fish.rb
-- library/blur/encryption.rb
 - library/blur/enhancements.rb
+- library/blur/evaluable.rb
+- library/blur/extension.rb
 - library/blur/handling.rb
+- library/blur/network.rb
 - library/blur/network/channel.rb
 - library/blur/network/command.rb
 - library/blur/network/connection.rb
+- library/blur/network/isupport.rb
 - library/blur/network/user.rb
-- library/blur/network.rb
+- library/blur/script.rb
 - library/blur/script/cache.rb
+- library/blur/script/commands.rb
 - library/blur/script/dsl.rb
-- library/blur/script/fantasy.rb
-- library/blur/script/messageparsing.rb
-- library/blur/script.rb
-- library/blur.rb
+- library/blur/version.rb
 homepage: https://github.com/mkroman/blur
 licenses:
-- Internet Systems Consortium (ISC)
+- MIT
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -71,19 +77,18 @@ require_paths:
 - library
 required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.0
+rubygems_version: 2.2.0
 signing_key: 
 specification_version: 4
 summary: An event-driven IRC-framework for Ruby.
 test_files: []
-has_rdoc: 

data/library/blur/script/fantasy.rb

@@ -1,72 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  class Script < Module
-    # The +Fantasy+ module is a module that gives the ability to turn a
-    # script into a DSL-like framework.
-    #
-    # What it does is automatically test to see if a message starts with a
-    # trigger, and then, if so, it sends the command-part of the message to
-    # the script object itself.
-    #
-    # This way, the plugin-writer doesn't need to have repetetive code like
-    # that in every script.
-    #
-    # @example
-    #   Script :example do
-    #     include Fantasy
-    #
-    #     def command_test user, channel, message
-    #       channel.say "I hear you."
-    #     end
-    #   end
-    #
-    #   # And if a user were to send the message ".test my method", it would
-    #   # trigger the #command_test method with the following arguments
-    #   #
-    #   # user    => #<Blur::Network::User … >
-    #   # channel => #<Blur::Network::Channel … >
-    #   # message => ".test my method"
-    module Fantasy
-      # The prefix that turns it into a possible command.
-      MessageTrigger = "."
-
-      # Extend +klass+ with self.
-      def self.included klass
-        klass.extend self
-      end
-
-      # Called when a script has been loaded, for use in modules extending
-      # the script.
-      def module_init
-        @__fantasy_triggers = []
-
-        public_methods.grep(/^command_/).each do |trigger|
-          @__fantasy_triggers << trigger.to_s[8..-1]
-        end
-      end
-      
-      # Handle all calls to the scripts +message+ method, check to see if
-      # the message containts a valid command, serialize it and pass it to
-      # the script as command_name with the parameters +user+, +channel+
-      # and +message+.
-      def message user, channel, line
-        return unless line.start_with? MessageTrigger
-        
-        command, args = line.split $;, 2
-        trigger = serialize command
-
-        if @__fantasy_triggers.include? trigger
-          __send__ :"command_#{trigger}", user, channel, args
-        end
-      end
-      
-    protected
-      
-      # Strip all non-word characters from the input command.
-      def serialize name
-        name.gsub /\W/, '' if name
-      end
-    end
-  end
-end

data/library/blur/script/messageparsing.rb

@@ -1,61 +0,0 @@
-# encoding: utf-8
-
-module Blur
-  class Script < Module
-    # The +MessageParsing+ module is a module that gives the ability to turn a
-    # script into a DSL-like framework.
-    #
-    # What it does is automatically test to see if a message starts with a
-    # trigger, and then, if so, it sends the command-part of the message to
-    # the script object itself.
-    #
-    # This way, the plugin-writer doesn't need to have repetetive code like
-    # that in every script.
-    #
-    # @example
-    #   Script :example do
-    #     extend MessageParsing
-    #
-    #     def command_test user, channel, message
-    #       channel.say "I hear you."
-    #     end
-    #   end
-    #
-    #   # And if a user were to send the message ".test my method", it would
-    #   # trigger the #command_test method with the following arguments
-    #   #
-    #   # user    => #<Blur::Network::User … >
-    #   # channel => #<Blur::Network::Channel … >
-    #   # message => ".test my method"
-    module MessageParsing
-      # The prefix that turns it into a possible command.
-      MessageTrigger = "."
-
-      def self.extended klass
-        warn "#{File.realpath __FILE__}: MessageParsing will be deprecated in the future, use Fantasy."
-      end
-      
-      # Handle all calls to the scripts +message+ method, check to see if
-      # the message containts a valid command, serialize it and pass it to
-      # the script as command_name with the parameters +user+, +channel+
-      # and +message+.
-      def message user, channel, line
-        return unless line.start_with? MessageTrigger
-        
-        command, args = line.split $;, 2
-        name = :"command_#{serialize command}"
-        
-        if respond_to? name
-          __send__ name, user, channel, args
-        end
-      end
-      
-    protected
-      
-      # Strip all non-word characters from the input command.
-      def serialize name
-        name.gsub /\W/, '' if name
-      end
-    end
-  end
-end