ruby-dbus 0.23.0.beta1 → 0.23.1

data/lib/dbus/org.freedesktop.DBus.xml

@@ -0,0 +1,97 @@
+<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node>
+  <interface name="org.freedesktop.DBus.Introspectable">
+    <method name="Introspect">
+      <arg direction="out" type="s"/>
+    </method>
+  </interface>
+  <interface name="org.freedesktop.DBus">
+    <method name="Hello">
+      <arg direction="out" type="s"/>
+    </method>
+    <method name="RequestName">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="u"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="ReleaseName">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="StartServiceByName">
+      <arg direction="in" type="s"/>
+      <arg direction="in" type="u"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="UpdateActivationEnvironment">
+      <arg direction="in" type="a{ss}"/>
+    </method>
+    <method name="NameHasOwner">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="b"/>
+    </method>
+    <method name="ListNames">
+      <arg direction="out" type="as"/>
+    </method>
+    <method name="ListActivatableNames">
+      <arg direction="out" type="as"/>
+    </method>
+    <method name="AddMatch">
+      <arg direction="in" type="s"/>
+    </method>
+    <method name="RemoveMatch">
+      <arg direction="in" type="s"/>
+    </method>
+    <method name="GetNameOwner">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="s"/>
+    </method>
+    <method name="ListQueuedOwners">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="as"/>
+    </method>
+    <method name="GetConnectionUnixUser">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="GetConnectionUnixProcessID">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="u"/>
+    </method>
+    <method name="GetAdtAuditSessionData">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="ay"/>
+    </method>
+    <method name="GetConnectionSELinuxSecurityContext">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="ay"/>
+    </method>
+    <method name="ReloadConfig">
+    </method>
+    <method name="GetId">
+      <arg direction="out" type="s"/>
+    </method>
+    <method name="GetConnectionCredentials">
+      <arg direction="in" type="s"/>
+      <arg direction="out" type="a{sv}"/>
+    </method>
+    <property name="Features" type="as" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="const"/>
+    </property>
+    <property name="Interfaces" type="as" access="read">
+      <annotation name="org.freedesktop.DBus.Property.EmitsChangedSignal" value="const"/>
+    </property>
+    <signal name="NameOwnerChanged">
+      <arg type="s"/>
+      <arg type="s"/>
+      <arg type="s"/>
+    </signal>
+    <signal name="NameLost">
+      <arg type="s"/>
+    </signal>
+    <signal name="NameAcquired">
+      <arg type="s"/>
+    </signal>
+  </interface>
+</node>

data/lib/dbus/proxy_service.rb

@@ -22,11 +22,12 @@ module DBus
   #   p manager.ListImages
   class ProxyService < NodeTree
     # @return [BusName,nil] The service name.
-    # May be nil for peer connections
+    # Will be nil for a {PeerConnection}
     attr_reader :name
     # @return [Connection] The connection we're using.
     attr_reader :connection
 
+    # @param connection [Connection] The connection we're using.
     def initialize(name, connection)
       @name = BusName.new(name)
       @connection = connection
@@ -76,7 +77,7 @@ module DBus
     # Perform a recursive retrospection on the given current _node_
     # on the given _path_.
     def rec_introspect(node, path)
-      xml = bus.introspect_data(@name, path)
+      xml = connection.introspect_data(@name, path)
       intfs, subnodes = IntrospectXMLParser.new(xml).parse
       subnodes.each do |nodename|
         subnode = node[nodename] = Node.new(nodename)
@@ -92,4 +93,15 @@ module DBus
       node.object = ProxyObjectFactory.new(xml, @connection, @name, path).build
     end
   end
+
+  # A hack for pretending that a {PeerConnection} has a single unnamed {ProxyService}
+  # so that we can get {ProxyObject}s from it.
+  class ProxyPeerService < ProxyService
+    # @param connection [Connection] The peer connection we're using.
+    def initialize(connection)
+      # this way we disallow ProxyService taking a nil name by accident
+      super(":0.0", connection)
+      @name = nil
+    end
+  end
 end

data/lib/dbus.rb

@@ -26,6 +26,7 @@ require_relative "dbus/api_options"
 require_relative "dbus/auth"
 require_relative "dbus/bus"
 require_relative "dbus/bus_name"
+require_relative "dbus/connection"
 require_relative "dbus/data"
 require_relative "dbus/emits_changed_signal"
 require_relative "dbus/error"

data/ruby-dbus.gemspec

@@ -9,7 +9,7 @@ GEMSPEC = Gem::Specification.new do |s|
   s.summary = "Ruby module for interaction with D-Bus"
   s.description = "Pure Ruby module for interaction with D-Bus IPC system"
   s.version = File.read("VERSION").strip
-  s.license = "LGPL-2.1"
+  s.license = "LGPL-2.1-or-later"
   s.author = "Ruby DBus Team"
   s.email = "martin.github@vidner.net"
   s.homepage = "https://github.com/mvidner/ruby-dbus"

data/spec/bus_connection_spec.rb

@@ -21,7 +21,6 @@ describe DBus::BusConnection do
     end
 
     context "when the name is taken already", tag_service: true do
-      # formerly it returned Service, now ObjectServer takes its role
       it "raises NameRequestError... too late" do
         name = "org.ruby.service"
         expect do
@@ -36,10 +35,10 @@ describe DBus::BusConnection do
       end
     end
 
-    context "when we're not allowed to own the name", tag_system_bus: true do
-      let(:bus) { DBus::ASystemBus.new }
-      xit "raises an error... too late" do
-        name = "org.rubygems.ruby_dbus.NotAllowedToOwnThisNameAnyway"
+    # This only works with our special bus setup
+    context "when we're not allowed to own the name", tag_limited_bus: true do
+      it "raises an error... too late" do
+        name = "org.rubygems.ruby_dbus.NobodyCanOwnThisName"
         expect do
           bus.request_service(name)
           _unrelated_call = bus.proxy.GetId.first
@@ -50,28 +49,41 @@ describe DBus::BusConnection do
 
   describe "#request_name", tag_bus: true do
     context "when the name request succeeds" do
-      it "returns something which can export objects" do
+      it "returns a success code" do
         name = "org.rubygems.ruby_dbus.RequestNameTest"
-        expect { bus.request_name(name) }.to_not raise_error
-        bus.proxy.ReleaseName(name)
+        expect(bus.request_name(name)).to eq DBus::Connection::REQUEST_NAME_REPLY_PRIMARY_OWNER
+        # second time, considered also a success
+        expect(bus.request_name(name)).to eq DBus::Connection::REQUEST_NAME_REPLY_ALREADY_OWNER
+        bus.release_name(name)
       end
     end
 
     context "when the name is taken already", tag_service: true do
-      # formerly it returned Service, now ObjectServer takes its role
       it "raises NameRequestError" do
         name = "org.ruby.service"
         expect do
-          # flags: avoid getting the name sometime later, unexpectedly
-          bus.request_name(name, flags: DBus::Connection::NAME_FLAG_DO_NOT_QUEUE)
+          bus.request_name(name)
+        end.to raise_error(DBus::Connection::NameRequestError)
+      end
+    end
+
+    context "when the name is taken already but we request queuing", tag_service: true do
+      it "raises NameRequestError but we are queued" do
+        name = "org.ruby.service"
+        owning = nil
+        # TODO: we do not expect the handlers to run
+        bus.on_name_acquired { owning = true }
+        bus.on_name_lost { owning = false }
+        expect do
+          bus.request_name(name, queue: true)
         end.to raise_error(DBus::Connection::NameRequestError)
+        expect(bus.release_name(name)).to eq DBus::BusConnection::RELEASE_NAME_REPLY_RELEASED
       end
     end
 
-    context "when we're not allowed to own the name", tag_system_bus: true do
-      let(:bus) { DBus::ASystemBus.new }
-      xit "raises an error... too late" do
-        name = "org.rubygems.ruby_dbus.NotAllowedToOwnThisNameAnyway"
+    context "when we're not allowed to own the name", tag_limited_bus: true do
+      it "raises an error" do
+        name = "org.rubygems.ruby_dbus.NobodyCanOwnThisName"
         expect do
           bus.request_name(name)
         end.to raise_error(DBus::Error, /not allowed to own the service/)

data/spec/connection_spec.rb

@@ -0,0 +1,37 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::PeerConnection do
+  let(:address) { ENV["DBUS_SESSION_BUS_ADDRESS"] }
+  subject { described_class.new(address) }
+
+  describe "#peer_service" do
+    it "returns a PeerService with a nil name" do
+      svc = subject.peer_service
+      expect(svc).to be_a(DBus::ProxyService)
+      expect(svc.name).to be_nil
+    end
+  end
+
+  describe "#add_match, #remove_match" do
+    it "doesn't crash trying to call AddMatch, RemoveMatch" do
+      mr = DBus::MatchRule.new
+      mr.member = "StateUpdated"
+      mr.interface = "org.PulseAudio.Core1.Device"
+      handler = ->(_msg) {}
+
+      # Cheating a bit with the mocking:
+      # a PulseAudio peer connection would error with
+      # > DBus::Error: Method "AddMatch" with signature "s" on interface
+      # > "org.freedesktop.DBus" doesn't exist
+      # but here we do have a bus at the other end, which replies with
+      # > DBus::Error: Client tried to send a message other than Hello without being registered
+      # where "registering" is a libdbus-1 thing meaning "internal bookkeeping and send Hello"
+      expect { subject.add_match(mr, &handler) }.to_not raise_error
+      expect { subject.remove_match(mr) }.to_not raise_error
+    end
+  end
+end

data/spec/dbus_spec.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env rspec
+# frozen_string_literal: true
+
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus do
+  describe ".session_bus", tag_bus: true do
+    it "returns a BusConnection" do
+      expect(DBus.session_bus).to be_a(DBus::BusConnection)
+    end
+  end
+
+  describe ".system_bus" do
+    # coverage obsession: mock it out,
+    # system bus may not exist during RPM builds
+    it "calls SystemBus.instance" do
+      expect(DBus::SystemBus).to receive(:instance)
+      DBus.system_bus
+    end
+  end
+end

data/spec/mock-service/spaghetti-monster.rb

@@ -23,7 +23,7 @@ class TestChild < DBus::Object
   end
 
   dbus_interface "org.ruby.TestChild" do
-    dbus_attr_reader :name, "s"
+    dbus_reader_attr_accessor :name, "s"
   end
 end
 
@@ -183,16 +183,14 @@ class Test < DBus::Object
   dbus_interface "org.ruby.TestParent" do
     dbus_method :New, "in name:s, out opath:o" do |name|
       child = TestChild.new("#{path}/#{name}")
-      connection.object_server.export(child)
+      object_server.export(child)
       [child.path]
     end
 
     dbus_method :Delete, "in opath:o" do |opath|
       raise ArgumentError unless opath.start_with?(path)
 
-      svr = connection.object_server
-      obj = svr.get_node(opath)&.object
-      svr.unexport(obj)
+      object_server.unexport(opath)
     end
   end
 
@@ -200,6 +198,7 @@ class Test < DBus::Object
     dbus_method :the_answer, "out answer:i" do
       [0]
     end
+
     dbus_method :interfaces, "out answer:i" do
       # 'Shadowed' from the Ruby side, meaning ProxyObject#interfaces
       # will return the list of interfaces rather than calling this method.

data/spec/object_server_spec.rb

@@ -55,26 +55,9 @@ describe DBus::ObjectServer do
         o
       end
 
-      # which is right?
-      # current behavior
-      it "a) silently uses the new object" do
+      it "raises an error" do
         server.export(obj1)
-        server.export(obj2)
-
-        expect(server).to_not receive(:unexport).with(obj1)
-        expect(server[path].which).to eq 2
-      end
-
-      xit "b) unexports the other object first" do
-        server.export(obj1)
-
-        expect(server).to receive(:unexport).with(obj1)
-        server.export(obj2)
-      end
-
-      xit "c) raises an error" do
-        server.export(obj1)
-        expect { server.export(obj2) }.to raise_error(RuntimeError)
+        expect { server.export(obj2) }.to raise_error(RuntimeError, /there is already an object/)
       end
     end
   end
@@ -85,10 +68,20 @@ describe DBus::ObjectServer do
       @svc = bus.object_server
     end
 
-    it "returns the unexported object" do
+    it "returns the unexported leaf object" do
       obj = DBus::Object.new "/org/ruby/Foo"
       @svc.export obj
-      expect(@svc.unexport(obj)).to be_a DBus::Object
+      expect(@svc.unexport(obj)).to be_equal(obj)
+    end
+
+    it "returns the unexported leaf object, if specified by its path" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect(@svc.unexport(obj.path)).to be_equal(obj)
+
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect(@svc.unexport(DBus::ObjectPath.new(obj.path))).to be_equal(obj)
     end
 
     it "returns false if the object was never exported" do
@@ -96,9 +89,50 @@ describe DBus::ObjectServer do
       expect(@svc.unexport(obj)).to be false
     end
 
-    it "raises when argument is not a DBus::Object" do
-      path = "/org/ruby/Foo"
-      expect { @svc.unexport(path) }.to raise_error(ArgumentError)
+    it "raises false if the path has no node" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect { @svc.unexport("/org/ruby/NotFoo") }.to raise_error(ArgumentError)
+      @svc.unexport obj
+    end
+
+    it "raises false if the path has no object" do
+      obj = DBus::Object.new "/org/ruby/Foo"
+      @svc.export obj
+      expect { @svc.unexport("/org/ruby") }.to raise_error(ArgumentError)
+      @svc.unexport obj
+    end
+
+    it "raises when argument is not usable" do
+      expect { @svc.unexport(:foo) }.to raise_error(ArgumentError)
+    end
+
+    context "/child_of_root" do
+      it "returns the unexported object" do
+        obj = DBus::Object.new "/child_of_root"
+        @svc.export obj
+        expect(@svc.unexport(obj)).to be_equal(obj)
+      end
+    end
+
+    context "/ (root)" do
+      it "returns the unexported object" do
+        obj = DBus::Object.new "/"
+        @svc.export obj
+        expect(@svc.unexport(obj)).to be_equal(obj)
+      end
+    end
+
+    context "not a leaf object" do
+      it "maintains objects on child paths" do
+        obj = DBus::Object.new "/org/ruby"
+        @svc.export obj
+        obj2 = DBus::Object.new "/org/ruby/Foo"
+        @svc.export obj2
+
+        @svc.unexport(obj)
+        expect(@svc.object("/org/ruby/Foo")).to be_a DBus::Object
+      end
     end
   end
 end

data/spec/object_spec.rb

@@ -175,4 +175,20 @@ describe DBus::Object do
       expect { obj.dispatch(msg) }.to_not raise_error
     end
   end
+
+  describe "#emit" do
+    context "before the object has been exported" do
+      it "raises an explanatory error" do
+        obj = ObjectTest.new("/test")
+
+        intf = DBus::Interface.new("org.example.Test")
+        signal = DBus::Signal.new("Ring")
+        expect { obj.emit(intf, signal) }
+          .to raise_error(
+            RuntimeError,
+            %r{Cannot emit signal org.example.Test.Ring before /test is exported}
+          )
+      end
+    end
+  end
 end

data/spec/proxy_service_spec.rb

@@ -5,13 +5,7 @@ require_relative "spec_helper"
 require "dbus"
 
 describe DBus::ProxyService do
-  context "when a private bus is set up" do
-    around(:each) do |example|
-      with_private_bus do
-        with_service_by_activation(&example)
-      end
-    end
-
+  context "when a private bus is set up", tag_service: true do
     let(:bus) { DBus::ASessionBus.new }
 
     describe "#exists?" do
@@ -26,5 +20,16 @@ describe DBus::ProxyService do
         expect(svc.exists?).to be false
       end
     end
+
+    # This method is used by dbus-gui-gtk.
+    # Deprecate it? In favor of introspecting the tree gradually
+    # or move it to the application code?
+    describe "#introspect" do
+      it "creates the whole node tree" do
+        svc = bus.service("org.ruby.service")
+        expect { svc.introspect }.to_not raise_error
+        expect(svc.root.dig("org", "ruby", "MyInstance")).to be_a DBus::Node
+      end
+    end
   end
 end

data/spec/tools/dbus-limited-session.conf

@@ -43,6 +43,9 @@
     <allow eavesdrop="true"/>
     <!-- Allow anyone to own anything -->
     <allow own="*"/>
+
+    <!-- To test how request_name handles bus errors -->
+    <deny own="org.rubygems.ruby_dbus.NobodyCanOwnThisName"/>
   </policy>
 
   <!-- Do not increase the limits.

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.23.0.beta1
+  version: 0.23.1
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2023-06-05 00:00:00.000000000 Z
+date: 2023-10-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rexml
@@ -124,6 +124,7 @@ files:
 - doc/Tutorial.md
 - examples/doc/README.md
 - examples/doc/_extract_examples
+- examples/no-bus/pulseaudio.rb
 - examples/no-introspect/nm-test.rb
 - examples/no-introspect/tracker-test.rb
 - examples/rhythmbox/playpause.rb
@@ -140,6 +141,7 @@ files:
 - lib/dbus/auth.rb
 - lib/dbus/bus.rb
 - lib/dbus/bus_name.rb
+- lib/dbus/connection.rb
 - lib/dbus/core_ext/class/attribute.rb
 - lib/dbus/core_ext/module/redefine_method.rb
 - lib/dbus/data.rb
@@ -157,6 +159,7 @@ files:
 - lib/dbus/object_manager.rb
 - lib/dbus/object_path.rb
 - lib/dbus/object_server.rb
+- lib/dbus/org.freedesktop.DBus.xml
 - lib/dbus/platform.rb
 - lib/dbus/proxy_object.rb
 - lib/dbus/proxy_object_factory.rb
@@ -175,9 +178,11 @@ files:
 - spec/bus_spec.rb
 - spec/byte_array_spec.rb
 - spec/client_robustness_spec.rb
+- spec/connection_spec.rb
 - spec/coverage_helper.rb
 - spec/data/marshall.yaml
 - spec/data_spec.rb
+- spec/dbus_spec.rb
 - spec/emits_changed_signal_spec.rb
 - spec/err_msg_spec.rb
 - spec/introspect_xml_parser_spec.rb
@@ -217,7 +222,7 @@ files:
 - spec/zzz_quit_spec.rb
 homepage: https://github.com/mvidner/ruby-dbus
 licenses:
-- LGPL-2.1
+- LGPL-2.1-or-later
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -230,9 +235,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: 2.4.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.3.26
 signing_key: