ruby-dbus 0.10.0 → 0.11.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d85683483eaee12e0221cc19843e3887a858269a
-  data.tar.gz: 8aa3af094fe0068807269591395d29d7eb37c7cf
+  metadata.gz: dfbf7c6779ae43ca2e0d5774d391bd8bb785bcbf
+  data.tar.gz: d8b52f014b2a5bc585099f601385a5bd27dd9ac4
 SHA512:
-  metadata.gz: 0493a1b55563d87d202b8cfda861a817d4ab63baa42724505976e64568fad392c2bdcf9a570ea99fe4c32c11ead7dfdc885fbe887e4fc9c7b67540d45c4b0b0d
-  data.tar.gz: 6d0f2704d4a30ef90b08b93c2e5f9f69750312914dfb7904ad5c9cb13aaaa6cef067dc0484d12b952c1885e747b831731b995526eeb9b39ef6c005ab29315124
+  metadata.gz: 1aa32167272f9caa031a723efbef29b72197bfa3837eede6d5615f88f4e643d1a5520b31777bac39e545310bab6a2023b1ee619d65fb26a4b48bf4ec11767ac0
+  data.tar.gz: 46cb2c144392a04aee1a718f75e1b2bebf22a1dd1bcee0efb3b262852dc8334578366a4e7e35568a9ceb127131b2f39e52e60690319a51448015fc4dd2f1401a

data/NEWS

@@ -5,6 +5,14 @@ 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.11.0 - 2014-02-17
+
+API:
+ * Connection: split off MessageQueue, marked other methods as private.
+
+Requirements:
+ * converted tests to RSpec, rather mechanically for now
+
 == Ruby D-Bus 0.10.0 - 2014-01-10
 
 Bug fixes:

data/README.md

@@ -1,13 +1,50 @@
-# Ruby D-Bus README
+# Ruby D-Bus
 
-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.
+[D-Bus](http://dbus.freedesktop.org) is an interprocess communication
+mechanism for Linux.
+Ruby D-Bus is a pure Ruby library for writing clients and services for D-Bus.
+
+[![Gem Version][GV img]][Gem Version]
+[![Build Status][BS img]][Build Status]
+[![Dependency Status][DS img]][Dependency Status]
+[![Code Climate][CC img]][Code Climate]
+[![Coverage Status][CS img]][Coverage Status]
+
+[Gem Version]: https://rubygems.org/gems/ruby-dbus
+[Build Status]: https://travis-ci.org/mvidner/ruby-dbus
+[travis pull requests]: https://travis-ci.org/mvidner/ruby-dbus/pull_requests
+[Dependency Status]: https://gemnasium.com/mvidner/ruby-dbus
+[Code Climate]: https://codeclimate.com/github/mvidner/ruby-dbus
+[Coverage Status]: https://coveralls.io/r/mvidner/ruby-dbus
+
+[GV img]: https://badge.fury.io/rb/ruby-dbus.png
+[BS img]: https://travis-ci.org/mvidner/ruby-dbus.png
+[DS img]: https://gemnasium.com/mvidner/ruby-dbus.png
+[CC img]: https://codeclimate.com/github/mvidner/ruby-dbus.png
+[CS img]: https://coveralls.io/repos/mvidner/ruby-dbus/badge.png?branch=master
+
+## Example
+
+Check whether the system is on battery power
+via [UPower](http://upower.freedesktop.org/docs/UPower.html#UPower:OnBattery)
+
+    require "dbus"
+    sysbus = DBus.system_bus
+    upower_service   = sysbus["org.freedesktop.UPower"]
+    upower_object    = upower_service.object "/org/freedesktop/UPower"
+    upower_object.introspect
+    upower_interface = upower_object["org.freedesktop.UPower"]
+    on_battery       = upower_interface["OnBattery"]
+    if on_battery
+      puts "The computer IS on battery power."
+    else
+      puts "The computer IS NOT on battery power."
+    end
 
 ## Requirements
 
 - Ruby 1.9.3 or 2.0
 
-[![Build Status](https://travis-ci.org/mvidner/ruby-dbus.png)](https://travis-ci.org/mvidner/ruby-dbus)
 
 ## Installation
 

data/Rakefile

@@ -3,7 +3,7 @@ require 'rake'
 require 'fileutils'
 include FileUtils
 require 'tmpdir'
-require 'rake/testtask'
+require 'rspec/core/rake_task'
 
 require "packaging"
 
@@ -18,24 +18,16 @@ Packaging.configuration do |conf|
   conf.skip_license_check << /^lib\/dbus\/core_ext\//
 end
 
-desc 'Default: run tests in the proper environment'
-task :default => :test
+desc 'Default: run specs in the proper environment'
+task :default => :spec
+task :test => :spec
 
-def common_test_task(t)
-    t.libs << "lib"
-    t.test_files = FileList['test/*_test.rb']
-    t.verbose = true
+RSpec::Core::RakeTask.new("bare:spec") do |t|
+  t.pattern = "**/test/**/*_spec.rb"
+  t.rspec_opts = "--color --format doc"
 end
-Rake::TestTask.new("bare:test") {|t| common_test_task t }
 
-begin
-  require 'rcov/rcovtask'
-  Rcov::RcovTask.new("bare:rcov") {|t| common_test_task t }
-rescue LoadError
-  # no rcov, never mind
-end
-
-%w(test rcov).each do |tname|
+%w(spec).each do |tname|
   desc "Run bare:#{tname} in the proper environment"
   task tname do |t|
     cd "test/tools" do
@@ -44,6 +36,12 @@ end
   end
 end
 
+if ENV["TRAVIS"]
+  require "coveralls/rake/task"
+  Coveralls::RakeTask.new
+  task :default => "coveralls:push"
+end
+
 #remove tarball implementation and create gem for this gemfile
 Rake::Task[:tarball].clear
 
@@ -54,6 +52,7 @@ task :tarball do |t|
     cd temp do
       sh "gem build ruby-dbus.gemspec"
     end
+    sh "rm -f package/*.gem"
     cp Dir.glob("#{temp}/*.gem"), "package"
   end
 end

data/VERSION

@@ -1 +1 @@
-0.10.0
+0.11.0

data/lib/dbus.rb

@@ -8,21 +8,25 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
-require 'dbus/core_ext/class/attribute'
-require 'dbus/type'
-require 'dbus/introspect'
-require 'dbus/error'
-require 'dbus/export'
-require 'dbus/bus'
-require 'dbus/logger'
-require 'dbus/marshall'
-require 'dbus/message'
-require 'dbus/matchrule'
-require 'dbus/auth'
-require 'dbus/xml'
+require_relative "dbus/auth"
+require_relative "dbus/bus"
+require_relative "dbus/core_ext/class/attribute"
+require_relative "dbus/error"
+require_relative "dbus/export"
+require_relative "dbus/introspect"
+require_relative "dbus/logger"
+require_relative "dbus/marshall"
+require_relative "dbus/matchrule"
+require_relative "dbus/message"
+require_relative "dbus/message_queue"
+require_relative "dbus/proxy_object"
+require_relative "dbus/proxy_object_factory"
+require_relative "dbus/proxy_object_interface"
+require_relative "dbus/type"
+require_relative "dbus/xml"
 
-require 'socket'
-require 'thread'
+require "socket"
+require "thread"
 
 # = D-Bus main module
 #

data/lib/dbus/bus.rb

@@ -11,7 +11,6 @@
 require 'socket'
 require 'thread'
 require 'singleton'
-require 'fcntl'
 
 # = D-Bus main module
 #
@@ -187,8 +186,8 @@ module DBus
   class Connection
     # The unique name (by specification) of the message.
     attr_reader :unique_name
-    # The socket that is used to connect with the bus.
-    attr_reader :socket
+    # pop and push messages here
+    attr_reader :message_queue
 
     # Create a new connection to the bus for a given connect _path_. _path_
     # format is described in the D-Bus specification:
@@ -197,93 +196,22 @@ module DBus
     # "transport1:key1=value1,key2=value2;transport2:key1=value1,key2=value2"
     # e.g. "unix:path=/tmp/dbus-test" or "tcp:host=localhost,port=2687"
     def initialize(path)
-      @path = path
+      @message_queue = MessageQueue.new(path)
       @unique_name = nil
-      @buffer = ""
       @method_call_replies = Hash.new
       @method_call_msgs = Hash.new
       @signal_matchrules = Hash.new
       @proxy = nil
       @object_root = Node.new("/")
-      @is_tcp = false
-    end
-
-    # Connect to the bus and initialize the connection.
-    def connect
-      addresses = @path.split ";"
-      # connect to first one that succeeds
-      worked = addresses.find do |a|
-        transport, keyvaluestring = a.split ":"
-        kv_list = keyvaluestring.split ","
-        kv_hash = Hash.new
-        kv_list.each do |kv|
-          key, escaped_value = kv.split "="
-          value = escaped_value.gsub(/%(..)/) {|m| [$1].pack "H2" }
-          kv_hash[key] = value
-        end
-        case transport
-          when "unix"
-          connect_to_unix kv_hash
-          when "tcp"
-          connect_to_tcp kv_hash
-          when "launchd"
-          connect_to_launchd kv_hash
-          else
-          # ignore, report?
-        end
-      end
-      worked
-      # returns the address that worked or nil.
-      # how to report failure?
-    end
-
-    # Connect to a bus over tcp and initialize the connection.
-    def connect_to_tcp(params)
-      #check if the path is sufficient
-      if params.key?("host") and params.key?("port")
-        begin
-          #initialize the tcp socket
-          @socket = TCPSocket.new(params["host"],params["port"].to_i)
-          @socket.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
-          init_connection
-          @is_tcp = true
-        rescue Exception => e
-          puts "Oops:", e
-          puts "Error: Could not establish connection to: #{@path}, will now exit."
-          exit(1) #a little harsh
-        end
-      else
-        #Danger, Will Robinson: the specified "path" is not usable
-        puts "Error: supplied path: #{@path}, unusable! sorry."
-      end
     end
 
-    # Connect to an abstract unix bus and initialize the connection.
-    def connect_to_unix(params)
-      @socket = Socket.new(Socket::Constants::PF_UNIX,Socket::Constants::SOCK_STREAM, 0)
-      @socket.fcntl(Fcntl::F_SETFD, Fcntl::FD_CLOEXEC)
-      if ! params['abstract'].nil?
-        if HOST_END == LIL_END
-          sockaddr = "\1\0\0#{params['abstract']}"
-        else
-          sockaddr = "\0\1\0#{params['abstract']}"
-        end
-      elsif ! params['path'].nil?
-        sockaddr = Socket.pack_sockaddr_un(params['path'])
+    # Dispatch all messages that are available in the queue,
+    # but do not block on the queue.
+    # Called by a main loop when something is available in the queue
+    def dispatch_message_queue
+      while (msg = @message_queue.pop(:non_block)) # FIXME EOFError
+        process(msg)
       end
-      @socket.connect(sockaddr)
-      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?
     end
 
     # Tell a bus to register itself on the glib main loop
@@ -292,13 +220,10 @@ module DBus
       # Circumvent a ruby-glib bug
       @channels ||= Array.new
 
-      gio = GLib::IOChannel.new(@socket.fileno)
+      gio = GLib::IOChannel.new(@message_queue.socket.fileno)
       @channels << gio
       gio.add_watch(GLib::IOChannel::IN) do |c, ch|
-        update_buffer
-        messages.each do |msg|
-          process(msg)
-        end
+        dispatch_message_queue
         true
       end
     end
@@ -394,6 +319,7 @@ module DBus
 '
 # This apostroph is for syntax highlighting editors confused by above xml: "
 
+    # @api private
     # Send a _message_.
     # If _reply_handler_ is not given, wait for the reply
     # and return the reply, or raise the error.
@@ -418,11 +344,12 @@ module DBus
             reply_handler.call(rmsg, * rmsg.params)
           end
         end
-        send(message.marshall)
+        @message_queue.push(message)
       end
       ret
     end
 
+    # @api private
     def introspect_data(dest, path, &reply_handler)
       m = DBus::Message.new(DBus::Message::METHOD_CALL)
       m.path = path
@@ -442,6 +369,7 @@ module DBus
       end
     end
 
+    # @api private
     # Issues a call to the org.freedesktop.DBus.Introspectable.Introspect method
     # _dest_ is the service and _path_ the object path you want to introspect
     # If a code block is given, the introspect call in asynchronous. If not
@@ -500,82 +428,22 @@ module DBus
       @proxy
     end
 
-    # Fill (append) the buffer from data that might be available on the
-    # socket.
-    def update_buffer
-      @buffer += @socket.read_nonblock(MSG_BUF_SIZE)  
-    rescue EOFError
-      raise                     # the caller expects it
-    rescue Exception => e
-      puts "Oops:", e
-      raise if @is_tcp          # why?
-      puts "WARNING: read_nonblock failed, falling back to .recv"
-      @buffer += @socket.recv(MSG_BUF_SIZE)  
-    end
-
-    # Get one message from the bus and remove it from the buffer.
-    # Return the message.
-    def pop_message
-      return nil if @buffer.empty?
-      ret = nil
-      begin
-        ret, size = Message.new.unmarshall_buffer(@buffer)
-        @buffer.slice!(0, size)
-      rescue IncompleteBufferException
-        # fall through, let ret be null
-      end
-      ret
-    end
-
-    # Retrieve all the messages that are currently in the buffer.
-    def messages
-      ret = Array.new
-      while msg = pop_message
-        ret << msg
-      end
-      ret
-    end
-
-    # The buffer size for messages.
-    MSG_BUF_SIZE = 4096
-
-    # Update the buffer and retrieve all messages using Connection#messages.
-    # Return the messages.
-    def poll_messages
-      r, d, d = IO.select([@socket], nil, nil, 0)
-      if r and r.size > 0
-        update_buffer
-      end
-      messages
-    end
-
+    # @api private
     # Wait for a message to arrive. Return it once it is available.
     def wait_for_message
-      if @socket.nil?
-        puts "ERROR: Can't wait for messages, @socket is nil."
-        return
-      end
-      ret = pop_message
-      while ret == nil
-        r, d, d = IO.select([@socket])
-        if r and r[0] == @socket
-          update_buffer
-          ret = pop_message
-        end
-      end
-      ret
+      @message_queue.pop                 # FIXME EOFError
     end
 
+    # @api private
     # 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)
+      @message_queue.push(m)
       @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)
@@ -585,6 +453,7 @@ module DBus
       end
     end
 
+    # @api private
     # Specify a code block that has to be executed when a reply for
     # message _m_ is received.
     def on_return(m, &retc)
@@ -620,6 +489,7 @@ module DBus
       end
     end
 
+    # @api private
     # Process a message _m_ based on its type.
     def process(m)
       return if m.nil? #check if somethings wrong
@@ -646,17 +516,17 @@ module DBus
         if not node
           reply = Message.error(m, "org.freedesktop.DBus.Error.UnknownObject",
                                 "Object #{m.path} doesn't exist")
-          send(reply.marshall)
+          @message_queue.push(reply)
         # handle introspectable as an exception:
         elsif m.interface == "org.freedesktop.DBus.Introspectable" and
             m.member == "Introspect"
           reply = Message.new(Message::METHOD_RETURN).reply_to(m)
           reply.sender = @unique_name
           reply.add_param(Type::STRING, node.to_xml)
-          send(reply.marshall)
+          @message_queue.push(reply)
         else
           obj = node.object
-          return if obj.nil?    # FIXME, sends no reply
+          return if obj.nil?    # FIXME, pushes no reply
           obj.dispatch(m) if obj
         end
       when DBus::Message::SIGNAL
@@ -669,6 +539,8 @@ module DBus
       else
         DBus.logger.debug "Unknown message type: #{m.message_type}"
       end
+    rescue Exception => ex
+      raise m.annotate_exception(ex)
     end
 
     # Retrieves the Service with the given _name_.
@@ -680,6 +552,7 @@ module DBus
     end
     alias :[] :service
 
+    # @api private
     # Emit a signal event for the given _service_, object _obj_, interface
     # _intf_ and signal _sig_ with arguments _args_.
     def emit(service, obj, intf, sig, *args)
@@ -693,7 +566,7 @@ module DBus
         m.add_param(par.type, args[i])
         i += 1
       end
-      send(m.marshall)
+      @message_queue.push(m)
     end
 
     ###########################################################################
@@ -712,12 +585,6 @@ module DBus
       end
       @service = Service.new(@unique_name, self)
     end
-
-    # Initialize the connection to the bus.
-    def init_connection
-      @client = Client.new(@socket)
-      @client.authenticate
-    end
   end # class Connection
 
 
@@ -731,7 +598,6 @@ module DBus
     # Get the the default session bus.
     def initialize
       super(ENV["DBUS_SESSION_BUS_ADDRESS"] || address_from_file || "launchd:env=DBUS_LAUNCHD_SESSION_BUS_SOCKET")
-      connect
       send_hello
     end
 
@@ -772,7 +638,6 @@ module DBus
     # Get the default system bus.
     def initialize
       super(SystemSocketName)
-      connect
       send_hello
     end
   end
@@ -793,7 +658,6 @@ module DBus
     # Get the remote bus.
     def initialize socket_name
       super(socket_name)
-      connect
       send_hello
     end
   end
@@ -829,7 +693,7 @@ module DBus
 
     # Add a _bus_ to the list of buses to watch for events.
     def <<(bus)
-      @buses[bus.socket] = bus
+      @buses[bus.message_queue.socket] = bus
     end
 
     # Quit a running main loop, to be used eg. from a signal handler
@@ -842,7 +706,7 @@ module DBus
       # before blocking, empty the buffers
       # https://bugzilla.novell.com/show_bug.cgi?id=537401
       @buses.each_value do |b|
-        while m = b.pop_message
+        while m = b.message_queue.message_from_buffer_nonblock
           b.process(m)
         end
       end
@@ -852,12 +716,12 @@ module DBus
         ready.first.each do |socket|
           b = @buses[socket]
           begin
-            b.update_buffer
+            b.message_queue.buffer_from_socket_nonblock
           rescue EOFError, SystemCallError
             @buses.delete socket # this bus died
             next
           end
-          while m = b.pop_message
+          while m = b.message_queue.message_from_buffer_nonblock
             b.process(m)
           end
         end