rbus 0.1.0 → 0.1.1

data/CHANGELOG.txt

@@ -1,9 +1,15 @@
 =CHANGELOG
 
-  RBus 0.1.0  2007-03-28
+  R-Bus 0.1.1  2007-03-30
+  * Signature guessing code
+  * Support for dbus-send style arguments
+  * Tutorial updates
+  * Bugfixes and more tests
+
+  R-Bus 0.1.0  2007-03-28
   * Released as Rubygem
   * Added rbus-send application
   * Bugfixes and other updates
 
-  RBus 0.0.1  2007-03-26
+  R-Bus 0.0.1  2007-03-26
   * Initial release (source only)

data/Manifest.txt

@@ -28,6 +28,7 @@ lib/rbus/bus/bus.rb
 lib/rbus/bus/proxy.rb
 lib/rbus/bus/transport.rb
 lib/rbus/default.rb
+lib/rbus/etc/blankslate.rb
 lib/rbus/etc/exception.rb
 lib/rbus/etc/log.rb
 lib/rbus/etc/types.rb

data/TUTORIAL.txt

@@ -101,17 +101,64 @@ Some examples of method calls:
 
 == Signatures, introspection and data types
 
-D-Bus
-{defines a number of standard data types}[http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-signatures]
-that can be used to send and receive data between applications.
-R-Bus is able to use Rubys standard types for the most part, as long as there is
-a signature available for the conversion. When a new Proxy object is created,
-R-Bus will ask the remote application for a list of methods and signatures via
-the standard methos +Introspect+. If the application provides such a list,
-everything should just work. :)
-
-If the introspection fails, the Proxy object may not know how to call the
-method. In this case you can add the method manually with +method!+:
+D-Bus defines a number of standard
+{data types}[http://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-signatures]
+that can be used to send and receive data between applications. Each method and
+signal has a signature that shows how many arguments and of what types it
+expects and/or returns. A few examples of signatures: 
+
+[+s+] a String
+[+ui+] Uint32, Int32
+[+as+] Array of Strings
+[<tt>a{sas}</tt>] Dict, or Hash in Ruby, with String keys and Arrays of Strings as values.
+
+R-Bus is able to use Rubys standard types without any conversion for the most
+part, as long as there is a known signature available for the conversion. This
+signature can be obtained in a number of ways, and the library tries really
+hard to find one:
+
+When a new Proxy object is created, R-Bus will ask the remote application for a
+list of methods and signatures via the standard method +Introspect+. If the 
+application provides such a list (and most do), everything should just work. :)
+
+If the introspection fails, the library tries to guess the signature from the
+arguments the method was called with. It will handle most types except integers
+automatically, as long as the structures aren't too complex. Currently, these
+Ruby classes are properly handled:
+
+* String - D-Bus string
+* Symbol - D-Bus string
+* TrueClass and FalseClass - D-Bus boolean
+* Float - D-Bus double
+* Hash - D-Bus array of dicts
+  * can not be empty, needs at least one key/value pair
+* Array
+  * D-Bus array if all values have the same signature (symbol and string is
+    considered to be the same)
+  * D-Bus struct if there are mixed values
+  * can't handle array of containers
+
+So, a call like:
+
+  object.Method({:key => ['value'], 'key2' => ['value']})
+
+will result in the signature <tt>a{sas}</tt>. And so on.
+
+Also, you can manually give any arguments in the same form as <em>rbus-send</em>
+(and <em>dbus-send</em>) accepts. This is the value, as a string, prefixed with
+the name of the type and a colon:
+
+  string:'some string'
+  uint32:42
+  int16:-25
+  array:string:'foo','bar'
+  dict:string:uint32:'foo',32,'bar',64
+
+See the section on rbus-send at the bottom of this document for the
+specification of the format and some examples.
+
+If all this fails, finally you can add the method manually with
+<tt>method!</tt>:
 
   obj.method!(:MethodName, 'as')
 
@@ -237,13 +284,18 @@ currently missing.</em>
 === rbus-send
 
 R-Bus comes with its own variant of <em>dbus-send</em>, called 
-<em>{rbus-send}[link:files/bin/rbus-send.html]</em>, which should be pretty much compatible, except for these 
-known issues:
+<em>{rbus-send}[link:files/bin/rbus-send.html]</em>, which should be pretty much
+compatible, except for:
 
 * There is no <tt>--reply-timeout</tt>. Trivial to fix in seconds, though
-  milli-seconds may not be.
+  milli-seconds may not be. Will be added.
 * Currently dumps the any server answer in YAML[http://www.yaml.org/] instead of
   the dbus-send format.
+* Does not demand that an interface be specified, meaning you can call, as an
+  example, the method <tt>Introspect</tt> instead of the qualified
+  <tt>org.freedesktop.DBus.Introspectable.Introspect</tt>, as long as the
+  method is unique in the object. As the specification clearly allows this for
+  any client, I consider this a feature.
 
 The invokation looks like this:
 

data/bin/rbus-send

@@ -49,55 +49,6 @@ require 'optparse'
 require 'rbus'
 require 'yaml'
 
-def make_signature # :nodoc:
-  translation = {
-    'byte'      => 'y',
-    'boolean'   => 'b',
-    'int16'     => 'n',
-    'uint16'    => 'q',
-    'int32'     => 'i',
-    'uint32'    => 'u',
-    'int64'     => 'x',
-    'uint64'    => 't',
-    'double'    => 'd',
-    'string'    => 's',
-    'objpath'   => 'o',
-    'signature' => 'g',
-    'variant'   => 'v',
-    'array'     => 'a',
-    'dict'      => 'a{',
-  }
-
-  signature = ''
-  array = false
-  
-  ARGV.map!{|a|
-    type, arg = a.split(':',2)
-    fail "Unknown type '#{type}'" unless translation.has_key?(type)
-    signature << translation[type]
-    case type
-      when 'dict'
-        key,value,arg = arg.split(':',3)
-        signature << translation[key]
-        signature << translation[value]
-        signature << '}'
-        arg.nil? ? {} : Hash[*arg.split(',')]
-      when 'array'
-        array = true
-        a = arg
-        redo
-      when 'variant'
-        a = arg
-        redo
-      else
-        rv = (array) ? arg.split(',') : arg 
-        array = false
-        rv
-    end
-  }
-  signature
-end
-
 klass = RBus::Signal
 destination = nil
 bus = nil
@@ -113,7 +64,7 @@ opts = OptionParser.new do |opts|
   }
   
   opts.on('--print-reply', 
-          'Block for a reply to the message sent, and print any reply received.') {
+          'Wait for, and print reply.') {
     print_reply = true
     klass = RBus::MethodCall
   }
@@ -122,7 +73,7 @@ opts = OptionParser.new do |opts|
     bus = RBus.system_bus
   }
   
-  opts.on('--session', 'Send to the session message bus. (This is the default.)') {
+  opts.on('--session', 'Send to the session message bus. (default.)') {
     bus = RBus.session_bus
   }
   
@@ -135,6 +86,10 @@ opts = OptionParser.new do |opts|
   }
 end
 
+opts.version = RBus::VERSION::STRING
+opts.summary_width = 18
+opts.summary_indent = ""
+
 opts.parse!
 
 if ARGV.length < 2
@@ -146,20 +101,11 @@ object_path = ARGV.shift
 member,interface = ARGV.shift.reverse.split('.',2).map{|s|s.reverse}
 
 bus = RBus.session_bus if bus.nil?
-
-message = klass.new do |m|
-  m.destination = destination
-  m.object_path = object_path
-  m.interface = interface
-  m.member = member
-  m.signature = make_signature
-  m.arguments = ARGV
-end
-
-#puts YAML.dump(message);exit
+object = bus.get_object(destination, object_path)
+object.interface!(interface)
 
 if print_reply
-  puts YAML.dump(bus.message_loop.send_message(message, nil))
+  puts YAML.dump(object.__send__(member, *ARGV))
 else
-  bus.message_loop.send_message(message, lambda{})
+  object.__send__(member, *ARGV){}
 end

data/examples/hal_device_info.rb

@@ -26,6 +26,9 @@
 # RBus Example:
 # Get information about a random HAL device.
 #
+# At least in my version, HAL does not provide introspection, but
+# the library now handles guessing a lot of arguments automatically.
+#
 
 # Add lib to load path during development
 $: << '../lib/'
@@ -46,9 +49,5 @@ random = devs[rand(devs.size)]
 random_device = bus.get_object('org.freedesktop.Hal',random)
 random_device.interface!('org.freedesktop.Hal.Device')
 
-# Define method manually, as HAL doesn't provide introspection, at least
-# in my version.
-random_device.method!(:GetProperty, 's')
-
 # Print info and device path:
 puts ("#{random_device.GetProperty('info.product')} (#{random})")

data/lib/rbus/bus/bus.rb

@@ -46,9 +46,8 @@ module RBus
   # Represents a connection to a Bus. It is also a Proxy object for
   # sending messages to the bus itself.
   class Bus < Proxy
-    NAMES = []
     
-    attr_reader :message_loop
+    attr_reader :message_loop, :transport, :names
     
     # Connect to Bus with +server_address+, which can contain multiple
     # addresses to try, separated by semicolons.
@@ -63,17 +62,16 @@ module RBus
       # Not used for anything, save at all?
       @guid = Auth.authorize(@transport)
 
-      # Start main message loop.
-      #@message_loop = Message::Loop.new(@transport).run
-      @message_loop = Mainloop.new(@transport)
+      # Setup mainloop.
+      @message_loop = Mainloop.new(self)
       
       @well_known_name = 'org.freedesktop.DBus'
       @object_path = '/org/freedesktop/DBus'
       @interface = 'org.freedesktop.DBus'
-      NAMES << Hello()
+      @names = [ Hello() ]
       Introspect()
 
-      Log.debug('Bus names:', NAMES)
+      Log.debug('Bus names:', @names)
 
     end
     

data/lib/rbus/bus/proxy.rb

@@ -22,21 +22,32 @@
 #++
 #
 require 'rexml/document'
+require File.join(File.dirname(__FILE__), '..', 'etc', 'blankslate')
 
 module RBus
 
   VALID_METHOD_NAME = /^[A-Za-z_][A-Za-z0-9_]{0,254}$/
-
-  # BlankSlate is a superclass that empties (almost) all instance methods
-  # from it's subclasses.
-  # See: http://onestepback.org/index.cgi/Tech/Ruby/BlankSlate.rdoc
-  class BlankSlate
-    instance_methods.each { |m| undef_method m unless m =~ /^__|[!\?]$/ }
-  end
+  PREFIX_TO_SIG = {
+    'byte'      => 'y',
+    'boolean'   => 'b',
+    'int16'     => 'n',
+    'uint16'    => 'q',
+    'int32'     => 'i',
+    'uint32'    => 'u',
+    'int64'     => 'x',
+    'uint64'    => 't',
+    'double'    => 'd',
+    'string'    => 's',
+    'objpath'   => 'o',
+    'signature' => 'g',
+    'variant'   => 'v',
+    'array'     => 'a',
+    'dict'      => 'a{',
+  }
 
   # The object that represents the remote bus object.
   class Proxy < BlankSlate
-  
+    
     # Parses Introspect() XML into a hash with
     # {method => signature}
     def self.parse_introspect(xml)
@@ -52,7 +63,7 @@ module RBus
       end
       methods
     end
-     
+    
     def initialize(bus, well_known_name, object_path)
       @bus = bus
       @message_loop = @bus.message_loop
@@ -60,7 +71,6 @@ module RBus
       @object_path = object_path
       Introspect()
     end
-    
     def Introspect # :nodoc:
       # TODO: store interfaces as well, if ever needed
       interface = @interface
@@ -107,6 +117,77 @@ module RBus
     def method!(name, signature)
       @methods[name.to_s] = signature
     end
+
+  # Parse arguments and guess signature from a few types
+  # Handles [dr]bus-send type arguments also
+  def parse_arguments!(arguments)
+      
+      strip = lambda{|s|s.sub!(/^'/,'');s.sub!(/'$/,'')}
+
+      signature = ''
+      array = false
+      arguments.map! do |value|
+        case value
+          when TrueClass, FalseClass
+            signature << 'b'
+          when Float
+            signature << 'd'
+          when Hash
+            signature << 'a{'
+            fail "Can't guess signature for empty hash" if value.empty?
+            k_sig = parse_arguments!([value.keys.first])
+            v_sig = parse_arguments!([value.values.first])
+            signature << k_sig
+            signature << v_sig
+            signature << '}'
+          when Array
+            a_sig = parse_arguments!(value)
+            #puts a_sig
+            
+            # TODO: this only covers simple types
+            sq = a_sig.squeeze
+            if sq.length == 1 || sq[0] == ?a && sq.length == 2
+              signature << 'a' << sq
+            else
+              signature << "(#{a_sig})"
+            end
+          when Symbol
+            signature << 's'  
+          when String
+            type, arg = value.split(':',2)
+            if PREFIX_TO_SIG.has_key?(type)
+              signature << PREFIX_TO_SIG[type]
+              strip.call(arg)
+              case type
+                when 'dict'
+                  key_s,val_s,arg = arg.split(':',3)
+                  strip.call(arg)
+                  value = arg.nil? ? {} : Hash[*arg.split(/'?,'?/)]
+                  signature << PREFIX_TO_SIG[key_s]
+                  signature << PREFIX_TO_SIG[val_s]
+                  signature << '}'
+                when 'array'
+                  array = true
+                  value = arg
+                  redo
+                when 'variant'
+                  value = arg
+                  redo
+                else
+                  value = (array) ? arg.split(/'?,'?/) : arg
+                  array = false
+              end              
+            else
+              signature << 's'
+            end
+          else
+            fail "Failed to guess signature for '#{value.class}'"
+        end
+        value
+      end
+      
+      return signature
+    end
     
     # Routes all method calls to remote object
     def method_missing(name, *args, &block) # :nodoc:
@@ -124,14 +205,25 @@ module RBus
         m.object_path = @object_path
         m.interface = @interface if @interface
         m.member = method
-        m.arguments = args
-        if !args.empty? && @methods.has_key?(method)
+        if !args.empty?
+          begin
+            # always walk arguments because 'key:value' is always a valid arg
+            signature = parse_arguments!(args)
+          rescue RuntimeError => e
+            # re-bomb unless other signature
+            raise e unless @methods.has_key?(method)
+          end
+          if !@methods.has_key?(method)
+            method!(name, signature)
+          end
           Log.debug('Signature: ' + @methods[method])
           m.signature = @methods[method]
         end
+        m.arguments = args
       end
       Log.debug(block_given? ? 'Block given' : 'Block NOT given')
       @message_loop.send_message(call, block_given? ? block : nil)
     end
   end
 end
+

data/lib/rbus/etc/blankslate.rb

@@ -0,0 +1,8 @@
+module RBus
+  # BlankSlate is a superclass that empties (almost) all instance methods
+  # from it's subclasses.
+  # See: http://onestepback.org/index.cgi/Tech/Ruby/BlankSlate.rdoc
+  class BlankSlate
+    instance_methods.each { |m| undef_method m unless m =~ /^__|\W$|^should/ }
+  end
+end

data/lib/rbus/etc/version.rb

@@ -27,7 +27,7 @@ module RBus #:nodoc:
   
     MAJOR = 0
     MINOR = 1
-    TINY  = 0
+    TINY  = 1
 
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/rbus/mainloop/mainloop.rb

@@ -30,9 +30,10 @@ module RBus
     include Observable
     include MonitorMixin
     
-    def initialize(transport)
+    def initialize(bus)
       super()
-      @transport = transport
+      @bus = bus
+      @transport = @bus.transport
       @writer = Message::Writer.new(@transport)
       @reader = Message::Reader.new(@transport)
       setup
@@ -50,10 +51,10 @@ module RBus
     def handle_incoming(message)
       return if message.nil?
       
-      # - empty NAMES is when Bus is connecting only
-      # - empty destination is for signals only
-      # - otherwise, NAMES must include the destination
-      return unless Bus::NAMES.empty? || message.destination.nil? || Bus::NAMES.include?(message.destination)
+      # - names.nil? is when Bus is connecting only
+      # - destination.empty? is for signals only
+      # - otherwise, names must include the destination
+      return unless @bus.names.nil? || message.destination.nil? || @bus.names.include?(message.destination)
       
       # The audience is listening... broadcast the new message.
       changed

data/spec/bus_spec.rb

@@ -25,7 +25,6 @@ require File.dirname(__FILE__) + '/helpers/spec_helper'
 require File.dirname(__FILE__) + '/helpers/bus_mocks'
 
 module RBus
-  
   module BusSpecHelper
     def setup_mocks
       @transport = mock('Transport')
@@ -37,7 +36,6 @@ module RBus
       Message::Reader.stub!(:new).and_return(@message_reader)
       
       message_loop = mock('Mainloop', :null_object => true)
-      #message_loop.stub!(:run).and_return(message_loop)
       message_loop.stub!(:send_message)
       Mainloop.stub!(:new).and_return(message_loop)
 
@@ -45,7 +43,8 @@ module RBus
       Bus.stub!(:get_object).and_return(@proxy)
 
       Transport.stub!(:connect).and_return(@transport)
-      Auth.stub!(:authorize).and_return(fake_guid)      
+      Auth.stub!(:authorize).and_return(fake_guid)
+      
     end
   
     def fake_guid
@@ -61,15 +60,15 @@ module RBus
     end
     
     specify "should be a Bus object" do
-      @bus.should_be_an_instance_of(Bus)
+      @bus.should be_an_instance_of(Bus)
     end
     
     specify "should respond to get_object" do
-      @bus.should_respond_to :get_object
+      @bus.should respond_to(:get_object)
     end
     
     specify "should barf on empty address" do
-      lambda{Bus.new('')}.should_raise InvalidAddressException
+      lambda{Bus.new('')}.should raise_error(InvalidAddressException)
     end
     
   end
@@ -94,15 +93,15 @@ module RBus
     end
 
     specify "should be a Bus object" do
-      @bus.should_be_a_kind_of(Bus)
+      @bus.should be_a_kind_of(Bus)
     end
     
     specify "should be a singleton" do
-      @bus.should == (RBus.session_bus)
+      @bus.should equal(RBus.session_bus)
     end
       
     specify "should be a SessionBus object" do
-      @bus.should_be_an_instance_of(SessionBus)
+      @bus.should be_an_instance_of(SessionBus)
     end
 
   end
@@ -132,8 +131,6 @@ module RBus
 
   end
 
-
-
   context "System bus" do
     include BusSpecHelper
     setup do
@@ -142,15 +139,15 @@ module RBus
     end
 
     specify "should be a Bus object" do
-      @bus.should_be_a_kind_of(Bus)
+      @bus.should be_a_kind_of(Bus)
     end
     
     specify "should be a singleton" do
-      @bus.should == (RBus.system_bus)
+      @bus.should equal(RBus.system_bus)
     end
       
     specify "should be a SystemBus object" do
-      @bus.should_be_an_instance_of(SystemBus)
+      @bus.should be_an_instance_of(SystemBus)
     end
 
   end

data/spec/mainloop_spec.rb

@@ -30,13 +30,16 @@ module RBus
         @transport = mock('Transport')
         @transport.stub!(:send)
         @transport.stub!(:read)
-       
+        
+        @bus = mock('Bus')
+        @bus.stub!(:transport).and_return(@transport)
+        @bus.stub!(:names).and_return([':1.31'])
+        
         @message = mock('Message', :null_object => true)
         @message.stub!(:serial).and_return(1)
         @message.stub!(:message).and_return("string")
         
         @message.stub!(:destination).and_return(":1.31")
-        Bus::NAMES[0] = ':1.31'
         
         @message_reader = mock('Message::Reader', :null_object => true)
         @message_reader.stub!(:read_message).and_return(@message)
@@ -46,7 +49,7 @@ module RBus
         @message_writer.stub!(:send_message)
         Writer::stub!(:new).and_return(@message_writer)
         
-        @message_loop = Mainloop.new(@transport)
+        @message_loop = Mainloop.new(@bus)
         
         Thread.abort_on_exception = true
       end

data/spec/message_spec.rb

@@ -48,7 +48,7 @@ module RBus
     specify "multi-threaded should still give all unique values" do
       threads = []
       serials = []
-      1337.times do
+      50.times do
         threads << Thread.new do
           select(nil,nil,nil,rand)
           serials << Message::SerialGenerator.get_unique

data/spec/proxy_spec.rb

@@ -62,6 +62,7 @@ module RBus
         m.arguments.should == ['a string',2,3,[2,3]]
         b.should == nil
       }
+      @proxy.method!(:Hola, 'suuau')
       @proxy.Hola('a string', 2,3,[2,3])
     end
     
@@ -115,6 +116,75 @@ module RBus
     specify "should raise on too long name (>255)" do
       lambda{@proxy.abcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijkabcdefghijk}.should_raise(InvalidNameException)
     end
+      
+  end
+  
+  context "Signature guesses" do
+    setup do
+      @well_known_name = 'org.rubyforge.rbus'
+      @object_path = '/org/rubyforge/rbus'
+      @message_loop = mock('MessageLoop')
+      @message_loop.stub!(:send_message)
+      @bus = mock('Bus')
+      @bus.stub!(:message_loop).and_return(@message_loop)
+      @proxy = Proxy.new(@bus, @well_known_name, @object_path)      
+    end
+    
+    specify "should parse mixed singles" do
+      args = [true, false,'something','string:string2', 'uint32:13']
+      @proxy.parse_arguments!(args).should == 'bbssu'
+      args.should == [true,false,'something','string2', '13']
+    end
+
+    specify "should parse struct of int,string" do
+      args = [['int32:-13','12']]
+      @proxy.parse_arguments!(args).should == '(is)'
+      args.should == [['-13','12']]
+    end
+    
+    specify "should parse array of ints" do
+      args = [['int32:-13','int32:12']]
+      @proxy.parse_arguments!(args).should == 'ai'
+      args.should == [['-13','12']]
+    end
     
+    specify "should parse array of array of string" do
+      args = [[['','12']]]
+      @proxy.parse_arguments!(args).should == 'aas'
+    end
+
+    specify "should parse array of string" do
+      args = ["array:string:'foo','bar'"]
+      @proxy.parse_arguments!(args).should == 'as'
+      args.should == [['foo','bar']]
+    end
+    
+    specify "should parse dict of string => uint32" do
+      args = ["dict:string:uint32:'foo',32,'bar',64"]
+      @proxy.parse_arguments!(args).should == 'a{su}'
+      args.should == [{'foo' => '32', 'bar' => '64'}]      
+    end
+    
+    
+    specify "should parse hash with s => s" do
+      args = [{'a' => 'a', 'b' => 'c'}]
+      @proxy.parse_arguments!(args).should == 'a{ss}'
+    end
+    
+    specify "should parse hash with s => as" do
+      args = [{:koss => ['haha'], 'bass' => ['lass']}]
+      @proxy.parse_arguments!(args).should == 'a{sas}'
+    end
+    
+    specify "should fail on parse empty hash" do
+      args = [{}]
+      lambda{@proxy.parse_arguments!(args)}.should_raise
+    end
+
+    specify "should parse float" do
+      args = [1.23]
+      @proxy.parse_arguments!(args).should == 'd'
+    end
+
   end
 end

metadata

@@ -3,8 +3,8 @@ rubygems_version: 0.9.2
 specification_version: 1
 name: rbus
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
-date: 2007-03-28 00:00:00 +02:00
+  version: 0.1.1
+date: 2007-03-30 00:00:00 +02:00
 summary: A native implementation of the D-Bus protocol.
 require_paths: 
 - lib
@@ -59,6 +59,7 @@ files:
 - lib/rbus/bus/proxy.rb
 - lib/rbus/bus/transport.rb
 - lib/rbus/default.rb
+- lib/rbus/etc/blankslate.rb
 - lib/rbus/etc/exception.rb
 - lib/rbus/etc/log.rb
 - lib/rbus/etc/types.rb