sdague-ruby-dbus 0.2.1

data/NEWS

@@ -0,0 +1,31 @@
+= Ruby D-Bus NEWS
+
+== Ruby D-Bus "Thanks for all the fish" 0.2.1 - 2007-12-29
+
+More bugfixes, mostly supplied by users supplying us with patches.  Thanks!
+
+ * Support for new types added: 
+   - dict (courtesy of Drake Wilson);
+   - double (courtesy of Patrick Sissons);
+   - variant.
+ * Improved exception raise support (courtesy of Sjoerd Simons,
+   Patrick Sissons).
+ * Some polish (removed debug output, solved unnecessary warnings).
+ * Documentation updates, example fixes and updates.
+
+== Ruby D-Bus "Almost live from DebConf 7" 0.2.0 - 2007-06-02
+
+Again a bugfix release, also meant to be the public release
+for exploratory purposes. New in 0.2.0:
+
+ * Complete tutorial revamp.
+ * Relicensed to the LGPL.
+
+== Ruby D-Bus "Release Often" 0.1.1 - 2007-04-23
+
+Bugfix release.  Fixes hardcoded string for requesting bus names,
+found by Rudi Cilibrasi.
+
+== Ruby D-Bus "Happy Birthday Paul" 0.1.0 - 2007-04-17
+
+First release. Supports most of D-Bus' features.

data/README

@@ -0,0 +1,53 @@
+= Ruby D-Bus README
+
+Ruby D-Bus provides an implementation of the D-Bus protocol such that the
+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) 
+
+== 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".
+
+== Feature
+
+Ruby D-Bus currently supports the following features:
+
+ * Connecting to local buses.
+ * Accessing remote services, objects and interfaces.
+ * Invoking methods on remote objects synchronously and asynchronously.
+ * Catch signals on remote objects and handle them via callbacks.
+ * Remote object introspection.
+ * Walking object trees.
+ * Creating services and registering them on the bus.
+ * Exporting objects with interfaces on a bus for remote use.
+ * Rubyish D-Bus object and interface syntax support that automatically
+   allows for introspection.
+ * Emitting signals on exported objects.
+
+== 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/.
+
+== License
+
+ Ruby D-Bus is free software; you can redistribute it and/or modify it
+ under the terms of the GNU Lesser General Public License as published by the
+ Free Software Foundation; either version 2.1 of the License, or (at
+ your option) any later version.

data/examples/gdbus/gdbus

@@ -0,0 +1,255 @@
+#!/usr/bin/ruby
+#
+# This is a quite complex example using internal lower level API.
+# Not a good starting point, but might be usefull if you want to do tricky
+# stuff.
+# -- Arnaud
+
+require 'dbus'
+require 'libglade2'
+
+$enable_system = false
+
+class MethodCallWindow
+  def initialize(pwindow, intf, meth)
+    @intf, @meth = intf, meth
+    @entries = Array.new
+    @dialog = Gtk::Dialog.new(meth.name, pwindow,
+                             Gtk::Dialog::MODAL | Gtk::Dialog::NO_SEPARATOR,
+                             [Gtk::Stock::OK, Gtk::Dialog::RESPONSE_OK],
+                             [Gtk::Stock::CANCEL, Gtk::Dialog::RESPONSE_CANCEL])
+
+    @meth.params.each do |param|
+      shbox = Gtk::HBox.new(true, 0)
+      label = Gtk::Label.new("#{param[0]} (#{param[1]})")
+      input = Gtk::Entry.new
+      @entries << input
+      shbox.pack_start(label, true, true, 0)
+      shbox.pack_start(input, true, true, 0)
+      @dialog.vbox.pack_start(shbox, true, true, 0)
+      @dialog.vbox.show_all
+    end
+  end
+
+  def run
+    on_ok if @dialog.run == Gtk::Dialog::RESPONSE_OK
+    @dialog.destroy
+  end
+
+  def on_ok
+    bus = @intf.object.bus
+    m = DBus::Message.new(DBus::Message::METHOD_CALL)
+    m.path = @intf.object.path
+    m.interface = @intf.name
+    m.destination = @intf.object.destination
+    m.member = @meth.name
+    m.sender = bus.unique_name
+    @meth.params.each_with_index do |param, idx|
+      entry = @entries[idx]
+      data = nil
+      case param[1]
+      when "u", "i"
+        data = entry.text.to_i
+      when "s"
+        data = entry.text
+      when /^a/
+        begin
+          data = eval(entry.text)
+        rescue
+          puts "Incorrect data: #{data}"
+        end
+      end
+      m.add_param(param[1], data)
+    end
+    bus.on_return(m) do |retm|
+      if retm.is_a?(DBus::Error)
+        puts "Error: #{retm.inspect}"
+      else
+        puts "Method #{m.member} returns: #{retm.params.inspect}"
+      end
+    end
+    bus.send(m.marshall)
+  end
+end
+
+class DBusUI
+  def initialize
+    @glade = GladeXML.new("gdbus.glade") { |h| method(h) } # This block is like
+                                                           # black magic :)
+    @sessiontreeview = @glade.get_widget("sessiontreeview")
+    setup_treeview_renderer(@sessiontreeview, 'D-Bus Objects')
+    @sessiontreeview.selection.signal_connect("changed") do |selection|
+      on_treeview_selection_changed(selection)
+    end
+
+    @systemtreeview = @glade.get_widget("systemtreeview")
+    setup_treeview_renderer(@systemtreeview, 'D-Bus Objects')
+    @systemtreeview.selection.signal_connect("changed") do |selection|
+      on_treeview_selection_changed(selection)
+    end
+
+    @methsigtreeview = @glade.get_widget("methsigtreeview")
+    # ierk
+    setup_methodview_renderer(@methsigtreeview)
+
+    @window = @glade.get_widget("window1")
+    @window.show_all
+    start_buses
+  end
+
+  def beautify_method(meth)
+    # Damn, this need to be rewritten :p
+    s = meth.name + "("
+    if meth.kind_of?(DBus::Method)
+      s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" } +
+            meth.rets.collect { |a| "out #{a[0]}:#{a[1]}" }).join(", ")
+    elsif meth.kind_of?(DBus::Signal)
+      s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" }).join(", ")
+    end
+    s += ")"
+    s
+  end
+
+  def on_treeview_selection_changed(selection)
+    selected = selection.selected
+    model = Gtk::ListStore.new(String, String, DBus::Method,
+                               DBus::ProxyObjectInterface)
+    @methsigtreeview.model = model
+    if selected
+      if intf = selected[1]
+        intf.methods.keys.sort.each do |mi|
+          m = intf.methods[mi]
+          subiter = model.append
+          subiter[0] = beautify_method(m)
+          subiter[1] = "M"
+          subiter[2] = m
+          subiter[3] = intf
+        end
+        intf.signals.keys.sort.each do |mi|
+          m = intf.signals[mi]
+          subiter = model.append
+          subiter[0] = beautify_method(m)
+          subiter[1] = "S"
+          subiter[2] = m
+          subiter[3] = intf
+        end
+      end
+    end
+  end
+
+  def on_method_activated(view, path, column)
+    name = view.model.get_iter(path)[0]
+    puts "Clicked on: #{name.inspect}"
+    type = view.model.get_iter(path)[1]
+    intf = view.model.get_iter(path)[2]
+    if type == "M"
+      method = view.model.get_iter(path)[2]
+      intf = view.model.get_iter(path)[3]
+      MethodCallWindow.new(@window, intf, method).run
+    elsif type == "S"
+      signal = view.model.get_iter(path)[2]
+      intf = view.model.get_iter(path)[3]
+      mr = DBus::MatchRule.new.from_signal(intf, signal)
+      puts "*** Registering matchrule: #{mr.to_s} ***"
+      intf.object.bus.add_match(mr) do |sig|
+        puts "Got #{sig.member}(#{sig.params.join(',')})"
+      end
+    end
+  end
+
+  def on_sessiontreeview_row_activated(view, path, column)
+    name = view.model.get_iter(path)[0]
+    puts "Clicked on: #{name.inspect}"
+    intf = view.model.get_iter(path)[1]
+  end
+
+  def on_window_delete_event(window, event)
+    Gtk.main_quit
+  end
+
+  def setup_methodview_renderer(treeview)
+    renderer = Gtk::CellRendererText.new
+    col_offset = treeview.insert_column(-1, "T", renderer, 'text' => 1)
+    col_offset = treeview.insert_column(-1, "Name", renderer, 'text' => 0)
+    column = treeview.get_column(col_offset - 1)
+    column.clickable = true
+  end
+
+  def setup_treeview_renderer(treeview, str)
+    renderer = Gtk::CellRendererText.new
+    col_offset = treeview.insert_column(-1, str, renderer, 'text' => 0)
+    column = treeview.get_column(col_offset - 1)
+    column.clickable = true
+  end
+
+  def process_input(bus)
+    # THIS is the bad ass loop
+    # we should return to the glib main loop from time to time. Anyone with a
+    # proper way to handle it ?
+    bus.update_buffer
+    bus.messages.each do |msg|
+      bus.process(msg)
+    end
+  end
+
+  def start_buses
+    # call glibize to get dbus messages from the glib mainloop
+    DBus::SessionBus.instance.glibize
+    DBus::SystemBus.instance.glibize if $enable_system
+
+    DBus::SessionBus.instance.proxy.ListNames do |msg, names|
+      fill_treeview(DBus::SessionBus.instance, @sessiontreeview, names)
+    end
+    if $enable_system
+      DBus::SystemBus.instance.proxy.ListNames do |msg, names|
+        fill_treeview(DBus::SystemBus.instance, @systemtreeview, names)
+      end
+    end
+  end
+
+  def walk_node(model, iter, node)
+    node.each_pair do |key, val|
+      subiter = model.append(iter)
+      subiter[0] = key
+      walk_node(model, subiter, val)
+    end
+    unless node.object.nil?
+      node.object.interfaces.sort.each do |ifname|
+        subiter = model.append(iter)
+        subiter[0] = ifname
+        subiter[1] = node.object[ifname]
+      end
+    end
+  end
+
+  def introspect_services(model, bus)
+    el = @introspect_array.shift
+    if not el =~ /^:/
+      iter = model.append(nil)
+      iter[0] = el
+      puts "introspecting: #{el}"
+      begin
+        service = bus.service(el).introspect
+        walk_node(model, iter, service.root)
+      rescue Exception => e
+        puts "DBus Error:"
+        puts e.backtrace.join("\n")
+      end
+    end
+
+    not @introspect_array.empty?
+  end
+
+  def fill_treeview(bus, treeview, array)
+    model = Gtk::TreeStore.new(String, DBus::ProxyObjectInterface)
+    treeview.model = model
+    @introspect_array = array.sort
+    Gtk::idle_add { introspect_services(model, bus) }
+  end
+
+  def main
+    Gtk.main
+  end
+end
+
+DBusUI.new.main

data/examples/gdbus/gdbus.glade

@@ -0,0 +1,184 @@
+<?xml version="1.0" standalone="no"?> <!--*- mode: xml -*-->
+<!DOCTYPE glade-interface SYSTEM "http://glade.gnome.org/glade-2.0.dtd">
+
+<glade-interface>
+
+<widget class="GtkWindow" id="window1">
+  <property name="visible">True</property>
+  <property name="title" translatable="yes">GD-Bus</property>
+  <property name="type">GTK_WINDOW_TOPLEVEL</property>
+  <property name="window_position">GTK_WIN_POS_NONE</property>
+  <property name="modal">False</property>
+  <property name="default_width">500</property>
+  <property name="default_height">400</property>
+  <property name="resizable">True</property>
+  <property name="destroy_with_parent">False</property>
+  <property name="decorated">True</property>
+  <property name="skip_taskbar_hint">False</property>
+  <property name="skip_pager_hint">False</property>
+  <property name="type_hint">GDK_WINDOW_TYPE_HINT_NORMAL</property>
+  <property name="gravity">GDK_GRAVITY_NORTH_WEST</property>
+  <property name="focus_on_map">True</property>
+  <property name="urgency_hint">False</property>
+  <signal name="delete_event" handler="on_window_delete_event" last_modification_time="Sat, 17 Mar 2007 14:49:13 GMT"/>
+
+  <child>
+    <widget class="GtkHPaned" id="hpaned1">
+      <property name="visible">True</property>
+      <property name="can_focus">True</property>
+
+      <child>
+	<widget class="GtkNotebook" id="notebook1">
+	  <property name="visible">True</property>
+	  <property name="can_focus">True</property>
+	  <property name="show_tabs">True</property>
+	  <property name="show_border">True</property>
+	  <property name="tab_pos">GTK_POS_TOP</property>
+	  <property name="scrollable">False</property>
+	  <property name="enable_popup">False</property>
+
+	  <child>
+	    <widget class="GtkScrolledWindow" id="scrolledwindow3">
+	      <property name="visible">True</property>
+	      <property name="can_focus">True</property>
+	      <property name="hscrollbar_policy">GTK_POLICY_ALWAYS</property>
+	      <property name="vscrollbar_policy">GTK_POLICY_ALWAYS</property>
+	      <property name="shadow_type">GTK_SHADOW_IN</property>
+	      <property name="window_placement">GTK_CORNER_TOP_LEFT</property>
+
+	      <child>
+		<widget class="GtkTreeView" id="sessiontreeview">
+		  <property name="visible">True</property>
+		  <property name="can_focus">True</property>
+		  <property name="headers_visible">True</property>
+		  <property name="rules_hint">False</property>
+		  <property name="reorderable">False</property>
+		  <property name="enable_search">True</property>
+		  <property name="fixed_height_mode">False</property>
+		  <property name="hover_selection">False</property>
+		  <property name="hover_expand">False</property>
+		  <signal name="row_activated" handler="on_sessiontreeview_row_activated" last_modification_time="Sat, 17 Mar 2007 10:17:11 GMT"/>
+		</widget>
+	      </child>
+	    </widget>
+	    <packing>
+	      <property name="tab_expand">False</property>
+	      <property name="tab_fill">True</property>
+	    </packing>
+	  </child>
+
+	  <child>
+	    <widget class="GtkLabel" id="label1">
+	      <property name="visible">True</property>
+	      <property name="label" translatable="yes">Session</property>
+	      <property name="use_underline">False</property>
+	      <property name="use_markup">False</property>
+	      <property name="justify">GTK_JUSTIFY_LEFT</property>
+	      <property name="wrap">False</property>
+	      <property name="selectable">False</property>
+	      <property name="xalign">0.5</property>
+	      <property name="yalign">0.5</property>
+	      <property name="xpad">0</property>
+	      <property name="ypad">0</property>
+	      <property name="ellipsize">PANGO_ELLIPSIZE_NONE</property>
+	      <property name="width_chars">-1</property>
+	      <property name="single_line_mode">False</property>
+	      <property name="angle">0</property>
+	    </widget>
+	    <packing>
+	      <property name="type">tab</property>
+	    </packing>
+	  </child>
+
+	  <child>
+	    <widget class="GtkScrolledWindow" id="scrolledwindow5">
+	      <property name="visible">True</property>
+	      <property name="can_focus">True</property>
+	      <property name="hscrollbar_policy">GTK_POLICY_ALWAYS</property>
+	      <property name="vscrollbar_policy">GTK_POLICY_ALWAYS</property>
+	      <property name="shadow_type">GTK_SHADOW_IN</property>
+	      <property name="window_placement">GTK_CORNER_TOP_LEFT</property>
+
+	      <child>
+		<widget class="GtkTreeView" id="systemtreeview">
+		  <property name="visible">True</property>
+		  <property name="can_focus">True</property>
+		  <property name="headers_visible">True</property>
+		  <property name="rules_hint">False</property>
+		  <property name="reorderable">False</property>
+		  <property name="enable_search">True</property>
+		  <property name="fixed_height_mode">False</property>
+		  <property name="hover_selection">False</property>
+		  <property name="hover_expand">False</property>
+		</widget>
+	      </child>
+	    </widget>
+	    <packing>
+	      <property name="tab_expand">False</property>
+	      <property name="tab_fill">True</property>
+	    </packing>
+	  </child>
+
+	  <child>
+	    <widget class="GtkLabel" id="label2">
+	      <property name="visible">True</property>
+	      <property name="label" translatable="yes">System</property>
+	      <property name="use_underline">False</property>
+	      <property name="use_markup">False</property>
+	      <property name="justify">GTK_JUSTIFY_LEFT</property>
+	      <property name="wrap">False</property>
+	      <property name="selectable">False</property>
+	      <property name="xalign">0.5</property>
+	      <property name="yalign">0.5</property>
+	      <property name="xpad">0</property>
+	      <property name="ypad">0</property>
+	      <property name="ellipsize">PANGO_ELLIPSIZE_NONE</property>
+	      <property name="width_chars">-1</property>
+	      <property name="single_line_mode">False</property>
+	      <property name="angle">0</property>
+	    </widget>
+	    <packing>
+	      <property name="type">tab</property>
+	    </packing>
+	  </child>
+	</widget>
+	<packing>
+	  <property name="shrink">True</property>
+	  <property name="resize">False</property>
+	</packing>
+      </child>
+
+      <child>
+	<widget class="GtkScrolledWindow" id="scrolledwindow4">
+	  <property name="visible">True</property>
+	  <property name="can_focus">True</property>
+	  <property name="hscrollbar_policy">GTK_POLICY_ALWAYS</property>
+	  <property name="vscrollbar_policy">GTK_POLICY_ALWAYS</property>
+	  <property name="shadow_type">GTK_SHADOW_IN</property>
+	  <property name="window_placement">GTK_CORNER_TOP_LEFT</property>
+
+	  <child>
+	    <widget class="GtkTreeView" id="methsigtreeview">
+	      <property name="visible">True</property>
+	      <property name="can_focus">True</property>
+	      <property name="headers_visible">True</property>
+	      <property name="rules_hint">False</property>
+	      <property name="reorderable">False</property>
+	      <property name="enable_search">True</property>
+	      <property name="fixed_height_mode">False</property>
+	      <property name="hover_selection">False</property>
+	      <property name="hover_expand">False</property>
+              <signal name="row_activated" handler="on_method_activated" last_modification_time="Sat, 17 Mar 2007 14:49:13 GMT"/>
+	    </widget>
+	  </child>
+	</widget>
+	<packing>
+	  <property name="shrink">True</property>
+	  <property name="resize">False</property>
+	</packing>
+      </child>
+    </widget>
+  </child>
+</widget>
+
+</glade-interface>

data/examples/gdbus/launch.sh

@@ -0,0 +1,4 @@
+#!/bin/sh
+set -e
+# for the lazy typer
+ruby -w -I ../../lib gdbus

data/examples/no-introspect/nm-test.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+#
+# Trivial network interface lister using NetworkManager.
+# NetworkManager does not support introspection, so the api is not that sexy.
+
+require 'dbus'
+
+bus = DBus::SystemBus.instance
+
+nm_service = bus.service("org.freedesktop.NetworkManager")
+nm_manager = nm_service.object("/org/freedesktop/NetworkManager")
+poi = DBus::ProxyObjectInterface.new(nm_manager, "org.freedesktop.NetworkManager")
+poi.define_method("getDevices", "")
+p poi.getDevices
+
+

data/examples/no-introspect/tracker-test.rb

@@ -0,0 +1,16 @@
+#!/usr/bin/ruby
+#
+# Trivial network interface lister using NetworkManager.
+# NetworkManager does not support introspection, so the api is not that sexy.
+
+require 'dbus'
+
+bus = DBus::SessionBus.instance
+
+tracker_service = bus.service("org.freedesktop.Tracker")
+tracker_manager = tracker_service.object("/org/freedesktop/tracker")
+poi = DBus::ProxyObjectInterface.new(tracker_manager, "org.freedesktop.Tracker.Files")
+poi.define_method("GetMetadataForFilesInFolder", "in live_query_id:i, in uri:s, in fields:as, out values:aas")
+p poi.GetMetadataForFilesInFolder(-1, ENV['HOME'] + "/Desktop", ["File:Name", "File:Size"])
+
+

data/examples/rhythmbox/playpause.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby
+
+require 'dbus'
+bus = DBus::SessionBus.instance
+# get a rb object
+proxy = bus.introspect("org.gnome.Rhythmbox", "/org/gnome/Rhythmbox/Player")
+proxyi = proxy["org.gnome.Rhythmbox.Player"]
+
+# register for signals
+
+mr = DBus::MatchRule.new
+mr.type = "signal"
+mr.interface = "org.gnome.Rhythmbox.Player"
+mr.path = "/org/gnome/Rhythmbox/Player"
+bus.add_match(mr) do |msg, first_param|
+  print msg.member + " "
+  puts first_param
+end
+
+proxyi.playPause(true)
+
+main = DBus::Main.new
+main << bus
+main.run
+

data/examples/service/call_service.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/ruby
+
+require "dbus"
+
+session_bus = DBus::SessionBus.instance
+
+ruby_srv = session_bus.service("org.ruby.service")
+
+# Get the object from this service
+player = ruby_srv.object("/org/ruby/MyInstance")
+
+# Introspect it
+puts player.introspect
+player.default_iface = "org.ruby.SampleInterface"
+player.test_variant(["s", "coucou"])
+player.on_signal("SomethingJustHappened") do |u, v|
+  puts "SomethingJustHappened: #{u} #{v}"
+end
+player.hello("8=======D", "(_._)")
+p player["org.ruby.AnotherInterface"].Reverse("Hello world!")
+
+main = DBus::Main.new
+main << session_bus
+main.run
+

data/examples/service/service_newapi.rb

@@ -0,0 +1,51 @@
+#!/usr/bin/ruby
+
+require 'dbus'
+require 'thread'
+Thread.abort_on_exception = true
+
+class Test < DBus::Object
+  # Create an interface aggregating all upcoming dbus_method defines.
+  dbus_interface "org.ruby.SampleInterface" do
+    dbus_method :hello, "in name:s, in name2:s" do |name, name2|
+      puts "hello(#{name}, #{name2})"
+    end
+
+    dbus_method :test_variant, "in stuff:v" do |variant|
+      p variant
+    end
+
+    dbus_signal :SomethingJustHappened, "toto:s, tutu:u"
+  end
+
+  dbus_interface "org.ruby.AnotherInterface" do
+    dbus_method :ThatsALongMethodNameIThink do
+      puts "ThatsALongMethodNameIThink"
+    end
+    dbus_method :Reverse, "in instr:s, out outstr:s" do |instr|
+      outstr = instr.split(//).reverse.join
+      puts "got: #{instr}, replying: #{outstr}"
+      [outstr]
+    end
+  end
+end
+
+bus = DBus::SessionBus.instance
+service = bus.request_service("org.ruby.service")
+myobj = Test.new("/org/ruby/MyInstance")
+service.export(myobj)
+
+Thread.new do
+  i = 0
+  loop do 
+    # Signal emission
+    myobj.SomethingJustHappened("hey", i += 1)
+    sleep(0.5)
+  end
+end
+
+puts "listening"
+main = DBus::Main.new
+main << bus
+main.run
+