Low commit activity in last 3 years
A long-lived project that still receives updates
A notifier for Thredded to push new post notifications to the Pushover app
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
 Dependencies

Development

>= 0
>= 0
= 0.58.2

Runtime

>= 0.13.4
 Project Readme

Thredded Pushover Notifier Build Status

A notifier for Thredded allowing push notifications to be sent via Pushover

Installation

Add this line to your application's Gemfile

gem 'thredded-pushover-notifier'

And then execute:

$ bundle

Or install it yourself as:

$ gem install thredded-pushover-notifier

Usage

  • You will need a Pushover app token (see the first option on https://pushover.net/api)
  • Let's assume you've added your Pushover app token as an environment variable PUSHOVER_APP_TOKEN.
  • You will need to have Thredded working already (at least v0.13.4) and have an initializer already in your rails app.
  • Let's assume your app is being served at http://example.com

To setup two notifiers - email and pushover, add the following to the bottom of your thredded.rb initializer:

Thredded::Engine.config.to_prepare do
  require 'thredded/pushover_notifier/content_helper'
  Thredded::PushoverNotifier::ContentHelper.include Thredded::Engine.routes.url_helpers
  pushover_notifier = Thredded::PushoverNotifier.new(ENV['PUSHOVER_APP_TOKEN'],  'http://example.com')
  Thredded.notifiers = [Thredded::EmailNotifier.new, pushover_notifier]
end

Development

After checking out the repo, run bin/setup to install dependencies. Then, run rake spec to run the tests. You can also run bin/console for an interactive prompt that will allow you to experiment.

To install this gem onto your local machine, run bundle exec rake install. To release a new version, update the version number in version.rb, and then run bundle exec rake release, which will create a git tag for the version, push git commits and tags, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/thredded/thredded-pushover-notifier. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.

License

The gem is available as open source under the terms of the MIT License.