yell-adapters-syslog 0.4.0

data/.gitignore

@@ -0,0 +1,4 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*

data/Gemfile

@@ -0,0 +1,4 @@
+source "http://rubygems.org"
+
+# Specify your gem's dependencies in yell-adapters-syslog.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+Copyright (c) 2012 Rudolf Schmidt
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/yell-adapters-syslog.rb

@@ -0,0 +1,30 @@
+# encoding: utf-8
+
+# Copyright (c) 2012 Rudolf Schmidt
+#
+# Permission is hereby granted, free of charge, to any person obtaining
+# a copy of this software and associated documentation files (the
+# "Software"), to deal in the Software without restriction, including
+# without limitation the rights to use, copy, modify, merge, publish,
+# distribute, sublicense, and/or sell copies of the Software, and to
+# permit persons to whom the Software is furnished to do so, subject to
+# the following conditions:
+#
+# The above copyright notice and this permission notice shall be
+# included in all copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+# EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+# MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+require 'yell'
+
+require File.dirname(__FILE__) + '/yell/adapters/syslog'
+
+module Yell #:nodoc:
+end
+

data/lib/yell/adapters/syslog.rb

@@ -0,0 +1,150 @@
+# encoding: utf-8
+
+require 'syslog'
+
+module Yell #:nodoc:
+  module Adapters #:nodoc:
+
+    class Syslog < Yell::Adapters::Base
+
+      # Syslog severities
+      #
+      # `man syslog` to see the severities
+      Severities = [7, 6, 4, 3, 2, 1]
+
+      # Map Syslog severities to internal represenation
+      #   'DEBUG'   => 7
+      #   'INFO'    => 6
+      #   'WARN'    => 4
+      #   'ERROR'   => 3
+      #   'FATAL'   => 2
+      #   'UNKNOWN' => 1
+      SeverityMap = Hash[ *(Yell::Severities.zip(Severities).flatten) ]
+
+      # Map Syslog options to internal representation
+      OptionMap = {
+        :cons   => ::Syslog::LOG_CONS,
+        :ndelay => ::Syslog::LOG_NDELAY,
+        :nowait => ::Syslog::LOG_NOWAIT,
+        :odelay => ::Syslog::LOG_ODELAY,
+        :perror => ::Syslog::LOG_PERROR,
+        :pid    => ::Syslog::LOG_PID
+      }
+
+      # Map Syslog facilities to internal represenation
+      FacilityMap = {
+        :auth     => ::Syslog::LOG_AUTH,
+        :authpriv => ::Syslog::LOG_AUTHPRIV,
+        # :console  => ::Syslog::LOG_CONSOLE, # described in 1.9.3 docu, but not defined
+        :cron     => ::Syslog::LOG_CRON,
+        :daemon   => ::Syslog::LOG_DAEMON,
+        :ftp      => ::Syslog::LOG_FTP,
+        :kern     => ::Syslog::LOG_KERN,
+        # :lrp      => ::Syslog::LOG_LRP, # described in 1.9.3 docu, but not defined
+        :mail     => ::Syslog::LOG_MAIL,
+        :news     => ::Syslog::LOG_NEWS,
+        # :ntp      => ::Syslog::LOG_NTP, # described in 1.9.3 docu, but not defined
+        # :security => ::Syslog::LOG_SECURITY, # described in 1.9.3 docu, but not defined
+        :syslog   => ::Syslog::LOG_SYSLOG,
+        :user     => ::Syslog::LOG_USER,
+        :uucp     => ::Syslog::LOG_UUCP,
+        :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
+      }
+
+      def initialize( options = {}, &block )
+        ident options[:ident] || $0
+        options options[:options] || [:pid, :cons]
+        facility options[:facility]
+
+        super( options, &block )
+      end
+
+      def stream
+        @stream ||= _new_stream
+      end
+
+      def close
+        @stream.close if @stream.respond_to? :close
+      rescue
+        # do nothing
+      ensure
+        @stream = nil
+      end
+
+      # Identify the calling program
+      def ident( val = nil )
+        @ident = val
+      end
+
+      # Set the log facility for Syslog
+      #
+      # See {Yell::Adapters::Syslog::OptionMap OptionMap} for allowed values.
+      #
+      # @example Direct or Symbol
+      #   facility( Syslog::LOG_NDELAY )
+      #   facility( :ndelay )
+      #
+      # @example Multiple
+      #   facility( :ndelay, Syslog::LOG_NDELAY ):
+      def options( *values )
+        @syslog_options = values.flatten.map do |v|
+          v.is_a?(Symbol) ? OptionMap[v] : v
+        end.inject { |a, b| a | b }
+      end
+
+      # Set the log facility for Syslog
+      #
+      # See {Yell::Adapters::Syslog::FacilityMap FacilityMap} for allowed values.
+      # @example Direct or Symbol
+      #  facility( :user  )
+      #  facility( Syslog::LOG_CONSOLE )
+      #
+      # @example Multiple
+      #   facility( :user, Syslog::LOG_CONSOLE )
+      def facility( *values )
+        @facility = values.flatten.map do |v|
+          v.is_a?(Symbol) ? FacilityMap[v] : v
+        end.inject { |a, b| a | b }
+      end
+
+
+      private
+
+      def write!( event )
+        stream.log( SeverityMap[event.level], clean(event.message) )
+      rescue Exception => e
+        close
+
+        # re-raise the exception
+        raise( e )
+      end
+
+      def _new_stream
+        return ::Syslog if ::Syslog.opened?
+
+        ::Syslog.open( @ident, @syslog_options, @facility )
+      end
+
+      # Borrowed from [SyslogLogger](https://github.com/seattlerb/sysloglogger)
+      def clean( message )
+        message = message.to_s.dup
+        message.strip!
+        message.gsub!(/%/, '%%') # syslog(3) freaks on % (printf)
+        message.gsub!(/\e\[[^m]*m/, '') # remove useless ansi color codes
+
+        message
+      end
+
+    end
+
+    register( :syslog, Yell::Adapters::Syslog )
+
+  end
+end

data/lib/yell/adapters/syslog/version.rb

@@ -0,0 +1,12 @@
+# encoding: utf-8
+
+module Yell #:nodoc:
+  module Adapters #:nodoc:
+
+    class Syslog
+      VERSION = "0.4.0"
+
+    end
+  end
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,14 @@
+$:.unshift File.expand_path('..', __FILE__)
+$:.unshift File.expand_path('../../lib', __FILE__)
+
+require 'yell-adapters-syslog'
+
+require 'rspec'
+require 'rr'
+require 'timecop'
+
+RSpec.configure do |config|
+  config.mock_framework = :rr
+
+end
+

data/spec/yell/adapters/syslog_spec.rb

@@ -0,0 +1,120 @@
+require 'spec_helper'
+
+describe Yell::Adapters::Syslog do
+  before do
+    Syslog.close if Syslog.opened?
+  end
+
+  shared_examples_for "a Syslog adapter" do
+    let( :adapter ) { Yell::Adapters::Syslog.new }
+
+    it "should call Syslog correctly" do
+      mock( Syslog ).log( Yell::Adapters::Syslog::SeverityMap[subject], "Hello World" )
+
+      adapter.write Yell::Event.new( subject, "Hello World" )
+    end
+  end
+
+  it_behaves_like( "a Syslog adapter" ) { subject { 'DEBUG' } }
+  it_behaves_like( "a Syslog adapter" ) { subject { 'INFO' } }
+  it_behaves_like( "a Syslog adapter" ) { subject { 'WARN' } }
+  it_behaves_like( "a Syslog adapter" ) { subject { 'ERROR' } }
+  it_behaves_like( "a Syslog adapter" ) { subject { 'FATAL' } }
+  it_behaves_like( "a Syslog adapter" ) { subject { 'UNKNOWN' } }
+
+  context "a new Yell::Adapters::Syslog instance" do
+    subject { Yell::Adapters::Syslog.new }
+
+    it { subject.instance_variable_get(:@ident).should == $0 }
+    it { subject.instance_variable_get(:@syslog_options).should == (Syslog::LOG_PID | Syslog::LOG_CONS) }
+    it { subject.instance_variable_get(:@facility).should be_nil }
+  end
+
+  context "OptionMap" do
+    subject { Yell::Adapters::Syslog::OptionMap }
+
+    it { subject[:cons].should == Syslog::LOG_CONS }
+    it { subject[:ndelay].should == Syslog::LOG_NDELAY }
+    it { subject[:nowait].should == Syslog::LOG_NOWAIT }
+    it { subject[:odelay].should == Syslog::LOG_ODELAY }
+    it { subject[:perror].should == Syslog::LOG_PERROR }
+    it { subject[:pid].should == Syslog::LOG_PID }
+  end
+
+  context "FacilityMap" do
+    subject { Yell::Adapters::Syslog::FacilityMap }
+
+    # :console  => ::Syslog::LOG_CONSOLE, # described in 1.9.3 docu, but not defined
+    # :lrp      => ::Syslog::LOG_LRP, # described in 1.9.3 docu, but not defined
+    # :ntp      => ::Syslog::LOG_NTP, # described in 1.9.3 docu, but not defined
+    # :security => ::Syslog::LOG_SECURITY, # described in 1.9.3 docu, but not defined
+    it { subject[:auth].should == Syslog::LOG_AUTH }
+    it { subject[:authpriv].should == Syslog::LOG_AUTHPRIV }
+    it { subject[:cron].should == Syslog::LOG_CRON }
+    it { subject[:daemon].should == Syslog::LOG_DAEMON }
+    it { subject[:ftp].should == Syslog::LOG_FTP }
+    it { subject[:kern].should == Syslog::LOG_KERN }
+    it { subject[:mail].should == Syslog::LOG_MAIL }
+    it { subject[:news].should == Syslog::LOG_NEWS }
+    it { subject[:syslog].should == Syslog::LOG_SYSLOG }
+    it { subject[:user].should == Syslog::LOG_USER }
+    it { subject[:uucp].should == Syslog::LOG_UUCP }
+    it { subject[:local0].should == Syslog::LOG_LOCAL0 }
+    it { subject[:local1].should == Syslog::LOG_LOCAL1 }
+    it { subject[:local2].should == Syslog::LOG_LOCAL2 }
+    it { subject[:local3].should == Syslog::LOG_LOCAL3 }
+    it { subject[:local4].should == Syslog::LOG_LOCAL4 }
+    it { subject[:local5].should == Syslog::LOG_LOCAL5 }
+    it { subject[:local6].should == Syslog::LOG_LOCAL6 }
+    it { subject[:local7].should == Syslog::LOG_LOCAL7 }
+  end
+
+  context :ident do
+    subject { Yell::Adapters::Syslog.new }
+
+    it "should be passed" do
+      mock.proxy( Syslog ).open( "my ident", anything, anything )
+
+      subject.ident "my ident"
+      subject.write Yell::Event.new("INFO", "Hello World")
+    end
+  end
+
+  context :options do
+    subject { Yell::Adapters::Syslog.new }
+
+    it "should be passed" do
+      mock.proxy( Syslog ).open( anything, Syslog::LOG_NDELAY, anything )
+
+      subject.options :ndelay
+      subject.write Yell::Event.new("INFO", "Hello World")
+    end
+
+    it "should work with multiple params" do
+      mock.proxy( Syslog ).open( anything, Syslog::LOG_PID|Syslog::LOG_NDELAY, anything )
+
+      subject.options :pid, :ndelay
+      subject.write Yell::Event.new("INFO", "Hello World")
+    end
+  end
+
+  context :facility do
+    subject { Yell::Adapters::Syslog.new }
+
+    it "should be passed" do
+      mock.proxy( Syslog ).open( anything, anything, Syslog::LOG_USER )
+
+      subject.facility :user
+      subject.write Yell::Event.new("INFO", "Hello World")
+    end
+
+    it "should work with multiple params" do
+      mock.proxy( Syslog ).open( anything, anything, Syslog::LOG_DAEMON|Syslog::LOG_USER )
+
+      subject.facility :daemon, :user
+      subject.write Yell::Event.new("INFO", "Hello World")
+    end
+  end
+
+end
+

data/yell-adapters-syslog.gemspec

@@ -0,0 +1,24 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "yell/adapters/syslog/version"
+
+Gem::Specification.new do |s|
+  s.name        = "yell-adapters-syslog"
+  s.version     = Yell::Adapters::Syslog::VERSION
+  s.authors     = ["Rudolf Schmidt"]
+
+  s.homepage    = "http://rubygems.org/gems/yell"
+  s.summary     = %q{Yell - Your Extensible Logging Library }
+  s.description = %q{Syslog adapter for Yell}
+
+  s.rubyforge_project = "yell"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+
+  s.add_runtime_dependency "yell", "~> 0.4"
+  s.add_development_dependency "rspec"
+  s.add_development_dependency "rr"
+end

metadata

@@ -0,0 +1,90 @@
+--- !ruby/object:Gem::Specification
+name: yell-adapters-syslog
+version: !ruby/object:Gem::Version
+  version: 0.4.0
+  prerelease: 
+platform: ruby
+authors:
+- Rudolf Schmidt
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-04-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: yell
+  requirement: &70357165504240 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: *70357165504240
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: &70357165503840 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70357165503840
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: &70357165503380 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: *70357165503380
+description: Syslog adapter for Yell
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- Rakefile
+- lib/yell-adapters-syslog.rb
+- lib/yell/adapters/syslog.rb
+- lib/yell/adapters/syslog/version.rb
+- spec/spec_helper.rb
+- spec/yell/adapters/syslog_spec.rb
+- yell-adapters-syslog.gemspec
+homepage: http://rubygems.org/gems/yell
+licenses: []
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: yell
+rubygems_version: 1.8.17
+signing_key: 
+specification_version: 3
+summary: Yell - Your Extensible Logging Library
+test_files:
+- spec/spec_helper.rb
+- spec/yell/adapters/syslog_spec.rb
+has_rdoc: