dboard 0.0.3 → 0.0.4

data/README.md

@@ -0,0 +1,57 @@
+A dashboard framework.
+
+It handles collecting data from user defined sources (simple ruby classes) and provides a simple API to poll for updates. See the [example app](https://github.com/joakimk/dboard_example) for information on how to use it.
+
+It's stable and has been in use for quite a while.
+
+Dboard is two parts:
+
+* The collection process you run on your server. It polls sources for data and sends it to your dashboard web server.
+* The API which combined with for example sinatra (and memcached) becomes a dashboard web server.
+
+Things dboard do for you:
+
+* Calls your classes for data as often as you have specified.
+* Sends the data to the dashboard web app.
+* Receives and stores the data in the dashboard web app.
+* Provides an API to get data to display on the dashboard.
+* Keeps the latest data in memcache so that all data is available when you visit the databoard, even data from slow or rarely updated sources (like external APIs).
+* Provides a javascript client that knows how to talk to the API (for now it's only included in the [example app](https://github.com/joakimk/dboard_example))
+* Only calls your javascript widgets when there is new data.
+
+Data flow:
+
+    +-----------------+              +--------------------+
+    |                 |              |                    |
+    |   Collector     | Pushes data  |   Dashboard web    |
+    |                 +--------------+   server           +----+
+    |                 |              |                    |    |
+    +-----------------+              +--------------------+    | Polls for updates
+       |           |                                           |
+       |           |                                           |
+    +--+--+     +--+--+                         +--------------+-------------+
+    |     |     |     |                         |                            |
+    |     |     |     |                         |  Dashboard page            |
+    +-----+     +-----+                         |                            |
+    Source A    Source B                        |                            |
+                                                |  See the example app.      |
+                                                |                            |
+                                                |                            |
+                                                |                            |
+                                                |                            |
+                                                |                            |
+                                                |                            |
+                                                |                            |
+                                                |                            |
+                                                |                            |
+                                                +----------------------------+
+
+The ASCII drawing above was created using [http://www.asciiflow.com/](http://www.asciiflow.com/).
+
+Todo:
+
+* Include the client side dashboard script (see the [example app](https://github.com/joakimk/dboard_example) for now).
+* Provide additional tools for creating dashboards (layout css, graphical widgets, etc). Probably as another gem.
+* Tools for deployment (if it can be made generic enough), otherwise a general guide.
+* Make the example app a bit more realistic. Dev-mode tools (foreman, guard, auto-reload-sources), use the collector, layout, more sources, etc.
+* If someone wants to add it: support for pushing data to the client using web sockets.

data/lib/publisher.rb

@@ -3,7 +3,7 @@ require 'json'
 module Dboard
   class Publisher
     def self.publish(source, data)
-      Api::Client.post("/sources/#{source}", :body => { :data => data.to_json })
+      Api::Client.post("/sources/#{source}", :body => { :data => data.to_json }, :timeout => 10000)
     rescue SocketError => ex
       puts "SocketError: #{ex.message}"
     end

data/lib/version.rb

@@ -1,3 +1,3 @@
 module Dboard
-  VERSION = "0.0.3"
+  VERSION = "0.0.4"
 end

data/spec/publisher_spec.rb

@@ -3,7 +3,7 @@ require File.expand_path(File.join(File.dirname(__FILE__), 'spec_helper'))
 describe "Publisher", "publish" do
   
   it "should send data to the dashboard server" do
-    Dboard::Api::Client.should_receive(:post).with("/sources/new_relic", :body => { :data => { :db => "80%" }.to_json })
+    Dboard::Api::Client.should_receive(:post).with("/sources/new_relic", :body => { :data => { :db => "80%" }.to_json }, :timeout => 10000)
     Dboard::Publisher.publish(:new_relic, { :db => "80%" })
   end
 

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: dboard
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 23
   prerelease: 
   segments: 
   - 0
   - 0
-  - 3
-  version: 0.0.3
+  - 4
+  version: 0.0.4
 platform: ruby
 authors: 
 - "Joakim Kolsj\xC3\xB6"
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-09-25 00:00:00 +02:00
+date: 2012-02-14 00:00:00 +01:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -192,7 +192,7 @@ files:
 - Gemfile
 - Guardfile
 - LICENCE
-- README
+- README.md
 - Rakefile
 - dboard.gemspec
 - lib/api.rb