iirc 0.2.1 → 0.2.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 677c6866347be71d8937503af4858234412668648f0e8f331f10aaaa7b5b2e9a
-  data.tar.gz: 9ebd831386cfd623ba4c8edf76c1c97c447c8321008c3dfacd16e35aa4ca1388
+  metadata.gz: 7948a6cd83b37e9d3fa9d8bd5248e330d52ed3881afde4fecdc9d5671cefc3da
+  data.tar.gz: 44592080131bb88427003f8e90301402e8211f674e2826d9fac3400fbebae920
 SHA512:
-  metadata.gz: de69d9cfe8d0a6c144b0bcd777d1f24fa3315d200fed8bfbd30ccdcf00a480057159924ea0ea3a94f5cfed81537de9f7c93b1b0740653076b1581e11929c5b08
-  data.tar.gz: b433ad524e9645734d90f53076c2ed7a019262bea73f395d426abcb7ab289ca9f1c897c1ae6376773d6e52b1243104666639c407905b856afc2e611dccb3361d
+  metadata.gz: b5f9e7eb864705787c7e7cdb51608f3a0189ca983ce8d95fc16f881a2b7782610b4833122c04ad7fbef82d8a17d1cda1668f46f66a01c23b9b1a363c17874271
+  data.tar.gz: e9c9d869cd16d8d2585f0d7399fdb6473a47e7f0012cd038d04f1489550cc90b5af4f09c0d0de8bc25c430e9f134dfd490ff14a492457ec4a193d5595dd7cf50

data/CHANGELOG.md

@@ -1,4 +1,37 @@
-## [Unreleased]
+## [0.2.6] - 2022-03-16
+
+- Add ircparser dependency
+  - It's technically optional, but it's needed to parse IRCv3 messages
+
+## [0.2.5] - 2022-03-16
+
+- Add dial method. Uses SSL by default, with configurable context
+- Add Bot.run method. Dials, yields an instance, then calls #run
+- Add IIRC() method to top-level for DSL shorthand
+  - See examples/facts.rb
+- Add examples/ (Facts, Greeter, Wolfram)
+
+## [0.2.4] - 2022-03-15
+
+- [Bot::Hooks] Run catch-all hooks before on_#{verb} ones
+- Include Bot::AmbientVerbs in Batteries
+  - Lets you write `say "Hello"` in event handlers instead of `say evt.target, "Hello"`
+  - Defaults the first arg of say,act,join,part,cycle,mode to the target of the current event
+- Add Bot::PrintIO module
+
+## [0.2.3] - 2022-03-14
+
+- Use new configure style for Bot::OperUp
+- Use new configure style for Bot::TrackOwnNick
+- Update own nick from welcome message (001)
+
+## [0.2.2] - 2022-03-13
+
+- Use escape sequences in formatting.rb for readability
+
+- Fix Event reference in parse()
+  - Bot::Event was moved to Event during refactor
+  - Missed as my code uses `include IIRC` at the top level
 
 ## [0.2.1] - 2022-03-12
 

data/examples/facts.rb

@@ -0,0 +1,30 @@
+require "iirc"
+
+IIRC {
+  include IIRC::Bot::PrintIO
+
+  def facts
+    @facts ||= {}
+  end
+
+  def on_privmsg(evt)
+    case evt.message
+    when /^=list\b/
+      say "I know about #{facts.empty? ? 'nothing' : facts.keys.join(', ')}"
+    when /^=tell ([[:alnum:]]+)/
+      say facts[$1] ? "#{$1} is #{facts[$1]}" : "I don't know what that is"
+    when /^=add ([[:alnum:]]+) (.+)/
+      say "Okay, #{$1} is #{$2}"
+      facts[$1] = $2
+    when /^=del ([[:alnum:]]+)/
+      say "Okay, forgetting #{$1}"
+      facts.delete $1
+    end
+  end
+
+  def autojoin_channels
+    ['##facts', '##iirc']
+  end
+
+  run "irc.libera.chat", nick: "FactBot[#{rand(100)}]"
+}

data/examples/greeter.rb

@@ -0,0 +1,16 @@
+require "iirc"
+
+class Greeter < IIRC::Bot
+  include AutoJoin
+  include Verbs
+
+  def on_join(evt)
+    say evt.target, "Hello #{evt.sender.nick}!"
+  end
+
+  def autojoin_channels
+    ['##iirc']
+  end
+end
+
+Greeter.run 'irc.libera.chat', nick: 'GreeterBot' if __FILE__ == $0

data/examples/wolfram.rb

@@ -0,0 +1,39 @@
+require "net/https"
+require "iirc"
+
+class Wolfram < IIRC::Batteries
+  include PrintIO
+
+  def on_privmsg(evt)
+    case evt.message
+    when /^!(what .+)/, /^!(define .+)/
+      answer($1).then { |answer|
+        if answer == "Wolfram|Alpha did not understand your input"
+          case rand(3)
+          when 0
+            say "I have no #{%w(earthly stinkin bloody).sample} idea :)"
+          when 1
+            say "If only I knew..."
+          when 2
+            say "#{evt.sender.nick}: If you ever find out, will you tell me?"
+          end
+        else
+          say answer.capitalize
+        end
+      }
+    end
+  end
+
+  def answer(query)
+    url = URI.parse("https://api.wolframalpha.com/v1/result")
+    url.query = URI.encode_www_form(i: query, appid: ENV['WOLFRAM_APP_ID'])
+
+    Net::HTTP.get(url)
+  end
+
+  def autojoin_channels
+    ['##wolframbot', '##iirc']
+  end
+end
+
+Wolfram.run 'irc.libera.chat', nick: 'WolframBot'+rand(100).to_s

data/iirc.gemspec

@@ -27,7 +27,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  # spec.add_dependency "example-gem", "~> 1.0"
+  spec.add_dependency "ircparser", "= 1.0.0"
 
   # For more information and examples about making a new gem, checkout our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/iirc/bot/formatting.rb

@@ -1,11 +1,11 @@
 module IIRC
   module Bot::Formatting
     module_function
-      def bold s; "#{s}"; end
-      def italic s; "#{s}"; end
-      def strike s; "#{s}"; end
-      def underline s; "#{s}"; end
-      def strip s; s.gsub /\x03(?:\d{1,2}(?:,\d{1,2})?)?/, ''; end
+      def bold(s) "\x02#{s}\x02" end
+      def italic(s) "\x1d#{s}\x1d" end
+      def strike(s) "\x1e#{s}\x1e" end
+      def underline(s) "\x1f#{s}\x1f" end
+      def strip(s) s.gsub(/\x03(?:\d{1,2}(?:,\d{1,2})?)?/, '') end
       alias :strip_formatting :strip
   end
 end

data/lib/iirc/bot/hooks.rb

@@ -31,10 +31,13 @@ module IIRC
     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[nil], *hooks[verb]]
+      for action in hooks[verb]
         call action, *args, **kwargs
       end
     rescue StopIteration

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

@@ -1,8 +1,6 @@
 module IIRC
   module Bot::IRCv3
     class Batch < Event
-      attr_accessor :events
-
       def events
         @events ||= []
       end

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

@@ -6,7 +6,7 @@ module IIRC
       def parse(line)
         msg = IRCParser::Message.parse(line.chomp)
 
-        Bot::Event.new.tap { |evt|
+        Event.new.tap { |evt|
           evt.sender = IRCParser::RFCWireFormat.__stringify_prefix(msg.prefix) if msg.prefix
           evt.tags = msg.tags
           evt.verb = msg.command.downcase.to_sym

data/lib/iirc/bot/oper_up.rb

@@ -1,15 +1,12 @@
 module IIRC
   module Bot::OperUp
-    def self.configure_actions
-      [:add_oper_up_hook]
-    end
-
-    def add_oper_up_hook
-      on :'001', :oper_up!
-    end
-
     def oper_up!
       self << "OPER #{ENV['IRC_OPER']}" if ENV['IRC_OPER']
     end
+
+    private
+      def configure_oper_up
+        on :'001', :oper_up!
+      end
   end
 end

data/lib/iirc/bot/parsing.rb

@@ -1,7 +1,7 @@
 module IIRC
   module Bot::Parsing
     def parse(line)
-      Bot::Event.new.tap { |evt|
+      Event.new.tap { |evt|
         words = line.chomp.split " "
 
         if words[0] and words[0].start_with? ":"

data/lib/iirc/bot/print_io.rb

@@ -0,0 +1,12 @@
+module IIRC
+  module Bot::PrintIO
+    def lines
+      super { |line| puts ">> #{line}"; yield line }
+    end
+
+    def <<(line)
+      puts "<< #{line}"
+      super
+    end
+  end
+end

data/lib/iirc/bot/track_own_nick.rb

@@ -1,9 +1,18 @@
 module IIRC
   module Bot::TrackOwnNick
-    def on_nick evt
-      if me === evt.sender
-        self.user.nick = evt.args[0]
+    private
+
+      def configure_own_nick_tracking
+        on :'001', :track_own_nick_from_welcome
+        on :nick,  :track_own_nick_change
+      end
+
+      def track_own_nick_from_welcome evt
+        me.nick = evt.args[0]
+      end
+
+      def track_own_nick_change evt
+        me.nick = evt.args[0] if me === evt.sender
       end
-    end
   end
 end

data/lib/iirc/version.rb

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

data/lib/iirc.rb

@@ -15,6 +15,7 @@ require_relative "iirc/bot/members"
 require_relative "iirc/bot/oper_up"
 require_relative "iirc/bot/parsing"
 require_relative "iirc/bot/pong"
+require_relative "iirc/bot/print_io"
 require_relative "iirc/bot/reading"
 require_relative "iirc/bot/redis"
 require_relative "iirc/bot/regex_hooks"
@@ -36,6 +37,16 @@ module IIRC
     include Configure
     include Pong
     include TrackOwnNick
+
+    def self.run(host, port=6697, ssl_context: SSL.default_context, **user_params, &blk)
+      socket = IIRC.dial(host, port, ssl_context: ssl_context)
+
+      new(socket, **user_params).tap { |bot|
+        bot.register!
+        bot.tap(&blk) if blk
+        bot.run
+      }
+    end
   end
 
   class IRCv3Bot < Bot
@@ -46,10 +57,63 @@ module IIRC
   end
 
   class Batteries < IRCv3Bot
-    include Channels
-    include Members
-    include Formatting
-    include AutoJoin
-    include Verbs
+    include Bot::Channels
+    include Bot::Members
+    include Bot::Formatting
+    include Bot::AutoJoin
+    include Bot::Verbs
+    include Bot::AmbientVerbs
+  end
+
+  module SSL
+    module_function
+
+    def default_context
+      verify_peer_and_hostname
+    end
+
+    def verify_peer_and_hostname
+      verify_peer.tap { |context|
+        context.verify_hostname = true
+      }
+    end
+
+    def verify_peer
+      no_verify.tap { |context|
+        context.verify_mode = OpenSSL::SSL::VERIFY_PEER
+        context.cert_store = OpenSSL::X509::Store.new.tap(&:set_default_paths)
+      }
+    end
+
+    def verify_hostname_only
+      no_verify.tap { |context|
+        context.verify_hostname = true
+      }
+    end
+
+    def no_verify
+      require 'openssl'
+      OpenSSL::SSL::SSLContext.new
+    end
   end
+
+  module_function
+    def dial(host, port=6697, ssl_context: SSL.default_context)
+      require 'socket'
+
+      Socket.tcp(host, port).then { |socket|
+        if ssl_context
+          OpenSSL::SSL::SSLSocket.new(socket, ssl_context).tap { |socket|
+            socket.hostname = host
+            socket.connect
+          }
+        else
+          socket
+        end
+      }
+    end
 end
+
+def IIRC(*args, **kwargs, &blk)
+  Class.new(IIRC::Batteries, &blk)
+end

metadata

@@ -1,15 +1,29 @@
 --- !ruby/object:Gem::Specification
 name: iirc
 version: !ruby/object:Gem::Version
-  version: 0.2.1
+  version: 0.2.6
 platform: ruby
 authors:
 - mooff
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-03-12 00:00:00.000000000 Z
-dependencies: []
+date: 2022-03-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ircparser
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 1.0.0
 description: A composable toolkit for IRC bots
 email:
 - mooff@awful.cooking
@@ -25,6 +39,9 @@ files:
 - Rakefile
 - bin/console
 - bin/setup
+- examples/facts.rb
+- examples/greeter.rb
+- examples/wolfram.rb
 - iirc.gemspec
 - lib/iirc.rb
 - lib/iirc/bot.rb
@@ -42,6 +59,7 @@ files:
 - lib/iirc/bot/oper_up.rb
 - lib/iirc/bot/parsing.rb
 - lib/iirc/bot/pong.rb
+- lib/iirc/bot/print_io.rb
 - lib/iirc/bot/reading.rb
 - lib/iirc/bot/redis.rb
 - lib/iirc/bot/regex_hooks.rb