syslogger5424 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 22ddee9851cb22ad2d3b96c3e72f5d897abdaaed
+  data.tar.gz: 42079138da0fd99aa6230dffdc4ce852116da9f0
+SHA512:
+  metadata.gz: dddc1c51a0ca5f5d1203380f5d72e9563955c4532736e332e5d55a15ba1b132d62aa397caf30a3681aef78dd91ed2a5e06563e0502e9b82998ce453a96451e01
+  data.tar.gz: c3b327028cca44584dd95fc948a72652d9e5bdaa768f82f4a3ee6aa6279c5100a91ef3dc1f21690c3bc87238c655954d8e7cc33a05f844434da05fa52225a123

data/lib/syslogger.rb

@@ -0,0 +1,14 @@
+require 'socket'
+require 'logger'
+
+require 'syslogger/logger'
+require 'syslogger/io'
+require 'syslogger/formatter/rfc5424'
+
+module SysLogger
+  extend self
+
+  def new(logdev = nil, shift_age = 0, shift_size = 1048576, &block)
+    return Logger.new(logdev, shift_age, shift_size, &block)
+  end
+end

data/lib/syslogger/formatter/rfc5424.rb

@@ -0,0 +1,90 @@
+module SysLogger
+  module Formatter
+    class RFC5424 < ::Logger::Formatter
+      attr_reader :msgid, :procid, :appname
+
+      Format = "<%s>1 %s %s %s %s %s [meta x-group=\"%s\"] %s\n"
+
+      FACILITIES = {
+        :kern     => 0,
+        :user     => 1,
+        :mail     => 2,
+        :daemon   => 3,
+        :auth     => 4,
+        :syslog   => 5,
+        :lpr      => 6,
+        :news     => 7,
+        :uucp     => 8,
+        :cron     => 9,
+        :authpriv => 10,
+        :ftp      => 11,
+        :ntp      => 12,
+        :audit    => 13,
+        :alert    => 14,
+        :at       => 15,
+        :local0   => 16,
+        :local1   => 17,
+        :local2   => 18,
+        :local3   => 19,
+        :local4   => 20,
+        :local5   => 21,
+        :local6   => 22,
+        :local7   => 23
+      }
+
+      SEVERITIES = {
+        :emerg  => 0,
+        :alert  => 1,
+        :crit   => 2,
+        :fatal  => 2,
+        :err    => 3,
+        :error  => 3,
+        :warn   => 4,
+        :notice => 5,
+        :info   => 6,
+        :debug  => 7
+      }
+
+      def initialize(appname = nil, procid = nil, msgid = nil, facility = nil)
+        super()
+
+        @msgid = format(msgid, 32)
+        @procid = format(procid, 128)
+        @appname = format(appname, 48)
+
+        self.facility = facility || :local7
+      end
+
+      def facility; @facility; end
+      def facility=(f)
+        @facility = FACILITIES[f.to_s.downcase.to_sym] || @facility
+      end
+
+      def call(severity, datetime, progname, message)
+        severity = SEVERITIES[severity.to_s.downcase.to_sym] || SEVERITIES[:info]
+        pri = (facility * 8) + severity
+
+        # Since we're using RFC5424 format, it makes more sense to use the
+        # passed in progname as the msgid rather than changing the appname when
+        # a block was received to generate the message.
+        message_id = progname.nil? ? msgid : format(progname, 32)
+
+        x_group = rand(99999999)
+        lines = msg2str(message).split(/\r?\n/).reject(&:empty?).map do |line|
+          Format % [pri, datetime.strftime("%FT%T.%6N%:z"), Socket.gethostname,
+                    appname, procid, message_id, x_group, line]
+        end
+
+        lines.join
+      end
+
+      def format(text, max_length)
+        if text
+          text[0..max_length].gsub(/\s+/, '')
+        else
+          '-'
+        end
+      end
+    end
+  end
+end

data/lib/syslogger/io.rb

@@ -0,0 +1,43 @@
+module SysLogger
+  class IO
+    def initialize(&file_creator)
+      @file_creator = file_creator
+      @file = @file_creator.call
+    end
+
+    def file
+      @file.closed? ? @file = @file_creator.call : @file
+    end
+
+    def write(message)
+      tries = 2
+      Array(message).each do |msg|
+        begin
+          transmit(msg)
+        rescue
+          file.close
+          retry unless (tries -= 1).zero?
+        end
+      end
+    end
+
+    def transmit(message)
+      # UNIXSocket overwrites Object#send, so using file.respond_to?(:send)
+      # does not work. If send and __send__ have different signigutres call
+      # send. Otherwise, call write.
+      unless file.method(:send).hash == file.method(:__send__).hash
+        file.send(message)
+      else
+        file.write(message)
+      end
+    end
+
+    def flush
+      @file.flush
+    end
+
+    def close
+      @file.close
+    end
+  end
+end

data/lib/syslogger/logger.rb

@@ -0,0 +1,17 @@
+module SysLogger
+  class Logger < ::Logger
+    attr_reader :logdev, :default_formatter
+
+    def initialize(logdev = nil, shift_age = 0, shift_size = 1048576, &block)
+      if logdev.nil? && block_given?
+        super(SysLogger::IO.new(&block), shift_age, shift_size)
+      elsif logdev.nil?
+        super($stdout, shift_age, shift_size)
+      else
+        super(logdev, shift_age, shift_size)
+      end
+
+      @default_formatter = SysLogger::Formatter::RFC5424.new
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,6 @@
+require 'syslogger'
+
+require 'rspec/its'
+
+RSpec.configure do |config|
+end

data/spec/syslogger/formatter/rfc5424_spec.rb

@@ -0,0 +1,13 @@
+describe SysLogger::Formatter::RFC5424 do
+  its(:msgid)    { is_expected.to eq "-" }
+  its(:procid)   { is_expected.to eq "-" }
+  its(:appname)  { is_expected.to eq "-" }
+  its(:facility) { is_expected.to eq 23 }
+
+  describe "#call" do
+    it "generates Format" do
+      expect(subject.call(::Logger::INFO, DateTime.now, "Prog", "Message")).
+        to match /<190>1.* - - Prog \[meta x-group=".*"\] Message/
+    end
+  end
+end

data/spec/syslogger/io_spec.rb

@@ -0,0 +1,14 @@
+describe SysLogger::IO do
+  let(:io) { StringIO.new }
+
+  subject { SysLogger::IO.new { io } }
+
+  its(:file) { is_expected.to eq io }
+
+  describe "#write" do
+    it "uses io" do
+      subject.write("foobar")
+      expect(io.string).to eq "foobar"
+    end
+  end
+end

data/spec/syslogger/logger_spec.rb

@@ -0,0 +1,14 @@
+describe SysLogger::Logger do
+  let(:io) { StringIO.new }
+
+  subject { SysLogger::Logger.new(io) }
+
+  its("logdev.dev")       { is_expected.to be io }
+  its(:default_formatter) { is_expected.to be_a SysLogger::Formatter::RFC5424 }
+
+  it "logs exceptions" do
+    subject.error StandardError.new("foobar")
+    expect(io.string).to match(
+      /<187>1.* - - - \[meta x-group=".*"\] foobar \(StandardError\)/)
+  end
+end

data/spec/syslogger_spec.rb

@@ -0,0 +1,9 @@
+describe SysLogger do
+  let(:logger) { SysLogger.new(StringIO.new) }
+
+  describe '#new' do
+    it 'creates a Logger' do
+      expect(logger).to be_a SysLogger::Logger
+    end
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification
+name: syslogger5424
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- EasyPost
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-09-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rspec
+  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'
+- !ruby/object:Gem::Dependency
+  name: rspec-its
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry
+  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'
+- !ruby/object:Gem::Dependency
+  name: pry-nav
+  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: support@easypost.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/syslogger.rb
+- lib/syslogger/formatter/rfc5424.rb
+- lib/syslogger/io.rb
+- lib/syslogger/logger.rb
+- spec/spec_helper.rb
+- spec/syslogger/formatter/rfc5424_spec.rb
+- spec/syslogger/io_spec.rb
+- spec/syslogger/logger_spec.rb
+- spec/syslogger_spec.rb
+homepage: http://github.com/EasyPost/syslogger
+licenses: []
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Logging via syslog
+test_files:
+- spec/spec_helper.rb
+- spec/syslogger/formatter/rfc5424_spec.rb
+- spec/syslogger/io_spec.rb
+- spec/syslogger/logger_spec.rb
+- spec/syslogger_spec.rb