ruby-notify-send 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 15905833105615e17847972a14f052c40070ba3c
+  data.tar.gz: 7a7bd9692f365101326dd8619bf584ef753bd8e9
+SHA512:
+  metadata.gz: f58597dfd5d83aa06e4d8692c03c9debb4ebcf116c062e499bfe14b8da3ab31f7d9efac9130dadd55eceeca48c8730107a5a753fe62b4bf1a57d7f9a8ca71e75
+  data.tar.gz: 1437eb9f6dded4942f1983145ffd3e986b425aa6aa351ae14cdd9ad281dd54c93e777aca03ce334ae3bf722092b5c9ffdf2c42e5824b26e5d6bd6b78a7f43826

data/README.md

@@ -0,0 +1,41 @@
+NotifySend for Ruby
+-------
+
+This gem allows you to generate desktop notifications from your Ruby script.
+
+It replicates the functionality of `notify-send`, but actually bypasses it completely and goes direct to `dbus`.
+
+Installation
+-------
+
+`gem install ruby-notify-send`
+
+Usage
+-------
+
+```
+require 'notify-send'
+
+# With positional parameters:
+NotifySend.send "Long running process just completed"
+NotifySend.send "Title", "some extra text"
+NotifySend.send "Title", "some extra text", "error" # <--- specifiying an icon
+
+# With a hash:
+NotifySend.send({summary: "Hi", timeout: 2000})
+NotifySend.send({summary: "Hi", body: "Hello, World!", icon: "info"})
+```
+
+Icons
+-------
+
+The `:icon` parameter can be one of:
+* 'error', 'info'
+* Any of the files in `/usr/share/notify-osd/icons/gnome/scalable/status`, minus the file extension (if you're on Ubuntu)
+* An absolute path to an image file, e.g. `{icon: "/home/user_name/Desktop/some_image.jpg", summary: ...}`
+
+Notes and known issues
+-------
+
+* `:timeout` seems to be ignored on my desktop
+* If `:summary` is an empty string, the notification will not be displayed

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+	t.libs << 'test'
+end
+
+desc "Run tests"
+task :default => :test

data/lib/notify-send.rb

@@ -0,0 +1,45 @@
+require 'dbus'
+
+class NotifySend
+
+ 	@@interface = nil
+	DEFAULTS = {
+		app_name: __FILE__,
+		id:       0,
+		icon:     'info',
+		summary:  '',
+		body:     '',
+		actions:  [],
+		hints:    {},
+		timeout:  2000
+	}
+
+	def self.send(first, *others)
+		if first.is_a?(Hash) and others.length == 0
+			_send first
+		elsif first.respond_to?(:to_s) and others.length < 4
+			_send [:body, :icon, :timeout].zip(others).each_with_object({summary: first}) { |(k, v), obj| obj[k] = v unless v.nil? }
+		else
+			raise ArgumentError.new("Invalid arguments")
+		end
+		# _send DEFAULTS.merge(first.is_a?(Hash) ? first : {summary: first, body: others[0]})
+	end
+
+	private
+
+	def self.interface
+		@@interface ||= get_interface
+	end
+
+	def self.get_interface
+		bus = DBus::SessionBus.instance
+		obj = bus.service("org.freedesktop.Notifications").object "/org/freedesktop/Notifications"
+		obj.introspect
+		obj["org.freedesktop.Notifications"]
+	end
+
+	def self._send(params)
+		interface.Notify *DEFAULTS.merge(params).values
+	end
+	
+end

data/ruby-notify-send.gemspec

@@ -0,0 +1,14 @@
+Gem::Specification.new do |s|
+	s.name         = "ruby-notify-send"
+	s.version      = "0.0.1"
+	s.date         = "2016-05-19"
+	s.summary      = "Send notify-send notifications from your Ruby application"
+	s.description  = "This replicates the functionality of notify-send, by talking directy to dbus"
+	s.authors      = "cyclotron3k"
+	s.files        = ["lib/notify-send.rb", "test/test_notify_send.rb", "Rakefile", "ruby-notify-send.gemspec", "README.md"]
+	s.test_files   = ["test/test_notify_send.rb"]
+	s.homepage     = "https://github.com/cyclotron3k/ruby-notify-send"
+	s.license      = "MIT"
+	s.add_runtime_dependency "ruby-dbus"
+	s.required_ruby_version = ">= 1.9.0" # we rely on guaranteed hash key ordering
+end

data/test/test_notify_send.rb

@@ -0,0 +1,13 @@
+require 'minitest/autorun'
+require 'notify-send'
+
+class HolaTest < Minitest::Test
+	def test_argument
+		assert_raises ArgumentError do 
+			NotifySend.send "test", "test", "test", "test", "test"
+		end
+		assert_raises ArgumentError do 
+			NotifySend.send
+		end
+	end
+end

metadata

@@ -0,0 +1,64 @@
+--- !ruby/object:Gem::Specification
+name: ruby-notify-send
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- cyclotron3k
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2016-05-19 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: ruby-dbus
+  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: This replicates the functionality of notify-send, by talking directy
+  to dbus
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/notify-send.rb
+- test/test_notify_send.rb
+- Rakefile
+- ruby-notify-send.gemspec
+- README.md
+homepage: https://github.com/cyclotron3k/ruby-notify-send
+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.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.0.3
+signing_key: 
+specification_version: 4
+summary: Send notify-send notifications from your Ruby application
+test_files:
+- test/test_notify_send.rb