Puts pop-up notifications about the current status of SABnzbd+ on your screen using libnotify-ruby (libnotify).
Currently notifies when SABnzbd+ adds an item to a queue, when an item is completed, and when an item begins being processed (i.e. starts being downloaded).
ruby-libnotify gem.
sudo gem install ruby-libnotify
I also had to install notify ruby-gnome2-dev to install ruby-libnotify
sudo apt-get install ruby-gnome2-dev
In order to run the rake tasks for generating the documentation you'll need YARD and Reek installed. These can be installed using ruby's gem.
sudo gem install reek
sudo gem install yard
For configuration we use the YAML syntax.
sabnzbd_plus:
model:
api:
caller:
http_json:
api_key: "48e93e8b1aaf946f541cc5118a531f48"
api_endpoint: "http://127.0.0.1:8880/api"
api_output: "json"
test:
api_key: "Mock API Key"
fixtures_directory: "test/fixtures/SABnzbd+"
log:
log:
file: "log/application.log"
notify:
lib_notify:
icon: "favicon.ico"
notify_for: [added, active, current, complete]
Parameters you probably want to change are
sabnzbd_plus -> model -> api -> caller -> http_json -> api_key
sabnzbd_plus -> model -> api -> caller -> http_json -> api_key
So for example if your SAB url is http://127.0.0.1:8880/sabnzbd your API endpoint will be http://127.0.0.1:8880/api
notify_for: [added, active, current, complete]
- added - Announce when a new nzb is added to the queue
- active - Announce when a nzb starts downloading, and if it stops downloading and starts again it'll be announced again
- current - Announce current items in the queue every 5min
- complete - Announce when an item completes
Delete what you don't wish to receive notifications about
Run the main application
bin/notify
Run the tests
rake test
Run the code smells detector
rake reek
Run the documentation generator
rake yard