sinatra-geckoboard 0.1.1 → 0.1.2

data/README.md

@@ -1,9 +1,9 @@
 # Sinatra Geckoboard
 
-**Work in progress**
-
 A little [Sinatra](http://www.sinatrarb.com/) extension to expose data nicely to [Geckoboard](http://www.geckoboard.com/).
 
+We are using it in production.
+
 ## Install
 
 Install with Rubygems:
@@ -39,7 +39,31 @@ class App < Sinatra::Base
 end
 ```
 
-## Licence
+### 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.
+
+```ruby
+pie_chart(values)
+```
+
+### Line Chart
+
+Render a line_chart widget.
+
+```ruby
+line_chart(values, axisx, axisy, colour)
+```
+
+### Geck-O-Meter
+
+Render a Geck-O-Meter widget.
+
+```ruby
+geck_o_meter(number, max, min)
+```
+
+## License
 
 MIT License
 

data/lib/sinatra/geckoboard.rb

@@ -1,9 +1,17 @@
+require 'digest/md5'
 require 'json'
 
 module Sinatra
   module Geckoboard
 
     module Helpers
+      # Create a color from string
+      #
+      # @param [String] string
+      def create_color(string)
+        "##{Digest::MD5.hexdigest(string)[0..5]}"
+      end
+
       # Render a line chart widget
       # Set content type as json
       # http://support.geckoboard.com/entries/274940-custom-chart-widget-type-definitions
@@ -13,7 +21,7 @@ module Sinatra
       # @param [Array] axisy
       # @param [String] colour
       # @return [String] the line chart as json string
-      def line_chart(values=[], axisx=[], axisy=[], colour="")
+      def line_chart(values=[], axisx=[], axisy=[], colour="#ff9900")
         render_widget "item" => values,
                       "settings" => {
                          "axisx" => axisx,
@@ -26,12 +34,28 @@ module Sinatra
       # Set content type as json
       # http://support.geckoboard.com/entries/274940-custom-chart-widget-type-definitions
       #
-      # @param [Array] values array of hash with: value, label and colour keys
+      # @param [Array] values array of hash with: value, label and optional colour keys
       # @return [String] the pie chart as json string
       def pie_chart(values=[])
+        values.map! do |value|
+          value['colour'] ||= create_color value['label']
+          value
+        end
         render_widget "item" => values
       end
 
+      # Render a geck-o-meter widget
+      # Set content type as json
+      # http://support.geckoboard.com/entries/274940-custom-chart-widget-type-definitions
+      #
+      # @param [String] values
+      # @param [Hash] max Hash with text and value keys
+      # @param [Hash] min Hash with text and value keys
+      # @return [String] the geck-o-meter chart as json string
+      def geck_o_meter(value, max, min)
+        render_widget "item" => value, "max" => max, "min" => min
+      end
+
       protected
       def render_widget(widget)
         content_type :json

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: sinatra-geckoboard
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
   prerelease: 
 platform: ruby
 authors:
@@ -9,11 +9,11 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2011-09-11 00:00:00.000000000Z
+date: 2011-10-24 00:00:00.000000000Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: sinatra
-  requirement: &17976980 !ruby/object:Gem::Requirement
+  requirement: &18868100 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -21,10 +21,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *17976980
+  version_requirements: *18868100
 - !ruby/object:Gem::Dependency
   name: json
-  requirement: &17976500 !ruby/object:Gem::Requirement
+  requirement: &18904260 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -32,10 +32,10 @@ dependencies:
         version: '1.0'
   type: :runtime
   prerelease: false
-  version_requirements: *17976500
+  version_requirements: *18904260
 - !ruby/object:Gem::Dependency
   name: bundler
-  requirement: &17976120 !ruby/object:Gem::Requirement
+  requirement: &18903880 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -43,10 +43,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17976120
+  version_requirements: *18903880
 - !ruby/object:Gem::Dependency
   name: minitest
-  requirement: &17975580 !ruby/object:Gem::Requirement
+  requirement: &18903340 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ~>
@@ -54,10 +54,10 @@ dependencies:
         version: '2.0'
   type: :development
   prerelease: false
-  version_requirements: *17975580
+  version_requirements: *18903340
 - !ruby/object:Gem::Dependency
   name: rake
-  requirement: &17975160 !ruby/object:Gem::Requirement
+  requirement: &18902920 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -65,10 +65,10 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17975160
+  version_requirements: *18902920
 - !ruby/object:Gem::Dependency
   name: rack-test
-  requirement: &17974700 !ruby/object:Gem::Requirement
+  requirement: &18902460 !ruby/object:Gem::Requirement
     none: false
     requirements:
     - - ! '>='
@@ -76,7 +76,7 @@ dependencies:
         version: '0'
   type: :development
   prerelease: false
-  version_requirements: *17974700
+  version_requirements: *18902460
 description: A little Sinatra extension to expose data nicely to Geckoboard.
 email: francois.de.metz@af83.com
 executables: []