ruby-dbus-wrapper-process-watch 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: edd034d2f9c6b834a17fea60c068a306e729dab9
+  data.tar.gz: ccac79e6952417186662cceb23cd4fab28acec8a
+SHA512:
+  metadata.gz: cb45ab3195afa5799c41da4589c5a9032167fd44798beaeb42b44c320ddd72e24fa8957da372e9415e6362fbf57a348a951317e9153d749859a4be00a754431f
+  data.tar.gz: 51cad04784b645ba45a3ca5bc1324c6a934ac9cb3e16ffa98eb93162b693d632b57d344447ff8d3e5d04dc8cde5e1a74b254704be2289de3a8990c6eb35be46f

data/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2014 mspanc
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

data/README.md

@@ -0,0 +1,63 @@
+ruby-dbus-wrapper-process-watch
+===============================
+
+Allows to register nice callbacks when D-Bus processess appear or disappear from the bus.
+
+
+# Installation
+
+## Step 1: Add this gem to your Gemfile
+
+Just add the following line to your `Gemfile`:
+
+    gem 'ruby-dbus-wrapper-process-watch'
+
+## Step 2: Read ruby-dbus-wrapper docs
+
+This gem relies on [ruby-dbus-wrapper](https://github.com/mspanc/ruby-dbus-wrapper). 
+It expects that you manually add ruby-dbus gem to your Gemfile, follow its docs.
+
+# Usage
+
+## Watching
+
+    # Initialize connection and wrapper
+    conn = DBus::SessionBus.instance
+    bus = DBus::Wrapper::Bus.new(conn, /^monitored\.dbus\.name\.wildcard.*/)
+
+    # Initialize process watch
+    ps = DBus::Wrapper::ProcessWatch.new(bus)
+
+    # Bind to events
+    ps.on(:registered) { |a| puts "Registered #{a}" }
+    ps.on(:unregistered) { |a| puts "Unregistered #{a}" }
+    ps.on(:resolved) { puts "Boot process finished, resolved IDs of all existing processes" };
+
+    # Start watching
+    ps.start!
+
+    # Start mainloop
+    main = DBus::Main.new
+    main << conn
+    main.run
+
+
+## Resolving names/IDs
+
+Once process became watched, you can call following methods to make D-Bus ID/name resolution:
+
+    ps.resolve_name_to_id("my.process.name") # => :1:231
+    ps.resolve_id_to_name(":1:213") # => "my.process.name"
+
+These methods can be useful if you try to convert D-Bus ID received as sender in signal callback.
+
+If there's no match, these methods will return nil.
+
+# License
+
+MIT
+
+# Author
+
+(c) 2014 Marcin Lewandowski
+

data/VERSION

@@ -0,0 +1 @@
+1.0.0

data/lib/ruby-dbus-wrapper-process-watch.rb

@@ -0,0 +1,2 @@
+require "ruby-dbus-wrapper"
+require_relative "ruby-dbus-wrapper-process-watch/process_watch"

data/lib/ruby-dbus-wrapper-process-watch/process_watch.rb

@@ -0,0 +1,111 @@
+module DBus
+  module Wrapper
+    class ProcessWatch
+      class NameResolutionFatalError < Exception; end
+      class NameResolutionRecoverableError < Exception; end
+
+      DBUS_ID_REGEXP = /\A(:1\.[0-9]+)\z/.freeze
+
+      def initialize(bus, process_name_regexp = /.*/)
+        @bus                  = bus
+        @process_name_regexp  = process_name_regexp
+        
+        @known_id_to_name     = {}
+        @known_name_to_id     = {}
+        @pending              = {}
+        @events               = { :resolved => [], :registered => [], :unregistered => [] }
+      end
+
+
+      def start!
+        @bus.monitor_signal("org.freedesktop.DBus", nil, "org.freedesktop.DBus", "NameOwnerChanged") { |message| on_name_owner_changed_signal(message) }
+        @bus.method_call("org.freedesktop.DBus", "/", "org.freedesktop.DBus", "ListNames") { |message| on_list_names_return(message) }
+      end
+
+
+      def on(event_name, &block)
+        raise ArgumentError, "Invalid event name #{event_name}" unless @events.keys.include? event_name.to_sym
+        raise ArgumentError, "You must pass a block" unless block_given?
+
+        @events[event_name.to_sym] << block
+      end
+
+
+      def resolve_name_to_id(name)
+        @known_name_to_id[name]
+      end
+
+
+      def resolve_id_to_name(id)
+        @known_id_to_name[id]
+      end
+
+
+      private 
+
+      def trigger(event_name, *args)
+        @events[event_name].each do |callback|
+          callback.call *args
+        end
+      end
+
+
+      def register(name, id)
+        @known_name_to_id[name] = id
+        @known_id_to_name[id] = name
+
+        trigger :registered, name
+      end
+
+
+      def unregister(name)
+        @known_id_to_name.delete @known_name_to_id[name]
+        @known_name_to_id.delete name
+
+        trigger :unregistered, name
+      end
+
+
+      def is_monitored_process_name?(name)
+        not name.match(DBUS_ID_REGEXP) and not name == "org.freedesktop.DBus" and name.match(@process_name_regexp)
+      end
+
+
+      def on_name_owner_changed_signal(message)
+        if is_monitored_process_name?(message.params[0])
+          if message.params[1] == '' and message.params[2] =~ DBUS_ID_REGEXP
+            register message.params[0], message.params[2]
+
+          elsif message.params[2] == '' and message.params[1] =~ DBUS_ID_REGEXP
+            unregister message.params[0]
+          end
+        end
+      end
+
+
+      def on_list_names_return(message)
+        raise NameResolutionFatalError, "Unable to query list of DBus names (#{message})" if message.is_a? DBus::Error
+
+        message.params.first.each do |name|
+          if is_monitored_process_name?(name)
+            @pending[name] = true
+          end
+        end
+
+        @pending.keys.each do |name|
+          @bus.method_call("org.freedesktop.DBus", "/", "org.freedesktop.DBus", "GetNameOwner", [[ DBus::Type::STRING, name]]) do |message| 
+            if message.is_a? DBus::Error
+              raise NameResolutionRecoverableError, "Unable to get DBus ID of of DBus process #{name} (#{message}) - most probably it has disappeared during query"
+            else
+              register name, message.params.first
+
+              @pending.delete name
+              
+              trigger :resolved  if @pending.size == 0 
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/ruby-dbus-wrapper-process-watch.gemspec

@@ -0,0 +1,17 @@
+require "rubygems"
+require "rake"
+
+GEMSPEC = Gem::Specification.new do |s|
+  s.name = "ruby-dbus-wrapper-process-watch"
+  s.summary = "Monitor D-Bus processes"
+  s.description = "Allows to register nice callbacks when D-Bus processess appear or disappear from the bus"
+  s.version = File.read("VERSION").strip
+  s.license = "MIT"
+  s.author = "Marcin Lewandowski"
+  s.email = "marcin@saepia.net"
+  s.homepage = "https://github.com/mspanc/ruby-dbus-wrapper-process-watch"
+  s.files = FileList["{lib}/**/*", "LICENSE", "README.md", "ruby-dbus-wrapper-process-watch.gemspec", "VERSION"].to_a.sort
+  s.require_path = "lib"
+  s.required_ruby_version = ">= 1.9.3"
+  s.add_runtime_dependency "ruby-dbus-wrapper"
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ruby-dbus-wrapper-process-watch
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Marcin Lewandowski
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-05-05 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-dbus-wrapper
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Allows to register nice callbacks when D-Bus processess appear or disappear
+  from the bus
+email: marcin@saepia.net
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- LICENSE
+- README.md
+- VERSION
+- lib/ruby-dbus-wrapper-process-watch.rb
+- lib/ruby-dbus-wrapper-process-watch/process_watch.rb
+- ruby-dbus-wrapper-process-watch.gemspec
+homepage: https://github.com/mspanc/ruby-dbus-wrapper-process-watch
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 1.9.3
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.2.2
+signing_key: 
+specification_version: 4
+summary: Monitor D-Bus processes
+test_files: []