ruby-dbus 0.12.0 → 0.13.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 25c36fdb17d7d5c19b83d451de704117b285fb56
-  data.tar.gz: 3f6ddb8bb599e3cd616a1e3ebf9f15394e3acd17
+  metadata.gz: be28e1bcc3ffa7c25f729d8915cd90344d565644
+  data.tar.gz: 94eaa6d210ee9fed21c764c7d24d521ca98bf60f
 SHA512:
-  metadata.gz: 0fe993c938add6a07d8432c3ae846fa93bf3b75bf6403dd04271f9401c09b41de3dbdd5487567500fe21d5abe1ec6ec8b0b8bd98c82c00ad9932253cfb5de9bb
-  data.tar.gz: 02d8d3c914d5c3b74b759e8e7eabce7bb1aa6a9c7cd1620645ed69f345639e85ab00353757502440c6fb601b6d11c9ac4df290c60eb576c5d49e1af9deeb47b7
+  metadata.gz: 89bad1fc379f3e77d8758007e5d88664faa765bd6e1ef7d9638490e67b33a5411da8d90c151c9e8d263951d40d43520076f2c6d18aa27423eb92d7409c275667
+  data.tar.gz: 9c24257d8db08279aeed560e050179d674397c0cdb93bba805f637afee70611edaa7373034aae2b8f69bf7466ea1936ea85a72dd1fe0182bfa02486bf57702a4

data/NEWS.md

@@ -0,0 +1,344 @@
+# Ruby D-Bus NEWS
+
+## Unreleased
+
+## Ruby D-Bus 0.13.0 - 2016-09-21
+
+Bug fixes:
+ * It is no longer required to explicitly call ProxyObject#introspect,
+   it will be done automatically once ([#28][]).
+
+Requirements:
+ * Introduced RuboCop to keep a consistent coding style.
+ * Replaced Gemfile.ci with a regular Gemfile.
+
+[#28]: http://github.com/mvidner/ruby-dbus/issue/28
+
+## Ruby D-Bus 0.12.0 - 2016-09-12
+
+API:
+ * Added proxy objects whose methods return single values instead of arrays
+   (use Service#[] instead of Service#object; [#30][]).
+
+Requirements:
+ * Require ruby 2.0.0, stopped supporting 1.9.3.
+
+[#30]: http://github.com/mvidner/ruby-dbus/issue/30
+
+## Ruby D-Bus 0.11.2 - 2016-09-11
+
+Bug fixes:
+ * Fixed reading a quoted session bus address, as written by dbus-1.10.10
+   ([#62][], Yasuhiro Asaka)
+
+[#62]: https://github.com/mvidner/ruby-dbus/pull/62
+
+## Ruby D-Bus 0.11.1 - 2016-05-12
+
+Bug fixes:
+ * Fix default path finding on FreeBSD (Greg)
+ * Service#unexport fixed to really return the unexported object
+
+Requirements:
+ * made tests compatible with RSpec 3
+
+## 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:
+ * fixed "Interfaces added with singleton_class.instance_eval aren't
+   exported" ([#22][], by miaoufkirsh)
+
+Requirements:
+ * Require ruby 1.9.3, stopped supporting 1.8.7.
+
+[#22]: https://github.com/mvidner/ruby-dbus/issue/22
+
+## Ruby D-Bus 0.9.3 - 2014-01-02
+
+Bug fixes:
+ * re-added COPYING, NEWS, README.md to the gem ([#47][],
+   by Cédric Boutillier)
+
+Packaging:
+ * use packaging_rake_tasks
+
+[#47]: https://github.com/mvidner/ruby-dbus/issue/47
+
+## Ruby D-Bus 0.9.2 - 2013-05-08
+
+Features:
+ * Ruby strings can be passed where byte arrays ("ay") are expected 
+   ([#40][], by Jesper B. Rosenkilde)
+
+Bug fixes:
+ * Fixed accessing ModemManager properties ([#41][], reported
+   by Ernest Bursa). MM introspection produces two elements
+   for a single interface; merge them.
+
+[#40]: https://github.com/mvidner/ruby-dbus/issue/40
+[#41]: https://github.com/mvidner/ruby-dbus/issue/41
+
+## Ruby D-Bus 0.9.1 - 2013-04-23
+
+Bug fixes:
+ * Prefer /etc/machine-id to /var/lib/dbus/machine-id
+   when DBUS_SESSION_BUS_ADDRESS is unset ([#39][], by WU Jun).
+
+[#39]: https://github.com/mvidner/ruby-dbus/issue/39
+
+## Ruby D-Bus 0.9.0 - 2012-11-06
+
+Features:
+ * When calling methods, the interface can be left unspecified if unambiguous
+  (Damiano Stoffie)
+ * YARD documentation, Reference.md
+
+Bug fixes:
+ * Introspection attribute "direction" can be omitted
+   as allowed by the specification (Noah Meyerhans).
+ * ProxyObjectInterface#on_signal no longer needs the "bus" parameter
+   ([#31][], by Damiano Stoffie)
+
+[#31]: https://github.com/mvidner/ruby-dbus/issue/31
+
+## Ruby D-Bus 0.8.0 - 2012-09-20
+
+Features:
+ * Add Anonymous authentication ([#27][], by Walter Brebels).
+ * Use Nokogiri for XML parsing when available ([#24][], by Geoff Youngs).
+
+Bug fixes:
+ * Use SCM_CREDS authentication only on FreeBSD, not on OpenBSD ([#21][],
+   reported by Adde Nilsson).
+ * Recognize signature "h" (UNIX_FD) used eg. by Upstart ([#23][],
+   by Bernd Ahlers).
+ * Find the session bus also via launchd, on OS X ([#20][], reported
+   by Paul Sturgess).
+
+Other:
+ * Now doing continuous integration with Travis:
+     http://travis-ci.org/#!/mvidner/ruby-dbus
+
+[#20]: https://github.com/mvidner/ruby-dbus/issue/20
+[#21]: https://github.com/mvidner/ruby-dbus/issue/21
+[#23]: https://github.com/mvidner/ruby-dbus/issue/23
+[#24]: https://github.com/mvidner/ruby-dbus/issue/24
+[#27]: https://github.com/mvidner/ruby-dbus/issue/27
+
+## Ruby D-Bus 0.7.2 - 2012-04-05
+
+A brown-paper-bag release.
+
+Bug fixes:
+ * Fixed "undefined local variable or method `continue'" in
+   DBus::Main#run when a service becomes idle (by Ravil Bayramgalin)
+
+## Ruby D-Bus 0.7.1 - 2012-04-04
+
+Bug fixes:
+ * Fixed calling asynchronous methods on the default interface ([#13][],
+   by Eugene Korbut). 
+ * Fixed Main#quit to really quit the loop (by Josef Reidinger)
+ * Unbundled files from Active Support (by Bohuslav Kabrda)
+
+[#13]: https://github.com/mvidner/ruby-dbus/issue/13
+
+## Ruby D-Bus 0.7.0 - 2011-07-26
+
+Features:
+ * Added ASystemBus and ASessionBus, non-singletons useful in tests
+   and threads.
+
+Bug fixes:
+ * Fixed handling of multibyte strings ([#8][], by Takayuki YAMAGUCHI).
+ * Allow reopening of a dbus_interface declaration ([#9][], by T. YAMAGUCHI).
+ * Fixed ruby-1.9.2 compatibility again ([#12][]).
+ * Fixed authentication on BSD ([#11][], by Jonathan Walker)
+ * Fixed exiting a nested event loop for synchronous calls
+   (reported by Timo Warns).
+ * Fixed introspection calls leaking reply handlers.
+ * "rake test" now works, doing what was called "rake env:test"
+
+[#8]: https://github.com/mvidner/ruby-dbus/issue/8
+[#9]: https://github.com/mvidner/ruby-dbus/issue/9
+[#11]: https://github.com/mvidner/ruby-dbus/issue/11
+[#12]: https://github.com/mvidner/ruby-dbus/issue/12
+
+## Ruby D-Bus 0.6.0 - 2010-12-11
+
+Features:
+ * Clients can access properties conveniently ([T#28][]).
+
+Bug fixes:
+ * Service won't crash whan handling an unknown method or interface ([T#31][]).
+ * Don't send an invalid error name when it originates from a NameError.
+
+[T#28]: https://trac.luon.net/ruby-dbus/ticket/28
+[T#31]: https://trac.luon.net/ruby-dbus/ticket/31
+
+## Ruby D-Bus 0.5.0 - 2010-11-07
+
+Features:
+ * Better binding of Ruby Exceptions to D-Bus Errors.
+ * Converted the package to a Gem ([#6][]).
+ * Converted the tutorial from Webgen to Markdown.
+
+Bug fixes:
+ * Don't pass file descriptors to subprocesses.
+ * Fixed InterfaceElement::validate_name ([T#38][], by Herwin Weststrate).
+ * Fixed a typo in InvalidDestinationName description ([T#40][]).
+
+[#6]: https://github.com/mvidner/ruby-dbus/issue/6
+[T#38]: https://trac.luon.net/ruby-dbus/ticket/38
+[T#40]: https://trac.luon.net/ruby-dbus/ticket/40
+
+## Ruby D-Bus 0.4.0 - 2010-08-20
+
+Features:
+ * TCP transport (by pangdudu)
+ * Enabled test code coverage report (rcov)
+
+Bug fixes:
+ * Classes should not share all interfaces ([T#36][]/[#5][])
+ * Ruby 1.9 compatibility ([T#37][], by Myra Nelson)
+
+[#5]: https://github.com/mvidner/ruby-dbus/issue/5
+[T#36]: https://trac.luon.net/ruby-dbus/ticket/36
+[T#37]: https://trac.luon.net/ruby-dbus/ticket/37
+
+## Ruby D-Bus 0.3.1 - 2010-07-22
+
+Bug fixes:
+ * Many on_signal could cause DBus.Error.LimitsExceeded [bsc#617350][]).
+   Don't add a match rule that already exists, enable removing match
+   rules. Now only one handler for a rule is called (but it is possible
+   for one signal to match more rules). This reverts the half-fix done
+   to fix [#3][]
+ * Re-added InterfaceElement#add_param for compatibility.
+ * Handle more ways which tell us that a bus connection has died.
+
+[#3]: https://github.com/mvidner/ruby-dbus/issue/3
+[bsc#617350]: https://bugzilla.novell.com/show_bug.cgi?id=617350
+
+## Ruby D-Bus 0.3.0 - 2010-03-28
+
+Bug fixes:
+ 
+ * Fixed "undefined method `get_node' for nil:NilClass"
+   on Ubuntu Karmic ([T#34][]).
+ * Get the session bus address even if unset in ENV ([#4][]).
+ * Improved exceptions a bit:
+   UndefinedInterface, InvalidMethodName, NoMethodError, no RuntimeException
+
+ These are by Klaus Kaempf:
+ * Make the signal dispatcher call all handlers ([#3][]).
+ * Run on Ruby < 1.8.7 ([#2][]).
+ * Avoid needless DBus::IncompleteBufferException ([T#33][]).
+ * Don't ignore DBus Errors in request_service, raise them ([T#32][]).
+
+[#2]: https://github.com/mvidner/ruby-dbus/issue/2
+[#3]: https://github.com/mvidner/ruby-dbus/issue/3
+[#4]: https://github.com/mvidner/ruby-dbus/issue/4
+[T#32]: https://trac.luon.net/ruby-dbus/ticket/32
+[T#33]: https://trac.luon.net/ruby-dbus/ticket/33
+[T#34]: https://trac.luon.net/ruby-dbus/ticket/34
+
+Features:
+
+ * Automatic signature inference for variants.
+ * Introduced FormalParameter where a plain pair had been used.
+
+## Ruby D-Bus 0.2.12 - 2010-01-24
+
+Bug fixes:
+
+ * Fixed a long-standing bug where a service activated by the bus
+   would fail with "undefined method `get_node' for nil:NilClass"
+   ([T#25][] and [T#29][]).
+
+[T#25]: https://trac.luon.net/ruby-dbus/ticket/25
+[T#29]: https://trac.luon.net/ruby-dbus/ticket/29
+
+
+## Ruby D-Bus 0.2.11 - 2009-11-12
+
+Features:
+
+ * Added DBus::Service#unexport (da1l6).
+
+Bug fixes:
+
+ * Return org.freedesktop.DBus.Error.UnknownObject instead of crashing
+   ([T#31][]).
+ * Rescue exceptions in dbus_methods and reply with DBus errors instead of
+   crashing (da1l6).
+ * Better exception messages when sending nil, or mismatched structs.
+ * Call mktemp without --tmpdir, to build on older distros.
+
+[T#31]: https://trac.luon.net/ruby-dbus/ticket/31
+
+## Ruby D-Bus 0.2.10 - 2009-09-10
+
+Bug fixes:
+
+ * DBus::Service.exists? fixed (Murat Demirten).
+ * Ruby 1.9 fixes (Jedediah Smith).
+ * Fixed an endless sleep in DBus::Main.run ([bsc#537401][]).
+ * Added details to PacketMarshaller exceptions ([bsc#538050][]).
+
+[bsc#537401]: https://bugzilla.novell.com/show_bug.cgi?id=537401
+[bsc#538050]: https://bugzilla.novell.com/show_bug.cgi?id=538050
+
+## Ruby D-Bus "I'm not dead" 0.2.9 - 2009-08-26
+
+Thank you to Paul and Arnaud for starting the project. I, Martin
+Vidner, am continuing with it on GitHub.
+
+ * Fixed passing an array through a variant (no ticket).
+ * Fixed marshalling "av" ([T#30][]).
+ * Fixed variant alignment ([T#27][]).
+ * Added DBus::Main.quit.
+ * Mention the DBus interface in a NameError for an unknown method.
+ * Fixed ruby-1.9 "warning: default `to_a' will be obsolete".
+ * Added Rakefile and gemspec.
+
+[T#27]: https://trac.luon.net/ruby-dbus/ticket/27
+[T#30]: https://trac.luon.net/ruby-dbus/ticket/30
+
+## Ruby D-Bus "Thanks for all the fish" 0.2.1 - 2007-12-29
+
+More bugfixes, mostly supplied by users supplying us with patches.  Thanks!
+
+ * Support for new types added: 
+   - dict (courtesy of Drake Wilson);
+   - double (courtesy of Patrick Sissons);
+   - variant.
+ * Improved exception raise support (courtesy of Sjoerd Simons,
+   Patrick Sissons).
+ * Some polish (removed debug output, solved unnecessary warnings).
+ * Documentation updates, example fixes and updates.
+
+## Ruby D-Bus "Almost live from DebConf 7" 0.2.0 - 2007-06-02
+
+Again a bugfix release, also meant to be the public release
+for exploratory purposes. New in 0.2.0:
+
+ * Complete tutorial revamp.
+ * Relicensed to the LGPL.
+
+## Ruby D-Bus "Release Often" 0.1.1 - 2007-04-23
+
+Bugfix release.  Fixes hardcoded string for requesting bus names,
+found by Rudi Cilibrasi.
+
+## Ruby D-Bus "Happy Birthday Paul" 0.1.0 - 2007-04-17
+
+First release. Supports most of D-Bus' features.

data/Rakefile

@@ -1,10 +1,14 @@
 #! /usr/bin/env ruby
-require 'rake'
-require 'fileutils'
+require "rake"
+require "fileutils"
 include FileUtils
-require 'tmpdir'
-require 'rspec/core/rake_task'
-
+require "tmpdir"
+require "rspec/core/rake_task"
+begin
+  require "rubocop/rake_task"
+rescue LoadError
+  nil
+end
 require "packaging"
 
 Packaging.configuration do |conf|
@@ -12,22 +16,22 @@ Packaging.configuration do |conf|
   conf.obs_target = "openSUSE_Tumbleweed"
   conf.package_name = "rubygem-ruby-dbus"
   conf.obs_sr_project = "openSUSE:Factory"
-  conf.skip_license_check << /^[^\/]*$/
-  conf.skip_license_check << /^(doc|examples|spec)\/.*/
+  conf.skip_license_check << %r{^[^/]*$}
+  conf.skip_license_check << %r{^(doc|examples|spec)/.*}
   # "Ruby on Rails is released under the MIT License."
   # but the files are missing copyright headers
-  conf.skip_license_check << /^lib\/dbus\/core_ext\//
+  conf.skip_license_check << %r{^lib/dbus/core_ext/}
 end
 
-desc 'Default: run specs in the proper environment'
-task :default => :spec
-task :test => :spec
+desc "Default: run specs in the proper environment"
+task default: [:spec, :rubocop]
+task test: :spec
 
 RSpec::Core::RakeTask.new("bare:spec")
 
 %w(spec).each do |tname|
   desc "Run bare:#{tname} in the proper environment"
-  task tname do |t|
+  task tname do |_t|
     cd "spec/tools" do
       sh "./test_env rake bare:#{tname}"
     end
@@ -37,14 +41,14 @@ end
 if ENV["TRAVIS"]
   require "coveralls/rake/task"
   Coveralls::RakeTask.new
-  task :default => "coveralls:push"
+  task default: "coveralls:push"
 end
 
-#remove tarball implementation and create gem for this gemfile
+# remove tarball implementation and create gem for this gemfile
 Rake::Task[:tarball].clear
 
 desc "Build a package from a clone of the local Git repo"
-task :tarball do |t|
+task :tarball do |_t|
   Dir.mktmpdir do |temp|
     sh "git clone . #{temp}"
     cd temp do
@@ -63,3 +67,5 @@ namespace :doc do
     end
   end
 end
+
+RuboCop::RakeTask.new if Object.const_defined? :RuboCop

data/VERSION

@@ -1 +1 @@
-0.12.0
+0.13.0

data/doc/Reference.md

@@ -23,23 +23,18 @@ is simply "dbus"
 #### Calling Methods
 
 1. {DBus.session_bus Connect to the session bus};
-   {DBus::Connection#[] get the screensaver service}
-   {DBus::Service#[] and its screensaver object}.
-2. Perform {DBus::ProxyObject#introspect explicit introspection}
-   to define the interfaces and methods
-   on the {DBus::ProxyObject object proxy}
-([I#28](https://github.com/mvidner/ruby-dbus/issues/28)).
-3. Call one of its methods in a loop, solving [xkcd#196](http://xkcd.com/196).
+2. {DBus::Connection#[] get the screensaver service}
+3. {DBus::Service#[] and its screensaver object}.
+4. Call one of its methods in a loop, solving [xkcd#196](http://xkcd.com/196).
 
  
 
     mybus = DBus.session_bus
-    service = mybus['org.freedesktop.ScreenSaver']
-    object = service['/ScreenSaver']
-    object.introspect
+    service = mybus["org.freedesktop.ScreenSaver"]
+    object = service["/ScreenSaver"]
     loop do
-        object.SimulateUserActivity
-        sleep 5 * 60
+      object.SimulateUserActivity
+      sleep 5 * 60
     end
 
 ##### Retrieving Return Values
@@ -48,10 +43,9 @@ A method proxy simply returns a value.
 In this example SuspendAllowed returns a boolean:
 
     mybus = DBus.session_bus
-    pm_s = mybus['org.freedesktop.PowerManagement']
-    pm_o = pm_s['/org/freedesktop/PowerManagement']
-    pm_o.introspect
-    pm_i = pm_o['org.freedesktop.PowerManagement']
+    pm_s = mybus["org.freedesktop.PowerManagement"]
+    pm_o = pm_s["/org/freedesktop/PowerManagement"]
+    pm_i = pm_o["org.freedesktop.PowerManagement"]
 
     if pm_i.CanSuspend
       pm_i.Suspend
@@ -69,13 +63,12 @@ which is what {DBus::Service#object} does.
 For nearly all methods you used `Method[0]` or
 `Method.first`
 ([I#30](https://github.com/mvidner/ruby-dbus/issues/30)).
-    
+
     mybus = DBus.session_bus
-    pm_s = mybus['org.freedesktop.PowerManagement']
+    pm_s = mybus["org.freedesktop.PowerManagement"]
     # use legacy compatibility API
-    pm_o = pm_s.object['/org/freedesktop/PowerManagement']
-    pm_o.introspect
-    pm_i = pm_o['org.freedesktop.PowerManagement']
+    pm_o = pm_s.object["/org/freedesktop/PowerManagement"]
+    pm_i = pm_o["org.freedesktop.PowerManagement"]
 
     # wrong
     # if pm_i.CanSuspend
@@ -95,12 +88,11 @@ or use {DBus::ProxyObjectInterface#all_properties} to get
 an actual Hash of them.
 
     sysbus = DBus.system_bus
-    upower_s = sysbus['org.freedesktop.UPower']
-    upower_o = upower_s['/org/freedesktop/UPower']
-    upower_o.introspect
-    upower_i = upower_o['org.freedesktop.UPower']
+    upower_s = sysbus["org.freedesktop.UPower"]
+    upower_o = upower_s["/org/freedesktop/UPower"]
+    upower_i = upower_o["org.freedesktop.UPower"]
 
-    on_battery = upower_i['OnBattery']
+    on_battery = upower_i["OnBattery"]
 
     puts "Is the computer on battery now? #{on_battery}"
 
@@ -135,10 +127,9 @@ To receive signals for a specific object and interface, use
 {DBus::ProxyObject#on_signal}(name, &block), for the default interface.
 
     sysbus = DBus.system_bus
-    login_s = sysbus['org.freedesktop.login1'] # part of systemd
-    login_o = login_s.object '/org/freedesktop/login1'
-    login_o.introspect
-    login_o.default_iface = 'org.freedesktop.login1.Manager'
+    login_s = sysbus["org.freedesktop.login1"] # part of systemd
+    login_o = login_s.object "/org/freedesktop/login1"
+    login_o.default_iface = "org.freedesktop.login1.Manager"
 
     main = DBus::Main.new
     main << sysbus
@@ -148,9 +139,8 @@ To receive signals for a specific object and interface, use
       puts "New session: #{name}"
 
       session_o = login_s.object(opath)
-      session_o.introspect
-      session_i = session_o['org.freedesktop.login1.Session']
-      uid, user_opath = session_i['User']
+      session_i = session_o["org.freedesktop.login1.Session"]
+      uid, _user_opath = session_i["User"]
       puts "Its UID: #{uid}"
       main.quit
     end
@@ -189,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,
@@ -218,12 +208,11 @@ D-Bus calls can reply with an error instead of a return value. An error is
 translated to a Ruby exception, an instance of {DBus::Error}.
 
     nm_o = DBus.system_bus["org.freedesktop.NetworkManager"]["/org/freedesktop/NetworkManager"]
-    nm_o.introspect
     nm = nm_o["org.freedesktop.NetworkManager"]
     begin
-        nm.Sleep(false)
+      nm.Sleep(false)
     rescue DBus::Error => e
-        puts e unless e.name == "org.freedesktop.NetworkManager.AlreadyAsleepOrAwake"
+      puts e unless e.name == "org.freedesktop.NetworkManager.AlreadyAsleepOrAwake"
     end
 
 #### Interfaces