ruby-dbus 0.7.2 → 0.8.0

data/NEWS

@@ -5,6 +5,25 @@ 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.8.0 - 2012-09-20
+
+Features:
+ * Add Anonymous authentication (Issue#27, by Walter Brebels).
+ * Use Nokogiri for XML parsing when available (Issue#24, by Geoff Youngs).
+
+Bug fixes:
+ * Use SCM_CREDS authentication only on FreeBSD, not on OpenBSD (Issue#21,
+   reported by Adde Nilsson).
+ * Recognize signature "h" (UNIX_FD) used eg. by Upstart (Issue#23,
+   by Bernd Ahlers).
+ * Find the session bus also via launchd, on OS X (Issue#20, reported
+   by Paul Sturgess).
+
+Other:
+ * Now doing continuous integration with Travis:
+     http://travis-ci.org/#!/mvidner/ruby-dbus
+
+
 == Ruby D-Bus 0.7.2 - 2012-04-05
 
 A brown-paper-bag release.

data/Rakefile

@@ -28,7 +28,7 @@ end
   desc "Run bare:#{tname} in the proper environment"
   task tname do |t|
     cd "test" do
-      system "./test_env rake bare:#{tname}"
+      sh "./test_env rake bare:#{tname}"
     end
   end
 end

data/VERSION

@@ -1 +1 @@
-0.7.2
+0.8.0

data/lib/dbus.rb

@@ -17,6 +17,7 @@ require 'dbus/marshall'
 require 'dbus/message'
 require 'dbus/matchrule'
 require 'dbus/auth'
+require 'dbus/xml'
 
 require 'socket'
 require 'thread'

data/lib/dbus/auth.rb

@@ -23,6 +23,13 @@ module DBus
     end
   end
 
+  # = Anonymous authentication class
+  class Anonymous < Authenticator
+    def authenticate
+      '527562792044427573' # Hex encoded version of "Ruby DBus"
+    end
+  end
+
   # = External authentication class 
   #
   # Class for 'external' type authentication.
@@ -115,12 +122,12 @@ module DBus
     def initialize(socket)
       @socket = socket
       @state = nil
-      @auth_list = [External,DBusCookieSHA1]
+      @auth_list = [External,DBusCookieSHA1,Anonymous]
     end
 
     # Start the authentication process.
     def authenticate
-      if (RbConfig::CONFIG["target_os"] =~ /bsd/)
+      if (RbConfig::CONFIG["target_os"] =~ /freebsd/)
         @socket.sendmsg(0.chr, 0, nil, [:SOCKET, :SCM_CREDS, ""])
       else
         @socket.write(0.chr)

data/lib/dbus/bus.rb

@@ -225,6 +225,8 @@ module DBus
           connect_to_unix kv_hash
           when "tcp"
           connect_to_tcp kv_hash
+          when "launchd"
+          connect_to_launchd kv_hash
           else
           # ignore, report?
         end
@@ -271,6 +273,12 @@ module DBus
       init_connection
     end
 
+    def connect_to_launchd(params)
+      socket_var = params['env']
+      socket = `launchctl getenv #{socket_var}`.chomp
+      connect_to_unix 'path' => socket
+    end
+
     # Send the buffer _buf_ to the bus using Connection#writel.
     def send(buf)
       @socket.write(buf) unless @socket.nil?
@@ -510,7 +518,7 @@ module DBus
       begin
         ret, size = Message.new.unmarshall_buffer(@buffer)
         @buffer.slice!(0, size)
-      rescue IncompleteBufferException => e
+      rescue IncompleteBufferException
         # fall through, let ret be null
       end
       ret
@@ -531,7 +539,6 @@ module DBus
     # Update the buffer and retrieve all messages using Connection#messages.
     # Return the messages.
     def poll_messages
-      ret = nil
       r, d, d = IO.select([@socket], nil, nil, 0)
       if r and r.size > 0
         update_buffer
@@ -719,7 +726,7 @@ module DBus
   class ASessionBus < Connection
     # Get the the default session bus.
     def initialize
-      super(ENV["DBUS_SESSION_BUS_ADDRESS"] || address_from_file)
+      super(ENV["DBUS_SESSION_BUS_ADDRESS"] || address_from_file || "launchd:env=DBUS_LAUNCHD_SESSION_BUS_SOCKET")
       connect
       send_hello
     end
@@ -734,6 +741,8 @@ module DBus
           return $1
         end
       end
+    rescue Errno::ENOENT
+      nil
     end
   end
 

data/lib/dbus/introspect.rb

@@ -8,9 +8,6 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
-# TODO check if it is slow, make replaceable
-require 'rexml/document'
-
 module DBus
   # Regular expressions that should match all method names.
   MethodSignalRE = /^[A-Za-z][A-Za-z0-9_]*$/
@@ -219,82 +216,6 @@ module DBus
     end
   end # class Signal
 
-  # = D-Bus introspect XML parser class
-  #
-  # This class parses introspection XML of an object and constructs a tree
-  # of Node, Interface, Method, Signal instances.
-  class IntrospectXMLParser
-    # Creates a new parser for XML data in string _xml_.
-    def initialize(xml)
-      @xml = xml
-    end
-
-    # return the names of direct subnodes
-    def parse_subnodes
-      subnodes = Array.new
-      d = REXML::Document.new(@xml)
-      d.elements.each("node/node") do |e|
-        subnodes << e.attributes["name"]
-      end
-      subnodes
-    end
-
-    # return a pair: [list of Interfaces, list of direct subnode names]
-    def parse
-      interfaces = Array.new
-      subnodes = Array.new
-      t = Time.now
-      d = REXML::Document.new(@xml)
-      d.elements.each("node/node") do |e|
-        subnodes << e.attributes["name"]
-      end
-      d.elements.each("node/interface") do |e|
-        i = Interface.new(e.attributes["name"])
-        e.elements.each("method") do |me|
-          m = Method.new(me.attributes["name"])
-          parse_methsig(me, m)
-          i << m
-        end
-        e.elements.each("signal") do |se|
-          s = Signal.new(se.attributes["name"])
-          parse_methsig(se, s)
-          i << s
-        end
-        interfaces << i
-      end
-      d = Time.now - t
-      if d > 2
-        puts "Some XML took more that two secs to parse. Optimize me!" if $DEBUG
-      end
-      [interfaces, subnodes]
-    end
-
-    ######################################################################
-    private
-
-    # Parses a method signature XML element _e_ and initialises
-    # method/signal _m_.
-    def parse_methsig(e, m)
-      e.elements.each("arg") do |ae|
-        name = ae.attributes["name"]
-        dir = ae.attributes["direction"]
-        sig = ae.attributes["type"]
-	if m.is_a?(DBus::Signal)
-          m.add_fparam(name, sig)
-	elsif m.is_a?(DBus::Method)
-          case dir
-          when "in"
-            m.add_fparam(name, sig)
-          when "out"
-	    m.add_return(name, sig)
-	  end
-        else
-          raise NotImplementedError, dir
-        end
-      end
-    end
-  end # class IntrospectXMLParser
-
   # = D-Bus proxy object interface class
   #
   # A class similar to the normal Interface used as a proxy for remote

data/lib/dbus/marshall.rb

@@ -146,7 +146,7 @@ module DBus
         if (packet & 0x8000) != 0
           packet -= 0x10000
         end
-      when Type::UINT32
+      when Type::UINT32, Type::UNIX_FD
         align(4)
         packet = get(4).unpack(@uint32)[0]
       when Type::INT32
@@ -317,7 +317,7 @@ module DBus
       case type.sigtype
       when Type::BYTE
         @packet += val.chr
-      when Type::UINT32
+      when Type::UINT32, Type::UNIX_FD
         align(4)
         @packet += [val].pack("L")
       when Type::UINT64

data/lib/dbus/message.rb

@@ -240,7 +240,7 @@ module DBus
       end
       pu = PacketUnmarshaller.new(buf, endianness)
       mdata = pu.unmarshall(MESSAGE_SIGNATURE)
-      dummy, @message_type, @flags, @protocol, @body_length, @serial, 
+      _, @message_type, @flags, @protocol, @body_length, @serial, 
         headers = mdata
 
       headers.each do |struct|
@@ -274,7 +274,7 @@ module DBus
     # Message#unmarshall_buf.
     # Return the message.
     def unmarshall(buf)
-      ret, size = unmarshall_buffer(buf)
+      ret, _ = unmarshall_buffer(buf)
       ret
     end
   end # class Message

data/lib/dbus/type.rb

@@ -33,6 +33,7 @@ module Type
   STRING = ?s
   SIGNATURE = ?g
   DICT_ENTRY = ?e
+  UNIX_FD = ?h
 
   # Mapping from type number to name.
   TypeName = {
@@ -52,7 +53,8 @@ module Type
     OBJECT_PATH => "OBJECT_PATH",
     STRING => "STRING",
     SIGNATURE => "SIGNATURE",
-    DICT_ENTRY => "DICT_ENTRY"
+    DICT_ENTRY => "DICT_ENTRY",
+    UNIX_FD => "UNIX_FD"
   }
 
   # Exception raised when an unknown/incorrect type is encountered.
@@ -96,6 +98,7 @@ module Type
         OBJECT_PATH => 4,
         STRING => 4,
         SIGNATURE => 1,
+        UNIX_FD => 4,
       }[@sigtype]
     end
 

data/lib/dbus/xml.rb

@@ -0,0 +1,156 @@
+# dbus/xml.rb - introspection parser, rexml/nokogiri abstraction
+#
+# This file is part of the ruby-dbus project
+# Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
+# Copyright (C) 2012 Geoff Youngs
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License, version 2.1 as published by the Free Software Foundation.
+# See the file "COPYING" for the exact licensing terms.
+
+# TODO check if it is slow, make replaceable
+require 'rexml/document'
+begin
+require 'nokogiri'
+rescue LoadError
+end
+
+module DBus
+  # = D-Bus introspect XML parser class
+  #
+  # This class parses introspection XML of an object and constructs a tree
+  # of Node, Interface, Method, Signal instances.
+  class IntrospectXMLParser
+    class << self
+      attr_accessor :backend
+    end
+    # Creates a new parser for XML data in string _xml_.
+    def initialize(xml)
+      @xml = xml
+    end
+
+    class AbstractXML
+      def self.have_nokogiri?
+        Object.const_defined?('Nokogiri')
+      end
+      class Node
+        def initialize(node)
+          @node = node
+        end
+        # required methods
+        # returns node attribute value
+        def [](key)
+        end
+        # yields child nodes which match xpath of type AbstractXML::Node
+        def each(xpath)
+        end
+      end
+      # required methods
+      # initialize parser with xml string
+      def initialize(xml)
+      end
+      # yields nodes which match xpath of type AbstractXML::Node
+      def each(xpath)
+      end
+    end
+
+    class NokogiriParser < AbstractXML
+      class NokogiriNode < AbstractXML::Node
+        def [](key)
+          @node[key]
+        end
+        def each(path, &block)
+          @node.search(path).each { |node| block.call NokogiriNode.new(node) }
+        end
+      end
+      def initialize(xml)
+        @doc = Nokogiri.XML(xml)
+      end
+      def each(path, &block)
+        @doc.search("//#{path}").each { |node| block.call NokogiriNode.new(node) }
+      end
+    end
+
+    class REXMLParser < AbstractXML
+      class REXMLNode < AbstractXML::Node
+        def [](key)
+          @node.attributes[key]
+        end
+        def each(path, &block)
+          @node.elements.each(path) { |node| block.call REXMLNode.new(node) }
+        end
+      end
+      def initialize(xml)
+        @doc = REXML::Document.new(xml)
+      end
+      def each(path, &block)
+        @doc.elements.each(path) { |node| block.call REXMLNode.new(node) }
+      end
+    end
+
+    if AbstractXML.have_nokogiri?
+      @backend = NokogiriParser
+    else
+      @backend = REXMLParser
+    end
+
+    # return a pair: [list of Interfaces, list of direct subnode names]
+    def parse
+      interfaces = Array.new
+      subnodes = Array.new
+      t = Time.now
+
+
+      d = IntrospectXMLParser.backend.new(@xml)
+      d.each("node/node") do |e|
+        subnodes << e["name"]
+      end
+      d.each("node/interface") do |e|
+        i = Interface.new(e["name"])
+        e.each("method") do |me|
+          m = Method.new(me["name"])
+          parse_methsig(me, m)
+          i << m
+        end
+        e.each("signal") do |se|
+          s = Signal.new(se["name"])
+          parse_methsig(se, s)
+          i << s
+        end
+        interfaces << i
+      end
+      d = Time.now - t
+      if d > 2
+        puts "Some XML took more that two secs to parse. Optimize me!" if $DEBUG
+      end
+      [interfaces, subnodes]
+    end
+
+    ######################################################################
+    private
+
+    # Parses a method signature XML element _e_ and initialises
+    # method/signal _m_.
+    def parse_methsig(e, m)
+      e.each("arg") do |ae|
+        name = ae["name"]
+        dir = ae["direction"]
+        sig = ae["type"]
+	if m.is_a?(DBus::Signal)
+          m.add_fparam(name, sig)
+	elsif m.is_a?(DBus::Method)
+          case dir
+          when "in"
+            m.add_fparam(name, sig)
+          when "out"
+	    m.add_return(name, sig)
+	  end
+        else
+          raise NotImplementedError, dir
+        end
+      end
+    end
+  end # class IntrospectXMLParser
+end # module DBus
+

data/test/bus_and_xml_backend_test.rb

@@ -0,0 +1,42 @@
+#!/usr/bin/env ruby
+# Test the bus class
+require "test/unit"
+require 'rubygems'
+require 'nokogiri'
+require "dbus"
+
+class BusAndXmlBackendTest < Test::Unit::TestCase
+  def setup
+    @bus = DBus::ASessionBus.new
+  end
+
+  def test_introspection_reading_rexml
+    DBus::IntrospectXMLParser.backend = DBus::IntrospectXMLParser::REXMLParser
+    @svc = @bus.service("org.ruby.service")
+    obj = @svc.object("/org/ruby/MyInstance")
+    obj.default_iface = 'org.ruby.SampleInterface'
+    obj.introspect
+    assert_nothing_raised do
+      assert_equal 42, obj.the_answer[0], "should respond to :the_answer"
+    end
+    assert_nothing_raised do
+      assert_equal "oof", obj["org.ruby.AnotherInterface"].Reverse('foo')[0], "should work with multiple interfaces"
+    end
+  end
+
+  def test_introspection_reading_nokogiri
+    # peek inside the object to see if a cleanup step worked or not
+    DBus::IntrospectXMLParser.backend = DBus::IntrospectXMLParser::NokogiriParser
+    @svc = @bus.service("org.ruby.service")
+    obj = @svc.object("/org/ruby/MyInstance")
+    obj.default_iface = 'org.ruby.SampleInterface'
+    obj.introspect
+    assert_nothing_raised do
+      assert_equal 42, obj.the_answer[0], "should respond to :the_answer"
+    end
+    assert_nothing_raised do
+      assert_equal "oof", obj["org.ruby.AnotherInterface"].Reverse('foo')[0], "should work with multiple interfaces"
+    end
+  end
+
+end

data/test/server_test.rb

@@ -10,7 +10,7 @@ class Foo < DBus::Object
   end
 
   dbus_signal :signal_without_interface
-rescue DBus::Object::UndefinedInterface => e
+rescue DBus::Object::UndefinedInterface
   # raised by the preceding signal declaration
 end
 

data/test/signal_test.rb

@@ -46,6 +46,7 @@ class SignalHandlerTest < Test::Unit::TestCase
       @loop.quit
     end
     @loop.run
+    quitter.join
 
     assert_equal 1, counter
   end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: ruby-dbus
 version: !ruby/object:Gem::Version 
-  hash: 7
+  hash: 63
   prerelease: 
   segments: 
   - 0
-  - 7
-  - 2
-  version: 0.7.2
+  - 8
+  - 0
+  version: 0.8.0
 platform: ruby
 authors: 
 - Ruby DBus Team
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2012-04-05 00:00:00 Z
+date: 2012-09-20 00:00:00 Z
 dependencies: []
 
 description: 
@@ -54,9 +54,11 @@ files:
 - lib/dbus/matchrule.rb
 - lib/dbus/message.rb
 - lib/dbus/type.rb
+- lib/dbus/xml.rb
 - ruby-dbus.gemspec
 - test/async_test.rb
 - test/binding_test.rb
+- test/bus_and_xml_backend_test.rb
 - test/bus_driver_test.rb
 - test/bus_test.rb
 - test/dbus-launch-simple