pangdudu-ruby-dbus 0.1.0 → 0.2.1

data/examples/simple/call_introspect.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/ruby
+
+require "dbus"
+
+session_bus = DBus::SessionBus.instance
+
+# Get the Rhythmbox service
+rhythmbox = session_bus.service("org.gnome.Rhythmbox")
+
+# Get the object from this service
+player = rhythmbox.object("/org/gnome/Rhythmbox/Player")
+
+# Introspect it
+player.introspect
+if player.has_iface? "org.gnome.Rhythmbox.Player"
+  puts "We have Rhythmbox Player interface"
+end
+
+player_with_iface = player["org.gnome.Rhythmbox.Player"]
+p player_with_iface.getPlayingUri
+
+# Maybe support default_iface=(iface_str) on an ProxyObject, so
+# that this is possible?
+player.default_iface = "org.gnome.Rhythmbox.Player"
+puts "default_iface test:"
+p player.getPlayingUri
+player.on_signal("elapsedChanged") do |u|
+  puts "elapsedChanged: #{u}"
+end
+
+main = DBus::Main.new
+main << session_bus
+main.run
+

data/examples/utils/listnames.rb

@@ -0,0 +1,11 @@
+#!/usr/bin/ruby
+
+require 'dbus'
+
+d = if ARGV.member?("--system")
+  DBus::SystemBus.instance
+else
+  DBus::SessionBus.instance
+end
+d.proxy.ListNames[0].each{ |n| puts "\t#{n}" }
+

data/examples/utils/notify.rb

@@ -0,0 +1,19 @@
+#!/usr/bin/ruby
+
+require 'dbus'
+
+if ARGV.size < 2
+  puts "Usage:"
+  puts "notify.rb \"title\" \"body\""
+  exit
+end
+
+d = DBus::SessionBus.instance
+o = d.service("org.freedesktop.Notifications").object("/org/freedesktop/Notifications")
+o.introspect
+
+i = o["org.freedesktop.Notifications"]
+
+i.Notify('notify.rb', 0, 'info', ARGV[0], ARGV[1], [], {}, 2000) do |ret, param|
+end
+

data/lib/dbus/auth.rb

@@ -29,68 +29,12 @@ module DBus
       # each character and determin hex value "1" => 0x31, "0" => 0x30. You
       # obtain for "1000" => 31303030 This is what the server is expecting.
       # Why? I dunno. How did I come to that conclusion? by looking at rbus
-      # code. I have no idea how he found that out. 
+      # code. I have no idea how he found that out.
       return Process.uid.to_s.split(//).collect { |a| "%x" % a[0] }.join
     end
   end
-  
-  # = Authentication class using SHA1 crypto algorithm 
-  #
-  # Class for 'CookieSHA1' type authentication.
-  # Implements the AUTH DBUS_COOKIE_SHA1 mechanism.
-  class DBusCookieSHA1 < Authenticator
-    
-    #the autenticate method (called in stage one of authentification)    
-    def authenticate
-      require 'etc'
-      return "#{hex_encode(Etc.getlogin)}" #server expects it to be binary
-    end
 
-    #returns the modules name
-    def name
-      return 'DBUS_COOKIE_SHA1'
-    end
-    
-    #handles the interesting crypto stuff, check the rbus-project for more info: http://rbus.rubyforge.org/
-    def data(hexdata)
-      require 'digest/sha1'
-      data = hex_decode(hexdata)
-      # name of cookie file, id of cookie in file, servers random challenge  
-      context, id, s_challenge = data.split(' ')
-      # Random client challenge        
-      c_challenge = Array.new(s_challenge.length/2).map{|obj|obj=rand(255).to_s}.join
-      # Search cookie file for id
-      path = File.join(ENV['HOME'], '.dbus-keyrings', context)
-      dlog "path: #{path.inspect}"
-      File.foreach(path) do |line|
-        if line.index(id) == 0
-          # Right line of file, read cookie
-          cookie = line.split(' ')[2].chomp
-          dlog "cookie: #{cookie.inspect}"
-          # Concatenate and encrypt
-          to_encrypt = [s_challenge, c_challenge, cookie].join(':')
-          sha = Digest::SHA1.hexdigest(to_encrypt)
-          #the almighty tcp server wants everything hex encoded
-          hex_response = hex_encode("#{c_challenge} #{sha}")
-          # Return response
-          response = [:AuthOk, hex_response]
-          return response
-        end
-      end
-      elog "Unable to locate cookie"
-    end  
-    
-    # encode plain to hex
-    def hex_encode(plain)
-      return nil if plain.nil?
-      plain.to_s.unpack('H*')[0]
-    end
-    
-    # decode hex to plain
-    def hex_decode(encoded)
-      encoded.scan(/[[:xdigit:]]{2}/).map{|h|h.hex.chr}.join
-    end  
-  end #DBusCookieSHA1 class ends here
+  # Note: this following stuff is tested with External authenticator only!
 
   # = Authentication client class.
   #
@@ -100,7 +44,7 @@ module DBus
     def initialize(socket)
       @socket = socket
       @state = nil
-      @auth_list = [External,DBusCookieSHA1]
+      @auth_list = [External]
     end
 
     # Start the authentication process.
@@ -128,59 +72,35 @@ module DBus
 
     # Try authentication using the next authenticator.
     def next_authenticator
-      begin
-        raise AuthException if @auth_list.size == 0
-        @authenticator = @auth_list.shift.new
-        auth_msg = ["AUTH", @authenticator.name, @authenticator.authenticate]
-        dlog "auth_msg: #{auth_msg.inspect}"
-        send(auth_msg)
-      rescue AuthException
-        @socket.close
-        raise
-      end
+      raise AuthenticationFailed if @auth_list.size == 0
+      @authenticator = @auth_list.shift.new
+      send("AUTH", @authenticator.name, @authenticator.authenticate)
     end
 
 
     # Read data (a buffer) from the bus until CR LF is encountered.
     # Return the buffer without the CR LF characters.
     def next_msg
-      data,crlf = "","\r\n"
-      left = 1024 #1024 byte, no idea if it's ever getting bigger
-      while left > 0
-        buf = @socket.read( left > 1 ? 1 : left )
-        break if buf.nil?
-        left -= buf.size
-        data += buf
-        break if data.include? crlf #crlf means line finished, the TCP socket keeps on listening, so we break 
-      end
-      readline = data.chomp.split(" ")
-      dlog "readline: #{readline.inspect}"
-      return readline
+      @socket.readline.chomp.split(" ")
     end
 
     # Try to reach the next state based on the current state.
     def next_state
       msg = next_msg
       if @state == :Starting
-        dlog ":Starting msg: #{msg[0].inspect}"
         case msg[0]
-        when "OK"
-          @state = :WaitingForOk    
         when "CONTINUE"
           @state = :WaitingForData
-        when "REJECTED" #needed by tcp, unix-path/abstract doesn't get here
-          @state = :WaitingForData
+        when "OK"
+          @state = :WaitingForOk
         end
       end
-      dlog "state: #{@state}"
       case @state
       when :WaitingForData
-        dlog ":WaitingForData msg: #{msg[0].inspect}"
         case msg[0]
         when "DATA"
           chall = msg[1]
           resp, chall = @authenticator.data(chall)
-          dlog ":WaitingForData/DATA resp: #{resp.inspect}"
           case resp
           when :AuthContinue
             send("DATA", chall)
@@ -206,7 +126,6 @@ module DBus
           @state = :WaitingForData
         end
       when :WaitingForOk
-        dlog ":WaitingForOk msg: #{msg[0].inspect}"
         case msg[0]
         when "OK"
           send("BEGIN")
@@ -222,7 +141,6 @@ module DBus
           @state = :WaitingForOk
         end
       when :WaitingForReject
-        dlog ":WaitingForReject msg: #{msg[0].inspect}"
         case msg[0]
         when "REJECT"
           next_authenticator
@@ -234,5 +152,5 @@ module DBus
       end
       return true
     end # def next_state
-  end # class Client 
+  end # class Client
 end # module D-Bus

data/lib/dbus/bus.rb

@@ -7,6 +7,7 @@
 # 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.
+
 require 'socket'
 require 'thread'
 require 'singleton'
@@ -77,7 +78,7 @@ module DBus
         n = n[elem]
       end
       if n.nil?
-        wlog "Unknown object #{path.inspect}"
+        puts "Warning, unknown object #{path}" if $DEBUG
       end
       n
     end
@@ -123,9 +124,10 @@ module DBus
 
     # Return an XML string representation of the node.
     def to_xml
-      xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN" "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
-      <node>'
-
+      xml = '<!DOCTYPE node PUBLIC "-//freedesktop//DTD D-BUS Object Introspection 1.0//EN"
+"http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
+<node>
+'
       self.each_pair do |k, v|
         xml += "<node name=\"#{k}\" />"
       end
@@ -138,7 +140,7 @@ module DBus
         end
       end
       xml += '</node>'
-      return xml
+      xml
     end
 
     # Return inspect information of the node.
@@ -171,10 +173,14 @@ module DBus
 
     # Create a new connection to the bus for a given connect _path_. _path_
     # format is described in the D-Bus specification:
-      # http://dbus.freedesktop.org/doc/dbus-specification.html#addresses
+    # http://dbus.freedesktop.org/doc/dbus-specification.html#addresses
     # and is something like:
     # "transport1:key1=value1,key2=value2;transport2:key1=value1,key2=value2"
-    # e.g. "unix:path=/tmp/dbus-test" or "tcp:host=localhost,port=2687"
+    # e.g. "unix:path=/tmp/dbus-test"
+    #
+    # Current implementation of ruby-dbus supports only a single server
+    # address and only "unix:path=...,guid=..." and
+    # "unix:abstract=...,guid=..." forms
     def initialize(path)
       @path = path
       @unique_name = nil
@@ -183,44 +189,14 @@ module DBus
       @method_call_msgs = Hash.new
       @signal_matchrules = Array.new
       @proxy = nil
+      # FIXME: can be TCP or any stream
+      @socket = Socket.new(Socket::Constants::PF_UNIX,
+                           Socket::Constants::SOCK_STREAM, 0)
       @object_root = Node.new("/")
     end
 
     # Connect to the bus and initialize the connection.
     def connect
-      connect_to_tcp if @path.include? "tcp:" #connect to tcp socket
-      connect_to_unix if @path.include? "unix:" #connect to unix socket
-    end
-
-    # Connect to a bus over tcp and initialize the connection.
-    def connect_to_tcp
-      #check if the path is sufficient
-      if @path.include? "host=" and @path.include? "port="
-        host,port,family = "","",""
-        #get the parameters
-        @path.split(",").each do |para|
-          host = para.sub("tcp:","").sub("host=","") if para.include? "host="
-          port = para.sub("port=","").to_i if para.include? "port="
-          family = para.sub("family=","") if para.include? "family="
-        end
-        dlog "host,port,family : #{host},#{port},#{family}"      
-        begin
-          #initialize the tcp socket
-          @socket = TCPSocket.new(host,port)
-          init_connection
-        rescue
-          elog "Could not establish connection to: #{@path}, will now exit."
-          exit(0) #a little harsh
-        end
-      else
-        #Danger, Will Robinson: the specified "path" is not usable
-        elog "supplied path: #{@path}, unusable! sorry."
-      end
-    end
-
-    # Connect to an abstract unix bus and initialize the connection.
-    def connect_to_unix
-      @socket = Socket.new(Socket::Constants::PF_UNIX,Socket::Constants::SOCK_STREAM, 0)
       parse_session_string
       if @transport == "unix" and @type == "abstract"
         if HOST_END == LIL_END
@@ -234,32 +210,10 @@ module DBus
       @socket.connect(sockaddr)
       init_connection
     end
-    
-    # Parse the session string (socket address).
-    def parse_session_string
-      path_parsed = /^([^:]*):([^;]*)$/.match(@path)
-      @transport = path_parsed[1]
-      adr = path_parsed[2]
-      if @transport == "unix"
-        adr.split(",").each do |eqstr|
-          idx, val = eqstr.split("=")
-          case idx
-          when "path"
-            @type = idx
-            @unix = val
-          when "abstract"
-            @type = idx
-            @unix_abstract = val
-          when "guid"
-            @guid = val
-          end
-        end
-      end
-    end
 
     # Send the buffer _buf_ to the bus using Connection#writel.
     def send(buf)
-      @socket.write(buf) unless @socket.nil?
+      @socket.write(buf)
     end
 
     # Tell a bus to register itself on the glib main loop
@@ -446,7 +400,7 @@ module DBus
     # Fill (append) the buffer from data that might be available on the
     # socket.
     def update_buffer
-      @buffer += @socket.read_nonblock(MSG_BUF_SIZE) unless @socket.nil?
+      @buffer += @socket.read_nonblock(MSG_BUF_SIZE)
     end
 
     # Get one message from the bus and remove it from the buffer.
@@ -487,10 +441,6 @@ module DBus
 
     # Wait for a message to arrive. Return it once it is available.
     def wait_for_message
-      if @socket.nil?
-        elog "Can't wait for messages, @socket is nil."
-        return
-      end
       ret = pop_message
       while ret == nil
         r, d, d = IO.select([@socket])
@@ -505,15 +455,11 @@ module DBus
     # Send a message _m_ on to the bus. This is done synchronously, thus
     # the call will block until a reply message arrives.
     def send_sync(m, &retc) # :yields: reply/return message
-      return if m.nil? #check if somethings wrong
       send(m.marshall)
       @method_call_msgs[m.serial] = m
       @method_call_replies[m.serial] = retc
 
       retm = wait_for_message
-      
-      return if retm.nil? #check if somethings wrong
-      
       process(retm)
       until [DBus::Message::ERROR,
           DBus::Message::METHOD_RETURN].include?(retm.message_type) and
@@ -528,7 +474,6 @@ module DBus
     def on_return(m, &retc)
       # Have a better exception here
       if m.message_type != Message::METHOD_CALL
-        elog "Funky exception, occured."
         raise "on_return should only get method_calls"
       end
       @method_call_msgs[m.serial] = m
@@ -544,14 +489,17 @@ module DBus
     end
 
     # Process a message _m_ based on its type.
+    # method call:: FIXME...
+    # method call return value:: FIXME...
+    # signal:: FIXME...
+    # error:: FIXME...
     def process(m)
-      return if m.nil? #check if somethings wrong
       case m.message_type
       when Message::ERROR, Message::METHOD_RETURN
         raise InvalidPacketException if m.reply_serial == nil
         mcs = @method_call_replies[m.reply_serial]
         if not mcs
-          dlog "no return code for mcs: #{mcs.inspect} m: #{m.inspect}"
+          puts "no return code for #{mcs.inspect} (#{m.inspect})" if $DEBUG
         else
           if m.message_type == Message::ERROR
             mcs.call(Error.new(m))
@@ -563,7 +511,7 @@ module DBus
         end
       when DBus::Message::METHOD_CALL
         if m.path == "/org/freedesktop/DBus"
-          dlog "Got method call on /org/freedesktop/DBus"
+          puts "Got method call on /org/freedesktop/DBus" if $DEBUG
         end
         # handle introspectable as an exception:
         if m.interface == "org.freedesktop.DBus.Introspectable" and
@@ -591,7 +539,7 @@ module DBus
           end
         end
       else
-        dlog "Unknown message type: #{m.message_type}"
+        puts "Unknown message type: #{m.message_type}" if $DEBUG
       end
     end
 
@@ -631,7 +579,29 @@ module DBus
       m.member = "Hello"
       send_sync(m) do |rmsg|
         @unique_name = rmsg.destination
-        dlog "Got hello reply. Our unique_name is #{@unique_name}, i feel special."
+        puts "Got hello reply. Our unique_name is #{@unique_name}" if $DEBUG
+      end
+    end
+
+    # Parse the session string (socket address).
+    def parse_session_string
+      path_parsed = /^([^:]*):([^;]*)$/.match(@path)
+      @transport = path_parsed[1]
+      adr = path_parsed[2]
+      if @transport == "unix"
+        adr.split(",").each do |eqstr|
+          idx, val = eqstr.split("=")
+          case idx
+          when "path"
+            @type = idx
+            @unix = val
+          when "abstract"
+            @type = idx
+            @unix_abstract = val
+          when "guid"
+            @guid = val
+          end
+        end
       end
     end
 
@@ -639,6 +609,11 @@ module DBus
     def init_connection
       @client = Client.new(@socket)
       @client.authenticate
+      # TODO: code some real stuff here
+      #writel("AUTH EXTERNAL 31303030")
+      #s = readl
+      # parse OK ?
+      #writel("BEGIN")
     end
   end # class Connection
 
@@ -648,10 +623,10 @@ module DBus
   # This is a singleton class.
   class SessionBus < Connection
     include Singleton
-    
+
     # Get the the default session bus.
-    def initialize socket_name=SessionSocketName
-      super(socket_name)
+    def initialize
+      super(ENV["DBUS_SESSION_BUS_ADDRESS"])
       connect
       send_hello
     end
@@ -665,14 +640,14 @@ module DBus
     include Singleton
 
     # Get the default system bus.
-    def initialize socket_name=SystemSocketName
-      super(socket_name)
+    def initialize
+      super(SystemSocketName)
       connect
       send_hello
     end
   end
 
-  # FIXME: we should get rid of these singeltons
+  # FIXME: we should get rid of these
 
   def DBus.system_bus
     SystemBus.instance

data/lib/dbus/introspect.rb

@@ -1,4 +1,4 @@
-p# dbus/introspection.rb - module containing a low-level D-Bus introspection implementation
+# dbus/introspection.rb - module containing a low-level D-Bus introspection implementation
 #
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
@@ -237,7 +237,7 @@ module DBus
       end
       d = Time.now - t
       if d > 2
-        wlog "Some XML took more that two secs to parse. Optimize me! (Hpricot?)"
+        puts "Some XML took more that two secs to parse. Optimize me!" if $DEBUG
       end
       [ret, subnodes]
     end

data/lib/dbus.rb

@@ -7,19 +7,16 @@
 # 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.
-require 'rubygems'
-require 'rofl' #http://github.com/pangdudu/rofl/tree/master makes the debug/tracing easy
-#comes from the Rofl logger/tracer module
-@logger.level = Logger::DEBUG
 
 require 'dbus/type'
 require 'dbus/introspect'
 require 'dbus/export'
-require 'dbus/bus'
+require 'dbus/bus.rb'
 require 'dbus/marshall'
 require 'dbus/message'
 require 'dbus/matchrule'
 require 'dbus/auth'
+
 require 'socket'
 require 'thread'
 
@@ -30,9 +27,6 @@ module DBus
   # Default socket name for the system bus.
   SystemSocketName = "unix:path=/var/run/dbus/system_bus_socket"
 
-  # Socket name for the session bus, not pretty.
-  SessionSocketName = ENV["DBUS_SESSION_BUS_ADDRESS"]
-
   # Byte signifying big endianness.
   BIG_END = ?B
   # Byte signifying little endianness.

metadata

@@ -1,39 +1,47 @@
 --- !ruby/object:Gem::Specification 
 name: pangdudu-ruby-dbus
 version: !ruby/object:Gem::Version 
-  version: 0.1.0
+  version: 0.2.1
 platform: ruby
 authors: 
-- Ruby DBUS Team, pangdudu
+- Ruby DBUS Team
 autorequire: dbus
 bindir: bin
 cert_chain: []
 
-date: 2009-07-27 00:00:00 -07:00
+date: 2009-05-16 00:00:00 -07:00
 default_executable: 
-dependencies: 
-- !ruby/object:Gem::Dependency 
-  name: pangdudu-rofl
-  type: :runtime
-  version_requirement: 
-  version_requirements: !ruby/object:Gem::Requirement 
-    requirements: 
-    - - ">="
-      - !ruby/object:Gem::Version 
-        version: "0"
-    version: 
-description: Ruby module for interaction with dbus, panda dev fork.
-email: pangdudu@github
+dependencies: []
+
+description: 
+email: http://trac.luon.net
 executables: []
 
 extensions: []
 
 extra_rdoc_files: 
-- README.rdoc
+- ChangeLog
 - COPYING
+- README
+- NEWS
 files: 
-- COPYING
-- README.rdoc
+- examples/simple
+- examples/simple/call_introspect.rb
+- examples/service
+- examples/service/call_service.rb
+- examples/service/service_newapi.rb
+- examples/gdbus
+- examples/gdbus/gdbus.glade
+- examples/gdbus/gdbus
+- examples/gdbus/launch.sh
+- examples/no-introspect
+- examples/no-introspect/nm-test.rb
+- examples/no-introspect/tracker-test.rb
+- examples/rhythmbox
+- examples/rhythmbox/playpause.rb
+- examples/utils
+- examples/utils/listnames.rb
+- examples/utils/notify.rb
 - lib/dbus
 - lib/dbus/message.rb
 - lib/dbus/auth.rb
@@ -44,12 +52,12 @@ files:
 - lib/dbus/matchrule.rb
 - lib/dbus/bus.rb
 - lib/dbus.rb
-- config/remote.session.dbus.conf
-- config/start_dbus_session.sh
-- test/simple_socket_test.rb
+- ChangeLog
+- COPYING
+- README
+- NEWS
 has_rdoc: true
-homepage: http://github.com/pangdudu/ruby-dbus/tree/master
-licenses: 
+homepage: http://trac.luon.net/data/ruby-dbus/
 post_install_message: 
 rdoc_options: []
 
@@ -70,9 +78,9 @@ required_rubygems_version: !ruby/object:Gem::Requirement
 requirements: []
 
 rubyforge_project: 
-rubygems_version: 1.3.5
+rubygems_version: 1.2.0
 signing_key: 
 specification_version: 2
-summary: Ruby module for interaction with dbus.
+summary: Ruby module for interaction with dbus
 test_files: []