geckoboard-push 0.1.0

data/README.rdoc

@@ -0,0 +1,70 @@
+= geckoboard-push
+
+* http://github.com/kickcode/geckoboard-push
+
+== DESCRIPTION:
+
+This is a Ruby library allowing you to push updates to Geckoboard widgets.
+
+== FEATURES:
+
+Exposes a Geckoboard::Push class allowing updates for the following widget types:
+
+* number and secondary value
+* text
+* RAG
+* line chart
+* pie chart
+* geckometer
+* funnel chart
+
+== SYNOPSIS:
+
+Simply add to your Gemfile as follows:
+
+  gem 'geckoboard-push'
+
+Then run "bundle install" and once installed, you need to configure the API key for your Geckoboard account:
+
+  Geckoboard::Push.api_key = "my_api_key"
+
+Once that's done, you can push updates to widgets as so:
+
+  Geckoboard::Push.new("my_widget_key").number_and_secondary_value(100, 10)
+
+== REQUIREMENTS:
+
+geckoboard-push depends upon httparty.
+
+== INSTALL:
+
+It's best to add it to the Gemfile for your app, but if needed you can install the gem manually:
+
+  gem install geckoboard-push
+
+== CONTRIBUTORS:
+
+Elliott Draper
+
+== LICENSE:
+
+Copyright 2011 Elliott Draper <el@kickcode.com>
+
+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/geckoboard-push.rb

@@ -0,0 +1 @@
+require File.join(File.dirname(__FILE__), "geckoboard", "push")

data/lib/geckoboard/push.rb

@@ -0,0 +1,97 @@
+gem 'httparty'
+require 'httparty'
+require 'json'
+
+module Geckoboard
+  class Push
+    class << self
+      # API configuration
+      attr_accessor :api_key
+      attr_accessor :api_version
+    end
+
+    # Custom error type for handling API errors
+    class Error < Exception; end
+
+    include HTTParty
+    base_uri 'https://push.geckoboard.com'
+
+    # Initializes the push object for a specific widget
+    def initialize(widget_key)
+      @widget_key = widget_key
+    end
+
+    # Makes a call to Geckoboard to push data to the current widget
+    def push(data)
+      raise Geckoboard::Push::Error.new("Api key not configured.") if Geckoboard::Push.api_key.nil? || Geckoboard::Push.api_key.empty?
+      result = JSON.parse(self.class.post("/#{Geckoboard::Push.api_version || 'v1'}/send/#{@widget_key}", {:body => {:api_key => Geckoboard::Push.api_key, :data => data}.to_json}))
+      raise Geckoboard::Push::Error.new(result["error"]) unless result["success"]
+      result["success"]
+    end
+
+    # Value and previous value should be numeric values
+    def number_and_secondary_value(value, previous_value)
+      self.push(:item => [{:text => "", :value => value}, {:text => "", :value => previous_value}])
+    end
+
+    # Items should be an array of hashes, each hash containing:
+    # - text
+    # - type (should be either :alert, or :info, optional)
+    def text(items)
+      data = items.collect do |item|
+        type = case item[:type]
+               when :alert
+                 1
+               when :info
+                 2
+               else
+                 0
+               end
+        {:text => item[:text], :type => type}
+      end
+      self.push(:item => data)
+    end
+
+    # Red, amber and green should be values
+    def rag(red, amber, green)
+      self.push(:item => [{:value => red}, {:value => amber}, {:value => green}])
+    end
+
+    # Values should be an array of numeric values
+    # Colour, x_axis and y_axis are optional settings
+    def line(values, colour = nil, x_axis = nil, y_axis = nil)
+      self.push(:item => values, :settings => {:axisx => x_axis, :axisy => y_axis, :colour => colour})
+    end
+
+    # Items should be an array of hashes, each hash containing:
+    # - value (numeric value)
+    # - label (optional)
+    # - colour (optional)
+    def pie(items)
+      data = items.collect do |item|
+        {:value => item[:value], :label => item[:label], :colour => item[:colour]}
+      end
+      self.push(:item => data)
+    end
+
+    # Value, min and max should be numeric values
+    def geckometer(value, min, max)
+      self.push(:item => value, :min => {:value => min}, :max => {:value => max})
+    end
+
+    # Items should be an array of hashes, each hash containing:
+    # - value (numeric value)
+    # - label (optional)
+    # Reverse defaults to false, and when true flips the colours on the widget
+    # Hide percentage defaults to false, and when true hides the percentage value on the widget
+    def funnel(items, reverse = false, hide_percentage = false)
+      data = items.collect do |item|
+        {:value => item[:value], :label => item[:label]}
+      end
+      opts = {:item => data}
+      opts[:type] = "reverse" if reverse
+      opts[:percentage] = "hide" if hide_percentage
+      self.push(opts)
+    end
+  end
+end

data/test/geckoboard/push_test.rb

@@ -0,0 +1,77 @@
+require 'test/unit'
+gem 'fakeweb'
+require 'fakeweb'
+gem 'mocha'
+require 'mocha'
+require File.join(File.expand_path(File.dirname(__FILE__)), "..", "..", "lib", "geckoboard", "push")
+
+class PushTest < Test::Unit::TestCase
+  def setup
+    FakeWeb.allow_net_connect = false
+    Geckoboard::Push.api_key = "12345"
+    @push = Geckoboard::Push.new("54321")
+  end
+
+  def test_with_no_api_key
+    Geckoboard::Push.api_key = nil
+    assert_raise Geckoboard::Push::Error do
+      @push.number_and_secondary_value(100, 10)
+    end
+  end
+
+  def test_invalid_key
+    Geckoboard::Push.api_key = "invalid"
+    response = Net::HTTPOK.new("1.1", 200, "OK")
+    response.instance_variable_set(:@body, '{"success":false,"error":"Api key has wrong format. "}')
+    response.instance_variable_set(:@read, true)
+    Net::HTTP.any_instance.expects(:request).returns(response)
+    assert_raise Geckoboard::Push::Error do
+      @push.number_and_secondary_value(100, 10)
+    end
+  end
+
+  def test_number_and_secondary_value
+    expect_http_request({"api_key" => "12345", "data" => {"item" => [{"text" => "", "value" => 100}, {"text" => "", "value" => 10}]}}.to_json)
+    assert_equal true, @push.number_and_secondary_value(100, 10)
+  end
+
+  def test_text
+    expect_http_request({"api_key" => "12345", "data" => {"item" => [{"text" => "Test1", "type" => 2}, {"text" => "Test2", "type" => 1}]}}.to_json)
+    assert_equal true, @push.text([{:type => :info, :text => "Test1"}, {:type => :alert, :text => "Test2"}])
+  end
+
+  def test_rag
+    expect_http_request({"api_key" => "12345", "data" => {"item" => [{"value" => 1}, {"value" => 2}, {"value" => 3}]}}.to_json)
+    assert_equal true, @push.rag(1,2,3)
+  end
+
+  def test_line
+    expect_http_request({"api_key" => "12345", "data" => {"item" => [1,2,3], "settings" => {"axisx" => "x axis", "axisy" => "y axis", "colour" => "ff9900"}}}.to_json)
+    assert_equal true, @push.line([1,2,3], "ff9900", "x axis", "y axis")
+  end
+
+  def test_pie
+    expect_http_request({"api_key" => "12345", "data" => {"item" => [{"value" => 1, "label" => "Test1", "colour" => "ff9900"}, {"value" => 2, "label" => "Test2", "colour" => "ff0099"}]}}.to_json)
+    assert_equal true, @push.pie([{:value => 1, :label => "Test1", :colour => "ff9900"}, {:value => 2, :label => "Test2", :colour => "ff0099"}])
+  end
+
+  def test_geckometer
+    expect_http_request({"api_key" => "12345", "data" => {"item" => 100, "min" => {"value" => 50}, "max" => {"value" => 200}}}.to_json)
+    assert_equal true, @push.geckometer(100, 50, 200)
+  end
+
+  def test_funnel
+    expect_http_request({"api_key" => "12345", "data" => {"item" => [{"value" => 5, "label" => "Test1"}, {"value" => 10, "label" => "Test2"}], "type" => "reverse", "percentage" => "hide"}}.to_json)
+    assert_equal true, @push.funnel([{:label => "Test1", :value => 5}, {:label => "Test2", :value => 10}], true, true)
+  end
+
+  def expect_http_request(json)
+    response = Net::HTTPOK.new("1.1", 200, "OK")
+    response.instance_variable_set(:@body, '{"success":true}')
+    response.instance_variable_set(:@read, true)
+    Net::HTTP.any_instance.expects(:request).with do |request|
+      assert_equal json, request.body
+      request.path == "/v1/send/54321" && request.method == "POST" && request.body == json
+    end.returns(response)
+  end
+end

metadata

@@ -0,0 +1,112 @@
+--- !ruby/object:Gem::Specification 
+name: geckoboard-push
+version: !ruby/object:Gem::Version 
+  prerelease: false
+  segments: 
+  - 0
+  - 1
+  - 0
+  version: 0.1.0
+platform: ruby
+authors: 
+- Elliott Draper
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-12-08 00:00:00 +00:00
+default_executable: 
+dependencies: 
+- !ruby/object:Gem::Dependency 
+  name: httparty
+  prerelease: false
+  requirement: &id001 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 8
+        - 1
+        version: 0.8.1
+  type: :runtime
+  version_requirements: *id001
+- !ruby/object:Gem::Dependency 
+  name: fakeweb
+  prerelease: false
+  requirement: &id002 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 1
+        - 3
+        - 0
+        version: 1.3.0
+  type: :development
+  version_requirements: *id002
+- !ruby/object:Gem::Dependency 
+  name: mocha
+  prerelease: false
+  requirement: &id003 !ruby/object:Gem::Requirement 
+    none: false
+    requirements: 
+    - - ~>
+      - !ruby/object:Gem::Version 
+        segments: 
+        - 0
+        - 10
+        - 0
+        version: 0.10.0
+  type: :development
+  version_requirements: *id003
+description: 
+email: el@kickcode.com
+executables: []
+
+extensions: []
+
+extra_rdoc_files: 
+- README.rdoc
+files: 
+- README.rdoc
+- test/geckoboard/push_test.rb
+- lib/geckoboard/push.rb
+- lib/geckoboard-push.rb
+has_rdoc: true
+homepage: http://docs.geckoboard.com/api/push.html
+licenses: []
+
+post_install_message: 
+rdoc_options: 
+- --main
+- README.rdoc
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      segments: 
+      - 0
+      version: "0"
+requirements: []
+
+rubyforge_project: 
+rubygems_version: 1.3.7
+signing_key: 
+specification_version: 3
+summary: Ruby library for pushing widget updates to Geckoboard.
+test_files: []
+