Project

pushover

0.05
No commit activity in last 3 years
No release in over 3 years
Api (and CLI) to interface with pushover.net
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
 Dependencies

Runtime

>= 0
>= 0
>= 0
 Project Readme

Pushover

Build Status codecov

This gem provides a CLI and an API interface to https://pushover.net.

Installation

To install:

gem install pushover

To use inside of an application, add this to the your gemfile:

gem 'pushover'

and run bundle to make it available:

bundle

Usage

For now, not much is supported on the CLI.

Sending a message:

pushover --token=your_app_token --user=user_key message here we go again, on my own.
pushover -tyour_app_token -uuser_key message here we go again, on my own.

Getting receipt details:

pushover -tyour_app_token receipt receipt-hash

Currently unsupported message features:

  • attachments
  • callbacks
  • setting timestamp

Api

  require 'pushover'

  ### message
  message = Pushover::Message.new(token: 'token', user: 'user_key', message: '...')
  message.push


  ### Receipt
  Pushover::Message.new(token: 'token', user: 'user_key', message: '...', 'priority': 2, expire: 1, retry: 60).push

  receipt = Pushover::Receipt.new(receipt: "receipt", token: 'token')
  receipt.get

  ### Responses
  response = Pushover::Message.new(token: 'token', user: 'user_key', message: '...').push

  # the below data is populated from the response
  puts response.status     # return the status of the request, 0 or 1
  puts response.request    # uuid of the request
  puts response.errors     # array of errors (if any)
  puts response.receipt    # receipt (if requested)
  puts response.headers    # response headers (includes limits)
  puts response.attributes # any other k/v pair returned from pushover

Contributing

  1. Fork it
  2. Switch to development (git checkout development)
  3. Create your feature branch (git checkout -b my-new-feature)
  4. Commit your changes (git commit -am 'Added some feature')
  5. Push to the branch (git push origin my-new-feature)
  6. Create new Pull Request against development