systemd-journal 1.2.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 978a030e0e1fbf45c4d7cf8f597fb746c125d9ed
-  data.tar.gz: b4ead8920befcd90d27351b7552128347e165a6a
+  metadata.gz: 17f43d104aba0ce7b017388964e8dc82a8552ad2
+  data.tar.gz: 22fa6ea7f4c044f1d1e27e81b388dc390ee02066
 SHA512:
-  metadata.gz: 16629bfb3cf7f6d58894eeec4f2e977c6eeed09eca46c09669060b6f25c1cb10237a3f2aa03551b291e974e7ae6ee10e884b11ffc4069680a30a17c76b11f51d
-  data.tar.gz: 45339d61c9c50b4eec0fcf36ac68d9cfe9feeacd8bb07f2d47f5c235b1d2e0f1bd64ce29a6118c6f226e1918d717a8b10285abc69816e56232f5c3227f8801ca
+  metadata.gz: 63fda69b863ca386c990331a565ff787b3b09ca3e14db6bfb3276bc0b291f726a2b0fb89d2d6431ea2147d86cbe548fd01f92cd91af255e5490cbcc30170969b
+  data.tar.gz: 3455916da4baede72a14514ee20702b4451b1391e746a5e0cbc7db087fefda64d8f29533e4b41585273a37e91f98a4e5638232afb1d97803876d36b6db3f69da

data/.travis.yml

@@ -21,3 +21,5 @@ before_script:
   - cd /tmp/systemd/ && make && sudo make install
   - echo "done building in $(pwd), switching back to $PREV_DIR, library path is $LD_LIBRARY_PATH"
   - cd $PREV_DIR
+  - >
+      [ -f /etc/machine-id ] || cat /dev/urandom | tr -cd 'a-f0-9' | head -c 32 | awk '{ print $1 }' | sudo tee /etc/machine-id

data/LICENSE.txt

@@ -19,4 +19,4 @@ 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.
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -9,7 +9,7 @@ Ruby bindings for reading from the systemd journal.
 
 Add this line to your application's Gemfile:
 
-    gem 'systemd-journal', '~> 1.1.0'
+    gem 'systemd-journal', '~> 1.2.0'
 
 And then execute:
 
@@ -22,7 +22,8 @@ thing.
 
 Obviously you will need to have
 [systemd](http://www.freedesktop.org/wiki/Software/systemd/) installed on your
-system in order to use the gem.  Currently we support systemd 208 or higher.
+system (specifically libsystemd or the older libsystemd-journal) in order to
+use the gem.  Currently we support systemd 208 or higher.
 
 ## Usage
 

data/lib/systemd.rb

@@ -0,0 +1,13 @@
+require 'systemd/journal'
+
+module Systemd
+  # See {Systemd::Id128.machine_id}.
+  def self.machine_id
+    Systemd::Id128.machine_id
+  end
+
+  # See {Systemd::Id128.boot_id}.
+  def self.boot_id
+    Systemd::Id128.boot_id
+  end
+end

data/lib/systemd/id128.rb

@@ -9,7 +9,7 @@ module Systemd
     # from this machine.
     # @example Filter journal to the current machine.
     #   j = Systemd::Journal.new
-    #   j.add_match('_MACHINE_ID', Systemd::Id128.machine_id)
+    #   j.filter(_machine_id: Systemd::Id128.machine_id)
     # @return [String] 128-bit hex string representing the current machine.
     def self.machine_id
       @machine_id ||= read_id128(:sd_id128_get_machine)
@@ -20,7 +20,7 @@ module Systemd
     # the current boot.
     # @example Filter journal to the current boot.
     #   j = Systemd::Journal.new
-    #   j.add_match('_BOOT_ID', Systemd::Id128.boot_id)
+    #   j.filter(_boot_id: Systemd::Id128.boot_id)
     # @return [String] 128-bit hex string representing the current boot.
     def self.boot_id
       @boot_id ||= read_id128(:sd_id128_get_boot)
@@ -59,7 +59,7 @@ module Systemd
                :qwords, [:uint64, 2]
 
         def to_s
-          ('%02x' * 16) % self[:bytes].to_a
+          format('%02x' * 16, *self[:bytes].to_a)
         end
 
         def self.from_s(str)

data/lib/systemd/journal.rb

@@ -9,8 +9,8 @@ require 'systemd/journal/waitable'
 require 'systemd/journal_error'
 require 'systemd/journal_entry'
 require 'systemd/id128'
-
 require 'systemd/ffi_size_t'
+require 'systemd'
 
 module Systemd
   # Class to allow interacting with the systemd journal.
@@ -194,17 +194,38 @@ module Systemd
       end
     end
 
+    # @private
+    def inspect
+      format(
+        '#<%s:0x%016x target: "%s", flags: 0x%08x>',
+        self.class.name,
+        object_id,
+        @open_target,
+        @open_flags
+      )
+    end
+
     private
 
     def open_journal(ptr, opts, flags)
+      @open_flags = 0
+
       case
       when opts[:path]
+        @open_target = "path:#{opts[:path]}"
         Native.sd_journal_open_directory(ptr, opts[:path], 0)
       when opts[:files]
-        Native.sd_journal_open_files(ptr, array_to_ptrs(Array(opts[:files])), 0)
+        files = Array(opts[:files])
+        @open_target = "file#{files.one? ? '' : 's'}:#{files.join(',')}"
+        Native.sd_journal_open_files(ptr, array_to_ptrs(files), 0)
       when opts[:container]
+        raise ArgumentError.new('This libsystemd-journal version does not support sd_journal_open_container') unless Native.open_container?
+        @open_flags = flags
+        @open_target = "container:#{opts[:container]}"
         Native.sd_journal_open_container(ptr, opts[:container], flags)
       else
+        @open_flags = flags
+        @open_target = 'journal:local'
         Native.sd_journal_open(ptr, flags)
       end
     end

data/lib/systemd/journal/native.rb

@@ -11,13 +11,25 @@ module Systemd
       ffi_lib %w( libsystemd.so.0         libsystemd.so
                   libsystemd-journal.so.0 libsystemd-journal.so)
 
+      @@has_open_container = true
+
+      def self.open_container?
+        @@has_open_container
+      end
+
       # setup/teardown
       attach_function :sd_journal_open,           [:pointer, :int], :int
       attach_function :sd_journal_open_directory, [:pointer, :string, :int], :int
       attach_function :sd_journal_close,          [:pointer], :void
 
       attach_function :sd_journal_open_files,     [:pointer, :pointer, :int], :int
-      attach_function :sd_journal_open_container, [:pointer, :string, :int], :int
+
+      # not available in 208
+      begin
+        attach_function :sd_journal_open_container, [:pointer, :string, :int], :int
+      rescue FFI::NotFoundError
+        @@has_open_container = false
+      end
 
       # navigation
       attach_function :sd_journal_next,          [:pointer], :int

data/lib/systemd/journal/navigable.rb

@@ -29,9 +29,9 @@ module Systemd
       # Move the read pointer by `offset` entries.
       # @param [Integer] offset how many entries to move the read pointer by.
       #   If this value is positive, the read pointer moves forward. Otherwise,
-      #   it moves backwards.
+      #   it moves backwards.  Defaults to moving forward one entry.
       # @return [Integer] number of entries the read pointer actually moved.
-      def move(offset)
+      def move(offset = 1)
         offset > 0 ? move_next_skip(offset) : move_previous_skip(-offset)
       end
 

data/lib/systemd/journal/version.rb

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

data/lib/systemd/journal/writable.rb

@@ -32,7 +32,6 @@ module Systemd
       # methods in this module will be available as class methods on
       #  {Systemd::Journal}
       module ClassMethods
-
         # Creates a new IO stream which writes newline-seperated messages to
         # the journal.
         # @param identifier [String] this value will be passed as
@@ -44,7 +43,11 @@ module Systemd
         #   priority prefixes
         # @return [IO]
         def log_stream(identifier, priority, opts = {})
-          fd = Native.sd_journal_stream_fd(identifier, priority, !!opts[:prefix])
+          fd = Native.sd_journal_stream_fd(
+            identifier,
+            priority,
+            !opts[:prefix].nil?
+          )
           raise JournalError.new(fd) if fd < 0
 
           IO.new(fd, File::WRONLY, encoding: Encoding::UTF_8)

data/lib/systemd/journal_entry.rb

@@ -11,18 +11,23 @@ module Systemd
     # @param [Hash] entry a hash containing all the key-value pairs associated
     #   with a given journal entry.
     def initialize(entry, context = {})
+      inspect = []
       @entry  = entry
       @ctx    = context
       @fields = entry.map do |key, value|
         name = key.downcase.to_sym
         define_singleton_method(name) { value } unless respond_to?(name)
+
+        inspect.push("#{name}: '#{value}'")
         name
       end
+      @inspect = inspect.join(', ')
     end
 
     # Returns the wall-clock time that this entry was received by the journal.
     # @return [Time]
     def realtime_timestamp
+      return nil unless @ctx.key?(:realtime_ts)
       @realtime_timestamp ||= Time.at(0, @ctx[:realtime_ts])
     end
 
@@ -30,9 +35,11 @@ module Systemd
     # by the journal.  This should be associated with a boot_id.
     # @return [Time]
     def monotonic_timestamp
+      return nil unless @ctx.key?(:monotonic_ts)
       @monotonic_timestamp ||= Time.at(0, @ctx[:monotonic_ts].first)
     end
 
+    # @private
     def method_missing(m, *args)
       # not all journal entries will have all fields.  don't raise an error
       # unless the user passed arguments.
@@ -40,15 +47,27 @@ module Systemd
     end
 
     # Get the value of a given field in the entry, or nil if it doesn't exist
+    # @param [String] the field name for which to look up the value. Can be a
+    #   symbol or string, case insensitive.
+    # @return [String] the value for the given field, or nil if not found.
     def [](key)
       @entry[key] || @entry[key.to_s.upcase]
     end
 
+    # Yields each field name and value pair to the provided block.
+    # If no block is given, returns an enumerator.
+    # @return [Enumerator]
     def each
       return to_enum(:each) unless block_given?
       @entry.each { |key, value| yield [key, value] }
     end
 
+    # Returns the catalog message that this Journal Entry references, if any.
+    # @option opts [Boolean] :replace set to false to not replace placeholder
+    #   strings in the catalog with the associated values in this Journal Entry.
+    #   defaults to true.
+    # @return [String] the catalog provided message for this Journal Entry, or
+    #   nil if non exists.
     def catalog(opts = {})
       return nil unless catalog?
 
@@ -60,12 +79,27 @@ module Systemd
       opts[:replace] ? field_substitute(cat) : cat
     end
 
+    # Returns true if this Journal Entry has an associated catalog message.
+    # @return [Boolean] whether or not this entry has an associated catalog
+    #   message.
     def catalog?
       !self[:message_id].nil?
     end
 
+    # Convert this Entry into a hash.
+    # @return [Hash] the hash representation of this journal entry.
+    def to_h
+      @entry.each_with_object({}) { |(k, v), h| h[k] = v.dup }
+    end
+
+    # @private
+    def inspect
+      format('#<%s:0x%016x %s>', self.class.name, object_id, @inspect)
+    end
+
     private
 
+    # @private
     def field_substitute(msg)
       msg.gsub(/@[A-Z_0-9]+@/) { |field| self[field[1..-2]] || field }
     end

data/spec/systemd/id128_spec.rb

@@ -0,0 +1,45 @@
+require 'spec_helper'
+
+RSpec.describe Systemd::Id128 do
+  subject(:id128){ Systemd::Id128 }
+
+  describe 'machine_id' do
+    it 'should be a 128 bit hexadecimal string' do
+      expect(id128.machine_id).to match(/[0-9a-f]{16}/)
+    end
+
+    it 'should match when called twice' do
+      m1 = id128.machine_id
+      m2 = id128.machine_id
+      expect(m1).to eq(m2)
+    end
+  end
+
+  # travis-ci does not boot with systemd so these cases
+  # will raise exceptions.
+  context 'when booted under systemd' do
+    describe 'boot_id' do
+      it 'should be a 128 bit hexadecimal string' do
+        expect(id128.boot_id).to match(/[0-9a-f]{16}/)
+      end
+
+      it 'should match when called twice' do
+        b1 = id128.boot_id
+        b2 = id128.boot_id
+        expect(b1).to eq(b2)
+      end
+    end
+  end unless ENV['TRAVIS']
+
+  describe 'random' do
+    it 'should be a 128 bit hexadecimal string' do
+      expect(id128.random).to match(/[0-9a-f]{16}/)
+    end
+
+    it 'should return a different value when called again' do
+      r1 = id128.random
+      r2 = id128.random
+      expect(r1).to_not eq(r2)
+    end
+  end
+end

data/spec/systemd/journal_entry_spec.rb

@@ -36,7 +36,16 @@ RSpec.describe Systemd::JournalEntry do
     end
 
     it 'yields each key/value in turn' do
-      expect(entry.map{ |k,v| [k,v] }).to eq([['_PID', pid], ['MESSAGE', msg]])
+      items = entry.map { |k, v| [k, v] }
+      expect(items).to eq([['_PID', pid], ['MESSAGE', msg]])
+    end
+  end
+
+  describe 'to_h' do
+    it 'returns a deep copy of the entry' do
+      copy = subject.to_h
+      expect(copy).to eq(hash)
+      expect { copy['_PID'] << '3' }.to_not change { subject._pid }
     end
   end
 

data/spec/systemd/journal_spec.rb

@@ -16,6 +16,11 @@ RSpec.describe Systemd::Journal do
       expect { j.new(container: '', files: []) }.to raise_error(ArgumentError)
       expect { j.new(container: '', path: '/') }.to raise_error(ArgumentError)
     end
+
+    it 'throws an ArgumentError when attempting to open a container without support' do
+      allow(Systemd::Journal::Native).to receive(:open_container?).and_return(false)
+      expect { j.new(container: 'test') }.to raise_error(ArgumentError)
+    end
   end
 
   describe 'query_unique' do
@@ -46,6 +51,8 @@ RSpec.describe Systemd::Journal do
     it 'returns the disk usage of the example journal file' do
       pending 'blocks? bytes?'
       expect(j.disk_usage).to eq(4_005_888)
+      # force failure to make travis-ci happy
+      expect(true).to be false
     end
   end
 
@@ -326,4 +333,45 @@ RSpec.describe Systemd::Journal do
     end
   end
 
+  describe 'wait' do
+    it 'returns nil if nothing happens' do
+      expect(Systemd::Journal::Native)
+        .to receive(:sd_journal_wait)
+        .and_return(:nop)
+
+      expect(j.wait(1)).to be nil
+    end
+
+    it 'returns :append if new entries are found' do
+      expect(Systemd::Journal::Native)
+        .to receive(:sd_journal_wait)
+        .and_return(:append)
+
+      expect(j.wait(1)).to be :append
+    end
+
+    it 'raise a JournalError on error' do
+      expect(Systemd::Journal::Native)
+        .to receive(:sd_journal_wait)
+        .and_return(-1)
+
+      expect { j.wait(1) }.to raise_error(Systemd::JournalError)
+    end
+
+    it 'can use select' do
+      expect(Systemd::Journal::Native).to_not receive(:sd_journal_wait)
+      j.wait(1, select: true)
+    end
+  end
+
+  describe 'wait_select_reliable?' do
+    it 'should not throw an error' do
+      expect { j.wait_select_reliable? }.to_not raise_error
+    end
+
+    it 'should return a boolean' do
+      expect([true, false]).to include(j.wait_select_reliable?)
+    end
+  end
+
 end

data/spec/systemd_spec.rb

@@ -0,0 +1,18 @@
+require 'spec_helper'
+
+RSpec.describe Systemd do
+  describe 'machine_id' do
+    it 'is an alias for Systemd::Id128.machine_id' do
+      expect(Systemd::Id128).to receive(:machine_id)
+      Systemd.machine_id
+    end
+  end
+
+  describe 'boot_id' do
+    it 'is an alias for Systemd::Id128.boot_id' do
+      expect(Systemd::Id128).to receive(:boot_id)
+      Systemd.boot_id
+    end
+  end
+
+end

data/systemd-journal.gemspec

@@ -4,26 +4,28 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'systemd/journal/version'
 
 Gem::Specification.new do |gem|
-  gem.name          = "systemd-journal"
+  gem.name          = 'systemd-journal'
   gem.version       = Systemd::Journal::VERSION
   gem.license       = 'MIT'
-  gem.authors       = ["John Ledbetter", "Daniel Mack"]
-  gem.email         = ["john@throttle.io"]
+  gem.authors       = ['John Ledbetter', 'Daniel Mack']
+  gem.email         = ['john@throttle.io']
   gem.description   = %q{Provides the ability to navigate and read entries from the systemd journal in ruby, as well as write events to the journal.}
   gem.summary       = %q{Ruby bindings to libsystemd-journal}
-  gem.homepage      = "https://github.com/ledbettj/systemd-journal"
+  gem.homepage      = 'https://github.com/ledbettj/systemd-journal'
 
   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.require_paths = ["lib"]
+  gem.require_paths = ['lib']
 
-  gem.add_dependency 'ffi', '~>1.9.0'
+  gem.required_ruby_version = '>= 1.9.3'
 
-  gem.add_development_dependency 'rspec',     '~> 3.0.0'
-  gem.add_development_dependency 'simplecov', '~> 0.7.1'
-  gem.add_development_dependency 'rubocop',   '~> 0.23.0'
-  gem.add_development_dependency 'rake',      '~> 10.1.0'
-  gem.add_development_dependency 'yard',      '~> 0.8.7.4'
-  gem.add_development_dependency 'pry',       '~> 0.10.0'
+  gem.add_runtime_dependency 'ffi', '~> 1.9.0'
+
+  gem.add_development_dependency 'rspec',     '~> 3.1'
+  gem.add_development_dependency 'simplecov', '~> 0.9'
+  gem.add_development_dependency 'rubocop',   '~> 0.26'
+  gem.add_development_dependency 'rake',      '~> 10.3'
+  gem.add_development_dependency 'yard',      '~> 0.8.7'
+  gem.add_development_dependency 'pry',       '~> 0.10'
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: systemd-journal
 version: !ruby/object:Gem::Version
-  version: 1.2.0
+  version: 1.2.1
 platform: ruby
 authors:
 - John Ledbetter
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-07-03 00:00:00.000000000 Z
+date: 2014-10-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: ffi
@@ -31,84 +31,84 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.0.0
+        version: '3.1'
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.9'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.7.1
+        version: '0.9'
 - !ruby/object:Gem::Dependency
   name: rubocop
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: '0.26'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.23.0
+        version: '0.26'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.3'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 10.1.0
+        version: '10.3'
 - !ruby/object:Gem::Dependency
   name: yard
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
+        version: 0.8.7
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.8.7.4
+        version: 0.8.7
 - !ruby/object:Gem::Dependency
   name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 0.10.0
+        version: '0.10'
 description: Provides the ability to navigate and read entries from the systemd journal
   in ruby, as well as write events to the journal.
 email:
@@ -127,6 +127,7 @@ files:
 - examples/journal_directory.rb
 - examples/ssh_watcher.rb
 - lib/systemd-journal.rb
+- lib/systemd.rb
 - lib/systemd/ffi_size_t.rb
 - lib/systemd/id128.rb
 - lib/systemd/journal.rb
@@ -143,8 +144,10 @@ files:
 - spec/fixtures/test.journal
 - spec/fixtures/test.json
 - spec/spec_helper.rb
+- spec/systemd/id128_spec.rb
 - spec/systemd/journal_entry_spec.rb
 - spec/systemd/journal_spec.rb
+- spec/systemd_spec.rb
 - systemd-journal.gemspec
 homepage: https://github.com/ledbettj/systemd-journal
 licenses:
@@ -158,7 +161,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.9.3
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
@@ -174,6 +177,8 @@ test_files:
 - spec/fixtures/test.journal
 - spec/fixtures/test.json
 - spec/spec_helper.rb
+- spec/systemd/id128_spec.rb
 - spec/systemd/journal_entry_spec.rb
 - spec/systemd/journal_spec.rb
+- spec/systemd_spec.rb
 has_rdoc: