gecko 0.0.1

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+.project
+.idea
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+test.rb

data/.rspec

@@ -0,0 +1 @@
+--color

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.8.7"
+  - "1.9.2"
+  - "1.9.3"
+script: bundle exec rspec spec

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in gecko.gemspec
+gemspec

data/LICENSE

@@ -0,0 +1,22 @@
+Copyright (c) 2012 Adam Williams
+
+MIT License
+
+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.md

@@ -0,0 +1,91 @@
+# Gecko [![Build Status](https://secure.travis-ci.org/awilliams/Gecko.png?branch=master)](https://travis-ci.org/awilliams/Gecko)
+
+Ruby gem for working with [Geckoboard's Push API](http://docs.geckoboard.com/custom-widgets/). 
+
+Features:
+* Uses Faraday gem for HTTP. You can easily swapout adapters
+* Designed for use with non-blocking requests (EventMachine)
+* Allows for multiple widget keys per widget object. Useful for updating widgets on multiple dashboards at once
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'gecko'
+
+Recommended for use with Eventmachine. Add these to your Gemfile
+
+    gem 'eventmachine'
+    gem 'em-http-request'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install gecko
+
+## Usage
+### Configuration
+```ruby
+# Configuration
+Gecko.config do |c|
+  # Your Geckoboard API key
+  c.api_key = '123456'
+  # block invoked by Faraday#new
+  # Set your http adapter here, otherwise Faraday.default_adapter is used
+  c.http_builder { |builder|
+    # use EventMachine Http adapter for non-blocking updates
+    builder.adapter :em_http
+  }
+end
+```
+
+### Update Widgets
+```ruby
+# Update widget
+text_widget = Gecko::Widget::Text.new("1234-widget-key")
+text_widget.add("some info")
+text_widget.add("this is the text", :alert)
+text_widget.update { |success, result, widget_key|
+  puts success ? "Updated" : "Error updating #{widget_key}: #{result.error}"
+}
+
+# Update widget using #config!
+text_widget = Gecko::Widget::Text.new("1234-widget-key").on_update do |success, result, widget_key|
+  # this block is executed on every update
+  puts success ? "Updated" : "Error updating #{widget_key}: #{result.error}"
+end
+text_widget.config! do |widget|
+  text_widget.add("some info")
+  text_widget.add("this is the text", :alert)
+end
+
+# Update multiple widgets at once - useful for same widget on various dashboards
+text_widget = Gecko::Widget::Text.new("1234-widget-key", "1234-second-widget-key").on_update do |success, result, widget_key|
+  # this block is executed TWICE every update since there are two widgets being updated
+  puts success ? "Updated" : "Error updating #{widget_key}: #{result.error}"
+end
+text_widget.config! do |widget|
+  text_widget.add("some info")
+  text_widget.add("this is the text", :alert)
+end
+```
+
+### Delete reset widget values
+```ruby
+widget = Gecko::Widget::Text.new("1234-abcdefg")
+# reset clear out previous items
+widget.reset.config! do |w|
+  widget.add("text alert", :alert)
+end
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Added some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,2 @@
+#!/usr/bin/env rake
+require "bundler/gem_tasks"

data/gecko.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/gecko/version', __FILE__)
+
+Gem::Specification.new do |gem|
+  gem.authors       = ["Adam Williams"]
+  gem.email         = ["pwnfactory@gmail.com"]
+  gem.description   = %q{Ruby library for updating Geckoboard Custom Widgets. Uses Faraday for HTTP requests and designed to work with the async API}
+  gem.summary       = %q{Ruby library for updating Geckoboard Custom Widgets}
+  gem.homepage      = "https://github.com/awilliams/Gecko"
+
+  gem.files         = `git ls-files`.split($\)
+  gem.executables   = []
+  gem.test_files    = gem.files.grep(%r{^(test|spec|features)/})
+  gem.name          = "gecko"
+  gem.require_paths = ["lib"]
+  gem.version       = Gecko::VERSION
+
+  gem.add_dependency "faraday", "~> 0.8.4"
+  gem.add_dependency "faraday_middleware-multi_json", "~> 0.0.4"
+  gem.add_dependency "multi_json"
+
+  gem.add_development_dependency "pry"
+  gem.add_development_dependency "awesome_print"
+  gem.add_development_dependency "yajl-ruby", "~> 1.1.0"
+  gem.add_development_dependency "eventmachine", "~> 1.0.0"
+  gem.add_development_dependency "em-http-request", "~> 1.0.0"
+
+  gem.add_development_dependency 'rspec'
+end

data/lib/gecko.rb

@@ -0,0 +1,22 @@
+module Gecko
+  class << self
+    def config
+      yield self.configurator if block_given?
+      self.configurator
+    end
+
+    protected
+
+    def configurator
+      @configurator ||= Configurator.new
+    end
+  end
+end
+
+require "gecko/version" unless Gecko.const_defined?(:VERSION)
+require "gecko/configurator"
+require "gecko/http"
+require "gecko/widget"
+
+Gecko.config.api_push_url = 'https://push.geckoboard.com/v1/send/:widget_key'
+Gecko.config.http_user_agent = "Gecko Ruby Gem #{Gecko::VERSION}"

data/lib/gecko/configurator.rb

@@ -0,0 +1,11 @@
+module Gecko
+  class Configurator
+    attr_accessor :api_key, :api_push_url, :http_user_agent
+    attr_reader :connection_builder
+
+    # Block invoked with Faraday builder when creating a connection
+    def http_builder(&block)
+      @connection_builder = block || nil
+    end
+  end
+end

data/lib/gecko/graph/funnel.rb

@@ -0,0 +1,67 @@
+module Gecko
+  class Widget
+    class Funnel < Widget
+      include Enumerable
+
+      Item = Struct.new(:value, :label)
+
+      attr_reader :reverse
+
+      def initialize(*args, &block)
+        super
+        self.standard
+        self.show_percentage
+        @items = []
+      end
+
+      def reset
+        @items.clear
+        self
+      end
+
+      def standard
+        @reverse = :standard
+      end
+
+      def reverse
+        @reverse = :reverse
+      end
+
+      def show_percentage
+        @percentage = :show
+      end
+
+      def hide_percentage
+        @percentage = :hide
+      end
+
+      def each(&block)
+        @items.each(&block)
+      end
+
+      def add(*args)
+        @items.push(Item.new(*args))
+      end
+
+      def [](index)
+        @items[index]
+      end
+
+      def []=(index, *args)
+        @items[index] = Item.new(*args)
+      end
+
+      def delete(index)
+        @items.delete_at(index)
+      end
+
+      def data_payload
+        {
+          :type => @reverse,
+          :percentage => @percentage,
+          :item => self.map{|item| {:value => item.value, :label => item.label} }
+        }
+      end
+    end
+  end
+end

data/lib/gecko/graph/geckometer.rb

@@ -0,0 +1,39 @@
+module Gecko
+  class Widget
+    class Geckometer < Widget
+      EndPoint = Struct.new(:value, :text)
+
+      attr_accessor :value
+      attr_reader :min, :max
+      def initialize(*args, &block)
+        super
+        @min, @max = EndPoint.new, EndPoint.new
+      end
+
+      def min_value=(value)
+        self.min.value = value
+      end
+
+      def min_text=(text)
+        self.min.text = text
+      end
+
+      def max_value=(value)
+        self.max.value = value
+      end
+
+      def max_text=(text)
+        self.max.text = text
+      end
+
+      def data_payload
+        {
+          :item => self.value,
+          :min => {:value => self.min.value, :text => self.min.text},
+          :max => {:value => self.max.value, :text => self.max.text}
+        }
+      end
+
+    end
+  end
+end

data/lib/gecko/graph/line.rb

@@ -0,0 +1,64 @@
+module Gecko
+  class Widget
+    class Line < Widget
+      include Enumerable
+
+      attr_accessor :color, :x_axis, :y_axis
+
+      def initialize(*args, &block)
+        super
+        @x_axis = []
+        @y_axis = []
+        @items = []
+      end
+
+      def each(&block)
+        @items.each(&block)
+      end
+
+      def add(*args)
+        @items.push(*args)
+      end
+
+      def reset
+        @items.clear
+        self
+      end
+
+      def add_x_axis(*args)
+        @x_axis.push(*args)
+      end
+
+      def add_y_axis(*args)
+        @y_axis.push(*args)
+      end
+
+      def [](index)
+        @items[index]
+      end
+
+      def []=(index, *args)
+        @items[index] = *args
+      end
+
+      def items=(array)
+        @items = array
+      end
+
+      def delete(index)
+        @items.delete_at(index)
+      end
+
+      def data_payload
+        {
+          :item => self.to_a,
+          :settings => {
+            :axisx => self.x_axis,
+            :axisy => self.y_axis,
+            :colour => self.color
+          }
+        }
+      end
+    end
+  end
+end

data/lib/gecko/graph/pie.rb

@@ -0,0 +1,49 @@
+module Gecko
+  class Widget
+    class Pie < Widget
+      include Enumerable
+
+      Item = Struct.new(:value, :label, :color)
+
+      def initialize(*args, &block)
+        super
+        @items = []
+      end
+
+      def each(&block)
+        @items.each(&block)
+      end
+
+      def reset
+        @items.clear
+        self
+      end
+
+      def add(*args)
+        @items.push(Item.new(*args))
+      end
+
+      def [](index)
+        @items[index]
+      end
+
+      def []=(index, *args)
+        @items[index] = Item.new(*args)
+      end
+
+      def delete(index)
+        @items.delete_at(index)
+      end
+
+      def data_payload
+        {:item => self.map{|item| self.item_payload(item) }}
+      end
+
+      def item_payload(item)
+        h = {:value => item.value, :label => item.label}
+        h.merge!({:colour => item.color}) if item.color
+        h
+      end
+    end
+  end
+end