gecko-pusher 0.0.3 → 0.0.4

data/README.md

@@ -81,6 +81,39 @@ Creating a channel returns an object that makes it easy to send messages to Geck
     channel.push(10, "Today", 20, "Yesterday")            // push number and secondary stat with descriptions
     channel.push(10, 20, absolute: true, type: reverse)   // push with options
 
+### Maps
+
+For basic, uncoloured, uniformly sized points, the API is dirt simple:
+
+    channel.push("192.168.0.1")                             // Push IP address
+    channel.push([-51.424, 0.02323])                        // Push Lat/Long
+    channel.push({city_name: "London", country_code: "GB"}) // Push address
+    channel.push("host.dsci.it")                            // Push hostname
+    channel.push("192.168.0.1", [-51.424, 0.02323]...)      // Push any combination of above as multiple args
+
+If you want to embellish points with additional styling information, you have to do a bit more work, with each element
+an array, the first element being as above, the second element being the point options. You can mix/match the two ways - the API
+will figure it out:
+
+    channel.push(["192.168.0.1", {colour: "FF0000", size: 3}])            // Push IP address
+    channel.push([[-51.424, 0.02323], {size: 8}])                         // Push Lat/Long
+    channel.push([{city_name: "London", country_code: "GB"}, {...}])      // Push address
+    channel.push(["host.dsci.it", {colour: "00FF00"}])                    // Push hostname
+    channel.push(["192.168.0.1", {colour: "FF0000", size: 3}],
+                 [[-51.424, 0.02323], {size: 8}])                         // Push any combination of above as multiple args
+
+    channel.push("192.168.0.1",
+                 [{city_name: "London", country_code: "GB"}, {...}],
+                 ["host.dsci.it", {colour: "00FF00"}],
+                 [-51.424, 0.02323],
+                 ...)
+
+### Gecko Meter
+
+    channel.push(10, 0, 20)                                   // Push basic value, min, max
+    channel.push(10, 0, "Min", 20, "Max")                     // Push values with descriptions
+    channel.push(10, 0, "Min", 20, "Max", type: "reverse")    // Push values, descriptions and options
+
 ## Contributing
 
 1. Fork it

data/lib/gecko-pusher/channel/base.rb

@@ -22,6 +22,10 @@ module Gecko
             end
           end
 
+          def extract_options(args)
+            args.last.is_a?(Hash) ? args.pop : {}
+          end
+
       end
     end
   end

data/lib/gecko-pusher/channel/gecko_meter.rb

@@ -0,0 +1,47 @@
+module Gecko
+  module Pusher
+    module Channel
+      class GeckoMeter < Base
+
+        def push(*args)
+          options = extract_options(args)
+          data = extract_values(args)
+          data[:type] = options[:type] unless options[:type].nil?
+          _push(data)
+        end
+
+        protected
+
+          def extract_values(args)
+            if just_values?(args)
+              {
+                item: args[0], 
+                min: { value: args[1] }, 
+                max: { value: args[2]}
+              }
+            elsif values_and_descriptions?(args)
+              {
+                item: args[0], 
+                min: { value: args[1], text: args[2] }, 
+                max: { value: args[3], text: args[4] }
+              }
+            else
+              raise ArgumentError
+            end
+          end
+
+          def just_values?(values)
+            values.length == 3 &&
+              values.all? {|a| a.is_a?(Integer)}
+          end
+
+          def values_and_descriptions?(values)
+            values.length == 5 &&
+              values[0].is_a?(Integer) &&
+              values[1].is_a?(Integer) && values[2].is_a?(String) &&
+              values[3].is_a?(Integer) && values[4].is_a?(String)
+          end
+      end
+    end
+  end
+end

data/lib/gecko-pusher/channel/map.rb

@@ -0,0 +1,60 @@
+module Gecko
+  module Pusher
+    module Channel
+      class Map < Base
+
+        def push(*args)
+          data = args.map {|arg|
+            point_data, options = if arg.is_a?(Array) &&
+                                    arg.length == 2 &&
+                                    arg.last.is_a?(Hash)
+                                    [arg.first, check_options(arg.last)]
+                                  else
+                                    [arg, {}]
+                                  end
+
+            if ip_address?(point_data)
+              {ip: point_data}.merge(options)
+            elsif lat_long?(point_data)
+              {latitude: point_data[0].to_s, longitude: point_data[1].to_s}.merge(options)
+            elsif address?(point_data)
+              {city: point_data}.merge(options)
+            elsif hostname?(point_data)
+              {host: point_data}.merge(options)
+            end
+          }
+
+          _push({points: { point: data}})
+        end
+
+        protected
+
+          def check_options(options)
+            raise ArgumentError unless options.keys.all? {|k|
+              [:color, :size, :cssClass].include?(k)
+            }
+            options
+          end
+
+          def ip_address?(point_data)
+            point_data.is_a?(String) &&
+              point_data =~ /\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/
+          end
+
+          def lat_long?(point_data)
+            point_data.length == 2 &&
+              point_data.all? { |p| p.is_a? Float }
+          end
+
+          def address?(point_data)
+            point_data.is_a?(Hash) &&
+              point_data.keys.all? {|k| [:city_name, :region_code, :country_code].include?(k)}
+          end
+
+          def hostname?(point_data)
+            point_data.is_a?(String)
+          end
+      end
+    end
+  end
+end

data/lib/gecko-pusher/channel/number.rb

@@ -33,10 +33,6 @@ module Gecko
               args[0].is_a?(Integer) && args[1].is_a?(String) &&
               args[2].is_a?(Integer) && args[3].is_a?(String)
           end
-
-          def extract_options(args)
-            args.last.is_a?(Hash) ? args.pop : {}
-          end
       end
     end
   end

data/lib/gecko-pusher/channel/rag.rb

@@ -14,7 +14,7 @@ module Gecko
           _push(data)
         end
 
-        private
+        protected
           
           def is_basic_rag?(*args)
             args.length == 3 && args.all? {|arg| arg.is_a? Integer}

data/lib/gecko-pusher/channel/rag_col.rb

@@ -0,0 +1,8 @@
+module Gecko
+  module Pusher
+    module Channel
+      class RagCol < Rag
+      end
+    end
+  end
+end

data/lib/gecko-pusher/channel.rb

@@ -1 +1 @@
-%w{base text rag line_chart number}.each {|f| require "gecko-pusher/channel/#{f}"}
+%w{base text rag rag_col line_chart number map gecko_meter}.each {|f| require "gecko-pusher/channel/#{f}"}

data/lib/gecko-pusher/version.rb

@@ -1,5 +1,5 @@
 module Gecko
   module Pusher
-    VERSION = "0.0.3"
+    VERSION = "0.0.4"
   end
 end

data/lib/gecko-pusher.rb

@@ -39,3 +39,7 @@ module Gecko
     end
   end
 end
+
+if ENV['GECKO_PUSHER_APIKEY']
+  Gecko::Pusher::api_key = ENV['GECKO_PUSHER_APIKEY']
+end

data/spec/lib/gecko-pusher/channel/gecko_meter_spec.rb

@@ -0,0 +1,55 @@
+require 'spec_helper'
+
+describe Gecko::Pusher::Channel::GeckoMeter do
+
+  before(:each) do
+    WebMock.reset!
+    Gecko::Pusher.api_key = API_KEY
+    @channel = Gecko::Pusher.channel(:gecko_meter, WIDGET_KEY)
+  end
+
+  it "should initiate a gecko meter channel" do
+    @channel.should be_a(Gecko::Pusher::Channel::GeckoMeter)
+  end
+
+  it "should push basic value, min and max" do
+    data = {
+      item: 10,
+      min: { value: 0 },
+      max: { value: 20 }
+    }
+    stub = stub_gecko_post(WIDGET_KEY, data)
+    @channel.push(10, 0, 20)
+    stub.should have_been_requested
+  end
+
+  it "should push values with descriptions" do
+    data = {
+      item: 10,
+      min: { value: 0, text: "Min" },
+      max: { value: 20, text: "Max" }
+    }
+    stub = stub_gecko_post(WIDGET_KEY, data)
+    @channel.push(10, 0, "Min", 20, "Max")
+    stub.should have_been_requested
+  end
+
+  it "should allow type option to be passed" do
+    data = {
+      item: 10,
+      min: { value: 0 },
+      max: { value: 20 },
+      type: "reverse"
+    }
+    stub = stub_gecko_post(WIDGET_KEY, data)
+    @channel.push(10, 0, 20, type: "reverse")
+    stub.should have_been_requested
+  end
+
+  it "should raise an ArgumentError for invalid arguments" do
+    expect {
+      @channel.push("an invalid argument")
+    }.should raise_error(ArgumentError)
+  end
+
+end

data/spec/lib/gecko-pusher/channel/map_spec.rb

@@ -0,0 +1,123 @@
+require 'spec_helper'
+
+describe Gecko::Pusher::Channel::Map do
+
+  before(:each) do
+    WebMock.reset!
+    Gecko::Pusher.api_key = API_KEY
+    @channel = Gecko::Pusher.channel(:map, WIDGET_KEY)
+  end
+
+  it "should initiate a map channel" do
+    @channel.should be_a(Gecko::Pusher::Channel::Map)
+  end
+
+  context "pushing simple values" do
+
+    it "should push an IP address" do
+      data = {
+        points: {
+          point: [
+            {ip: "1.2.3.4"}
+          ]
+        }
+      }
+      stub = stub_gecko_post(WIDGET_KEY, data)
+      @channel.push("1.2.3.4")
+      stub.should have_been_requested
+    end
+
+    it "should push a lat/long" do
+      data = {
+        points: {
+          point: [
+            {latitude: "51.0001",longitude: "-51.0001"}
+          ]
+        }
+      }
+      stub = stub_gecko_post(WIDGET_KEY, data)
+      @channel.push([51.0001, -51.0001])
+      stub.should have_been_requested
+    end
+
+    it "should push an address" do
+      data = {
+        points: {
+          point: [
+            {city: {
+              city_name: "London",
+              country_code: "GB"
+            }}
+          ]
+        }
+      }
+      stub = stub_gecko_post(WIDGET_KEY, data)
+      @channel.push({city_name: "London", country_code: "GB"})
+      stub.should have_been_requested
+    end
+
+    it "should push a hostname" do
+      data = {
+        points: {
+          point: [
+            {host: "gecko.dsci.it"}
+          ]
+        }
+      }
+      stub = stub_gecko_post(WIDGET_KEY, data)
+      @channel.push("gecko.dsci.it")
+      stub.should have_been_requested
+    end
+
+    it "should push multiple values" do
+      data = {
+        points: {
+          point: [
+            {host: "gecko.dsci.it"},
+            {ip: "1.2.3.4"},
+            {latitude: "51.0001",longitude: "-51.0001"}
+          ]
+        }
+      }
+      stub = stub_gecko_post(WIDGET_KEY, data)
+      @channel.push(
+        "gecko.dsci.it",
+        "1.2.3.4",
+        [51.0001, -51.0001]
+      )
+      stub.should have_been_requested
+
+    end
+  end
+
+  context "pushing values with additional metadata" do
+
+    it "should raise ArgumentError if invalid point option passed" do
+      expect {
+        @channel.push(["gecko.dsci.it", {not_an_option: 8}])
+      }.should raise_error(ArgumentError)
+    end
+
+    it "should push multiple values" do
+      data = {
+        points: {
+          point: [
+            {host: "gecko.dsci.it", size: 8},
+            {ip: "1.2.3.4", color: "ff0000"},
+            {latitude: "51.0001",longitude: "-51.0001", cssClass: "classname"}
+          ]
+        }
+      }
+      stub = stub_gecko_post(WIDGET_KEY, data)
+      @channel.push(
+        ["gecko.dsci.it", {size: 8}],
+        ["1.2.3.4", {color: "ff0000"}],
+        [[51.0001, -51.0001], {cssClass: "classname"}]
+      )
+      stub.should have_been_requested
+
+    end
+
+  end
+
+end

data/spec/lib/gecko-pusher/channel/number_spec.rb

@@ -1,6 +1,6 @@
 require 'spec_helper'
 
-describe Gecko::Pusher::Channel::Rag do
+describe Gecko::Pusher::Channel::Number do
 
   before(:each) do
     WebMock.reset!

data/spec/lib/gecko-pusher/channel/rag_col_spec.rb

@@ -0,0 +1,43 @@
+require 'spec_helper'
+
+describe Gecko::Pusher::Channel::RagCol do
+
+  before(:each) do
+    WebMock.reset!
+    Gecko::Pusher.api_key = API_KEY
+    @channel = Gecko::Pusher.channel(:rag_col, WIDGET_KEY)
+  end
+
+  it "should initiate a RAG Column channel" do
+    @channel.should be_a(Gecko::Pusher::Channel::RagCol)
+  end
+
+  it "should push RAG values" do
+    data = {
+      item: [
+        { value: 100 },
+        { value: 200 },
+        { value: 300 }
+      ]
+    }
+    stub = stub_gecko_post(WIDGET_KEY, data)
+    @channel.push(100, 200, 300)
+    stub.should have_been_requested
+  end
+
+  it "should push RAG values and descriptions" do
+    data = {
+      item: [
+        { value: 100, text: "red description" },
+        { value: 200, text: "amber description" },
+        { value: 300, text: "green description" }
+      ]
+    }
+    stub = stub_gecko_post(WIDGET_KEY, data)
+    @channel.push(100, "red description",
+                  200, "amber description",
+                  300, "green description")
+    stub.should have_been_requested
+  end
+end
+

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: gecko-pusher
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.4
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2012-06-25 00:00:00.000000000 Z
+date: 2012-06-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -158,13 +158,19 @@ files:
 - lib/gecko-pusher.rb
 - lib/gecko-pusher/channel.rb
 - lib/gecko-pusher/channel/base.rb
+- lib/gecko-pusher/channel/gecko_meter.rb
 - lib/gecko-pusher/channel/line_chart.rb
+- lib/gecko-pusher/channel/map.rb
 - lib/gecko-pusher/channel/number.rb
 - lib/gecko-pusher/channel/rag.rb
+- lib/gecko-pusher/channel/rag_col.rb
 - lib/gecko-pusher/channel/text.rb
 - lib/gecko-pusher/version.rb
+- spec/lib/gecko-pusher/channel/gecko_meter_spec.rb
 - spec/lib/gecko-pusher/channel/line_chart_spec.rb
+- spec/lib/gecko-pusher/channel/map_spec.rb
 - spec/lib/gecko-pusher/channel/number_spec.rb
+- spec/lib/gecko-pusher/channel/rag_col_spec.rb
 - spec/lib/gecko-pusher/channel/rag_spec.rb
 - spec/lib/gecko-pusher/channel/text_spec.rb
 - spec/lib/gecko-pusher/channel_spec.rb
@@ -185,7 +191,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -392887078648416788
+      hash: 211583460469092842
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
@@ -194,7 +200,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
       version: '0'
       segments:
       - 0
-      hash: -392887078648416788
+      hash: 211583460469092842
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
@@ -202,8 +208,11 @@ signing_key:
 specification_version: 3
 summary: Provides a simple library to send updates to Geckoboard via its push API.
 test_files:
+- spec/lib/gecko-pusher/channel/gecko_meter_spec.rb
 - spec/lib/gecko-pusher/channel/line_chart_spec.rb
+- spec/lib/gecko-pusher/channel/map_spec.rb
 - spec/lib/gecko-pusher/channel/number_spec.rb
+- spec/lib/gecko-pusher/channel/rag_col_spec.rb
 - spec/lib/gecko-pusher/channel/rag_spec.rb
 - spec/lib/gecko-pusher/channel/text_spec.rb
 - spec/lib/gecko-pusher/channel_spec.rb