slogger 0.0.1

data/Gemfile

@@ -0,0 +1,9 @@
+group :development do
+  gem "rspec"
+  gem "bundler", "~> 1.0.0"
+  gem "jeweler", "~> 1.5.2"
+end
+
+group :test do
+    gem "rspec"
+end

data/Gemfile.lock

@@ -0,0 +1,25 @@
+GEM
+  specs:
+    diff-lcs (1.1.2)
+    git (1.2.5)
+    jeweler (1.5.2)
+      bundler (~> 1.0.0)
+      git (>= 1.2.5)
+      rake
+    rake (0.8.7)
+    rspec (2.5.0)
+      rspec-core (~> 2.5.0)
+      rspec-expectations (~> 2.5.0)
+      rspec-mocks (~> 2.5.0)
+    rspec-core (2.5.1)
+    rspec-expectations (2.5.0)
+      diff-lcs (~> 1.1.2)
+    rspec-mocks (2.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.0.0)
+  jeweler (~> 1.5.2)
+  rspec

data/README.rdoc

@@ -0,0 +1,40 @@
+= slogger
+
+Slogger is a Ruby library to help work with standard Ruby Syslog library.
+
+== Features
+
+=== 1. Slogger::Logger
+
+A more friendly wrapper on Ruby's Syslog.
+    
+Sample:
+    
+  slogger = Slogger::Logger.new "sample_app", :debug, :local0 
+  slogger.info "A good info"
+  slogger.debug "A deep info"
+  
+  # and after, look at the syslog file of your SO  ;)
+
+=== 2. Slogger::Rack::RequestLogger
+
+A Rack middleware to log incoming requests.
+
+Sample:
+
+    configure do
+      slogger = Slogger::Logger.new "sample_app", :debug, :local0
+      use Slogger::Rack::RequestLogger, slogger
+    end
+
+    # and after, look at the syslog file of your SO  ;)
+    
+== Future
+
+I don't know. I think in adding more stuff sometime in the future. Let's see.
+
+For now is it.
+
+== Copyright
+
+Copyright (c) 2011 Leandro Silva (CodeZone). Blog: http://leandrosilva.com.br.

data/Rakefile

@@ -0,0 +1,50 @@
+require 'rubygems'
+require 'bundler'
+begin
+  Bundler.setup(:default, :development)
+rescue Bundler::BundlerError => e
+  $stderr.puts e.message
+  $stderr.puts "Run `bundle install` to install missing gems"
+  exit e.status_code
+end
+require 'rake'
+
+require 'jeweler'
+Jeweler::Tasks.new do |gem|
+  # gem is a Gem::Specification... see http://docs.rubygems.org/read/chapter/20 for more options
+  gem.name = "slogger"
+  gem.homepage = "http://github.com/leandrosilva/slogger"
+  gem.license = "MIT"
+  gem.summary = %Q{Slogger is a Ruby library to help work with standard Ruby Syslog library.}
+  gem.description = %Q{Slogger is a Ruby library to help work with standard Ruby Syslog library. Yeah! Just it.}
+  gem.email = "leandrodoze@gmail.com"
+  gem.authors = ["Leandro Silva"]
+  gem.files =  FileList["[A-Z]*", "{lib,sample,spec}/**/*"]
+  # Include your dependencies below. Runtime dependencies are required when using your gem,
+  # and development dependencies are only needed for development (ie running rake tasks, tests, etc)
+  #  gem.add_runtime_dependency 'jabber4r', '> 0.1'
+  #  gem.add_development_dependency 'rspec', '> 1.2.3'
+end
+Jeweler::RubygemsDotOrgTasks.new
+
+require 'rspec/core'
+require 'rspec/core/rake_task'
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = FileList['spec/**/*_spec.rb']
+end
+
+RSpec::Core::RakeTask.new(:rcov) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+end
+
+task :default => :spec
+
+require 'rake/rdoctask'
+Rake::RDocTask.new do |rdoc|
+  version = File.exist?('VERSION') ? File.read('VERSION') : ""
+
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title = "slogger #{version}"
+  rdoc.rdoc_files.include('README*')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end

data/VERSION

@@ -0,0 +1 @@
+0.0.1

data/lib/slogger.rb

@@ -0,0 +1,4 @@
+require "syslog"
+
+require "slogger/logger"
+require "slogger/request_logger"

data/lib/slogger/logger.rb

@@ -0,0 +1,82 @@
+module Slogger
+  #
+  # The wrapper for standard Ruby Syslog library.
+  #
+  class Logger
+    LEVEL = {
+      :crit    => 0,
+      :emerg   => 1,
+      :alert   => 2,
+      :err     => 3,
+      :warning => 4,
+      :notice  => 5,
+      :info    => 6,
+      :debug   => 7
+    }
+    
+    FACILITY = {
+      :user     => Syslog::LOG_USER,
+      :mail     => Syslog::LOG_MAIL,
+      :daemon   => Syslog::LOG_DAEMON,
+      :auth     => Syslog::LOG_AUTH,
+      :syslog   => Syslog::LOG_SYSLOG,
+      :lpr      => Syslog::LOG_LPR,
+      :news     => Syslog::LOG_NEWS,
+      :uucp     => Syslog::LOG_UUCP,
+      :cron     => Syslog::LOG_CRON,
+      :authpriv => Syslog::LOG_AUTHPRIV,
+      :ftp      => Syslog::LOG_FTP,
+      :local0   => Syslog::LOG_LOCAL0,
+      :local1   => Syslog::LOG_LOCAL1,
+      :local2   => Syslog::LOG_LOCAL2,
+      :local3   => Syslog::LOG_LOCAL3,
+      :local4   => Syslog::LOG_LOCAL4,
+      :local5   => Syslog::LOG_LOCAL5,
+      :local6   => Syslog::LOG_LOCAL6,
+      :local7   => Syslog::LOG_LOCAL7
+    }
+    
+    attr_reader :app_name, :level, :facility
+
+    #
+    # To build a Slogger::Logger instance.
+    #
+    # +app_name+::  The appliaction name to be logged
+    # +level+::     The log level: :crit, :emerg, :alert, :err, :warning, :notice,
+    #                 :info, or :debug.
+    # +facility+::  A typical syslog facility: :user, :mail, :daemon, :auth,
+    #                 :syslog, :lpr, :news, :uucp, :cron, :authpriv, :ftp,
+    #                 :local0, :local1, :local2, :local3, :local4, :local5,
+    #                 :local6, or :local7
+    #
+    # Raises an ArgumentError if app_name, level, or facility is nil.
+    #
+    def initialize(app_name, level, facility)
+      raise ArgumentError, "The 'app_name' parameter is required" unless app_name
+      raise ArgumentError, "The 'level' parameter is required" unless level
+      raise ArgumentError, "The 'facility' parameter is required" unless facility
+      
+      @app_name = app_name
+      @level = level
+      @level_as_int = LEVEL[level]
+      @facility = facility
+      @facility_as_int = FACILITY[facility]
+    end
+    
+    def method_missing(name, *args)
+      if LEVEL.key? name
+        log(name, args[0])
+      else
+        super name, *args
+      end
+    end
+    
+    private
+    
+    def log(level, message)
+      return if LEVEL[level] > @level_as_int
+
+      Syslog.open(@app_name, Syslog::LOG_PID, @facility_as_int) { |s| s.send level, message }
+    end
+  end
+end

data/lib/slogger/request_logger.rb

@@ -0,0 +1,65 @@
+module Slogger
+  module Rack
+    #
+    # Slogger::Rack::RequestLogger is a kind of Rack middleware. It forwards every
+    # request to an +app+ given, and logs a line in the syslog using Slogger::Logger.
+    #
+    # Yes, it's based on Rack::CommonLogger code.
+    #
+    class RequestLogger
+      FORMAT = %{%s - %s "%s %s%s %s" %d %s %0.4f}
+
+      #
+      # To build a Slogger::Rack::RequestLogger instance.
+      #
+      # +app+::     The Rack application
+      # +logger+::  A Slogger::Logger instance
+      #
+      def initialize(app, slogger)
+        @app = app
+        @logger = slogger
+      end
+
+      def call(env)
+        began_at = Time.now
+        status, header, body = @app.call env
+        header = ::Rack::Utils::HeaderHash.new header
+
+        log env, status, header, began_at
+      
+        [status, header, body]
+      end
+
+      private
+
+      def log(env, status, header, began_at)
+        now = Time.now
+        length = extract_content_length header
+
+        message = FORMAT % [
+          env['HTTP_X_FORWARDED_FOR'] || env["REMOTE_ADDR"] || "-",
+          env["REMOTE_USER"] || "-",
+          env["REQUEST_METHOD"],
+          env["PATH_INFO"],
+          env["QUERY_STRING"].empty? ? "" : "?#{env['QUERY_STRING']}",
+          env["HTTP_VERSION"],
+          status.to_s[0..3],
+          length,
+          now - began_at ]
+        
+        sanitize! message
+      
+        @logger.info message
+      end
+
+      def extract_content_length(headers)
+        value = headers["Content-Length"] or return "-"
+        value.to_s == "0" ? "-" : value
+      end
+    
+      def sanitize!(string)
+        string.gsub!("%", "%%")
+      end
+    end
+  end
+end

data/spec/slogger/logger_spec.rb

@@ -0,0 +1,43 @@
+require File.join(File.dirname(__FILE__), "..", "/spec_helper")
+
+describe Slogger::Logger do
+  describe "valid state" do
+    subject { Slogger::Logger.new "test_app", :debug, :local0 }
+
+    its(:app_name) { should == "test_app" }
+    its(:level) { should == :debug }
+    its(:facility) { should == :local0 }
+  end
+  
+  describe "invalid state" do
+    it "should raise ArgumentError if doen't have app_name" do
+      lambda { Slogger::Logger.new nil, :debug, :local0 }.should raise_error
+    end
+
+    it "should raise ArgumentError if doen't have level" do
+      lambda { Slogger::Logger.new "test_app", nil, :local0 }.should raise_error
+    end
+
+    it "should raise ArgumentError if doen't have facility" do
+      lambda { Slogger::Logger.new "test_app", :debug, nil }.should raise_error
+    end
+  end
+  
+  describe "when in warning level" do
+    subject { Slogger::Logger.new "test_app", :warning, :local0 }
+
+    it "should log WARNING messages" do
+      Syslog.stub!(:warning).with(anything).and_return(Syslog)
+      Syslog.should_receive(:warning).and_return(Syslog)
+
+      subject.warning "WARNING message"
+    end
+    
+    it "shouldn't log INFO messages" do
+      Syslog.stub!(:info).with(anything).and_return(Syslog)
+      Syslog.should_not_receive(:info).and_return(Syslog)
+
+      subject.info "INFO message"
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,12 @@
+ENV['RACK_ENV'] = "test"
+
+require "rubygems"
+require "bundler"
+
+require File.join(File.dirname(__FILE__), "..", "lib", "slogger.rb")
+
+#
+# RSpec setup
+#
+
+require "rspec"

metadata

@@ -0,0 +1,122 @@
+--- !ruby/object:Gem::Specification 
+name: slogger
+version: !ruby/object:Gem::Version 
+  hash: 29
+  prerelease: 
+  segments: 
+  - 0
+  - 0
+  - 1
+  version: 0.0.1
+platform: ruby
+authors: 
+- Leandro Silva
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-02-17 00:00:00 -02:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: rspec
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  prerelease: false
+  type: :development
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
+  name: bundler
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 23
+        segments: 
+        - 1
+        - 0
+        - 0
+        version: 1.0.0
+  prerelease: false
+  type: :development
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
+  name: jeweler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 7
+        segments: 
+        - 1
+        - 5
+        - 2
+        version: 1.5.2
+  prerelease: false
+  type: :development
+  requirement: *id003
+description: Slogger is a Ruby library to help work with standard Ruby Syslog library. Yeah! Just it.
+email: leandrodoze@gmail.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- Gemfile
+- Gemfile.lock
+- README.rdoc
+- Rakefile
+- VERSION
+- lib/slogger.rb
+- lib/slogger/logger.rb
+- lib/slogger/request_logger.rb
+- spec/slogger/logger_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/leandrosilva/slogger
+licenses: 
+- MIT
+post_install_message: 
+rdoc_options: []
+
+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: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.5.2
+signing_key: 
+specification_version: 3
+summary: Slogger is a Ruby library to help work with standard Ruby Syslog library.
+test_files: 
+- spec/slogger/logger_spec.rb
+- spec/spec_helper.rb