ircinch 2.4.0

data/examples/plugins/google.rb

@@ -0,0 +1,36 @@
+require "cgi"
+require "ircinch"
+require "nokogiri"
+require "open-uri"
+
+class Google
+  include Cinch::Plugin
+  match(/google (.+)/)
+
+  def search(query)
+    url = "http://www.google.com/search?q=#{CGI.escape(query)}"
+    res = Nokogiri.HTML(URI.parse(url).open).at("h3.r")
+
+    title = res.text
+    link = res.at("a")[:href]
+    desc = res.at("./following::div").children.first.text
+    CGI.unescape_html "#{title} - #{desc} (#{link})"
+  rescue
+    "No results found"
+  end
+
+  def execute(m, query)
+    m.reply(search(query))
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.libera.chat"
+    c.nick = "MrIrCinch"
+    c.channels = ["#ircinch-bots"]
+    c.plugins.plugins = [Google]
+  end
+end
+
+bot.start

data/examples/plugins/hello.rb

@@ -0,0 +1,21 @@
+require "ircinch"
+
+class Hello
+  include Cinch::Plugin
+
+  match "hello"
+
+  def execute(m)
+    m.reply "Hello, #{m.user.nick}"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.plugins.plugins = [Hello]
+  end
+end
+
+bot.start

data/examples/plugins/hooks.rb

@@ -0,0 +1,34 @@
+require "cinch"
+
+class HooksDemo
+  include Cinch::Plugin
+
+  hook :pre, method: :generate_random_number
+  def generate_random_number(m)
+    # Hooks are called in the same thread as the handler and thus
+    # using thread local variables is possible.
+    Thread.current[:rand] = Kernel.rand
+  end
+
+  hook :post, method: :cheer
+  def cheer(m)
+    m.reply "Yay, I successfully ran a command…"
+  end
+
+  match "rand"
+  def execute(m)
+    m.reply "Random number: " + Thread.current[:rand].to_s
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick = "ircinch_hooks"
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.verbose = true
+    c.plugins.plugins = [HooksDemo]
+  end
+end
+
+bot.start

data/examples/plugins/join_part.rb

@@ -0,0 +1,41 @@
+require "ircinch"
+
+class JoinPart
+  include Cinch::Plugin
+
+  match(/join (.+)/, method: :join)
+  match(/part(?: (.+))?/, method: :part)
+
+  def initialize(*args)
+    super
+
+    @admins = ["injekt", "DominikH"]
+  end
+
+  def check_user(user)
+    user.refresh # be sure to refresh the data, or someone could steal the nick
+    @admins.include?(user.authname)
+  end
+
+  def join(m, channel)
+    return unless check_user(m.user)
+    Channel(channel).join
+  end
+
+  def part(m, channel)
+    return unless check_user(m.user)
+    channel ||= m.channel
+    Channel(channel).part if channel
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.libera.chat"
+    c.nick = "IrCinchBot"
+    c.channels = ["#ircinch-bots"]
+    c.plugins.plugins = [JoinPart]
+  end
+end
+
+bot.start

data/examples/plugins/lambdas.rb

@@ -0,0 +1,35 @@
+require "ircinch"
+
+class DirectAddressing
+  include Cinch::Plugin
+
+  # Note: the lambda will be executed in the context it has been
+  # defined in, in this case the class DirectAddressing (and not an
+  # instance of said class).
+  #
+  # The reason we are using a lambda is that the bot's nick can change
+  # and the prefix has to be up to date.
+  set :prefix, lambda { |m| Regexp.new("^" + Regexp.escape(m.bot.nick + ": ")) }
+
+  match "hello", method: :greet
+  def greet(m)
+    m.reply "Hello to you, too."
+  end
+
+  match "rename", method: :rename
+  def rename(m)
+    @bot.nick += "_"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick = "ircinch_lambda"
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.verbose = true
+    c.plugins.plugins = [DirectAddressing]
+  end
+end
+
+bot.start

data/examples/plugins/last_nick.rb

@@ -0,0 +1,24 @@
+require "ircinch"
+
+class Nickchange
+  include Cinch::Plugin
+  listen_to :nick
+
+  def listen(m)
+    # This will send a PM to the user who changed their nick and inform
+    # them of their old nick.
+    m.reply "Your old nick was: #{m.user.last_nick}", true
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick = "ircinch_nickchange"
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.verbose = true
+    c.plugins.plugins = [Nickchange]
+  end
+end
+
+bot.start

data/examples/plugins/msg.rb

@@ -0,0 +1,21 @@
+require "ircinch"
+
+class Messenger
+  include Cinch::Plugin
+
+  match(/msg (.+?) (.+)/)
+  def execute(m, receiver, message)
+    User(receiver).send(message)
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.libera.chat"
+    c.nick = "IrCinchBot"
+    c.channels = ["#ircinch-bots"]
+    c.plugins.plugins = [Messenger]
+  end
+end
+
+bot.start

data/examples/plugins/multiple_matches.rb

@@ -0,0 +1,32 @@
+require "ircinch"
+
+class MultiCommands
+  include Cinch::Plugin
+  match(/command1 (.+)/, method: :command1)
+  match(/command2 (.+)/, method: :command2)
+  match(/^command3 (.+)/, use_prefix: false)
+
+  def command1(m, arg)
+    m.reply "command1, arg: #{arg}"
+  end
+
+  def command2(m, arg)
+    m.reply "command2, arg: #{arg}"
+  end
+
+  def execute(m, arg)
+    m.reply "command3, arg: #{arg}"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick = "ircinch_multi"
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.verbose = true
+    c.plugins.plugins = [MultiCommands]
+  end
+end
+
+bot.start

data/examples/plugins/own_events.rb

@@ -0,0 +1,37 @@
+require "ircinch"
+
+class RandomNumberGenerator
+  def initialize(bot)
+    @bot = bot
+  end
+
+  def start
+    loop do
+      sleep 5 # pretend that we are waiting for some kind of entropy
+      @bot.handlers.dispatch(:random_number, nil, Kernel.rand)
+    end
+  end
+end
+
+class DoSomethingRandom
+  include Cinch::Plugin
+
+  listen_to :random_number
+  def listen(m, number)
+    Channel("#ircinch-bots").send "I got a random number: #{number}"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick = "ircinch_events"
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.verbose = true
+    c.plugins.plugins = [DoSomethingRandom]
+  end
+end
+
+Thread.new { RandomNumberGenerator.new(bot).start }
+
+bot.start

data/examples/plugins/seen.rb

@@ -0,0 +1,44 @@
+require "ircinch"
+
+class Seen
+  class SeenStruct < Struct.new(:who, :where, :what, :time)
+    def to_s
+      "[#{time.asctime}] #{who} was seen in #{where} saying #{what}"
+    end
+  end
+
+  include Cinch::Plugin
+  listen_to :channel
+  match(/seen (.+)/)
+
+  def initialize(*args)
+    super
+    @users = {}
+  end
+
+  def listen(m)
+    @users[m.user.nick] = SeenStruct.new(m.user, m.channel, m.message, Time.now)
+  end
+
+  def execute(m, nick)
+    if nick == @bot.nick
+      m.reply "That's me!"
+    elsif nick == m.user.nick
+      m.reply "That's you!"
+    elsif @users.key?(nick)
+      m.reply @users[nick].to_s
+    else
+      m.reply "I haven't seen #{nick}"
+    end
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.plugins.plugins = [Seen]
+  end
+end
+
+bot.start

data/examples/plugins/timer.rb

@@ -0,0 +1,22 @@
+require "ircinch"
+
+class TimedPlugin
+  include Cinch::Plugin
+
+  timer 5, method: :timed
+  def timed
+    Channel("#ircinch-bots").send "5 seconds have passed"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick = "ircinch_timer"
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.verbose = true
+    c.plugins.plugins = [TimedPlugin]
+  end
+end
+
+bot.start

data/examples/plugins/url_shorten.rb

@@ -0,0 +1,34 @@
+require "cgi"
+require "ircinch"
+require "open-uri"
+
+class TinyURL
+  include Cinch::Plugin
+
+  listen_to :channel
+
+  def shorten(url)
+    url = URI.parse("http://tinyurl.com/api-create.php?url=#{CGI.escape(url)}").open
+    (url == "Error") ? nil : url
+  rescue OpenURI::HTTPError
+    nil
+  end
+
+  def listen(m)
+    urls = URI.extract(m.message, "http")
+    short_urls = urls.map { |url| shorten(url) }.compact
+    unless short_urls.empty?
+      m.reply short_urls.join(", ")
+    end
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.libera.chat"
+    c.channels = ["#ircinch-bots"]
+    c.plugins.plugins = [TinyURL]
+  end
+end
+
+bot.start

data/ircinch.gemspec

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+require_relative "lib/cinch/version"
+
+Gem::Specification.new do |spec|
+  spec.name = "ircinch"
+  spec.version = Cinch::VERSION
+  spec.authors = ["Matt Sias"]
+  spec.email = ["siasmj@uwec.edu"]
+
+  spec.summary = "An IRC Bot Building Ruby Framework"
+  spec.description = "A simple, friendly Ruby DSL for creating IRC bots"
+  spec.homepage = "https://github.com/ircinchrb/ircinch"
+  spec.license = "MIT"
+  spec.required_ruby_version = ">= 2.7.0"
+
+  spec.metadata["homepage_uri"] = spec.homepage
+  spec.metadata["source_code_uri"] = "https://github.com/ircinchrb/ircinch"
+  spec.metadata["changelog_uri"] = "https://github.com/ircinchrb/ircinch/blob/main/CHANGELOG.md"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(__dir__) do
+    `git ls-files -z`.split("\x0").reject do |f|
+      (f == __FILE__) || f.match(%r{\A(?:(?:bin|test|spec|features)/|\.(?:git|travis|circleci)|appveyor)})
+    end
+  end
+  spec.bindir = "exe"
+  spec.executables = spec.files.grep(%r{\Aexe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  # Register runtime dependencies (gems required to run this gem)
+  # spec.add_dependency "example-gem", "~> 1.0"
+
+  # Register development dependencies (gems required to program this gem)
+  spec.add_development_dependency "rake", "~> 13.0"
+  spec.add_development_dependency "minitest", "~> 5.16"
+  spec.add_development_dependency "simplecov", "~> 0.21.2"
+  spec.add_development_dependency "standard", "~> 1.18"
+
+  # For more information and examples about making a new gem, check out our
+  # guide at: https://bundler.io/guides/creating_gem.html
+end

data/lib/cinch/ban.rb

@@ -0,0 +1,53 @@
+# frozen_string_literal: true
+
+require_relative "mask"
+
+module Cinch
+  # This class represents channel bans.
+  class Ban
+    # @return [Mask] A {Mask} object for non-extended bans
+    # @return [String] A String object for extended bans (see {#extended})
+    attr_reader :mask
+
+    # The user who created the ban. Might be nil on networks that do
+    # not strictly follow the RFCs, for example IRCnet in some(?)
+    # cases.
+    #
+    # @return [User, nil] The user who created the ban
+    attr_reader :by
+
+    # @return [Time]
+    attr_reader :created_at
+
+    # @return [Boolean] whether this is an extended ban (as used by for example Freenode)
+    attr_reader :extended
+
+    # @param [String, Mask] mask The mask
+    # @param [User, nil] by The user who created the ban.
+    # @param [Time] at The time at which the ban was created
+    def initialize(mask, by, at)
+      @by, @created_at = by, at
+      if mask.match?(/^[$~]/)
+        @extended = true
+        @mask = mask
+      else
+        @extended = false
+        @mask = Mask.from(mask)
+      end
+    end
+
+    # @return [Boolean] true if the ban matches `user`
+    # @raise [Exceptions::UnsupportedFeature] Cinch does not support
+    #   Freenode's extended bans
+    def match(user)
+      raise UnsupportedFeature, "extended bans are not supported yet" if @extended
+      @mask =~ user
+    end
+    alias_method :=~, :match
+
+    # @return [String]
+    def to_s
+      @mask.to_s
+    end
+  end
+end