ducksboard 0.1.0

data/.gitignore

@@ -0,0 +1 @@
+Gemfile.lock

data/Gemfile

@@ -0,0 +1,2 @@
+source :rubygems
+gem 'httparty'

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2011 Joseph Hsu
+
+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/README.mdown

@@ -0,0 +1,52 @@
+## Ducksboard API Ruby wrapper
+
+### Configuration
+
+API Key can be set in the environment
+
+    export DUCKSBOARD_API_KEY='YOURKEY'
+
+or in an initializer
+
+    Ducksboard.api_key = 'YOURKEY'
+
+### Counter
+
+    widget = Ducksbaord::Counter.new(1234) # Widget numeric id
+    widget.value = 10
+    widget.save
+
+### Image
+
+    widget = Ducksboard::Image.new(1235)
+    widget.source = "https://dashboard.ducksboard.com/static/accounts/img/logo_small.png"
+    # or
+    widget.source = "~/Pictures/logo.png"
+    widget.caption = "Ducksboard logo!"
+    widget.timestamp = 1310649204
+    widget.save
+
+### Gauge
+
+    widget = DUcksboard::GRaph.new(1235)
+    widget.value = 0.93
+    widget.save
+
+### Graph
+
+    # remember that the graph widgets need atleast 2 points before it displays anything
+    widget = Ducksboard::Graph.new(1236)
+    widget.timestamp = Time.now.to_i
+    widget.value = 198
+    widget.save
+
+### Timeline
+
+    widget = Ducksbaord::Timeline.new(1237)
+    widget.title = "A Title"
+    widget.image = "http://url.to.io/some_image.gif"
+    # or
+    widget.image = :edited
+    # any of the following as a string or symbol: orange, red, green, created, edited or deleted
+    widget.content = "text content"
+    widget.link = "http://google.com"

data/ducksboard.gemspec

@@ -0,0 +1,29 @@
+Gem::Specification.new do |s|
+  s.name        = 'ducksboard'
+  s.version     = '0.1.0'
+  s.summary     = "API wrapper for ducksboard.com dashboard"
+  s.description = "Ruby API wrapper for ducksboard realtime dashboard using HTTParty"
+  s.authors     = ["Joseph Hsu"]
+  s.email       = 'jhsu.x1@gmail.com'
+  s.files       = `git ls-files`.split("\n")
+  s.homepage    = 'http://github.com/jhsu/ducksboard'
+  s.license     = 'MIT'
+  s.required_ruby_version = '>= 1.8.7'
+
+  s.add_runtime_dependency 'httparty', '~> 0.8', '>= 0.8.1'
+
+  s.post_install_message = <<-DESC
+  Quack! (in real-time)"
+
+  ===
+
+  Don't forget to set your ENV variable for DUCKSBOARD_API_KEY
+
+    export DUCKSBOARD_API_KEY='YOURKEY'
+
+  or set it in your script
+
+    Ducksboard.api_key = 'YOURKEY'
+DESC
+
+end

data/lib/ducksboard.rb

@@ -0,0 +1,13 @@
+require 'httparty'
+
+module Ducksboard
+  class << self ; attr_accessor :api_key end
+  @api_key = ENV['DUCKSBOARD_API_KEY']
+end
+
+require 'ducksboard/widget'
+require 'ducksboard/counter'
+require 'ducksboard/gauge'
+require 'ducksboard/graph'
+require 'ducksboard/image'
+require 'ducksboard/timeline'

data/lib/ducksboard/counter.rb

@@ -0,0 +1,4 @@
+module Ducksboard
+  class Counter < Widget
+  end
+end

data/lib/ducksboard/gauge.rb

@@ -0,0 +1,4 @@
+module Ducksboard
+  class Gauge < Widget
+  end
+end

data/lib/ducksboard/graph.rb

@@ -0,0 +1,7 @@
+module Ducksboard
+  class Graph < Widget
+    def valid?
+      @data[:timestamp] && @data[:value]
+    end
+  end
+end

data/lib/ducksboard/image.rb

@@ -0,0 +1,42 @@
+require 'base64'
+require 'json'
+module Ducksboard
+  class Image < Widget
+
+    def initialize(*args)
+      super
+      @data[:value] ||={}
+    end
+
+    def source
+      @data[:value][:source]
+    end
+
+    def source=(image_location)
+      source_value = if image_location =~ /^http/
+        image_location
+      else
+        'data:image/png;base64,' + 
+          Base64.encode64(File.read(File.expand_path(image_location)))
+      end
+      @data[:value][:source] = source_value
+    end
+
+    def caption
+      @data[:value][:caption]
+    end
+
+    def caption=(text=nil)
+      @data[:value][:caption] = caption.to_s
+    end
+
+    def timestamp
+      @data[:timestamp]
+    end
+
+    def timestamp=(time)
+      @data[:timestamp] = time
+    end
+
+  end
+end

data/lib/ducksboard/timeline.rb

@@ -0,0 +1,38 @@
+module Ducksboard
+  class Timeline < Widget
+
+    ICONS = {
+      :orange  => "https://app.ducksboard.com/static/img/timeline/orange.gif",
+      :red     => "https://app.ducksboard.com/static/img/timeline/red.gif",
+      :green   => "https://app.ducksboard.com/static/img/timeline/green.gif",
+      :created => "https://app.ducksboard.com/static/img/timeline/created.png",
+      :edited  => "https://app.ducksboard.com/static/img/timeline/edited.png",
+      :deleted => "https://app.ducksboard.com/static/img/timeline/deleted.png"
+    }
+
+    def title; @data[:title] end
+    def image; @data[:image] end
+    def content; @data[:image] end
+    def link; @data[:image] end
+
+    def title=(text)
+      @data[:title] = text
+    end
+
+    def image=(url)
+      @data[:image] = if url =~ /^http/
+        url
+      else
+        ICONS[url.to_sym]
+      end
+    end
+
+    def content=(text)
+      @data[:content] = text
+    end
+
+    def link=(url)
+      @data[:link] = url
+    end
+  end
+end

data/lib/ducksboard/widget.rb

@@ -0,0 +1,48 @@
+require 'json'
+module Ducksboard
+  class Widget
+    include ::HTTParty
+    base_uri "https://push.ducksboard.com/values"
+    basic_auth Ducksboard.api_key, 'ducksboard-gem'
+
+    attr_accessor :id, :data, :type
+
+    def initialize(id, data={})
+      @id = id
+      @data = data
+    end
+
+    def value
+      @data[:value]
+    end
+
+    def value=(val)
+      @data[:value] = val
+    end
+
+    def timestamp
+      @data[:timestamp]
+    end
+
+    def timestamp=(time)
+      @data[:timestamp] = time
+    end
+
+    def update(data=nil)
+      @data = data if data
+      self.class.post('/' + id.to_s, :body => @data.to_json)
+    end
+
+    def save
+      if valid?
+        update.code.to_i == 200
+      else
+        raise "Invalid Data: #{@data.inspect}"
+      end
+    end
+
+    def valid?
+      true
+    end
+  end
+end

metadata

@@ -0,0 +1,73 @@
+--- !ruby/object:Gem::Specification
+name: ducksboard
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+  prerelease: 
+platform: ruby
+authors:
+- Joseph Hsu
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2011-11-01 00:00:00.000000000Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: httparty
+  requirement: &70319378162520 !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ~>
+      - !ruby/object:Gem::Version
+        version: '0.8'
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: 0.8.1
+  type: :runtime
+  prerelease: false
+  version_requirements: *70319378162520
+description: Ruby API wrapper for ducksboard realtime dashboard using HTTParty
+email: jhsu.x1@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- Gemfile
+- LICENSE
+- README.mdown
+- ducksboard.gemspec
+- lib/ducksboard.rb
+- lib/ducksboard/counter.rb
+- lib/ducksboard/gauge.rb
+- lib/ducksboard/graph.rb
+- lib/ducksboard/image.rb
+- lib/ducksboard/timeline.rb
+- lib/ducksboard/widget.rb
+homepage: http://github.com/jhsu/ducksboard
+licenses:
+- MIT
+post_install_message: ! "  Quack! (in real-time)\"\n\n  ===\n\n  Don't forget to set
+  your ENV variable for DUCKSBOARD_API_KEY\n\n    export DUCKSBOARD_API_KEY='YOURKEY'\n\n
+  \ or set it in your script\n\n    Ducksboard.api_key = 'YOURKEY'\n"
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: 1.8.7
+required_rubygems_version: !ruby/object:Gem::Requirement
+  none: false
+  requirements:
+  - - ! '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 1.8.10
+signing_key: 
+specification_version: 3
+summary: API wrapper for ducksboard.com dashboard
+test_files: []