grinch 1.0.0

data/docs/plugins.md

@@ -0,0 +1,4 @@
+# @title Plugins
+# @markup kramdown
+
+Content will follow soon…

data/docs/readme.md

@@ -0,0 +1,20 @@
+# @title README
+# @markup kramdown
+
+
+- {file:docs/changes.md Changelog}
+- {file:docs/migrating.md Migration guides}
+
+# Important documents
+
+The following is a list of important documents to read.
+
+- {file:docs/bot_options.md Bot options}
+- {file:docs/common_tasks.md Common Tasks}
+- {file:docs/common_mistakes.md Common mistakes}
+- {Cinch::DCC DCC}
+- {file:docs/encodings.md Encodings}
+- {file:docs/logging.md Logging}
+- {Cinch::SASL SASL}
+- {Cinch::Formatting Formatting messages}
+- {file:docs/events.md Events}

data/examples/basic/autovoice.rb

@@ -0,0 +1,32 @@
+require 'cinch'
+
+# Give this bot ops in a channel and it'll auto voice
+# visitors
+#
+# Enable with !autovoice on
+# Disable with !autovoice off
+#
+# It starts out disabled.
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.nick            = "cinch_autovoice"
+    c.server          = "irc.freenode.org"
+    c.verbose         = true
+    c.channels        = ["#cinch-bots"]
+  end
+
+  on :join do |m|
+    unless m.user.nick == bot.nick # We shouldn't attempt to voice ourselves
+      m.channel.voice(m.user) if @autovoice
+    end
+  end
+
+  on :channel, /^!autovoice (on|off)$/ do |m, option|
+    @autovoice = option == "on"
+
+    m.reply "Autovoice is now #{@autovoice ? 'enabled' : 'disabled'}"
+  end
+end
+
+bot.start

data/examples/basic/google.rb

@@ -0,0 +1,35 @@
+require 'cinch'
+require 'open-uri'
+require 'nokogiri'
+require 'cgi'
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = "irc.freenode.net"
+    c.nick     = "MrCinch"
+    c.channels = ["#cinch-bots"]
+  end
+
+  helpers do
+    # Extremely basic method, grabs the first result returned by Google
+    # or "No results found" otherwise
+    def google(query)
+      url = "http://www.google.com/search?q=#{CGI.escape(query)}"
+      res = Nokogiri.parse(open(url).read).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
+  end
+
+  on :message, /^!google (.+)/ do |m, query|
+    m.reply google(query)
+  end
+end
+
+bot.start

data/examples/basic/hello.rb

@@ -0,0 +1,15 @@
+require 'cinch'
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.freenode.org"
+    c.channels = ["#cinch-bots"]
+  end
+
+  on :message, "hello" do |m|
+    m.reply "Hello, #{m.user.nick}"
+  end
+end
+
+bot.start
+

data/examples/basic/join_part.rb

@@ -0,0 +1,34 @@
+require 'cinch'
+
+# Who should be able to access these plugins
+$admin = "injekt"
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = "irc.freenode.org"
+    c.nick     = "CinchBot"
+    c.channels = ["#cinch-bots"]
+  end
+
+  helpers do
+    def is_admin?(user)
+      true if user.nick == $admin
+    end
+  end
+
+  on :message, /^!join (.+)/ do |m, channel|
+    bot.join(channel) if is_admin?(m.user)
+  end
+
+  on :message, /^!part(?: (.+))?/ do |m, channel|
+    # Part current channel if none is given
+    channel = channel || m.channel
+
+    if channel
+      bot.part(channel) if is_admin?(m.user)
+    end
+  end
+end
+
+bot.start
+

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
+
+$memos = {}
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = "irc.freenode.org"
+    c.channels = ["#cinch-bots"]
+  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
+
+$users = {}
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server   = 'irc.freenode.org'
+    c.channels = ["#cinch-bots"]
+  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)).css("div.meaning").first.text.gsub(/\s+/, ' ').strip 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,37 @@
+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.channels        = ["#cinch-bots"]
+    c.verbose         = true
+    c.plugins.plugins = [Autovoice]
+  end
+end
+
+bot.start

data/examples/plugins/custom_prefix.rb

@@ -0,0 +1,23 @@
+require 'cinch'
+
+class SomeCommand
+  include Cinch::Plugin
+
+  set :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/dice_roll.rb

@@ -0,0 +1,38 @@
+require 'cinch'
+
+class DiceRoll
+  include Cinch::Plugin
+
+  # [[<repeats>#]<rolls>]d<sides>[<+/-><offset>]
+  match(/roll (?:(?:(\d+)#)?(\d+))?d(\d+)(?:([+-])(\d+))?/)
+  def execute(m, repeats, rolls, sides, offset_op, offset)
+    repeats = repeats.to_i
+    repeats = 1 if repeats < 1
+    rolls   = rolls.to_i
+    rolls   = 1 if rolls < 1
+
+    total = 0
+
+    repeats.times do
+      rolls.times do
+        score = rand(sides.to_i) + 1
+        if offset_op
+          score = score.send(offset_op, offset.to_i)
+        end
+        total += score
+      end
+    end
+
+    m.reply "Your dice roll was: #{total}", true
+  end
+end
+
+bot = Cinch::Bot.new do
+  configure do |c|
+    c.server = 'irc.freenode.org'
+    c.channels = ['#cinch-bots']
+    c.plugins.plugins = [DiceRoll]
+  end
+end
+
+bot.start

data/examples/plugins/google.rb

@@ -0,0 +1,36 @@
+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.parse(open(url).read).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.freenode.net"
+    c.nick   = "MrCinch"
+    c.channels = ["#cinch-bots"]
+    c.plugins.plugins = [Google]
+  end
+end
+
+bot.start