philips_hue 0.1.4 → 0.1.5

data/README.md

@@ -4,7 +4,7 @@ This is a library for accessing and controlling your [Philips Hue](http://www.me
 
 #### TL;DR:
 
-[Check out the bin/ directory for examples](https://github.com/dmerrick/lights_app/tree/master/bin) of how to use this project and what kind of things you can do.
+Install with `gem install philips_hue`. [Check out the bin/ directory for examples](https://github.com/dmerrick/lights_app/tree/master/bin) of how to use this project and what kind of things you can do.
 
 
 ### Registering with the Bridge

data/bin/flash.rb

@@ -34,10 +34,10 @@ OptionParser.new do |opts|
   opts.on("-n [number]", Integer, "Repeat [number] times") do |num|
     options.repeat = num
   end
-  opts.on("--app [app_name]", "The name of the registered app") do |app|
+  opts.on("-a [app_name]","--app [app_name]", "The name of the registered app") do |app|
     options.app_name = app
   end
-  opts.on("--api [url]", "The address of the Hue hub") do |api|
+  opts.on("-b [addr]","--bridge [addr]", "The address of the Hue bridge") do |api|
     options.api_url = api
   end
 end.parse!

data/bin/register.rb

@@ -0,0 +1,34 @@
+#!/usr/bin/env ruby
+# example: register.rb --bridge 192.168.1.14 --app lightsapp
+
+# this is a great place for a new user to start
+# if you see "Success!", you're ready to start hacking
+
+# any time you use a new app name, you will have to reregister
+
+require 'rubygems'
+require 'optparse'
+require 'philips_hue'
+
+# parse the command line options
+options = {}
+OptionParser.new do |opts|
+  opts.banner = "Usage: register.rb [options]"
+  opts.on("-a [app_name]","--app [app_name]", "The name of the app to register") do |app|
+    options[:app_name] = app
+  end
+  opts.on("-b [addr]","--bridge [addr]", "The address of the Hue bridge") do |api|
+    options[:api_url] = api
+  end
+end.parse!
+
+# register the app with the hue bridge
+# get ready to press the link button!
+hue = PhilipsHue::Bridge.register(options[:app_name], options[:api_url])
+
+# it worked!
+# print some friendly info
+puts
+puts "Success!"
+puts hue
+puts hue.lights.first

data/lib/philips_hue/bridge.rb

@@ -9,11 +9,10 @@ module PhilipsHue
       @app_name = app_name
       @key = Digest::MD5.hexdigest(@app_name)
       @api_endpoint = "http://#{api_url}/api"
-      @lights = add_all_lights
     end
 
     # provide getter methods for these variables
-    attr_reader :app_name, :key, :api_endpoint, :lights
+    attr_reader :app_name, :key, :api_endpoint
 
     # returns overall system status as JSON
     def overview
@@ -26,26 +25,43 @@ module PhilipsHue
       Light.new(light_name, light_id, @api_endpoint, @key)
     end
 
+    # return the lights array or add them it if needed
+    def lights
+      @lights ||= add_all_lights
+    end
+
     # helper method to get light by light_id
     def light(light_id)
       @lights[light_id.to_i-1]
     end
 
     # registers your app with the Hue
-    # this must be run for every unique app name
-    # FIXME: this needs to be more adequately tested
-    def register!
+    # this must be run for every new app name
+    def self.register(app_name, api_url)
       puts "Press the link button on the Hue..."
-      sleep 10
-      json_body = {:username => @key, :devicetype => @app_name}.to_json
-      response = HTTParty.post(@api_endpoint, :body => json_body)
-
-      if response.first["error"] # should be response.code
-        puts "Press link button and try again."
-        exit
-      else
-        return response
+
+      # pretty countdown
+      10.downto(1) do |n|
+        print n
+        sleep 1
+        print n == 1 ? "\r#{' '*30}\r" : ", "
       end
+
+      # create a new bridge and submit a special POST request
+      new_bridge = self.new(app_name, api_url)
+      json_body = { :username => new_bridge.key, :devicetype => new_bridge.app_name}.to_json
+      response = HTTParty.post(new_bridge.api_endpoint, :body => json_body)
+
+      # quit if it didn't work (link button wasn't pressed)
+      abort "Press link button and try again." if response.first["error"]
+
+      # return the now-registered bridge
+      new_bridge
+    end
+
+    # human-readable bridge summary
+    def to_s
+      "#{app_name}: #{api_endpoint}"
     end
 
     private

data/lib/philips_hue/version.rb

@@ -1,3 +1,3 @@
 module PhilipsHue
-  VERSION = "0.1.4"
+  VERSION = "0.1.5"
 end

data/lib/philips_hue.rb

@@ -1,5 +1,6 @@
 require 'digest/md5'
 require 'httparty'
+require 'json'
 
 require 'philips_hue/version'
 require 'philips_hue/bridge'

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: philips_hue
 version: !ruby/object:Gem::Version
-  version: 0.1.4
+  version: 0.1.5
   prerelease: 
 platform: ruby
 authors:
@@ -27,6 +27,22 @@ dependencies:
     - - ! '>='
       - !ruby/object:Gem::Version
         version: 0.10.0
+- !ruby/object:Gem::Dependency
+  name: json
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '1.6'
 description: A library to control and query Philips Hue lights
 email: dana.merrick@gmail.com
 executables: []
@@ -42,6 +58,7 @@ files:
 - bin/all_on.rb
 - bin/flash.rb
 - bin/light_show.rb
+- bin/register.rb
 - bin/sandbox.rb
 - bin/test.rb
 - README.md