blur 2.1.3 → 2.1.6

data/library/blur/network/isupport.rb

@@ -1,20 +1,22 @@
-# encoding: utf-8
+# frozen_string_literal: true
+
+require 'English'
 
 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
+      NUMERIC_PARAMS = %w[CHANNELLEN MODES NICKLEN KICKLEN TOPICLEN AWAYLEN
+                          MAXCHANNELS MAXBANS MAXPARA MAXTARGETS].freeze
 
       # Our parsers for parameters that require special treatment.
-      Parsers = {
+      PARSERS = {
         # CHANLIMIT=pfx:num[,pfx:num,...]
         #
         # This parameter specifies the maximum number of channels that a client
@@ -24,10 +26,10 @@ module Blur
         # 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 ?: }
+        %w[CHANLIMIT] => lambda do |value|
+          {}.tap do |result|
+            params = value.split ','
+            mappings = params.map { |param| param.split ':' }
 
             mappings.each do |prefixes, limit|
               prefixes.each_char do |prefix|
@@ -48,10 +50,12 @@ module Blur
         #
         # 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]
+        %w[PREFIX] => lambda do |value|
+          {}.tap do |result|
+            match = value.match(/^\((.+)\)(.*)/)
+
+            if match
+              modes, prefix = match[1..2]
 
               modes.chars.each_with_index do |char, index|
                 result[char] = prefix[index]
@@ -77,39 +81,41 @@ module Blur
         #    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
+        %w[CHANMODES] => lambda do |value|
+          {}.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
+        NUMERIC_PARAMS => lambda do |value|
           value.to_i
         end
-      }
+      }.freeze
 
       # Initialize a new ISupport with a network reference.
-      # 
+      #
       # @param network [Network] The parent network.
       def initialize network
+        super
+
         @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['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"
+        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.
@@ -117,12 +123,12 @@ module Blur
       # @param parameters [Array] The list of parameters.
       def parse *params
         params.each do |parameter|
-          name, value = parameter.split ?=
+          name, value = parameter.split '='
 
           if value
-            _, parser = Parsers.find{|key, value| key.include? name }
+            _, parser = PARSERS.find { |key, _value| key.include? name }
 
-            self[name] = parser.nil? ? value : parser.(value)
+            self[name] = parser.nil? ? value : parser.call(value)
           else
             self[name] = true
           end

data/library/blur/network.rb

@@ -6,11 +6,12 @@ module Blur
   # Although the connection is a part of the network module, it is mainly used
   # 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
 
+    DEFAULT_PING_INTERVAL = 30
+    DEFAULT_RECONNECT = true
+
     # Returns a unique identifier for this network.
     #
     # You can override the id in your network configuration by setting an 'id'
@@ -20,6 +21,8 @@ module Blur
     #
     # @return [String] the unique identifier for this network.
     attr_reader :id
+    # @return [String] the current nickname.
+    attr_accessor :nickname
     # @return [Hash] the network options.
     attr_accessor :options
     # @return [Hash] the map of users that is known.
@@ -32,8 +35,19 @@ module Blur
     attr_accessor :connection
     # @return [Network::ISupport] the network isupport specs.
     attr_accessor :isupport
+    # @return [Array<String>] list of capabilities supported by the network.
+    attr_accessor :capabilities
     # @return [Boolean] true if we're waiting for a capability negotiation.
     attr_reader :waiting_for_cap
+    # @return [Time] the last time a pong was sent or received.
+    attr_accessor :last_pong_time
+    # The max PING interval for the server. This is used to determine when the
+    # client will attempt to send its own PING command.
+    #
+    # @note the actual time until a client PING is sent can vary by an
+    #   additional 0-30 seconds.
+    # @return [Number] the max interval between pings from a server.
+    attr_accessor :server_ping_interval_max
 
     # Check whether or not connection is established.
     def connected?
@@ -94,15 +108,21 @@ module Blur
     def initialize options, client = nil
       @client = client
       @options = options
+      # @log = ::Logging.logger[self]
       @users = {}
       @channels = {}
       @isupport = ISupport.new self
+      @capabilities = []
+      @reconnect_interval = 3
+      @server_ping_interval_max = @options.fetch('server_ping_interval',
+                                                 150).to_i
 
       unless options['nickname']
         raise ArgumentError, 'Network configuration for ' \
           "`#{id}' is missing a nickname"
       end
 
+      @nickname = options['nickname']
       @options['username'] ||= @options['nickname']
       @options['realname'] ||= @options['username']
       @options['channels'] ||= []
@@ -122,11 +142,11 @@ module Blur
     # Called when the network connection has enough data to form a command.
     def got_message message
       @client.got_message self, message
-    rescue StandardError => exception
-      puts "#{exception.class}: #{exception.message}"
+    rescue StandardError => e
+      puts "#{e.class}: #{e.message}"
       puts
       puts '---'
-      puts exception.backtrace
+      puts e.backtrace
     end
 
     # Find a channel by its name.
@@ -171,27 +191,74 @@ module Blur
     #
     # @see Connection
     def connect
-      @connection = EventMachine.connect host, port, Connection, self
+      # @log.info "Connecting to #{self}"
+
+      begin
+        @connection = EventMachine.connect host, port, Connection, self
+      rescue EventMachine::ConnectionError => e
+        warn "Establishing connection to #{self} failed!"
+        warn e.message
+
+        schedule_reconnect
+        return
+      end
+
+      @ping_timer = EventMachine.add_periodic_timer DEFAULT_PING_INTERVAL do
+        periodic_ping_check
+      end
     end
 
-    # Called when the connection was successfully established.
-    def connected!
-      if sasl?
-        @waiting_for_cap = true
+    # Schedules a reconnect after a user-specified number of seconds.
+    def schedule_reconnect
+      # @log.info "Reconnecting to #{self} in #{@reconnect_interval} seconds"
+
+      EventMachine.add_timer @reconnect_interval do
+        connect
+      end
+    end
+
+    def server_connection_timeout
+      @connection.close_connection
 
-        transmit :CAP, 'REQ', 'sasl'
+      warn "Connection to #{self} timed out"
+    end
+
+    def periodic_ping_check
+      now = Time.now
+      seconds_since_pong = now - @last_pong_time
+
+      return unless seconds_since_pong >= @server_ping_interval_max
+
+      # @log.info "No PING request from the server in #{seconds_since_pong}s!"
+
+      transmit 'PING', now.to_s
+
+      # Wait 15 seconds and declare a timeout if we didn't get a PONG.
+      previous_pong_time = @last_pong_time.dup
+
+      EventMachine.add_timer 15 do
+        server_connection_timeout if @last_pong_time == previous_pong_time
       end
+    end
+
+    # Called when the connection was successfully established.
+    def connected!
+      @waiting_for_cap = true
+      @capabilities.clear
 
+      transmit :CAP, 'LS'
       transmit :PASS, @options['password'] if @options['password']
       transmit :NICK, @options['nickname']
       transmit :USER, @options['username'], 'void', 'void', @options['realname']
+
+      @last_pong_time = Time.now
     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"
+      puts 'Server does not support capability negotiation'
     end
 
     # Called when we're done with capability negotiation.
@@ -203,11 +270,17 @@ module Blur
 
     # Called when the connection was closed.
     def disconnected!
-      @channels.each { |_name, channel| channel.users.clear }
+      @channels.each { |_, channel| channel.users.clear }
       @channels.clear
       @users.clear
+      @ping_timer.cancel
 
+      # @log.debug "Connection to #{self} lost!"
       @client.network_connection_closed self
+
+      return unless @options.fetch('reconnect', DEFAULT_RECONNECT)
+
+      schedule_reconnect
     end
 
     # Terminate the connection and clear all channels and users.
@@ -225,7 +298,7 @@ module Blur
       if @client.verbose
         formatted_command = message.command.to_s.ljust 8, ' '
         formatted_params = message.parameters.map(&:inspect).join ' '
-        log "#{'→' ^ :red} #{formatted_command} #{formatted_params}"
+        puts "→ #{formatted_command} #{formatted_params}"
       end
 
       @connection.send_data "#{message}\r\n"

data/library/blur/script.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
   module Commands
@@ -27,7 +27,7 @@ module Blur
       #   command! '!ping' do |user, channel, args|
       #     channel.say "#{user}: pong"
       #   end
-      def command! command, *args, &block
+      def command! command, *_args, &block
         id = (command_lut << command)
         define_method :"_command_#{id}", &block
       end
@@ -40,11 +40,11 @@ module Blur
 
       klass.extend ClassMethods
       klass.command_lut = CommandLUT.new
-      klass.register! message: -> (script, user, channel, line) {
+      klass.register! message: lambda { |script, user, channel, line|
         command, args = line.split ' ', 2
         return unless command
 
-        if id = klass.command_lut.commands[command.downcase]
+        if (id = klass.command_lut.commands[command.downcase])
           script.__send__ :"_command_#{id}", user, channel, args
         end
       }
@@ -56,7 +56,7 @@ module Blur
       attr_accessor :name, :authors, :version, :description, :events
 
       # Sets the author.
-      # 
+      #
       # @example
       #   Author 'John Doe <john.doe@example.com>'
       def Author *authors
@@ -104,11 +104,16 @@ module Blur
         (@events[name] ||= []) << method_name
       end
 
-      def to_s; inspect end
-      def inspect; %%#<SuperScript:0x#{self.object_id.to_s 16}>% end
+      def to_s
+        inspect
+      end
+
+      def inspect
+        %(#<SuperScript:0x#{object_id.to_s 16}>)
+      end
 
-      alias :author :authors
-      alias :Authors :Author
+      alias author authors
+      alias Authors Author
     end
 
     # Called when when the superscript has been loaded and added to the list of
@@ -122,7 +127,7 @@ module Blur
     # Reference to the main client that holds the script.
     attr_accessor :_client_ref
 
-    # Script-specific configuration that is read from the main configuration 
+    # Script-specific configuration that is read from the main configuration
     # file.
     attr_accessor :config
 
@@ -132,7 +137,9 @@ module Blur
     def unloaded; end
 
     # Gets the instantiated script with +name+.
-    def script name; _client_ref.scripts[name] end
+    def script name
+      _client_ref.scripts[name]
+    end
 
     # Gets a human-readable representation of the script.
     def inspect
@@ -142,6 +149,8 @@ module Blur
         "@description=#{self.class.description.inspect}>"
     end
 
-    def to_s; inspect end
+    def to_s
+      inspect
+    end
   end
 end

data/library/blur/script_cache.rb

@@ -1,7 +1,7 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
-  class ScriptCache < Hash
+  class ScriptCache
     def initialize script_name, path, hash
       @script_name = script_name
       @path = path
@@ -9,20 +9,22 @@ module Blur
     end
 
     # Gets a cache +value+ by its +key+.
-    def [] key; @hash[key] end
+    def [] key
+      @hash[key]
+    end
 
     # Sets the cache +key+ to the provided +value+.
-    def []= key, value; @hash[key] = value end
+    def []= key, value
+      @hash[key] = value
+    end
 
     # Saves the cache as a YAML file.
     def save
       directory = File.dirname @path
-      
-      unless File.directory? directory
-        Dir.mkdir directory
-      end
 
-      File.open @path, ?w do |file|
+      Dir.mkdir directory unless File.directory? directory
+
+      File.open @path, 'w' do |file|
         YAML.dump @hash, file
       end
     end
@@ -31,7 +33,7 @@ module Blur
     def self.load script_name, cache_dir
       cache_path = File.join cache_dir, "#{script_name}.yml"
 
-      if File.exists? cache_path
+      if File.exist? cache_path
         object = YAML.load_file cache_path
 
         ScriptCache.new script_name, cache_path, object

data/library/blur/user.rb

@@ -1,11 +1,11 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
   # The +User+ class is used for encapsulating a user and its properties.
   #
   # The user owns a reference to its parent channel.
   #
-  # Modes can be set for a user, but Blur is not 
+  # Modes can be set for a user, but Blur is not
   # {http://www.irc.org/tech_docs/005.html ISupport}-compliant yet.
   #
   # @todo make so that channels *and* users belongs to the network, and not
@@ -24,16 +24,39 @@ module Blur
     attr_accessor :network
     attr_accessor :channels
 
+    # @return [Hash<String, String>] a map of symbols to channel user modes.
+    COMMON_SYMBOL_MODES = {
+      '@' => 'o',
+      '+' => 'v',
+      '%' => 'h',
+      '&' => 'a',
+      '~' => 'q'
+    }.freeze
+
     # Check to see if the user is an admin (+a)
-    def admin?; @modes.include? "a" end
+    def admin?
+      @modes.include? 'a'
+    end
+
     # Check to see if the user has voice (+v)
-    def voice?; @modes.include? "v" end
+    def voice?
+      @modes.include? 'v'
+    end
+
     # Check to see if the user is the owner (+q)
-    def owner?; @modes.include? "q" end
+    def owner?
+      @modes.include? 'q'
+    end
+
     # Check to see if the user is an operator (+o)
-    def operator?; @modes.include? "o" end
+    def operator?
+      @modes.include? 'o'
+    end
+
     # Check to see if the user is an half-operator (+h)
-    def half_operator?; @modes.include? "h" end
+    def half_operator?
+      @modes.include? 'h'
+    end
 
     # Instantiate a user with a nickname.
     def initialize nick, network = nil
@@ -41,11 +64,11 @@ module Blur
       @modes = String.new
       @channels = []
       @network = network
-      
-      if modes = prefix_to_mode(nick[0])
-        @nick  = nick[1..-1]
-        @modes = modes
-      end
+
+      return unless (modes = prefix_to_mode(nick[0]))
+
+      @nick  = nick[1..]
+      @modes = modes
     end
 
     # Merge the users mode corresponding to the leading character (+ or -).
@@ -56,26 +79,26 @@ module Blur
 
       modes.each_char do |char|
         case char
-        when ?+
+        when '+'
           addition = true
-        when ?-
+        when '-'
           addition = false
         else
           addition ? @modes.concat(char) : @modes.delete!(char)
         end
       end
     end
-    
+
     # Send a private message to the user.
     #
     # @param [String] message the message to send.
     def say message
       @network.say self, message
     end
-    
+
     # Convert it to a debug-friendly format.
     def inspect
-      %{#<#{self.class.name}:0x#{self.object_id.to_s 16} @nick=#{@nick.inspect}>}
+      %(#<#{self.class.name}:0x#{object_id.to_s 16} @nick=#{@nick.inspect}>)
     end
 
     # Called when YAML attempts to save the object, which happens when a
@@ -83,23 +106,17 @@ module Blur
     def to_yaml options = {}
       @nick.to_yaml options
     end
-    
+
     # Get the users nickname.
     def to_s
       @nick
     end
 
-  private
+    private
 
     # Translate a nickname-prefix to a mode character.
     def prefix_to_mode prefix
-      case prefix
-      when '@' then 'o'
-      when '+' then 'v'
-      when '%' then 'h'
-      when '&' then 'a'
-      when '~' then 'q'
-      end
+      COMMON_SYMBOL_MODES[prefix]
     end
   end
 end

data/library/blur/version.rb

@@ -1,13 +1,13 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 module Blur
   # The current version of Blur.
-  Version = '2.1.3'.freeze
+  VERSION = '2.1.6'
 
   # Get the current version.
   #
   # @return [String] The current version of Blur.
   def self.version
-    Version
+    VERSION
   end
 end

data/library/blur.rb

@@ -1,4 +1,4 @@
-# encoding: utf-8
+# frozen_string_literal: true
 
 require 'yaml'
 require 'socket'
@@ -11,28 +11,30 @@ require 'eventmachine'
 require 'ircparser'
 
 # Require all library files.
-require 'blur/logging'
-require 'blur/version'
-require 'blur/callbacks'
-require 'blur/script'
-require 'blur/script_cache'
-require 'blur/network'
-require 'blur/client'
-require 'blur/user'
-require 'blur/channel'
-require 'blur/enhancements'
-require 'blur/network/isupport'
-require 'blur/network/connection'
+require_relative './blur/version'
+require_relative './blur/callbacks'
+require_relative './blur/script'
+require_relative './blur/script_cache'
+require_relative './blur/network'
+require_relative './blur/client'
+require_relative './blur/user'
+require_relative './blur/channel'
+require_relative './blur/network/isupport'
+require_relative './blur/network/connection'
 
 # 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
+  # Client error.
+  class ClientError < StandardError; end
+
+  # Configuration file error.
   class ConfigError < StandardError; end
 
   # Creates a new superscript class and inserts it into the list of scripts.
-  def self.Script name, *args, &block
+  def self.Script name, *_args, &block
     klass = Class.new SuperScript
     klass.name = name
     klass.events = {}