logging-remote-syslog 0.0.1

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1,2 @@
+--default_path spec
+--order rand

data/.travis.yml

@@ -0,0 +1,9 @@
+language: ruby
+rvm:
+  - 1.8.7
+  - 1.9.3
+  - jruby-18mode # JRuby in 1.8 mode
+  - jruby-19mode # JRuby in 1.9 mode
+  - rbx-18mode
+  - rbx-19mode
+  - ree

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in logging-remote-syslog.gemspec
+gemspec

data/README.md

@@ -0,0 +1,51 @@
+# logging/remote-syslog
+
+logging/remote-syslog is a remote syslog appender for use with the Logging library. ![Travis CI Status](https://secure.travis-ci.org/BIAINC/logging-remote-syslog.png)
+
+## Installation
+
+Add this line to your application's Gemfile:
+    ```bash
+    gem 'logging-remote-syslog'
+    ```
+
+And then execute:
+    ```bash
+    $ bundle
+    ```
+
+Or install it yourself as:
+    ```bash
+    $ gem install logging-remote-syslog
+    ```
+
+## Usage
+
+```
+require 'logging'
+require 'logging/remote-syslog'
+
+logger = Logging.logger['MyApp']
+logger.add_appenders(
+  Logging.appenders.remote_syslog(ident, syslog_server: syslog_host, port: syslog_port)
+  )
+
+logger.level = :info
+logger.info 'MyApp Message'
+
+```
+
+## Tests
+
+```
+rake
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Write code and add _tests_
+4. Commit your changes (`git commit -am 'Added some feature'`)
+5. Push to the branch (`git push origin my-new-feature`)
+6. Create new Pull Request

data/Rakefile

@@ -0,0 +1,15 @@
+#!/usr/bin/env rake
+require 'bundler'
+require "bundler/gem_tasks"
+
+Bundler.setup
+Bundler.require
+
+require 'rspec/core/rake_task'
+
+task :default => [:spec]
+
+desc "Run all RSpec tests"
+RSpec::Core::RakeTask.new(:spec) do |t|
+  t.ruby_opts = ["-W0"]
+end

data/lib/logging/VERSION

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

data/lib/logging/appenders/remote-syslog.rb

@@ -0,0 +1,170 @@
+# Copyright (c) <2012> ['Tim Pease','Amy Sutedja', 'Paul Morton']
+#
+# 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.
+
+module Logging::Appenders
+  def self.remote_syslog( *args )
+    return Logging::Appenders::RemoteSyslog if args.empty?
+    Logging::Appenders::RemoteSyslog.new(*args)
+  end
+
+  # This class provides an Appender that can write to remote syslog.
+  #
+  class RemoteSyslog < Logging::Appender
+    # call-seq:
+    #    RemoteSyslog.new( name, opts = {} )
+    #
+    # Create an appender that will log messages to remote syslog. The
+    # options that can be used to configure the appender are as follows:
+    #
+    #    :ident         => identifier string (name is used by default)
+    #    :syslog_server => address of the remote syslog server
+    #    :port          => port of the remote syslog server
+    #    :facility      => the syslog facility to use
+    #
+    # The parameter :ident is a string that will be prepended to every
+    # message. The :facility parameter encodes a default facility to be
+    # assigned to all messages that do not have an explicit facility encoded.
+    #
+    #    'auth'       The authorization system: login(1), su(1), getty(8),
+    #                 etc.
+    #
+    #    'authpriv'   The same as 'auth', but logged to a file readable
+    #                 only by selected individuals.
+    #
+    #    'cron'       The cron daemon: cron(8).
+    #
+    #    'daemon'     System daemons, such as routed(8), that are not
+    #                 provided for explicitly by other facilities.
+    #
+    #    'ftp'        The file transfer protocol daemons: ftpd(8), tftpd(8).
+    #
+    #    'kern'       Messages generated by the kernel. These cannot be
+    #                 generated by any user processes.
+    #
+    #    'lpr'        The line printer spooling system: lpr(1), lpc(8),
+    #                 lpd(8), etc.
+    #
+    #    'mail'       The mail system.
+    #
+    #    'news'       The network news system.
+    #
+    #    'syslog'     Messages generated internally by syslogd(8).
+    #
+    #    'user'       Messages generated by random user processes. This is
+    #                 the default facility identifier if none is specified.
+    #
+    #    'uucp'       The uucp system.
+    #
+    #    'local0'     Reserved for local use. Similarly for 'local1'
+    #                 through 'local7'.
+    #
+    # See SyslogProtocol::FACILITIES for the complete list of valid values.
+    #
+    def initialize( name, opts = {} )
+      @ident = opts.getopt(:ident, name)
+      @syslog_server =  opts.getopt(:syslog_server, '127.0.0.1')
+      @port = opts.getopt(:port, 514, :as => Integer)
+
+      facility_name = opts.getopt(:facility, 'user')
+
+      @facility = ::SyslogProtocol::FACILITIES[facility_name]
+
+      # provides a mapping from the default Logging levels
+      # to the syslog levels
+      @map = ['debug', 'info', 'warn', 'err', 'crit']
+
+      map = opts.getopt(:map)
+      self.map = map unless map.nil?
+
+      super
+    end
+
+    # call-seq:
+    #    map = { logging_levels => syslog_levels }
+    #
+    # Configure the mapping from the Logging levels to the syslog levels.
+    # This is needed in order to log events at the proper syslog level.
+    #
+    # Without any configuration, the following mapping will be used:
+    #
+    #    :debug  =>  'debug'
+    #    :info   =>  'info'
+    #    :warn   =>  'warn'
+    #    :error  =>  'err'
+    #    :fatal  =>  'crit'
+    #
+    def map=( levels )
+      map = []
+      levels.keys.each do |lvl|
+        num = ::Logging.level_num(lvl)
+        map[num] = syslog_level_num(levels[lvl])
+      end
+      @map = map
+    end
+
+
+    private
+
+    # call-seq:
+    #    write( event )
+    #
+    # Write the given _event_ to the syslog facility. The log event will be
+    # processed through the Layout associated with this appender. The message
+    # will be logged at the level specified by the event.
+    #
+    def write( event )
+      pri = SyslogProtocol::SEVERITIES['debug']
+      message = if event.instance_of?(::Logging::LogEvent)
+          pri = @map[event.level]
+          @layout.format(event)
+        else
+          event.to_s
+        end
+      return if message.empty?
+
+      udp_sender = RemoteSyslogLogger::UdpSender.new(
+        @syslog_server,
+        @port,
+        :facility => @facility,
+        :severity => pri,
+        :program => @ident
+        )
+
+      udp_sender.write(message)
+
+      self
+    end
+
+    # call-seq:
+    #    syslog_level_num( level )    => integer
+    #
+    # Takes the given _level_ as a string, symbol, or integer and returns
+    # the corresponding syslog level number.
+    #
+    def syslog_level_num( level )
+      case level
+      when Integer; level
+      when String, Symbol
+        level = level.to_s.downcase
+        SyslogProtocol::SEVERITIES[level]
+      else
+        raise ArgumentError, "unknown level '#{level}'"
+      end
+    end
+
+  end  # RemoteSyslog
+end # Logging::Appenders

data/lib/logging/remote-syslog.rb

@@ -0,0 +1,22 @@
+# Copyright (c) <2012> ['Amy Sutedja', 'Paul Morton']
+#
+# 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 "logging/appender"
+require "syslog_protocol/common"
+require "remote_syslog_logger/udp_sender"
+
+require 'logging/appenders/remote-syslog'

data/logging-remote-syslog.gemspec

@@ -0,0 +1,40 @@
+# -*- encoding: utf-8 -*-
+# Copyright (c) <2012> ['Amy Sutedja', 'Paul Morton']
+#
+# 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.
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Amy Sutedja", "Paul Morton"]
+  gem.email         = ["asutedja@biaprotect.com", "pmorton@biaprotect.com"]
+  gem.description   = "Remote syslog appender for Logging"
+  gem.summary       = File.read('README.md')
+  gem.homepage      = "https://github.com/BIAINC/logging-remote-syslog"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = gem.files.grep(%r{^bin/}).map{ |f| File.basename(f) }
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "logging-remote-syslog"
+  gem.require_paths = ["lib"]
+  gem.version       = File.read('./lib/logging/VERSION')
+  gem.license       = 'MIT'
+
+  gem.add_runtime_dependency 'logging', '>= 1.7.2'
+  gem.add_runtime_dependency 'remote_syslog_logger', '>= 1.0.3'
+
+  gem.add_development_dependency 'rspec', '>= 2.10.0'
+  gem.add_development_dependency 'rake', '>= 0.9.2'
+  gem.add_development_dependency 'rr', '>= 1.0.4'
+end

data/spec/logging/appenders/remote_syslog_spec.rb

@@ -0,0 +1,58 @@
+# Copyright (c) <2012> ['Amy Sutedja', 'Paul Morton']
+#
+# 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 'spec_helper'
+
+# Logging Logger
+Logging.logger[::Logging].add_appenders(Logging.appenders.stdout)
+Logging.logger[::Logging].level = :info
+
+describe Logging::Appenders::RemoteSyslog do
+  it 'can be instantiated' do
+    Logging.appenders.remote_syslog('Test').should be_an_instance_of(Logging::Appenders::RemoteSyslog)
+  end
+
+  it 'can log' do
+    syslog_host = 'logs.papertrailapp.com'
+    syslog_port = 63961
+    ident = 'Test'
+    message = 'Test Message'
+    level = :info
+    facility = 'local6'
+
+    any_instance_of(RemoteSyslogLogger::UdpSender) do |s|
+      stub(s).initialize do |*args|
+        args[0].should == syslog_host
+        args[1].should == syslog_port
+        args[2][:facility].should == SyslogProtocol::FACILITIES[facility]
+        args[2][:severity].should == 'info'
+        args[2][:program].should == ident
+      end
+
+      stub(s).write do |*args|
+        args.first.should == " #{level.to_s.upcase}  #{ident} : #{message}\n"
+      end
+    end
+
+    logger = Logging.logger['Test']
+    logger.add_appenders(
+      Logging.appenders.remote_syslog(ident, :syslog_server => syslog_host, :port => syslog_port, :facility => facility)
+      )
+    logger.level = level
+    logger.info("Test Message").should == true
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,21 @@
+# Copyright (c) <2012> ['Amy Sutedja', 'Paul Morton']
+#
+# 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.
+
+Dir['./spec/support/**/*.rb'].map {|f| require f}
+
+require 'logging'
+require 'logging/remote-syslog'

data/spec/support/rr.rb

@@ -0,0 +1,20 @@
+# Copyright (c) <2012> ['Amy Sutedja', 'Paul Morton']
+#
+# 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.
+
+RSpec.configure do |configuration|
+  configuration.mock_with :rr
+end

metadata

@@ -0,0 +1,161 @@
+--- !ruby/object:Gem::Specification
+name: logging-remote-syslog
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Amy Sutedja
+- Paul Morton
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-06-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: logging
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.7.2
+- !ruby/object:Gem::Dependency
+  name: remote_syslog_logger
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.10.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.9.2
+- !ruby/object:Gem::Dependency
+  name: rr
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.0.4
+description: Remote syslog appender for Logging
+email:
+- asutedja@biaprotect.com
+- pmorton@biaprotect.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- .travis.yml
+- Gemfile
+- README.md
+- Rakefile
+- lib/logging/VERSION
+- lib/logging/appenders/remote-syslog.rb
+- lib/logging/remote-syslog.rb
+- logging-remote-syslog.gemspec
+- spec/logging/appenders/remote_syslog_spec.rb
+- spec/spec_helper.rb
+- spec/support/rr.rb
+homepage: https://github.com/BIAINC/logging-remote-syslog
+licenses:
+- MIT
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3243274781071415485
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+      segments:
+      - 0
+      hash: 3243274781071415485
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: ! '# logging/remote-syslog  logging/remote-syslog is a remote syslog appender
+  for use with the Logging library. ![Travis CI Status](https://secure.travis-ci.org/BIAINC/logging-remote-syslog.png)  ##
+  Installation  Add this line to your application''s Gemfile: ```bash gem ''logging-remote-syslog''
+  ```  And then execute: ```bash $ bundle ```  Or install it yourself as: ```bash
+  $ gem install logging-remote-syslog ```  ## Usage  ``` require ''logging'' require
+  ''logging/remote-syslog''  logger = Logging.logger[''MyApp''] logger.add_appenders(
+  Logging.appenders.remote_syslog(ident, syslog_server: syslog_host, port: syslog_port)
+  )  logger.level = :info logger.info ''MyApp Message''  ```  ## Tests  ``` rake ```  ##
+  Contributing  1. Fork it 2. Create your feature branch (`git checkout -b my-new-feature`)
+  3. Write code and add _tests_ 4. Commit your changes (`git commit -am ''Added some
+  feature''`) 5. Push to the branch (`git push origin my-new-feature`) 6. Create new
+  Pull Request'
+test_files:
+- spec/logging/appenders/remote_syslog_spec.rb
+- spec/spec_helper.rb
+- spec/support/rr.rb