leftronicapi 1.1.1 → 1.2.0

data/README.md

@@ -59,7 +59,7 @@ require 'leftronic'
 Create a class instance with your API key. Feel free to name it whatever you'd like.
 
 ```ruby
-update = Leftronic.new("YOUR_ACCESS_KEY")
+leftronic = Leftronic.new "YOUR_ACCESS_KEY"
 ```
 
 Here are some example functions to push to your dashboard. Be sure you have configured the correct widgets to accept custom data points. Also, be sure that you have entered your API access key correctly.
@@ -67,35 +67,42 @@ Here are some example functions to push to your dashboard. Be sure you have conf
 Let's start with pushing a number to a widget.
 
 ```ruby
-update = Leftronic.pushNumber("yourNumberStream", 14600)
+update = leftronic.push_number "yourNumberStream", 14600
 ```
 
-Now we'll push some geographic coordinates to a map widget. You can use either the U.S. or world map widgets. The first coordinate (37.8) is the latitude and the second coordinate (-122.6) is the longitude. If your request is successful, you should see a data point appear on San Francisco, California.
+Now we'll push some geographic coordinates to a map widget. You can use either the U.S. or world map widgets. The first coordinate (37.8) is the latitude and the second coordinate (-122.6) is the longitude. If your request is successful, you should see a data point appear on San Francisco, California. Optionally, if you'd like to set the color of your map point simply specify that in your function call. *Note*: only red, blue, green, purple, and yellow colors are supported at this time. Incorrect or missing color will default to red.
 
 ```ruby
-update = Leftronic.pushGeo("yourGeoStream", 37.8, -122.6)
+update = leftronic.push_geo "yourGeoStream", 37.8, -122.6
+```
+
+```ruby
+update = leftronic.push_geo "yourGeoStream", 37.8, -122.6, :blue
 ```
 
 Here's how you push a title and message to a text feed widget.
 
 ```ruby
-update = Leftronic.pushText("yourTextStream", "This is my title.", "Hello World!")
+update = leftronic.push_text "yourTextStream", "This is my title.", "Hello World!"
 ```
 
-Let's push an array of names and values to a leaderboard widget. Be sure to create the array first (you may call it whatever you'd like). Be careful to use the proper syntax. Next, push the array to your widget.
+A leaderboard widget requires a hash. The widget will display the hash entries sorted by value.
 
 ```ruby
-leaderArray = Array[{"name" => "Johnny", "value" => 84}, {"name" => "Jamie", "value" => 75}, {"name" => "Lance", "value" => 62}]
-
-update = Leftronic.pushLeaderboard("yourBoardStream", leaderArray)
+update = leftronic.push_leaderboard "yourBoardStream", some_hash
+```
+```ruby
+update = leftronic.push_leaderboard "yourBoardStream", 'Johnny' => 84, 'Jamie' => 75, 'Lance' => 62
 ```
 
-Similar to the last example, let's push a list of items to a list widget. Same rules as last time.
+Finally, let's push an array to a list widget.
 
 ```ruby
-listArray = Array[{"listItem" => "Elizabeth"}, {"listItem" => "Marshall"}, {"listItem" => "Claire"}, {"listItem" => "Nolan"}]
-
-update = Leftronic.pushList("yourListStream", listArray)
+update = leftronic.push_list "yourListStream", some_array
+```
+```ruby
+update = leftronic.push_list "yourListStream", 'Elizabeth', 'Marshall', 'Claire', 'Nolan'
+```
 ```
 
 Feedback and Issues

data/Rakefile

@@ -20,7 +20,8 @@ Jeweler::Tasks.new do |gem|
   gem.summary = %Q{The official Ruby Gem to interface with the Leftronic API.}
   gem.description = %Q{Provides a set of functions to update Leftronic dashboard widgets with custom data. Data is submitted by an HTTP POST request with data encoded in the JSON format.}
   gem.email = "support@leftronic.com"
-  gem.authors = ["Peter Schaadt"]
+  gem.authors = ["Cesar Del Solar"]
+  gem.version = '1.2.0'
   ### dependencies defined in Gemfile
 end
 Jeweler::RubygemsDotOrgTasks.new

data/leftronicapi.gemspec

@@ -4,14 +4,14 @@
 # -*- encoding: utf-8 -*-
 
 Gem::Specification.new do |s|
-  s.name = "leftronicapi"
-  s.version = "1.1.1"
+  s.name = %q{leftronicapi}
+  s.version = "1.2.0"
 
   s.required_rubygems_version = Gem::Requirement.new(">= 0") if s.respond_to? :required_rubygems_version=
-  s.authors = ["Peter Schaadt"]
-  s.date = "2011-09-28"
-  s.description = "Provides a set of functions to update Leftronic dashboard widgets with custom data. Data is submitted by an HTTP POST request with data encoded in the JSON format."
-  s.email = "support@leftronic.com"
+  s.authors = ["Cesar Del Solar"]
+  s.date = %q{2012-03-22}
+  s.description = %q{Provides a set of functions to update Leftronic dashboard widgets with custom data. Data is submitted by an HTTP POST request with data encoded in the JSON format.}
+  s.email = %q{support@leftronic.com}
   s.extra_rdoc_files = [
     "LICENSE.txt",
     "README.md",
@@ -32,16 +32,17 @@ Gem::Specification.new do |s|
     "test/helper.rb",
     "test/test_leftronic.rb"
   ]
-  s.homepage = "http://github.com/sonofabell/leftronic-ruby"
+  s.homepage = %q{http://github.com/sonofabell/leftronic-ruby}
   s.licenses = ["GNU - LGPL"]
   s.require_paths = ["lib"]
-  s.rubygems_version = "1.8.10"
-  s.summary = "The official Ruby Gem to interface with the Leftronic API."
+  s.rubygems_version = %q{1.3.6}
+  s.summary = %q{The official Ruby Gem to interface with the Leftronic API.}
 
   if s.respond_to? :specification_version then
+    current_version = Gem::Specification::CURRENT_SPECIFICATION_VERSION
     s.specification_version = 3
 
-    if Gem::Version.new(Gem::VERSION) >= Gem::Version.new('1.2.0') then
+    if Gem::Version.new(Gem::RubyGemsVersion) >= Gem::Version.new('1.2.0') then
       s.add_runtime_dependency(%q<curb>, [">= 0"])
       s.add_runtime_dependency(%q<json>, [">= 0"])
       s.add_runtime_dependency(%q<rake>, [">= 0"])

data/lib/leftronic.rb

@@ -1,88 +1,84 @@
+require 'net/http'
+require 'net/https'
 require 'rubygems'
-require 'curb'
 require 'json'
 
 class Leftronic
+  ALLOWED_COLORS = [:red, :yellow, :green, :blue, :purple]
+  attr_accessor :key
+  def url=(url)
+    @url = URI(url.to_s)
+  end
+  def url
+    @url.to_s
+  end
 
-  attr_accessor :accessKey
-  
-  # Class variable
-  def initialize(accessKey)
-      @@accessKey = accessKey
+  def initialize(key, url='https://beta.leftronic.com/customSend/')
+    @key = key
+    self.url = url
   end
 
-  def self.pushNumber(streamName, point)
-      ### Pushing a number to a Number, Horizontal/Vertical Bar, or Dial widget
-      parameters = {"accessKey" => @@accessKey, "streamName" => streamName, "point" => point}
-      # Convert to JSON
-      jsonData = parameters.to_json()
-      # Form request
-      urlRequest = Curl::Easy.http_post("https://beta.leftronic.com/customSend/", jsonData
-      # Make request
-          ) do |curl|
-            curl.headers['Accept'] = 'application/json'
-            curl.headers['Content-Type'] = 'application/json'
-          end
+  # Push anything to a widget
+  def push(stream, object)
+    post stream, object
   end
 
-  def self.pushGeo(streamName, lati, longi)
-      ### Pushing a geographic location (latitude and longitude) to a Map widget
-      parameters = {"accessKey" => @@accessKey, "streamName" => streamName, "point" => {
-        "latitude" => lati, "longitude" => longi}}
-      # Convert to JSON
-      jsonData = parameters.to_json()
-      # Form request
-      urlRequest = Curl::Easy.http_post("https://beta.leftronic.com/customSend/", jsonData
-      # Make request
-          ) do |curl|
-            curl.headers['Accept'] = 'application/json'
-            curl.headers['Content-Type'] = 'application/json'
-          end
+  # Push a Number to a widget
+  def push_number(stream, point)
+    post stream, point
   end
-  
-  def self.pushText(streamName, myTitle, myMsg)
-      ### Pushing a title and message to a Text Feed widget
-      parameters = {"accessKey" => @@accessKey, "streamName" => streamName, "point" => {
-        "title" => myTitle, "msg" => myMsg}}
-      # Convert to JSON
-      jsonData = parameters.to_json()
-      # Form request
-      urlRequest = Curl::Easy.http_post("https://beta.leftronic.com/customSend/", jsonData
-      # Make request
-          ) do |curl|
-            curl.headers['Accept'] = 'application/json'
-            curl.headers['Content-Type'] = 'application/json'
-          end
+
+  # Push a geographic location (latitude and longitude) to a Map widget
+  def push_geo(stream, lat, long, color=nil)
+    post stream, 'latitude' => lat, 'longitude' => long, 'color' => color
   end
 
-  def self.pushLeaderboard(streamName, leaderArray)
-      ### Pushing an array to the Leaderboard widget
-      parameters = {"accessKey" => @@accessKey, "streamName" => streamName, "point" => {
-        "leaderboard" => leaderArray}}
-      # Convert to JSON
-      jsonData = parameters.to_json()
-      # Form request
-      urlRequest = Curl::Easy.http_post("https://beta.leftronic.com/customSend/", jsonData
-      # Make request
-          ) do |curl|
-            curl.headers['Accept'] = 'application/json'
-            curl.headers['Content-Type'] = 'application/json'
-          end
+  # Push a title and message to a Text Feed widget
+  def push_text(stream, title, message)
+    post stream, 'title' => title, 'msg' => message
   end
-  
-  def self.pushList(streamName, listArray)
-      ### Pushing an array to the List widget
-      parameters = {"accessKey" => @@accessKey, "streamName" => streamName, "point" => {
-        "list" => listArray}}
-      # Convert to JSON
-      jsonData = parameters.to_json()
-      # Form request
-      urlRequest = Curl::Easy.http_post("https://beta.leftronic.com/customSend/", jsonData
-      # Make CURL request
-          ) do |curl|
-            curl.headers['Accept'] = 'application/json'
-            curl.headers['Content-Type'] = 'application/json'
-          end
+
+  # Push a hash to a Leaderboard widget
+  def push_leaderboard(stream, hash)
+    leaderboard = hash.inject([]) do |array, (key, value)|
+      array << {'name' => key, 'value' => value}
+    end
+    post stream, 'leaderboard' => leaderboard
   end
 
+  # Push an array to a List widget
+  def push_list(stream, *array)
+    post stream, 'list' => array.flatten.map{|item| {'listItem' => item}}
+  end
+
+  protected
+
+  def post(stream, params)
+    request = build_request(stream, params)
+    connection = build_connection
+    connection.start{|http| http.request request}
+    params
+  end
+
+  def build_request(stream, params)
+    request = Net::HTTP::Post.new @url.request_uri
+    request['Accept'] = 'application/json'
+    request['Content-Type'] = 'application/json'
+    request.body = {
+      'accessKey' => @key,
+      'streamName' => stream,
+      'point' => params
+    }.to_json
+    request
+  end
+
+  def build_connection # NOTE: Does not open the connection
+    connection = Net::HTTP.new @url.host, @url.port
+    if @url.scheme == 'https'
+      connection.use_ssl = true
+      connection.verify_mode = OpenSSL::SSL::VERIFY_NONE
+    end
+    connection
+  end
 end
+

metadata

@@ -1,124 +1,110 @@
 --- !ruby/object:Gem::Specification 
 name: leftronicapi
 version: !ruby/object:Gem::Version 
-  hash: 17
-  prerelease: 
+  prerelease: false
   segments: 
   - 1
-  - 1
-  - 1
-  version: 1.1.1
+  - 2
+  - 0
+  version: 1.2.0
 platform: ruby
 authors: 
-- Peter Schaadt
+- Cesar Del Solar
 autorequire: 
 bindir: bin
 cert_chain: []
 
-date: 2011-09-28 00:00:00 Z
+date: 2012-03-22 00:00:00 -07:00
+default_executable: 
 dependencies: 
 - !ruby/object:Gem::Dependency 
-  requirement: &id001 !ruby/object:Gem::Requirement 
-    none: false
+  prerelease: false
+  type: :runtime
+  name: curb
+  version_requirements: &id001 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  version_requirements: *id001
-  name: curb
+  requirement: *id001
+- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id002 !ruby/object:Gem::Requirement 
-    none: false
+  name: json
+  version_requirements: &id002 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  version_requirements: *id002
-  name: json
+  requirement: *id002
+- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :runtime
-- !ruby/object:Gem::Dependency 
-  requirement: &id003 !ruby/object:Gem::Requirement 
-    none: false
+  name: rake
+  version_requirements: &id003 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  version_requirements: *id003
-  name: rake
-  prerelease: false
-  type: :runtime
+  requirement: *id003
 - !ruby/object:Gem::Dependency 
-  requirement: &id004 !ruby/object:Gem::Requirement 
-    none: false
+  prerelease: false
+  type: :development
+  name: shoulda
+  version_requirements: &id004 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  version_requirements: *id004
-  name: shoulda
+  requirement: *id004
+- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id005 !ruby/object:Gem::Requirement 
-    none: false
+  name: bundler
+  version_requirements: &id005 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 23
         segments: 
         - 1
         - 0
         - 0
         version: 1.0.0
-  version_requirements: *id005
-  name: bundler
+  requirement: *id005
+- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id006 !ruby/object:Gem::Requirement 
-    none: false
+  name: jeweler
+  version_requirements: &id006 !ruby/object:Gem::Requirement 
     requirements: 
     - - ~>
       - !ruby/object:Gem::Version 
-        hash: 7
         segments: 
         - 1
         - 6
         - 4
         version: 1.6.4
-  version_requirements: *id006
-  name: jeweler
+  requirement: *id006
+- !ruby/object:Gem::Dependency 
   prerelease: false
   type: :development
-- !ruby/object:Gem::Dependency 
-  requirement: &id007 !ruby/object:Gem::Requirement 
-    none: false
+  name: rcov
+  version_requirements: &id007 !ruby/object:Gem::Requirement 
     requirements: 
     - - ">="
       - !ruby/object:Gem::Version 
-        hash: 3
         segments: 
         - 0
         version: "0"
-  version_requirements: *id007
-  name: rcov
-  prerelease: false
-  type: :development
+  requirement: *id007
 description: Provides a set of functions to update Leftronic dashboard widgets with custom data. Data is submitted by an HTTP POST request with data encoded in the JSON format.
 email: support@leftronic.com
 executables: []
@@ -143,6 +129,7 @@ files:
 - lib/leftronic.rb
 - test/helper.rb
 - test/test_leftronic.rb
+has_rdoc: true
 homepage: http://github.com/sonofabell/leftronic-ruby
 licenses: 
 - GNU - LGPL
@@ -152,27 +139,23 @@ 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.8.10
+rubygems_version: 1.3.6
 signing_key: 
 specification_version: 3
 summary: The official Ruby Gem to interface with the Leftronic API.