Provides a simple library to send updates to GeckoBoard via its push API
PLEASE NOTE: at present this README is a spec - the library does not implement all these features yet.
Add this line to your application's Gemfile:
gem 'gecko-pusher'
And then execute:
$ bundle
Or install it yourself as:
$ gem install gecko-pusher
Gecko::Pusher.api_key = <your api key>
or set the following environment variable - Gecko::Pusher will pick it up
GECKO_PUSHER_APIKEY = <your api key>
channel = Gecko::Pusher.channel(:text, "<your widget key>")
First parameter options:
:text
:map
:number
:rag
:rag_col
:line_chart
:pie_chart
:gecko_meter
:funnel
:bullet
Creating a channel with an missing or invalid type will cause an ArgumentError to be raised.
Creating a channel returns an object that makes it easy to send messages to Geckoboard without having to manually create the JSON. Rather, the push method will parse your args in (hopefully) a manner that makes sense. So, text widgets (when you use the :text option) will understand the following:
channel.push("Message") // Single plain message
channel.push(Gecko::Pusher::TEXT_ALERT, "Message") // Single alert message
channel.push("One", "Two", "Three") // Multiple plain messages
channel.push(Gecko::Pusher::TEXT_ALERT, "One", "Two", "Three") // Muliple alert messages
channel.push(
[ Gecko::Pusher::TEXT_ALERT, "One", "Two" ],
[ Gecko::Pusher::TEXT_INFO, "Three", "Four" ],
[ "Five", "Six"]
) // Multiple different message types, one type per array (default: Gecko::Pusher::TEXT_PLAIN)
channel.push(100, 200, 300) // Pushes RAG values with no description
channel.push(100, "desc", 222, "desc", 300 "desc") // Push RAG values with descriptions
channel.push(:green, 100) // Just push a green value
channel.push(:green, 100, "Description") // Push a green value with a description
channel.push([1,2,3,4,5]) // Push raw values, no settings
channel.push([1,2,3,4,5], colour: "#FF0000") // Push values with colour set
channel.push([1,2,3,4,5], colour: "#FF0000", axisx: ['1','2']) // Push values with colour and X-axis labels set
channel.push(10) // push number
channel.push(10, 20) // push number and secondary stat
channel.push(10, "Today", 20, "Yesterday") // push number and secondary stat with descriptions
channel.push(10, 20, absolute: true, type: reverse) // push with options
For basic, uncoloured, uniformly sized points, the API is dirt simple:
channel.push("192.168.0.1") // Push IP address
channel.push([-51.424, 0.02323]) // Push Lat/Long
channel.push({city_name: "London", country_code: "GB"}) // Push address
channel.push("host.dsci.it") // Push hostname
channel.push("192.168.0.1", [-51.424, 0.02323]...) // Push any combination of above as multiple args
If you want to embellish points with additional styling information, you have to do a bit more work, with each element an array, the first element being as above, the second element being the point options. You can mix/match the two ways - the API will figure it out:
channel.push(["192.168.0.1", {color: "FF0000", size: 3}]) // Push IP address
channel.push([[-51.424, 0.02323], {size: 8}]) // Push Lat/Long
channel.push([{city_name: "London", country_code: "GB"}, {...}]) // Push address
channel.push(["host.dsci.it", {color: "00FF00"}]) // Push hostname
channel.push(["192.168.0.1", {color: "FF0000", size: 3}],
[[-51.424, 0.02323], {size: 8}]) // Push any combination of above as multiple args
channel.push("192.168.0.1",
[{city_name: "London", country_code: "GB"}, {...}],
["host.dsci.it", {color: "00FF00"}],
[-51.424, 0.02323],
...)
channel.push(10, 0, 20) // Push basic value, min, max
channel.push(10, 0, "Min", 20, "Max") // Push values with descriptions
channel.push(10, 0, "Min", 20, "Max", type: "reverse") // Push values, descriptions and options
- Fork it
- Create your feature branch (
git checkout -b my-new-feature) - Commit your changes with specs to ensure resilience to regressions (
git commit -am 'Added some feature') - Push to the branch (
git push origin my-new-feature) - Create new Pull Request