ruby-dbus 0.5.0 → 0.6.0

data/NEWS

@@ -5,6 +5,15 @@ Note about bug numbers:
  Issue#1  - http://github.com/mvidner/ruby-dbus/issues#issue/1
  bnc#1    - https://bugzilla.novell.com/show_bug.cgi?id=1
 
+== Ruby D-Bus 0.6.0 - 2010-12-11
+
+Features:
+ * Clients can access properties conveniently (Ticket#28).
+
+Bug fixes:
+ * Service won't crash whan handling an unknown method or interface (Ticket#31).
+ * Don't send an invalid error name when it originates from a NameError.
+
 == Ruby D-Bus 0.5.0 - 2010-11-07
 
 Features:

data/README

@@ -5,23 +5,11 @@ D-Bus system can be used in the Ruby programming language.
 
 == Requirements
 
- * Ruby 1.8 (>= 1.8.6?)
-
- Optionally, for generating the tutorial:
- * Webgen (>= 0.4) 
+ * Ruby 1.8 (>= 1.8.6?) or 1.9
 
 == Installation
 
- 1. Decompress the Ruby D-Bus tarball (ruby-dbus-<version>.tar.gz).
- 2. Move to top-level directory and type:
-
-      $ ruby setup.rb config
-      $ ruby setup.rb setup
-     ($ su)
-      # ruby setup.rb install
-
-    You can also install files in your favorite directory by
-    supplying setup.rb some options. Try "ruby setup.rb --help".
+ * gem install ruby-dbus
 
 == Feature
 
@@ -42,8 +30,9 @@ Ruby D-Bus currently supports the following features:
 == Usage
 
  See some of the examples in the examples/ subdirectory of the tarball.
- Also, check out the included tutorial (in Webgen format) in doc/tutorial/
- or view it online on http://trac.luon.net/data/ruby-dbus/tutorial/.
+ Also, check out the included tutorial (in Markdown format) in doc/tutorial/
+ or view it online on
+ https://github.com/mvidner/ruby-dbus/blob/master/doc/tutorial/index.markdown .
 
 == License
 

data/VERSION

@@ -1 +1 @@
-0.5.0
+0.6.0

data/doc/tutorial/index.html

@@ -164,6 +164,15 @@ access it with <code>bus.proxy</code> method. For example, you can retrieve an a
 exported service names of a bus like this:</p>
 <pre><code>bus.proxy.ListNames[0]
 </code></pre>
+<h2>Properties</h2>
+<p>Some D-Bus objects provide access to properties. They are accessed by
+treating a proxy interface as a hash:</p>
+<pre><code>nm_iface = network_manager_object["org.freedesktop.NetworkManager"]
+enabled = nm_iface["WirelessEnabled"]
+puts "Wireless is " + (enabled ? "enabled":"disabled")
+puts "Toggling wireless"
+nm_iface["WirelessEnabled"] = ! enabled
+</code></pre>
 <h2>Calling a method asynchronously</h2>
 <p>D-Bus is <em>asynchronous</em>.  This means that you do not have to wait for a
 reply when you send a message.  When you call a remote method that takes a

data/doc/tutorial/index.markdown

@@ -229,6 +229,19 @@ exported service names of a bus like this:
 
     bus.proxy.ListNames[0]
 
+Properties
+----------
+
+Some D-Bus objects provide access to properties. They are accessed by
+treating a proxy interface as a hash:
+
+    nm_iface = network_manager_object["org.freedesktop.NetworkManager"]
+    enabled = nm_iface["WirelessEnabled"]
+    puts "Wireless is " + (enabled ? "enabled":"disabled")
+    puts "Toggling wireless"
+    nm_iface["WirelessEnabled"] = ! enabled
+
+
 Calling a method asynchronously
 -------------------------------
 

data/examples/no-introspect/call-overloaded.rb

@@ -0,0 +1,22 @@
+#!/usr/bin/env ruby
+#
+# How to call overloaded methods.
+
+require 'dbus'
+
+bus = DBus::SessionmBus.instance
+
+konsole_svc = bus["org.freedesktop.konsole"]
+konsole_obj = konsole_svc["/Konsole"]
+poi = DBus::ProxyObjectInterface.new(konsole_obj, "org.kde.konsole.Konsole")
+
+
+begin
+  poi.define_method("getDevices", "") # NM 0.6
+  p poi.getDevices
+rescue Exception
+  poi.define_method("GetDevices", "") # NM 0.7
+  p poi.GetDevices
+end
+
+

data/examples/simple/properties.rb

@@ -0,0 +1,19 @@
+#! /usr/bin/env ruby
+require 'dbus'
+
+bus = DBus::SystemBus.instance
+nm_service = bus["org.freedesktop.NetworkManager"]
+network_manager_object = nm_service.object("/org/freedesktop/NetworkManager")
+network_manager_object.introspect
+nm_iface = network_manager_object["org.freedesktop.NetworkManager"]
+
+# read a property
+enabled = nm_iface["WirelessEnabled"]
+if enabled
+  puts "Wireless is enabled"
+else
+  puts "Wireless is disabled"
+end
+puts "Toggling wireless"
+# write a property
+nm_iface["WirelessEnabled"] = ! enabled

data/lib/dbus.rb

@@ -64,14 +64,6 @@ module DBus
   class IncompleteBufferException < Exception
   end
 
-  # Exception raised when an interface is not implemented.
-  class InterfaceNotImplemented < Exception
-  end
-
-  # Exception raised when an method is not found in the interface.
-  class MethodNotInInterface < Exception
-  end
-
   # Exception raised when a method has not been implemented (yet).
   class MethodNotImplemented < Exception
   end

data/lib/dbus/bus.rb

@@ -427,8 +427,8 @@ module DBus
         pof = DBus::ProxyObjectFactory.new(data, self, dest, path)
         return pof.build
       else
-        introspect_data(dest, path) do |data|
-          yield(DBus::ProxyObjectFactory.new(data, self, dest, path).build)
+        introspect_data(dest, path) do |async_data|
+          yield(DBus::ProxyObjectFactory.new(async_data, self, dest, path).build)
         end
       end
     end

data/lib/dbus/export.rb

@@ -11,18 +11,6 @@
 require 'thread'
 
 module DBus
-  # Exception raised when an interface cannot be found in an object.
-  class InterfaceNotInObject < Exception
-  end
-
-  # Exception raised when a method cannot be found in an inferface.
-  class MethodNotInInterface < Exception
-  end
-
-  # Method raised when a method returns an invalid return type.
-  class InvalidReturnType < Exception
-  end
-
   # Exported object type
   # = Exportable D-Bus object class
   #
@@ -55,14 +43,18 @@ module DBus
     def dispatch(msg)
       case msg.message_type
       when Message::METHOD_CALL
-        if not self.intfs[msg.interface]
-          raise InterfaceNotInObject, msg.interface
-        end
-        meth = self.intfs[msg.interface].methods[msg.member.to_sym]
-        raise MethodNotInInterface if not meth
-        methname = Object.make_method_name(msg.interface, msg.member)
         reply = nil
         begin
+          if not self.intfs[msg.interface]
+            raise DBus.error("org.freedesktop.DBus.Error.UnknownMethod"),
+            "Interface \"#{msg.interface}\" of object \"#{msg.path}\" doesn't exist"
+          end
+          meth = self.intfs[msg.interface].methods[msg.member.to_sym]
+          if not meth
+            raise DBus.error("org.freedesktop.DBus.Error.UnknownMethod"),
+            "Method \"#{msg.member}\" on interface \"#{msg.interface}\" of object \"#{msg.path}\" doesn't exist"
+          end
+          methname = Object.make_method_name(msg.interface, msg.member)
           retdata = method(methname).call(*msg.params)
           retdata =  [*retdata]
 

data/lib/dbus/introspect.rb

@@ -422,6 +422,23 @@ module DBus
         bus.add_match(mr) { |msg| block.call(*msg.params) }
       end
     end
+
+    PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties"
+
+    # Read a property.
+    def [](propname)
+      self.object[PROPERTY_INTERFACE].Get(self.name, propname)[0]
+    end
+
+    # Write a property.
+    def []=(propname, value)
+      self.object[PROPERTY_INTERFACE].Set(self.name, propname, value)
+    end
+
+    # Read all properties at once, as a hash.
+    def all_properties
+      self.object[PROPERTY_INTERFACE].GetAll(self.name)[0]
+    end
   end # class ProxyObjectInterface
 
   # D-Bus proxy object class

data/lib/dbus/message.rb

@@ -295,7 +295,7 @@ module DBus
     end
 
     def self.from_exception(ex)
-      name = if ex.respond_to? :name
+      name = if ex.is_a? DBus::Error
                ex.name
              else
                "org.freedesktop.DBus.Error.Failed"

data/ruby-dbus.gemspec

@@ -10,7 +10,7 @@ GEMSPEC = Gem::Specification.new do |s|
   s.version = File.read("VERSION").strip
   s.author = "Ruby DBus Team"
   s.email = "ruby-dbus-devel@lists.luon.net"
-  s.homepage = "http://trac.luon.net/data/ruby-dbus/"
+  s.homepage = "https://trac.luon.net/ruby-dbus"
   s.files = FileList["{doc/tutorial,examples,lib,test}/**/*", "Rakefile", "ruby-dbus.gemspec", "VERSION"].to_a.sort
   s.require_path = "lib"
   s.has_rdoc = true

data/test/property_test.rb

@@ -0,0 +1,55 @@
+#!/usr/bin/env ruby
+require "test/unit"
+require "dbus"
+
+class PropertyTest < Test::Unit::TestCase
+  def setup
+    session_bus = DBus::SessionBus.instance
+    svc = session_bus.service("org.ruby.service")
+    @obj = svc.object("/org/ruby/MyInstance")
+    @obj.introspect
+    @iface = @obj["org.ruby.SampleInterface"]
+  end
+
+  def test_property_reading
+    assert_equal "READ ME", @iface["ReadMe"]
+  end
+
+  def test_property_nonreading
+    e = assert_raises DBus::Error do
+      @iface["WriteMe"]
+    end
+    assert_match(/not readable/, e.to_s)
+  end
+
+  def test_property_writing
+    @iface["ReadOrWriteMe"] = "VALUE"
+    assert_equal "VALUE", @iface["ReadOrWriteMe"]
+  end
+
+  def test_property_nonwriting
+    e = assert_raises DBus::Error do
+      @iface["ReadMe"] = "WROTE"
+    end
+    assert_match(/not writable/, e.to_s)
+  end
+
+  def test_get_all
+    all = @iface.all_properties
+    assert_equal ["ReadMe", "ReadOrWriteMe"], all.keys.sort
+  end
+
+  def test_unknown_property_reading
+    e = assert_raises DBus::Error do
+      @iface["Spoon"]
+    end
+    assert_match(/not found/, e.to_s)
+  end
+
+  def test_unknown_property_writing
+    e = assert_raises DBus::Error do
+      @iface["Spoon"] = "FORK"
+    end
+    assert_match(/not found/, e.to_s)
+  end
+end

data/test/server_robustness_test.rb

@@ -38,4 +38,35 @@ class ServerRobustnessTest < Test::Unit::TestCase
   rescue DBus::Error => e
     assert_no_match(/timeout/, e.to_s)
   end
+
+  def test_a_method_that_raises_name_error
+    obj = @svc.object "/org/ruby/MyInstance"
+    obj.introspect
+    obj.default_iface = "org.ruby.SampleInterface"
+    obj.will_raise_name_error
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_no_match(/timeout/, e.to_s)
+  end
+
+  # https://trac.luon.net/ruby-dbus/ticket/31#comment:3
+  def test_no_such_method_without_introspection
+    obj = @svc.object "/org/ruby/MyInstance"
+    ifc = DBus::ProxyObjectInterface.new(obj, "org.ruby.SampleInterface")
+    ifc.define_method("not_the_answer", "out n:i")
+    ifc.not_the_answer
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_no_match(/timeout/, e)
+  end
+
+  def test_no_such_interface_without_introspection
+    obj = @svc.object "/org/ruby/MyInstance"
+    ifc = DBus::ProxyObjectInterface.new(obj, "org.ruby.NoSuchInterface")
+    ifc.define_method("the_answer", "out n:i")
+    ifc.the_answer
+    assert false, "should have raised"
+  rescue DBus::Error => e
+    assert_no_match(/timeout/, e)
+  end
 end

data/test/service_newapi.rb

@@ -9,9 +9,18 @@ def d(msg)
   puts "#{$$} #{msg}" if $DEBUG
 end
 
+PROPERTY_INTERFACE = "org.freedesktop.DBus.Properties"
+
 class Test < DBus::Object
+  INTERFACE = "org.ruby.SampleInterface"
+  def initialize(path)
+    super path
+    @read_me = "READ ME"
+    @read_or_write_me = "READ OR WRITE ME"
+  end
+
   # Create an interface aggregating all upcoming dbus_method defines.
-  dbus_interface "org.ruby.SampleInterface" do
+  dbus_interface INTERFACE do
     dbus_method :hello, "in name:s, in name2:s" do |name, name2|
       puts "hello(#{name}, #{name2})"
     end
@@ -40,6 +49,10 @@ class Test < DBus::Object
       raise DBus.error, "failed as designed"
     end
 
+    dbus_method :will_raise_name_error, "" do
+      "foo".frobnicate
+    end
+
     dbus_method :Error, "in name:s, in description:s" do |name, description|
       raise DBus.error(name), description
     end
@@ -81,6 +94,61 @@ class Test < DBus::Object
 
     dbus_signal :LongTaskEnd
   end
+
+  # Properties:
+  # ReadMe:string, returns "READ ME" at first, then what WriteMe received
+  # WriteMe:string
+  # ReadOrWriteMe:string, returns "READ OR WRITE ME" at first
+  dbus_interface PROPERTY_INTERFACE do
+    dbus_method :Get, "in interface:s, in propname:s, out value:v" do |interface, propname|
+      if interface == INTERFACE
+        if propname == "ReadMe"
+          [@read_me]
+        elsif propname == "ReadOrWriteMe"
+          [@read_or_write_me]
+        elsif propname == "WriteMe"
+          raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"), "Property '#{interface}.#{propname}' (on object '#{@path}') is not readable"
+        else
+          raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"), "Property '#{interface}.#{propname}' not found on object '#{@path}'"
+        end
+      else
+        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"), "Interface '#{interface}' not found on object '#{@path}'"
+      end
+# what should happen for unknown properties
+# plasma: InvalidArgs (propname), UnknownInterface (interface)
+    end
+
+    dbus_method :Set, "in interface:s, in propname:s, in  value:v" do |interface, propname, value|
+      if interface == INTERFACE
+        if propname == "ReadMe"
+          raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"), "Property '#{interface}.#{propname}' (on object '#{@path}') is not writable"
+        elsif propname == "ReadOrWriteMe"
+          @read_or_write_me = value
+          self.PropertiesChanged(interface, {propname => value}, [])
+        elsif propname == "WriteMe"
+          @read_me = value
+          self.PropertiesChanged(interface, {"ReadMe" => value}, [])
+        else
+          raise DBus.error("org.freedesktop.DBus.Error.InvalidArgs"), "Property '#{interface}.#{propname}' not found on object '#{@path}'"
+        end
+      else
+        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"), "Interface '#{interface}' not found on object '#{@path}'"
+      end
+    end
+
+    dbus_method :GetAll, "in interface:s, out value:a{sv}" do |interface|
+      if interface == INTERFACE
+        [ {
+            "ReadMe" => @read_me,
+            "ReadOrWriteMe" =>@read_or_write_me,
+          } ]
+      else
+        raise DBus.error("org.freedesktop.DBus.Error.UnknownInterface"), "Interface '#{interface}' not found on object '#{@path}'"
+      end
+    end
+
+    dbus_signal :PropertiesChanged, "interface:s, changed_properties:a{sv}, invalidated_properties:as"
+  end
 end
 
 class Derived < Test

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-dbus
 version: !ruby/object:Gem::Version 
-  hash: 11
+  hash: 7
   prerelease: false
   segments: 
   - 0
-  - 5
+  - 6
   - 0
-  version: 0.5.0
+  version: 0.6.0
 platform: ruby
 authors: 
 - Ruby DBus Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2010-11-07 00:00:00 +01:00
+date: 2010-12-10 00:00:00 +01:00
 default_executable: 
 dependencies: []
 
@@ -37,12 +37,14 @@ files:
 - examples/gdbus/gdbus
 - examples/gdbus/gdbus.glade
 - examples/gdbus/launch.sh
+- examples/no-introspect/call-overloaded.rb
 - examples/no-introspect/nm-test.rb
 - examples/no-introspect/tracker-test.rb
 - examples/rhythmbox/playpause.rb
 - examples/service/call_service.rb
 - examples/service/service_newapi.rb
 - examples/simple/call_introspect.rb
+- examples/simple/properties.rb
 - examples/utils/listnames.rb
 - examples/utils/notify.rb
 - lib/dbus.rb
@@ -63,6 +65,7 @@ files:
 - test/bus_driver_test.rb
 - test/dbus-launch-simple
 - test/dbus-limited-session.conf
+- test/property_test.rb
 - test/server_robustness_test.rb
 - test/server_test.rb
 - test/service_newapi.rb
@@ -80,7 +83,7 @@ files:
 - README
 - NEWS
 has_rdoc: true
-homepage: http://trac.luon.net/data/ruby-dbus/
+homepage: https://trac.luon.net/ruby-dbus
 licenses: []
 
 post_install_message: