iirc 0.6.1 → 0.6.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d37d0f934314b8e8eeb5fd4ea354eafcc202ccc4bc567d380c80654717315fbe
-  data.tar.gz: 89ffd1535419115092ecb43111b849a28cde83dccf4e91b7203bc1aef74d8fc8
+  metadata.gz: 49f724afe62aa2f76c2d5effda29ce98c9f9b5ae8d83f175ac0de51385e9c431
+  data.tar.gz: e61a5053975303f7e45dc4be44f3cebddc63a3171a984c1785fcae666be27d07
 SHA512:
-  metadata.gz: 07fc79ea88bd32e3af37fa05da4c18dcd532aff0d9bd1e458394293a009ba3b6166bd1d80ec55f4c041ecd42b206773ed6b445fc0983dc83c53ec3566d9c2388
-  data.tar.gz: 428284505861a86036420d2f4cc9924327364f5195b683364d20def329335a69377408a8b12c01aa442dee1e205977d5f2dd8d68f6778c4e4d37c48648736e12
+  metadata.gz: fc76b8e4d7455058a20dff37d6d29cb0082d69b65681a0e36b7eeccb7abdb25cf58b52bbb23bb652c34747756e0352e2969bb99a669349cada61041cfcdd0dec
+  data.tar.gz: 3c4a85314c46eb87752f1a85e2235d1744a0e2f3b9a024af7c5bc5e8b7a604d505edf9905022393bacb973b7bfd7e94da815321cba5d651cea21776d1dc07486

data/CHANGELOG.md

@@ -1,3 +1,8 @@
+## [0.6.2] - 2022-04-28
+
+- [Event]  Add CTCP parsing methods
+- [Sender] Nick is the server name when sender is a server
+
 ## [0.6.1] - 2022-04-01
 
 - Add SedBot example

data/lib/iirc/bot.rb

@@ -21,6 +21,10 @@ module IIRC
       super() if defined? super
       self.socket = socket
       self.user = user.is_a?(User) ? user : User.new(**user)
+
+      if !user.key?(:nick)
+        self.user.nick ||= self.class.name&.split('::')&.last
+      end
     end
 
     def register!
@@ -35,4 +39,4 @@ module IIRC
       raise ArgumentError.new('no nick given') unless me.nick && !me.nick.empty?
     end
   end
-end
+end

data/lib/iirc/event.rb

@@ -28,5 +28,39 @@ module IIRC
     def message
       args.last
     end
+
+    CTCP_REGEX = /^\x01(\w+)(?: ([^\x01]+))?\x01?$/
+
+    def ctcp?
+      message&.match?(CTCP_REGEX)
+    end
+
+    def ctcp_verb
+      $1.downcase.to_sym if message =~ CTCP_REGEX
+    end
+
+    def ctcp_message
+      $2 if message =~ CTCP_REGEX
+    end
+
+    # Parses CTCP data in message, returning nil or an Array like [:action, "does the Macarena"], [:version], [:version, "SomeClient v0.1"]
+    # @example Pattern matching (case)
+    #   case evt.ctcp
+    #   in [:action, msg]
+    #     say "#{evt.nick} did an action: #{italic msg}"
+    #   in [:version]
+    #     say "\x01VERSION Ruby IIRC (v#{IIRC::VERSION})\x01"
+    #   in [:dcc, type, *]
+    #     say "You want to start a DCC #{type} with me? Are you crazy!?"
+    #   else
+    #   end
+    # @example Pattern matching (if)
+    #   on(:privmsg, :be_annoying) { |evt|
+    #     act "#{thing} also" if [:action, thing] in evt.ctcp
+    #   }
+    # @return [Array<Symbol, String?>, nil] CTCP verb and text content, if any (e.g. [:action, "says hello"], [:clientinfo], [:version, "SomeClient v0.1"])
+    def ctcp
+      [ctcp_verb, ctcp_message].compact if ctcp?
+    end
   end
 end

data/lib/iirc/modules/autojoin.rb

@@ -8,7 +8,7 @@ module IIRC
       on :'001', :autojoin!
     end
 
-    # Send JOIN for each {#autojoin_channel}
+    # Send JOIN for each in {#autojoin_channels}
     # @return [Array<String>] channels joined
     def autojoin!
       for channel in autojoin_channels

data/lib/iirc/modules/hooks.rb

@@ -7,8 +7,7 @@ module IIRC
     def run
       lines { |line|
         begin
-          evt = parse(line)
-          fire! evt.verb, evt
+          self >> line
         rescue Exception => ex
           puts ex.message
           puts ex.backtrace
@@ -16,6 +15,11 @@ module IIRC
       }
     end
 
+    def >>(line)
+      evt = parse(line)
+      fire! evt.verb, evt
+    end
+
     def on verb=nil, action=nil, &blk
       if action and blk
         define_singleton_method(action, blk)

data/lib/iirc/modules/isupport.rb

@@ -20,9 +20,14 @@ module IIRC
 
     private
       def configure_isupport
+        on :'001', :clear_isupport
         on :'005', :store_isupport
       end
 
+      def clear_isupport
+        @isupport = nil
+      end
+
       def store_isupport(evt)
         tokens = evt.args[1..-2]
 
@@ -66,5 +71,20 @@ module IIRC
     def channel_prefixes
       (@channel_prefixes ||= self['CHANTYPES']&.chars.freeze) || ['#'].freeze
     end
+
+    # Modes which grant privileges to a user in a channel and their respective
+    # prefix characters seen in NAMES, WHO and WHOIS replies.
+    # @see https://modern.ircdocs.horse/#channel-membership-prefixes
+    # @example qaohv
+    #   isupport.prefix_modes # => {'q'=>'~', 'a'=>'&', 'o'=>'@', 'h'=>'%', 'v'=>'+'}
+    # @return [Hash<String,String>] channel mode => prefix character
+    def prefix_modes
+      if self['PREFIX'].is_a? String
+        modes, symbols = self['PREFIX'][1..].split(')').map!(&:chars)
+        Hash[modes.zip(symbols)].freeze
+      else
+        {}.freeze
+      end
+    end
   end
 end

data/lib/iirc/sender.rb

@@ -31,9 +31,9 @@ module IIRC
       not user.nil?
     end
 
-    def nick; user&.nick end
+    def nick; user ? user.nick : without_leading_colon end
     def username; user&.username end
-    def host; server? ? without_leading_colon : user.host end
+    def host; user ? user.host : without_leading_colon end
 
     def to_prefix
       ":#{self}"
@@ -48,8 +48,9 @@ module IIRC
   end
 
   module_function
-    # Extends and returns a source string with the IIRC::Sender mixin.
-    # Duplicates first if the string is frozen. Returns nil if source is nil.
+    # Adds the IIRC::Sender mixin to a string. 
+    # If the string is frozen, a copy is returned. 
+    # If the source is nil, nil is returned.
     #
     # @example :nick!user@host
     #   v = IIRC.Sender(":JimmyWales!jim@wikipedia.org") # => "JimmyWales!jim@wikipedia.org"
@@ -66,4 +67,4 @@ module IIRC
         (source.frozen? ? source.dup : source).extend(Sender)
       end
     end
-end
+end

data/lib/iirc/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module IIRC
-  VERSION = "0.6.1"
+  VERSION = "0.6.2"
 end

data/lib/iirc.rb

@@ -49,8 +49,6 @@ module IIRC
         local_host: local_host, local_port: local_port,
         ssl_context: ssl_context)
 
-      user_params[:nick] = self.name&.split('::').last if !user_params.key?(:nick)
-
       new(socket, **user_params).tap { |bot|
         bot.register!
         bot.tap(&blk) if blk

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iirc
 version: !ruby/object:Gem::Version
-  version: 0.6.1
+  version: 0.6.2
 platform: ruby
 authors:
 - mooff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-04-01 00:00:00.000000000 Z
+date: 2022-04-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ircparser