log4r_remote_syslog_outputter 0.0.1

data/.gitignore

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

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--profile
+--backtrace

data/Gemfile

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

data/README

@@ -0,0 +1,4 @@
+A Log4r outputter that delegates to Papertrail's remote syslog logger.
+
+See lib/log4r_remote_syslog_outputter/log4r/outputters/remote_syslog_outputter.rb
+for usage information, it's self-explanatory.

data/Rakefile

@@ -0,0 +1,18 @@
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+desc 'Default: run specs.'
+task :default => :spec
+
+desc "Run specs"
+RSpec::Core::RakeTask.new do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  # Put spec opts in a file named .rspec in root
+end
+
+desc "Generate code coverage"
+RSpec::Core::RakeTask.new(:coverage) do |t|
+  t.pattern = "./spec/**/*_spec.rb" # don't need this, it's default.
+  t.rcov = true
+  t.rcov_opts = ['--exclude', 'spec']
+end

data/lib/log4r_remote_syslog_outputter.rb

@@ -0,0 +1,3 @@
+require "log4r_remote_syslog_outputter/version"
+require "log4r_remote_syslog_outputter/log4r/outputter/remote_syslog_outputter"
+

data/lib/log4r_remote_syslog_outputter/log4r/outputter/remote_syslog_outputter.rb

@@ -0,0 +1,40 @@
+require 'log4r/outputter/outputter'
+require 'remote_syslog_logger/udp_sender'
+require 'uri'
+
+module Log4r
+  class RemoteSyslogOutputter < Log4r::Outputter
+    # The url is required here but it has to be specified
+    # as an option (not a parameter) because that's the only
+    # way it can be created from a configuration file.
+    #   :url  is given when an XML configuration file is used
+    #   'url' is given when a YAML configuration file is used
+    def initialize(name, options = {})
+      url =   options['url']
+      url ||= options[:url]
+      uri = URI.parse(url)
+      options.dup.tap do |o|
+        super(name, [:level, :formatter, :url, 'url'].inject({}) { |h, i| 
+          h.tap { |a| 
+            a[i] = o.delete(i) 
+          } 
+        })
+        @udp_sender = RemoteSyslogLogger::UdpSender.new(uri.host, uri.port, symbolize_keys(o))
+      end
+    end
+    private
+
+    def write(data)
+      @udp_sender.write(data)
+    end
+
+    def symbolize_keys(hash)
+      output = {}
+      hash.each do |key, value|
+        output[key.to_sym] = value
+      end
+      output
+    end
+
+  end
+end

data/lib/log4r_remote_syslog_outputter/version.rb

@@ -0,0 +1,3 @@
+class Log4rRemoteSyslogOutputter
+  VERSION = "0.0.1"
+end

data/log4r_remote_syslog_outputter.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "log4r_remote_syslog_outputter/version"
+
+Gem::Specification.new do |s|
+  s.name        = "log4r_remote_syslog_outputter"
+  s.version     = Log4rRemoteSyslogOutputter::VERSION
+  s.authors     = ["Rob Hanlon"]
+  s.email       = ["rob@mediapiston.com"]
+  s.homepage    = "http://www.mediapiston.com/"
+  s.summary     = %q{A Log4r outputter that outputs via remote syslog}
+  s.description = %q{The outputter included in this library simply ties Log4r's Outputter interface together with remote_syslog_logger.}
+
+  s.add_dependency('log4r', '>= 1.1.9')
+  s.add_dependency('remote_syslog_logger', '>= 1.0.3')
+
+  s.add_development_dependency('rspec', '>= 2.7.0')
+
+  s.rubyforge_project = "log4r_remote_syslog_outputter"
+
+  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"]
+end

data/spec/config_files/config.xml

@@ -0,0 +1,15 @@
+<log4r_config>
+ 
+    <!-- Outputters -->
+    <outputter name="remote_syslog_outputter" type="RemoteSyslogOutputter" level="ALL" url="http://localhost:3203">
+        <formatter type="Log4r::PatternFormatter">
+            <pattern>=>[%5l %d] %C: %M [%t]</pattern>
+        </formatter>
+    </outputter>
+  
+    <!-- Loggers -->
+    <logger name="my_awesome_logger" level="ALL" additive="false" trace="true">
+        <outputter>remote_syslog_outputter</outputter>
+    </logger>
+  
+</log4r_config>

data/spec/lib/log4r/logger_spec.rb

@@ -0,0 +1,26 @@
+require 'spec_helper'
+
+describe Log4r::Logger do
+  describe 'with RemoteSyslogOutputter' do
+    let(:url)  {'http://localhost:' + (rand(65535 - 1024)+1024).to_s }
+    let(:uri)  { URI.parse(url) }
+    let(:host) { uri.host }
+    let(:port) { uri.port }
+    let(:outputter) { Log4r::RemoteSyslogOutputter.new('outputter', :url => url) }
+ 
+    let(:socket) { UDPSocket.new }
+
+    subject { Log4r::Logger.new('Logger') }
+
+    before(:each) do
+      subject.outputters << outputter
+      socket.bind(host, port)
+    end
+
+    it 'should make a UDP request to localhost' do
+      subject.info 'Info'
+      message, = socket.recvfrom(1024)
+      message.should =~ /Logger.*Info/
+    end
+  end
+end

data/spec/lib/log4r/outputter/remote_syslog_outputter_spec.rb

@@ -0,0 +1,101 @@
+require 'spec_helper'
+
+describe Log4r::RemoteSyslogOutputter do
+  
+  let(:name) { 'name' }
+  let(:url)  { 'http://localhost:65535' }
+  let(:uri)  { URI.parse(url) }
+  let(:host) { uri.host }
+  let(:port) { uri.port }
+
+  describe '#initialize' do
+
+    subject { Log4r::RemoteSyslogOutputter }
+
+    it 'should create a new RemoteSyslogLogger::UdpSender' do
+      RemoteSyslogLogger::UdpSender
+        .should_receive(:new)
+        .with(host, port, {})
+
+      subject.new(name, :url => url)
+    end
+
+    it "should not pass along :level and :formatter, and 'url' to RemoteSyslogLogger::UdpSender's constructor" do
+      RemoteSyslogLogger::UdpSender
+        .should_receive(:new)
+        .with(host, port, :key => 'value')
+
+      subject.new(name, :url => url, :level => nil, :formatter => nil, :key => 'value')
+    end
+
+    it "should symbolize the extra keys" do
+      RemoteSyslogLogger::UdpSender
+        .should_receive(:new)
+        .with(host, port, :program => 'value')
+
+      subject.new(name, :url => url, :level => nil, :formatter => nil, 'program' => 'value')
+
+    end
+
+    it 'should not modify the input options hash, using a duplicate' do
+      options = {:url => url, :level => nil, :formatter => nil}
+      orig_options = options.dup
+
+      RemoteSyslogLogger::UdpSender.should_receive(:new)
+
+      subject.new(name, options)
+
+      options.should == orig_options
+    end
+  end
+
+  describe '#write' do
+    let(:udp_sender) { stub }
+    let(:data) { stub }
+
+    subject { Log4r::RemoteSyslogOutputter.new(name, :url => url) }
+
+    it 'should delegate to udp_sender#write' do
+      RemoteSyslogLogger::UdpSender.stub!(:new).and_return(udp_sender)
+
+      udp_sender.should_receive(:write).with(data)
+
+      subject.send(:write, data)
+    end
+  end
+
+  context 'when creating via a configuration file' do
+
+    let(:logger_name)   { "my_awesome_logger" }
+    let(:outputter_name) { "remote_syslog_outputter" }
+    let(:hash_from_yaml) do
+      { 
+        "loggers"=> [
+          {"name"=> logger_name, "level"=>"ALL", "trace" => true, "additive"=>false, "outputters"=>[outputter_name]}
+        ],        
+        "outputters" =>  [
+          {"type" => "RemoteSyslogOutputter", "name" => outputter_name, "level" => "ALL", 
+           "url"  => "http://localhost:3203", "program" =>"Test",
+           "formatter" => {"pattern"=>"%C %l: %m", "type"=>"PatternFormatter" } 
+          }
+        ]
+      }
+  
+    end
+
+    it 'should work create an outputter from a YAML config file' do
+      Log4r::YamlConfigurator.decode_yaml(hash_from_yaml)
+    end
+
+    it 'should work with an XML config file' do
+      Log4r::Configurator.load_xml_file('spec/config_files/config.xml')
+    end
+
+    after(:each) do
+      outputter = Log4r::Outputter[outputter_name]
+      outputter.name.should eql(outputter_name)
+      Log4r::Logger[logger_name].outputters.should eql([outputter])
+    end
+
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,8 @@
+require 'rubygems'
+require 'bundler/setup'
+require 'log4r_remote_syslog_outputter'
+require 'log4r/yamlconfigurator'
+require 'log4r/configurator'
+require 'log4r/formatter/patternformatter'
+require 'uri'
+

metadata

@@ -0,0 +1,111 @@
+--- !ruby/object:Gem::Specification
+name: log4r_remote_syslog_outputter
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+  prerelease: 
+platform: ruby
+authors:
+- Rob Hanlon
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2012-09-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: log4r
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 1.1.9
+- !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.7.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 2.7.0
+description: The outputter included in this library simply ties Log4r's Outputter
+  interface together with remote_syslog_logger.
+email:
+- rob@mediapiston.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .rspec
+- Gemfile
+- README
+- Rakefile
+- lib/log4r_remote_syslog_outputter.rb
+- lib/log4r_remote_syslog_outputter/log4r/outputter/remote_syslog_outputter.rb
+- lib/log4r_remote_syslog_outputter/version.rb
+- log4r_remote_syslog_outputter.gemspec
+- spec/config_files/config.xml
+- spec/lib/log4r/logger_spec.rb
+- spec/lib/log4r/outputter/remote_syslog_outputter_spec.rb
+- spec/spec_helper.rb
+homepage: http://www.mediapiston.com/
+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: log4r_remote_syslog_outputter
+rubygems_version: 1.8.24
+signing_key: 
+specification_version: 3
+summary: A Log4r outputter that outputs via remote syslog
+test_files:
+- spec/config_files/config.xml
+- spec/lib/log4r/logger_spec.rb
+- spec/lib/log4r/outputter/remote_syslog_outputter_spec.rb
+- spec/spec_helper.rb