appboard 1.0.2 → 1.0.3

data/README.md

@@ -9,7 +9,7 @@ Further reading:
 * [Home page](http://appboard.me/)
 * [The essential documentation](http://appboard.me/docs)
 * [List of available widgets](http://appboard.me/docs/widgets)
-
+* [Follow us on Twitter](http://twitter.com/appboard)
 
 NOTE: We are currently in private beta. Please let me know (eugene@appboard.me) if you'd like an invite.
 
@@ -38,7 +38,7 @@ or you could define API key in call block:
     require 'rubygems'
     require 'appboard'
 
-    Appboard.pub {
+    Appboard.push {
         apiKey "abcd1234"
     
         widget('some name here') {
@@ -72,8 +72,8 @@ There is several options how you could use API:
 
     require 'rubygems'
     require 'appboard'
-
-    Appboard.settings ({ :apiKey => "abcd1234" })
+    
+    Appboard.settings = { :apiKey => "abcd1234" } 
 
     widget = Appboard.widget('some name here') {
 	    uid "abcd1234"
@@ -83,7 +83,7 @@ There is several options how you could use API:
 	    }
     }
 
-    response = widget.pub    			# publish data on appboard.me
+    response = widget.push    			# push data to Dashboard on appboard.me
 
     response.success?     # => true
     response.code         # => 200
@@ -94,10 +94,7 @@ There is several options how you could use API:
     require 'rubygems'
     require 'appboard'
 
-    Appboard.settings ({ :apiKey => "abcd1234" })
-
-
-    Appboard.pub {
+    Appboard.push {
         apiKey "abcd1234"
     
         widget('widget1') {
@@ -106,14 +103,14 @@ There is several options how you could use API:
 		    data do {
 			    # Data is here		
 		    }
-    	 }
+    	}
         widget('widget2') {
 		    uid "abcd4321"
 
 		    data do {
 			    # Data is here		
 		    }
-    	 }
+    	}
     }
 
 

data/examples/barchart.rb

@@ -0,0 +1,36 @@
+require 'rubygems'
+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'
+
+    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
+    }
+}
+
+
+

data/examples/bubblechart.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+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'
+
+    widget('some name here') {
+      uid "dwTgneCxzCOlFTjI"     
+      data do
+	{ 
+	    :series => [
+		{
+		    :name => "A",
+		    :entries => 10
+		},
+		{
+		    :name => "B",
+		    :entries => 15
+		},
+		{
+		    :name => "C",
+		    :entries => 60
+		}
+	    ]
+	 }
+      end
+    }
+}
+

data/examples/columnchart.rb

@@ -0,0 +1,35 @@
+require 'rubygems'
+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'
+
+    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
+    }
+}
+
+

data/examples/fillergauge.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+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'
+
+    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
+    }
+}
+

data/examples/funnelchart.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+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'
+
+    widget('some name here') {
+      uid "wyKUysnPLOmXpLcC"	
+      data do
+        {
+	    :series => [
+		{
+		    :name => "A",
+		    :entries => 1
+		},
+		{
+		    :name => "B",
+		    :entries => 20
+		},
+		{
+		    :name => "C",
+		    :entries => 5
+		}
+	    ]
+	 }
+	end
+    }
+}
+

data/examples/linechart.rb

@@ -0,0 +1,34 @@
+require 'rubygems'
+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'
+
+    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
+    }
+}
+

data/examples/piechart.rb

@@ -0,0 +1,33 @@
+require 'rubygems'
+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'
+
+    widget('some name here') {
+      uid "QHKUBwxBPpiaAinB"
+      data do
+        {
+	    :series => [
+		{
+		    :name => "A",
+		    :entries => 1
+		},
+		{
+		    :name => "B",
+		    :entries => 2
+		},
+		{
+		    :name => "C",
+		    :entries => 3
+		}
+	    ]
+	 }
+      end
+    }
+}
+

data/examples/radialgauge.rb

@@ -0,0 +1,27 @@
+require 'rubygems'
+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'
+
+    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
+    }
+}
+

data/examples/singlenumner.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.push {
+    apiKey 'wOUpOJeOozcgPdZa'
+
+    widget('some name here') {
+      uid "weXtrkUwSeZGvcRK"	
+      data do 
+	{
+	    :current => 100
+	}
+      end
+    }
+}

data/lib/appboard/bootstrap.rb

@@ -1,22 +1,25 @@
-module Appboard
-  module Bootstrap
-    def default_settings
-      url = URI.parse(ENV["APPBOARD_API_URL"] || 'http://api.appboard.me')
-      {
-        :url => url,
-	:version => 'v1',
-        :logging => false
-      }
-    rescue Object => e
-      raise "invalid APPBOARD_API_URL: (#{url.inspect}) #{e.class} -> #{e.message}"
-    end
-    
-    def settings
-      @@settings ||= default_settings
-    end
-    
-    def settings=(settings_hash)
-      @@settings = default_settings.update(settings_hash)
-    end
-  end
+module Appboard
+  module Bootstrap
+    def default_settings
+      url = URI.parse(ENV["APPBOARD_API_URL"] || 'http://api.appboard.me')
+      apiKey = ENV["APPBOARD_API_KEY"]
+
+      {
+        :url => url,
+        :apiKey => apiKey,
+	:version => 'v1',
+        :logging => false
+      }
+    rescue Object => e
+      raise "invalid APPBOARD_API_URL: (#{url.inspect}) #{e.class} -> #{e.message}"
+    end
+    
+    def settings
+      @@settings ||= default_settings
+    end
+    
+    def settings=(settings_hash)
+      @@settings = default_settings.update(settings_hash)
+    end
+  end
 end

data/lib/appboard/version.rb

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

data/lib/appboard.rb

@@ -23,9 +23,9 @@ module Appboard
         @apiKey                                                                                     
     end                         
 
-    # Publish all defined widgets in block
+    # Push on dashboard all defined widgets in block
     #
-    # appboard.pub {
+    # appboard.push {
     #    # Do stuff in here
     # }
     #
@@ -35,13 +35,13 @@ module Appboard
     #
     # Refer to default config below for how to set these as defaults
     #
-    def pub(options = {}, &block)
+    def push(options = {}, &block)
       @config = settings.update(options)
-	
+
       self.instance_eval(&block) if block_given?
     end
 
-    # Define a widget. May be called inside start loop or separately
+    # Define a widget. May be called inside push loop or separately
     #
     # widget('name') {
     #   data {

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appboard
 version: !ruby/object:Gem::Version 
-  hash: 19
+  hash: 17
   prerelease: false
   segments: 
   - 1
   - 0
-  - 2
-  version: 1.0.2
+  - 3
+  version: 1.0.3
 platform: ruby
 authors: 
 - appboard.me
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-06-29 00:00:00 -04:00
+date: 2011-06-30 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -79,7 +79,7 @@ dependencies:
         version: "0"
   requirement: *id004
   type: :development
-description: Simple and opinionated interface on top of RESTful HTTP API for pushing your data to appboard.me
+description: Simple and opinionated interface on top of RESTful HTTP API for pushing your data to Dashboard on appboard.me
 email: eugene@appboard.me
 executables: []
 
@@ -89,13 +89,22 @@ extra_rdoc_files:
 - LICENSE.txt
 - README.md
 files: 
+- README.md
+- examples/barchart.rb
+- examples/bubblechart.rb
+- examples/columnchart.rb
+- examples/fillergauge.rb
+- examples/funnelchart.rb
+- examples/linechart.rb
+- examples/piechart.rb
+- examples/radialgauge.rb
+- examples/singlenumner.rb
 - lib/appboard.rb
 - lib/appboard/bootstrap.rb
 - lib/appboard/rest_api.rb
 - lib/appboard/version.rb
 - lib/appboard/widget.rb
 - LICENSE.txt
-- README.md
 has_rdoc: true
 homepage: https://github.com/appboard/appboard
 licenses: []
@@ -129,6 +138,6 @@ rubyforge_project:
 rubygems_version: 1.3.7
 signing_key: 
 specification_version: 3
-summary: API interface on top of RESTful HTTP API for pushing your data to appboard.me
+summary: API interface on top of RESTful HTTP API for pushing your data to Dashboard on appboard.me
 test_files: []