appboard 1.0.4 → 1.0.5

data/README.md

@@ -45,9 +45,9 @@ or you could define API key in call block:
         widget('some name here') {
 		    uid "abcd1234"
 
-		    data do {
+		    data do 
 			    # Data is here		
-		    }
+		    end
     	}
     }
 
@@ -74,14 +74,14 @@ There is several options how you could use API:
     require 'rubygems'
     require 'appboard'
     
-    Appboard.settings = { :apiKey => "abcd1234" } 
+    Appboard.settings = { :apiKey => "zxcv1234" } 
 
     widget = Appboard.widget('some name here') {
 	    uid "abcd1234"
 
-	    data do {
+	    data do 
 		    # Data is here		
-	    }
+	    end
     }
 
     response = widget.push    			# push data to Dashboard on appboard.me
@@ -96,21 +96,21 @@ There is several options how you could use API:
     require 'appboard'
 
     Appboard.push {
-        apiKey "abcd1234"
+        apiKey "zxcv1234"
     
         widget('widget1') {
 		    uid "abcd1234"
 
-		    data do {
+		    data do
 			    # Data is here		
-		    }
+		    end
     	}
         widget('widget2') {
-		    uid "abcd4321"
+		    uid "poiu4321"
 
-		    data do {
+		    data do
 			    # Data is here		
-		    }
+		    end
     	}
     }
 

data/lib/appboard/exceptions.rb

@@ -0,0 +1,25 @@
+module Appboard
+
+  # Base Error class which all custom appboard exceptions inherit from.
+  # 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
+  end
+
+end

data/lib/appboard/rest_api.rb

@@ -1,65 +1,32 @@
-module Appboard
-  module RestAPI
-
-    def default_headers
-      {
-        :content_type => :json,
-        :accept       => :json
-      }
-    end
-
-    def get(uri, options = {})
-      begin
-        parse_response(RestClient.get(uri, default_headers), options.dup)
-      rescue => e
-        if $DEBUG
-          raise "Error while sending a GET request #{uri}\n: #{e}"
-        else
-          raise e
-        end
-      end
-    end
-
-    def put(uri, doc = nil, options = {})
-      opts = options.dup
-      payload = payload_from_doc(doc, opts)
-      begin
-        parse_response(RestClient.put(uri, payload, default_headers.merge(opts)), opts)
-      rescue Exception => e
-        if $DEBUG
-          raise "Error while sending a PUT request #{uri}\npayload: #{payload.inspect}\n#{e}"
-        else
-          raise e
-        end
-      end
-    end
-
-    def post(uri, doc = nil, options = {})
-      opts = options.dup
-      payload = payload_from_doc(doc, opts)
-      begin
-        parse_response(RestClient.post(uri, payload, default_headers.merge(opts)), opts)
-      rescue Exception => e
-        if $DEBUG
-          raise "Error while sending a POST request #{uri}\npayload: #{payload.inspect}\n#{e}"
-        else
-          raise e
-        end
-      end
-    end
-
-    protected
-
-    # Check if the provided doc is nil or special IO device or temp file. If not, 
-    # encode it into a string.
-    def payload_from_doc(doc, opts = {})
-      (opts.delete(:raw) || doc.nil? || doc.is_a?(IO) || doc.is_a?(Tempfile)) ? doc : MultiJson.encode(doc)
-    end
-
-    # Parse the response provided.
-    def parse_response(result, opts = {})
-      opts.delete(:raw) ? result : MultiJson.decode(result, opts.update(:max_nesting => false))
-    end
-
-  end
+module Appboard
+  module RestAPI
+
+    def default_headers
+      {
+        :content_type => :json,
+        :accept       => :json
+      }
+    end
+    
+    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
+    end
+  end
 end

data/lib/appboard/version.rb

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

data/lib/appboard.rb

@@ -8,6 +8,7 @@ require 'appboard/version'
 require 'appboard/rest_api'
 require 'appboard/bootstrap'
 require 'appboard/widget'
+require 'appboard/exceptions'
 
 module Appboard
 
@@ -72,20 +73,9 @@ module Appboard
 
     def send(widget)  
 	url = "#{@config[:url]}/#{@config[:version]}/#{@apiKey}/data/#{widget.uid}"
-	json = JSON.generate(widget.get_data)
-	
-	#put url, json
-	
-                                                            
-        begin                                                                                                               
-    	    response = RestClient.put url, json, {:content_type => :json, :accept => :json}                                   
-            puts response                                                                                                     
-        rescue => e
-            abort "Failed to POST: #{e.message}"                                                                      
-        end
-    end                                  
-
 
+	put url, widget.get_data
+    end                                  
 
 
     def handle_error(e)

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification 
 name: appboard
 version: !ruby/object:Gem::Version 
-  hash: 31
+  hash: 29
   prerelease: false
   segments: 
   - 1
   - 0
-  - 4
-  version: 1.0.4
+  - 5
+  version: 1.0.5
 platform: ruby
 authors: 
 - appboard.me
@@ -15,7 +15,7 @@ autorequire:
 bindir: bin
 cert_chain: []
 
-date: 2011-07-13 00:00:00 -04:00
+date: 2011-07-15 00:00:00 -04:00
 default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
@@ -102,6 +102,7 @@ files:
 - examples/singlenumner.rb
 - lib/appboard.rb
 - lib/appboard/bootstrap.rb
+- lib/appboard/exceptions.rb
 - lib/appboard/rest_api.rb
 - lib/appboard/version.rb
 - lib/appboard/widget.rb