hue 0.2.0 → 0.3.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06f9987573ff54e807b7cb86f72237c6ed8c825f
-  data.tar.gz: 1150180432174f58f9e19d4f9fa45cb8f98ddd99
+SHA256:
+  metadata.gz: 17b9710dcfb0defef023c1adb4c4da4ca86fddc6f2e6c0d971bcb562c57ec61a
+  data.tar.gz: 8d8afd006ca7892d74f33af84f4040aedd0718b13583e1708a6994bb7803c3d9
 SHA512:
-  metadata.gz: d5b848f3b17020b64327b235be4ef897b3c31d41aadb69b245b14ab8b0b7caa3a7b2e0469bd8cac8deb20cf1bfdaa67d27f52f5f7ec9e598d48b44f5e2a7a892
-  data.tar.gz: a01dcd6e0385d5b327c34fa308d6fd37381073b22270af0a692e498ef2f2172dab8a045e3d90f24fd0850d29f2684765705f44b3a2eb68c7202f902f3b5d9b49
+  metadata.gz: 8d3a2e81c450c2d1dd5c94ade3cf146ea4f56f4102f710051c54185902c388f9c9494a6f597f3f0ee05b59d0b0ade9ba837c2a7983df9679ce14ea34dd07e9eb
+  data.tar.gz: eea449790732dbcfcd0795f1e01af3d6d1a19b800c3b41404fe0bd1a12a76fa706f59269f90320365dde650c6425811fca9bd0ea38558945e8d8c0800badcdc4

data/.github/workflows/main.yml

@@ -0,0 +1,29 @@
+name: Tests
+on: [push]
+jobs:
+  test:
+    name: Test
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Test
+        run: bundle exec rake test
+  lint:
+    name: Lint
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+      - name: Test
+        run: bundle exec rake standard

data/.gitignore

@@ -1,3 +1,4 @@
+.DS_Store
 *.gem
 *.rbc
 .bundle

data/.ruby-version

@@ -0,0 +1 @@
+3.2.2

data/Gemfile

@@ -1,5 +1,8 @@
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
 gemspec
 
-gem 'rake'
+gem "rake", "~> 13.0"
+gem "minitest", "~> 5.0"
+gem "standard", "~> 1.3"
+gem "webmock", "~> 3.19"

data/LICENSE

@@ -1,4 +1,4 @@
-Copyright (c) 2013-2014 Sam Soffes, http://soff.es
+Copyright (c) 2013-2024 Sam Soffes, https://soff.es
 
 MIT License
 

data/{Readme.markdown → README.md}

@@ -2,7 +2,6 @@
 
 Work with Philips Hue light bulbs from Ruby.
 
-[![Code Climate](https://codeclimate.com/github/soffes/hue.png)](https://codeclimate.com/github/soffes/hue) [![Dependency Status](https://gemnasium.com/soffes/hue.png)](https://gemnasium.com/soffes/hue) [![Gem Version](https://badge.fury.io/rb/hue.png)](http://badge.fury.io/rb/hue)
 
 ## Installation
 
@@ -78,7 +77,3 @@ group.new? # => false
 # Destroying groups
 client.groups.last.destroy!
 ```
-
-## Contributing
-
-See the [contributing guide](Contributing.markdown).

data/Rakefile

@@ -1,10 +1,12 @@
-require 'bundler/gem_tasks'
+require "bundler/gem_tasks"
+require "rake/testtask"
 
-begin
-  require 'rspec/core/rake_task'
-  RSpec::Core::RakeTask.new(:spec)
-
-  task :default => :spec
-rescue LoadError
-  # no rspec available
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList["test/**/*_test.rb"]
 end
+
+require "standard/rake"
+
+task default: :test

data/bin/console

@@ -0,0 +1,7 @@
+#!/usr/bin/env ruby
+
+require 'bundler/setup'
+require 'hue'
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/hue

@@ -5,4 +5,8 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 require 'hue'
 require 'hue/cli'
 
-Hue::Cli.start
+begin
+  Hue::Cli.start
+rescue Hue::LinkButtonNotPressed
+  abort("Error: Press the link button on your bridge and then run this command again within 30 seconds of pressing it.")
+end

data/hue.gemspec

@@ -1,28 +1,23 @@
-# coding: utf-8
-lib = File.expand_path('../lib', __FILE__)
+lib = File.expand_path("../lib", __FILE__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'hue/version'
+require "hue/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'hue'
-  spec.version       = Hue::VERSION
-  spec.authors       = ['Sam Soffes']
-  spec.email         = ['sam@soff.es']
-  spec.description   = 'Work with Philips Hue light bulbs.'
-  spec.summary       = 'Work with Philips Hue light bulbs from Ruby.'
-  spec.homepage      = 'https://github.com/soffes/hue'
-  spec.license       = 'MIT'
+  spec.name = "hue"
+  spec.version = Hue::VERSION
+  spec.authors = ["Sam Soffes"]
+  spec.email = ["sam@soff.es"]
+  spec.description = "Work with Philips Hue light bulbs."
+  spec.summary = "Work with Philips Hue light bulbs from Ruby."
+  spec.homepage = "https://github.com/soffes/hue"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files`.split($/)
-  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
-  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
-  spec.require_paths = ['lib']
+  spec.files = `git ls-files`.split($/)
+  spec.executables = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 1.9.3'
-  spec.add_dependency 'thor'
-  spec.add_dependency 'json'
-  spec.add_dependency 'log_switch', '0.4.0'
-  spec.add_dependency 'curb'
-  spec.add_development_dependency 'rspec', '~> 3.2.0'
-  spec.add_development_dependency 'webmock'
+  spec.required_ruby_version = ">= 2.1.0"
+  spec.add_dependency "thor"
+  spec.add_dependency "json"
+  spec.add_dependency "color_conversion"
 end

data/lib/hue/bridge.rb

@@ -46,32 +46,35 @@ module Hue
     # Current time stored on the bridge.
     def utc
       json = get_configuration
-      DateTime.parse(json['utc'])
+      DateTime.parse(json["utc"])
     end
 
     # Indicates whether the link button has been pressed within the last 30
     # seconds.
     def link_button_pressed?
       json = get_configuration
-      json['linkbutton']
+      json["linkbutton"]
     end
 
     # This indicates whether the bridge is registered to synchronize data with a
     # portal account.
     def has_portal_services?
       json = get_configuration
-      json['portalservices']
+      json["portalservices"]
     end
 
     def refresh
       json = get_configuration
       unpack(json)
+      @lights = nil
+      @groups = nil
+      @scenes = nil
     end
 
     def lights
       @lights ||= begin
         json = JSON(Net::HTTP.get(URI.parse(base_url)))
-        json['lights'].map do |key, value|
+        json["lights"].map do |key, value|
           Light.new(@client, self, key, value)
         end
       end
@@ -81,7 +84,7 @@ module Hue
       uri = URI.parse("#{base_url}/lights")
       http = Net::HTTP.new(uri.host)
       response = http.request_post(uri.path, nil)
-      (response.body).first
+      response.body.first
     end
 
     def groups
@@ -102,27 +105,27 @@ module Hue
       end
     end
 
-  private
+    private
 
     KEYS_MAP = {
-      :id => :id,
-      :ip => :internalipaddress,
-      :name => :name,
-      :proxy_port => :proxyport,
-      :software_update => :swupdate,
-      :ip_whitelist => :whitelist,
-      :software_version => :swversion,
-      :proxy_address => :proxyaddress,
-      :mac_address => :macaddress,
-      :network_mask => :netmask,
-      :portal_services => :portalservices,
+      id: :id,
+      ip: :internalipaddress,
+      name: :name,
+      proxy_port: :proxyport,
+      software_update: :swupdate,
+      ip_whitelist: :whitelist,
+      software_version: :swversion,
+      proxy_address: :proxyaddress,
+      mac_address: :macaddress,
+      network_mask: :netmask,
+      portal_services: :portalservices
     }
 
     def unpack(hash)
       KEYS_MAP.each do |local_key, remote_key|
         value = hash[remote_key.to_s]
         next unless value
-        instance_variable_set("@#{local_key}", value)
+        instance_variable_set(:"@#{local_key}", value)
       end
     end
 

data/lib/hue/cli.rb

@@ -1,67 +1,67 @@
-require 'thor'
+require "thor"
 
 module Hue
   class Cli < Thor
-    desc 'lights', 'Find all of the lights on your network'
+    desc "lights", "Find all of the lights on your network"
     def lights
       client.lights.each do |light|
         puts light.id.to_s.ljust(6) + light.name
       end
     end
 
-    desc 'add LIGHTS', 'Search for new lights'
+    desc "add LIGHTS", "Search for new lights"
     def add(thing)
       case thing
-      when 'lights'
+      when "lights"
         client.add_lights
       end
     end
 
-    desc 'light ID STATE [COLOR]', 'Access a light'
+    desc "light ID STATE [COLOR]", "Access a light"
     long_desc <<-LONGDESC
     Examples: \n
       hue all on \n
       hue all off \n
       hue all --hue 12345  \n
-      hue all --bri 25 \n
-      hue all --hue 50000 --bri 200 --sat 240 \n
+      hue all --brightness 25 \n
+      hue all --hue 50000 --brightness 200 --saturation 240 \n
       hue all --alert lselect \n
     LONGDESC
-    option :hue, :type => :numeric
-    option :sat, :type => :numeric, :aliases => '--saturation'
-    option :bri, :type => :numeric, :aliases => '--brightness'
-    option :alert, :type => :string
-    desc 'all STATE', 'Send commands to all lights'
-    def all(state = 'on')
+    option :hue, type: :numeric
+    option :sat, type: :numeric, aliases: "--saturation"
+    option :bri, type: :numeric, aliases: "--brightness"
+    option :alert, type: :string
+    desc "all STATE", "Send commands to all lights"
+    def all(state = "on")
       body = options.dup
-      body[:on] = state == 'on'
+      body[:on] = state == "on"
       client.lights.each do |light|
         puts light.set_state body
       end
     end
 
-    desc 'light ID STATE [COLOR]', 'Access a light'
+    desc "light ID STATE [COLOR]", "Access a light"
     long_desc <<-LONGDESC
     Examples: \n
       hue light 1 on --hue 12345  \n
-      hue light 1 --bri 25 \n
+      hue light 1 --brightness 25 \n
       hue light 1 --alert lselect \n
       hue light 1 off
     LONGDESC
-    option :hue, :type => :numeric
-    option :sat, :type => :numeric, :aliases => '--saturation'
-    option :brightness, :type => :numeric, :aliases => '--brightness'
-    option :alert, :type => :string
+    option :hue, type: :numeric
+    option :sat, type: :numeric, aliases: "--saturation"
+    option :bri, type: :numeric, aliases: "--brightness"
+    option :alert, type: :string
     def light(id, state = nil)
       light = client.light(id)
       puts light.name
 
       body = options.dup
-      body[:on] = (state == 'on' || !(state == 'off'))
+      body[:on] = (state == "on" || !(state == "off"))
       puts light.set_state(body) if body.length > 0
     end
 
-    desc 'groups', 'Find all light groups on your network'
+    desc "groups", "Find all light groups on your network"
     def groups
       client.groups.each do |group|
         puts group.id.to_s.ljust(6) + group.name
@@ -71,28 +71,28 @@ module Hue
       end
     end
 
-    desc 'group ID STATE [COLOR]', 'Update a group of lights'
+    desc "group ID STATE [COLOR]", "Update a group of lights"
     long_desc <<-LONGDESC
     Examples: \n
       hue groups 1 on --hue 12345
-      hue groups 1 --bri 25
+      hue groups 1 --brightness 25
       hue groups 1 --alert lselect
       hue groups 1 off
     LONGDESC
-    option :hue, :type => :numeric
-    option :sat, :type => :numeric, :aliases => '--saturation'
-    option :brightness, :type => :numeric, :aliases => '--brightness'
-    option :alert, :type => :string
+    option :hue, type: :numeric
+    option :sat, type: :numeric, aliases: "--saturation"
+    option :bri, type: :numeric, aliases: "--brightness"
+    option :alert, type: :string
     def group(id, state = nil)
       group = client.group(id)
       puts group.name
 
       body = options.dup
-      body[:on] = (state == 'on' || !(state == 'off'))
+      body[:on] = (state == "on" || !(state == "off"))
       puts group.set_state(body) if body.length > 0
     end
 
-  private
+    private
 
     def client
       @client ||= Hue::Client.new

data/lib/hue/client.rb

@@ -1,15 +1,15 @@
-require 'net/http'
-require 'json'
-require 'curb'
+require "net/http"
+require "json"
+require "resolv"
 
 module Hue
   class Client
     attr_reader :username
 
-    def initialize(username = nil)
-      username = find_username unless @username
-
-      @username = username
+    def initialize(username = nil, use_mdns: true)
+      @bridge_id = nil
+      @username = username || find_username
+      @use_mdns = use_mdns
 
       if @username
         begin
@@ -23,8 +23,12 @@ module Hue
     end
 
     def bridge
-      # Pick the first one for now. In theory, they should all do the same thing.
-      bridge = bridges.first
+      @bridge_id ||= find_bridge_id
+      bridge = if @bridge_id
+        bridges.find { |b| b.id == @bridge_id }
+      else
+        bridges.first
+      end
       raise NoBridgeFound unless bridge
       bridge
     end
@@ -32,14 +36,8 @@ module Hue
     def bridges
       @bridges ||= begin
         bs = []
-        easy = Curl::Easy.new
-        easy.follow_location = true
-        easy.max_redirects = 10
-        easy.url = 'https://www.meethue.com/api/nupnp'
-        easy.perform
-        JSON(easy.body).each do |hash|
-          bs << Bridge.new(self, hash)
-        end
+        discovery_mdns(bs) if @use_mdns
+        discovery_meethue(bs) if bs.empty?
         bs
       end
     end
@@ -54,7 +52,7 @@ module Hue
 
     def light(id)
       id = id.to_s
-      lights.select { |l| l.id == id }.first
+      lights.find { |l| l.id == id }
     end
 
     def groups
@@ -65,7 +63,7 @@ module Hue
       return Group.new(self, bridge) if id.nil?
 
       id = id.to_s
-      groups.select { |g| g.id == id }.first
+      groups.find { |g| g.id == id }
     end
 
     def scenes
@@ -74,18 +72,18 @@ module Hue
 
     def scene(id)
       id = id.to_s
-      scenes.select { |s| s.id == id }.first
+      scenes.find { |s| s.id == id }
     end
 
     private
 
     def find_username
-      return ENV['HUE_USERNAME'] if ENV['HUE_USERNAME']
+      return ENV["HUE_USERNAME"] if ENV["HUE_USERNAME"]
 
-      json = JSON(File.read(File.expand_path('~/.hue')))
-      json['username']
+      json = JSON(File.read(File.expand_path("~/.hue")))
+      json["username"]
     rescue
-      return nil
+      nil
     end
 
     def validate_user
@@ -95,35 +93,69 @@ module Hue
         response = response.first
       end
 
-      if error = response['error']
+      if (error = response["error"])
         raise get_error(error)
       end
 
-      response['success']
+      response["success"]
     end
 
     def register_user
       body = JSON.dump({
-        devicetype: 'Ruby'
+        devicetype: "Ruby"
       })
 
       uri = URI.parse("http://#{bridge.ip}/api")
       http = Net::HTTP.new(uri.host)
       response = JSON(http.request_post(uri.path, body).body).first
 
-      if error = response['error']
+      if (error = response["error"])
         raise get_error(error)
       end
 
-      if @username = response['success']['username']
-        File.write(File.expand_path('~/.hue'), JSON.dump({username: @username}))
+      if (@username = response["success"]["username"])
+        File.write(File.expand_path("~/.hue"), JSON.dump({username: @username}))
+      end
+    end
+
+    def find_bridge_id
+      return ENV["HUE_BRIDGE_ID"] if ENV["HUE_BRIDGE_ID"]
+
+      json = JSON(File.read(File.expand_path("~/.hue")))
+      json["bridge_id"]
+    rescue
+      nil
+    end
+
+    def discovery_mdns(bs)
+      resolver = Resolv::MDNS.new
+      resolver.timeouts = 10
+
+      resolver.each_resource("_hue._tcp.local", Resolv::DNS::Resource::IN::PTR) do |bridge_ptr|
+        bridge_target = resolver.getresource(bridge_ptr.name, Resolv::DNS::Resource::IN::SRV).target
+
+        bridge_hash = {
+          "id" => resolver.getresource(bridge_ptr.name, Resolv::DNS::Resource::IN::TXT).strings[0].split("=")[1],
+          "internalipaddress" => resolver.getresource(bridge_target, Resolv::DNS::Resource::IN::A).address
+        }
+
+        bs << Bridge.new(self, bridge_hash)
+      end
+    end
+
+    def discovery_meethue(bs)
+      uri = URI("https://discovery.meethue.com/")
+      response = Net::HTTP.get(uri)
+
+      JSON(response).each do |hash|
+        bs << Bridge.new(self, hash)
       end
     end
 
     def get_error(error)
       # Find error class and return instance
-      klass = Hue::ERROR_MAP[error['type']] || UnknownError unless klass
-      klass.new(error['description'])
+      klass ||= Hue::ERROR_MAP[error["type"]] || UnknownError
+      klass.new(error["description"])
     end
   end
 end

data/lib/hue/editable_state.rb

@@ -1,7 +1,13 @@
+require "color_conversion"
+
 module Hue
   module EditableState
+    HUE_RANGE = 0..65535
+    SATURATION_RANGE = 0..254
+    BRIGHTNESS_RANGE = 0..254
+
     def on?
-      @state['on']
+      @on || false
     end
 
     def on!
@@ -12,16 +18,47 @@ module Hue
       self.on = false
     end
 
-    %w{on hue saturation brightness color_temperature alert effect}.each do |key|
-      define_method "#{key}=".to_sym do |value|
+    # Turn the light on if it's off and vice versa
+    def toggle!
+      if @on
+        off!
+      else
+        on!
+      end
+    end
+
+    %w[on hue saturation brightness color_temperature alert effect].each do |key|
+      define_method :"#{key}=" do |value|
         set_state({key.to_sym => value})
-        instance_variable_set("@#{key}".to_sym, value)
+        instance_variable_set(:"@#{key}", value)
       end
     end
 
     def set_xy(x, y)
-      set_state({:xy => [x, y]})
+      set_state({xy: [x, y]})
       @x, @y = x, y
     end
+
+    def hex
+      ColorConversion::Color.new(h: hue, s: saturation, b: brightness).hex
+    end
+
+    def hex=(hex)
+      hex = "##{hex}" unless hex.start_with?("#")
+      hsb = ColorConversion::Color.new(hex).hsb
+
+      # Map values from standard HSB to what Hue wants and update state
+      state = {
+        hue: ((hsb[:h].to_f / 360.0) * HUE_RANGE.last.to_f).to_i,
+        saturation: ((hsb[:s].to_f / 100.0) * SATURATION_RANGE.last.to_f).to_i,
+        brightness: ((hsb[:b].to_f / 100.0) * BRIGHTNESS_RANGE.last.to_f).to_i
+      }
+
+      set_state(state)
+
+      @hue = state[:hue]
+      @saturation = state[:saturation]
+      @brightness = state[:brightness]
+    end
   end
 end