iirc 0.2.7 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d5f568a48b28bcd4d10bdf613db4baa4451514e26d77acdbf18d9c988fd8792f
-  data.tar.gz: 2f384b6fd3f8f7e3e43b8b714baad42de702733f0634736abc8a6ede67bb52d9
+  metadata.gz: 4c856c393db0b7645fa204d003750816cda3ce860b2be538e523f7d8bcf56b4e
+  data.tar.gz: 74252990a51523295d3dc788579b1f7ea456a995939e35d8c6004556742b7117
 SHA512:
-  metadata.gz: a6b72bfb5048226f87c4d5c8e3d8471885fea226c970da825c66dd8189642a9908e39fabb050a3867c3ddf794eee25e713006333c875164f04707c3bb42459bf
-  data.tar.gz: d0876472a0c3f099f0001555191456ee666033377a2180bcaafa74360b7c46f10277be431c4590b557b7a174f4ca409eea0be7b0ad5644bd8aee4203ee8eefc5
+  metadata.gz: 1c02d3b4eac6f4bebb0d2cb46e9241594021f07cb4fa2464508203bab3f1402f98901dd138efa1676d2de7fa678ac3117b08256ae819658c02819ff7dc2adeed
+  data.tar.gz: bb1fbf17c4f574f099a1b0c47d4e6aa087658c51137c8019facc151ccfd93591125c45b5bd327af6e75a85ae0d3f8ccea434da78b424c5f1c563c8f281413c2e

data/CHANGELOG.md

@@ -1,3 +1,22 @@
+## [0.3.0] - 2022-03-26
+
+- [Bot] Include ReplyTarget
+- [Hooks] Refactor
+- Add AcceptInvites module
+- Improve Greeter example
+
+## [0.2.9] - 2022-03-24
+
+- Add reply target concept (Bot::ReplyTarget)
+  - The reply target of an event is the sender's nick when we are its target,
+    and equal to the regular target otherwise.
+  - The ambient verb methods now target the reply target of the ambient event by default.
+  - Should make writing actions more convenient.
+
+## [0.2.8] - 2022-03-22
+
+- Add MIT license
+
 ## [0.2.7] - 2022-03-16
 
 - Include Bot::RegexHooks in Batteries

data/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2022 mooff <mooff@awful.cooking>
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/Rakefile

@@ -2,6 +2,7 @@
 
 require "bundler/gem_tasks"
 require "rake/testtask"
+require "rdoc/task"
 
 Rake::TestTask.new(:test) do |t|
   t.libs << "test"
@@ -9,4 +10,9 @@ Rake::TestTask.new(:test) do |t|
   t.test_files = FileList["test/**/*_test.rb"]
 end
 
+RDoc::Task.new do |rd|
+  rd.rdoc_files.include("lib/**/*.rb")
+  rd.options = ["--all"]
+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/iirc.gemspec

@@ -7,6 +7,7 @@ Gem::Specification.new do |spec|
   spec.version       = IIRC::VERSION
   spec.authors       = ["mooff"]
   spec.email         = ["mooff@awful.cooking"]
+  spec.license       = "MIT"
 
   spec.summary       = "Lean, mean IRC processing machine"
   spec.description   = "A composable toolkit for IRC bots"

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,3 +1,5 @@
+require_relative "reply_target"
+
 module IIRC
   module Bot::AmbientEvents
     private
@@ -27,18 +29,6 @@ module IIRC
       end
   end
 
-  module Bot::AmbientVerbs
-    include Bot::AmbientEvents
-
-    def join(channel=ambient_target) super end
-    def part(channel=ambient_target, reason='') super end
-    def msg(channel=ambient_target, msg) super end
-    def act(channel=ambient_target, msg) super end
-    def cycle(channel=ambient_target, reason='') super end
-    def mode(channel=ambient_target, mode) super end
-    alias :say :msg
-  end
-
   module Bot::AmbientEvents::LabeledRequests
     def labeled_request(*)
       initial_evt = ambient_event
@@ -47,4 +37,24 @@ module IIRC
       end
     end
   end
+
+  module Bot::AmbientEvents::ReplyTarget
+    include Bot::ReplyTarget
+    def ambient_reply_target
+      reply_target(ambient_event)
+    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
+  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/reply_target.rb

@@ -0,0 +1,14 @@
+module IIRC
+  module Bot::ReplyTarget
+    # The +reply_target+ of an event is the sender's nickname when _we_ are the
+    # +target+. Otherwise, it returns the regular +target+.
+    #
+    # It lets us reply to events without having to repeat the `(me ===
+    # target) ? sender.nick : target` logic used to make sure we don't message
+    # ourselves when we receive a direct PRIVMSG, NOTICE, etc.
+
+    def reply_target(evt)
+      (me === evt.target) ? evt.sender.nick : evt.target
+    end
+  end
+end

data/lib/iirc/event.rb

@@ -10,8 +10,7 @@ module IIRC
     end
 
     def sender=(v)
-      v.extend Sender if v
-      @sender = v
+      @sender = IIRC::Sender(v)
     end
 
     def args=(v)

data/lib/iirc/sender.rb

@@ -1,7 +1,26 @@
 module IIRC
+  # A mixin which adds IRC hostmask introspection methods to strings.
+  #
+  # *CoolNick*, *:NickName*, <b>:nick!user@host</b>, *:server.name*, *another.server.name* forms are supported.
+  #
+  # A leading colon may be present in the string, and will be ignored.
+  #
+  # @example nick!user@example.com
+  #   sender = "nick!user@example.com".extend(IIRC::Sender)
+  #   sender.user? # => true
+  #   sender.host  # => "example.com"
+  # @example :irc.server
+  #   sender = ":irc.server".extend(IIRC::Sender)
+  #   sender.server? # => true
+  #   sender.host    # => "irc.server"
+  # @example JimBob
+  #   sender = "JimBob".extend(IIRC::Sender)
+  #   sender.user? # => true
+  #   sender.nick  # => "JimBob"
+
   module Sender
     def user
-      @user ||= User.from_sender(self)
+      @user ||= User.from_source(self)
     end
 
     def server?
@@ -14,16 +33,37 @@ module IIRC
 
     def nick; user&.nick end
     def username; user&.username end
-    def host; user&.host end
+    def host; server? ? without_leading_colon : user.host end
 
     def to_prefix
       ":#{self}"
     end
 
-    def to_s
+    def without_leading_colon
       delete_prefix(':')
     end
 
+    alias :to_s :without_leading_colon
     alias :inspect :to_prefix
   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.
+    #
+    # @example :nick!user@host
+    #   v = IIRC.Sender(":JimmyWales!jim@wikipedia.org") # => "JimmyWales!jim@wikipedia.org"
+    #   v.nick    # => "JimmyWales"
+    #   v.host    # => "wikipedia.org"
+    #   v.user?   # => true
+    # @example server.name
+    #   IIRC.Sender("services.libera.chat").server? # => true
+
+    def Sender(source)
+      if source.nil?
+        nil
+      else
+        (source.frozen? ? source.dup : source).extend(Sender)
+      end
+    end
 end

data/lib/iirc/version.rb

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

data/lib/iirc.rb

@@ -5,6 +5,7 @@ require_relative "iirc/sender"
 require_relative "iirc/user"
 
 require_relative "iirc/bot"
+require_relative "iirc/bot/accept_invites"
 require_relative "iirc/bot/ambient"
 require_relative "iirc/bot/autojoin"
 require_relative "iirc/bot/channels"
@@ -19,6 +20,7 @@ require_relative "iirc/bot/print_io"
 require_relative "iirc/bot/reading"
 require_relative "iirc/bot/redis"
 require_relative "iirc/bot/regex_hooks"
+require_relative "iirc/bot/reply_target"
 require_relative "iirc/bot/track_own_nick"
 require_relative "iirc/bot/verbs"
 
@@ -37,9 +39,12 @@ module IIRC
     include Configure
     include Pong
     include TrackOwnNick
+    include ReplyTarget
 
-    def self.run(host, port=6697, ssl_context: SSL.default_context, **user_params, &blk)
-      socket = IIRC.dial(host, port, ssl_context: ssl_context)
+    def self.run(host, port=6697, local_host: nil, local_port: nil, ssl_context: SSL.default_context, **user_params, &blk)
+      socket = IIRC.dial(host, port,
+        local_host: local_host, local_port: local_port,
+        ssl_context: ssl_context)
 
       new(socket, **user_params).tap { |bot|
         bot.register!
@@ -99,10 +104,10 @@ module IIRC
   end
 
   module_function
-    def dial(host, port=6697, ssl_context: SSL.default_context)
+    def dial(host, port=6697, local_host: nil, local_port: nil, ssl_context: SSL.default_context)
       require 'socket'
 
-      Socket.tcp(host, port).then { |socket|
+      Socket.tcp(host, port, local_host, local_port).then { |socket|
         if ssl_context
           OpenSSL::SSL::SSLSocket.new(socket, ssl_context).tap { |socket|
             socket.hostname = host

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: iirc
 version: !ruby/object:Gem::Version
-  version: 0.2.7
+  version: 0.3.0
 platform: ruby
 authors:
 - mooff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2022-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ircparser
@@ -35,6 +35,7 @@ files:
 - ".gitignore"
 - CHANGELOG.md
 - Gemfile
+- LICENSE
 - README.md
 - Rakefile
 - bin/console
@@ -45,6 +46,7 @@ files:
 - iirc.gemspec
 - lib/iirc.rb
 - lib/iirc/bot.rb
+- lib/iirc/bot/accept_invites.rb
 - lib/iirc/bot/ambient.rb
 - lib/iirc/bot/autojoin.rb
 - lib/iirc/bot/channels.rb
@@ -63,6 +65,7 @@ files:
 - lib/iirc/bot/reading.rb
 - lib/iirc/bot/redis.rb
 - lib/iirc/bot/regex_hooks.rb
+- lib/iirc/bot/reply_target.rb
 - lib/iirc/bot/track_own_nick.rb
 - lib/iirc/bot/verbs.rb
 - lib/iirc/event.rb
@@ -70,7 +73,8 @@ files:
 - lib/iirc/user.rb
 - lib/iirc/version.rb
 homepage: https://github.com/awfulcooking/iirc
-licenses: []
+licenses:
+- MIT
 metadata:
   homepage_uri: https://github.com/awfulcooking/iirc
   source_code_uri: https://github.com/awfulcooking/iirc