Statuspageio
Ruby gem for the Statuspage REST API.
Installation
Add this line to your application's Gemfile:
gem 'statuspageio'And then execute:
$ bundle
Or install it yourself as:
$ gem install statuspageio
Usage
Initializing a client
client = Statuspageio::Client.new(api_key: '<your_api_key>', page_id: '<your_page_id>')
client.incidentsIncidents
# get a list of all your incidents
client.incidents
# get incidents scoped by their status
client.incidents(:active_maintenance)
client.incidents(:scheduled)
client.incidents(:unresolved)
client.incidents(:upcoming)
# pagination support
client.incidents(limit: 20, page: 2)
# query support
client.incidents(query: 'AWS is down')
# fetch an incident
client.incident(<incident_id>)
# create an incident (see https://developer.statuspage.io for payload options)
client.create_incident(<incident payload>)
# update an incident
client.update_incident(<incident_id>, payload)
# delete an incident
client.delete_incident(<incident_id>)Subscribers
# get a list of all your subscribers
client.subscribers
# get a list of all your subscribers per incident
client.subscribers(incident_id: <incident_id>)
# query support
client.subscribers(query: 'Albert Einstein')
# create a subscriber (see https://developer.statuspage.io for payload options)
client.create_subscriber(<subscriber payload>)
# delete a subscriber
client.delete_subscriber(<subscriber_id>)
# delete a subscriber for an incident
client.delete_subscriber(<subscriber_id>, incident_id: <incident_id>)In Rails you can configure using an initializer
config/intializers/statuspage.rb
Statuspageio.configure do |config|
config.api_key = ENV['STATUSPAGE_API_KEY']
config.page_id = ENV['STATUSPAGE_PAGE_ID']
endDevelopment
After checking out the repo, run bin/setup to install dependencies. 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/dasnixon/statuspageio.
License
The gem is available as open source under the terms of the MIT License.