dbus-systemd 0.8.0 → 0.9.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: b0d7cb7f2cc7465907d88f909e89cfab72fc2417
-  data.tar.gz: f883e6d2188cb5ccda2c5a995ac480a611afda26
+  metadata.gz: 2cc0ac2b5457ce2194acfe99f01c52535421adb1
+  data.tar.gz: 3a52bf67e943a51bd21a3f271db5ad8e305b714c
 SHA512:
-  metadata.gz: 759886ec0c0824f88ded4061564ced21937a9dc090c8cc8c3069dfa5493e3d54bf1345a95d4472bf52c09ca36e0db8e3d6adf00df31c20e5fcc4fab4fe1febfc
-  data.tar.gz: 6d54949564d74a83c60cb9ee4d300d01fe1dbc8a0411740cc6b6463632affdf05f57eca30453fc92343aeeb31983be1cb01e1cfbdc37a1c33afc8df1f00a71d2
+  metadata.gz: 3e684fea2e6ae0f010e2317dae780776e3cb8d2447f31c074c0aaa3484cfc82143e7f8f854ace2d06720b667235eaf13643174daffe0b42eed0046918977ab4b
+  data.tar.gz: c389fa2907e2080ccefb3a567bd36d753994eebaebd42957e8535161dcde793fd3ccda7c3d172e08f039a1540ecffdf8c8e1cb49bb790c2565434e8e18bfa987

data/dbus-systemd.gemspec

@@ -33,4 +33,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'rake', '~> 10.5'
   spec.add_development_dependency 'rspec', '~> 3.0'
   spec.add_development_dependency 'rubocop', '~> 0.43'
+  spec.add_development_dependency 'yard', '~> 0.9'
 end

data/lib/dbus/systemd/helpers.rb

@@ -23,14 +23,28 @@ require 'dbus'
 module DBus
   module Systemd
     module Helpers
+      #
+      # get an instance of the system bus
+      #
+      # @return [DBus::SystemBus]
       def system_bus
         DBus::SystemBus.instance
       end
 
+      #
+      # get an instance of the session bus
+      #
+      # @return [DBus::SessionBus]
       def session_bus
         DBus::SessionBus.instance
       end
 
+      #
+      # map an array to a hash from an index map
+      #
+      # @param array [Array] array to be mapped
+      # @param map [Hash] map of positional elements to array indices
+      # @return [Hash] hash with keys from map and values from array
       def map_array(array, map)
         mapped = {}
 

data/lib/dbus/systemd/hostnamed.rb

@@ -28,14 +28,24 @@ require_relative 'mixin'
 module DBus
   module Systemd
     class Hostnamed
+      # the hostnamed dbus node path
       NODE = '/org/freedesktop/hostname1'.freeze
+
+      # the hostnamed dbus interface
       INTERFACE = 'org.freedesktop.hostname1'.freeze
 
       include Mixin::MethodMissing
       include Mixin::Properties
 
+      # @return [DBus::Service]
+      # @api private
       attr_reader :service
 
+      #
+      # Creates a new Hostnamed object for interfacing
+      # with hostnamed on the given bus
+      #
+      # @param bus [DBus::SystemBus, DBus::SessionBus] dbus instance
       def initialize(bus = Helpers.system_bus)
         @service = bus.service(INTERFACE)
         @object = @service.object(NODE)

data/lib/dbus/systemd/importd/manager.rb

@@ -25,12 +25,17 @@ require_relative 'transfer'
 module DBus
   module Systemd
     module Importd
+      # the importd dbus interface
       INTERFACE = 'org.freedesktop.import1'.freeze
 
       class Manager
+        # the importd manager dbus node path
         NODE = '/org/freedesktop/import1'.freeze
+
+        # the importd manager dbus interface
         INTERFACE = 'org.freedesktop.import1.Manager'.freeze
 
+        # index mapping of transfer array returned from ListTransfers()
         TRANSFER_INDICES = {
           id: 0,
           operation: 1,
@@ -43,28 +48,55 @@ module DBus
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        # @return [DBus::Service]
+        # @api private
         attr_reader :service
 
+        #
+        # Creates a new Manager object for interfacing with
+        # the hostnamed Manager interface
+        #
+        # @param bus [DBus::SystemBus, DBus::SessionBus] dbus instance
         def initialize(bus = Systemd::Helpers.system_bus)
           @service = bus.service(Importd::INTERFACE)
           @object = @service.object(NODE)
                             .tap(&:introspect)
         end
 
+        #
+        # return a list of mapped transfers
+        #
+        # @return [Array] array of hashes with transfer data
         def transfers
           self.ListTransfers.first.map { |t| map_transfer(t) }
         end
 
+        #
+        # Create a transfer object from a transfer id
+        #
+        # @param id [Integer] transfer id
+        # @return [DBus::Systemd::Importd::Transfer] importd transfer object
         def transfer(id)
           Transfer.new(id, self)
         end
 
+        #
+        # Create a transfer object from the transfer node path
+        #
+        # @param path [String] transfer dbus node path
+        # @return [DBus::Systemd::Importd::Transfer] importd transfer object
         def get_transfer_by_path(path)
           obj = @service.object(path)
                         .tap(&:introspect)
           Transfer.new(obj.Get(Transfer::INTERFACE, 'Id').first, self)
         end
 
+        #
+        # map a transfer array as returned from ListTransfers
+        # to a hash with keys from TRANSER_INDICES
+        #
+        # @param transfer_array [Array] a transfer array
+        # @return [Hash] mapped transfer array to named fields
         def map_transfer(transfer_array)
           Systemd::Helpers.map_array(transfer_array, TRANSFER_INDICES)
         end

data/lib/dbus/systemd/importd/transfer.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Importd
       class Transfer
+        # importd transfer object dbus interface
         INTERFACE = 'org.freedesktop.import1.Transfer'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # create a transfer object for interfacing with importd transfers
+        #
+        # @param id [Integer] transfer id
+        # @param manager [DBus::Systemd::Importd::Manager] the importd manager object
         def initialize(id, manager = Manager.new)
           @object = manager.service.object("#{Manager::NODE}/transfer/_#{id}")
                            .tap(&:introspect)

data/lib/dbus/systemd/job.rb

@@ -24,11 +24,17 @@ require_relative 'mixin'
 module DBus
   module Systemd
     class Job
+      # systemd job object dbus interface
       INTERFACE = 'org.freedesktop.systemd1.Job'.freeze
 
       include Mixin::MethodMissing
       include Mixin::Properties
 
+      #
+      # Creates a job object for interfacing with a systemd job
+      #
+      # @param id [Integer] the job id
+      # @param manager [DBus::Systemd::Manager] the systemd manager to query
       def initialize(id, manager = Manager.new)
         job_path = manager.GetJob(id).first
         @object = manager.service.object(job_path)

data/lib/dbus/systemd/localed.rb

@@ -28,14 +28,23 @@ require_relative 'mixin'
 module DBus
   module Systemd
     class Localed
+      # the localed object dbus node path
       NODE = '/org/freedesktop/locale1'.freeze
+
+      # the localed object dbus interface
       INTERFACE = 'org.freedesktop.locale1'.freeze
 
       include Mixin::MethodMissing
       include Mixin::Properties
 
+      # @return [DBus::Service]
+      # @api private
       attr_reader :service
 
+      #
+      # Create a new DBus::Systemd::Localed object
+      #
+      # @param bus [DBus::SystemBus, DBus::SessionBus] the bus instance
       def initialize(bus = Helpers.system_bus)
         @service = bus.service(INTERFACE)
         @object = @service.object(NODE)

data/lib/dbus/systemd/logind/manager.rb

@@ -27,12 +27,17 @@ require_relative 'seat'
 module DBus
   module Systemd
     module Logind
+      # the logind objet dbus interface
       INTERFACE = 'org.freedesktop.login1'.freeze
 
       class Manager
+        # the logind manager object dbus node path
         NODE = '/org/freedesktop/login1'.freeze
+
+        # the logind manager object dbus interface
         INTERFACE = 'org.freedesktop.login1.Manager'.freeze
 
+        # session array index map as returned by ListSessions
         SESSION_INDICES = {
           id: 0,
           user_id: 1,
@@ -41,17 +46,20 @@ module DBus
           object_path: 4
         }.freeze
 
+        # user array index map as returned by ListUsers
         USER_INDICES = {
           id: 0,
           name: 1,
           object_path: 2
         }.freeze
 
+        # seat array index map as returned by ListSeats
         SEAT_INDICES = {
           id: 0,
           object_path: 1
         }.freeze
 
+        # inhibitor array index map as returned by ListInhibitors
         INHIBITOR_INDICES = {
           what: 0,
           who: 1,
@@ -64,64 +72,127 @@ module DBus
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        # @return [DBus::Service]
+        # @api private
         attr_reader :service
 
+        #
+        # Create a logind manager dbus proxy object
+        #
+        # @param bus [DBus::SystemBus, DBus::SessionBus] dbus instance
         def initialize(bus = Systemd::Helpers.system_bus)
           @service = bus.service(Logind::INTERFACE)
           @object = @service.object(NODE)
                             .tap(&:introspect)
         end
 
+        #
+        # get mapped list of seats
+        #
+        # @return [Array] array of mapped seat hashes
         def seats
           self.ListSeats.first.map { |s| map_seat(s) }
         end
 
+        #
+        # get seat object
+        #
+        # @param id [String] seat id (e.g. 'seat0')
+        # @return [DBus::Systemd::Logind::Seat] logind seat object
         def seat(id)
           Seat.new(id, self)
         end
 
+        #
+        # get seat object from dbus node path
+        #
+        # @param path [String] seat dbus node path
+        # @return [DBus::Systemd::Logind::Seat] logind seat object
         def get_seat_by_path(path)
           obj = @service.object(path)
                         .tap(&:introspect)
           Seat.new(obj.Get(Seat::INTERFACE, 'Id').first, self)
         end
 
+        #
+        # map seat array to named field hash
+        #
+        # @param seat_array [Array] seat array as returned from ListSeats
+        # @return [Hash] mapped array as hash
         def map_seat(seat_array)
           Systemd::Helpers.map_array(seat_array, SEAT_INDICES)
         end
 
+        #
+        # array of property-mapped seat hashes
+        #
+        # @return [Array] array of seat-property hashes
         def sessions
           self.ListSessions.first.map { |s| map_session(s) }
         end
 
+        #
+        # dbus session object by id
+        #
+        # @param id [String] session id
+        # @return [DBus::Systemd::Logind::Session] logind session object
         def session(id)
           Session.new(id, self)
         end
 
+        #
+        # get session object by dbus node path
+        #
+        # @param path [String] session dbus node path
+        # @return [DBus::Systemd::Logind::Session] logind session object
         def get_session_by_path(path)
           obj = @service.object(path)
                         .tap(&:introspect)
           Session.new(obj.Get(Session::INTERFACE, 'Id').first, self)
         end
 
+        #
+        # convert session array to mapped hash
+        #
+        # @param session_array [Array] session array as returned by ListSessions
+        # @return [Hash] mapped session property hash
         def map_session(session_array)
           Systemd::Helpers.map_array(session_array, SESSION_INDICES)
         end
 
+        #
+        # get logind users
+        #
+        # @return [Array] array of mapped logind user property hashes
         def users
           self.ListUsers.first.map { |u| map_user(u) }
         end
 
+        #
+        # get user dbus object
+        #
+        # @param id [Integer] user id
+        # @return [DBus::Systemd::Logind::User] logind user dbus object
         def user(id)
           User.new(id, self)
         end
 
+        #
+        # get user dbus object from dbus node path
+        #
+        # @param path [String] dbus node path for user
+        # @return [DBus::Systemd::Logind::User] logind user dbus object
         def get_user_by_path(path)
           obj = @service.object(path)
                         .tap(&:introspect)
           User.new(obj.Get(User::INTERFACE, 'Id').first, self)
         end
 
+        #
+        # convert user array to hash with mapped properties
+        #
+        # @param user_array [Array] user array as returned by ListUsers
+        # @return [Hash] hash with mapped user properties
         def map_user(user_array)
           Systemd::Helpers.map_array(user_array, USER_INDICES)
         end

data/lib/dbus/systemd/logind/seat.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Logind
       class Seat
+        # logind seat object dbus interface
         INTERFACE = 'org.freedesktop.login1.Seat'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # create a new logind seat dbus object
+        #
+        # @param id [String] logind seat id
+        # @param manager [DBus::Systemd::Logind::Manager] logind manager object
         def initialize(id, manager = Manager.new)
           seat_path = manager.GetSeat(id).first
           @object = manager.service.object(seat_path)

data/lib/dbus/systemd/logind/session.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Logind
       class Session
+        # logind session object dbus interface
         INTERFACE = 'org.freedesktop.login1.Session'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # create logind session dbus proxy object
+        #
+        # @param id [String] logind session id
+        # @param manager [DBus::Systemd::Logind::Manager] logind manager object
         def initialize(id, manager = Manager.new)
           session_path = manager.GetSession(id).first
           @object = manager.service.object(session_path)

data/lib/dbus/systemd/logind/user.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Logind
       class User
+        # logind user object dbus interface
         INTERFACE = 'org.freedesktop.login1.User'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # create new logind user dbus proxy object
+        #
+        # @param id [Integer] logind user id
+        # @param manager [DBus::Systemd::Logind::Manager] logind manager object
         def initialize(id, manager = Manager.new)
           user_path = manager.GetUser(id).first
           @object = manager.service.object(user_path)

data/lib/dbus/systemd/machined/image.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Machined
       class Image
+        # machined image object dbus interface
         INTERFACE = 'org.freedesktop.machine1.Image'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # Create a machined image dbus proxy object
+        #
+        # @param name [String] image name
+        # @param manager [DBus::Systemd::Machined::Manager] manager dbus proxy object
         def initialize(name, manager = Manager.new)
           image_path = manager.GetImage(name).first
           @object = manager.service.object(image_path)

data/lib/dbus/systemd/machined/machine.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Machined
       class Machine
+        # machined machine object dbus interface
         INTERFACE = 'org.freedesktop.machine1.Machine'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # create machined machine dbus proxy object
+        #
+        # @param name [String] machine name
+        # @param manager [DBus::Systemd::Machined::Manager] machined manager object
         def initialize(name, manager = Manager.new)
           machine_path = manager.GetMachine(name).first
           @object = manager.service.object(machine_path)

data/lib/dbus/systemd/machined/manager.rb

@@ -26,12 +26,17 @@ require_relative 'image'
 module DBus
   module Systemd
     module Machined
+      # machined dbus interface
       INTERFACE = 'org.freedesktop.machine1'.freeze
 
       class Manager
+        # machined manager dbus object node path
         NODE = '/org/freedesktop/machine1'.freeze
+
+        # machined manager dbus interface
         INTERFACE = 'org.freedesktop.machine1.Manager'.freeze
 
+        # machine array index map as returned by ListMachines
         MACHINE_INDICES = {
           name: 0,
           class: 1,
@@ -39,6 +44,7 @@ module DBus
           object_path: 3
         }.freeze
 
+        # image array index map as returned by ListImages
         IMAGE_INDICES = {
           name: 0,
           type: 1,
@@ -52,46 +58,90 @@ module DBus
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        # @return [DBus::Service]
+        # @api private
         attr_reader :service
 
+        #
+        # Create machined Manager dbus proxy object
+        #
+        # @param bus [DBus::SystemBus, DBus::SessionBus] dbus instance
         def initialize(bus = Systemd::Helpers.system_bus)
           @service = bus.service(Machined::INTERFACE)
           @object = @service.object(NODE)
                             .tap(&:introspect)
         end
 
+        #
+        # array of machines with mapped properties
+        #
+        # @return [Array] array of machine property hashes
         def machines
           self.ListMachines.first.map { |m| map_machine(m) }
         end
 
+        #
+        # get machine dbus proxy object by machine name
+        #
+        # @param name [String] machine name
+        # @return [DBus::Systemd::Machined::Machine] machine instance
         def machine(name)
           Machine.new(name, self)
         end
 
+        #
+        # get machine dbus proxy object by dbus node path
+        #
+        # @param path [String] machine dbus node path
+        # @return [DBus::Systemd::Machined::Machine] machine instance
         def get_machine_by_path(path)
           obj = @service.object(path)
                         .tap(&:introspect)
           Machine.new(obj.Get(Machine::INTERFACE, 'Name').first, self)
         end
 
+        #
+        # map machine property array from ListMachines to indexed property hash
+        #
+        # @param machine_array [Array] machine property array as returned by ListMachines
+        # @return [Hash] hash containing mapped machine properties
         def map_machine(machine_array)
           Systemd::Helpers.map_array(machine_array, MACHINE_INDICES)
         end
 
+        #
+        # get mapped array of images
+        #
+        # @return [Array] array of mapped image property hashes
         def images
           self.ListImages.first.map { |i| map_image(i) }
         end
 
+        #
+        # get image proxy object by name
+        #
+        # @param name [String] image name
+        # @return [DBus::Systemd::Machined::Machine] image dbus proxy object
         def image(name)
           Image.new(name, self)
         end
 
+        #
+        # get image dbus proxy object by dbus node path
+        #
+        # @param path [String] image dbus node path
+        # @return [DBus::Systemd::Machined::Image] image dbus proxy object
         def get_image_by_path(path)
           obj = @service.object(path)
                         .tap(&:introspect)
           Image.new(obj.Get(Image::INTERFACE, 'Name').first, self)
         end
 
+        #
+        # map image array as returned by ListImages to property hash
+        #
+        # @param image_array [Array] image property array as returned by ListImages
+        # @return [Hash] image property hash
         def map_image(image_array)
           Systemd::Helpers.map_array(image_array, IMAGE_INDICES)
         end

data/lib/dbus/systemd/manager.rb

@@ -29,12 +29,17 @@ require_relative 'job'
 
 module DBus
   module Systemd
+    # systemd dbus interface
     INTERFACE = 'org.freedesktop.systemd1'.freeze
 
     class Manager
+      # systemd manager object dbus node path
       NODE = '/org/freedesktop/systemd1'.freeze
+
+      # systemd manager dbus interface
       INTERFACE = 'org.freedesktop.systemd1.Manager'.freeze
 
+      # index map of unit array returned by ListUnits
       UNIT_INDICES = {
         name: 0,
         description: 1,
@@ -48,6 +53,7 @@ module DBus
         job_object_path: 9
       }.freeze
 
+      # index map of job array returned by ListJobs
       JOB_INDICES = {
         id: 0,
         unit: 1,
@@ -60,46 +66,90 @@ module DBus
       include Mixin::MethodMissing
       include Mixin::Properties
 
+      # @return [DBus::Service]
+      # @api private
       attr_reader :service
 
+      #
+      # Create a systemd manager dbus proxy object
+      #
+      # @param bus [DBus::SystemBus, DBus::SessionBus] bus instance
       def initialize(bus = Systemd::Helpers.system_bus)
         @service = bus.service(Systemd::INTERFACE)
         @object = @service.object(NODE)
                           .tap(&:introspect)
       end
 
+      #
+      # get an array of mapped units/unit properties
+      #
+      # @return [Array] array of mapped unit property hashes
       def units
         self.ListUnits.first.map { |u| map_unit(u) }
       end
 
+      #
+      # get a unit dbus proxy object by name
+      #
+      # @param name [String] unit name (e.g. 'sshd.service')
+      # @return [DBus::Systemd::Unit] unit dbus proxy object
       def unit(name)
         Unit.new(name, self)
       end
 
+      #
+      # get unit object by dbus node path
+      #
+      # @param path [String] unit dbus node path
+      # @return [DBus::Systemd::Unit] unit dbus proxy object
       def get_unit_by_object_path(path)
         obj = @service.object(path)
                       .tap(&:introspect)
         Unit.new(obj.Get(Unit::INTERFACE, 'Id').first, self)
       end
 
+      #
+      # map unit array from ListUnits to property hash
+      #
+      # @param unit_array [Array] array as returned from ListUnits
+      # @return [Hash] unit property hash
       def map_unit(unit_array)
         Helpers.map_array(unit_array, UNIT_INDICES)
       end
 
+      #
+      # array of jobs from ListJobs mapped to property hashes
+      #
+      # @return [Array] array of job property hashes
       def jobs
         self.ListJobs.first.map { |j| map_job(j) }
       end
 
+      #
+      # get job by id
+      #
+      # @param id [Integer] job id
+      # @return [DBus::Systemd::Job] job dbus proxy object
       def job(id)
         Job.new(id, self)
       end
 
+      #
+      # get job by dbus node path
+      #
+      # @param path [String] job dbus node path
+      # @return [DBus::Systemd::Job] job dbus proxy object
       def get_job_by_object_path(path)
         obj = @service.object(path)
                       .tap(&:introspect)
         Job.new(obj.Get(Job::INTERFACE, 'Id').first, self)
       end
 
+      #
+      # map job array from ListJobs to property hash
+      #
+      # @param job_array [Array] job property array as returned by ListJobs
+      # @return [Hash] mapped job property hash
       def map_job(job_array)
         Helpers.map_array(job_array, JOB_INDICES)
       end

data/lib/dbus/systemd/mixin.rb

@@ -22,8 +22,14 @@ module DBus
   module Systemd
     module Mixin
       module MethodMissing
+        # @return DBus::ProxyObject
+        # @api private
         attr_reader :object
 
+        #
+        # use method_missing to proxy methods to
+        # the dbus proxy object interface methods
+        #
         def method_missing(name, *args, &blk)
           if @object.respond_to?(name)
             @object.send(name, *args, &blk)
@@ -32,12 +38,20 @@ module DBus
           end
         end
 
+        #
+        # fix respond_to to also check the dbus methods
+        #
         def respond_to_missing?(*args)
           @object.respond_to?(*args) || super
         end
       end
 
       module Properties
+        #
+        # fetches properties from a named interface
+        #
+        # @param interface [String], interface to get properties from
+        # @return [Hash] interface property hash
         def properties(interface = self.class::INTERFACE)
           self.GetAll(interface).first
         end

data/lib/dbus/systemd/networkd/link.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Networkd
       class Link
+        # networkd link dbus interface
         INTERFACE = 'org.freedesktop.network1.Link'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # create new networkd link dbus proxy object
+        #
+        # @param id [Integer] networkd link id
+        # @param manager [DBus::Systemd::Networkd::Manager] networkd manager object
         def initialize(id, manager = Manager.new)
           @object = manager.service.object("#{Manager::NODE}/link/#{id}")
                            .tap(&:introspect)

data/lib/dbus/systemd/networkd/manager.rb

@@ -25,23 +25,38 @@ require_relative 'link'
 module DBus
   module Systemd
     module Networkd
+      # networkd dbus interface
       INTERFACE = 'org.freedesktop.network1'.freeze
 
       class Manager
+        # networkd manager object dbus node path
         NODE = '/org/freedesktop/network1'.freeze
+
+        # networkd manager dbus interface
         INTERFACE = 'org.freedesktop.network1.Manager'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        # @return [DBus::Service]
+        # @api private
         attr_reader :service
 
+        #
+        # create a networkd manager dbus proxy object
+        #
+        # @param bus [DBus::SystemBus, DBus::SessionBus] dbus instance
         def initialize(bus = Systemd::Helpers.system_bus)
           @service = bus.service(Networkd::INTERFACE)
           @object = @service.object(NODE)
                             .tap(&:introspect)
         end
 
+        #
+        # get a link by id
+        #
+        # @param id [Integer] networkd link id
+        # @return [DBus::Systemd::Networkd::Link] networkd link dbus proxy object
         def link(id)
           Link.new(id, self)
         end

data/lib/dbus/systemd/resolved/link.rb

@@ -25,11 +25,17 @@ module DBus
   module Systemd
     module Resolved
       class Link
+        # resolved link dbus interface
         INTERFACE = 'org.freedesktop.resolve1.Link'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        #
+        # create a new link dbus proxy object
+        #
+        # @param id [Integer] resolved link id
+        # @param manager [DBus::Systemd::Resolved::Manager] resolved manager object
         def initialize(id, manager = Manager.new)
           link_path = manager.GetLink(id).first
           @object = manager.service.object(link_path)

data/lib/dbus/systemd/resolved/manager.rb

@@ -25,22 +25,41 @@ require_relative 'link'
 module DBus
   module Systemd
     module Resolved
+      # resolved dbus interface
       INTERFACE = 'org.freedesktop.resolve1'.freeze
 
       class Manager
+        # resolved manager object dbus node path
         NODE = '/org/freedesktop/resolve1'.freeze
+
+        # resolved manager dbus interface
         INTERFACE = 'org.freedesktop.resolve1.Manager'.freeze
 
         include Systemd::Mixin::MethodMissing
         include Systemd::Mixin::Properties
 
+        # @return [DBus::Service]
+        # @api private
         attr_reader :service
 
+        #
+        # get a new resolved manager dbus proxy object
+        #
+        # @param bus [DBus::SystemBus, DBus::SessionBus] dbus instance
         def initialize(bus = Systemd::Helpers.system_bus)
           @service = bus.service(Resolved::INTERFACE)
           @object = @service.object(NODE)
                             .tap(&:introspect)
         end
+
+        #
+        # get a resolved link by id
+        #
+        # @param id [Integer] resolved link id
+        # @return [DBus::Systemd::Resolved::Link] resolved link dbus proxy object
+        def link(id)
+          Link.new(id, self)
+        end
       end
     end
   end

data/lib/dbus/systemd/timedated.rb

@@ -24,14 +24,23 @@ require_relative 'mixin'
 module DBus
   module Systemd
     class Timedated
+      # the timedated dbus node path
       NODE = '/org/freedesktop/timedate1'.freeze
+
+      # the timedated dbus interface
       INTERFACE = 'org.freedesktop.timedate1'.freeze
 
       include Mixin::MethodMissing
       include Mixin::Properties
 
+      # @return [DBus::Service]
+      # @api private
       attr_reader :service
 
+      #
+      # Create a new object for interfacing with timedated
+      #
+      # @param bus [DBus::SystemBus, DBus::SessionBus] dbus instance
       def initialize(bus = Helpers.system_bus)
         @service = bus.service(INTERFACE)
         @object = @service.object(NODE)

data/lib/dbus/systemd/unit.rb

@@ -24,11 +24,17 @@ require_relative 'mixin'
 module DBus
   module Systemd
     class Unit
+      # the unit dbus interface
       INTERFACE = 'org.freedesktop.systemd1.Unit'.freeze
 
       include Mixin::MethodMissing
       include Mixin::Properties
 
+      #
+      # create a new unit object for interfacing with systemd units
+      #
+      # @param name [String] unit name
+      # @param manager [DBus::Systemd::Manager] systemd manager object
       def initialize(name, manager = Manager.new)
         unit_path = manager.GetUnit(name).first
         @object = manager.service.object(unit_path)

data/lib/dbus/systemd/unit/automount.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Automount < Unit
+        # systemd automount unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Automount'.freeze
       end
     end

data/lib/dbus/systemd/unit/device.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Device < Unit
+        # systemd device unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Device'.freeze
       end
     end

data/lib/dbus/systemd/unit/mount.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Mount < Unit
+        # systemd mount unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Mount'.freeze
       end
     end

data/lib/dbus/systemd/unit/path.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Path < Unit
+        # systemd path unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Path'.freeze
       end
     end

data/lib/dbus/systemd/unit/scope.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Scope < Unit
+        # systemd scope unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Scope'.freeze
       end
     end

data/lib/dbus/systemd/unit/service.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Service < Unit
+        # systemd service unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Service'.freeze
       end
     end

data/lib/dbus/systemd/unit/slice.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Slice < Unit
+        # systemd slice unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Slice'.freeze
       end
     end

data/lib/dbus/systemd/unit/snapshot.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Snapshot < Unit
+        # systemd snapshot unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Snapshot'.freeze
       end
     end

data/lib/dbus/systemd/unit/socket.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Socket < Unit
+        # systemd socket unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Socket'.freeze
       end
     end

data/lib/dbus/systemd/unit/swap.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Swap < Unit
+        # systemd swap unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Swap'.freeze
       end
     end

data/lib/dbus/systemd/unit/target.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Target < Unit
+        # systemd target unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Target'.freeze
       end
     end

data/lib/dbus/systemd/unit/timer.rb

@@ -24,6 +24,7 @@ module DBus
   module Systemd
     class Unit
       class Timer < Unit
+        # systemd timer unit dbus interface
         INTERFACE = 'org.freedesktop.systemd1.Timer'.freeze
       end
     end

data/lib/dbus/systemd/version.rb

@@ -20,6 +20,7 @@
 #
 module DBus
   module Systemd
-    VERSION = '0.8.0'.freeze
+    # dbus-systemd gem version
+    VERSION = '0.9.0'.freeze
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: dbus-systemd
 version: !ruby/object:Gem::Version
-  version: 0.8.0
+  version: 0.9.0
 platform: ruby
 authors:
 - Nathan Williams
@@ -80,6 +80,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '0.43'
+- !ruby/object:Gem::Dependency
+  name: yard
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
 description: library for interfacing with systemd D-Bus APIs
 email:
 - nath.e.will@gmail.com