appboard 1.0.0

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2011 appboard.me
+
+Permission is hereby granted, free of charge, to any person obtaining
+a copy of this software and associated documentation files (the
+"Software"), to deal in the Software without restriction, including
+without limitation the rights to use, copy, modify, merge, publish,
+distribute, sublicense, and/or sell copies of the Software, and to
+permit persons to whom the Software is furnished to do so, subject to
+the following conditions:
+
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
+LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
+OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
+WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

data/lib/appboard/bootstrap.rb

@@ -0,0 +1,22 @@
+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
+end

data/lib/appboard/rest_api.rb

@@ -0,0 +1,65 @@
+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
+end

data/lib/appboard/version.rb

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

data/lib/appboard/widget.rb

@@ -0,0 +1,32 @@
+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
+end

data/lib/appboard.rb

@@ -0,0 +1,107 @@
+require 'uri'
+require 'json' unless defined? ActiveSupport::JSON
+require 'restclient'
+
+$:.unshift File.dirname(__FILE__)
+
+require 'appboard/version'
+require 'appboard/rest_api'
+require 'appboard/bootstrap'
+require 'appboard/widget'
+
+module Appboard
+
+  class << self
+    @@widgets = {}
+
+    include Appboard::Bootstrap
+    include Appboard::RestAPI
+
+    # Define API key
+    def apiKey(value = nil)                                                                                                   
+	@apiKey = value unless value.nil?                                                                                   
+        @apiKey                                                                                     
+    end                         
+
+    # Start the appboard loop
+    #
+    # appboard.start {
+    #    # Do stuff in here
+    # }
+    #
+    # == Options
+    # * :apiKey => 'API key'
+    # * :logging => false
+    #
+    # Refer to default config below for how to set these as defaults
+    #
+    def start(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
+    #
+    # widget('name') {
+    #   data {
+    #     # Data is here
+    #	}
+    # }
+    # 
+    def widget(widget_name)
+      if block_given?
+        block = Proc.new
+        widget = register_widget(widget_name, &block)
+        send(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 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}/#{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                                  
+
+
+
+
+    def handle_error(e)
+      log.error "#{e.class}: #{e.message}"#, :exception => e
+      e.backtrace.each do |line|
+        log.error line
+      end
+    end
+    	 
+    def log
+      @@log ||= Logger.new($stdout)
+    end
+
+    def log=(log)
+      @@log = log
+    end
+
+  end
+end

data/lib/test.rb

@@ -0,0 +1,19 @@
+require 'rubygems'
+require './appboard'
+
+Appboard.start {
+    apiKey 'wOUpOJeOozcgPdZa'
+
+    widget('test') {
+	uid "weXtrkUwSeZGvcRK"
+	
+	data do 
+	    {
+		:current => 120
+	    }
+	end
+    }
+}
+
+
+Appboard.widget('test')

metadata

@@ -0,0 +1,135 @@
+--- !ruby/object:Gem::Specification 
+name: appboard
+version: !ruby/object:Gem::Version 
+  hash: 23
+  prerelease: false
+  segments: 
+  - 1
+  - 0
+  - 0
+  version: 1.0.0
+platform: ruby
+authors: 
+- appboard.me
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-06-24 00:00:00 -04:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rake
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - "="
+      - !ruby/object:Gem::Version 
+        hash: 49
+        segments: 
+        - 0
+        - 8
+        - 7
+        version: 0.8.7
+  requirement: *id001
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: git
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 21
+        segments: 
+        - 1
+        - 2
+        - 5
+        version: 1.2.5
+  requirement: *id002
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: bundler
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        hash: 15
+        segments: 
+        - 1
+        - 0
+        version: "1.0"
+  requirement: *id003
+  type: :runtime
+- !ruby/object:Gem::Dependency 
+  prerelease: false
+  name: rest-client
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ">="
+      - !ruby/object:Gem::Version 
+        hash: 3
+        segments: 
+        - 0
+        version: "0"
+  requirement: *id004
+  type: :development
+description: Simple and opinionated interface on top of RESTful HTTP API for pushing your data to appboard.me
+email: eugene@appboard.me
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- LICENSE.txt
+- README
+files: 
+- lib/appboard.rb
+- lib/appboard/bootstrap.rb
+- lib/appboard/rest_api.rb
+- lib/appboard/version.rb
+- lib/appboard/widget.rb
+- lib/test.rb
+- LICENSE.txt
+- README
+has_rdoc: true
+homepage: https://github.com/appboard/appboard
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      hash: 3
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+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
+test_files: []
+