appboard 1.0.7 → 1.0.8

data/README.md

@@ -72,68 +72,110 @@ This will automatically create you an appboard.me account and create an default
 Usage
 -----
 
-There is several options how you could use API:
 
+**Setup Dashboard**
+
+After creating account (or deploying addon on Heroku) simple dashboard will be created for you with clocks :)
+
+In order to update or create new dashboard you will need to setup it, and the moment this supported only via Ruby GEM.
+
+Supported widget sizes are: 1x1, 1x2, 1x3, 2x1, 2x2, 2x3, 3x1, 3x2 and 3x3.
+Supported widget types are: Clock, Single Number, Alert, Bubble Chart, Funnel Chart, Line Chart, Bar Chart, Column Chart, Pie Chart, Radial Gauge, Filler Gauge. Check out [list of available widgets](http://appboard.me/docs/widgets). We are continue working over new nice widgets!
+
+There is simple example that updates default dashboard with new configuration:
 
-*Option 1.* Setup new dashboard and pushing data to widget:
 
     require 'rubygems'
     require 'appboard'
-    
-    Appboard.setup {
-      apiKey "zxcv1234"
-    
-      widget('My Clock') {
-        type "clock"
-        size "1x1"
-      }
-    
-      widget('First Indicator') {
-        type "singlenumber"
-        size "1x1"
-      }
-    }
-    
-    Appboard.widget('First Indicator') {
-      data do 
-        {
-          :current => 10
+        
+    Appboard.settings = { :apiKey => '...' }    # required only for local environment
+                                                # for Heroku will be taken from environment variables
+    Appboard.setup() {
+        dashboard('My Dashboard') {
+            width 5                             # defines widht of dashboard as 5 widgets
+            
+            widget('clock') {
+                type "Clock"
+                size "1x1"
+            }
+        
+            widget('my indicator 1') {
+                type "Single Number"
+                size "1x1"
+            }
+         
+            widget('my indicator 2') {
+                type "Alert"
+                size "1x1"
+            }
         }
-      end
     }
-    
-    puts Appboard.widget('First Indicator').uid 			# prints widget uid
 
 
-After seting up dashboard configuration is stored in Appboard class, and widget could be easily accessed by name. 
-For already configured dashboards you could push your data by widget uid.  
+As result of this operation dashboard with three widgets (Clock, Simple Number and Alert) will be set. Server will return in result widget's uid (unique identifier) and this data will be stored in Appboard class.
+
+You can access this data easily:
+
+    uidMyIndicator1 = Appboard.widget('my indicator1').uid
 
+Note: If you are running this on local environment you will need to define _*apiKey*_ before calling Appboard.setup, on Heroku apiKey will be injected during deploying appboard addon.
 
-*Option 2.* Pushing data to widget by widget UID
+    Appboard.settings = { :apiKey => '...', :debug => true }
+
+You can find more examples in our Git repository: [one](https://github.com/appboard/appboard/blob/master/examples/setupdashboard1.rb), [two](https://github.com/appboard/appboard/blob/master/examples/setupdashboard2.rb) and [three](https://github.com/appboard/appboard/blob/master/examples/setupdashboard3.rb)
+
+**Pushing your data to Widget**
+
+_in context of Appboard_ - after dashboard is set by Appboard.setup configuration is stored in Appboard class, and you can easily push data to widget by widget name:
 
     require 'rubygems'
     require 'appboard'
-    
-    Appboard.push {
-      apiKey "zxcv1234"
-      
-      widget('widget1') {
-        uid "abcd1234"
-      
-        data do
-          # Data is here		
-        end
-      }
-      
-      widget('widget2') {
-        uid "poiu4321"
         
+    Appboard.settings = { :apiKey => '...' }
+        
+    Appboard.setup() {
+        dashboard('My Dashboard') {
+            widget('clock') {
+                type "Clock"
+                size "1x1"
+            }
+        
+            widget('my indicator 1') {
+                type "Single Number"
+                size "1x1"
+            }
+        }
+    }
+        
+    Appboard.widget('my indicator 1') {
         data do
-          # Data is here		
+            {
+                :current => 100
+            }
         end
-      }
     }
 
+_by widget uid (unique identifier)_ - other way to push data to widget is define widget *uid*:
+
+    require 'rubygems'
+    require 'appboard'
+        
+    Appboard.settings = { :apiKey => '...' }
+        
+    Appboard.push {
+        widget() {
+            uid "[widgetUid]"
+            data do
+                {
+                    ...
+                }
+            end
+        }
+    }
+
+Each widget has its own page on this site. That page contains all the information you need in order to start working with the widget, including descriptions of data model (a piece that represents some kind of data). 
+
+More examples for different widgets you could find in "our repository":https://github.com/appboard/appboard/tree/master/examples on GitHub.
 
 
 NOTE:  Don't forget to specify your apiKey and widget identifier.

data/examples/alert.rb

@@ -5,51 +5,51 @@ require 'appboard'
 # Updates Alert Widget on Dashboard (see http://appboard.me/docs/alert)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-        uid "gFMndwmrtZzAWWYB"
-        data do
-            [
-                {
-                    :current => 0,
-                    :label => 'server 1',
-                    :boundaries => [
-                	{
-                    	    :shape => "triangledown",
-                    	    :color => "#fd1d25",
-                    	    :range => 0,
-                    	    :title => "Down"
-                	},
-                	{
-                    	    :shape => "triangleup",
-                    	    :color => "#9ac736",
-                    	    :range => 1,
-                    	    :title => "Up"
-                	}
-                    ]  
-                },
-                {
-                    :current => 1,
-                    :label => 'server 2',
-                    :boundaries => [
-                	{
-                    	    :shape => "triangledown",
-                    	    :color => "#fd1d25",
-                    	    :range => 0,
-                    	    :title => "Down"
-                	},
-                	{
-                    	    :shape => "triangleup",
-                    	    :color => "#9ac736",
-                    	    :range => 1,
-                    	    :title => "Up"
-                	}
-                    ]  
-                }
-            ]
-        end
-    }
+Appboard.push {
+  widget() {
+    uid "gFMndwmrtZzAWWYB"
+    data do
+      [
+        {
+          :current => 0,
+          :label => 'server 1',
+          :boundaries => [
+            {
+              :shape => "triangledown",
+              :color => "#fd1d25",
+              :range => 0,
+              :title => "Down"
+            },
+            {
+              :shape => "triangleup",
+              :color => "#9ac736",
+              :range => 1,
+              :title => "Up"
+            }
+          ]  
+        },
+        {
+          :current => 1,
+          :label => 'server 2',
+          :boundaries => [
+            {
+              :shape => "triangledown",
+              :color => "#fd1d25",
+              :range => 0,
+              :title => "Down"
+            },
+            {
+              :shape => "triangleup",
+              :color => "#9ac736",
+              :range => 1,
+              :title => "Up"
+            }
+          ]  
+        }
+      ]
+    end
+  }
 }
 

data/examples/barchart.rb

@@ -5,31 +5,31 @@ require 'appboard'
 # Updates Bar Chart on Dashboard (see http://appboard.me/docs/barchart)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "ULcgjwNlKgqNPEpz"
-      data do
-	{
-	    :xAxis => ["Jan", "Feb", "Mar", "Apr"],
-	    :series => [
-		{
-		    :name => "A",
-		    :entries => [2, 3, 4, 1]
-		},
-		{
-		    :name => "B",
-		    :entries => [1, 2, 3, 4]
-		},
-		{
-		    :name => "C",
-		    :entries => [2, 4, 2, 2]
-		}
-	    ]
-	 }
-      end
-    }
+Appboard.push {
+  widget() {
+    uid "ULcgjwNlKgqNPEpz"
+    data do
+      {
+        :xAxis => ["Jan", "Feb", "Mar", "Apr"],
+        :series => [
+          {
+            :name => "A",
+            :entries => [2, 3, 4, 1]
+          },
+          {
+            :name => "B",
+            :entries => [1, 2, 3, 4]
+          },
+          {
+            :name => "C",
+            :entries => [2, 4, 2, 2]
+          }
+        ]
+      }
+    end
+  }
 }
 
 

data/examples/bubblechart.rb

@@ -5,29 +5,29 @@ require 'appboard'
 # Updates Bubble Chart on Dashboard (see http://appboard.me/docs/bubblechart)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "dwTgneCxzCOlFTjI"     
-      data do
-	{ 
-	    :series => [
-		{
-		    :name => "A",
-		    :entries => 10
-		},
-		{
-		    :name => "B",
-		    :entries => 15
-		},
-		{
-		    :name => "C",
-		    :entries => 60
-		}
-	    ]
-	 }
-      end
-    }
+Appboard.push {
+  widget() {
+    uid "dwTgneCxzCOlFTjI"     
+    data do
+      { 
+        :series => [
+          {
+            :name => "A",
+            :entries => 10
+          },
+          {
+            :name => "B",
+            :entries => 15
+          },
+          {
+            :name => "C",
+            :entries => 60
+          }
+        ]
+      }
+    end
+  }
 }
 

data/examples/columnchart.rb

@@ -5,31 +5,31 @@ require 'appboard'
 # Updates Column Chart on Dashboard (see http://appboard.me/docs/columnchart)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "HkGIhTInYAwwwXbQ"
-      data do
-	{
-	    :xAxis => ["Jan", "Feb", "Mar", "Apr"],
-	    :series => [
-		{
-		    :name => "A",
-		    :entries => [2, 3, 4, 1]
-		},
-		{
-		    :name => "B",
-		    :entries => [3, 4, 2, 1]
-		},
-		{
-		    :name => "C",
-		    :entries => [5, 2, 1, 3]
-		}
-	    ]
-	}
-      end
-    }
+Appboard.push {
+  widget() {
+    uid "HkGIhTInYAwwwXbQ"
+    data do
+      {
+        :xAxis => ["Jan", "Feb", "Mar", "Apr"],
+        :series => [
+          {
+            :name => "A",
+            :entries => [2, 3, 4, 1]
+          },
+          {
+            :name => "B",
+            :entries => [3, 4, 2, 1]
+          },
+          {
+            :name => "C",
+            :entries => [5, 2, 1, 3]
+          }
+        ]
+      }
+    end
+  }
 }
 
 

data/examples/fillergauge.rb

@@ -5,23 +5,23 @@ require 'appboard'
 # Updates Filler Gauge on Dashboard (see  http://appboard.me/docs/gauge)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "vCmpsvRHKoLBZTBN"
-      data do
-	{
-           :value => 80,
-    	    :minimum => 0,
-    	    :maximum => 100,
-    	    :ranges => [
-    		{:range => 80, :fillColor => "#9ac736"},
-    	        {:range => 15, :fillColor => "#e06f0f"},
-    	        {:range => 5, :fillColor => "#fd1d25"}
-    	    ]    
-	}
-      end
-    }
+Appboard.push {
+  widget() {
+    uid "vCmpsvRHKoLBZTBN"
+    data do
+      {
+        :value => 80,
+        :minimum => 0,
+        :maximum => 100,
+        :ranges => [
+          {:range => 80, :fillColor => "#9ac736"},
+          {:range => 15, :fillColor => "#e06f0f"},
+          {:range => 5, :fillColor => "#fd1d25"}
+        ]    
+      }
+    end
+  }
 }
 

data/examples/funnelchart.rb

@@ -5,29 +5,29 @@ require 'appboard'
 # Updates Funnel Chart on Dashboard (see http://appboard.me/docs/funnelchart)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "wyKUysnPLOmXpLcC"	
-      data do
-        {
-	    :series => [
-		{
-		    :name => "A",
-		    :entries => 1
-		},
-		{
-		    :name => "B",
-		    :entries => 20
-		},
-		{
-		    :name => "C",
-		    :entries => 5
-		}
-	    ]
-	 }
-	end
-    }
+Appboard.push {
+  widget() {
+    uid "wyKUysnPLOmXpLcC"	
+    data do
+      {
+        :series => [
+          {
+            :name => "A",
+            :entries => 1
+          },
+          {
+            :name => "B",
+            :entries => 20
+          },
+          {
+            :name => "C",
+            :entries => 5
+          }
+        ]
+      }
+    end
+  }
 }
 

data/examples/linechart.rb

@@ -5,30 +5,30 @@ require 'appboard'
 # Updates Line Chart on Dashboard (see http://appboard.me/docs/linechart)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "CrnBIfRFvkFcNKPX"
-      data do
-	{
-	    :xAxis => ["Jan", "Feb", "Mar", "Apr"],
-	    :series => [
-		{
-		    :name => "A",
-		    :entries => [1, 2, 3, 4]
-		},
-		{
-		    :name => "B",
-		    :entries => [10, 15, 20, 10]
-		},
-		{
-		    :name => "C",
-		    :entries => [20, 10, 5, 5]
-		}
-	    ]
-	}
-      end
-    }
+Appboard.push {
+  widget() {
+    uid "CrnBIfRFvkFcNKPX"
+    data do
+      {
+        :xAxis => ["Jan", "Feb", "Mar", "Apr"],
+        :series => [
+          {
+            :name => "A",
+            :entries => [1, 2, 3, 4]
+          },
+          {
+            :name => "B",
+            :entries => [10, 15, 20, 10]
+          },
+          {
+            :name => "C",
+            :entries => [20, 10, 5, 5]
+          }
+        ]
+      }
+    end
+  }
 }
 

data/examples/piechart.rb

@@ -5,29 +5,29 @@ require 'appboard'
 # Updates Pie Chart on Dashboard (see http://appboard.me/docs/piechart)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "QHKUBwxBPpiaAinB"
-      data do
-        {
-	    :series => [
-		{
-		    :name => "A",
-		    :entries => 1
-		},
-		{
-		    :name => "B",
-		    :entries => 2
-		},
-		{
-		    :name => "C",
-		    :entries => 3
-		}
-	    ]
-	 }
-      end
-    }
+Appboard.push {
+  widget() {
+    uid "QHKUBwxBPpiaAinB"
+    data do
+      {
+        :series => [
+          {
+            :name => "A",
+            :entries => 1
+          },
+          {
+            :name => "B",
+            :entries => 2
+          },
+          {
+            :name => "C",
+            :entries => 3
+          }
+        ]
+      }
+    end
+  }
 }
 

data/examples/radialgauge.rb

@@ -5,23 +5,23 @@ require 'appboard'
 # Updates Radial Gauge on Dashboard (see http://appboard.me/docs/gauge)
 # Don't forget to specify your apiKey and widget identifier.
 #
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
 
-    widget('some name here') {
-      uid "BEMTCnwSYHQntaBS"
-      data do
-        {
-	    :value => 80,
-    	    :minimum => 0,
-    	    :maximum => 100,
-    	    :ranges => [
-    		{:range => 80, :fillColor => "#9ac736"},
-    	        {:range => 15, :fillColor => "#e06f0f"},
-    	        {:range => 5, :fillColor => "#fd1d25"}
-    	    ]    
-	}
-      end
-    }
+Appboard.push {
+  widget() {
+    uid "BEMTCnwSYHQntaBS"
+    data do
+      {
+        :value => 80,
+        :minimum => 0,
+        :maximum => 100,
+        :ranges => [
+          {:range => 80, :fillColor => "#9ac736"},
+          {:range => 15, :fillColor => "#e06f0f"},
+          {:range => 5, :fillColor => "#fd1d25"}
+        ]    
+      }
+    end
+  }
 }
 

data/examples/setupdashboard1.rb

@@ -0,0 +1,80 @@
+require 'rubygems'
+require 'appboard'
+
+#
+# Creates dashboard with four widgets (Clock, Single Number, Radial Gauge and Pie Chart) and push some random data to widgets.
+# Don't forget to specify your apiKey.
+#
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
+
+# Dashboard configuration
+Appboard.setup() {
+  dashboard('My Dashboard') {    
+    widget('clock') {
+      type "Clock"
+      size "1x1"
+    }
+
+    widget('indicator 1') {
+      type "Single Number"
+      size "1x1"
+    }
+    
+    widget('indicator 2') {
+      type "Radial Gauge"
+      size "1x1"
+    }
+    
+    widget('indicator 3') {
+      type "Pie Chart"
+      size "1x1"
+    }
+  }
+}
+
+
+# Pushing some demo data to widgets separately
+Appboard.widget('indicator 1') {
+  data do
+    {
+      :current => Random.rand(100)
+    }
+  end
+}
+
+Appboard.widget('indicator 2') {
+  data do
+    {
+      :value => Random.rand(100),
+      :minimum => 0,
+      :maximum => 100,
+      :ranges => [
+        {:range => 80, :fillColor => "#9ac736"},
+        {:range => 15, :fillColor => "#e06f0f"},
+        {:range => 5, :fillColor => "#fd1d25"}
+      ]
+    }
+  end
+}
+
+Appboard.widget('indicator 3') {
+  data do
+    {
+      :series => [
+        {
+          :name => "A",
+          :entries => Random.rand(100)
+        },
+        {
+          :name => "B",
+          :entries => Random.rand(100)
+        },
+        {
+          :name => "C",
+          :entries => Random.rand(100)
+        }
+      ]
+    }
+  end
+}
+

data/examples/setupdashboard2.rb

@@ -0,0 +1,115 @@
+require 'rubygems'
+require 'appboard'
+
+#
+# Creates dashboard with four widgets (Clock, Alert, Filler Gauge and Bubble Chart) and push some random data to widgets.
+# Don't forget to specify your apiKey.
+#
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
+
+# Dashboard configuration
+Appboard.setup() {
+  dashboard('My Dashboard') {    
+    widget('clock') {
+      type "Clock"
+      size "1x1"
+    }
+    
+    widget('indicator 1') {
+      type "Alert"
+      size "1x1"
+    }
+    
+    widget('indicator 2') {
+      type "Filler Gauge"
+      size "1x1"
+    }
+    
+    widget('indicator 3') {
+      type "Bubble Chart"
+      size "1x1"
+    }
+  }
+}
+
+
+# Pushing some demo data to widgets by widget name
+Appboard.push {
+  widget('indicator 1') {
+    data do
+      [
+        {
+          :current => Random.rand(1),
+          :label => 'Example 1',
+          :boundaries => [
+            {
+              :shape => "rectangle",
+              :color => "#00FF00",
+              :range => 0,
+              :title => "Down"
+            },{
+              :shape => "rhombus",
+              :color => "#FF0000",
+              :range => 1,
+              :title => "Up"
+            }
+          ]
+        }, 
+        {
+          :current =>  Random.rand(1),
+          :label => 'Example 2',
+          :boundaries => [
+            {
+              :shape => "triangledown",
+              :color => "#fd1d25",
+              :range => 0,
+              :title => "Down"
+            },{
+              :shape => "triangleup",
+              :color => "#9ac736",
+              :range => 1,
+              :title => "Up"
+            }
+          ]
+        }
+      ]
+    end
+  }
+  
+  widget('indicator 2') {
+    data do
+      {
+        :value => Random.rand(100),
+        :minimum => 0,
+        :maximum => 100,
+        :ranges => [
+          {:range => 80, :fillColor => "#9ac736"},
+          {:range => 15, :fillColor => "#e06f0f"},
+          {:range => 5, :fillColor => "#fd1d25"}
+          ]
+      }
+    end
+  }
+ 
+  widget('indicator 3') {
+    data do
+      {
+        :series => [
+          {
+            :name => "Example 1", 
+            :entries => Random.rand(100),
+          },
+          {
+            :name => "Example 2",
+            :entries => Random.rand(100),
+          },
+          {
+            :name => "Example 3",
+            :entries => Random.rand(100),
+          }
+        ]
+      }
+    end
+  }
+}
+

data/examples/setupdashboard3.rb

@@ -0,0 +1,112 @@
+require 'rubygems'
+require 'appboard'
+
+#
+# Creates dashboard with four widgets (Clock, Line Chart, Bar Chart and Column Chart) and push some random data to widgets.
+# Don't forget to specify your apiKey.
+#
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
+
+# Dashboard configuration
+Appboard.setup() {
+  dashboard('My Dashboard') {    
+    widget('clock') {
+      type "clock"
+      size "1x1"
+    }
+    
+    widget('indicator 1') {
+      type "linechart"
+      size "3x1"
+    }
+    
+    widget('indicator 2') {
+      type "barchart"
+      size "2x2"
+    }
+    
+    widget('indicator 3') {
+      type "columnchart"
+      size "2x2"
+    }
+  }
+}
+
+i1Uid = Appboard.widget('indicator 1').uid
+i2Uid = Appboard.widget('indicator 2').uid
+i3Uid = Appboard.widget('indicator 3').uid
+
+# Pushing some demo data to widgets by widget uid
+Appboard.push {
+  widget() {
+    uid i1Uid
+    
+    data do
+      {
+        :xAxis => ["Jan", "Feb", "Mar", "Apr"],
+        :series => [
+          {
+            :name => "Example 1",
+            :entries => [Random.rand(10), Random.rand(10), Random.rand(10), Random.rand(10)]
+          },
+          {
+            :name => "Example 2",
+            :entries => [Random.rand(20), Random.rand(20), Random.rand(20), Random.rand(20)]
+          },
+          {
+            :name => "Example 3",
+            :entries => [Random.rand(40), Random.rand(40), Random.rand(40), Random.rand(40)]
+          }
+        ]
+      }
+    end
+  }
+  
+  widget() {
+    uid i2Uid
+
+    data do
+      {
+        :xAxis => ["Jan", "Feb", "Mar", "Apr"],
+        :series => [
+          {
+            :name => "Example 1",
+            :entries => [Random.rand(10), Random.rand(10), Random.rand(10), Random.rand(10)]
+          },
+          {
+            :name => "Example 2",
+            :entries => [Random.rand(20), Random.rand(20), Random.rand(20), Random.rand(20)]
+          },
+          {
+            :name => "Example 3",
+            :entries => [Random.rand(40), Random.rand(40), Random.rand(40), Random.rand(40)]
+          }
+        ]
+      }
+    end
+  }
+  
+  widget() {
+    uid i3Uid
+
+    data do
+      {
+        :xAxis => ["Jan", "Feb", "Mar", "Apr"],
+        :series => [
+          {
+            :name => "Example 1",
+            :entries => [Random.rand(10), Random.rand(10), Random.rand(10), Random.rand(10)]
+          },
+          {
+            :name => "Example 2",
+            :entries => [Random.rand(20), Random.rand(20), Random.rand(20), Random.rand(20)]
+          },
+          {
+            :name => "Example 3",
+            :entries => [Random.rand(40), Random.rand(40), Random.rand(40), Random.rand(40)]
+          }
+        ]
+      }
+    end
+  }
+}

data/examples/singlenumber.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require 'appboard'
+
+#
+# Updates Singge Number on Dashboard (see http://appboard.me/docs/singlenumber)
+# Don't forget to specify your apiKey and widget identifier.
+#
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :url => 'http://localhost:9000', :debug => true }
+
+Appboard.push {
+  widget() {
+    uid "weXtrkUwSeZGvcRK"	
+    data do 
+      {
+        :current => 100
+      }
+    end
+  }
+}

data/lib/appboard/dashboardsetup.rb

@@ -2,7 +2,7 @@ module Appboard
   # Dashboard configuration
   class DashboardSetup
     # Defines dashboard
-    class Dashboard
+    class Dashboard      
       def initialize(name, &block)
         @widgets = {}
         @width = 5

data/lib/appboard/version.rb

@@ -2,7 +2,7 @@ module Appboard #:nodoc:
   module Version #:nodoc:
     MAJOR = 1
     MINOR = 0
-    TINY  = 7
+    TINY  = 8
      
     STRING = [MAJOR, MINOR, TINY].join('.')
   end

data/lib/appboard/widgetpusher.rb

@@ -43,13 +43,11 @@ module Appboard
     #   end
     # }
     # 
-    def widget(widget_name)
+    def widget(widget_name = nil)
       if block_given?
         block = Proc.new
         widget = Widget.new(widget_name, &block)
-        
-        raise ArgumentError, "Widget 'uid' is not defined" if widget.uid.nil?
-        
+                
         (@widgets ||= []) << widget
         self
       else

data/lib/appboard.rb

@@ -100,6 +100,22 @@ module Appboard
         pusher = WidgetPusher.new.instance_eval(&block)
                
         pusher.get_widgets.each do |widget|
+          dashboard = nil
+      
+          if widget.name
+            @@dashboards.each do |name, db|
+              dashboard = db if db.has_widget(widget.name)
+              break if dashboard
+            end
+          
+            if dashboard
+              widget_tmpl = dashboard.get_widget(widget.name)
+              widget.uid(widget_tmpl.uid)
+            end
+          end          
+          
+          raise ArgumentError, "Widget 'uid' and 'name' are not defined" if widget.uid.nil? && widget.name.nil?
+
           apiKey = pusher.apiKey || config[:apiKey]
           url = "#{config[:url]}/#{config[:version]}/#{apiKey}/data/#{widget.uid}"
       
@@ -124,7 +140,7 @@ module Appboard
       
       @@dashboards.each do |name, db|
         dashboard = db if db.has_widget(widget_name)
-        break if dashboard.nil?
+        break if dashboard
       end
       
       raise ArgumentError, "Widget '#{widget_name}' is not defined, to use this method setup dashboard with Appboard.setup()" if dashboard.nil?

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appboard
 version: !ruby/object:Gem::Version 
-  hash: 25
+  hash: 7
   prerelease: false
   segments: 
   - 1
   - 0
-  - 7
-  version: 1.0.7
+  - 8
+  version: 1.0.8
 platform: ruby
 authors: 
 - appboard.me
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-19 00:00:00 -04:00
+date: 2011-07-20 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -100,7 +100,10 @@ files:
 - examples/piechart.rb
 - examples/radialgauge.rb
 - examples/setupdashboard.rb
-- examples/singlenumner.rb
+- examples/setupdashboard1.rb
+- examples/setupdashboard2.rb
+- examples/setupdashboard3.rb
+- examples/singlenumber.rb
 - lib/appboard.rb
 - lib/appboard/bootstrap.rb
 - lib/appboard/dashboardsetup.rb

data/examples/singlenumner.rb

@@ -1,19 +0,0 @@
-require 'rubygems'
-require 'appboard'
-
-#
-# Updates Singge Number on Dashboard (see http://appboard.me/docs/singlenumber)
-# Don't forget to specify your apiKey and widget identifier.
-#
-Appboard.push {
-    apiKey 'wOUpOJeOozcgPdZa'
-
-    widget('some name here') {
-      uid "weXtrkUwSeZGvcRK"	
-      data do 
-	{
-	    :current => 100
-	}
-      end
-    }
-}