blur 2.1.2 → 2.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d3972a328bb47b223b4795b59b416636411a9aa5ab1930ca3cb1b924b2c24f2c
-  data.tar.gz: 8aa0590f665280b6d637bbe7e14a0a44a1afa3c090cd3d0eb6d6c1218269671b
+  metadata.gz: 8e3a0bf486ae6b8b30c925220195462b412e23bd62e767e2996c698273d5bf18
+  data.tar.gz: 733539cbd3f671eb799f541523031ca42303184db7866b5113058486c664c95a
 SHA512:
-  metadata.gz: d2cfc568774d57ab0ec786237c0055a5953936b2fbf39a2815dc1d94375ec8e0805f76ad09f194db852f5d80a944dd328e94dd8f63b770775d749002b2e1bb49
-  data.tar.gz: 5983e426f4f1e045e203005c9f43b8f252935d326ad1f10bdf342d796676ff143d6ed60271596d77d4aca01d941ebd32241eafa64d9f682e6a7c8ec61baf8bc3
+  metadata.gz: 8517510ecd51f045b995fcd42d00d1da7587d7fb2f36911e59bc6ed9f2478e7076b2bcdfca1290001e276392f3ad63dc9829fb90a0b67432e1223ca4bde5e48f
+  data.tar.gz: 0bac6a2de2bc5d1d8294ba2d9342ffde0d39fedc40b318d73a5c5e187c1de298ad371a94bf4c67bd6433ee7ba896d24cd945408c869d3c4a4149a289b54ac6fd

data/README.md

@@ -1,5 +1,4 @@
-Blur
-====
+# 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
@@ -7,18 +6,16 @@ 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.
 
 [![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
-  * Non-blocking connections (no threading)
-  * Extensible with scripts, (re)loadable during runtime
-  * Modular, makes it a piece of cake to extend its IRC-capability
+## Getting started
 
-Future Plans
-------------
-  * DCC File-transfers
-  * DH1080 Key-Exchange
-  * Better event-handling in scripts
+
+## Documentation
+
+Documentation is available [here](https://www.rubydoc.info/github/mkroman/blur)
+
+## Features
+  * SSL/TLS connections
+  * Connect to multiple networks in a single process
+  * Non-blocking connections (no threading just for networking)
+  * Extensible with scripts that are (re)loadable during runtime

data/library/blur.rb

@@ -2,6 +2,7 @@
 
 require 'yaml'
 require 'socket'
+require 'base64'
 require 'ostruct'
 require 'openssl'
 
@@ -28,8 +29,7 @@ require 'blur/network/connection'
 # It allows the developer to extend it in multiple ways.
 # It can be by handlers, scripts, communications, and what have you.
 module Blur
-  # Contains all superscript classes for scripts that may be used.
-  @@scripts = {}
+  class ConfigError < StandardError; end
 
   # Creates a new superscript class and inserts it into the list of scripts.
   def self.Script name, *args, &block
@@ -39,12 +39,12 @@ module Blur
     klass.class_exec &block
     klass.init
 
-    @@scripts[name] = klass
+    scripts[name] = klass
   end
 
   # Gets all superscript classes.
   def self.scripts
-    @@scripts
+    @scripts ||= {}
   end
 
   # Resets all scripts.
@@ -52,8 +52,8 @@ module Blur
   # This method will call `deinit` on each script class before removing them to
   # give them a chance to clean up.
   def self.reset_scripts!
-    @@scripts.each_value &:deinit
-    @@scripts.clear
+    scripts.each_value &:deinit
+    scripts.clear
   end
 
   # Instantiates a client with given options and then makes the client instance

data/library/blur/callbacks.rb

@@ -2,29 +2,27 @@
 
 module Blur
   module Callbacks
-    # Our list of callbacks.
-    @@callbacks = {}
-
     # Get a list of callbacks registered.
     #
     # @returns [Array] the list of callbacks
     def callbacks
-      @@callbacks
+      @callbacks ||= {}
     end
 
     # Emit a new event with given arguments.
     #
     # @param name [Symbol] The event name.
     # @param args [optional, Array] The list of arguments to pass.
+    # @return [true, false] True if any callbacks were invoked, nil otherwise
     def emit name, *args
-      EM.defer do
-        notify_scripts name, *args
-      end
+      # Trigger callbacks in scripts before triggering events in the client.
+      EM.defer { notify_scripts name, *args }
 
-      if (callbacks = @@callbacks[name]) and callbacks.any?
-        EM.defer do
-          callbacks.each{|callback| callback.call *args }
-        end
+      matching_callbacks = callbacks[name]
+      return false unless matching_callbacks&.any?
+
+      EM.defer do
+        matching_callbacks.each { |callback| callback.call *args }
       end
     end
 
@@ -33,10 +31,10 @@ module Blur
     # @param name [Symbol] The event name.
     # @yield [args, ...] The arguments passed from #emit.
     def on name, &block
-      (@@callbacks[name] ||= []) << block
+      (callbacks[name] ||= []) << block
     end
 
-  protected
+    protected
 
     def notify_scripts name, *args
       scripts = @scripts.values.select{|script| script.class.events.key? name }

data/library/blur/client.rb

@@ -9,13 +9,14 @@ module Blur
   # distributing the incoming commands to the right networks and scripts.
   class Client
     include Callbacks
-    include Handling, Logging
+    include Handling
+    include Logging
 
     # Client error.
     Error = Class.new StandardError
 
     # The default environment.
-    ENVIRONMENT = ENV['BLUR_ENV'] || 'development'
+    ENVIRONMENT = ENV['BLUR_ENV'] || 'development'.freeze
 
     # The default configuration.
     DEFAULT_CONFIG = {
@@ -33,8 +34,10 @@ module Blur
     attr_accessor :config
     # @return [Hash] initialized scripts.
     attr_accessor :scripts
-
+    # @return [Boolean] whether verbose logging is enabled.
     attr_accessor :verbose
+    # @return [String] the path to the currently used config file.
+    attr_accessor :config_path
 
     # Instantiates the client, stores the options, instantiates the networks
     # and then loads available scripts.
@@ -49,11 +52,15 @@ module Blur
       @environment = options[:environment]
       @verbose = options[:verbose] == true
 
+      unless @config_path
+        raise ConfigError, 'missing config file path in :config_path option'
+      end
+
       load_config!
 
       networks = @config['blur']['networks']
 
-      if networks and networks.any?
+      if networks&.any?
         networks.each do |network_options|
           @networks.<< Network.new network_options, self
         end
@@ -106,10 +113,10 @@ module Blur
     # @param [optional, Symbol] signal The signal received by the system, if any.
     def quit signal = :SIGINT
       @networks.each do |network|
-        network.transmit :QUIT, "Got SIGINT?"
+        network.transmit :QUIT, 'Got SIGINT?'
         network.disconnect
       end
-      
+
       EventMachine.stop
     end
 
@@ -127,20 +134,49 @@ module Blur
     # Loads all scripts in the script directory.
     def load_scripts!
       scripts_dir = File.expand_path @config['blur']['scripts_dir']
-      scripts_cache_dir = File.expand_path @config['blur']['cache_dir']
-
-      Dir.glob File.join(scripts_dir, '*.rb') do |file|
-        begin
-          load file, true
-        rescue Exception => e
-          STDERR.puts "The script `#{file}' failed to load"
-          STDERR.puts "#{e.class}: #{e.message}"
-          STDERR.puts
-          STDERR.puts 'Backtrace:', '---', e.backtrace
-        end
+      script_file_paths = Dir.glob File.join scripts_dir, '*.rb'
+
+      # Sort the script file paths by file name so they load by alphabetical
+      # order.
+      #
+      # This will make it possible to create a script called '10_database.rb'
+      # which will be loaded before '20_settings.rb' and non-numeric prefixes
+      # will be loaded after that.
+      script_file_paths = script_file_paths.sort do |a, b|
+        File.basename(a) <=> File.basename(b)
       end
 
+      script_file_paths.each { |script_path| load_script_file script_path }
+
+      initialize_superscripts
+
+      emit :scripts_loaded
+    end
+
+    # Loads the given +file_path+ as a Ruby script, wrapping it in an anonymous
+    # module to protect our global namespace.
+    #
+    # @param [String] file_path the path to the ruby script.
+    #
+    # @raise [Exception] if there was any problems loading the file
+    def load_script_file file_path
+      load file_path, true
+    rescue Exception => exception
+      warn "The script `#{file_path}' failed to load"
+      warn "#{exception.class}: #{exception.message}"
+      warn ''
+      warn 'Backtrace:', '---', exception.backtrace
+    end
+
+    # Instantiates each +SuperScript+ in the +Blur.scripts+ list by manually
+    # allocating an instance and calling #initialize on it, then the instance is
+    # stored in +Client#scripts+.
+    #
+    # @raise [Exception] any exception that might occur in any scripts'
+    #   #initialize method.
+    def initialize_superscripts
       scripts_config = @config['scripts']
+      scripts_cache_dir = File.expand_path @config['blur']['cache_dir']
 
       Blur.scripts.each do |name, superscript|
         script = superscript.allocate
@@ -151,8 +187,6 @@ module Blur
 
         @scripts[name] = script
       end
-
-      emit :scripts_loaded
     end
 
     # Unloads initialized scripts and superscripts.
@@ -167,7 +201,7 @@ module Blur
       Blur.reset_scripts!
     end
 
-  private
+    private
 
     # Load the user-specified configuration file.
     #

data/library/blur/handling.rb

@@ -247,6 +247,67 @@ module Blur
         network.isupport.parse *params
       end
 
+      # Received when the server supports capability negotiation.
+      def got_cap network, message
+        id, command = message.parameters[0..1]
+
+        case command
+        when 'ACK'
+          capabilities = message.parameters[2]&.split
+
+          if capabilities&.include? 'sasl' and network.sasl?
+            network.transmit :AUTHENTICATE, 'PLAIN'
+          else
+            network.cap_end
+          end
+        when 'NAK'
+          capabilities = message.parameters[2]&.split
+
+          if capabilities&.include? 'sasl' and network.sasl?
+            puts "The server does not support SASL, but you've configured it " \
+              "as such! Disconnecting!"
+
+            network.disconnect
+          end
+
+        end
+      end
+
+      def got_001 network, message
+        if network.waiting_for_cap
+          network.abort_cap_neg
+        end
+      end
+
+      def got_authenticate network, message
+        case message.parameters[0]
+        when '+'
+          return unless network.sasl?
+          sasl = network.options['sasl']
+
+          response = "#{sasl['username']}\x00#{sasl['username']}\x00#{sasl['password']}"
+          network.transmit :AUTHENTICATE, Base64.encode64(response).strip
+        end
+      end
+
+      # :server 900 <nick> <nick>!<ident>@<host> <account> :You are now logged in as <user>
+      # RPL_LOGGEDIN SASL
+      def got_900 network, message
+        if network.waiting_for_cap
+          network.cap_end
+        end
+      end
+
+      # :server 904 <nick> :SASL authentication failed
+      # ERR_SASLFAIL
+      def got_904 network, message
+        nick, message = message.parameters
+
+        puts "SASL authentication failed! Disconnecting!"
+
+        network.disconnect
+      end
+
       alias_method :got_353, :got_name_reply
       alias_method :got_422, :got_end_of_motd
       alias_method :got_376, :got_end_of_motd

data/library/blur/network.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
   # The +Network+ module is to be percieved as an IRC network.
@@ -7,13 +7,21 @@ module Blur
   # for network-related structures, such as {User}, {Channel} and {Command}.
   class Network
     include Logging
-    
+
     # +ConnectionError+ should only be triggered from within {Connection}.
     class ConnectionError < StandardError; end
 
+    # Returns a unique identifier for this network.
+    #
+    # You can override the id in your network configuration by setting an 'id'
+    # key with the id you want.. If no id is specified, the the id will be
+    # constructed from the hostname and port number
+    # in the format "<host>:<port>"
+    #
+    # @return [String] the unique identifier for this network.
+    attr_reader :id
     # @return [Hash] the network options.
     attr_accessor :options
-
     # @return [Hash] the map of users that is known.
     attr_accessor :users
     # @return [Hash] the map of channels the client is in.
@@ -24,24 +32,41 @@ module Blur
     attr_accessor :connection
     # @return [Network::ISupport] the network isupport specs.
     attr_accessor :isupport
+    # @return [Boolean] true if we're waiting for a capability negotiation.
+    attr_reader :waiting_for_cap
 
     # Check whether or not connection is established.
-    def connected?; @connection and @connection.established? end
+    def connected?
+      @connection&.established?
+    end
 
     # Get the remote hostname.
     #
     # @return [String] the remote hostname.
-    def host; @options['hostname'] end
+    def host
+      @options['hostname']
+    end
 
     # Get the remote port.
     # If no port is specified, it returns 6697 if using a secure connection,
     # returns 6667 otherwise.
     #
     # @return [Fixnum] the remote port
-    def port; @options['port'] ||= secure? ? 6697 : 6667 end
-    
+    def port
+      @options['port'] ||= secure? ? 6697 : 6667
+    end
+
     # Check to see if it's a secure connection.
-    def secure?; @options['secure'] == true end
+    def secure?
+      @options['secure'] == true
+    end
+
+    # @return [Boolean] whether we want to authenticate with SASL.
+    def sasl?
+      @options['sasl'] &&
+        @options['sasl']['username'] &&
+        @options['sasl']['password']
+    end
 
     # Instantiates the network.
     #
@@ -52,17 +77,17 @@ module Blur
     # @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
+    #   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) 
+    # @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 
+    # @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.
@@ -72,20 +97,18 @@ module Blur
       @users = {}
       @channels = {}
       @isupport = ISupport.new self
-      
+
       unless options['nickname']
-        if options['hostname']
-          raise ArgumentError, "Network configuration for `#{options['hostname']}' is missing a nickname"
-        else
-          raise ArgumentError, "Network configuration is missing a nickname"
-        end
+        raise ArgumentError, 'Network configuration for ' \
+          "`#{id}' is missing a nickname"
       end
-      
+
       @options['username'] ||= @options['nickname']
       @options['realname'] ||= @options['username']
       @options['channels'] ||= []
+      @id = options.fetch 'id', "#{host}:#{port}"
     end
-    
+
     # Send a message to a recipient.
     #
     # @param [String, #to_s] recipient the recipient.
@@ -93,53 +116,55 @@ module Blur
     def say recipient, message
       transmit :PRIVMSG, recipient.to_s, message
     end
-    
+
+    # Forwards the received message to the client instance.
+    #
     # Called when the network connection has enough data to form a command.
     def got_message message
       @client.got_message self, message
-    rescue => e
-      puts "#{e.class}: #{e.message}"
+    rescue StandardError => exception
+      puts "#{exception.class}: #{exception.message}"
       puts
-      puts "---"
-      puts e.backtrace
+      puts '---'
+      puts exception.backtrace
     end
-    
+
     # Find a channel by its name.
     #
     # @param [String] name the channel name.
     # @return [Network::Channel] the matching channel, or nil.
     def channel_by_name name
-      @channels.find {|channel| channel.name == name }
+      @channels.find { |channel| channel.name == name }
     end
-    
+
     # Find all instances of channels in which there is a user with the nick
     # +nick+.
     #
     # @param [String] nick the nickname.
     # @return [Array] a list of channels in which the user is located, or nil.
     def channels_with_user nick
-      @channels.select {|channel| channel.user_by_nick nick }
+      @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
+      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
+      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"]
+      isupport['CHANMODES']['D']
     end
 
     # Attempt to establish a connection and send initial data.
@@ -151,25 +176,45 @@ module Blur
 
     # Called when the connection was successfully established.
     def connected!
+      if sasl?
+        @waiting_for_cap = true
+
+        transmit :CAP, 'REQ', 'sasl'
+      end
+
       transmit :PASS, @options['password'] if @options['password']
       transmit :NICK, @options['nickname']
       transmit :USER, @options['username'], 'void', 'void', @options['realname']
     end
 
+    # Called when the server doesn't support capability negotiation.
+    def abort_cap_neg
+      @waiting_for_cap = false
+
+      puts "Server does not support capability negotiation"
+    end
+
+    # Called when we're done with capability negotiation.
+    def cap_end
+      @waiting_for_cap = false
+
+      transmit :CAP, 'END'
+    end
+
     # Called when the connection was closed.
     def disconnected!
-      @channels.each {|name, channel| channel.users.clear }
+      @channels.each { |_name, channel| channel.users.clear }
       @channels.clear
       @users.clear
 
       @client.network_connection_closed self
     end
-    
+
     # Terminate the connection and clear all channels and users.
     def disconnect
       @connection.close_connection_after_writing
     end
-    
+
     # Transmit a command to the server.
     #
     # @param [Symbol, String] name the command name.
@@ -178,9 +223,11 @@ module Blur
       message = IRCParser::Message.new command: name.to_s, parameters: arguments
 
       if @client.verbose
-        log "#{'→' ^ :red} #{message.command.to_s.ljust(8, ' ') ^ :light_gray} #{message.parameters.map(&:inspect).join ' '}"
+        formatted_command = message.command.to_s.ljust 8, ' '
+        formatted_params = message.parameters.map(&:inspect).join ' '
+        log "#{'→' ^ :red} #{formatted_command} #{formatted_params}"
       end
-      
+
       @connection.send_data "#{message}\r\n"
     end
 
@@ -196,7 +243,7 @@ module Blur
 
     # Convert it to a debug-friendly format.
     def to_s
-      %{#<#{self.class.name} "#{host}":#{port}>}
+      %(#<#{self.class.name} "#{host}":#{port}>)
     end
   end
 end

data/library/blur/version.rb

@@ -2,7 +2,7 @@
 
 module Blur
   # The current version of Blur.
-  Version = '2.1.2'.freeze
+  Version = '2.1.3'.freeze
 
   # Get the current version.
   #

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: blur
 version: !ruby/object:Gem::Version
-  version: 2.1.2
+  version: 2.1.3
 platform: ruby
 authors:
 - Mikkel Kroman
 autorequire: 
 bindir: executables
 cert_chain: []
-date: 2018-03-04 00:00:00.000000000 Z
+date: 2019-07-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: deep_merge
@@ -96,8 +96,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.7.6
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: An event-driven IRC-framework for Ruby.