journald-native 1.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 434d6c7409f38d0c734102b165c7422774b4b765
+  data.tar.gz: dbb1a39c162a253430a5ddf497a7b6ecc8c71ee5
+SHA512:
+  metadata.gz: 53b67e58815b34992d37b8a39339372e2d27393bbefe533d37375aac7fd4ef9386fd35fecece27ee7c9b201f56488d12fed26d22d24a1b17bb00e72fdad67473
+  data.tar.gz: ec9ac27fa92aeb99b0258780342ebdbf34805f90db345990f5e650db5bf9a4ffd8e738f8a64612b7612a03bd4f540ab8091a4a74e8635b234f5caec24d503f68

data/.gitignore

@@ -0,0 +1,27 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log
+Makefile
+*.iml
+*.ipr
+*.iws
+.rakeTasks

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Anton Smirnov
+
+MIT License
+
+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.

data/README.md

@@ -0,0 +1,50 @@
+# journald-native
+
+A systemd-journal native logging lib wrapper.
+[See sd-journal help for more info](http://www.freedesktop.org/software/systemd/man/sd_journal_print.html)
+
+## Usage
+
+```ruby
+    require 'journald/native'
+```
+
+### Constants
+
+Constants are used to denote a log level
+
+Available constants:
+
+```ruby
+    Journald::LOG_EMERG     # system is unusable
+    Journald::LOG_ALERT     # action must be taken immediately
+    Journald::LOG_CRIT      # critical conditions
+    Journald::LOG_ERR       # error conditions
+    Journald::LOG_WARNING   # warning conditions
+    Journald::LOG_NOTICE    # normal but significant condition
+    Journald::LOG_INFO      # informational
+    Journald::LOG_DEBUG     # debug-level messages
+```
+
+systemd-journal uses syslog constants to denote level therefore they are equal to those of the Syslog module,
+e.g. ```Journald::LOG_WARNING == Syslog::LOG_WARNING```. 
+[See syslog man page for more info](http://man7.org/linux/man-pages/man3/syslog.3.html)
+
+### Methods
+
+Methods of Journald::Native class wrap systemd-journal calls. 
+[See sd-journal help for more info](http://www.freedesktop.org/software/systemd/man/sd_journal_print.html) 
+
+```ruby
+    Journald::Native.send "MESSAGE=message", "PRIORITY=#{Journald::LOG_WARNING}"
+    Journald::Native.print Journald::LOG_WARNING, "message"
+    Journald::Native.perror "message"
+```
+
+It is not recommended to use ```print``` and ```perror``` as you may lose ```'\0'``` byte in your string due to
+C zero-terminated string format (all zero bytes in the middle will be removed) On the contrary ```send``` uses
+binary buffers and does not have such shortcoming.
+
+### License
+
+Licensed under the MIT License. See ```LICENSE.txt``` for more info

data/Rakefile

@@ -0,0 +1,9 @@
+require 'bundler/gem_tasks'
+require 'rake/extensiontask'
+
+spec = Gem::Specification.load('journald-native.gemspec')
+Rake::ExtensionTask.new('journald_native', spec)
+
+task :build => :compile do
+  # just add prerequisite
+end

data/ext/journald_native/extconf.rb

@@ -0,0 +1,20 @@
+require 'mkmf'
+
+LIBDIR      = RbConfig::CONFIG['libdir']
+INCLUDEDIR  = RbConfig::CONFIG['includedir']
+
+HEADER_DIRS = [INCLUDEDIR]
+
+LIB_DIRS = [LIBDIR]
+
+dir_config('systemd', HEADER_DIRS, LIB_DIRS)
+
+# check headers
+abort 'systemd/sd-journal.h is missing. please install systemd-journal' unless find_header('systemd/sd-journal.h')
+
+# check functions
+%w(sd_journal_print sd_journal_sendv sd_journal_perror).each do |func|
+   abort "#{func}() is missing. systemd-journal is not usable" unless find_library('systemd-journal', func)
+end
+
+create_makefile('journald_native')

data/ext/journald_native/journald_native.c

@@ -0,0 +1,139 @@
+/* Do not add C line and file to the log messages */
+#define SD_JOURNAL_SUPPRESS_LOCATION
+
+#include <ruby.h>
+#include <systemd/sd-journal.h>
+
+void Init_journald_native();
+
+/* initializers */
+static void jdl_init_modules();
+static void jdl_init_constants();
+static void jdl_init_methods();
+
+/* methods */
+static VALUE jdl_native_print(VALUE self, VALUE priority, VALUE message);
+static VALUE jdl_native_send(int argc, VALUE* argv, VALUE self);
+static VALUE jdl_native_perror(VALUE self, VALUE message);
+
+/* aux */
+static char * jdl_alloc_safe_string(VALUE string);
+
+/* globals */
+static VALUE mJournald;
+static VALUE mNative;
+
+void Init_journald_native()
+{
+    jdl_init_modules();
+    jdl_init_constants();
+    jdl_init_methods();
+}
+
+static void jdl_init_modules()
+{
+    mJournald = rb_define_module("Journald");
+    mNative   = rb_define_module_under(mJournald, "Native");
+}
+
+static void jdl_init_constants()
+{
+    rb_define_const(mJournald, "LOG_EMERG",   INT2NUM(LOG_EMERG));    /* system is unusable */
+    rb_define_const(mJournald, "LOG_ALERT",   INT2NUM(LOG_ALERT));    /* action must be taken immediately */
+    rb_define_const(mJournald, "LOG_CRIT",    INT2NUM(LOG_CRIT));     /* critical conditions */
+    rb_define_const(mJournald, "LOG_ERR",     INT2NUM(LOG_ERR));      /* error conditions */
+    rb_define_const(mJournald, "LOG_WARNING", INT2NUM(LOG_WARNING));  /* warning conditions */
+    rb_define_const(mJournald, "LOG_NOTICE",  INT2NUM(LOG_NOTICE));   /* normal but significant condition */
+    rb_define_const(mJournald, "LOG_INFO",    INT2NUM(LOG_INFO));     /* informational */
+    rb_define_const(mJournald, "LOG_DEBUG",   INT2NUM(LOG_DEBUG));    /* debug-level messages */
+}
+
+static void jdl_init_methods()
+{
+    rb_define_singleton_method(mNative, "print",  jdl_native_print,  2);
+    rb_define_singleton_method(mNative, "send",   jdl_native_send,  -1); // -1 to pass as C array
+    rb_define_singleton_method(mNative, "perror", jdl_native_perror, 1);
+}
+
+static VALUE jdl_native_print(VALUE v_self, VALUE v_priority, VALUE v_message)
+{
+    int priority, result;
+    char *message;
+
+    priority = NUM2INT(v_priority);
+    message  = jdl_alloc_safe_string(v_message);
+
+    result = sd_journal_print(priority, "%s", message);
+
+    free(message);
+
+    return INT2NUM(result);
+}
+
+static VALUE jdl_native_send(int argc, VALUE* argv, VALUE self)
+{
+    //const char * fmt = "%s";
+    struct iovec *msgs;
+    size_t i;
+    int result;
+
+    msgs = calloc(argc, sizeof(struct iovec));
+
+    for (i = 0; i < argc; i++) {
+        VALUE v = argv[i];
+        StringValue(v);
+        msgs[i].iov_base = RSTRING_PTR(v);
+        msgs[i].iov_len  = RSTRING_LEN(v);
+    }
+
+    result = sd_journal_sendv(msgs, argc);
+
+    free(msgs);
+
+    return INT2NUM(result);
+}
+
+static VALUE jdl_native_perror(VALUE v_self, VALUE v_message)
+{
+    int result;
+    char *message;
+
+    message = jdl_alloc_safe_string(v_message);
+
+    result = sd_journal_perror(message);
+
+    free(message);
+
+    return INT2NUM(result);
+}
+
+/**
+ * Remove zeros from string and ensure it's zero-terminated
+ */
+static char * jdl_alloc_safe_string(VALUE v_string)
+{
+    char  *str;
+    size_t len;
+
+    char  *newstr,
+          *ptr;
+    size_t i;
+
+    /* convert tos sring */
+    StringValue(v_string);
+
+    str = RSTRING_PTR(v_string);
+    len = RSTRING_LEN(v_string);
+
+    newstr = calloc(len + 1, sizeof(char));
+
+    for (i = 0, ptr = newstr; i < len; i++) {
+        if (str[i]) {
+            *(ptr++) = str[i];
+        }
+    }
+
+    *ptr = '\0';
+
+    return newstr;
+}

data/journald-native.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'journald/native/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'journald-native'
+  spec.version       = Journald::Native::VERSION
+  spec.authors       = ['Anton Smirnov']
+  spec.email         = ['sandfox@sandfox.im']
+  spec.summary       = %q{systemd-journal logging native lib wrapper}
+  # spec.description   = %q{Write a longer description. Optional.}
+  spec.homepage      = 'https://github.com/sandfox-im/journald-native'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.extensions << 'ext/journald_native/extconf.rb'
+
+  spec.required_ruby_version = '>= 1.9.2'
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rake-compiler'
+end

data/lib/journald/native.rb

@@ -0,0 +1,7 @@
+require 'journald/native/version'
+require_relative '../journald_native'
+
+module Journald
+  module Native
+  end
+end

data/lib/journald/native/version.rb

@@ -0,0 +1,5 @@
+module Journald
+  module Native
+    VERSION = '1.0.1'
+  end
+end

metadata

@@ -0,0 +1,98 @@
+--- !ruby/object:Gem::Specification
+name: journald-native
+version: !ruby/object:Gem::Version
+  version: 1.0.1
+platform: ruby
+authors:
+- Anton Smirnov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-10-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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'
+- !ruby/object:Gem::Dependency
+  name: rake-compiler
+  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:
+- sandfox@sandfox.im
+executables: []
+extensions:
+- ext/journald_native/extconf.rb
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- ext/journald_native/extconf.rb
+- ext/journald_native/journald_native.c
+- journald-native.gemspec
+- lib/journald/native.rb
+- lib/journald/native/version.rb
+homepage: https://github.com/sandfox-im/journald-native
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: 1.9.2
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.1.11
+signing_key: 
+specification_version: 4
+summary: systemd-journal logging native lib wrapper
+test_files: []
+has_rdoc: