cinch 2.2.5 → 2.2.6

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: b1e40f6cd0cfe7e806d4b87bfd591c5320c5a2fc
+  data.tar.gz: d7a173c15ed16769d1703ba3dd7b9d1f7c810cba
+SHA512:
+  metadata.gz: f687dc8eeffdbb9c455017e679ec0528b09c95aea5e921207f5ccb132d61bfb3ae2d3417db6cdb0500199671d5f5344194d1d021ff8933914254acc78f419b82
+  data.tar.gz: 96e85381ff58dc28d4aa457c4985924e1b32fcc708823330e6eb87c71ef7da4c62f36edd4a3c958a640d63135c64c65bccf9a66c39e8c7ecf0270beae52646f4

data/lib/cinch/irc.rb

@@ -311,6 +311,11 @@ module Cinch
           new_network = :jtv
           new_ircd    = :jtv
         end
+      when "004"
+        if msg.params == %w{irc.tinyspeck.com IRC-SLACK gateway}
+          new_network = :slack
+          new_ircd = :slack
+        end
       when "005"
         case @isupport["NETWORK"]
         when "NGameTV"
@@ -350,7 +355,7 @@ module Cinch
         msg.channel.bans_unsynced << ban
         events << [:ban, ban]
       else
-        msg.channel.bans_unsynced.delete_if {|b| b.mask == ban.mask}.first
+        msg.channel.bans_unsynced.delete_if {|b| b.mask == ban.mask}
         events << [:unban, ban]
       end
     end
@@ -441,64 +446,83 @@ module Cinch
     # @version 1.1.0
     def on_mode(msg, events)
       if msg.channel?
-        add_and_remove = @bot.irc.isupport["CHANMODES"]["A"] + @bot.irc.isupport["CHANMODES"]["B"] + @bot.irc.isupport["PREFIX"].keys
-
-        param_modes = {
-          :add    => @bot.irc.isupport["CHANMODES"]["C"] + add_and_remove,
-          :remove => add_and_remove
-        }
-
-        modes = ModeParser.parse_modes(msg.params[1], msg.params[2..-1], param_modes)
-        modes.each do |direction, mode, param|
-          if @bot.irc.isupport["PREFIX"].keys.include?(mode)
-            target = User(param)
-
-            # (un)set a user-mode
-            if direction == :add
-              msg.channel.users[target] << mode unless msg.channel.users[User(param)].include?(mode)
-            else
-              msg.channel.users[target].delete mode
-            end
+        parse_channel_modes(msg, events)
+        return
+      end
+      if msg.params.first == bot.nick
+        parse_bot_modes(msg)
+      end
+    end
 
-            user_events = {
-              "o" => "op",
-              "v" => "voice",
-              "h" => "halfop"
-            }
-            if user_events.has_key?(mode)
-              event = (direction == :add ? "" : "de") + user_events[mode]
-              events << [event.to_sym, target]
-            end
-          elsif @bot.irc.isupport["CHANMODES"]["A"].include?(mode)
-            case mode
-            when "b"
-              process_ban_mode(msg, events, param, direction)
-            when "q"
-              process_owner_mode(msg, events, param, direction) if @network.owner_list_mode
-            else
-              raise Exceptions::UnsupportedMode, mode
-            end
+    def parse_channel_modes(msg, events)
+      add_and_remove = @bot.irc.isupport["CHANMODES"]["A"] + @bot.irc.isupport["CHANMODES"]["B"] + @bot.irc.isupport["PREFIX"].keys
+
+      param_modes = {
+        :add    => @bot.irc.isupport["CHANMODES"]["C"] + add_and_remove,
+        :remove => add_and_remove
+      }
+
+
+      modes, err = ModeParser.parse_modes(msg.params[1], msg.params[2..-1], param_modes)
+      if err != nil
+        if  @network.ircd != :slack || !err.is_a?(ModeParser::TooManyParametersError)
+          raise Exceptions::InvalidModeString, err
+        end
+      end
+      modes.each do |direction, mode, param|
+        if @bot.irc.isupport["PREFIX"].keys.include?(mode)
+          target = User(param)
+
+          # (un)set a user-mode
+          if direction == :add
+            msg.channel.users[target] << mode unless msg.channel.users[target].include?(mode)
           else
-            # channel options
-            if direction == :add
-              msg.channel.modes_unsynced[mode] = param.nil? ? true : param
-            else
-              msg.channel.modes_unsynced.delete(mode)
-            end
+            msg.channel.users[target].delete mode
           end
-        end
 
-        events << [:mode_change, modes]
-      elsif msg.params.first == bot.nick
-        modes = ModeParser.parse_modes(msg.params[1], msg.params[2..-1])
-        modes.each do |direction, mode, _|
+          user_events = {
+            "o" => "op",
+            "v" => "voice",
+            "h" => "halfop"
+          }
+          if user_events.has_key?(mode)
+            event = (direction == :add ? "" : "de") + user_events[mode]
+            events << [event.to_sym, target]
+          end
+        elsif @bot.irc.isupport["CHANMODES"]["A"].include?(mode)
+          case mode
+          when "b"
+            process_ban_mode(msg, events, param, direction)
+          when "q"
+            process_owner_mode(msg, events, param, direction) if @network.owner_list_mode
+          else
+            raise Exceptions::UnsupportedMode, mode
+          end
+        else
+          # channel options
           if direction == :add
-            @bot.modes << mode unless @bot.modes.include?(mode)
+            msg.channel.modes_unsynced[mode] = param.nil? ? true : param
           else
-            @bot.modes.delete(mode)
+            msg.channel.modes_unsynced.delete(mode)
           end
         end
       end
+
+      events << [:mode_change, modes]
+    end
+
+    def parse_bot_modes(msg)
+      modes, err = ModeParser.parse_modes(msg.params[1], msg.params[2..-1])
+      if err != nil
+        raise Exceptions::InvalidModeString, err
+      end
+      modes.each do |direction, mode, _|
+        if direction == :add
+          @bot.modes << mode unless @bot.modes.include?(mode)
+        else
+          @bot.modes.delete(mode)
+        end
+      end
     end
 
     def on_nick(msg, events)
@@ -556,7 +580,6 @@ module Cinch
         msg.user.online = true
       end
 
-
       if msg.message =~ /^\001DCC SEND (?:"([^"]+)"|(\S+)) (\S+) (\d+)(?: (\d+))?\001$/
         process_dcc_send($1 || $2, $3, $4, $5, msg, events)
       end
@@ -595,6 +618,11 @@ module Cinch
       detect_network(msg, "002")
     end
 
+    # @since 2.2.6
+    def on_004(msg, events)
+      detect_network(msg, "004")
+    end
+
     def on_005(msg, events)
       # ISUPPORT
       @isupport.parse(*msg.params[1..-2].map {|v| v.split(" ")}.flatten)
@@ -647,13 +675,6 @@ module Cinch
     def on_318(msg, events)
       # RPL_ENDOFWHOIS
       user = User(msg.params[1])
-
-      if @whois_updates[user].nil? ||
-         (@whois_updates[user].empty? && !user.attr(:unknown?, true, true))
-        user.end_of_whois(nil)
-        return
-      end
-
       user.end_of_whois(@whois_updates[user])
       @whois_updates.delete user
     end
@@ -828,8 +849,7 @@ module Cinch
     def on_401(msg, events)
       # ERR_NOSUCHNICK
       if user = @bot.user_list.find(msg.params[1])
-        user.end_of_whois(nil, true)
-        @whois_updates.delete user
+        update_whois(user, {:unknown? => true})
       end
     end
 
@@ -837,7 +857,7 @@ module Cinch
       # ERR_NOSUCHSERVER
 
       if user = @bot.user_list.find(msg.params[1]) # not _ensured, we only want a user that already exists
-        user.end_of_whois(nil, true)
+        user.end_of_whois({:unknown? => true})
         @whois_updates.delete user
         # TODO freenode specific, test on other IRCd
       end

data/lib/cinch/mode_parser.rb

@@ -4,17 +4,26 @@ module Cinch
   # @api private
   # @since 1.1.0
   module ModeParser
+    ErrEmptyString = "Empty mode string"
+    MalformedError = Struct.new(:modes)
+    EmptySequenceError = Struct.new(:modes)
+    NotEnoughParametersError = Struct.new(:op)
+    TooManyParametersError = Struct.new(:modes, :params)
+
     # @param [String] modes The mode string as sent by the server
     # @param [Array<String>] params Parameters belonging to the modes
     # @param [Hash{:add, :remove => Array<String>}] param_modes
     #   A mapping describing which modes require parameters
+    # @return [(Array<(Symbol<:add, :remove>, String<char>, String<param>), foo)]
     def self.parse_modes(modes, params, param_modes = {})
       if modes.size == 0
-        raise Exceptions::InvalidModeString, 'Empty mode string'
+        return nil, ErrEmptyString
+        # raise Exceptions::InvalidModeString, 'Empty mode string'
       end
 
       if modes[0] !~ /[+-]/
-        raise Exceptions::InvalidModeString, "Malformed modes string: %s" % modes
+        return nil, MalformedError.new(modes)
+        # raise Exceptions::InvalidModeString, "Malformed modes string: %s" % modes
       end
 
       changes = []
@@ -25,7 +34,8 @@ module Cinch
       modes.each_char do |ch|
         if ch =~ /[+-]/
           if count == 0
-            raise Exceptions::InvalidModeString, 'Empty mode sequence: %s' % modes
+            return changes, EmptySequenceError.new(modes)
+            # raise Exceptions::InvalidModeString, 'Empty mode sequence: %s' % modes
           end
 
           direction = case ch
@@ -41,7 +51,8 @@ module Cinch
             if params.size > 0
               param = params.shift
             else
-              raise Exceptions::InvalidModeString, 'Not enough parameters: %s' % ch.inspect
+              return changes, NotEnoughParametersError.new(ch)
+              # raise Exceptions::InvalidModeString, 'Not enough parameters: %s' % ch.inspect
             end
           end
           changes << [direction, ch, param]
@@ -50,14 +61,16 @@ module Cinch
       end
 
       if params.size > 0
-        raise Exceptions::InvalidModeString, 'Too many parameters: %s %s' % [modes, params]
+        return changes, TooManyParametersError.new(modes, params)
+        # raise Exceptions::InvalidModeString, 'Too many parameters: %s %s' % [modes, params]
       end
 
       if count == 0
-        raise Exceptions::InvalidModeString, 'Empty mode sequence: %s' % modes
+        return changes, EmptySequenceError.new(modes)
+        # raise Exceptions::InvalidModeString, 'Empty mode sequence: %s' % modes
       end
 
-      return changes
+      return changes, nil
     end
   end
 end

data/lib/cinch/network.rb

@@ -39,7 +39,7 @@ module Cinch
     # @return [String, nil] The mode used for getting the list of
     #   channel owners, if any
     def owner_list_mode
-      return "q" if @ircd == :unreal
+      return "q" if @ircd == :unreal || @ircd == :inspircd
     end
 
     # @return [String, nil] The mode used for getting the list of

data/lib/cinch/target.rb

@@ -103,7 +103,7 @@ module Cinch
     # @see #safe_notice
     # @see #notice
     def safe_notice(text)
-      safe_msg(text, true)
+      safe_send(text, true)
     end
 
     # Invoke an action (/me) in/to the target.

data/lib/cinch/user.rb

@@ -274,9 +274,9 @@ module Cinch
     # @return [void]
     # @api private
     # @since 1.0.1
-    def end_of_whois(values, not_found = false)
+    def end_of_whois(values)
       @in_whois = false
-      if not_found
+      if values[:unknown?]
         sync(:unknown?, true, true)
         self.online = false
         sync(:idle, 0, true)

data/lib/cinch/user_list.rb

@@ -34,9 +34,16 @@ module Cinch
       else
         raise ArgumentError
       end
+
+      if nick == @bot.nick
+        user_obj = @bot
+      end
+
       downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
       @mutex.synchronize do
-        user_obj = @cache[downcased_nick] ||= User.new(*bargs, @bot)
+        if user_obj.nil?
+          user_obj = @cache[downcased_nick] ||= User.new(*bargs, @bot)
+        end
         if user && host
           # Explicitly set user and host whenever we request a User
           # object to update them on e.g. JOIN.
@@ -52,6 +59,10 @@ module Cinch
     # @param [String] nick nick of a user
     # @return [User, nil]
     def find(nick)
+      if nick == @bot.nick
+        return @bot
+      end
+
       downcased_nick = nick.irc_downcase(@bot.irc.isupport["CASEMAPPING"])
       @mutex.synchronize do
         return @cache[downcased_nick]

data/lib/cinch/version.rb

@@ -1,4 +1,4 @@
 module Cinch
   # Version of the library
-  VERSION = '2.2.5'
+  VERSION = '2.2.6'
 end

metadata

@@ -1,15 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cinch
 version: !ruby/object:Gem::Version
-  version: 2.2.5
-  prerelease: 
+  version: 2.2.6
 platform: ruby
 authors:
 - Dominik Honnef
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-03-30 00:00:00.000000000 Z
+date: 2015-07-08 00:00:00.000000000 Z
 dependencies: []
 description: A simple, friendly DSL for creating IRC bots
 email:
@@ -18,127 +17,125 @@ executables: []
 extensions: []
 extra_rdoc_files: []
 files:
+- ".yardopts"
 - LICENSE
 - README.md
-- .yardopts
-- docs/changes.md
-- docs/getting_started.md
-- docs/readme.md
 - docs/bot_options.md
+- docs/changes.md
 - docs/common_mistakes.md
-- docs/events.md
-- docs/plugins.md
+- docs/common_tasks.md
 - docs/encodings.md
+- docs/events.md
+- docs/getting_started.md
 - docs/logging.md
-- docs/common_tasks.md
 - docs/migrating.md
-- lib/cinch/formatting.rb
-- lib/cinch/channel.rb
-- lib/cinch/timer.rb
-- lib/cinch/sasl/diffie_hellman.rb
-- lib/cinch/sasl/plain.rb
-- lib/cinch/sasl/dh_blowfish.rb
-- lib/cinch/sasl/mechanism.rb
-- lib/cinch/network.rb
-- lib/cinch/sasl.rb
-- lib/cinch/cached_list.rb
-- lib/cinch/bot.rb
-- lib/cinch/isupport.rb
+- docs/plugins.md
+- docs/readme.md
+- examples/basic/autovoice.rb
+- examples/basic/google.rb
+- examples/basic/hello.rb
+- examples/basic/join_part.rb
+- examples/basic/memo.rb
+- examples/basic/msg.rb
+- examples/basic/seen.rb
+- examples/basic/urban_dict.rb
+- examples/basic/url_shorten.rb
+- examples/plugins/autovoice.rb
+- examples/plugins/custom_prefix.rb
+- examples/plugins/dice_roll.rb
+- examples/plugins/google.rb
+- examples/plugins/hello.rb
+- examples/plugins/hooks.rb
+- examples/plugins/join_part.rb
+- examples/plugins/lambdas.rb
+- examples/plugins/last_nick.rb
+- examples/plugins/msg.rb
+- examples/plugins/multiple_matches.rb
+- examples/plugins/own_events.rb
+- examples/plugins/seen.rb
+- examples/plugins/timer.rb
+- examples/plugins/url_shorten.rb
+- lib/cinch.rb
 - lib/cinch/#channel.rb#
-- lib/cinch/helpers.rb
-- lib/cinch/handler.rb
-- lib/cinch/handler_list.rb
-- lib/cinch/rubyext/module.rb
-- lib/cinch/rubyext/float.rb
-- lib/cinch/rubyext/string.rb
-- lib/cinch/syncable.rb
-- lib/cinch/plugin_list.rb
-- lib/cinch/message.rb
-- lib/cinch/target.rb
-- lib/cinch/mask.rb
-- lib/cinch/configuration/sasl.rb
+- lib/cinch/ban.rb
+- lib/cinch/bot.rb
+- lib/cinch/cached_list.rb
+- lib/cinch/callback.rb
+- lib/cinch/channel.rb
+- lib/cinch/channel_list.rb
+- lib/cinch/configuration.rb
 - lib/cinch/configuration/bot.rb
+- lib/cinch/configuration/dcc.rb
 - lib/cinch/configuration/plugins.rb
+- lib/cinch/configuration/sasl.rb
 - lib/cinch/configuration/ssl.rb
-- lib/cinch/configuration/dcc.rb
 - lib/cinch/configuration/timeouts.rb
-- lib/cinch/pattern.rb
-- lib/cinch/open_ended_queue.rb
-- lib/cinch/logger_list.rb
-- lib/cinch/callback.rb
-- lib/cinch/dcc.rb
-- lib/cinch/version.rb
-- lib/cinch/utilities/deprecation.rb
-- lib/cinch/utilities/kernel.rb
-- lib/cinch/utilities/encoding.rb
 - lib/cinch/constants.rb
-- lib/cinch/mode_parser.rb
-- lib/cinch/user.rb
-- lib/cinch/logger/formatted_logger.rb
-- lib/cinch/logger/zcbot_logger.rb
-- lib/cinch/exceptions.rb
-- lib/cinch/logger.rb
-- lib/cinch/plugin.rb
-- lib/cinch/user_list.rb
-- lib/cinch/dcc/incoming/send.rb
+- lib/cinch/dcc.rb
 - lib/cinch/dcc/dccable_object.rb
-- lib/cinch/dcc/outgoing.rb
 - lib/cinch/dcc/incoming.rb
+- lib/cinch/dcc/incoming/send.rb
+- lib/cinch/dcc/outgoing.rb
 - lib/cinch/dcc/outgoing/send.rb
+- lib/cinch/exceptions.rb
+- lib/cinch/formatting.rb
+- lib/cinch/handler.rb
+- lib/cinch/handler_list.rb
+- lib/cinch/helpers.rb
 - lib/cinch/irc.rb
-- lib/cinch/channel_list.rb
-- lib/cinch/ban.rb
+- lib/cinch/isupport.rb
+- lib/cinch/logger.rb
+- lib/cinch/logger/formatted_logger.rb
+- lib/cinch/logger/zcbot_logger.rb
+- lib/cinch/logger_list.rb
+- lib/cinch/mask.rb
+- lib/cinch/message.rb
 - lib/cinch/message_queue.rb
-- lib/cinch/configuration.rb
-- lib/cinch.rb
-- examples/plugins/timer.rb
-- examples/plugins/msg.rb
-- examples/plugins/dice_roll.rb
-- examples/plugins/lambdas.rb
-- examples/plugins/join_part.rb
-- examples/plugins/google.rb
-- examples/plugins/autovoice.rb
-- examples/plugins/multiple_matches.rb
-- examples/plugins/url_shorten.rb
-- examples/plugins/own_events.rb
-- examples/plugins/seen.rb
-- examples/plugins/last_nick.rb
-- examples/plugins/hooks.rb
-- examples/plugins/hello.rb
-- examples/plugins/custom_prefix.rb
-- examples/basic/msg.rb
-- examples/basic/join_part.rb
-- examples/basic/google.rb
-- examples/basic/autovoice.rb
-- examples/basic/url_shorten.rb
-- examples/basic/memo.rb
-- examples/basic/seen.rb
-- examples/basic/urban_dict.rb
-- examples/basic/hello.rb
+- lib/cinch/mode_parser.rb
+- lib/cinch/network.rb
+- lib/cinch/open_ended_queue.rb
+- lib/cinch/pattern.rb
+- lib/cinch/plugin.rb
+- lib/cinch/plugin_list.rb
+- lib/cinch/rubyext/float.rb
+- lib/cinch/rubyext/module.rb
+- lib/cinch/rubyext/string.rb
+- lib/cinch/sasl.rb
+- lib/cinch/sasl/dh_blowfish.rb
+- lib/cinch/sasl/diffie_hellman.rb
+- lib/cinch/sasl/mechanism.rb
+- lib/cinch/sasl/plain.rb
+- lib/cinch/syncable.rb
+- lib/cinch/target.rb
+- lib/cinch/timer.rb
+- lib/cinch/user.rb
+- lib/cinch/user_list.rb
+- lib/cinch/utilities/deprecation.rb
+- lib/cinch/utilities/encoding.rb
+- lib/cinch/utilities/kernel.rb
+- lib/cinch/version.rb
 homepage: http://cinchrb.org
 licenses:
 - MIT
+metadata: {}
 post_install_message: 
 rdoc_options: []
 require_paths:
 - lib
 required_ruby_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: 1.9.1
 required_rubygems_version: !ruby/object:Gem::Requirement
-  none: false
   requirements:
-  - - ! '>='
+  - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 1.8.23
+rubygems_version: 2.4.5
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: An IRC Bot Building Framework
 test_files: []
-has_rdoc: yard