No commit activity in last 3 years
No release in over 3 years
A plugin for the pushpop integration system for reading Github's current status from status.github.com
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Dependencies

Development

>= 0

Runtime

>= 0
~> 1.11
 Project Readme

Pushpop-Github-Status

This is a step for pushpop that pulls Github's current status. It will pull all 4 status endpoints by default:

require "pushpop"
require "pushpop-github-status"

job "Github status job" do
  every 5.minutes

  github_status

  step "do something with the status" do |gs|
    gs.status
  end
end

The format of the step's return value is:

{
  # Format like https://status.github.com/api/status.json
  status: { },

  # Format like https://status.github.com/api/last-message.json
  last_message: { },

  # Format like https://status.github.com/api/messages.json
  messages: { },

  # Format like https://status.github.com/api/daily-summary.json
  daily_summary: { }
}

For an explanation of the values, check out Github's status API documentation

If you want to pull just a few of the endpoints, end the previous step with an array of the data you want:

require "pushpop"
require "pushpop-github-status"

job "Github status job" do
  every 5.minutes

  step "set the endpoints I want" do
    [:status, :last_message]
  end

  github_status

  step "do something with the status" do |gs|
    gs.status
  end
end

The above code will only return the "status" and "last_message" endpoints.

The MIT License (MIT)

Copyright (c) 2015 Will Barrett

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.