ruby-dbus 0.12.0 → 0.13.0

data/lib/dbus/auth.rb

@@ -6,7 +6,7 @@
 # License, version 2.1 as published by the Free Software Foundation.
 # See the file "COPYING" for the exact licensing terms.
 
-require 'rbconfig'
+require "rbconfig"
 
 module DBus
   # Exception raised when authentication fails somehow.
@@ -24,11 +24,11 @@ module DBus
   # = Anonymous authentication class
   class Anonymous < Authenticator
     def authenticate
-      '527562792044427573' # Hex encoded version of "Ruby DBus"
+      "527562792044427573" # Hex encoded version of "Ruby DBus"
     end
   end
 
-  # = External authentication class 
+  # = External authentication class
   #
   # Class for 'external' type authentication.
   class External < Authenticator
@@ -39,76 +39,75 @@ module DBus
       # 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.
-      return Process.uid.to_s.split(//).collect { |a| "%x" % a[0].ord }.join
+      Process.uid.to_s.split(//).map { |d| d.ord.to_s(16) }.join
     end
   end
-  
-  # = Authentication class using SHA1 crypto algorithm 
+
+  # = 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)    
+    # the autenticate method (called in stage one of authentification)
     def authenticate
-      require 'etc'
-      #number of retries we have for auth
+      require "etc"
+      # number of retries we have for auth
       @retries = 1
-      return "#{hex_encode(Etc.getlogin)}" #server expects it to be binary
+      hex_encode(Etc.getlogin).to_s # server expects it to be binary
     end
 
-    #returns the modules name
+    # returns the modules name
     def name
-      return 'DBUS_COOKIE_SHA1'
+      "DBUS_COOKIE_SHA1"
     end
-    
-    #handles the interesting crypto stuff, check the rbus-project for more info: http://rbus.rubyforge.org/
+
+    # handles the interesting crypto stuff, check the rbus-project for more info: http://rbus.rubyforge.org/
     def data(hexdata)
-      require 'digest/sha1'
+      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.bytesize/2).map{|obj|obj=rand(255).to_s}.join
+      # name of cookie file, id of cookie in file, servers random challenge
+      context, id, s_challenge = data.split(" ")
+      # Random client challenge
+      c_challenge = 1.upto(s_challenge.bytesize / 2).map { rand(255).to_s }.join
       # Search cookie file for id
-      path = File.join(ENV['HOME'], '.dbus-keyrings', context)
+      path = File.join(ENV["HOME"], ".dbus-keyrings", context)
       DBus.logger.debug "path: #{path.inspect}"
       File.foreach(path) do |line|
         if line.index(id) == 0
           # Right line of file, read cookie
-          cookie = line.split(' ')[2].chomp
+          cookie = line.split(" ")[2].chomp
           DBus.logger.debug "cookie: #{cookie.inspect}"
           # Concatenate and encrypt
-          to_encrypt = [s_challenge, c_challenge, cookie].join(':')
+          to_encrypt = [s_challenge, c_challenge, cookie].join(":")
           sha = Digest::SHA1.hexdigest(to_encrypt)
-          #the almighty tcp server wants everything hex encoded
+          # 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
-      #a little rescue magic
+      # a little rescue magic
       unless @retries <= 0
-        puts "ERROR: Could not auth, will now exit." 
+        puts "ERROR: Could not auth, will now exit."
         puts "ERROR: Unable to locate cookie, retry in 1 second."
         @retries -= 1
         sleep 1
         data(hexdata)
       end
-    end  
-    
+    end
+
     # encode plain to hex
     def hex_encode(plain)
       return nil if plain.nil?
-      plain.to_s.unpack('H*')[0]
+      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
+      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!
 
@@ -120,12 +119,12 @@ module DBus
     def initialize(socket)
       @socket = socket
       @state = nil
-      @auth_list = [External,DBusCookieSHA1,Anonymous]
+      @auth_list = [External, DBusCookieSHA1, Anonymous]
     end
 
     # Start the authentication process.
     def authenticate
-      if (RbConfig::CONFIG["target_os"] =~ /freebsd/)
+      if RbConfig::CONFIG["target_os"] =~ /freebsd/
         @socket.sendmsg(0.chr, 0, nil, [:SOCKET, :SCM_CREDS, ""])
       else
         @socket.write(0.chr)
@@ -134,13 +133,15 @@ module DBus
       @state = :Starting
       while @state != :Authenticated
         r = next_state
-        return r if not r
+        return r if !r
       end
       true
     end
 
     ##########
+
     private
+
     ##########
 
     # Send an authentication method _meth_ with arguments _args_ to the
@@ -152,42 +153,39 @@ module DBus
 
     # Try authentication using the next authenticator.
     def next_authenticator
-      begin
-        raise AuthenticationFailed if @auth_list.size == 0
-        @authenticator = @auth_list.shift.new
-        auth_msg = ["AUTH", @authenticator.name, @authenticator.authenticate]
-        DBus.logger.debug "auth_msg: #{auth_msg.inspect}"
-        send(auth_msg)
-      rescue AuthenticationFailed
-        @socket.close
-        raise
-      end
+      raise AuthenticationFailed if @auth_list.empty?
+      @authenticator = @auth_list.shift.new
+      auth_msg = ["AUTH", @authenticator.name, @authenticator.authenticate]
+      DBus.logger.debug "auth_msg: #{auth_msg.inspect}"
+      send(auth_msg)
+    rescue AuthenticationFailed
+      @socket.close
+      raise
     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
+      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 )
+        buf = @socket.read(left > 1 ? 1 : left)
         break if buf.nil?
         left -= buf.bytesize
         data += buf
-        break if data.include? crlf #crlf means line finished, the TCP socket keeps on listening, so we break 
+        break if data.include? crlf # crlf means line finished, the TCP socket keeps on listening, so we break
       end
       readline = data.chomp.split(" ")
       DBus.logger.debug "readline: #{readline.inspect}"
-      return readline
+      readline
     end
 
-=begin
-    # Read data (a buffer) from the bus until CR LF is encountered.
-    # Return the buffer without the CR LF characters.
-    def next_msg
-      @socket.readline.chomp.split(" ")
-    end
-=end
+    #     # Read data (a buffer) from the bus until CR LF is encountered.
+    #     # Return the buffer without the CR LF characters.
+    #     def next_msg
+    #       @socket.readline.chomp.split(" ")
+    #     end
 
     # Try to reach the next state based on the current state.
     def next_state
@@ -196,10 +194,10 @@ module DBus
         DBus.logger.debug ":Starting msg: #{msg[0].inspect}"
         case msg[0]
         when "OK"
-          @state = :WaitingForOk    
+          @state = :WaitingForOk
         when "CONTINUE"
           @state = :WaitingForData
-        when "REJECTED" #needed by tcp, unix-path/abstract doesn't get here
+        when "REJECTED" # needed by tcp, unix-path/abstract doesn't get here
           @state = :WaitingForData
         end
       end
@@ -263,7 +261,7 @@ module DBus
           return false
         end
       end
-      return true
+      true
     end # def next_state
   end # class Client
 end # module D-Bus

data/lib/dbus/bus.rb

@@ -8,9 +8,9 @@
 # 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'
+require "socket"
+require "thread"
+require "singleton"
 
 # = D-Bus main module
 #
@@ -28,7 +28,8 @@ module DBus
 
     # Create a new service with a given _name_ on a given _bus_.
     def initialize(name, bus)
-      @name, @bus = name, bus
+      @name = name
+      @bus = bus
       @root = Node.new("/")
     end
 
@@ -40,11 +41,9 @@ module DBus
     # Perform an introspection on all the objects on the service
     # (starting recursively from the root).
     def introspect
-      if block_given?
-        raise NotImplementedError
-      else
-        rec_introspect(@root, "/")
-      end
+      raise NotImplementedError if block_given?
+
+      rec_introspect(@root, "/")
       self
     end
 
@@ -63,7 +62,7 @@ module DBus
         node.object = ProxyObject.new(
           @bus, @name, path,
           api: api
-          )
+        )
       end
       node.object
     end
@@ -78,11 +77,11 @@ module DBus
     # Raises ArgumentError if it is not a DBus::Object.
     # Returns the object, or false if _obj_ was not exported.
     def unexport(obj)
-      raise ArgumentError.new("DBus::Service#unexport() expects a DBus::Object argument") unless obj.kind_of?(DBus::Object)
+      raise ArgumentError, "DBus::Service#unexport() expects a DBus::Object argument" unless obj.is_a?(DBus::Object)
       return false unless obj.path
-      pathSep = obj.path.rindex("/") #last path seperator
-      parent_path = obj.path[1..pathSep-1]
-      node_name = obj.path[pathSep+1..-1]
+      last_path_separator_idx = obj.path.rindex("/")
+      parent_path = obj.path[1..last_path_separator_idx - 1]
+      node_name = obj.path[last_path_separator_idx + 1..-1]
 
       parent_node = get_node(parent_path, false)
       return false unless parent_node
@@ -94,13 +93,10 @@ module DBus
     # true, the the nodes in the path are created if they do not already exist.
     def get_node(path, create = false)
       n = @root
-      path.sub(/^\//, "").split("/").each do |elem|
-        if not n[elem]
-          if not create
-            return nil
-          else
-            n[elem] = Node.new(elem)
-          end
+      path.sub(%r{^/}, "").split("/").each do |elem|
+        if !(n[elem])
+          return nil if !create
+          n[elem] = Node.new(elem)
         end
         n = n[elem]
       end
@@ -111,7 +107,9 @@ module DBus
     end
 
     #########
+
     private
+
     #########
 
     # Perform a recursive retrospection on the given current _node_
@@ -121,16 +119,15 @@ module DBus
       intfs, subnodes = IntrospectXMLParser.new(xml).parse
       subnodes.each do |nodename|
         subnode = node[nodename] = Node.new(nodename)
-        if path == "/"
-          subpath = "/" + nodename
-        else
-          subpath = path + "/" + nodename
-        end
+        subpath = if path == "/"
+                    "/" + nodename
+                  else
+                    path + "/" + nodename
+                  end
         rec_introspect(subnode, subpath)
       end
-      if intfs.size > 0
-        node.object = ProxyObjectFactory.new(xml, @bus, @name, path).build
-      end
+      return if intfs.empty?
+      node.object = ProxyObjectFactory.new(xml, @bus, @name, path).build
     end
   end
 
@@ -156,18 +153,18 @@ module DBus
 "http://www.freedesktop.org/standards/dbus/1.0/introspect.dtd">
 <node>
 '
-      self.each_pair do |k, v|
+      each_pair do |k, _v|
         xml += "<node name=\"#{k}\" />"
       end
       if @object
-        @object.intfs.each_pair do |k, v|
-          xml += %{<interface name="#{v.name}">\n}
+        @object.intfs.each_pair do |_k, v|
+          xml += %(<interface name="#{v.name}">\n)
           v.methods.each_value { |m| xml += m.to_xml }
           v.signals.each_value { |m| xml += m.to_xml }
-          xml +="</interface>\n"
+          xml += "</interface>\n"
         end
       end
-      xml += '</node>'
+      xml += "</node>"
       xml
     end
 
@@ -180,8 +177,8 @@ module DBus
     # Return instance inspect information, used by Node#inspect.
     def sub_inspect
       s = ""
-      if not @object.nil?
-        s += "%x " % @object.object_id
+      if !@object.nil?
+        s += format("%x ", @object.object_id)
       end
       s + "{" + keys.collect { |k| "#{k} => #{self[k].sub_inspect}" }.join(",") + "}"
     end
@@ -208,9 +205,9 @@ module DBus
     def initialize(path)
       @message_queue = MessageQueue.new(path)
       @unique_name = nil
-      @method_call_replies = Hash.new
-      @method_call_msgs = Hash.new
-      @signal_matchrules = Hash.new
+      @method_call_replies = {}
+      @method_call_msgs = {}
+      @signal_matchrules = {}
       @proxy = nil
       @object_root = Node.new("/")
     end
@@ -219,20 +216,20 @@ module DBus
     # 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
+      while (msg = @message_queue.pop(:non_block)) # FIXME: EOFError
         process(msg)
       end
     end
 
     # Tell a bus to register itself on the glib main loop
     def glibize
-      require 'glib2'
+      require "glib2"
       # Circumvent a ruby-glib bug
-      @channels ||= Array.new
+      @channels ||= []
 
       gio = GLib::IOChannel.new(@message_queue.socket.fileno)
       @channels << gio
-      gio.add_watch(GLib::IOChannel::IN) do |c, ch|
+      gio.add_watch(GLib::IOChannel::IN) do |_c, _ch|
         dispatch_message_queue
         true
       end
@@ -326,8 +323,8 @@ module DBus
     </signal>
   </interface>
 </node>
-'
-# This apostroph is for syntax highlighting editors confused by above xml: "
+'.freeze
+    # This apostroph is for syntax highlighting editors confused by above xml: "
 
     # @api private
     # Send a _message_.
@@ -340,11 +337,8 @@ module DBus
       ret = nil
       if reply_handler.nil?
         send_sync(message) do |rmsg|
-          if rmsg.is_a?(Error)
-            raise rmsg
-          else
-            ret = rmsg.params
-          end
+          raise rmsg if rmsg.is_a?(Error)
+          ret = rmsg.params
         end
       else
         on_return(message) do |rmsg|
@@ -371,8 +365,8 @@ module DBus
         send_sync_or_async(m).first
       else
         send_sync_or_async(m) do |*args|
-          # TODO test async introspection, is it used at all?
-          args.shift            # forget the message, pass only the text
+          # TODO: test async introspection, is it used at all?
+          args.shift # forget the message, pass only the text
           reply_handler.call(*args)
           nil
         end
@@ -389,7 +383,7 @@ module DBus
     # The returned object is a ProxyObject that has methods you can call to
     # issue somme METHOD_CALL messages, and to setup to receive METHOD_RETURN
     def introspect(dest, path)
-      if not block_given?
+      if !block_given?
         # introspect in synchronous !
         data = introspect_data(dest, path)
         pof = DBus::ProxyObjectFactory.new(data, self, dest, path)
@@ -416,11 +410,9 @@ module DBus
       # method calls to be serviced arrive before the reply for RequestName
       # (Ticket#29).
       proxy.RequestName(name, NAME_FLAG_REPLACE_EXISTING) do |rmsg, r|
-        if rmsg.is_a?(Error)  # check and report errors first
-	  raise rmsg
-	elsif r != REQUEST_NAME_REPLY_PRIMARY_OWNER
-          raise NameRequestError
-	end
+        # check and report errors first
+        raise rmsg if rmsg.is_a?(Error)
+        raise NameRequestError unless r == REQUEST_NAME_REPLY_PRIMARY_OWNER
       end
       @service = Service.new(name, self)
       @service
@@ -431,13 +423,13 @@ module DBus
     #   ({DBus::ApiOptions#proxy_method_returns_array})
     # Returns the object.
     def proxy
-      if @proxy == nil
+      if @proxy.nil?
         path = "/org/freedesktop/DBus"
         dest = "org.freedesktop.DBus"
         pof = DBus::ProxyObjectFactory.new(
           DBUSXMLINTRO, self, dest, path,
           api: ApiOptions::A0
-          )
+        )
         @proxy = pof.build["org.freedesktop.DBus"]
       end
       @proxy
@@ -446,23 +438,23 @@ module DBus
     # @api private
     # Wait for a message to arrive. Return it once it is available.
     def wait_for_message
-      @message_queue.pop                 # FIXME EOFError
+      @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
+      return if m.nil? # check if somethings wrong
       @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
-      
+      return if retm.nil? # check if somethings wrong
+
       process(retm)
-      while @method_call_replies.has_key? m.serial
+      while @method_call_replies.key? m.serial
         retm = wait_for_message
         process(retm)
       end
@@ -496,23 +488,23 @@ module DBus
 
     def remove_match(mr)
       mrs = mr.to_s
-      unless @signal_matchrules.delete(mrs).nil?
-        # don't remove nonexisting matches.
-        # FIXME if we do try, the Error.MatchRuleNotFound is *not* raised
-        # and instead is reported as "no return code for nil"
-        proxy.RemoveMatch(mrs)
-      end
+      rule_existed = @signal_matchrules.delete(mrs).nil?
+      # don't remove nonexisting matches.
+      return if rule_existed
+      # FIXME: if we do try, the Error.MatchRuleNotFound is *not* raised
+      # and instead is reported as "no return code for nil"
+      proxy.RemoveMatch(mrs)
     end
 
     # @api private
     # Process a message _m_ based on its type.
     def process(m)
-      return if m.nil? #check if somethings wrong
+      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
+        raise InvalidPacketException if m.reply_serial.nil?
         mcs = @method_call_replies[m.reply_serial]
-        if not mcs
+        if !mcs
           DBus.logger.debug "no return code for mcs: #{mcs.inspect} m: #{m.inspect}"
         else
           if m.message_type == Message::ERROR
@@ -528,20 +520,20 @@ module DBus
           DBus.logger.debug "Got method call on /org/freedesktop/DBus"
         end
         node = @service.get_node(m.path)
-        if not node
+        if !node
           reply = Message.error(m, "org.freedesktop.DBus.Error.UnknownObject",
                                 "Object #{m.path} doesn't exist")
           @message_queue.push(reply)
         # handle introspectable as an exception:
-        elsif m.interface == "org.freedesktop.DBus.Introspectable" and
-            m.member == "Introspect"
+        elsif m.interface == "org.freedesktop.DBus.Introspectable" &&
+              m.member == "Introspect"
           reply = Message.new(Message::METHOD_RETURN).reply_to(m)
           reply.sender = @unique_name
           reply.add_param(Type::STRING, node.to_xml)
           @message_queue.push(reply)
         else
           obj = node.object
-          return if obj.nil?    # FIXME, pushes no reply
+          return if obj.nil? # FIXME, pushes no reply
           obj.dispatch(m) if obj
         end
       when DBus::Message::SIGNAL
@@ -565,7 +557,7 @@ module DBus
       # anything
       Service.new(name, self)
     end
-    alias :[] :service
+    alias [] service
 
     # @api private
     # Emit a signal event for the given _service_, object _obj_, interface
@@ -602,7 +594,6 @@ module DBus
     end
   end # class Connection
 
-
   # = D-Bus session bus class
   #
   # The session bus is a session specific bus (mostly for desktop use).
@@ -625,18 +616,18 @@ module DBus
     def self.address_from_file
       # systemd uses /etc/machine-id
       # traditional dbus uses /var/lib/dbus/machine-id
-      machine_id_path = Dir['{/etc,/var/lib/dbus,/var/db/dbus}/machine-id'].first
+      machine_id_path = Dir["{/etc,/var/lib/dbus,/var/db/dbus}/machine-id"].first
       return nil unless machine_id_path
       machine_id = File.read(machine_id_path).chomp
 
       display = ENV["DISPLAY"][/:(\d+)\.?/, 1]
 
       bus_file_path = File.join(ENV["HOME"], "/.dbus/session-bus/#{machine_id}-#{display}")
-      return nil unless File.exists?(bus_file_path)
+      return nil unless File.exist?(bus_file_path)
 
       File.open(bus_file_path).each_line do |line|
         if line =~ /^DBUS_SESSION_BUS_ADDRESS=(.*)/
-          address = $1
+          address = Regexp.last_match(1)
           return address[/\A'(.*)'\z/, 1] || address[/\A"(.*)"\z/, 1] || address
         end
       end
@@ -648,7 +639,6 @@ module DBus
     include Singleton
   end
 
-
   # = D-Bus system bus class
   #
   # The system bus is a system-wide bus mostly used for global or
@@ -663,22 +653,21 @@ module DBus
       send_hello
     end
   end
-  
+
   # = D-Bus remote (TCP) bus class
   #
-  # This class may be used when connecting to remote (listening on a TCP socket) 
+  # This class may be used when connecting to remote (listening on a TCP socket)
   # busses. You can also use it to connect to other non-standard path busses.
-  # 
+  #
   # The specified socket_name should look like this:
   # (for TCP)         tcp:host=127.0.0.1,port=2687
   # (for Unix-socket) unix:path=/tmp/my_funky_bus_socket
-  # 
-  # you'll need to take care about authentification then, more info here: 
+  #
+  # you'll need to take care about authentification then, more info here:
   # http://github.com/pangdudu/ruby-dbus/blob/master/README.rdoc
   class RemoteBus < Connection
-
     # Get the remote bus.
-    def initialize socket_name
+    def initialize(socket_name)
       super(socket_name)
       send_hello
     end
@@ -691,13 +680,13 @@ module DBus
 
   # Shortcut for the {SystemBus} instance
   # @return [Connection]
-  def DBus.system_bus
+  def self.system_bus
     SystemBus.instance
   end
 
   # Shortcut for the {SessionBus} instance
   # @return [Connection]
-  def DBus.session_bus
+  def self.session_bus
     SessionBus.instance
   end
 
@@ -709,7 +698,7 @@ module DBus
   class Main
     # Create a new main event loop.
     def initialize
-      @buses = Hash.new
+      @buses = {}
       @quitting = false
     end
 
@@ -728,11 +717,11 @@ module DBus
       # before blocking, empty the buffers
       # https://bugzilla.novell.com/show_bug.cgi?id=537401
       @buses.each_value do |b|
-        while m = b.message_queue.message_from_buffer_nonblock
+        while (m = b.message_queue.message_from_buffer_nonblock)
           b.process(m)
         end
       end
-      while not @quitting and not @buses.empty?
+      while !@quitting && !@buses.empty?
         ready = IO.select(@buses.keys, [], [], 5) # timeout 5 seconds
         next unless ready # timeout exceeds so continue unless quitting
         ready.first.each do |socket|
@@ -743,7 +732,7 @@ module DBus
             @buses.delete socket # this bus died
             next
           end
-          while m = b.message_queue.message_from_buffer_nonblock
+          while (m = b.message_queue.message_from_buffer_nonblock)
             b.process(m)
           end
         end