ruby-dbus 0.16.0 → 0.18.0.beta2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c8a530c6d561a17c6179bda15319036a806f1a42b427033e96caccfc738ebf7b
-  data.tar.gz: 959143cab388b528354cc569c698a8c99dc79bbca1b21dbdcc064e212b8794a2
+  metadata.gz: 0c89eebb575c67de57670fdc2e8b70b4c08dcaf7fc3c1bad858f1d23869571c1
+  data.tar.gz: 4a4793ed412ebd25a636bed4dafa5367800658eb5d52d853ef1b2c0df0e3e272
 SHA512:
-  metadata.gz: 41d4ff1294958f67efac62ae0d1b326728617976ea944f3c3374f7156bf33632e9e072260f002c11ca44b099113d75e5ecc58f67c3d2c9d34666f6abe92bdbb3
-  data.tar.gz: c93e54662d3cf01a9b0ac0a2e5c70d0efc78da1758349cfe6209cba37fa707b7334503518a7e0b4f53d754aff22d5ff53c2d7f8c2d8c32e6df9b097a1bf0f34b
+  metadata.gz: c03aa469aebb197943266b9147fba6b55383a22248e0814b0c2f7799c2e95d43b555f80a919c236a437c90805cbd7647498c1f8b1cf901d4a298da0b2d81e50c
+  data.tar.gz: f7906b8c2308909cb8974240f3d8de3bc3e10a481fc15c91acd7af5526f405fd314df8b1a424683009a64dfc52ebfa9fa2c73497f8215cb403d80ab02866d56a

data/NEWS.md

@@ -2,6 +2,52 @@
 
 ## Unreleased
 
+## Ruby D-Bus 0.18.0.beta2 - 2022-04-04
+
+API:
+ * Renamed the DBus::Type::Type class to DBus::Type
+   (which was previously a module).
+ * Introduced DBus::Data classes, use them in Properties.Get,
+   Properties.GetAll to return correct types as declared (still [#97][]).
+
+Bug fixes:
+ * Signature validation: Ensure DBus.type produces a valid Type
+ * Detect more malformed messages: non-NUL padding bytes, variants with
+   multiple or no value.
+ * Added thorough tests (`spec/data/marshall.yaml`) to detect nearly all
+   invalid data at unmarshalling time.
+
+## Ruby D-Bus 0.18.0.beta1 - 2022-02-24
+
+API:
+ * D-Bus structs have been passed as Ruby arrays. Now these arrays are frozen.
+ * Ruby structs can be used as D-Bus structs.
+
+Bug fixes:
+ * Returning the value for o.fd.DBus.Properties.Get, use the specific property
+   signature, not the generic Variant ([#97][]).
+
+Requirements:
+ * Require Ruby 2.4, because of RuboCop 1.0.
+
+[#97]: https://github.com/mvidner/ruby-dbus/issues/97
+
+## Ruby D-Bus 0.17.0 - 2022-02-11
+
+API:
+ * Export properties with `dbus_attr_accessor`, `dbus_reader` etc. ([#86][]).
+
+Bug fixes:
+ * Depend on rexml which is separate since Ruby 3.0 ([#87][],
+   by Toshiaki Asai).
+   Nokogiri is faster but bigger so it remains optional.
+ * Fix connection in case ~/.dbus-keyrings has multiple cookies, showing
+   as "Oops: undefined method `zero?' for nil:NilClass".
+ * Add the missing name to the root introspection node.
+
+[#86]: https://github.com/mvidner/ruby-dbus/pull/86
+[#87]: https://github.com/mvidner/ruby-dbus/pull/87
+
 ## Ruby D-Bus 0.16.0 - 2019-10-15
 
 API:

data/README.md

@@ -11,14 +11,13 @@ Ruby D-Bus is a pure Ruby library for writing clients and services for D-Bus.
 [![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
+[Build Status]: https://github.com/mvidner/ruby-dbus/actions?query=branch%3Amaster
 [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?branch=master
+[BS img]: https://github.com/mvidner/ruby-dbus/workflows/CI/badge.svg?branch=master
 [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
@@ -32,7 +31,6 @@ via [UPower](http://upower.freedesktop.org/docs/UPower.html#UPower:OnBattery)
     sysbus = DBus.system_bus
     upower_service   = sysbus["org.freedesktop.UPower"]
     upower_object    = upower_service["/org/freedesktop/UPower"]
-    upower_object.introspect
     upower_interface = upower_object["org.freedesktop.UPower"]
     on_battery       = upower_interface["OnBattery"]
     if on_battery
@@ -43,7 +41,7 @@ via [UPower](http://upower.freedesktop.org/docs/UPower.html#UPower:OnBattery)
 
 ## Requirements
 
-- Ruby 2.0 or newer.
+- Ruby 2.4 or newer.
 
 
 ## Installation

data/Rakefile

@@ -1,7 +1,8 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 require "rake"
 require "fileutils"
-include FileUtils
 require "tmpdir"
 require "rspec/core/rake_task"
 begin
@@ -9,6 +10,12 @@ begin
 rescue LoadError
   nil
 end
+begin
+  require "yard"
+rescue LoadError
+  nil
+end
+
 require "packaging"
 
 Packaging.configuration do |conf|
@@ -38,12 +45,6 @@ RSpec::Core::RakeTask.new("bare:spec")
   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
 
@@ -68,4 +69,13 @@ namespace :doc do
   end
 end
 
-RuboCop::RakeTask.new if Object.const_defined? :RuboCop
+if Object.const_defined? :RuboCop
+  RuboCop::RakeTask.new
+else
+  desc "Run RuboCop (dummy)"
+  task :rubocop do
+    warn "RuboCop not installed"
+  end
+end
+
+YARD::Rake::YardocTask.new if Object.const_defined? :YARD

data/VERSION

@@ -1 +1 @@
-0.16.0
+0.18.0.beta2

data/doc/Reference.md

@@ -153,7 +153,7 @@ To receive signals for a specific object and interface, use
 
 D-Bus booleans, numbers, strings, arrays and dictionaries become their straightforward Ruby counterparts.
 
-Structs become arrays.
+Structs become frozen arrays.
 
 Object paths become strings.
 
@@ -171,7 +171,7 @@ by the D-Bus signature.
 If the signature expects a Variant
 (which is the case for all Properties!) then an explicit mechanism is needed.
 
-1. A pair [{DBus::Type::Type}, value] specifies to marshall *value* as
+1. A pair [{DBus::Type}, value] specifies to marshall *value* as
    that specified type.
    The pair can be produced by {DBus.variant}(signature, value) which
    gives the  same result as [{DBus.type}(signature), value].
@@ -179,7 +179,7 @@ If the signature expects a Variant
    ISSUE: using something else than cryptic signatures is even more painful
    than remembering the signatures!
 
-        foo_i["Bar"] = DBus.variant("au", [0, 1, 1, 2, 3, 5, 8])
+   `foo_i["Bar"] = DBus.variant("au", [0, 1, 1, 2, 3, 5, 8])`
 
 2. Other values are tried to fit one of these:
    Boolean, Double, Array of Variants, Hash of String keyed Variants,
@@ -190,11 +190,18 @@ If the signature expects a Variant
    type. This will hit you when you rely on method (2) but happen to have
    a particular string value in an array.
 
+##### Structs
+
+If a **STRUCT** `(...)` is expected you may pass
+
+- an [Array](https://ruby-doc.org/core/Array.html) (frozen is fine)
+- a [Struct](https://ruby-doc.org/core/Struct.html)
+
 ##### Byte Arrays
 
 If a byte array (`ay`) is expected you can pass a String too.
 The bytes sent are according to the string's
-[encoding](http://ruby-doc.org/core-2.0.0/Encoding.html).
+[encoding](http://ruby-doc.org/core/Encoding.html).
 
 ##### nil
 
@@ -244,14 +251,97 @@ When you want to provide a DBus API.
 (check that client and service side have their counterparts)
 
 ### Basic
+
 #### Exporting a Method
+
 ##### Interfaces
+
 ##### Methods
+
 ##### Bus Names
+
 ##### Errors
+
 #### Exporting Properties
+
+Similar to plain Ruby attributes, declared with
+
+- {https://docs.ruby-lang.org/en/3.1/Module.html#method-i-attr_accessor attr_accessor}
+- {https://docs.ruby-lang.org/en/3.1/Module.html#method-i-attr_reader attr_reader}
+- {https://docs.ruby-lang.org/en/3.1/Module.html#method-i-attr_writer attr_writer}
+
+These methods declare the attributes and export them as properties:
+
+- {DBus::Object.dbus_attr_accessor}
+- {DBus::Object.dbus_attr_reader}
+- {DBus::Object.dbus_attr_writer}
+
+For making properties out of Ruby methods (which are not attributes), use:
+
+- {DBus::Object.dbus_accessor}
+- {DBus::Object.dbus_reader}
+- {DBus::Object.dbus_writer}
+
+Note that the properties are declared in the Ruby naming convention with
+`snake_case` and D-Bus sees them `CamelCased`. Use the `dbus_name` argument
+for overriding this.
+
+ 
+
+    class Note < DBus::Object
+      dbus_interface "net.vidner.Example.Properties" do
+        # A read-write property "Title",
+        # with `title` and `title=` accessing @title.
+        dbus_attr_accessor :title, DBus::Type::STRING
+
+        # A read-only property "Author"
+        # (type specified via DBus signature)
+        # with `author` reading `@author`
+        dbus_attr_reader :author, "s"
+
+        # A read-only property `Clock`
+        def clock
+          Time.now.to_s
+        end
+        dbus_reader :clock, "s"
+
+        # Name mapping: `CreationTime`
+        def creation_time
+          "1993-01-01 00:00:00 +0100"
+        end
+        dbus_reader :creation_time, "s"
+
+        dbus_attr_accessor :book_volume, DBus::Type::VARIANT, dbus_name: "Volume"
+      end
+
+      dbus_interface "net.vidner.Example.Audio" do
+        dbus_attr_accessor :speaker_volume, DBus::Type::BYTE, dbus_name: "Volume"
+      end
+
+      # Must assign values because `nil` would crash our connection
+      def initialize(opath)
+        super
+        @title = "Ahem"
+        @author = "Martin"
+        @book_volume = 1
+        @speaker_volume = 11
+      end
+    end
+
+    obj = Note.new("/net/vidner/Example/Properties")
+
+    bus = DBus::SessionBus.instance
+    service = bus.request_service("net.vidner.Example")
+    service.export(obj)
+
+    main = DBus::Main.new
+    main << bus
+    main.run
+
 ### Advanced
+
 #### Inheritance
+
 #### Names
 
 Specification Conformance

data/examples/doc/_extract_examples

@@ -1,9 +1,14 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 if ARGV[0].nil?
   puts "Usage: #{$PROGRAM_NAME} file.md"
   exit
 end
 
+base_url = "https://github.com/mvidner/ruby-dbus/blob/master/"
+base_url += ARGV[0].gsub("../", "")
+
 File.open(ARGV[0]) do |f|
   title = nil
   setup = ""
@@ -20,7 +25,9 @@ File.open(ARGV[0]) do |f|
           setup = example
         else
           File.open("#{basename}.rb", "w") do |e|
+            anchor = title.downcase.gsub(/ +/, "-")
             e.write setup
+            e.write "# #{base_url}##{anchor}\n"
             e.write example
             e.chmod(0o755)
           end

data/examples/gdbus/gdbus

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # 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
@@ -103,11 +105,12 @@ class DBusUI
 
   def beautify_method(meth)
     # Damn, this need to be rewritten :p
-    s = meth.name + "("
-    if meth.is_a?(DBus::Method)
+    s = "#{meth.name}("
+    case meth
+    when DBus::Method
       s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" } +
             meth.rets.collect { |a| "out #{a[0]}:#{a[1]}" }).join(", ")
-    elsif meth.is_a?(DBus::Signal)
+    when DBus::Signal
       s += (meth.params.collect { |a| "in #{a[0]}:#{a[1]}" }).join(", ")
     end
     s += ")"
@@ -119,25 +122,26 @@ class DBusUI
     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
+    return unless selected
+
+    intf = selected[1]
+    return unless intf
+
+    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
 
@@ -145,11 +149,12 @@ class DBusUI
     name = view.model.get_iter(path)[0]
     puts "Clicked on: #{name.inspect}"
     type = view.model.get_iter(path)[1]
-    if type == "M"
+    case type
+    when "M"
       method = view.model.get_iter(path)[2]
       intf = view.model.get_iter(path)[3]
       MethodCallWindow.new(@window, intf, method).run
-    elsif type == "S"
+    when "S"
       signal = view.model.get_iter(path)[2]
       intf = view.model.get_iter(path)[3]
       mr = DBus::MatchRule.new.from_signal(intf, signal)
@@ -204,6 +209,7 @@ class DBusUI
     end
 
     return unless ENABLE_SYSTEM
+
     DBus::SystemBus.instance.proxy.ListNames do |_msg, names|
       fill_treeview(DBus::SystemBus.instance, @systemtreeview, names)
     end
@@ -217,6 +223,7 @@ class DBusUI
     end
 
     return if node.object.nil?
+
     node.object.interfaces.sort.each do |ifname|
       subiter = model.append(iter)
       subiter[0] = ifname

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

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # Trivial network interface lister using NetworkManager.
 # NetworkManager does not support introspection, so the api is not that sexy.

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

@@ -1,4 +1,6 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
+
 #
 # Trivial network interface lister using NetworkManager.
 # NetworkManager does not support introspection, so the api is not that sexy.
@@ -11,4 +13,4 @@ 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"])
+p poi.GetMetadataForFilesInFolder(-1, "#{ENV["HOME"]}/Desktop", ["File:Name", "File:Size"])

data/examples/rhythmbox/playpause.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 bus = DBus::SessionBus.instance
@@ -13,7 +14,7 @@ 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 + " "
+  print "#{msg.member} "
   puts first_param
 end
 

data/examples/service/call_service.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 
@@ -14,7 +15,7 @@ player.test_variant(["s", "coucou"])
 player.on_signal("SomethingJustHappened") do |u, v|
   puts "SomethingJustHappened: #{u} #{v}"
 end
-player.hello("8=======D", "(_._)")
+player.hello("Hey", "there!")
 p player["org.ruby.AnotherInterface"].Reverse("Hello world!")
 
 main = DBus::Main.new

data/examples/service/complex-property.rb

@@ -0,0 +1,21 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "dbus"
+
+# Complex property
+class Test < DBus::Object
+  dbus_interface "net.vidner.Scratch" do
+    dbus_attr_reader :progress, "(stttt)"
+  end
+
+  def initialize(opath)
+    @progress = ["working", 1, 0, 100, 42].freeze
+    super(opath)
+  end
+end
+
+bus = DBus::SessionBus.instance
+svc = bus.request_service("net.vidner.Scratch")
+svc.export(Test.new("/net/vidner/Scratch"))
+DBus::Main.new.tap { |m| m << bus }.run

data/examples/service/service_newapi.rb

@@ -1,7 +1,7 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
-require "thread"
 Thread.abort_on_exception = true
 
 class Test < DBus::Object

data/examples/simple/call_introspect.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 

data/examples/simple/get_id.rb

@@ -1,7 +1,8 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
 
 # find the library without external help
-$LOAD_PATH.unshift File.expand_path("../../../lib", __FILE__)
+$LOAD_PATH.unshift File.expand_path("../../lib", __dir__)
 
 require "dbus"
 

data/examples/simple/properties.rb

@@ -1,4 +1,6 @@
 #! /usr/bin/env ruby
+# frozen_string_literal: true
+
 require "dbus"
 
 bus = DBus::SystemBus.instance

data/examples/utils/listnames.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 

data/examples/utils/notify.rb

@@ -1,4 +1,5 @@
 #!/usr/bin/env ruby
+# frozen_string_literal: true
 
 require "dbus"
 

data/lib/dbus/api_options.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2016 Martin Vidner
 #
@@ -9,6 +11,13 @@
 module DBus
   class ApiOptions
     # https://github.com/mvidner/ruby-dbus/issues/30
+    # @return [Boolean]
+    #   - true: a proxy (client-side) method will return an array
+    #     even for the most common case where the method is declared
+    #     to have only one 'out parameter'
+    #   - false: a proxy (client-side) method will return
+    #     - one value for the only 'out parameter'
+    #     - an array with more 'out parameters'
     attr_accessor :proxy_method_returns_array
 
     A0 = ApiOptions.new

data/lib/dbus/auth.rb

@@ -1,3 +1,5 @@
+# frozen_string_literal: true
+
 # This file is part of the ruby-dbus project
 # Copyright (C) 2007 Arnaud Cornet and Paul van Tilburg
 #
@@ -73,7 +75,7 @@ module DBus
       path = File.join(ENV["HOME"], ".dbus-keyrings", context)
       DBus.logger.debug "path: #{path.inspect}"
       File.foreach(path) do |line|
-        if line.index(id).zero?
+        if line.start_with?(id)
           # Right line of file, read cookie
           cookie = line.split(" ")[2].chomp
           DBus.logger.debug "cookie: #{cookie.inspect}"
@@ -87,27 +89,28 @@ module DBus
           return response
         end
       end
+      return if @retries <= 0
+
       # a little rescue magic
-      unless @retries <= 0
-        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
+      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
 
     # encode plain to hex
     def hex_encode(plain)
       return nil if plain.nil?
-      plain.to_s.unpack("H*")[0]
+
+      plain.to_s.unpack1("H*")
     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
+  end
 
   # Note: this following stuff is tested with External authenticator only!
 
@@ -148,12 +151,13 @@ module DBus
     # server.
     def send(meth, *args)
       o = ([meth] + args).join(" ")
-      @socket.write(o + "\r\n")
+      @socket.write("#{o}\r\n")
     end
 
     # Try authentication using the next authenticator.
     def next_authenticator
       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}"
@@ -169,9 +173,10 @@ module DBus
       data = ""
       crlf = "\r\n"
       left = 1024 # 1024 byte, no idea if it's ever getting bigger
-      while left > 0
+      while left.positive?
         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
@@ -262,6 +267,6 @@ module DBus
         end
       end
       true
-    end # def next_state
-  end # class Client
-end # module D-Bus
+    end
+  end
+end