ponder 0.0.2 → 0.1.0

data/README.md

@@ -66,13 +66,13 @@ Besides the configuration for nick, server and port as shown in the **Getting St
 
 * `logging`
 
-    If `logging` is set to `true`, all incoming and outgoing traffic will be logged to logs/traffic.log and errors will be logged to logs/error.log. If you just want to log errors, you can manipulate the traffic logger in the configure block with `c.traffic_logger = c.empty_logger`. A logger set to `empty_logger` will not log anything.
+    If `logging` is set to `true`, all incoming and outgoing traffic and exceptions will be logged to logs/log.log.
     
-    You can also define other loggers for traffic\_logger and error\_logger with `c.traffic_logger = @my_cool_logger` or `c.traffic_logger = Logger.new(...)`. Per default, there are just #info and #error called on the logger.
+    You can also define your own logger, use `c.logger = @my_cool_logger` or `c.logger = Logger.new(...)`. Ponder itself just uses the #info and #error methods on the logger.
     
-    You can access the logger instances via `@ponder.traffic_logger` or `@ponder.error_logger`, so you could do: `@ponder.traffic_logger.info('I did this and that right now')`.
+    You can access the logger instance via `@ponder.logger`, so you could do: `@ponder.logger.info('I did this and that right now')`.
     
-    It defaults to `false`. (TODO: write about "other" logger methods)
+    It defaults to `false`.
 
 * `reconnect`
 
@@ -266,6 +266,17 @@ You can have Before Filters! They are called before each event handling process
 
 This Before Filter will be called, if a channel message with the word "foo" gets in. You can use all other event types (like :query, :kick, ...) as well. Also possible is an array notation like `before_filter([:query, :channel], /foo/) ...`. If you want the filter to work an all event types, you can simply use `:all`. Filters will be called in defining order; first defined, first called. Event specific filters are called before `:all` filters.
 
+You could use it for authentication/authorization. Example:
+
+    @ponder.before_filter :channel, // do |event_data|
+      if is_an_admin?(event_data[:nick])
+        event_data[:authorized_request] = true
+      else
+        event_data[:authorized_request] = false
+      end
+    end
+
+Now, one can check for `event_data[:authorized_request]` in a callback.
 ### After Filters
 After Filters work the same way as Before Filters do, just after the actual event handling process. An After Filter does not hinder later After Filters to fire up if it returns `false`. Example:
 
@@ -322,7 +333,7 @@ The source can be found at GitHub: [tbuehlmann/ponder](http://github.com/tbuehlm
 You can contact me through [GitHub](http://github.com/tbuehlmann/ "GitHub") and IRC (named tbuehlmann in the Freenode network).
 
 ## Discworld Context
-So, why all that silly names? Ponder Stibbons? Thaum? Twoflogger (referring to Twoflower), BlindIO? What's the Mended Drum? Who's the Librarian? Simply put, I freaking enshrine Terry Pratchett's Discworld Novels and there were no better name for this project than Ponder. Ponder Stibbons is the Head of Inadvisably Applied Magic at the Unseen University of Ankh Morpork. He researched the Thaum, like the atom, just for magic. And I just love that character, so there we are. If you're a fan too or want to talk about the Discworld, the framework, whatever, don't hesitate to contact me.
+So, why all that silly names? Ponder Stibbons? Thaum? Twoflogger (referring to Twoflower), BlindIo? What's the Mended Drum? Who's the Librarian? Simply put, I freaking enshrine Terry Pratchett's Discworld Novels and there were no better name for this project than Ponder. Ponder Stibbons is the Head of Inadvisably Applied Magic at the Unseen University of Ankh Morpork. He researched the Thaum, like the atom, just for magic. And I just love that character, so there we are. If you're a fan too or want to talk about the Discworld, the framework, whatever, don't hesitate to contact me.
 
 ## License
 Copyright (c) 2010, 2011 Tobias Bühlmann

data/Rakefile

@@ -0,0 +1,10 @@
+$LOAD_PATH.unshift(File.dirname(__FILE__))
+
+task :test do
+  require 'test/test_async_irc.rb'
+  require 'test/test_callback.rb'
+  require 'test/test_irc.rb'
+end
+
+task :default => :test
+

data/examples/echo.rb

@@ -1,5 +1,4 @@
-require 'pathname'
-$LOAD_PATH.unshift Pathname.new(__FILE__).dirname.expand_path.join('..', 'lib')
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
 require 'ponder'
 
@@ -23,3 +22,4 @@ end
 end
 
 @ponder.connect
+

data/examples/github_blog.rb

@@ -1,8 +1,7 @@
-require 'pathname'
-$LOAD_PATH.unshift Pathname.new(__FILE__).dirname.expand_path.join('..', 'lib')
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
 
-require 'ponder'
 require 'rubygems'
+require 'ponder'
 require 'nokogiri'
 require 'open-uri'
 
@@ -10,11 +9,11 @@ require 'open-uri'
 @ponder = Ponder::Thaum.new
 
 @ponder.configure do |c|
-  c.server    = 'chat.freenode.org'
-  c.port      = 6667
-  c.nick      = 'Ponder'
-  c.verbose   = true
-  c.logging   = false
+  c.server  = 'chat.freenode.org'
+  c.port    = 6667
+  c.nick    = 'Ponder'
+  c.verbose = true
+  c.logging = false
 end
 
 @ponder.on :connect do
@@ -22,10 +21,11 @@ end
 end
 
 @ponder.on :channel, /^blog\?$/ do |event_data|
-  doc = Nokogiri::HTML(open('http://github.com/blog'))
-  title = doc.xpath('//html/body/div/div[2]/div/div/ul/li/h2/a')[0].text
-  
+  doc = Nokogiri::HTML(open('https://github.com/blog'))
+  title = doc.xpath('/html/body/div/div[2]/div/div/ul/li/h2/a')[0].text
+
   @ponder.message event_data[:channel], "Newest Github Blog Post: #{title}"
 end
 
 @ponder.connect
+

data/examples/redis_last_seen.rb

@@ -3,10 +3,10 @@
 # 
 # The redis server version needs to be >= 1.3.10 for hash support.
 
-require 'pathname'
-$LOAD_PATH.unshift Pathname.new(__FILE__).dirname.expand_path.join('..', 'lib')
-require 'ponder'
+$LOAD_PATH.unshift(File.join(File.dirname(__FILE__), '..', 'lib'))
+
 require 'rubygems'
+require 'ponder'
 require 'redis'
 
 FORMAT = '%Y-%m-%d %H:%M:%S'
@@ -17,28 +17,29 @@ class String
   end
 end
 
-@last_seen = Redis.new(:thread_safe => true)
+@redis = Redis.new(:thread_safe => true)
 
 def remember(lowercase_nick, nick, user, host, channel, action,
                action_content)
-  @last_seen.hmset(lowercase_nick,
-                     'nick',           nick,
-                     'user',           user,
-                     'host',           host,
-                     'channel',        channel,
-                     'action',         action,
-                     'action_content', action_content,
-                     'updated_at',     Time.now.to_i)
+  @redis.hmset(
+    lowercase_nick,
+    'nick',           nick,
+    'user',           user,
+    'host',           host,
+    'channel',        channel,
+    'action',         action,
+    'action_content', action_content,
+    'updated_at',     Time.now.to_i)
 end
 
 @ponder = Ponder::Thaum.new
 
 @ponder.configure do |c|
-  c.server    = 'chat.freenode.org'
-  c.port      = 6667
-  c.nick      = 'Ponder'
-  c.verbose   = true
-  c.logging   = false
+  c.server  = 'chat.freenode.org'
+  c.port    = 6667
+  c.nick    = 'Ponder'
+  c.verbose = true
+  c.logging = false
 end
 
 @ponder.on :connect do
@@ -76,9 +77,9 @@ end
              "#{event_data[:nick]} #{event_data[:reason]}")
 end
 
-def last_seen(nick, event_data)
-  data = @last_seen.hgetall nick
-  
+def last_seen(nick)
+  data = @redis.hgetall(nick)
+
   case data['action']
   when 'channel'
     "#{data['nick']} wrote something in #{data['channel']} at #{Time.at(data['updated_at'].to_i).strftime(FORMAT)}."
@@ -101,21 +102,21 @@ end
 
 @ponder.on :channel, /^!seen \S+$/ do |event_data|
   nick = event_data[:message].split(' ')[1].downcase
-  
+
   # wildcards
   if nick =~ /\*/
-    users = @last_seen.keys nick.escape_redis
+    users = @redis.keys nick.escape_redis
     results = users.length
-    
+
     case results
     when 0
       @ponder.message event_data[:channel], 'No such nick found.'
     when 1
-      @ponder.message last_seen(users[0])
+      @ponder.message event_data[:channel], last_seen(users[0])
     when 2..5
       nicks = []
       users.each do |user|
-        nicks << @last_seen.hgetall(user)['nick']
+        nicks << @redis.hgetall(user)['nick']
       end
       nicks = nicks.join(', ')
       @ponder.message event_data[:channel], "#{results} nicks found (#{nicks})."
@@ -123,8 +124,8 @@ end
       @ponder.message event_data[:channel], "Too many results (#{results})."
     end
   # single search
-  elsif @last_seen.exists nick
-    msg = last_seen(nick, event_data)
+  elsif @redis.exists nick
+    msg = last_seen(nick)
     if online_nick = @ponder.whois(nick)
       msg = "#{online_nick[:nick]} is online. (#{msg})"
     end

data/lib/ponder.rb

@@ -1,22 +1,11 @@
-require 'pathname'
-require 'rubygems'
-
-$LOAD_PATH.unshift Pathname.new(__FILE__).dirname.expand_path
+$LOAD_PATH.unshift(File.dirname(__FILE__))
 
 module Ponder
-  def self.root
-    Pathname.new($0).dirname.expand_path
-  end
-  
-  require 'ponder/version'
-  require 'ponder/thaum'
-  require 'ponder/formatting'
-  require 'ponder/logger/blind_io'
-  
-  if RUBY_VERSION < '1.9'
-    require 'ruby/1.8/string'
-    require 'ponder/logger/twoflogger18'
-  else
-    require 'ponder/logger/twoflogger'
-  end
+  ROOT = File.dirname($0)
+
+  autoload :Filter,     'ponder/filter'
+  autoload :Formatting, 'ponder/formatting'
+  autoload :Thaum,      'ponder/thaum'
+  autoload :VERSION,    'ponder/version'
 end
+

data/lib/ponder/connection.rb

@@ -1,37 +1,41 @@
+require 'rubygems'
 require 'eventmachine'
 
 module Ponder
   class Connection < EventMachine::Connection
     include EventMachine::Protocols::LineText2
-    
+
     def initialize(thaum)
       @thaum = thaum
     end
-    
+
     def connection_completed
       @thaum.register
     end
-    
+
     def unbind
       @thaum.connected = false
-      @thaum.process_callbacks :disconnect
-      @thaum.traffic_logger.info '-- Ponder disconnected'
+      @thaum.process_callbacks :disconnect, {}
+      @thaum.logger.info '-- Ponder disconnected'
       @thaum.console_logger.info '-- Ponder disconnected'
-      
+
       if @thaum.config.reconnect
-        @thaum.traffic_logger.info "-- Reconnecting in #{@thaum.config.reconnect_interval} seconds"
+        @thaum.logger.info "-- Reconnecting in #{@thaum.config.reconnect_interval} seconds"
         @thaum.console_logger.info "-- Reconnecting in #{@thaum.config.reconnect_interval} seconds"
-        
+
         EventMachine::add_timer(@thaum.config.reconnect_interval) do
           reconnect @thaum.config.server, @thaum.config.port
         end
       else
         EventMachine::stop_event_loop
+        @thaum.logger.close
+        @thaum.console_logger.close
       end
     end
-    
+
     def receive_line(line)
-      @thaum.parse line.force_encoding('utf-8')
+      @thaum.parse line
     end
   end
 end
+

data/lib/ponder/irc.rb

@@ -3,7 +3,7 @@ module Ponder
     # raw IRC messages
     def raw(message)
       @connection.send_data "#{message}\r\n"
-      @traffic_logger.info ">> #{message}"
+      @logger.info ">> #{message}"
       @console_logger.info ">> #{message}"
     end
     

data/lib/ponder/logger/blind_io.rb

@@ -1,11 +1,25 @@
 module Ponder
-  module Logger
-    class BlindIo
-      def initialize
-        [:debug, :info, :warn, :error, :fatal, :unknown, :start_logging, :stop_logging].each do |method_name|
-          self.class.send(:define_method, method_name, Proc.new { |*args| nil })
-        end
-      end
+  class BlindIo
+    def debug(*args, &block)
+    end
+
+    def info(*args, &block)
+    end
+
+    def warn(*args, &block)
+    end
+
+    def error(*args, &block)
+    end
+
+    def fatal(*args, &block)
+    end
+
+    def unknown(*args, &block)
+    end
+
+    def method_missing(*args, &block)
     end
   end
 end
+

data/lib/ponder/logger/twoflogger.rb

@@ -1,93 +1,13 @@
-require 'pathname'
-require 'thread'
-autoload :FileUtils, 'fileutils'
+require 'logger'
 
 module Ponder
-  module Logger
-    class Twoflogger
-      attr_accessor :level, :levels, :time_format
-      
-      def initialize(destination = Ponder.root.join('logs', 'log.log'), level = :debug, time_format = '%Y-%m-%d %H:%M:%S', levels = {:debug => 0, :info => 1, :warn => 2, :error => 3, :fatal => 4, :unknown => 5})
-        @level = level
-        @time_format = time_format
-        @levels = levels
-        @queue = Queue.new
-        @mutex = Mutex.new
-        @running = false
-        
-        define_level_shorthand_methods
-        self.log_dev = destination
-      end
-      
-      def start_logging
-        @running = true
-        @thread = Thread.new do
-          begin
-            while @running do
-              write(@queue.pop)
-            end
-          ensure
-            @log_dev.close if @log_dev.is_a?(File)
-          end
-        end
-      end
-      
-      def stop_logging
-        @running = false
-      end
-      
-      def log_dev=(destination)
-        stop_logging
-        
-        if destination.is_a?(Pathname)
-          unless destination.exist?
-            unless destination.dirname.directory?
-              FileUtils.mkdir_p destination.dirname
-            end
-            
-            File.new(destination, 'w+')
-          end
-          @log_dev = File.open(destination, 'a+')
-          @log_dev.sync = true
-        elsif destination.is_a?(IO)
-          @log_dev = destination
-        else
-          raise TypeError, 'need a Pathname or IO'
-        end
-      end
-      
-      private
-      
-      def define_level_shorthand_methods
-        @levels.each_pair do |level_name, severity|
-          self.class.send(:define_method, level_name, Proc.new { |*messages| queue(severity, *messages) })
-        end
-      end
-      
-      def queue(severity, *messages)
-        raise(ArgumentError, 'Need a message') if messages.empty?
-        raise(ArgumentError, 'Need messages that respond to #to_s') if messages.any? { |message| !message.respond_to?(:to_s) }
-        
-        if severity >= @levels[@level]
-          message_hashes = messages.map { |message| {:severity => severity, :message => message} }
-          
-          @mutex.synchronize do
-            message_hashes.each do |hash|
-              @queue << hash
-            end
-          end
-        end
-      end
-      
-      def write(*message_hashes)
-        begin
-          message_hashes.each do |hash|
-            @log_dev.puts "#{@levels.key(hash[:severity])} #{Time.now.strftime(@time_format)} #{hash[:message]}"
-          end
-        rescue => e
-          puts e.message, *e.backtrace
-        end
+  class Twoflogger < Logger
+    def initialize(*args)
+      super(*args)
+      self.formatter = proc do |severity, datetime, progname, msg|
+        "#{severity} #{datetime.strftime('%Y-%m-%d %H:%M:%S')} #{msg}\n"
       end
     end
   end
 end
+