rubysl-syslog 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 894d206e352212f68ad2cb0defbaa38990263981
+  data.tar.gz: 4757483d1db5f76795b993b88f9529268981064e
+SHA512:
+  metadata.gz: 82d6bb7c726e989f0417f8c7115499a0d8982b99e2c6906eea23bfbed8dec6166277a5182cf3cd57132ea7ed2fc329a6196b0ba90c060abf7fd0a65a3ef7d8c4
+  data.tar.gz: 55a005fdb0bf1f9d1bf79055ab7ca16e0a6d7b321a1d6b877d2e4d549bcb473146b65aa4084e26d8c69f355d726666e5ebdede742a2884ca1e7186ec23568dff

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/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+before_install:
+  - gem update --system
+  - gem --version
+  - gem install rubysl-bundler
+script: bundle exec mspec spec
+rvm:
+  - rbx-nightly-18mode

data/Gemfile

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

data/LICENSE

@@ -0,0 +1,25 @@
+Copyright (c) 2013, Brian Shirai
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this
+   list of conditions and the following disclaimer.
+2. Redistributions in binary form must reproduce the above copyright notice,
+   this list of conditions and the following disclaimer in the documentation
+   and/or other materials provided with the distribution.
+3. Neither the name of the library nor the names of its contributors may be
+   used to endorse or promote products derived from this software without
+   specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
+AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
+IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY DIRECT,
+INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
+BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
+DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
+OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
+NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
+EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

data/README.md

@@ -0,0 +1,29 @@
+# Rubysl::Syslog
+
+TODO: Write a gem description
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'rubysl-syslog'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install rubysl-syslog
+
+## Usage
+
+TODO: Write usage instructions here
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/lib/rubysl/syslog.rb

@@ -0,0 +1,2 @@
+require "rubysl/syslog/syslog"
+require "rubysl/syslog/version"

data/lib/rubysl/syslog/extconf.rb

@@ -0,0 +1,15 @@
+require "ffi2/generators"
+
+FFI::FileProcessor.new "syslog.rb.ffi", "syslog.rb"
+
+# Fake out rubygem's expected build steps with extconf.rb
+File.open "Makefile", "w" do |f|
+  f.puts <<-EOM
+.PHONY: all install
+
+all:
+
+install:
+
+  EOM
+end

data/lib/rubysl/syslog/syslog.rb.ffi

@@ -0,0 +1,307 @@
+#  Created by Ari Brown on 2008-02-23.
+#  For rubinius. All pwnage reserved.
+#
+
+# ** Syslog(Module)
+
+# Included Modules: Syslog::Constants
+
+# require 'syslog'
+
+# A Simple wrapper for the UNIX syslog system calls that might be handy
+# if you're writing a server in Ruby.  For the details of the syslog(8)
+# architecture and constants, see the syslog(3) manual page of your
+# platform.
+
+module Syslog
+  FFI = Rubinius::FFI
+
+  module Constants
+    @@@
+    constants do |c|
+      c.include 'syslog.h'
+
+      c.const 'LOG_EMERG'
+      c.const 'LOG_ALERT'
+      c.const 'LOG_ERR'
+      c.const 'LOG_CRIT'
+      c.const 'LOG_WARNING'
+      c.const 'LOG_NOTICE'
+      c.const 'LOG_INFO'
+      c.const 'LOG_DEBUG'
+      c.const 'LOG_PID'
+      c.const 'LOG_CONS'
+      c.const 'LOG_ODELAY'
+      c.const 'LOG_NDELAY'
+      c.const 'LOG_NOWAIT'
+      c.const 'LOG_PERROR'
+      c.const 'LOG_AUTH'
+      c.const 'LOG_AUTHPRIV'
+      c.const 'LOG_CONSOLE'
+      c.const 'LOG_CRON'
+      c.const 'LOG_DAEMON'
+      c.const 'LOG_FTP'
+      c.const 'LOG_KERN'
+      c.const 'LOG_LPR'
+      c.const 'LOG_MAIL'
+      c.const 'LOG_NEWS'
+      c.const 'LOG_NTP'
+      c.const 'LOG_SECURITY'
+      c.const 'LOG_SYSLOG'
+      c.const 'LOG_USER'
+      c.const 'LOG_UUCP'
+      c.const 'LOG_LOCAL0'
+      c.const 'LOG_LOCAL1'
+      c.const 'LOG_LOCAL2'
+      c.const 'LOG_LOCAL3'
+      c.const 'LOG_LOCAL4'
+      c.const 'LOG_LOCAL5'
+      c.const 'LOG_LOCAL6'
+      c.const 'LOG_LOCAL7'
+    end
+    @@@
+
+    ##
+    #   LOG_MASK(pri)
+    #
+    # HACK copied from macro
+    # Creates a mask for one priority.
+    def self.LOG_MASK(pri)
+      1 << pri
+    end
+
+    ##
+    #   LOG_UPTO(pri)
+    # HACK copied from macro
+    # Creates a mask for all priorities up to pri.
+    def self.LOG_UPTO(pri)
+      (1 << ((pri)+1)) - 1
+    end
+  end
+
+  include Constants
+
+  module Foreign
+    extend FFI::Library
+
+    # methods
+    attach_function :open,     "openlog",    [:pointer, :int, :int], :void
+    attach_function :close,    "closelog",   [], :void
+    attach_function :write,    "syslog",     [:int, :string, :string], :void
+    attach_function :set_mask, "setlogmask", [:int], :int
+  end
+
+  # Not open by default.
+  #
+  # Yes, a normal ivar, on Syslog, the module.
+  @open = false
+
+  ##
+  # returns the ident of the last open call
+  def self.ident
+    @open ? @ident : nil
+  end
+
+  ##
+  # returns the options of the last open call
+  def self.options
+    @open ? @options : nil
+  end
+
+  ##
+  # returns the facility of the last open call
+  def self.facility
+    @open ? @facility : nil
+  end
+
+  ##
+  # mask
+  #   mask=(mask)
+  #
+  # Returns or sets the log priority mask.  The value of the mask
+  # is persistent and will not be reset by Syslog::open or
+  # Syslog::close.
+  #
+  # Example:
+  #   Syslog.mask = Syslog::LOG_UPTO(Syslog::LOG_ERR)
+  def self.mask=(mask)
+    unless @open
+      raise RuntimeError, "must open syslog before setting log mask"
+    end
+
+    @mask_before_reopen = nil
+
+    @mask = Rubinius::Type.coerce_to mask, Fixnum, :to_int
+
+    Foreign.set_mask(@mask)
+  end
+
+  def self.mask
+    @open ? @mask : nil
+  end
+
+  ##
+  #   open(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS, facility = Syslog::LOG_USER) [{ |syslog| ... }]
+  #
+  # Opens syslog with the given options and returns the module
+  # itself.  If a block is given, calls it with an argument of
+  # itself.  If syslog is already opened, raises RuntimeError.
+  #
+  # Examples:
+  #   Syslog.open('ftpd', Syslog::LOG_PID | Syslog::LOG_NDELAY, Syslog::LOG_FTP)
+  #   open!(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS, facility = Syslog::LOG_USER)
+  #   reopen(ident = $0, logopt = Syslog::LOG_PID | Syslog::LOG_CONS, facility = Syslog::LOG_USER)
+  def self.open(ident=nil, opt=nil, fac=nil)
+    raise "Syslog already open" unless not @open
+
+    ident ||= $0
+    opt ||= Constants::LOG_PID | Constants::LOG_CONS
+    fac ||= Constants::LOG_USER
+
+    @ident = ident
+    @options = opt
+    @facility = fac
+
+    # syslog rereads the string everytime syslog() is called, so we have to use
+    # an FFI pointer to keep the memory the string is in alive
+    @ident_pointer = FFI::MemoryPointer.new(@ident.size + 1)
+    @ident_pointer.write_string(@ident)
+
+    Foreign.open(@ident_pointer, opt, fac)
+
+    @open = true
+
+    # Calling set_mask twice is the standard way to set the 'default' mask
+    self.mask = @mask_before_reopen || Foreign.set_mask(0)
+
+    if block_given?
+      begin
+        yield self
+      ensure
+        close
+      end
+    end
+
+    self
+  end
+
+  def self.reopen(*args, &block)
+    @mask_before_reopen = mask
+    close
+    open(*args, &block)
+  end
+
+  class << self
+    alias_method :open!, :reopen
+  end
+
+  ##
+  # Is it open?
+  def self.opened?
+    @open
+  end
+
+  ##
+  # Close the log
+  # close will raise an error if it is already closed
+  def self.close
+    raise "Syslog not opened" unless @open
+
+    Foreign.close
+    @ident = nil
+    @options = @facility = @mask = nil;
+    @open = false
+  end
+
+  ##
+  #   log(Syslog::LOG_CRIT, "The %s is falling!", "sky")
+  #
+  # Doesn't take any platform specific printf statements
+  #   logs things to $stderr
+  #   log(Syslog::LOG_CRIT, "Welcome, %s, to my %s!", "leethaxxor", "lavratory")
+  def self.log(pri, format, *args)
+    raise "Syslog must be opened before write" unless @open
+
+    pri = Rubinius::Type.coerce_to(pri, Fixnum, :to_i)
+
+    message = StringValue(format) % args
+    Foreign.write(pri, "%s", message)
+  end
+
+  ##
+  # handy little shortcut for LOG_EMERG as the priority
+  def self.emerg(*args);
+    log(LOG_EMERG, *args)
+  end
+
+  ##
+  # handy little shortcut for LOG_ALERT as the priority
+  def self.alert(*args)
+    log(LOG_ALERT, *args)
+  end
+
+  ##
+  # handy little shortcut for LOG_ERR as the priority
+  def self.err(*args)
+    log(LOG_ERR, *args)
+  end
+
+  ##
+  # handy little shortcut for LOG_CRIT as the priority
+  def self.crit(*args)
+    log(LOG_CRIT, *args)
+  end
+
+  ##
+  # handy little shortcut for LOG_WARNING as the priority
+  def self.warning(*args)
+    log(LOG_WARNING, *args)
+  end
+
+  ##
+  # handy little shortcut for LOG_NOTICE as the priority
+  def self.notice(*args)
+    log(LOG_NOTICE, *args)
+  end
+
+  ##
+  # handy little shortcut for LOG_INFO as the priority
+  def self.info(*args)
+    log(LOG_INFO, *args)
+  end
+
+  ##
+  # handy little shortcut for LOG_DEBUG as the priority
+  def self.debug(*args)
+    log(LOG_DEBUG, *args)
+  end
+
+  def self.LOG_MASK(pri)
+    Constants.LOG_MASK(pri)
+  end
+
+  ##
+  #   LOG_UPTO(pri)
+  # HACK copied from macro
+  # Creates a mask for all priorities up to pri.
+  def self.LOG_UPTO(pri)
+    Constants.LOG_UPTO(pri)
+  end
+
+  def self.inspect
+    if @open
+      "#<%s: opened=true, ident=\"%s\", options=%d, facility=%d, mask=%d>" %
+      [self.name, @ident, @options, @facility, @mask]
+    else
+      "#<#{self.name}: opened=false>"
+    end
+  end
+
+  ##
+  #   Syslog.instance # => Syslog
+  # Returns the Syslog module
+  def self.instance
+    self
+  end
+end
+

data/lib/rubysl/syslog/version.rb

@@ -0,0 +1,5 @@
+module RubySL
+  module Syslog
+    VERSION = "1.0.0"
+  end
+end

data/lib/syslog.rb

@@ -0,0 +1 @@
+require "rubysl/syslog"

data/rubysl-syslog.gemspec

@@ -0,0 +1,28 @@
+# coding: utf-8
+require './lib/rubysl/syslog/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "rubysl-syslog"
+  spec.version       = RubySL::Syslog::VERSION
+  spec.authors       = ["Brian Shirai"]
+  spec.email         = ["brixen@gmail.com"]
+  spec.description   = %q{Ruby standard library syslog.}
+  spec.summary       = %q{Ruby standard library syslog.}
+  spec.homepage      = "https://github.com/rubysl/rubysl-syslog"
+  spec.license       = "BSD"
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.extensions    = ["lib/rubysl/syslog/extconf.rb"]
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = "~> 1.8.7"
+
+  spec.add_runtime_dependency "ffi2-generators", "~> 0.1"
+
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "mspec", "~> 1.5"
+  spec.add_development_dependency "rubysl-prettyprint", "~> 1.0"
+end