rubysl-syslog 2.0.1 → 2.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: c18c5e6919582a916342b3d609e6a1c4f25f9a6a
-  data.tar.gz: 7004baf274cb2e678080c438a41de7148114aacb
+  metadata.gz: bfebde7dcce150345a9455b71f9704eef695d9dd
+  data.tar.gz: 1307cccdf46e9a8f62f5b7188b0ac7f20568c13c
 SHA512:
-  metadata.gz: 1e56cf512f8b2e0ae2888e66ba40f4d25011a5f1b6b8f4590a836df4bfba2541a8462f981d82029905d9832cba433d04db772b4d46128e68162a06f502c6770c
-  data.tar.gz: 2c8c234d5e933871863fb9a03d27184ad3e6ad53142f88a15c2e028a0cec6ec33f290172650cb627582a18a3e9102ad1cd37139f7f3c251a105d269c98b76a12
+  metadata.gz: 94a117ef9961ac3aaaa0a1b747f273771b0eaa9b1ee760769a3a6bfc81d351cb684d20c3e3534a866485e52d0b74642b1960ae5d8d9f6dc2a2ba3c7be04fd191
+  data.tar.gz: a85cbefaf15ca5c869ef4eec24d263ba7a841ead120d53cea2289914f34b03bef5b44062cd7ac588d058d5eb014258975e120200a66ae405b65cc5270d586d6b

data/.travis.yml

@@ -1,11 +1,12 @@
 language: ruby
-before_install:
-  - rvm use $RVM --install --binary --fuzzy
-  - gem update --system
-  - gem --version
-  - gem install rubysl-bundler
-  - gem install rubysl-rake
-  - rake
 env:
-  - RVM=rbx-nightly-d21 RUBYLIB=lib
-script: bundle exec mspec spec
+  - RUBYLIB=lib:.
+script: mspec spec
+branches:
+  only:
+    - 1.0
+    - 2.0
+rvm:
+  - 2.1.0
+  - rbx-2
+

data/lib/rubysl/syslog/version.rb

@@ -1,5 +1,5 @@
 module RubySL
   module Syslog
-    VERSION = "2.0.1"
+    VERSION = "2.1.0"
   end
 end

data/lib/syslog/logger.rb

@@ -0,0 +1,208 @@
+require 'syslog'
+require 'logger'
+
+##
+# Syslog::Logger is a Logger work-alike that logs via syslog instead of to a
+# file.  You can use Syslog::Logger to aggregate logs between multiple
+# machines.
+#
+# By default, Syslog::Logger uses the program name 'ruby', but this can be
+# changed via the first argument to Syslog::Logger.new.
+#
+# NOTE! You can only set the Syslog::Logger program name when you initialize
+# Syslog::Logger for the first time.  This is a limitation of the way
+# Syslog::Logger uses syslog (and in some ways, a limitation of the way
+# syslog(3) works).  Attempts to change Syslog::Logger's program name after
+# the first initialization will be ignored.
+#
+# === Example
+#
+# The following will log to syslogd on your local machine:
+#
+#   require 'syslog/logger'
+#
+#   log = Syslog::Logger.new 'my_program'
+#   log.info 'this line will be logged via syslog(3)'
+#
+# Also the facility may be set to specify the facility level which will be used:
+#
+#   log.info 'this line will be logged using Syslog default facility level'
+#
+#   log_local1 = Syslog::Logger.new 'my_program', Syslog::LOG_LOCAL1
+#   log_local1.info 'this line will be logged using local1 facility level'
+#
+#
+# You may need to perform some syslog.conf setup first.  For a BSD machine add
+# the following lines to /etc/syslog.conf:
+#
+#  !my_program
+#  *.*                                             /var/log/my_program.log
+#
+# Then touch /var/log/my_program.log and signal syslogd with a HUP
+# (killall -HUP syslogd, on FreeBSD).
+#
+# If you wish to have logs automatically roll over and archive, see the
+# newsyslog.conf(5) and newsyslog(8) man pages.
+
+class Syslog::Logger
+  # Default formatter for log messages.
+  class Formatter
+    def call severity, time, progname, msg
+      clean msg
+    end
+
+    private
+
+    ##
+    # Clean up messages so they're nice and pretty.
+
+    def clean message
+      message = message.to_s.strip
+      message.gsub!(/\e\[[0-9;]*m/, '') # remove useless ansi color codes
+      return message
+    end
+  end
+
+  ##
+  # The version of Syslog::Logger you are using.
+
+  VERSION = '2.0'
+
+  ##
+  # Maps Logger warning types to syslog(3) warning types.
+  #
+  # Messages from Ruby applications are not considered as critical as messages
+  # from other system daemons using syslog(3), so most messages are reduced by
+  # one level.  For example, a fatal message for Ruby's Logger is considered
+  # an error for syslog(3).
+
+  LEVEL_MAP = {
+    ::Logger::UNKNOWN => Syslog::LOG_ALERT,
+    ::Logger::FATAL   => Syslog::LOG_ERR,
+    ::Logger::ERROR   => Syslog::LOG_WARNING,
+    ::Logger::WARN    => Syslog::LOG_NOTICE,
+    ::Logger::INFO    => Syslog::LOG_INFO,
+    ::Logger::DEBUG   => Syslog::LOG_DEBUG,
+  }
+
+  ##
+  # Returns the internal Syslog object that is initialized when the
+  # first instance is created.
+
+  def self.syslog
+    @@syslog
+  end
+
+  ##
+  # Specifies the internal Syslog object to be used.
+
+  def self.syslog= syslog
+    @@syslog = syslog
+  end
+
+  ##
+  # Builds a methods for level +meth+.
+
+  def self.make_methods meth
+    level = ::Logger.const_get(meth.upcase)
+    eval <<-EOM, nil, __FILE__, __LINE__ + 1
+      def #{meth}(message = nil, &block)
+        add(#{level}, message, &block)
+      end
+
+      def #{meth}?
+        @level <= #{level}
+      end
+    EOM
+  end
+
+  ##
+  # :method: unknown
+  #
+  # Logs a +message+ at the unknown (syslog alert) log level, or logs the
+  # message returned from the block.
+
+  ##
+  # :method: fatal
+  #
+  # Logs a +message+ at the fatal (syslog err) log level, or logs the message
+  # returned from the block.
+
+  ##
+  # :method: error
+  #
+  # Logs a +message+ at the error (syslog warning) log level, or logs the
+  # message returned from the block.
+
+  ##
+  # :method: warn
+  #
+  # Logs a +message+ at the warn (syslog notice) log level, or logs the
+  # message returned from the block.
+
+  ##
+  # :method: info
+  #
+  # Logs a +message+ at the info (syslog info) log level, or logs the message
+  # returned from the block.
+
+  ##
+  # :method: debug
+  #
+  # Logs a +message+ at the debug (syslog debug) log level, or logs the
+  # message returned from the block.
+
+  Logger::Severity::constants.each do |severity|
+    make_methods severity.downcase
+  end
+
+  ##
+  # Log level for Logger compatibility.
+
+  attr_accessor :level
+
+  # Logging formatter, as a +Proc+ that will take four arguments and
+  # return the formatted message. The arguments are:
+  #
+  # +severity+:: The Severity of the log message.
+  # +time+:: A Time instance representing when the message was logged.
+  # +progname+:: The #progname configured, or passed to the logger method.
+  # +msg+:: The _Object_ the user passed to the log message; not necessarily a
+  #         String.
+  #
+  # The block should return an Object that can be written to the logging
+  # device via +write+.  The default formatter is used when no formatter is
+  # set.
+  attr_accessor :formatter
+
+  ##
+  # The facility argument is used to specify what type of program is logging the message.
+
+  attr_accessor :facility
+
+  ##
+  # Fills in variables for Logger compatibility.  If this is the first
+  # instance of Syslog::Logger, +program_name+ may be set to change the logged
+  # program name. The +facility+ may be set to specify the facility level which will be used.
+  #
+  # Due to the way syslog works, only one program name may be chosen.
+
+  def initialize program_name = 'ruby', facility = nil
+    @level = ::Logger::DEBUG
+    @formatter = Formatter.new
+
+    @@syslog ||= Syslog.open(program_name)
+
+    @facility = (facility || @@syslog.facility)
+  end
+
+  ##
+  # Almost duplicates Logger#add.  +progname+ is ignored.
+
+  def add severity, message = nil, progname = nil, &block
+    severity ||= ::Logger::UNKNOWN
+    @level <= severity and
+      @@syslog.log( (LEVEL_MAP[severity] | @facility), '%s', formatter.call(severity, Time.now, progname, (message || block.call)) )
+    true
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: rubysl-syslog
 version: !ruby/object:Gem::Version
-  version: 2.0.1
+  version: 2.1.0
 platform: ruby
 authors:
 - Brian Shirai
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-09-25 00:00:00.000000000 Z
+date: 2014-11-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi2-generators
@@ -99,6 +99,7 @@ files:
 - lib/rubysl/syslog/syslog.rb.ffi
 - lib/rubysl/syslog/version.rb
 - lib/syslog.rb
+- lib/syslog/logger.rb
 - rubysl-syslog.gemspec
 - spec/alert_spec.rb
 - spec/close_spec.rb
@@ -142,7 +143,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.0.7
+rubygems_version: 2.2.2
 signing_key: 
 specification_version: 4
 summary: Ruby standard library syslog.
@@ -169,4 +170,3 @@ test_files:
 - spec/shared/log.rb
 - spec/shared/reopen.rb
 - spec/warning_spec.rb
-has_rdoc: