appboard 1.0.5 → 1.0.6

data/README.md

@@ -12,7 +12,7 @@ Further reading:
 * [Demo Dashboard](http://appboard.me/demo)
 * [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.
+NOTE: We are currently in private beta. Please let me know (dev@appboard.me) if you'd like an invite.
 
 
 Gem Installation
@@ -39,16 +39,21 @@ or you could define API key in call block:
     require 'rubygems'
     require 'appboard'
 
-    Appboard.push {
+    Appboard.setup {
         apiKey "abcd1234"
     
-        widget('some name here') {
-		    uid "abcd1234"
+        ...			
+    }
+
+or,
 
-		    data do 
-			    # Data is here		
-		    end
-    	}
+    require 'rubygems'
+    require 'appboard'
+
+    Appboard.push {
+        apiKey "abcd1234"
+    
+        ...			
     }
 
 
@@ -69,28 +74,43 @@ Usage
 
 There is several options how you could use API:
 
-*publish each widget separately*
+
+*Option 1.* Setup new dashboard and pushing data to widget:
+
 
     require 'rubygems'
     require 'appboard'
+
+    Appboard.setup {
+        apiKey "zxcv1234"
     
-    Appboard.settings = { :apiKey => "zxcv1234" } 
+        widget('My Clock') {
+		    		type "clock"
+						size "1x1"
+				}
+    	
+        widget('First Indicator') {
+		    		type "singlenumber"
+						size "1x1"
+    		}
+    }
 
-    widget = Appboard.widget('some name here') {
-	    uid "abcd1234"
+    Appboard.widget('First Indicator') {
+				data do 
+					{
+	    			:current => 10
+					}
+				end
+		}
 
-	    data do 
-		    # Data is here		
-	    end
-    }
+		puts Appboard.widget('First Indicator').uid 			# prints widget uid
 
-    response = widget.push    			# push data to Dashboard on appboard.me
 
-    response.success?     # => true
-    response.code         # => 200
+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.  
 
 
-*publish few widgets at once*
+*Option 2.* Pushing data to widget by widget UID
 
     require 'rubygems'
     require 'appboard'
@@ -99,24 +119,23 @@ There is several options how you could use API:
         apiKey "zxcv1234"
     
         widget('widget1') {
-		    uid "abcd1234"
+		    		uid "abcd1234"
+
+		    		data do
+			    		# Data is here		
+		    		end
+    		}
 
-		    data do
-			    # Data is here		
-		    end
-    	}
         widget('widget2') {
-		    uid "poiu4321"
+		    		uid "poiu4321"
 
-		    data do
-			    # Data is here		
-		    end
-    	}
+		    		data do
+			    		# Data is here		
+		    		end
+    		}
     }
 
 
-    widget = Appboard.widget('widget1') 			# after you could access widget by name 
-
 
 NOTE:  Don't forget to specify your apiKey and widget identifier.
 

data/examples/setupdashboard.rb

@@ -0,0 +1,44 @@
+require 'rubygems'
+require 'appboard'
+
+#
+# Seting up new dashboard.
+# Don't forget to specify your apiKey and widget identifier.
+#
+Appboard.settings = { :apiKey => 'wOUpOJeOozcgPdZa', :debug => true }
+
+Appboard.setup() {
+	dashboard('my dashboard1') {    
+		widget('clock') {
+			type "clock"
+			size "1x1"
+		}
+
+		widget('my indicator 1') {
+			type "singlenumber"
+			size "1x1"
+		}
+
+		widget('my indicator 2') {
+			type "singlenumber"
+			size "1x1"
+		}
+	}
+}
+
+
+Appboard.widget('my indicator 1') {
+    data do 
+	{
+	    :current => 10
+	}
+    end
+}
+
+Appboard.widget('my indicator 2') {
+    data do 
+	{
+	    :current => 20
+	}
+    end
+}

data/lib/appboard/bootstrap.rb

@@ -7,8 +7,9 @@ module Appboard
       {
         :url => url,
         :apiKey => apiKey,
-	:version => 'v1',
-        :logging => false
+				:version => 'v1',
+        :logging => false,
+				:debug => false
       }
     rescue Object => e
       raise "invalid APPBOARD_API_URL: (#{url.inspect}) #{e.class} -> #{e.message}"

data/lib/appboard/dashboardsetup.rb

@@ -0,0 +1,168 @@
+module Appboard
+  # Dashboard configuration
+  class DashboardSetup
+    # Defines dashboard
+    class Dashboard
+      def initialize(name, &block)
+        @widgets = {}
+        @width = 5
+        @name = name
+        
+        instance_eval(&block)
+      end
+
+      def widgets
+        @widgets
+      end
+
+      def name
+        @name
+      end
+
+      def width(value = nil)
+        @width = value unless value.nil?
+        @width
+      end	
+
+      def uid(value = nil)
+        @uid = value unless value.nil?
+        @uid
+      end	
+
+      # Define a widget. May be called inside push loop or separately
+      #
+      # widget('name') {
+      #    type "..."
+      #    size "..."  
+      # }
+      # 
+      def widget(widget_name)
+        if block_given?
+          block = Proc.new
+          widget = Widget.new(widget_name, &block)
+
+          raise ArgumentError, "Widget with name '#{widget_name.to_s}' is already defined" if @widgets[widget_name.to_s]
+
+          @widgets[widget_name.to_s] = widget
+        else
+          widget = @widgets[widget_name.to_s]
+
+          raise ArgumentError, "Widget is not defined, to define new widget you must supply a block as the last argument" if widget.nil?
+        end 	
+        widget
+      end
+
+      def get_widgets
+        widgets = []
+      
+        @widgets.each do |name, widget| 
+          widgets << widget
+        end 
+      
+        widgets
+      end
+
+      def has(name)
+        true if @widgets[name]
+      end
+  
+      def to_json(*a)
+        widgets = []
+  
+        @widgets.each do |name, widget| 
+          widgets << widget
+        end 
+  
+        {
+          :name     => @name,
+          :width     => @width,
+          :widgets  => widgets
+        }.to_json(*a)
+      end
+  	 end
+
+    # Defines widget
+    class Widget
+      def initialize(name, &block)
+        @name = name
+        instance_eval(&block)
+      end
+      
+      def name
+        @name
+      end
+      
+      def uid(value = nil)
+        @uid = value unless value.nil?
+        @uid
+      end
+      
+      def type(value = nil)
+        @type = value unless value.nil?
+        @type
+      end
+      
+      def size(value = nil)
+        @size = value unless value.nil? 
+        @size
+      end
+      
+      def data(&block)
+        @data = block if block_given?
+        @data
+      end
+        
+      def get_data
+        @data.call()
+      end
+      
+      def to_json(*a)
+        {
+          :name   => @name,
+          :type   => @type,
+          :size   => @size
+        }.to_json(*a)
+      end
+    end
+
+    # Define API key
+    def apiKey(value = nil)                                                                                                   
+      @apiKey = value unless value.nil?                                                                                   
+      @apiKey                                                                                     
+    end         
+
+    # Define a dashboard. May be called inside setup loop or separately
+    #
+    # dashboard('name') {
+    #   width 5 
+    #
+    #   widget('widget 1') {
+    #     type "..."
+    #     size "..."  		
+    #   }
+    #
+    #   widget('widget 2') {
+    #     # widget configuration is here  
+    #   }
+    # }
+    # 
+    def dashboard(name)
+      block = Proc.new
+      @dashboard = Dashboard.new(name, &block) 
+      
+      self
+    end
+
+    def get_dashboard
+      @dashboard
+    end
+    
+    def get_widget(name)
+      @dashboard.widget(name)
+    end
+    
+    def has_widget(name)
+      @dashboard.has(name)
+    end
+  end
+end

data/lib/appboard/exceptions.rb

@@ -4,19 +4,19 @@ module Appboard
   # Rescuing Appboard::Error (or RuntimeError) will get all custom exceptions.
   # If your dashboard is correctly configured and data is specified correctly, you should never expect to see any of these.
   class Error < RuntimeError
-
+  
     # BadRequest is raised when a data for widget is specified incorrectly. Message usualy contains reference to documentation.
     class BadRequest < Error
     end
-
+    
     # NotFound is raised when a apiKey, dashboard or widget is not found.
     class NotFound < Error
     end
-
+    
     # ThrottleLimit is raised when throttle limit is reached (more details you could fine here - http://appboard.me/docs/restapi)
     class ThrottleLimit < Error
     end
-
+    
     # MissingConfiguration is raised when we're trying to run send data to widget or dashboard that needs configuration.
     class MissingConfiguration < Error
     end

data/lib/appboard/rest_api.rb

@@ -1,32 +1,72 @@
 module Appboard
   module RestAPI
-
+  
     def default_headers
       {
         :content_type => :json,
         :accept       => :json
       }
     end
+      
+    def send_data(url, payload)
+      json = JSON.generate(payload)
+      
+      begin                                                                                                            
+        RestClient.put url, json, default_headers                             
+      rescue RestClient::Exception => e
+        message = ""
+      
+        begin    
+          message = JSON.parse(e.response.body)["message"] if e.response.body
+        rescue JSON::ParserError => pe
+          # ignore
+        end 
+        
+        raise Error::BadRequest, message if e.http_code == 400 
+        raise Error::NotFound, message if e.http_code == 404 
+        raise Error::ThrottleLimit, message if e.http_code == 503
+        raise e
+      end
+    end
+    
+    def send_setup(url, config)
+      success = false
+      json = config.get_dashboard.to_json
     
-    def put(url, payload)
-	json = JSON.generate(payload)
-                                                        
-        begin                                                                                                            
-    	    RestClient.put url, json, default_headers                             
-        rescue RestClient::Exception => e
-	    message = ""
-
-	    begin    
-	    	message = JSON.parse(e.response.body)["message"] if e.response.body
-	    rescue JSON::ParserError => pe
-                # ignore
-            end 
-
-	    raise Error::BadRequest, message if e.http_code == 400 
-	    raise Error::NotFound, message if e.http_code == 404 
-	    raise Error::ThrottleLimit, message if e.http_code == 503
-	    raise e
-        end
+      begin                                                                                                            
+        response = RestClient.put url, json, default_headers
+      
+        begin    
+          dr = JSON.parse(response.body) if response.body
+      
+          # update widgets with data in response
+          dr["widgets"].each do |rw| 
+            widget = config.get_dashboard.widget(rw["name"])
+            uid = rw["uid"]
+      
+            widget.uid(uid)
+          end
+        rescue JSON::ParserError => pe
+          raise Error::MissingConfiguration
+        end 
+      
+        success = true if response.code == 200
+      rescue RestClient::Exception => e
+        message = ""
+      
+        begin    
+          message = JSON.parse(e.response.body)["message"] if e.response.body
+        rescue JSON::ParserError => pe
+          # ignore
+        end 
+      
+        raise Error::BadRequest, message if e.http_code == 400 
+        raise Error::NotFound, message if e.http_code == 404 
+        raise Error::ThrottleLimit, message if e.http_code == 503
+        raise e
+      end
+      
+      success
     end
   end
 end

data/lib/appboard/version.rb

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

data/lib/appboard/widget.rb

@@ -1,32 +1,37 @@
 module Appboard
-    # Defines widget
-    class Widget
-	def initialize(name, &block)
-	    @name = name
-	    instance_eval(&block)
-	end
-
-	def name
-	    @name
-	end
-
-	def uid(value = nil)
-	    @uid = value unless value.nil?
-	    @uid
-	end
-	
-	def type(value = nil)
-	    @type = value unless value.nil?
-	    @type
-	end
-
-	def data(&block)
-	    @data = block if block_given?
-	    @data
-	end
-	  
-	def get_data
-	    @data.call()
-	end
-   end
+  # Defines widget
+  class Widget
+    def initialize(name, &block)
+      @name = name
+      instance_eval(&block)
+    end
+    
+    def name
+      @name
+    end
+    
+    def uid(value = nil)
+      @uid = value unless value.nil?
+      @uid
+    end
+    
+    def type(value = nil)
+      @uid = value unless value.nil?
+      @type
+    end
+    
+    def size(value = nil)
+      @size = value unless value.nil?
+      @size
+    end
+    
+    def data(&block)
+      @data = block if block_given?
+      @data
+    end
+      
+    def get_data
+      @data.call()
+    end
+  end
 end

data/lib/appboard/widgetpusher.rb

@@ -0,0 +1,64 @@
+module Appboard
+  # Widget pusher
+  class WidgetPusher
+    # Defines widget
+    class Widget
+      def initialize(name, &block)
+        @name = name
+        instance_eval(&block)
+      end
+      
+      def name
+        @name
+      end
+      
+      def uid(value = nil)
+        @uid = value unless value.nil?
+        @uid
+      end
+      
+      def data(&block)
+        @data = block if block_given?
+        @data
+      end
+        
+      def get_data
+        @data.call()
+      end
+    end
+
+    # Define API key
+    def apiKey(value = nil)                                                                                                   
+      @apiKey = value unless value.nil?                                                                                   
+      @apiKey                                                                                     
+    end         
+
+    # Define a widget. May be called inside push loop or separately
+    #
+    # widget('name') {
+    #   uid "..."
+    #
+    #   data do
+    #     # Data is here
+    #   end
+    # }
+    # 
+    def widget(widget_name)
+      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
+        raise ArgumentError, "Widget is not defined, to define new widget you must supply a block as the last argument" if widget.nil?
+      end
+    end
+
+    def get_widgets
+      @widgets
+    end
+  end
+end

data/lib/appboard.rb

@@ -1,4 +1,4 @@
-require 'uri'
+require 'uri' 
 require 'json' unless defined? ActiveSupport::JSON
 require 'restclient'
 
@@ -8,26 +8,83 @@ require 'appboard/version'
 require 'appboard/rest_api'
 require 'appboard/bootstrap'
 require 'appboard/widget'
+require 'appboard/widgetpusher'
+require 'appboard/dashboardsetup'
 require 'appboard/exceptions'
 
 module Appboard
 
   class << self
-    @@widgets = {}
+    @@dashboards = {}
 
     include Appboard::Bootstrap
     include Appboard::RestAPI
 
     # Define API key
     def apiKey(value = nil)                                                                                                   
-	@apiKey = value unless value.nil?                                                                                   
-        @apiKey                                                                                     
-    end                         
+      @apiKey = value unless value.nil?                                                                                   
+      @apiKey                                                                                     
+    end         
 
+    # Creates new or updates existing dashboard with defined widgets in block
+    #
+    # appboard.setup {
+    #   dashboard('name') {
+    #     width 5 
+    #
+    #     widget('widget 1') {
+    #       type "..."
+    #       size "..."      
+    #     }
+    #
+    #     widget('widget 2') {
+    #       # Widget configuration is here  
+    #     }
+    #   }
+    # }
+    #
+    # == Options
+    # * :apiKey => 'API key'
+    # * :logging => false
+    # * :debug => false
+    #
+    # Refer to default config below for how to set these as defaults
+    #
+    def setup(options = {}, &block)
+      config = settings.update(options)
+      
+      if block_given?
+        ds = DashboardSetup.new.instance_eval(&block) 
+        
+        apiKey = ds.apiKey || config[:apiKey]
+        url = "#{config[:url]}/#{config[:version]}/#{apiKey}/setup"
+      
+        result = send_setup url, ds
+      
+        if result && config[:debug]
+          puts "Dashboard with name '#{ds.get_dashboard.name}' has been set, and following widgets have been added:"
+      
+          ds.get_dashboard.get_widgets.each do |widget|
+            puts " * #{widget.name}, with uid '#{widget.uid}'"
+          end
+        end	
+      
+        @@dashboards[ds.get_dashboard.name] = ds if result
+      else
+        raise ArgumentError, "Block is expected as argument for Appboard.setup()"
+      end
+    end
+                
     # Push on dashboard all defined widgets in block
     #
     # appboard.push {
-    #    # Do stuff in here
+    #   widget() {
+    #     uid "..."
+    #
+    #     data {
+    #       # Data is here
+    #	    }
+    #   }
     # }
     #
     # == Options
@@ -37,9 +94,20 @@ module Appboard
     # Refer to default config below for how to set these as defaults
     #
     def push(options = {}, &block)
-      @config = settings.update(options)
-
-      self.instance_eval(&block) if block_given?
+      config = settings.update(options)
+      
+      if block_given?
+        pusher = WidgetPusher.new.instance_eval(&block)
+               
+        pusher.get_widgets.each do |widget|
+          apiKey = pusher.apiKey || config[:apiKey]
+          url = "#{config[:url]}/#{config[:version]}/#{apiKey}/data/#{widget.uid}"
+      
+          send_data url, widget.get_data
+        end
+      else
+        raise ArgumentError, "Block is expected as argument for Appboard.push()"
+      end
     end
 
     # Define a widget. May be called inside push loop or separately
@@ -47,37 +115,39 @@ module Appboard
     # widget('name') {
     #   data {
     #     # Data is here
-    #	}
+    #	  }
     # }
     # 
     def widget(widget_name)
+      config = settings
+      dashboard = nil
+      
+      @@dashboards.each do |name, db|
+        dashboard = db if db.has_widget(widget_name)
+        break if dashboard.nil?
+      end
+      
+      raise ArgumentError, "Widget '#{widget_name}' is not defined, to use this method setup dashboard with Appboard.setup()" if dashboard.nil?
+      
       if block_given?
         block = Proc.new
-        widget = register_widget(widget_name, &block)
-        send(widget)
+      
+        apiKey = dashboard.apiKey || config[:apiKey]
+        uid = dashboard.get_widget(widget_name).uid
+        url = "#{config[:url]}/#{config[:version]}/#{apiKey}/data/#{uid}"
+      
+        widget = Widget.new(widget_name, &block)
+        send_data url, widget.get_data
       else
-	widget = @@widgets[widget_name.to_s]
-
-        raise ArgumentError, "Widget is not defined, to define new widget you must supply a block as the last argument" if widget.nil?
-      end 	
+        block = Proc.new {}
+        
+        widget = Widget.new(widget_name, &block)
+        widget.uid(dashboard.get_widget(widget_name).uid)
+      end 
+      
       widget
     end
 
-    def register_widget(widget_name, &block)
-	widget = Widget.new(widget_name, &block)
-
-    	((@@widgets[widget_name.to_s] ||= []) << widget).uniq!
-	widget
-    end
-
-
-    def send(widget)  
-	url = "#{@config[:url]}/#{@config[:version]}/#{@apiKey}/data/#{widget.uid}"
-
-	put url, widget.get_data
-    end                                  
-
-
     def handle_error(e)
       log.error "#{e.class}: #{e.message}"#, :exception => e
       e.backtrace.each do |line|
@@ -92,6 +162,5 @@ module Appboard
     def log=(log)
       @@log = log
     end
-
   end
 end

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appboard
 version: !ruby/object:Gem::Version 
-  hash: 29
+  hash: 27
   prerelease: false
   segments: 
   - 1
   - 0
-  - 5
-  version: 1.0.5
+  - 6
+  version: 1.0.6
 platform: ruby
 authors: 
 - appboard.me
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-15 00:00:00 -04:00
+date: 2011-07-19 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -99,13 +99,16 @@ files:
 - examples/linechart.rb
 - examples/piechart.rb
 - examples/radialgauge.rb
+- examples/setupdashboard.rb
 - examples/singlenumner.rb
 - lib/appboard.rb
 - lib/appboard/bootstrap.rb
+- lib/appboard/dashboardsetup.rb
 - lib/appboard/exceptions.rb
 - lib/appboard/rest_api.rb
 - lib/appboard/version.rb
 - lib/appboard/widget.rb
+- lib/appboard/widgetpusher.rb
 - LICENSE.txt
 has_rdoc: true
 homepage: https://github.com/appboard/appboard