Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
A little Sinatra extension to expose data nicely to Geckoboard.
Ruby
Branch: master

Fetching latest commit…

Cannot retrieve the latest commit at this time

Failed to load latest commit information.
example
lib/sinatra
spec
Gemfile
README.md
Rakefile
sinatra-geckoboard.gemspec

README.md

Sinatra Geckoboard

A little Sinatra extension to expose data nicely to Geckoboard.

We are using it in production.

Install

Install with Rubygems:

gem install sinatra-geckoboard

If you use bundler, add it to your Gemfile:

gem "sinatra-geckoboard", "~>0.1.0"

Usage

require 'sinatra/base'
require 'sinatra/geckoboard'

class App < Sinatra::Base
  register Sinatra::Geckoboard

  get '/pie_graph' do
    pie_chart [ { "label" => "Chuck Norris",
                  "value" => 3,
                  "colour" => "#ff9900" },
                { "label" => "Bruce Lee",
                  "value" => 0,
                  "colour" => "#ef9900" }
              ]
  end

  get '/line_chart' do
    line_chart [1, 3], ["value1", "value2"], ["top1", "top2"], "#ff9900"
  end
end

Pie Chart

Render a pie chart widget. You should pass an array of Hash. If the key colour is ommited, a colour will be generated with the label key.

pie_chart(values)

Line Chart

Render a line_chart widget.

line_chart(values, axisx, axisy, colour)

Geck-O-Meter

Render a Geck-O-Meter widget.

geck_o_meter(number, max, min)

RAG

Render a RAG widget.

red   = {value: 4, text: 'Plop'}
amber = {value: 4, text: 'Plop'}
green = {value: 4, text: 'Plop'}
rag(red, amber, green)

Number + optional secondary stat

Render a Number widget.

number1 = {value: 4, text: 'Plop'}
number2 = {value: 5, text: 'Plop'}
number(number1[, number2])

License

MIT License

Copyright (C) 2011 by af83

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.

Something went wrong with that request. Please try again.