iirc 0.2.9 → 0.4.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2b3e9c48299d3d224743658cf8f5ccb1fa350fa748c8319fccd0d1a2c7154f81
-  data.tar.gz: 7675b9b55b30fb8a66c96aaccae46a4cd60c1381d8d79a1d4b9e1fdd13ccc6e9
+  metadata.gz: 2e4ac6446425ac435d2277035d20421968eb778ba3ff980adc1a81a77e9822ef
+  data.tar.gz: 4c19e2b02319359014d0d9f14a5a9d1f757a948bac14bcc5152635dbb7412e50
 SHA512:
-  metadata.gz: 7f5f6743fd668c3da81091b5ae865e32bc83685166d4802bccd3bcd19c8dc2aebff176cb41b0cbb986b8b01c0e8ebeef527bdc4f099b6d327a4cca15e43ec6a9
-  data.tar.gz: df2a11d9936e4744581fa0cf8196a424692272f72f439acf18384ebb9afb122835637475e7d97618a81a5f291efe37f42dca378021d18b7b0246722dc86b564a
+  metadata.gz: 1db175bc3db1cbc464652f8ba5e7153e087851bc803adccd4d8434420095d0431f4e41b2ff31122333ba29895d7c66f609ea3d11d6f7d76f1b0024dbbc55d8f4
+  data.tar.gz: a759db9e4264a582b373bc708948330ea58a26639e66e9610cc9258e3965f810de0101ad97acb6ca095c4a926de4899526e64cc53f46391b0ae91006a8b03114

data/.yardopts

@@ -0,0 +1 @@
+--markup=markdown --private --protected

data/CHANGELOG.md

@@ -1,3 +1,34 @@
+## [0.4.1] - 2022-03-29
+
+- [ISupport] Add module to process RPL_ISUPPORT
+- [ISupport] Add Inquiry helpers + docs
+
+## [0.4.0] - 2022-03-27
+
+- [Numerics] Add module with constants imported from ircdocs.horse
+  - Run `rake numerics` to re-import.
+
+- [IIRC.run,IIRC.dial] Support passing a symbol as ssl_context
+	- e.g. ssl_context: :no_verify instead of ssl_context: IIRC::SSL.no_verify
+
+- The AmbientEvents modules have been reorganised
+  - AmbientVerbs is now Ambient::Verbs
+  - AmbientEvents => Ambient::Events
+  - AmbientEvents::{LabeledRequests,ReplyTarget} => Ambient::{LabeledRequests,ReplyTarget}
+
+- #ambient_reply_target() has been replaced with #reply_target(evt=ambient_event)
+
+- [Bot.run] Set nick to class name if no param is given
+  - `MyBot.run('irc.libera.chat')` is enough to connect to Libera as 'MyBot'
+
+## [0.3.0] - 2022-03-26
+
+- [Bot] Include ReplyTarget
+- [Hooks] Refactor
+- Add AcceptInvites module
+- Improve Greeter example
+- [IIRC.run,IIRC.dial] now accept local_host, local_port keyword arguments
+
 ## [0.2.9] - 2022-03-24
 
 - Add reply target concept (Bot::ReplyTarget)

data/Gemfile

@@ -8,3 +8,6 @@ gemspec
 gem "rake", "~> 13.0"
 
 gem "minitest", "~> 5.0"
+
+gem "redcarpet", "= 3.5.1" # for Markdown docs (README.md)
+gem "yard"

data/README.md

@@ -1,8 +1,26 @@
 # Lean, mean IRC processing machine
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/iirc`. To experiment with that code, run `bin/console` for an interactive prompt.
+```ruby
+require 'iirc'
+
+class CoolBot < IIRC::IRCv3Bot
+  include Verbs
+
+  def configure_coolness
+    on /^!poke/, :poke_back
+  end
 
-TODO: Delete this and the text above, and describe your gem
+  def poke_back(evt)
+    act "pokes #{evt.sender.nick} back!!!"
+  end
+
+  def autojoin_channels
+    ['##coolness']
+  end
+end
+
+CoolBot.run 'irc.libera.chat' if __FILE__ == $0
+```
 
 ## Installation
 
@@ -22,7 +40,7 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+TODO: Flesh out usage instructions here
 
 ## Development
 

data/Rakefile

@@ -15,4 +15,63 @@ RDoc::Task.new do |rd|
   rd.options = ["--all"]
 end
 
+task :numerics do
+  require 'yaml'
+  require 'open-uri'
+
+  data = YAML.load URI.open('https://raw.githubusercontent.com/ircdocs/irc-defs/gh-pages/_data/numerics.yaml')
+  revision = data['file']['revision']
+
+  puts "Loaded numerics.yaml revision #{revision}"
+
+  open(File.join(__dir__, 'lib/iirc/numerics.rb'), 'w+') do |out|
+    out << <<~HEADER
+      module IIRC
+        # Definitions imported from ircdocs.horse
+        # @version #{revision}
+        # @see https://raw.githubusercontent.com/ircdocs/irc-defs/gh-pages/_data/numerics.yaml
+        # @see https://defs.ircdocs.horse/defs/numerics.html
+        module Numerics
+    HEADER
+
+    values = data['values'].reject { |v| v['obsolete'] }
+    counts = values.map { |v| v['name'] }.tally
+
+    constants = {}
+
+    for row in values
+      out << "    # #{row['comment'].squeeze(' ').tr("\r", '').gsub("\n", ' ').strip}\n" if row['comment']
+      out << "    # @format #{row['numeric']} #{row['format'].strip}\n" if row['format']
+
+      name = row['name']
+      if counts[name] > 1 and row['origin']
+        name += '_' + row['origin'].gsub(/[^[:alnum:]]/, '_').gsub(/_{2,}/, '_').sub(/_$/, '').upcase
+      end
+      if constants[name]
+        name += '_ALT'
+        if constants[name]
+          fail <<~MSG
+            Couldn't derive a unique name for #{name}.
+            Previous source: #{constants[name].inspect}
+          MSG
+        end
+      end
+
+      constants[name] = row
+
+      out << "    #{name} = #{row['numeric'].to_sym.inspect}"
+      out << "\n"
+    end
+
+    out << <<~FOOTER
+        end
+      end
+    FOOTER
+  end
+
+  puts "%d numerics." % data['values'].count
+  system('wc', File.join(__dir__, 'lib/iirc/numerics.rb'))
+end
+
 task default: :test
+

data/examples/greeter.rb

@@ -3,9 +3,10 @@ require "iirc"
 class Greeter < IIRC::Bot
   include AutoJoin
   include Verbs
+  include PrintIO
 
   def on_join(evt)
-    say evt.target, "Hello #{evt.sender.nick}!"
+    say evt.target, "Hello #{evt.sender.nick}!" unless me === evt.sender
   end
 
   def autojoin_channels

data/lib/iirc/bot/accept_invites.rb

@@ -0,0 +1,22 @@
+module IIRC
+  module Bot::AcceptInvites
+    # Override this to decide whether we should accept a given invite.
+    # By default, all invites are accepted.
+    # @param [Event]
+    # @return [true] if we should join the channel
+    def accept_invite?(evt)
+      true
+    end
+
+    private
+      def configure_accept_invites
+        on :invite, :accept_invites
+      end
+
+      def accept_invites(evt)
+        if me === evt.target and accept_invite?(evt)
+          join evt.args[1]
+        end
+      end
+  end
+end

data/lib/iirc/bot/ambient.rb

@@ -1,60 +1,61 @@
 require_relative "reply_target"
 
 module IIRC
-  module Bot::AmbientEvents
-    private
-      def configure_ambient_events
-        hook :set_ambient_event
-      end
+  module Bot::Ambient
+    module Events
+      private
+        def configure_ambient_events
+          hook :set_ambient_event
+        end
 
-      def ambient_event
-        Thread.current[:ambient_event]
-      end
+        def ambient_event
+          Thread.current[:ambient_event]
+        end
 
-      def ambient_target; ambient_event&.target; end
-      def ambient_sender; ambient_event&.sender; end
+        def ambient_target; ambient_event&.target; end
+        def ambient_sender; ambient_event&.sender; end
 
-      def set_ambient_event(evt)
-        Thread.current[:ambient_event] = evt
-      end
+        def set_ambient_event(evt)
+          Thread.current[:ambient_event] = evt
+        end
 
-      def with_ambient_event(evt)
-        initial_event = ambient_event
-        set_ambient_event(evt)
-        begin
-          yield evt
-        ensure
-          set_ambient_event(initial_event)
+        def with_ambient_event(evt)
+          initial_event = ambient_event
+          set_ambient_event(evt)
+          begin
+            yield evt
+          ensure
+            set_ambient_event(initial_event)
+          end
         end
-      end
-  end
+    end
 
-  module Bot::AmbientEvents::LabeledRequests
-    def labeled_request(*)
-      initial_evt = ambient_event
-      super do |reply|
-        with_ambient_event(initial_evt) { yield reply }
+    module LabeledRequests
+      def labeled_request(*)
+        initial_evt = ambient_event
+        super do |reply|
+          with_ambient_event(initial_evt) { yield reply }
+        end
       end
     end
-  end
 
-  module Bot::AmbientEvents::ReplyTarget
-    include Bot::ReplyTarget
-    def ambient_reply_target
-      reply_target(ambient_event)
+    module ReplyTarget
+      def reply_target(evt=ambient_event) super end
+    end
+
+    module Verbs
+      include Events
+      include ReplyTarget
+
+      def join(channel=reply_target) super end
+      def part(channel=reply_target, reason='') super end
+      def msg(target=reply_target, msg) super end
+      def act(target=reply_target, msg) super end
+      def cycle(channel=reply_target, reason='') super end
+      def mode(target=reply_target, mode) super end
+      alias :say :msg
     end
-  end
 
-  module Bot::AmbientVerbs
-    include Bot::AmbientEvents
-    include Bot::AmbientEvents::ReplyTarget
-
-    def join(channel=ambient_reply_target) super end
-    def part(channel=ambient_reply_target, reason='') super end
-    def msg(channel=ambient_reply_target, msg) super end
-    def act(channel=ambient_reply_target, msg) super end
-    def cycle(channel=ambient_reply_target, reason='') super end
-    def mode(channel=ambient_reply_target, mode) super end
-    alias :say :msg
+    include Verbs
   end
-end
+end

data/lib/iirc/bot/hooks.rb

@@ -4,6 +4,18 @@ module IIRC
       @hooks ||= Hash.new { |h,v| h[v] = Set.new }
     end
 
+    def run
+      lines { |line|
+        begin
+          evt = parse(line)
+          fire! evt.verb, evt
+        rescue Exception => ex
+          puts ex.message
+          puts ex.backtrace
+        end
+      }
+    end
+
     def on verb=nil, action=nil, &blk
       if action and blk
         define_singleton_method(action, blk)
@@ -17,10 +29,6 @@ module IIRC
       end
     end
 
-    def hook action=nil, &blk
-      on nil, action, &blk
-    end
-
     def off verb, action=nil, &blk
       action ||= blk
       if action
@@ -30,14 +38,12 @@ module IIRC
       end
     end
 
+    def hook action=nil, &blk
+      on nil, action, &blk
+    end
+
     def fire! verb, *args, **kwargs
-      for action in hooks[nil]
-        call action, *args, **kwargs
-      end
-      if respond_to? :"on_#{verb}"
-        send(:"on_#{verb}", *args, **kwargs)
-      end
-      for action in hooks[verb]
+      for action in hook_seq(verb)
         call action, *args, **kwargs
       end
     rescue StopIteration
@@ -54,16 +60,9 @@ module IIRC
       end
     end
 
-    def run
-      lines { |line|
-        begin
-          evt = parse(line)
-          fire! evt.verb, evt
-        rescue Exception => ex
-          puts ex.message
-          puts ex.backtrace
-        end
-      }
-    end
+    protected
+      def hook_seq(verb)
+        [*hooks[nil], (:"on_#{verb}" if respond_to?(:"on_#{verb}")), *hooks[verb]].compact
+      end
   end
-end
+end

data/lib/iirc/bot/ircv3/parsing.rb

@@ -4,7 +4,7 @@ module IIRC
       autoload :IRCParser, 'ircparser'
 
       def parse(line)
-        msg = IRCParser::Message.parse(line.chomp)
+        msg = IRCParser::Message.parse(line.tr("\r", '').chomp)
 
         Event.new.tap { |evt|
           evt.sender = IRCParser::RFCWireFormat.__stringify_prefix(msg.prefix) if msg.prefix

data/lib/iirc/bot/isupport.rb

@@ -0,0 +1,70 @@
+# frozen_string_literal: true
+
+module IIRC
+  # Parses RPL_ISUPPORT (005) events into a Hash.
+  #
+  # These are sent by servers after registration to provide info about the network,
+  # what the server supports, and how it behaves.
+  #
+  # Provides a Hash of the raw values, extended with helper methods which process them.
+  #
+  # @see https://defs.ircdocs.horse/defs/isupport.html List of tokens and their values (defs.ircdocs.horse)
+  # @see https://datatracker.ietf.org/doc/html/draft-hardy-irc-isupport-00
+  # @see https://datatracker.ietf.org/doc/html/draft-brocklesby-irc-isupport-00
+  module Bot::ISupport
+    # Hash of tokens sent by the server after registration indicating feature support and limits.
+    # @return [Hash#extend(Inquiry)] the raw isupport key=>value pairs. keys with no value are assigned +true+.
+    def isupport
+      @isupport ||= {}.extend(Inquiry)
+    end
+
+    private
+      def configure_isupport
+        on :'005', :store_isupport
+      end
+
+      def store_isupport(evt)
+        tokens = evt.args[1..-2]
+
+        for token in tokens
+          name, value = token.split('=', 2)
+          isupport[name] = value.freeze || true
+        end
+      end
+  end
+
+  # Methods for inquiry into a Hash of raw ISUPPORT key=>value pairs.
+  # These are mixed in to the Hash returned by {ISupport#isupport}.
+  #
+  # The key=>value format returned by #isupport won't change.
+  # Rather, methods which process the values can be added here.
+  module Bot::ISupport::Inquiry
+    # Whether or not the server supports a user mode which lets clients mark themselves as bots.
+    def bot_mode?
+      !!bot_mode
+    end
+
+    # User mode which can be used to mark clients as bots.
+    # @return [String] mode char (usually 'B')
+    # @return [nil] if mode is not supported
+    def bot_mode
+      self['BOT']
+    end
+
+    # A string indicating the case mapping used by the server to determine case-insensitive equality
+    # of channel names and nick names.
+    #
+    # @note IIRC does not currently perform case-insensitive comparisons. This may change in future.
+    # @return [String] the name of the casemapping. e.g. 'ascii', 'rfc1459', 'rfc3454'
+    def case_mapping
+      self['CASEMAPPING']
+    end
+
+    # Characters used as channel prefixes by this server.
+    # @see https://defs.ircdocs.horse/defs/chantypes.html
+    # @return [Array] prefixes, e.g. ['#', '&']
+    def channel_prefixes
+      (@channel_prefixes ||= self['CHANTYPES']&.chars.freeze) || ['#'].freeze
+    end
+  end
+end

data/lib/iirc/bot/members.rb

@@ -1,15 +1,11 @@
 module IIRC
   module Bot::Members
-    def self.configure_actions
-      [:listen_for_names]
-    end
-
     def members
       @members ||= {}
     end
 
     private
-      def listen_for_names
+      def configure_members_tracking
         on :'353', :receive_names
         on :'366', :receive_names_end
       end

data/lib/iirc/bot.rb

@@ -30,7 +30,7 @@ module IIRC
     end
 
     private def ensure_registration_info!
-      me.username ||= me.nick.downcase
+      me.username ||= me.nick&.downcase
       me.realname ||= me.nick
       raise ArgumentError.new('no nick given') unless me.nick && !me.nick.empty?
     end