cinch 0.2.6 → 0.2.9

data/README.rdoc

@@ -10,6 +10,9 @@ plugin, defining a rule, and watching your profits flourish.
 Cinch will do all of the hard work for you, so you can spend time creating cool plugins
 and extensions to wow your internet peers.
 
+If you'd like to test your own Cinch experiments you can do so in the cinch IRC channel
+on {irc.freenode.org}[irc://irc.freenode.org/cinch]. Support is also welcome here.
+
 == Installation
 The latest version of Cinch is 0.2
 
@@ -105,6 +108,27 @@ This method also works for arrays, to only reply to a message sent in the foo an
    m.reply "Hello"
  end
 
+You can also set a custom prefix for each individual plugin, this is a great method if you have 
+two commands which do slightly different things. You can seperate the commands depending on which
+prefix the rule contains. 
+
+ bot.plugin "foo", :prefix => '@' do |m|
+   m.reply "Doing foo.."
+ end
+
+You can also prefix the rule with the bots nickname. Either pass the <b>:bot</b>, <b>:botnick</b> or
+<b>bot.nick</b> values to the prefix option.
+
+ bot.plugin "foo", :prefix => :bot do |m|
+   m.reply "Doing foo.."
+ end
+
+Assuming the username is cinch, this will respond to the following:
+* cinch: foo
+* cinch, foo
+
+More examples of this can be found in the /examples directory
+
 == Named Parameter Patterns
 Since version 0.2, Cinch supports named parameter patterns. It means stuff like the this works:
 
@@ -141,20 +165,26 @@ Which would provide the following output on IRC:
 
 Note though that although Cinch adds the capturing parenthesis for you, you must escape it yourself
 
+== Examples
+Check out the /examples directory for basic, yet fully functional out-of-the-box bots.
+If you have any examples you'd like to add, please either fork the repo and push your example
+before sending me a pull request. Alternatively paste the example and inform me in the IRC 
+channel or by email
+
 == Authors
 Just me at the moment, sad poor lonely me...
 * {Lee Jarvis}[http://blog.injekt.net]
 
 == Notes
-
 * RDoc API documentation is available {here}[http://rdoc.injekt.net/cinch]
 * Wiki is available {here}[https://github.com/injekt/cinch/wikis]
 * Issue and feature tracking is available {here}[https://github.com/injekt/cinch/issues]
 * Contribution in the form of bugfixes or feature requests is welcome and encouraged
 
+== Contribute
 If you'd like to contribute, fork the GitHub repository, make any changes, and send 
 {injekt}[http://github.com/injekt] a pull request. Collaborator access is available on
-request once one patch has been submitted.
+request once one patch has been submitted. Any contribution is welcome and appreciated
 
 == TODO
 * More specs

data/Rakefile

@@ -42,24 +42,10 @@ task :release => [:package] do
   sh "gem push ./#{NAME}-#{VERSION}.gem"
 end
 
-desc "Upload rdoc to injekt.net"
-task :upload => [:clean, :rdoc] do
-  sh("scp -r rdoc/* injekt@injekt.net:/var/www/injekt.net/rdoc/cinch")
-end
-
 desc "Run all specs"
 Spec::Rake::SpecTask.new(:spec) do |t|
   t.spec_files = Dir['spec/**/*_spec.rb']
 end
 
-namespace :spec do
-  desc "Print with specdoc formatting"
-  Spec::Rake::SpecTask.new(:doc) do |t|
-    t.spec_opts = ["--format", "specdoc"]
-    t.spec_files = Dir['spec/**/*_spec.rb']
-  end
-end
-
-
 task :default => [:clean, :spec]
 

data/examples/custom_prefix.rb

@@ -0,0 +1,25 @@
+require 'cinch'
+
+bot = Cinch.setup do 
+  server "irc.freenode.org"
+  channels %w( #cinch )
+end
+
+bot.plugin "default" do |m|
+  m.reply "default prefix"
+end
+
+bot.plugin "custom", :prefix => '@' do |m|
+  m.reply "custom prefix"
+end
+
+bot.plugin "botnick", :prefix => :botnick do |m|
+  m.reply "botnick prefix"
+end
+
+bot.plugin "botnick2", :prefix => bot.nick do |m|
+  m.reply "another botnick prefix"
+end
+
+bot.run
+

data/examples/google.rb

@@ -0,0 +1,31 @@
+require 'cinch'
+require 'open-uri'
+require 'nokogiri'
+require 'cgi'
+
+bot = Cinch.setup do 
+  server "irc.freenode.net"
+  nick "MrCinch"
+  channels %w/ #cinch /
+end
+
+# 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::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
+
+bot.plugin("google :query") do |m|
+  m.reply google(m.args[:query])
+end
+
+bot.run

data/examples/urban_dict.rb

@@ -0,0 +1,31 @@
+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.setup do 
+  server "irc.freenode.net"
+  nick "MrCinch"
+  channels %w/ #cinch /
+end
+
+# 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
+
+bot.plugin("urban :query") do |m|
+  m.answer urban_dict(m.args[:query]) || "No results found"
+end
+
+bot.run
+
+# injekt> !urban cinch
+# MrCinch> injekt: describing an action that's extremely easy.
+

data/lib/cinch.rb

@@ -9,7 +9,7 @@ require 'cinch/rules'
 require 'cinch/base'
 
 module Cinch
-  VERSION = '0.2.6'
+  VERSION = '0.2.9'
 
   # Setup bot options and return a new Cinch::Base instance
   def self.setup(ops={}, &blk)

data/lib/cinch/base.rb

@@ -21,7 +21,7 @@ module Cinch
 
     # A Hash holding rules and attributes
     attr_reader :rules
-    
+
     # A Hash holding listeners and reply Procs
     attr_reader :listeners
 
@@ -32,6 +32,7 @@ module Cinch
     DEFAULTS = {
       :port => 6667,
       :nick => "Cinch",
+      :nick_suffix => '_',
       :username => 'cinch',
       :realname => "Cinch IRC Microframework",
       :prefix => '!',
@@ -70,7 +71,12 @@ module Cinch
 
       # Default listeners
       on(:ping) {|m| @irc.pong(m.text) }
-      
+
+      on(433) do |m|
+        @options.nick += @options.nick_suffix
+        @irc.nick @options.nick
+      end
+
       if @options.respond_to?(:channels)
         on(376) { @options.channels.each {|c| @irc.join(c) } }
       end
@@ -87,8 +93,8 @@ module Cinch
             op.on("-n nick") {|v| options[:nick] = v }
             op.on("-c command_prefix") {|v| options[:prefix] = v }
             op.on("-v", "--verbose", "Enable verbose mode") {|v| options[:verbose] = true }
-            op.on("-C", "--channels x,y,z", Array, "Autojoin channels") {|v| 
-              options[:channels] = v.map {|c| %w(# + &).include?(c[0].chr) ? c : c.insert(0, '#') } 
+            op.on("-C", "--channels x,y,z", Array, "Autojoin channels") {|v|
+              options[:channels] = v.map {|c| %w(# + &).include?(c[0].chr) ? c : c.insert(0, '#') }
             }
           end.parse(ARGV)
         rescue OptionParser::MissingArgument => err
@@ -109,7 +115,7 @@ module Cinch
     #  end
     def plugin(rule, options={}, &blk)
       rule, keys = compile(rule)
-      
+
       if @rules.has_rule?(rule)
         @rules.add_callback(rule, blk)
         @rules.merge_options(rule, options)
@@ -117,7 +123,7 @@ module Cinch
         @rules.add_rule(rule, keys, options, blk)
       end
     end
-    
+
     # Add new listeners
     #
     # == Example
@@ -135,7 +141,7 @@ module Cinch
     end
 
     # This method builds a regular expression from your rule
-    # and defines all named parameters, as well as dealing with 
+    # and defines all named parameters, as well as dealing with
     # patterns.
     #
     # So far 3 patterns are supported:
@@ -170,7 +176,7 @@ module Cinch
     #
     # Or mix them all
     #  bot.plugin("say :n-digit :who-word :text")
-    #  
+    #
     # Using "!say 3 injekt some text here" would provide
     # the following attributes
     # m.args[:n] => 3
@@ -190,7 +196,7 @@ module Cinch
           if k =~ /\-(\w+)$/
             key, type = k.split('-')
             keys << key[1..-1]
-            
+
             case type
             when 'digit'; "(\\d+?)"
             when 'word'; "([a-zA-Z_]+?)"
@@ -204,7 +210,7 @@ module Cinch
                 "([^\x00\r\n]+?)"
               end
             end
-          else  
+          else
             keys << k[1..-1]
             "([^\x00\r\n]+?)"
           end
@@ -216,7 +222,7 @@ module Cinch
     # Add a custom 'type', for rule validation
     #
     # == Example
-    # bot = Cinch.setup do 
+    # bot = Cinch.setup do
     #   server 'irc.freenode.org'
     #   port 6667
     # end
@@ -230,15 +236,15 @@ module Cinch
       @custom_patterns[name.to_s] = "(#{pattern.to_s})"
     end
     alias :add_custom_type :add_custom_pattern # backwards
-    alias :add_pattern :add_custom_pattern 
+    alias :add_pattern :add_custom_pattern
 
     # Run run run
-    def run      
+    def run
       @irc.connect options.server, options.port
       @irc.pass options.password if options.password
       @irc.nick options.nick
       @irc.user options.username, options.usermode, '*', options.realname
-        
+
       begin
         process(@irc.read) while @irc.connected?
       rescue Interrupt
@@ -255,24 +261,41 @@ module Cinch
       message.irc = @irc
       puts message if options.verbose
 
+      # runs on any symbol
+      @listeners[:any].each { |l| l.call(message) } if @listeners.key?(:any)
+
       if @listeners.key?(message.symbol)
         @listeners[message.symbol].each {|l| l.call(message) }
       end
 
       if [:privmsg].include?(message.symbol)
 
-        # At the moment we must traverse all possibly rules, which
+        # At the moment we must traverse all possible rules, which
         # could get clunky with a lot of rules. This is because each
         # rule can be unique in what prefix it uses, in future some kind
         # of loose checking should be put in place
         rules.each do |rule|
-          unless rule.options.key?(:prefix) || options.prefix == false
-            unless rule.to_s[1..options.prefix.size] == options.prefix
-              rule.to_s.insert(1, options.prefix)
+          pattern = rule.to_s
+          
+          if options.prefix
+            if rule.options.key?(:prefix)
+              if [:bot, :botnick, options.nick].include? rule.options[:prefix]
+                prefix = options.nick + "[:,] "
+              else              
+                prefix = rule.options[:prefix]
+              end
+            else
+              prefix = options.prefix
             end
+          else
+            prefix = nil
           end
 
-          if message.text && mdata = message.text.rstrip.match(Regexp.new(rule.to_s))
+          if prefix && pattern[1..prefix.size] != prefix
+            pattern.insert(1, prefix)
+          end
+
+          if message.text && mdata = message.text.rstrip.match(Regexp.new(pattern))
             unless rule.keys.empty? || mdata.captures.empty?
               args = Hash[rule.keys.map {|k| k.to_sym}.zip(mdata.captures)]
               message.args = args
@@ -306,4 +329,3 @@ module Cinch
     end
   end
 end
-

data/spec/base_spec.rb

@@ -16,6 +16,10 @@ describe "Cinch::Base" do
       @base.listeners.should include :ping
     end
 
+    it "should add a default nick-taken listener" do
+      @base.listeners.should include :"433"
+    end
+
     it "should add a 376 listener, only if channels are set" do
       @base.listeners.should_not include :'376'
       @full.listeners.should include :'376'

data/spec/options_spec.rb

@@ -27,7 +27,12 @@ describe "Cinch::Base options" do
     defaults = {
       :port => 6667,
       :nick => 'Cinch',
+      :nick_suffix => '_',
+      :username => 'cinch',
+      :realname => 'Cinch IRC Microframework',
+      :usermode => 0,
       :prefix => '!',
+      :password => nil,
     }
 
     base = @base.new

data/spec/spec.opts

@@ -0,0 +1,2 @@
+--colour
+--format specdoc

metadata

@@ -5,8 +5,8 @@ version: !ruby/object:Gem::Version
   segments: 
   - 0
   - 2
-  - 6
-  version: 0.2.6
+  - 9
+  version: 0.2.9
 platform: ruby
 authors: 
 - Lee 'injekt' Jarvis
@@ -14,7 +14,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-04-28 00:00:00 +01:00
+date: 2010-05-07 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -43,6 +43,7 @@ files:
 - README.rdoc
 - Rakefile
 - spec/base_spec.rb
+- spec/spec.opts
 - spec/irc/socket_spec.rb
 - spec/irc/helper.rb
 - spec/irc/message_spec.rb
@@ -57,10 +58,13 @@ files:
 - lib/cinch/irc/parser.rb
 - lib/cinch/rules.rb
 - lib/cinch/irc.rb
+- examples/google.rb
+- examples/custom_prefix.rb
 - examples/join_part.rb
 - examples/msg.rb
 - examples/memo.rb
 - examples/custom_patterns.rb
+- examples/urban_dict.rb
 - examples/seen.rb
 - examples/hello.rb
 - examples/autovoice.rb