systemd-journal 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: cb7ad77b556c438d61a805803ce3ea525aae200f
-  data.tar.gz: 135d9669a414f246f1b75e060ba8b6d719bdea2f
+  metadata.gz: 6f9a1f4583f555e4c8832ce277fc87d02eeabb2f
+  data.tar.gz: a4bc24e388cf2211574a5f138df8d05dc7f97505
 SHA512:
-  metadata.gz: 063fc619fbc6436e72381812dcb0c3905a3b17d260e8d0223df0dec95b51a8219cbf6ee1c02a3eff3f0f548e474ca8df77ed2f6a97adfe12de90c87018b0a5dd
-  data.tar.gz: 1175078fb9650d9bf12c5bbbd612b87ddb5b5bf5c44974d49fdc4a9344ee1e1f4934a92f35b1f9c8c5a4fbfe5b2d4408b9a1f17a58bff2ebf0ce0bff30c051d4
+  metadata.gz: 25274b48c5eba590dd4904f10142932fc4c6458170a49f93453c4d7e0cbb9822c6d045e2d9536f0d79244528081d2725fe99ab1aafacb3ebb4ae891a2076e05c
+  data.tar.gz: 2f863c1a90d35b999115eedd3b160b5d36db4cc273f80fdad5a91fca74dcc9f8c1189b9e1cd9c47dbc6e69df3b180d02ab15be8718ec46383539ebc1e22c14ce

data/.rubocop.yml

@@ -0,0 +1,8 @@
+SignalException:
+  Enabled: false
+
+RaiseArgs:
+  Enabled: false
+
+SpaceAroundBlockBraces:
+  EnforcedStyle: space_inside_braces

data/Gemfile

@@ -6,3 +6,4 @@ gemspec
 gem 'pry'
 gem 'rake'
 gem 'yard'
+gem 'rubocop'

data/README.md

@@ -2,7 +2,8 @@
 
 Ruby bindings for reading from the systemd journal.
 
-* [documentation](http://rubydoc.info/gems/systemd-journal)
+* [gem documentation](http://rubydoc.info/gems/systemd-journal)
+* [libsystemd-journal documentation](http://www.freedesktop.org/software/systemd/man/sd-journal.html)
 
 ## Installation
 
@@ -14,6 +15,11 @@ And then execute:
 
     bundle install
 
+Obviously you will need to have [systemd](http://www.freedesktop.org/wiki/Software/systemd/)
+installed on your system in order to use the gem.  The two native library
+dependencies are `libsystemd-journal` and `libsystemd-id128`.
+
+
 ## Usage
 
     require 'systemd/journal'
@@ -30,17 +36,17 @@ Print all messages as they occur:
 Filter events and iterate:
 
     j = Systemd::Journal.new
-    
+
     # only display entries from SSHD with priority 6.
     j.filter(priority: 6, _exe: '/usr/bin/sshd')
     j.each do |entry|
       puts entry.message
     end
-    
+
 Moving around the journal:
 
     j = Systemd::Journal.new
-    
+
     j.seek(:head)   # move to the start of journal
     j.move(10)      # move forward by 10 entries
     c = j.cursor    # get a reference to this entry
@@ -50,15 +56,20 @@ Moving around the journal:
     j.seek(:tail)   # move to end of the journal
     j.move_previous # move back
     j.move_next     # move forward
-    
+
     j.current_entry # get the entry we're currently positioned at
-    
+
     # seek the entry that occured closest to this time
     j.seek(Time.parse("2013-10-31T12:00:00+04:00:00"))
 
-     
+
 See the documentation for more examples.
 
+## Issues?
+
+If you run into problems or have questions, please open an
+[Issue](https://github.com/ledbettj/systemd-journal/issues).
+
 ## Contributing
 
 1. Fork it

data/Rakefile

@@ -1,12 +1,18 @@
 require "bundler/gem_tasks"
 require "yard"
 require "rspec/core/rake_task"
+require "rubocop/rake_task"
 
 desc "open a console with systemd/journal required"
 task :console do
   exec 'pry -I./lib -r systemd/journal'
 end
 
+Rubocop::RakeTask.new(:rubocop) do |task|
+  task.patterns = ['lib/**/*.rb']
+  task.fail_on_error = false
+end
+
 YARD::Rake::YardocTask.new do |t|
   t.files = ['lib/**/*.rb']
   t.options = ['--no-private', '--markup=markdown']

data/examples/ssh_watcher.rb

@@ -8,10 +8,8 @@ class SSHWatcher
   end
 
   def run
-    @journal.add_match(:_exe, '/usr/bin/sshd')
-    # skip all existing entries -- sd_journal_seek_tail() is currently broken.
-    while @journal.move_next ; end
-
+    @journal.filter(_exe: '/usr/bin/sshd')
+    @journal.seek(:tail)
     @journal.watch{ |entry| process_event(entry) }
   end
 

data/lib/systemd/ffi_size_t.rb

@@ -2,18 +2,14 @@ require 'ffi'
 
 # @private
 class FFI::MemoryPointer
+  # monkey patch a read_size_t and write_size_t method onto FFI::MemoryPointer
+  p = FFI::MemoryPointer.new(:size_t, 1)
+  w = case p.size
+      when 4 then :uint32
+      when 8 then :uint64
+      else raise RuntimeError.new("unsupported size_t width: #{p.size}")
+      end
 
-  # monkey patch a read_size_t and write_size_t method onto
-  # FFI::MemoryPointer if necessary.
-  case (p = FFI::MemoryPointer.new(:size_t, 1)).size
-  when 4
-    alias_method(:read_size_t,  :read_uint32)  unless p.respond_to?(:read_size_t)
-    alias_method(:write_size_t, :write_uint32) unless p.respond_to?(:write_size_t)
-  when 8
-    alias_method(:read_size_t,  :read_uint64)  unless p.respond_to?(:read_size_t)
-    alias_method(:write_size_t, :write_uint64) unless p.respond_to?(:write_size_t)
-  else
-    raise RuntimeError.new("unsupported size_t width: #{p.size}")
-  end
-  
+  alias_method :read_size_t,  :"read_#{w}"  unless p.respond_to?(:read_size_t)
+  alias_method :write_size_t, :"write_#{w}" unless p.respond_to?(:write_size_t)
 end

data/lib/systemd/id128.rb

@@ -1,8 +1,9 @@
 require 'ffi'
 
 module Systemd
+  # Provides access to the 128-bit IDs for various items in the systemd
+  # ecosystem, such as the machine id and boot id.
   module Id128
-
     # Get the 128-bit hex string identifying the current machine.
     # Can be used to filter a journal to show only messages originating
     # from this machine.
@@ -11,12 +12,7 @@ module Systemd
     #   j.add_match('_MACHINE_ID', Systemd::Id128.machine_id)
     # @return [String] 128-bit hex string representing the current machine.
     def self.machine_id
-      @machine_id ||= begin
-                        ptr = FFI::MemoryPointer.new(Native::Id128, 1)
-                        rc = Native.sd_id128_get_machine(ptr)
-                        raise JournalError.new(rc) if rc < 0
-                        Native::Id128.new(ptr).to_s
-                      end
+      @machine_id ||= read_id128(:sd_id128_get_machine)
     end
 
     # Get the 128-bit hex string identifying the current system's current boot.
@@ -27,19 +23,20 @@ module Systemd
     #   j.add_match('_BOOT_ID', Systemd::Id128.boot_id)
     # @return [String] 128-bit hex string representing the current boot.
     def self.boot_id
-      @boot_id ||= begin
-                     ptr = FFI::MemoryPointer.new(Native::Id128, 1)
-                     rc = Native.sd_id128_get_boot(ptr)
-                     raise JournalError.new(rc) if rc < 0
-                     Native::Id128.new(ptr).to_s
-                   end
+      @boot_id ||= read_id128(:sd_id128_get_boot)
     end
 
     # Get a random 128-bit hex string.
     # @return [String] 128-bit random hex string.
     def self.random
+      read_id128(:sd_id128_randomize)
+    end
+
+    private
+
+    def self.read_id128(func)
       ptr = FFI::MemoryPointer.new(Native::Id128, 1)
-      rc = Native.sd_id128_randomize(ptr)
+      rc = Native.send(func, ptr)
       raise JournalError.new(rc) if rc < 0
       Native::Id128.new(ptr).to_s
     end
@@ -56,13 +53,14 @@ module Systemd
         attach_function :sd_id128_randomize,   [:pointer], :int
       end
 
+      # @private
       class Id128 < FFI::Union
         layout :bytes,  [:uint8, 16],
                :dwords, [:uint32, 4],
                :qwords, [:uint64, 2]
 
         def to_s
-          ("%02x" * 16) % self[:bytes].to_a
+          ('%02x' * 16) % self[:bytes].to_a
         end
       end
     end

data/lib/systemd/journal.rb

@@ -38,9 +38,9 @@ module Systemd
       ptr   = FFI::MemoryPointer.new(:pointer, 1)
 
       rc = if path
-             Native::sd_journal_open_directory(ptr, path, 0)
+             Native.sd_journal_open_directory(ptr, path, 0)
            else
-             Native::sd_journal_open(ptr, flags)
+             Native.sd_journal_open(ptr, flags)
            end
 
       raise JournalError.new(rc) if rc < 0
@@ -101,9 +101,8 @@ module Systemd
     # @return [Boolean] False if unable to move to the next entry, indicating
     #   that the pointer has reached the end of the journal.
     def move_next
-      if (rc = Native::sd_journal_next(@ptr)) < 0
-        raise JournalError.new(rc) if rc < 0
-      end
+      rc = Native.sd_journal_next(@ptr)
+      raise JournalError.new(rc) if rc < 0
       rc > 0
     end
 
@@ -112,7 +111,7 @@ module Systemd
     #   moved. If this number is less than the requested amount, the read
     #   pointer has reached the end of the journal.
     def move_next_skip(amount)
-      rc = Native::sd_journal_next_skip(@ptr, amount)
+      rc = Native.sd_journal_next_skip(@ptr, amount)
       raise JournalError.new(rc) if rc < 0
       rc
     end
@@ -122,9 +121,8 @@ module Systemd
     # @return [Boolean] False if unable to move to the previous entry,
     #   indicating that the pointer has reached the beginning of the journal.
     def move_previous
-      if (rc = Native::sd_journal_previous(@ptr)) < 0
-        raise JournalError.new(rc) if rc < 0
-      end
+      rc = Native.sd_journal_previous(@ptr)
+      raise JournalError.new(rc) if rc < 0
       rc > 0
     end
 
@@ -133,7 +131,7 @@ module Systemd
     #   was moved.  If this number is less than the requested amount, the read
     #   pointer has reached the beginning of the journal.
     def move_previous_skip(amount)
-      rc = Native::sd_journal_previous_skip(@ptr, amount)
+      rc = Native.sd_journal_previous_skip(@ptr, amount)
       raise JournalError.new(rc) if rc < 0
       rc
     end
@@ -152,15 +150,15 @@ module Systemd
     def seek(whence)
       rc = case whence
            when :head, :start
-             Native::sd_journal_seek_head(@ptr)
+             Native.sd_journal_seek_head(@ptr)
            when :tail, :end
-             Native::sd_journal_seek_tail(@ptr)
+             Native.sd_journal_seek_tail(@ptr)
            else
              if whence.is_a?(Time)
                # TODO: is this right? who knows.
-               Native::sd_journal_seek_realtime_usec(@ptr, whence.to_i * 1_000_000)
+               Native.sd_journal_seek_realtime_usec(@ptr, whence.to_i * 1_000_000)
              elsif whence.is_a?(String)
-               Native::sd_journal_seek_cursor(@ptr, whence)
+               Native.sd_journal_seek_cursor(@ptr, whence)
              else
                raise ArgumentError.new("Unknown seek type: #{whence.class}")
              end
@@ -183,13 +181,13 @@ module Systemd
     def read_field(field)
       len_ptr = FFI::MemoryPointer.new(:size_t, 1)
       out_ptr = FFI::MemoryPointer.new(:pointer, 1)
-
-      rc = Native::sd_journal_get_data(@ptr, field.to_s.upcase, out_ptr, len_ptr)
+      field   = field.to_s.upcase
+      rc = Native.sd_journal_get_data(@ptr, field, out_ptr, len_ptr)
 
       raise JournalError.new(rc) if rc < 0
 
       len = len_ptr.read_size_t
-      out_ptr.read_pointer.read_string_length(len).split('=', 2).last
+      string_from_out_ptr(out_ptr, len).split('=', 2).last
     end
 
     # Read the contents of all fields from the current journal entry.
@@ -205,22 +203,15 @@ module Systemd
     #   j.move_next
     #   j.current_entry{ |field, value| puts "#{field}: #{value}" }
     def current_entry
-      Native::sd_journal_restart_data(@ptr)
-
-      len_ptr = FFI::MemoryPointer.new(:size_t, 1)
-      out_ptr = FFI::MemoryPointer.new(:pointer, 1)
+      Native.sd_journal_restart_data(@ptr)
       results = {}
 
-      while (rc = Native::sd_journal_enumerate_data(@ptr, out_ptr, len_ptr)) > 0
-        len = len_ptr.read_size_t
-        key, value = out_ptr.read_pointer.read_string_length(len).split('=', 2)
+      while (kvpair = enumerate_helper(:sd_journal_enumerate_data))
+        key, value = kvpair
         results[key] = value
-
         yield(key, value) if block_given?
       end
 
-      raise JournalError.new(rc) if rc < 0
-
       JournalEntry.new(results)
     end
 
@@ -237,24 +228,16 @@ module Systemd
     #   end
     def query_unique(field)
       results = []
-      out_ptr = FFI::MemoryPointer.new(:pointer, 1)
-      len_ptr = FFI::MemoryPointer.new(:size_t,  1)
 
-      Native::sd_journal_restart_unique(@ptr)
-
-      if (rc = Native::sd_journal_query_unique(@ptr, field.to_s.upcase)) < 0
-        raise JournalError.new(rc)
-      end
+      Native.sd_journal_restart_unique(@ptr)
 
-      while (rc = Native::sd_journal_enumerate_unique(@ptr, out_ptr, len_ptr)) > 0
-        len = len_ptr.read_size_t
-        results << out_ptr.read_pointer.read_string_length(len).split('=', 2).last
+      rc = Native.sd_journal_query_unique(@ptr, field.to_s.upcase)
+      raise JournalError.new(rc) if rc < 0
 
-        yield results.last if block_given?
+      while (kvpair = enumerate_helper(:sd_journal_enumerate_unique))
+        results << kvpair.last
       end
 
-      raise JournalError.new(rc) if rc < 0
-
       results
     end
 
@@ -271,7 +254,7 @@ module Systemd
     # @return [Symbol] :append if new entries were appened to the journal.
     # @return [Symbol] :invalidate if journal files were added/removed/rotated.
     def wait(timeout_usec = -1)
-      rc = Native::sd_journal_wait(@ptr, timeout_usec)
+      rc = Native.sd_journal_wait(@ptr, timeout_usec)
       raise JournalError.new(rc) if rc.is_a?(Fixnum) && rc < 0
       rc == :nop ? nil : rc
     end
@@ -287,7 +270,7 @@ module Systemd
     #     puts event.message
     #   end
     def watch
-      while true
+      loop do
         if wait
           yield current_entry while move_next
         end
@@ -303,7 +286,7 @@ module Systemd
     # @return [nil]
     def add_filter(field, value)
       match = "#{field.to_s.upcase}=#{value}"
-      rc = Native::sd_journal_add_match(@ptr, match, match.length)
+      rc = Native.sd_journal_add_match(@ptr, match, match.length)
       raise JournalError.new(rc) if rc < 0
     end
 
@@ -336,7 +319,7 @@ module Systemd
     #     # has priority 5
     #   end
     def add_disjunction
-      rc = Native::sd_journal_add_disjunction(@ptr)
+      rc = Native.sd_journal_add_disjunction(@ptr)
       raise JournalError.new(rc) if rc < 0
     end
 
@@ -354,14 +337,14 @@ module Systemd
     #     # current_entry is an sshd event with priority 5
     #   end
     def add_conjunction
-      rc = Native::sd_journal_add_conjunction(@ptr)
+      rc = Native.sd_journal_add_conjunction(@ptr)
       raise JournalError.new(rc) if rc < 0
     end
 
     # Remove all filters and conjunctions/disjunctions.
     # @return [nil]
     def clear_filters
-      Native::sd_journal_flush_matches(@ptr)
+      Native.sd_journal_flush_matches(@ptr)
     end
 
     # Get the number of bytes the Journal is currently using on disk.
@@ -371,7 +354,7 @@ module Systemd
     # @return [Integer] size in bytes
     def disk_usage
       size_ptr = FFI::MemoryPointer.new(:uint64)
-      rc = Native::sd_journal_get_usage(@ptr, size_ptr)
+      rc = Native.sd_journal_get_usage(@ptr, size_ptr)
 
       raise JournalError.new(rc) if rc < 0
       size_ptr.read_uint64
@@ -382,7 +365,7 @@ module Systemd
     # @return [Integer] size in bytes.
     def data_threshold
       size_ptr = FFI::MemoryPointer.new(:size_t, 1)
-      if (rc = Native::sd_journal_get_data_threshold(@ptr, size_ptr)) < 0
+      if (rc = Native.sd_journal_get_data_threshold(@ptr, size_ptr)) < 0
         raise JournalError.new(rc)
       end
 
@@ -392,7 +375,7 @@ module Systemd
     # Set the maximum length of a data field that will be returned.
     # Fields longer than this will be truncated.
     def data_threshold=(threshold)
-      if (rc = Native::sd_journal_set_data_threshold(@ptr, threshold)) < 0
+      if (rc = Native.sd_journal_set_data_threshold(@ptr, threshold)) < 0
         raise JournalError.new(rc)
       end
     end
@@ -425,17 +408,32 @@ module Systemd
     private
 
     def self.finalize(ptr)
-      proc{ Native::sd_journal_close(ptr) unless ptr.nil? }
+      proc{ Native.sd_journal_close(ptr) unless ptr.nil? }
+    end
+
+    def enumerate_helper(enum_function)
+      len_ptr = FFI::MemoryPointer.new(:size_t, 1)
+      out_ptr = FFI::MemoryPointer.new(:pointer, 1)
+
+      rc = Native.send(enum_function, @ptr, out_ptr, len_ptr)
+      raise JournalError.new(rc) if rc < 0
+      return nil if rc == 0
+
+      len = len_ptr.read_size_t
+      string_from_out_ptr(out_ptr, len).split('=', 2)
+    end
+
+    def string_from_out_ptr(p, len)
+      p.read_pointer.read_string_length(len)
     end
 
     # some sd_journal_* functions return strings that we're expected to free
-    # ourselves.  This function copies the string from a char* to a ruby string,
+    # ourselves. This function copies the string from a char* to a ruby string,
     # frees the char*, and returns the ruby string.
     def read_and_free_outstr(ptr)
       str = ptr.read_string
       LibC.free(ptr)
       str
     end
-
   end
 end

data/lib/systemd/journal/compat.rb

@@ -6,7 +6,6 @@ module Systemd
     # This module provides compatibility with the systemd-journal.gem
     # by Daniel Mack (https://github.com/zonque/systemd-journal.gem)
     module Compat
-
        # system is unusable
       LOG_EMERG   = 0
       # action must be taken immediately
@@ -32,12 +31,11 @@ module Systemd
       # methods in this module will be available as class methods on
       #  {Systemd::Journal}
       module ClassMethods
-
         # write the value of the c errno constant to the systemd journal in the
         # style of the perror() function.
         # @param [String] message the text to prefix the error message with.
         def perror(message)
-          rc = Native::sd_journal_perror(message)
+          rc = Native.sd_journal_perror(message)
           raise JournalError.new(rc) if rc < 0
         end
 
@@ -46,23 +44,22 @@ module Systemd
         #   severity of the event.
         # @param [String] message the content of the message to write.
         def print(level, message)
-          rc = Native::sd_journal_print(level, message)
+          rc = Native.sd_journal_print(level, message)
           raise JournalError.new(rc) if rc < 0
         end
 
         # write an event to the systemd journal.
         # @param [Hash] contents the set of key-value pairs defining the event.
         def message(contents)
-          items = contents.flat_map do |k,v|
+          items = contents.flat_map do |k, v|
             [:string, "#{k.to_s.upcase}=#{v}"]
           end
           # add a null pointer to terminate the varargs
           items += [:string, nil]
-          rc = Native::sd_journal_send(*items)
+          rc = Native.sd_journal_send(*items)
           raise JournalError.new(rc) if rc < 0
         end
       end
-
     end
   end
 end

data/lib/systemd/journal/fields.rb

@@ -12,7 +12,7 @@ module Systemd
                          _MACHINE_ID _HOSTNAME _TRANSPORT }
 
     # Fields used in messages originating from the kernel.
-    KERNEL_FIELDS = %w{ _KERNEL_DEVICE _KERNEL_SUBSYSTEM _UDEV_SYSNAME _UDEV_DEVNODE _UDEV_DEVLINK }
-
+    KERNEL_FIELDS = %w{ _KERNEL_DEVICE _KERNEL_SUBSYSTEM _UDEV_SYSNAME
+                        _UDEV_DEVNODE _UDEV_DEVLINK }
   end
 end

data/lib/systemd/journal/native.rb

@@ -1,8 +1,9 @@
 module Systemd
   class Journal
     # Provides the FFI bindings to the native `libsystemd-journal` shared
-    #   library.
+    #  library.
     module Native
+      # rubocop:disable LineLength
       require 'ffi'
       extend FFI::Library
       ffi_lib %w[libsystemd-journal.so libsystemd-journal.so.0]
@@ -60,9 +61,9 @@ module Systemd
       # misc
       attach_function :sd_journal_get_usage, [:pointer, :pointer], :int
     end
-
   end unless $NO_FFI_SPEC
 
+  # @private
   module LibC
     require 'ffi'
     extend FFI::Library
@@ -70,5 +71,4 @@ module Systemd
 
     attach_function :free, [:pointer], :void
   end
-
 end

data/lib/systemd/journal/version.rb

@@ -1,6 +1,6 @@
 module Systemd
   class Journal
     # The version of the systemd-journal gem.
-    VERSION = '1.0.1'
+    VERSION = '1.0.2'
   end
 end

data/lib/systemd/journal_entry.rb

@@ -1,9 +1,15 @@
 module Systemd
+  # Represents a single entry in the Journal.
   class JournalEntry
     include Enumerable
 
     attr_reader :fields
 
+    # Create a new JournalEntry from the given entry hash. You probably don't
+    # need to construct this yourself; instead instances are returned from
+    # {Systemd::Journal} methods such as {Systemd::Journal#current_entry}.
+    # @param [Hash] entry a hash containing all the key-value pairs associated
+    #   with a given journal entry.
     def initialize(entry)
       @entry  = entry
       @fields = entry.map do |key, value|
@@ -14,15 +20,14 @@ module Systemd
 
     end
 
+    # Get the value of a given field in the entry, or nil if it doesn't exist
     def [](key)
       @entry[key] || @entry[key.to_s.upcase]
     end
 
     def each
       return to_enum(:each) unless block_given?
-
       @entry.each{ |key, value| yield [key, value] }
     end
-
   end
 end

data/lib/systemd/journal_error.rb

@@ -3,8 +3,7 @@ require 'ffi'
 module Systemd
   # This execption is raised whenever a sd_journal_* call returns an error.
   class JournalError < StandardError
-
-    # Returns the (negated) error number.
+    # Returns the (positive) error number.
     attr_reader :code
 
     # Instantiate a new JournalError based on the specified return code.
@@ -12,7 +11,7 @@ module Systemd
     # return code.
     def initialize(code)
       @code = -code
-      super(LIBC::strerror(@code))
+      super(LIBC.strerror(@code))
     end
 
     private
@@ -25,6 +24,5 @@ module Systemd
 
       attach_function :strerror, [:int], :string
     end
-
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: systemd-journal
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - John Ledbetter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-11-15 00:00:00.000000000 Z
+date: 2013-12-04 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -62,6 +62,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rubocop.yml
 - Gemfile
 - LICENSE.txt
 - README.md