1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
|
# Libnotify
[](https://travis-ci.org/splattael/libnotify) [](https://rubygems.org/gems/libnotify) [](https://codeclimate.com/github/splattael/libnotify) [](http://inch-ci.org/github/splattael/libnotify)
Ruby bindings for libnotify using FFI.
[Gem](https://rubygems.org/gems/libnotify) |
[Source](https://github.com/splattael/libnotify) |
[RDoc](http://rubydoc.info/github/splattael/libnotify/master)
## Usage
### Hash Syntax
```ruby
require 'libnotify'
Libnotify.show(:body => "hello", :summary => "world", :timeout => 2.5)
```
### Block Syntax
```ruby
require 'libnotify'
n = Libnotify.new do |notify|
notify.summary = "hello"
notify.body = "world"
notify.timeout = 1.5 # 1.5 (s), 1000 (ms), "2", nil, false
notify.urgency = :critical # :low, :normal, :critical
notify.append = false # default true - append onto existing notification
notify.transient = true # default false - keep the notifications around after display
notify.icon_path = "/usr/share/icons/gnome/scalable/emblems/emblem-default.svg"
end
n.show!
```
### Mixed Syntax
```ruby
require 'libnotify'
# Mixed syntax
options = {:body => "world", :timeout => 20}
Libnotify.show(options) do |opts|
opts.timeout = 1.5 # overrides :timeout in options
end
```
### Managing Icon Paths
```ruby
require 'libnotify'
# Icon path auto-detection
Libnotify.icon_dirs << "/usr/share/icons/gnome/*/"
Libnotify.show(:icon_path => "emblem-default.png")
Libnotify.show(:icon_path => :"emblem-default")
```
### Updating existing notification and closing it
```ruby
# Update pre-existing notification then close it
n = Libnotify.new(:summary => "hello", :body => "world")
n.update # identical to show! if not shown before
Kernel.sleep 1
n.update(:body => "my love") do |notify|
notify.summary = "goodbye"
end
Kernel.sleep 1
n.close
```
## Installation
```bash
gem install libnotify
```
You'll need libnotify. On Debian just type:
```bash
apt-get install libnotify1
```
## Testing
```bash
git clone git://github.com/splattael/libnotify.git
cd libnotify
(gem install bundler)
bundle install
rake
```
### Code coverage
```bash
COVERAGE=1 rake
```
## Caveats
### Ubuntu
`timeout` and `append` options might not work on Ubuntu.
See GH #21 for details.
https://github.com/splattael/libnotify/issues/21#issuecomment-19114127
## Authors
* Peter Leitzen (https://github.com/splattael)
## [Contributors](https://github.com/splattael/libnotify/graphs/contributors)
* Dennis Collective (https://github.com/denniscollective)
* Daniel Mack (https://github.com/zonque)
* Nuisance of Cats (https://github.com/nuisanceofcats)
* Jason Staten (https://github.com/statianzo)
* Jeremy Lawler (https://github.com/jlawler)
* Kero van Gelder (https://github.com/keroami)
* René Föhring (https://github.com/rrrene)
* Cezary Baginski (https://github.com/e2)
* robisacommonusername (https://github.com/robisacommonusername)
* Fernando Briano (https://github.com/picandocodigo)
## License
[MIT License](http://www.opensource.org/licenses/MIT)
## TODO
* Unify show/update interface
-> simplifies code
* Turn FFI module into a class
-> more plugabble
* Support newer features of `libnotify`
-> actions, hints?
See https://developer-next.gnome.org/libnotify/0.7/NotifyNotification.html
* Support older versions of `libnotify`
-> prior `0.4`?
|
