ruby-dbus 0.15.0 → 0.16.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06e7540fb8468a14731fd8d988828dfe349e687a
-  data.tar.gz: 86dbf9d6e8c1947bb87ef4f1ef1a4aefa337f1f6
+SHA256:
+  metadata.gz: c8a530c6d561a17c6179bda15319036a806f1a42b427033e96caccfc738ebf7b
+  data.tar.gz: 959143cab388b528354cc569c698a8c99dc79bbca1b21dbdcc064e212b8794a2
 SHA512:
-  metadata.gz: 9347931528a1e83c9b4747b232c3f6e9f8da3968efa7f5fe4a473d6333783a0643823973e91efb35f1c7676a6da0ee6a16eade4176842de6fb4e7aa58c6d5304
-  data.tar.gz: c814265c6472dc3b715a0f99ca5c6ea920d26a08dcde3eff573a889779320dc00292d637f976067ba3f6e5ae86cbccc099e56430adf8109147e910169f59e44a
+  metadata.gz: 41d4ff1294958f67efac62ae0d1b326728617976ea944f3c3374f7156bf33632e9e072260f002c11ca44b099113d75e5ecc58f67c3d2c9d34666f6abe92bdbb3
+  data.tar.gz: c93e54662d3cf01a9b0ac0a2e5c70d0efc78da1758349cfe6209cba37fa707b7334503518a7e0b4f53d754aff22d5ff53c2d7f8c2d8c32e6df9b097a1bf0f34b

data/NEWS.md

@@ -2,10 +2,19 @@
 
 ## Unreleased
 
+## Ruby D-Bus 0.16.0 - 2019-10-15
+
+API:
+ * An invalid service name or an invalid object path will raise
+   instead of being sent to the bus. The bus would then drop the connection,
+   producing EOFError here ([#80][]).
+
+[#80]: https://github.com/mvidner/ruby-dbus/issues/80
+
 ## Ruby D-Bus 0.15.0 - 2018-04-30
 
 API:
- * Accessing an unknown interface will raise instead of returning nil ([#74]).
+ * Accessing an unknown interface will raise instead of returning nil ([#74][]).
 
 Bug fixes:
  * Fixed a conflict with activesupport 5.2 ([#71])

data/VERSION

@@ -1 +1 @@
-0.15.0
+0.16.0

data/lib/dbus.rb

@@ -11,14 +11,16 @@
 require_relative "dbus/api_options"
 require_relative "dbus/auth"
 require_relative "dbus/bus"
+require_relative "dbus/bus_name"
 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/object"
+require_relative "dbus/object_path"
 require_relative "dbus/proxy_object"
 require_relative "dbus/proxy_object_factory"
 require_relative "dbus/proxy_object_interface"

data/lib/dbus/bus.rb

@@ -17,7 +17,7 @@ require "singleton"
 # Module containing all the D-Bus modules and classes.
 module DBus
   # This represents a remote service. It should not be instantiated directly
-  # Use Bus::service()
+  # Use {Bus#service}
   class Service
     # The service name.
     attr_reader :name
@@ -28,7 +28,7 @@ module DBus
 
     # Create a new service with a given _name_ on a given _bus_.
     def initialize(name, bus)
-      @name = name
+      @name = BusName.new(name)
       @bus = bus
       @root = Node.new("/")
     end
@@ -458,6 +458,9 @@ module DBus
         retm = wait_for_message
         process(retm)
       end
+    rescue EOFError
+      new_err = DBus::Error.new("Connection dropped after we sent #{m.inspect}")
+      raise new_err
     end
 
     # @api private

data/lib/dbus/bus_name.rb

@@ -0,0 +1,27 @@
+# This file is part of the ruby-dbus project
+# Copyright (C) 2019 Martin Vidner
+#
+# This library is free software; you can redistribute it and/or
+# 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.
+
+module DBus
+  # A {::String} that validates at initialization time
+  # @see https://dbus.freedesktop.org/doc/dbus-specification.html#message-protocol-names-bus
+  class BusName < String
+    # @raise Error if not a valid bus name
+    def initialize(s)
+      unless self.class.valid?(s)
+        raise DBus::Error, "Invalid bus name #{s.inspect}"
+      end
+      super
+    end
+
+    def self.valid?(s)
+      s.size <= 255 &&
+        (s =~ /\A:[A-Za-z0-9_-]+(\.[A-Za-z0-9_-]+)+\z/ ||
+         s =~ /\A[A-Za-z_-][A-Za-z0-9_-]*(\.[A-Za-z_-][A-Za-z0-9_-]*)+\z/)
+    end
+  end
+end

data/lib/dbus/introspect.rb

@@ -14,10 +14,6 @@ module DBus
   # Regular expressions that should match all interface names.
   INTERFACE_ELEMENT_RE = /^[A-Za-z][A-Za-z0-9_]*$/
 
-  # Exception raised when an unknown signal is used.
-  class UnknownSignal < Exception
-  end
-
   # Exception raised when an invalid class definition is encountered.
   class InvalidClassDefinition < Exception
   end

data/lib/dbus/message_queue.rb

@@ -11,6 +11,7 @@ require "fcntl"
 require "socket"
 
 module DBus
+  # Encapsulates a socket so that we can {#push} and {#pop} {Message}s.
   class MessageQueue
     # The socket that is used to connect with the bus.
     attr_reader :socket
@@ -22,10 +23,10 @@ module DBus
       connect
     end
 
-    # TODO: failure modes
-    #
-    # If _non_block_ is true, return nil instead of waiting
-    # EOFError may be raised
+    # @param non_block [Boolean] if true, return nil instead of waiting
+    # @return [Message,nil] one message or nil if unavailable
+    # @raise EOFError
+    # @todo failure modes
     def pop(non_block = false)
       buffer_from_socket_nonblock
       message = message_from_buffer_nonblock
@@ -124,14 +125,14 @@ module DBus
 
     # Initialize the connection to the bus.
     def init_connection
-      @client = Client.new(@socket)
-      @client.authenticate
+      client = Client.new(@socket)
+      client.authenticate
     end
 
     public # FIXME: fix Main loop instead
 
     # Get and remove one message from the buffer.
-    # Return the message or nil.
+    # @return [Message,nil] the message or nil if unavailable
     def message_from_buffer_nonblock
       return nil if @buffer.empty?
       ret = nil
@@ -139,7 +140,7 @@ module DBus
         ret, size = Message.new.unmarshall_buffer(@buffer)
         @buffer.slice!(0, size)
       rescue IncompleteBufferException
-        # fall through, let ret be null
+        # fall through, let ret remain nil
       end
       ret
     end
@@ -149,7 +150,8 @@ module DBus
 
     # Fill (append) the buffer from data that might be available on the
     # socket.
-    # EOFError may be raised
+    # @return [void]
+    # @raise EOFError
     def buffer_from_socket_nonblock
       @buffer += @socket.read_nonblock(MSG_BUF_SIZE)
     rescue EOFError

data/lib/dbus/{export.rb → object.rb}

@@ -1,5 +1,3 @@
-# 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
 #
@@ -16,7 +14,7 @@ module DBus
   # = Exportable D-Bus object class
   #
   # Objects that are going to be exported by a D-Bus service
-  # should inherit from this class. At the client side, use ProxyObject.
+  # should inherit from this class. At the client side, use {ProxyObject}.
   class Object
     # The path of the object.
     attr_reader :path
@@ -127,5 +125,5 @@ module DBus
     def self.make_method_name(intfname, methname)
       "#{intfname}%%#{methname}"
     end
-  end # class Object
-end # module DBus
+  end
+end

data/lib/dbus/object_path.rb

@@ -0,0 +1,24 @@
+# This file is part of the ruby-dbus project
+# Copyright (C) 2019 Martin Vidner
+#
+# This library is free software; you can redistribute it and/or
+# 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.
+
+module DBus
+  # A {::String} that validates at initialization time
+  class ObjectPath < String
+    # @raise Error if not a valid object path
+    def initialize(s)
+      unless self.class.valid?(s)
+        raise DBus::Error, "Invalid object path #{s.inspect}"
+      end
+      super
+    end
+
+    def self.valid?(s)
+      s == "/" || s =~ %r{\A(/[A-Za-z0-9_]+)+\z}
+    end
+  end
+end

data/lib/dbus/proxy_object.rb

@@ -36,7 +36,7 @@ module DBus
     def initialize(bus, dest, path, api: ApiOptions::CURRENT)
       @bus = bus
       @destination = dest
-      @path = path
+      @path = ObjectPath.new(path)
       @introspected = false
       @interfaces = {}
       @subnodes = []

data/ruby-dbus.gemspec

@@ -7,7 +7,7 @@ GEMSPEC = Gem::Specification.new do |s|
   s.summary = "Ruby module for interaction with D-Bus"
   s.description = "Pure Ruby module for interaction with D-Bus IPC system"
   s.version = File.read("VERSION").strip
-  s.license = "LGPL v2.1"
+  s.license = "LGPL-2.1"
   s.author = "Ruby DBus Team"
   s.email = "martin.github@vidner.net"
   s.homepage = "https://github.com/mvidner/ruby-dbus"

data/spec/bus_name_spec.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env rspec
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::BusName do
+  describe ".valid?" do
+    it "recognizes valid bus names" do
+      expect(described_class.valid?("org.freedesktop.DBus")).to be_truthy
+      expect(described_class.valid?(":1.42")).to be_truthy
+      expect(described_class.valid?("org._7_zip.Archiver")).to be_truthy
+    end
+
+    it "recognizes invalid bus names" do
+      expect(described_class.valid?("")).to be_falsey
+      expect(described_class.valid?("Empty..Component")).to be_falsey
+      expect(described_class.valid?(".Empty.First.Component")).to be_falsey
+      expect(described_class.valid?("Empty.Last.Component.")).to be_falsey
+      expect(described_class.valid?("Invalid.Ch@r@cter")).to be_falsey
+      expect(described_class.valid?("/Invalid-Character")).to be_falsey
+      long_name = "a." + ("long." * 100) + "name"
+      expect(described_class.valid?(long_name)).to be_falsey
+      expect(described_class.valid?("org.7_zip.Archiver")).to be_falsey
+    end
+  end
+end

data/spec/client_robustness_spec.rb

@@ -0,0 +1,25 @@
+#!/usr/bin/env rspec
+# Test that a client survives various error cases
+require_relative "spec_helper"
+require "dbus"
+
+describe "ClientRobustnessTest" do
+  before(:each) do
+    @bus = DBus::ASessionBus.new
+    @svc = @bus.service("org.ruby.service")
+  end
+
+  context "when the bus name is invalid" do
+    it "tells the user the bus name is invalid" do
+      # user mistake, should be "org.ruby.service"
+      expect { @bus.service(".org.ruby.service") }.to raise_error(DBus::Error)
+    end
+  end
+
+  context "when the object path is invalid" do
+    it "tells the user the path is invalid" do
+      # user mistake, should be "/org/ruby/MyInstance"
+      expect { @svc.object("org.ruby.MyInstance") }.to raise_error(DBus::Error)
+    end
+  end
+end

data/spec/object_path_spec.rb

@@ -0,0 +1,23 @@
+#!/usr/bin/env rspec
+require_relative "spec_helper"
+require "dbus"
+
+describe DBus::ObjectPath do
+  describe ".valid?" do
+    it "recognizes valid paths" do
+      expect(described_class.valid?("/")).to be_truthy
+      expect(described_class.valid?("/99Numbers/_And_Underscores/anywhere")).to be_truthy
+      long_name = "/A23456789" * 42
+      # no 255 character limit for object paths
+      expect(described_class.valid?(long_name)).to be_truthy
+    end
+
+    it "recognizes invalid paths" do
+      expect(described_class.valid?("")).to be_falsey
+      expect(described_class.valid?("/Empty//Component")).to be_falsey
+      expect(described_class.valid?("/EmptyLastComponent/")).to be_falsey
+      expect(described_class.valid?("/Invalid Character")).to be_falsey
+      expect(described_class.valid?("/Invalid-Character")).to be_falsey
+    end
+  end
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: ruby-dbus
 version: !ruby/object:Gem::Version
-  version: 0.15.0
+  version: 0.16.0
 platform: ruby
 authors:
 - Ruby DBus Team
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2018-04-30 00:00:00.000000000 Z
+date: 2019-10-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: coveralls
@@ -127,16 +127,18 @@ files:
 - lib/dbus/api_options.rb
 - lib/dbus/auth.rb
 - lib/dbus/bus.rb
+- lib/dbus/bus_name.rb
 - lib/dbus/core_ext/class/attribute.rb
 - lib/dbus/core_ext/module/redefine_method.rb
 - lib/dbus/error.rb
-- lib/dbus/export.rb
 - lib/dbus/introspect.rb
 - lib/dbus/logger.rb
 - lib/dbus/marshall.rb
 - lib/dbus/matchrule.rb
 - lib/dbus/message.rb
 - lib/dbus/message_queue.rb
+- lib/dbus/object.rb
+- lib/dbus/object_path.rb
 - lib/dbus/proxy_object.rb
 - lib/dbus/proxy_object_factory.rb
 - lib/dbus/proxy_object_interface.rb
@@ -147,12 +149,15 @@ files:
 - spec/binding_spec.rb
 - spec/bus_and_xml_backend_spec.rb
 - spec/bus_driver_spec.rb
+- spec/bus_name_spec.rb
 - spec/bus_spec.rb
 - spec/byte_array_spec.rb
+- spec/client_robustness_spec.rb
 - spec/err_msg_spec.rb
 - spec/introspect_xml_parser_spec.rb
 - spec/introspection_spec.rb
 - spec/main_loop_spec.rb
+- spec/object_path_spec.rb
 - spec/property_spec.rb
 - spec/proxy_object_spec.rb
 - spec/server_robustness_spec.rb
@@ -172,7 +177,7 @@ files:
 - spec/variant_spec.rb
 homepage: https://github.com/mvidner/ruby-dbus
 licenses:
-- LGPL v2.1
+- LGPL-2.1
 metadata: {}
 post_install_message: 
 rdoc_options: []
@@ -190,7 +195,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
 requirements: []
 rubyforge_project: 
-rubygems_version: 2.2.5
+rubygems_version: 2.7.6
 signing_key: 
 specification_version: 4
 summary: Ruby module for interaction with D-Bus