green_syslogger 0.1.0

data/Manifest

@@ -0,0 +1,5 @@
+README.md
+Rakefile
+lib/green_syslogger.rb
+test/green_syslogger_test.rb
+Manifest

data/README.md

@@ -0,0 +1,51 @@
+# GreenLogger
+
+Syslogger that makes your life greener
+
+## Install
+
+   $ [sudo] gem install green_syslogger
+
+## Usage
+
+   require 'green_syslogger'
+   logger = GreenSyslogger.new
+   logger.debug( 'debug message' )
+   
+To configure it on the <RAILS_ENVIRONMENT>.rb:
+
+  config.logger = GreenSyslogger.new(<default tag>, <facility>, <level>)
+
+
+By default
+
+   GreenSyslogger.new('rails', 'local2', :debug)
+
+
+To use it: 
+
+  logger.debug("my debug message")
+  logger.error("my error message")
+
+
+To user another tag:
+
+  logger.custom("my custom message", <tag>, <level>)
+
+
+By default:
+
+  logger.custom("my custom message", 'custom', :info)
+
+## TODO
+
+
+## Credits
+
+* Authors: [Fernando Guillen](http://fernandoguillen.info) & [Juan Jose Vidal](http://twitter.com/j2vidal)
+* Copyright: Copyright (c) 2010 Fernando Guillen
+* License: Released under the MIT license.
+
+## Thanks to
+
+*SponsorPay* for let us open it.

data/Rakefile

@@ -0,0 +1,13 @@
+require 'rubygems'  
+require 'rake'  
+require 'echoe'  
+  
+Echoe.new('green_syslogger', '0.1.0') do |p|  
+  p.description     = "Syslogger that makes your life greener"  
+  p.url             = "http://github.com/fguillen/GreenSyslogger"  
+  p.author          = "Fernando Guillen <http://fernandoguillen.info> & Juan Jose Vidal <@j2vidal>"
+  p.email           = "fguillen.mail@gmail.com"
+  p.ignore_pattern  = ["tmp/*"]
+  p.development_dependencies = []
+  p.runtime_dependencies = []
+end

data/green_syslogger.gemspec

@@ -0,0 +1,31 @@
+# -*- encoding: utf-8 -*-
+
+Gem::Specification.new do |s|
+  s.name = %q{green_syslogger}
+  s.version = "0.1.0"
+
+  s.required_rubygems_version = Gem::Requirement.new(">= 1.2") if s.respond_to? :required_rubygems_version=
+  s.authors = ["Fernando Guillen <http://fernandoguillen.info> & Juan Jose Vidal <@j2vidal>"]
+  s.date = %q{2010-11-09}
+  s.description = %q{Syslogger that makes your life greener}
+  s.email = %q{fguillen.mail@gmail.com}
+  s.extra_rdoc_files = ["README.md", "lib/green_syslogger.rb"]
+  s.files = ["README.md", "Rakefile", "lib/green_syslogger.rb", "test/green_syslogger_test.rb", "Manifest", "green_syslogger.gemspec"]
+  s.homepage = %q{http://github.com/fguillen/GreenSyslogger}
+  s.rdoc_options = ["--line-numbers", "--inline-source", "--title", "Green_syslogger", "--main", "README.md"]
+  s.require_paths = ["lib"]
+  s.rubyforge_project = %q{green_syslogger}
+  s.rubygems_version = %q{1.3.7}
+  s.summary = %q{Syslogger that makes your life greener}
+  s.test_files = ["test/green_syslogger_test.rb"]
+
+  if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
+    s.specification_version = 3
+
+    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    else
+    end
+  else
+  end
+end

data/lib/green_syslogger.rb

@@ -0,0 +1,93 @@
+require 'syslog'
+
+#
+# Custom log
+#
+# To install it cofigure it on the <RAILS_ENVIRONMENT>.rb:
+#    config.logger = GreenSyslogger.new(<default tag>, <facility>, <level>)
+#
+# By default
+#     GreenSyslogger.new('rails', 'local2', :debug)
+#
+# To use it: 
+#
+#    logger.debug("my debug message")
+#    logger.error("my error message")
+#
+# To user another tag:
+#
+#    logger.custom("my custom message", <tag>, <level>)
+#
+# By default:
+#
+#    logger.custom("my custom message", 'custom', :info)
+#
+class GreenSyslogger
+  attr_accessor :level
+  
+  # Mapping between Logger levels and Syslog levels
+  LEVELS_MAP = {
+    :debug    => [:debug    , 0],
+    :info     => [:info     , 1],
+    :warn     => [:warning  , 2],
+    :error    => [:err      , 3],
+    :fatal    => [:emerg    , 4],
+    :unknown  => [:debub    , 5]
+  }
+  
+  DEFAULT_CONF  = [ Syslog::LOG_PID, Syslog::LOG_LOCAL2 ]
+  
+  def initialize(tag = 'rails', facility = 'local2', level = :debug)
+    @tag = tag
+    @facility = facility
+    @level = level
+    @syslog = Syslog.open( @tag, Syslog::LOG_PID, Syslog.const_get( "LOG_#{@facility.upcase}" ) )
+  end
+  
+  def close
+    @syslog.close
+  end
+  
+  def opened?
+    @syslog.opened?
+  end
+
+  # level default to 'info'
+  # tag default 'ids-custom'
+  def custom(message, tag = 'ids-custom', level = :info)
+    @syslog = Syslog.reopen( tag, Syslog::LOG_PID, Syslog.const_get( "LOG_#{@facility.upcase}" ) )
+    self.log(message, level)
+    @syslog = Syslog.reopen( @tag, Syslog::LOG_PID, Syslog.const_get( "LOG_#{@facility.upcase}" ) )
+  end
+  
+  # level default to 'info'
+  def log(message, level = :info)
+    # File.open("/tmp/ids.log", 'w') { |f| f.write(message) }
+    @syslog.send(LEVELS_MAP[level][0], clean(message))
+  end
+  
+  LEVELS_MAP.each_key do |level|
+    define_method level do |message|
+      if self.send("#{level}?")
+        self.log(message, level)
+      end
+    end
+    
+    define_method "#{level}?" do
+      LEVELS_MAP[level][1] >= LEVELS_MAP[@level][1]
+    end
+  end
+  
+  private 
+
+    # Clean up messages so they're nice and pretty.
+    # Taken from SyslogLogger with small variation
+    def clean(message)
+      message = message.to_s.dup
+      message.strip!
+      message.gsub!(/%/, '%%') # syslog(3) freaks on % (printf)
+      message.gsub!(/\^\[[^m]*m/, '') # remove useless ansi color codes
+      return message
+    end
+
+end

data/test/green_syslogger_test.rb

@@ -0,0 +1,77 @@
+require 'rubygems'
+require 'test/unit'
+require 'mocha'
+require File.expand_path(File.dirname(__FILE__) + '/../lib/green_syslogger')
+
+
+class GreenSysloggerTest < Test::Unit::TestCase
+  
+  def setup
+    @logger = GreenSyslogger.new
+    @message = "wadus message"
+  end
+
+  def teardown
+    @logger.close
+  end
+
+  def test_initialize_by_default
+    Syslog.expects(:open).with('rails', Syslog::LOG_PID, Syslog::LOG_LOCAL2).returns( @logger.instance_eval('@syslog') )
+    @logger = GreenSyslogger.new
+    assert_equal(:debug, @logger.instance_eval("@level"))
+  end
+  
+  def test_initialize_with_params
+    Syslog.expects(:open).with('my tag', Syslog::LOG_PID, Syslog::LOG_LOCAL3).returns( @logger.instance_eval('@syslog') )
+    @logger = GreenSyslogger.new('my tag', 'local3', :info)
+    assert_equal(:info, @logger.instance_eval("@level"))
+  end
+  
+  def test_has_a_collection_of_methods
+    GreenSyslogger::LEVELS_MAP.each_key do |level|
+      @logger.expects(:log).with(@message, level)
+      @logger.send(level, @message)
+    end
+  end
+
+  def test_log
+    @logger.instance_eval('@syslog').expects(:debug).with(@message)
+    @logger.log(@message, :debug)
+  end
+
+  def test_log_cleaned
+    @logger.expects(:clean).with(@message).returns("#{@message} cleaned")
+    @logger.instance_eval('@syslog').expects(:debug).with("#{@message} cleaned")
+    @logger.log(@message, :debug)
+  end
+
+  def test_clean
+    dirty_message = "^[[1m^[[36mSQL (0.339ms)^[[0m  ^[[1m select landing_page_id, count(*) cnt from transactions \n where landing_page_id in (4278,4279,4334,4338,4340,4342) \n and status >= 45 and created_at >= '2010-11-08T11:30:22'\n group by landing_page_id\n^[[0m"
+    clean_message = "SQL (0.339ms)   select landing_page_id, count(*) cnt from transactions \n where landing_page_id in (4278,4279,4334,4338,4340,4342) \n and status >= 45 and created_at >= '2010-11-08T11:30:22'\n group by landing_page_id\n"
+
+    assert_equal(clean_message, @logger.send(:clean, dirty_message))
+  end
+
+  def test_log_in_debug_level
+    @logger.level = :debug
+    @logger.expects(:log).times(3)
+    @logger.debug(@message)
+    @logger.info(@message)
+    @logger.error(@message)
+  end
+
+  def test_log_in_info_level
+    @logger.level = :info
+    @logger.expects(:log).times(2)
+    @logger.debug(@message)
+    @logger.info(@message)
+    @logger.error(@message)
+  end
+
+  def test_log_with_custom_tag
+    Syslog.expects(:reopen).returns(@logger.instance_eval('@syslog')).twice
+    @logger.expects(:log)
+    @logger.custom(@message)
+  end
+
+end

metadata

@@ -0,0 +1,79 @@
+--- !ruby/object:Gem::Specification 
+name: green_syslogger
+version: !ruby/object:Gem::Version 
+  hash: 27
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Fernando Guillen <http://fernandoguillen.info> & Juan Jose Vidal <@j2vidal>
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2010-11-09 00:00:00 +01:00
+default_executable: 
+dependencies: []
+
+description: Syslogger that makes your life greener
+email: fguillen.mail@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.md
+- lib/green_syslogger.rb
+files: 
+- README.md
+- Rakefile
+- lib/green_syslogger.rb
+- test/green_syslogger_test.rb
+- Manifest
+- green_syslogger.gemspec
+has_rdoc: true
+homepage: http://github.com/fguillen/GreenSyslogger
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --line-numbers
+- --inline-source
+- --title
+- Green_syslogger
+- --main
+- README.md
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 11
+      segments: 
+      - 1
+      - 2
+      version: "1.2"
+requirements: []
+
+rubyforge_project: green_syslogger
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Syslogger that makes your life greener
+test_files: 
+- test/green_syslogger_test.rb