lumberjack_syslog_device 1.0.0 → 1.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: fb001f870d1cfccdc29ec125be18dcff064b2d78e2731205db30704a9d2170c2
+  data.tar.gz: b9a73d61ec0ef1be9dd31cb35b36d405d265a8de5a2692480a3f98faef270c23
+SHA512:
+  metadata.gz: 15851b8b81b2480ca0735173b9f9e2fa1b4d05147d6b4d64979c06a984df8adfd965fe384e4b8073c4b219bb6973948ada88a2aaae3a3647b8ed175ba683c4b7
+  data.tar.gz: 537be3b73a57c3d62abbcb31442c9d88242fa44e884b4b73739e8f72edb0272a383fa9ed0110bfda74a931f705367ca7bae97be137b460345ec33cda011923bd

data/CHANGE_LOG.md

@@ -0,0 +1,3 @@
+# 2.0.0
+
+* Add support for lumberjack 2.0 tags

data/README.md

@@ -0,0 +1,18 @@
+# Lumberjack Syslog Device
+
+[![Build Status](https://travis-ci.org/bdurand/lumberjack_syslog_device.svg?branch=master)](https://travis-ci.org/bdurand/lumberjack_syslog_device)
+[![Maintainability](https://api.codeclimate.com/v1/badges/61785ec7e33012f55d65/maintainability)](https://codeclimate.com/github/bdurand/lumberjack_syslog_device/maintainability)
+
+This gem provides a logging device for the [lumberjack](https://github.com/bdurand/lumberjack) gem that will log to syslog, the centralized system logging facility. See http://en.wikipedia.org/wiki/Syslog for more information on syslog.
+
+## Example Usage
+
+```ruby
+require 'lumberjack_syslog_device'
+
+device = Lumberjack::SyslogDevice.new
+logger = Lumberjack::Logger.new(device)
+logger.info("Write me to syslog!")
+```
+
+See SyslogDevice for more details.

data/VERSION

@@ -1 +1 @@
-1.0.0
+1.1.0

data/lib/lumberjack_syslog_device.rb

@@ -1,10 +1,12 @@
+# frozen_string_literal: true
+
 require 'syslog'
 require 'lumberjack'
 
 module Lumberjack
   # This Lumberjack device logs output to syslog. There can only be one connection to syslog
   # open at a time. If you use syslog elsewhere in your application, you'll need to pass
-  # <tt>:close_connection => true</tt> to the constructor. Otherwise, the connection will be kept
+  # :close_connection => true to the constructor. Otherwise, the connection will be kept
   # open between +write+ calls.
   class SyslogDevice < Device
     SEVERITY_MAP = {
@@ -15,57 +17,56 @@ module Lumberjack
       Severity::FATAL => Syslog::LOG_CRIT,
       Severity::UNKNOWN => Syslog::LOG_ALERT
     }
-    
+
     PERCENT = '%'
     ESCAPED_PERCENT = '%%'
-    
+
     @@lock = Mutex.new
-    
-    
+
     # Create a new SyslogDevice. The options control how messages are written to syslog.
     #
-    # The template can be specified using the <tt>:template</tt> option. This can
+    # The template can be specified using the :template option. This can
     # either be a Proc or a string that will compile into a Template object.
     # If the template is a Proc, it should accept an LogEntry as its only argument and output a string.
     # If the template is a template string, it will be used to create a Template.
-    # The default template is <tt>":message (#:unit_of_work_id)"</tt>.
+    # The default template is `:message (#:unit_of_work_id) :tags`.
     #
-    # The <tt>:close_connection</tt> option can be used to specify that the connection to syslog should be
+    # The :close_connection option can be used to specify that the connection to syslog should be
     # closed after every +write+ call. This will slow down performance, but will allow you to use syslog
     # elsewhere in your application.
     #
-    # The <tt>:options</tt> option will pass through options to syslog. The default is
-    # <tt>Syslog::LOG_PID | Syslog::LOG_CONS</tt>. Available values for the bit map are:
-    # * <tt>Syslog::LOG_CONS</tt> - Write directly to system console if there is an error while sending to system logger.
-    # * <tt>Syslog::LOG_NDELAY</tt> - Open the connection immediately (normally, the connection is opened when the first message is logged).
-    # * <tt>Syslog::LOG_NOWAIT</tt> - Don't wait for child processes that may have been created while logging the message.
-    # * <tt>Syslog::LOG_ODELAY</tt> - The converse of LOG_NDELAY; opening of the connection is delayed.
-    # * <tt>Syslog::LOG_PERROR</tt> - Print to stderr as well.
-    # * <tt>Syslog::LOG_PID</tt> - Include PID with each message.
+    # The :options option will pass through options to syslog. The default is
+    # Syslog::LOG_PID | Syslog::LOG_CONS. Available values for the bit map are:
+    # * Syslog::LOG_CONS - Write directly to system console if there is an error while sending to system logger.
+    # * Syslog::LOG_NDELAY - Open the connection immediately (normally, the connection is opened when the first message is logged).
+    # * Syslog::LOG_NOWAIT - Don't wait for child processes that may have been created while logging the message.
+    # * Syslog::LOG_ODELAY - The converse of LOG_NDELAY; opening of the connection is delayed.
+    # * Syslog::LOG_PERROR - Print to stderr as well.
+    # * Syslog::LOG_PID - Include PID with each message.
     #
-    # The <tt>:facility</tt> option will pass through a facility to syslog. Available values are
-    # * <tt>Syslog::LOG_AUTH</tt>
-    # * <tt>Syslog::LOG_AUTHPRIV</tt>
-    # * <tt>Syslog::LOG_CRON</tt>
-    # * <tt>Syslog::LOG_DAEMON</tt>
-    # * <tt>Syslog::LOG_FTP</tt>
-    # * <tt>Syslog::LOG_KERN</tt>
-    # * <tt>Syslog::LOG_LOCAL0</tt> through <tt>Syslog::LOG_LOCAL7</tt>
-    # * <tt>Syslog::LOG_LPR</tt>
-    # * <tt>Syslog::LOG_MAIL</tt>
-    # * <tt>Syslog::LOG_NEWS</tt>
-    # * <tt>Syslog::LOG_SYSLOG</tt>
-    # * <tt>Syslog::LOG_USER</tt> (default)
-    # * <tt>Syslog::LOG_UUCP</tt>
+    # The :facility option will pass through a facility to syslog. Available values are
+    # * Syslog::LOG_AUTH
+    # * Syslog::LOG_AUTHPRIV
+    # * Syslog::LOG_CRON
+    # * Syslog::LOG_DAEMON
+    # * Syslog::LOG_FTP
+    # * Syslog::LOG_KERN
+    # * Syslog::LOG_LOCAL0 through Syslog::LOG_LOCAL7
+    # * Syslog::LOG_LPR
+    # * Syslog::LOG_MAIL
+    # * Syslog::LOG_NEWS
+    # * Syslog::LOG_SYSLOG
+    # * Syslog::LOG_USER (default)
+    # * Syslog::LOG_UUCP
     def initialize(options = {})
-      @template = options[:template] || lambda{|entry| entry.unit_of_work_id ? "#{entry.message} (##{entry.unit_of_work_id})" : entry.message}
+      @template = options[:template] || default_template
       @template = Template.new(@template) if @template.is_a?(String)
       @syslog_options = options[:options] || (Syslog::LOG_PID | Syslog::LOG_CONS)
       @syslog_facility = options[:facility]
       @close_connection = options[:close_connection]
       @syslog_identity = nil
     end
-    
+
     def write(entry)
       message = @template.call(entry).gsub(PERCENT, ESCAPED_PERCENT)
       @@lock.synchronize do
@@ -77,28 +78,51 @@ module Lumberjack
         end
       end
     end
-    
+
     def close
       flush
       @lock.synchronize do
         @syslog.close if @syslog && @syslog.opened?
       end
     end
-    
+
     private
-    
+
     # Open syslog with ident set to progname. If it is already open with a different
     # ident, close it and reopen it.
     def open_syslog(progname) #:nodoc:
-      if Syslog.opened?
-        if (progname.nil? || Syslog.ident == progname) && @syslog_facility == Syslog.facility && @syslog_options == Syslog.options
-          return Syslog
+      syslog_impl = syslog_implementation
+      if syslog_impl.opened?
+        if (progname.nil? || syslog_impl.ident == progname) && @syslog_facility == syslog_impl.facility && @syslog_options == syslog_impl.options
+          return syslog_impl
+        else
+          syslog_impl.close
         end
-        Syslog.close
       end
-      syslog = Syslog.open(progname, @syslog_options, @syslog_facility)
+      syslog = syslog_impl.open(progname, @syslog_options, @syslog_facility)
       syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_DEBUG)
       syslog
     end
+
+    # Provided for testing purposes
+    def syslog_implementation #:nodoc:
+      Syslog
+    end
+
+    def default_template
+      lambda do |entry|
+        tags = entry.tags
+        if tags && !tags.empty?
+          message = String.new(entry.message)
+          message << " (#{entry.unit_of_work_id})" if entry.unit_of_work_id
+          tags.each do |name, value|
+            message << " [#{name}:#{value.inspect}]" unless name == Lumberjack::LogEntry::UNIT_OF_WORK_ID
+          end
+          message
+        else
+          entry.message
+        end
+      end
+    end
   end
 end

data/lumberjack_syslog_device.gemspec

@@ -0,0 +1,33 @@
+Gem::Specification.new do |spec|
+  spec.name = 'lumberjack_syslog_device'
+  spec.version = File.read(File.expand_path("../VERSION", __FILE__)).strip
+  spec.authors = ['Brian Durand']
+  spec.email = ['bbdurand@gmail.com']
+
+  spec.summary = "A logging device for the lumberjack gem that writes log entries to syslog."
+  spec.homepage = "https://github.com/bdurand/lumberjack_syslog_device"
+  spec.license = "MIT"
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  ignore_files = %w(
+    .gitignore
+    .travis.yml
+    Appraisals
+    Gemfile
+    Gemfile.lock
+    Rakefile
+    gemfiles/
+    spec/
+  )
+  spec.files = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject{ |f| ignore_files.any?{ |path| f.start_with?(path) } }
+  end
+
+  spec.require_paths = ['lib']
+
+  spec.add_dependency "lumberjack", ">=1.1"
+
+  spec.add_development_dependency("rspec", ["~> 3.0"])
+  spec.add_development_dependency "rake"
+end

metadata

@@ -1,90 +1,91 @@
---- !ruby/object:Gem::Specification 
+--- !ruby/object:Gem::Specification
 name: lumberjack_syslog_device
-version: !ruby/object:Gem::Version 
-  hash: 23
-  prerelease: 
-  segments: 
-  - 1
-  - 0
-  - 0
-  version: 1.0.0
+version: !ruby/object:Gem::Version
+  version: 1.1.0
 platform: ruby
-authors: 
+authors:
 - Brian Durand
 autorequire: 
 bindir: bin
 cert_chain: []
-
-date: 2011-02-11 00:00:00 -06:00
-default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
+date: 2020-01-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
   name: lumberjack
-  prerelease: false
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
-    requirements: 
-    - - ~>
-      - !ruby/object:Gem::Version 
-        hash: 15
-        segments: 
-        - 1
-        - 0
-        version: "1.0"
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
   type: :runtime
-  version_requirements: *id001
-description: A logging device for the lumberjack gem that writes log entries to syslog.
-email: 
-- bdurand@embellishedvisions.com
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.1'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: 
+email:
+- bbdurand@gmail.com
 executables: []
-
 extensions: []
-
-extra_rdoc_files: 
-- README.rdoc
-files: 
-- README.rdoc
-- VERSION
-- Rakefile
+extra_rdoc_files: []
+files:
+- CHANGE_LOG.md
 - MIT_LICENSE
+- README.md
+- VERSION
 - lib/lumberjack_syslog_device.rb
-- spec/lumberjack_syslog_device_spec.rb
-- spec/spec_helper.rb
-has_rdoc: true
-homepage: http://github.com/bdurand/lumberjack_mongo_device
-licenses: []
-
+- lumberjack_syslog_device.gemspec
+homepage: https://github.com/bdurand/lumberjack_syslog_device
+licenses:
+- MIT
+metadata: {}
 post_install_message: 
-rdoc_options: 
-- --charset=UTF-8
-- --main
-- README.rdoc
-require_paths: 
+rdoc_options: []
+require_paths:
 - lib
-required_ruby_version: !ruby/object:Gem::Requirement 
-  none: false
-  requirements: 
+required_ruby_version: !ruby/object:Gem::Requirement
+  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
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
   - - ">="
-    - !ruby/object:Gem::Version 
-      hash: 3
-      segments: 
-      - 0
-      version: "0"
+    - !ruby/object:Gem::Version
+      version: '0'
 requirements: []
-
-rubyforge_project: 
-rubygems_version: 1.5.0
+rubygems_version: 3.0.3
 signing_key: 
-specification_version: 3
+specification_version: 4
 summary: A logging device for the lumberjack gem that writes log entries to syslog.
 test_files: []
-

data/README.rdoc

@@ -1,13 +0,0 @@
-Lumberjack Syslog Device
-
-This gem provides a logging device for the lumberjack gem that will log to syslog, the centralized system logging facility. See http://en.wikipedia.org/wiki/Syslog for more information on syslog.
-
-== Example Usage
-
-  require 'lumberjack_syslog_device'
-  
-  device = Lumberjack::SyslogDevice.new
-  logger = Lumberjack::Logger.new(device)
-  logger.info("Write me to syslog!")
-
-See SyslogDevice for more details.

data/Rakefile

@@ -1,56 +0,0 @@
-require 'rubygems'
-require 'rake'
-require 'rake/gempackagetask'
-require 'rake/rdoctask'
-
-desc 'Default: run unit tests.'
-task :default => :test
-
-desc 'RVM likes to call it tests'
-task :tests => :test
-
-begin
-  require 'rspec'
-  require 'rspec/core/rake_task'
-  desc 'Run the unit tests'
-  RSpec::Core::RakeTask.new(:test)
-rescue LoadError
-  task :test do
-    STDERR.puts "You must have rspec 2.0 installed to run the tests"
-  end
-end
-
-desc 'Generate rdoc.'
-Rake::RDocTask.new(:rdoc) do |rdoc|
-  rdoc.rdoc_dir = 'rdoc'
-  rdoc.options << '--title' << 'Lumberjack Syslog Device' << '--line-numbers' << '--inline-source' << '--main' << 'README.rdoc'
-  rdoc.rdoc_files.include('README.rdoc')
-  rdoc.rdoc_files.include('lib/**/*.rb')
-end
-
-namespace :rbx do
-  desc "Cleanup *.rbc files in lib directory"
-  task :delete_rbc_files do
-    FileList["lib/**/*.rbc"].each do |rbc_file|
-      File.delete(rbc_file)
-    end
-    nil
-  end
-end
-
-spec_file = File.expand_path('../lumberjack_syslog_device.gemspec', __FILE__)
-if File.exist?(spec_file)
-  spec = eval(File.read(spec_file))
-
-  Rake::GemPackageTask.new(spec) do |p|
-    p.gem_spec = spec
-  end
-  Rake.application["package"].prerequisites.unshift("rbx:delete_rbc_files")
-
-  desc "Release to rubygems.org"
-  task :release => :package do
-    require 'rake/gemcutter'
-    Rake::Gemcutter::Tasks.new(spec).define
-    Rake::Task['gem:push'].invoke
-  end
-end

data/spec/lumberjack_syslog_device_spec.rb

@@ -1,119 +0,0 @@
-require 'spec_helper'
-
-describe Lumberjack::SyslogDevice do
-  
-  let(:time){ Time.parse("2011-02-01T18:32:31Z") }
-  let(:entry){ Lumberjack::LogEntry.new(time, Lumberjack::Severity::WARN, "message 1", "lumberjack_syslog_device_spec", 12345, "ABCD") }
-
-  context "open connecton" do  
-    it "should be able to specify syslog options" do
-      syslog = MockSyslog.new
-      device = Lumberjack::SyslogDevice.new(:options => Syslog::LOG_CONS)
-      Syslog.should_receive(:open).with(entry.progname, Syslog::LOG_CONS, nil).and_return(syslog)
-      device.write(entry)
-    end
-  
-    it "should be able to specify a syslog facility" do
-      syslog = MockSyslog.new
-      device = Lumberjack::SyslogDevice.new(:facility => Syslog::LOG_FTP)
-      Syslog.should_receive(:open).with(entry.progname, (Syslog::LOG_PID | Syslog::LOG_CONS), Syslog::LOG_FTP).and_return(syslog)
-      device.write(entry)
-    end
-  
-    it "should log all messages since the logger will filter them by severity" do
-      syslog = MockSyslog.new
-      device = Lumberjack::SyslogDevice.new
-      Syslog.should_receive(:open).with(entry.progname, (Syslog::LOG_PID | Syslog::LOG_CONS), nil).and_return(syslog)
-      device.write(entry)
-      syslog.mask.should == Syslog::LOG_UPTO(Syslog::LOG_DEBUG)
-    end
-  end
-  
-  context "logging" do
-    it "should log entries to syslog" do
-      entry.unit_of_work_id = nil
-      device = Lumberjack::SyslogDevice.new
-      messages = read_syslog do
-        device.write(entry)
-      end
-      messages.first.should include("message 1")
-    end
-  
-    it "should log output to syslog with the unit of work id if it exists" do
-      device = Lumberjack::SyslogDevice.new
-      messages = read_syslog do
-        device.write(entry)
-      end
-      messages.first.should include("message 1 (#ABCD)")
-    end
-  
-    it "should be able to specify a string template" do
-      device = Lumberjack::SyslogDevice.new(:template => ":unit_of_work_id - :message")
-      messages = read_syslog do
-        device.write(entry)
-      end
-      messages.first.should include("ABCD - message 1")
-    end
-  
-    it "should be able to specify a proc template" do
-      device = Lumberjack::SyslogDevice.new(:template => lambda{|e| e.message.upcase})
-      messages = read_syslog do
-        device.write(entry)
-      end
-      messages.first.should include("MESSAGE 1")
-    end
-  
-    it "should properly handle percent signs in the syslog message" do
-      device = Lumberjack::SyslogDevice.new
-      entry.message = "message 100%"
-      messages = read_syslog do
-        device.write(entry)
-      end
-      messages.first.should include("message 100% (#ABCD)")
-    end
-  
-    it "should convert lumberjack severities to syslog severities" do
-      syslog = MockSyslog.new
-      device = Lumberjack::SyslogDevice.new
-      Syslog.stub!(:open).and_return(syslog)
-      syslog.should_receive(:log).with(Syslog::LOG_DEBUG, "debug")
-      syslog.should_receive(:log).with(Syslog::LOG_INFO, "info")
-      syslog.should_receive(:log).with(Syslog::LOG_WARNING, "warn")
-      syslog.should_receive(:log).with(Syslog::LOG_ERR, "error")
-      syslog.should_receive(:log).with(Syslog::LOG_CRIT, "fatal")
-      device.write(Lumberjack::LogEntry.new(Time.now, Lumberjack::Severity::DEBUG, "debug", "lumberjack_syslog_device_spec", 12345, nil))
-      device.write(Lumberjack::LogEntry.new(Time.now, Lumberjack::Severity::INFO, "info", "lumberjack_syslog_device_spec", 12345, nil))
-      device.write(Lumberjack::LogEntry.new(Time.now, Lumberjack::Severity::WARN, "warn", "lumberjack_syslog_device_spec", 12345, nil))
-      device.write(Lumberjack::LogEntry.new(Time.now, Lumberjack::Severity::ERROR, "error", "lumberjack_syslog_device_spec", 12345, nil))
-      device.write(Lumberjack::LogEntry.new(Time.now, Lumberjack::Severity::FATAL, "fatal", "lumberjack_syslog_device_spec", 12345, nil))
-    end
-    
-    it "should log messages with the syslog ident set to the progname" do
-      device = Lumberjack::SyslogDevice.new
-      messages = read_syslog("lumberjack_syslog_device") do
-        device.write(entry)
-        entry.progname = "spec_for_lumberjack_syslog_device"
-        entry.message = "new message"
-        device.write(entry)
-      end
-      messages.first.should include("lumberjack_syslog_device_spec")
-      messages.last.should include("spec_for_lumberjack_syslog_device")
-    end
-    
-    it "should keep open the syslog connection by default" do
-      device = Lumberjack::SyslogDevice.new
-      messages = read_syslog do
-        device.write(entry)
-        Syslog.should be_opened
-      end
-    end
-    
-    it "should close the syslog connection if :close_connection is true" do
-      device = Lumberjack::SyslogDevice.new(:close_connection => true)
-      messages = read_syslog do
-        device.write(entry)
-        Syslog.should_not be_opened
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,52 +0,0 @@
-require File.expand_path("../../lib/lumberjack_syslog_device.rb", __FILE__)
-
-SYSLOG_FILE = ENV["SYSLOG_FILE"] || "/var/log/system.log"
-
-# Round about way of reading syslog by following it using the command line and looking in the output.
-def read_syslog(progname = "lumberjack_syslog_device_spec")
-  message_id = rand(0xFFFFFFFFFFFFFFFF)
-  Syslog.open("lumberjack_syslog_device_spec") do |syslog|
-    syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_DEBUG)
-    syslog.warning("************** start #{message_id}")
-  end
-  
-  yield
-  
-  Syslog.close if Syslog.opened?
-  Syslog.open("lumberjack_syslog_device_spec") do |syslog|
-    syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_DEBUG)
-    syslog.warning("************** end #{message_id}")
-  end
-  
-  # Loop over the syslog file until the start and end markers are found
-  8.times do
-    retval = nil
-    lines = `tail -500 #{SYSLOG_FILE}`.split("\n")
-    lines.each do |line|
-      if line.include?("start #{message_id}")
-        retval = []
-      elsif line.include?("end #{message_id}")
-        return retval
-      else
-        retval << line if retval && line.include?(progname)
-      end
-    end
-    break if retval
-    sleep(0.25)
-  end
-  raise "could not find message logged to #{SYSLOG_FILE}"
-end
-
-class MockSyslog
-  attr_accessor :mask
-  attr_reader :ident, :options, :facility
-
-  def open(ident, options, facility)
-    @ident = ident
-    @options = options
-    @facility = facility
-  end
-
-  def log(*args)
-  end
-end