cinch 0.3.5 → 1.0.0

data/examples/basic/memo.rb

@@ -0,0 +1,39 @@
+#!/usr/bin/env ruby
+
+require 'cinch'
+
+class Memo < Struct.new(:nick, :channel, :text, :time)
+  def to_s
+    "[#{time.asctime}] <#{channel}/#{nick}> #{text}"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.freenode.org"
+    c.channels = ["#cinch-bots"]
+
+    @memos = {}
+  end
+
+  on :message do |m|
+    if @memos.has_key?(m.user.nick)
+      m.user.send @memos.delete(m.user.nick).to_s
+    end
+  end
+
+  on :message, /^!memo (.+?) (.+)/ do |m, nick, message|
+    if @memos.key?(nick)
+      m.reply "There's already a memo for #{nick}. You can only store one right now"
+    elsif nick == m.user.nick
+      m.reply "You can't leave memos for yourself.."
+    elsif nick == bot.nick
+      m.reply "You can't leave memos for me.."
+    else
+      @memos[nick] = Memo.new(m.user.nick, m.channel, message, Time.now)
+      m.reply "Added memo for #{nick}"
+    end
+  end
+end
+
+bot.start

data/examples/basic/msg.rb

@@ -0,0 +1,16 @@
+require 'cinch'
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = "irc.freenode.org"
+    c.nick     = "CinchBot"
+    c.channels = ["#cinch-bots"]
+  end
+
+  on :message, /^!msg (.+?) (.+)/ do |m, who, text|
+    User(who).send text
+  end
+end
+
+bot.start
+

data/examples/basic/seen.rb

@@ -0,0 +1,36 @@
+require 'cinch'
+
+class Seen < Struct.new(:who, :where, :what, :time)
+  def to_s
+    "[#{time.asctime}] #{who} was seen in #{where} saying #{what}"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = 'irc.freenode.org'
+    c.channels = ["#cinch-bots"]
+
+    @users = {}
+  end
+
+  # Only log channel messages
+  on :channel do |m|
+    @users[m.user.nick] = Seen.new(m.user.nick, m.channel, m.message, Time.new)
+  end
+
+  on :channel, /^!seen (.+)/ do |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.start
+

data/examples/basic/urban_dict.rb

@@ -0,0 +1,35 @@
+require 'cinch'
+require 'open-uri'
+require 'nokogiri'
+require 'cgi'
+
+# This bot connects to urban dictionary and returns the first result
+# for a given query, replying with the result directly to the sender
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = "irc.freenode.net"
+    c.nick     = "MrCinch"
+    c.channels = ["#cinch-bots"]
+  end
+
+  helpers do
+    # This method assumes everything will go ok, it's not the best method
+    # of doing this *by far* and is simply a helper method to show how it
+    # can be done.. it works!
+    def urban_dict(query)
+      url = "http://www.urbandictionary.com/define.php?term=#{CGI.escape(query)}"
+      CGI.unescape_html Nokogiri::HTML(open(url)).at("div.definition").text.gsub(/\s+/, ' ') rescue nil
+    end
+  end
+
+  on :message, /^!urban (.+)/ do |m, term|
+    m.reply(urban_dict(term) || "No results found", true)
+  end
+end
+
+bot.start
+
+# injekt> !urban cinch
+# MrCinch> injekt: describing an action that's extremely easy.
+

data/examples/basic/url_shorten.rb

@@ -0,0 +1,35 @@
+require 'open-uri'
+require 'cinch'
+
+# Automatically shorten URL's found in messages
+# Using the tinyURL API
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = "irc.freenode.org"
+    c.channels = ["#cinch-bots"]
+  end
+
+  helpers do
+    def shorten(url)
+      url = open("http://tinyurl.com/api-create.php?url=#{URI.escape(url)}").read
+      url == "Error" ? nil : url
+    rescue OpenURI::HTTPError
+      nil
+    end
+  end
+
+  on :channel do |m|
+    urls = URI.extract(m.message, "http")
+
+    unless urls.empty?
+      short_urls = urls.map {|url| shorten(url) }.compact
+
+      unless short_urls.empty?
+        m.reply short_urls.join(", ")
+      end
+    end
+  end
+end
+
+bot.start

data/examples/plugins/autovoice.rb

@@ -0,0 +1,40 @@
+require 'cinch'
+
+# Give this bot ops in a channel and it'll auto voice
+# visitors
+#
+# Enable with !autovoice on
+# Disable with !autovoice off
+
+class Autovoice
+  include Cinch::Plugin
+  listen_to :join
+  match /autovoice (on|off)/
+
+  def listen(m)
+    unless m.user.nick == bot.nick
+      m.channel.voice(m.user) if @autovoice
+    end
+  end
+
+  def execute(m, option)
+    @autovoice = option == "on"
+
+    m.reply "Autovoice is now #{@autovoice ? 'enabled' : 'disabled'}"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick            = "cinch_autovoice"
+    c.server          = "irc.freenode.org"
+    c.verbose         = true
+    c.plugins.plugins = [Autovoice]
+  end
+
+  on :connect do
+    bot.join "#cinch"
+  end
+end
+
+bot.start

data/examples/plugins/custom_prefix.rb

@@ -0,0 +1,23 @@
+require 'cinch'
+
+class SomeCommand
+  include Cinch::Plugin
+
+  prefix "~"
+  match "somecommand"
+
+  def execute(m)
+    m.reply "Successful"
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = "irc.freenode.org"
+    c.channels = ["#cinch-bots"]
+    c.plugins.plugins = [SomeCommand]
+  end
+end
+
+bot.start
+

data/examples/plugins/google.rb

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

data/examples/plugins/hello.rb

@@ -0,0 +1,22 @@
+require 'cinch'
+
+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.freenode.org"
+    c.channels = ["#cinch-bots"]
+    c.plugins.plugins = [Hello]
+  end
+end
+
+bot.start
+

data/examples/plugins/join_part.rb

@@ -0,0 +1,42 @@
+require 'cinch'
+
+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.freenode.org"
+    c.nick   = "CinchBot"
+    c.channels = ["#cinch-bots"]
+    c.plugins.plugins = [JoinPart]
+  end
+end
+
+bot.start

data/examples/plugins/memo.rb

@@ -0,0 +1,50 @@
+#!/usr/bin/env ruby
+
+require 'cinch'
+
+class Memo
+  class MemoStruct < Struct.new(:nick, :channel, :text, :time)
+    def to_s
+      "[#{time.asctime}] <#{channel}/#{nick}> #{text}"
+    end
+  end
+
+  include Cinch::Plugin
+
+  listen_to :message
+  match /memo (.+?) (.+)/
+
+  def initialize(*args)
+    super
+    @memos = {}
+  end
+
+  def listen(m)
+    if @memos.has_key?(m.user.nick)
+      m.user.send @memos.delete(m.user.nick).to_s
+    end
+  end
+
+  def execute(m, nick, message)
+    if @memos.key?(nick)
+      m.reply "There's already a memo for #{nick}. You can only store one right now"
+    elsif nick == m.user.nick
+      m.reply "You can't leave memos for yourself.."
+    elsif nick == bot.nick
+      m.reply "You can't leave memos for me.."
+    else
+      @memos[nick] = MemoStruct.new(m.user.nick, m.channel, message, Time.now)
+      m.reply "Added memo for #{nick}"
+    end
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.freenode.org"
+    c.channels = ["#cinch-bots"]
+    c.plugins.plugins = [Memo]
+  end
+end
+
+bot.start

data/examples/plugins/msg.rb

@@ -0,0 +1,22 @@
+require 'cinch'
+
+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.freenode.org"
+    c.nick   = "CinchBot"
+    c.channels = ["#cinch-bots"]
+    c.plugins.plugins = [Messenger]
+  end
+end
+
+bot.start
+

data/examples/plugins/multiple_matches.rb

@@ -0,0 +1,41 @@
+require 'cinch'
+
+# Give this bot ops in a channel and it'll auto voice
+# visitors
+#
+# Enable with !autovoice on
+# Disable with !autovoice off
+
+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            = "cinch_multi"
+    c.server          = "irc.freenode.org"
+    c.verbose         = true
+    c.plugins.plugins = [MultiCommands]
+  end
+
+  on :connect do
+    bot.join "#dominikh"
+  end
+end
+
+bot.start