hue 0.1.5 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 392c6116951d5bc531a34f0ef2c52d5fb5f82ad8
-  data.tar.gz: 3a5e4de39857bd328c5e69deb2866266d709fcc7
+SHA256:
+  metadata.gz: af74df93c5514679bab0613c9c6c87b0a0dfae19b919fc903ad42a8fafe9b681
+  data.tar.gz: 0afb9bd5b7ee11be0a1dce6b56846c6d13fa7cd9a9b67e2f9c8014c8d03f0fb7
 SHA512:
-  metadata.gz: e21f6cc541aa058b4a5502f7699f0bb67c46ecf63d07c45c4ea036b037a20ced5372db75cb6d2b9d06fa3796badab290eb2639d3d2084487f9038c09e98899e4
-  data.tar.gz: 2d95c4b7a772fbbb966f368f0967ea1d20a9c36b6ee677927a6644548ffde7d93cff812cea376b691f11d72c1180972e31d63bd71e07b0373b1bdb2c0ec5a1f7
+  metadata.gz: 00f64a5fdad18722af090747e6a2dfe2a5fefb556bcd634ee7b498f54df80e23e94975c295a2925a46cf2166e88df0af07dee1999e26446f7e42e66ebbc8778b
+  data.tar.gz: f54f5552bceb7456b0a1d6ccdc29f7ca3cb01636231d83a5f0d7d93b907defce6bfbfcb0e2f96444e49543fbb85f7cda66586f72eedaea912c7a18f5ededb570

data/.github/workflows/main.yml

@@ -0,0 +1,14 @@
+name: Tests
+on: [push]
+jobs:
+  test:
+    name: Test Swift Package
+    runs-on: ubuntu-latest
+    timeout-minutes: 5
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-ruby@v1
+      - name: 'Install Dependencies'
+        run: sudo apt-get install libcurl4-openssl-dev && gem install bundler && bundle install
+      - name: 'Test'
+        run: bundle exec rake test

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
 
@@ -64,7 +63,7 @@ group = client.group(1)
 
 # Accessing group lights
 group.lights.first.on!
-group.lights.each { |light| light.hue = rand(0...65535) }
+group.lights.each { |light| light.hue = rand(Hue::Light::HUE_RANGE) }
 
 # Creating groups
 group = client.group # Don't specify an ID
@@ -78,7 +77,3 @@ group.new? # => false
 # Destroying groups
 client.groups.last.destroy!
 ```
-
-## Contributing
-
-See the [contributing guide](Contributing.markdown).

data/Rakefile

@@ -1 +1,10 @@
 require 'bundler/gem_tasks'
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.libs << 'lib'
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

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

@@ -18,9 +18,11 @@ Gem::Specification.new do |spec|
   spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
   spec.require_paths = ['lib']
 
-  spec.required_ruby_version = '>= 1.9.3'
+  spec.required_ruby_version = '>= 2.1.0'
   spec.add_dependency 'thor'
   spec.add_dependency 'json'
   spec.add_dependency 'log_switch', '0.4.0'
   spec.add_dependency 'curb'
+  spec.add_development_dependency 'minitest', '~> 5.0'
+  spec.add_development_dependency 'webmock'
 end

data/lib/hue/bridge.rb

@@ -66,6 +66,9 @@ module Hue
     def refresh
       json = get_configuration
       unpack(json)
+      @lights = nil
+      @groups = nil
+      @scenes = nil
     end
 
     def lights

data/lib/hue/client.rb

@@ -1,28 +1,35 @@
 require 'net/http'
 require 'json'
+require 'resolv'
 require 'curb'
 
 module Hue
   class Client
     attr_reader :username
 
-    def initialize(username = '1234567890')
-      unless USERNAME_RANGE.include?(username.length)
-        raise InvalidUsername, "Usernames must be between #{USERNAME_RANGE.first} and #{USERNAME_RANGE.last}."
-      end
-
-      @username = username
+    def initialize(username = nil, use_mdns: true)
+      @bridge_id = nil
+      @username = username || find_username
+      @use_mdns = use_mdns
 
-      begin
-        validate_user
-      rescue Hue::UnauthorizedUser
+      if @username
+        begin
+          validate_user
+        rescue Hue::UnauthorizedUser
+          register_user
+        end
+      else
         register_user
       end
     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 unless @bridge_id
+      if @bridge_id
+        bridge = bridges.select { |b| b.id == @bridge_id }.first
+      else
+        bridge = bridges.first
+      end
       raise NoBridgeFound unless bridge
       bridge
     end
@@ -30,14 +37,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
@@ -75,44 +76,89 @@ module Hue
       scenes.select { |s| s.id == id }.first
     end
 
-  private
+    private
 
-  def validate_user
-    response = JSON(Net::HTTP.get(URI.parse("http://#{bridge.ip}/api/#{@username}")))
+    def find_username
+      return ENV['HUE_USERNAME'] if ENV['HUE_USERNAME']
 
-    if response.is_a? Array
-      response = response.first
+      json = JSON(File.read(File.expand_path('~/.hue')))
+      json['username']
+    rescue
+      return nil
     end
 
-    if error = response['error']
-      raise get_error(error)
+    def validate_user
+      response = JSON(Net::HTTP.get(URI.parse("http://#{bridge.ip}/api/#{@username}")))
+
+      if response.is_a? Array
+        response = response.first
+      end
+
+      if error = response['error']
+        raise get_error(error)
+      end
+
+      response['success']
     end
 
-    response['success']
-  end
+    def register_user
+      body = JSON.dump({
+        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']
+        raise get_error(error)
+      end
 
-  def register_user
-    body = JSON.dump({
-      devicetype: 'Ruby',
-      username: @username
-    })
+      if @username = response['success']['username']
+        File.write(File.expand_path('~/.hue'), JSON.dump({username: @username}))
+      end
+    end
 
-    uri = URI.parse("http://#{bridge.ip}/api")
-    http = Net::HTTP.new(uri.host)
-    response = JSON(http.request_post(uri.path, body).body).first
+    def find_bridge_id
+      return ENV['HUE_BRIDGE_ID'] if ENV['HUE_BRIDGE_ID']
 
-    if error = response['error']
-      raise get_error(error)
+      json = JSON(File.read(File.expand_path('~/.hue')))
+      json['bridge_id']
+    rescue
+      return nil
     end
 
-    response['success']
-  end
+    def discovery_mdns(bs)
+      resolver = Resolv::MDNS.new
+      resolver.timeouts = 10
 
-  def get_error(error)
-    # Find error class and return instance
-    klass = Hue::ERROR_MAP[error['type']] || UnknownError unless klass
-    klass.new(error['description'])
-  end
+      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)
+      easy = Curl::Easy.new
+      easy.follow_location = true
+      easy.max_redirects = 10
+      easy.url = 'https://discovery.meethue.com/'
+      easy.perform
+      JSON(easy.body).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'])
+    end
   end
 end

data/lib/hue/light.rb

@@ -19,16 +19,16 @@ module Hue
 
     # Hue of the light. This is a wrapping value between 0 and 65535.
     # Both 0 and 65535 are red, 25500 is green and 46920 is blue.
-    attr_accessor :hue
+    attr_reader :hue
 
     # Saturation of the light. 255 is the most saturated (colored)
     # and 0 is the least saturated (white).
-    attr_accessor :saturation
+    attr_reader :saturation
 
     # Brightness of the light. This is a scale from the minimum
     # brightness the light is capable of, 0, to the maximum capable
     # brightness, 255. Note a brightness of 0 is not off.
-    attr_accessor :brightness
+    attr_reader :brightness
 
     # The x coordinate of a color in CIE color space. Between 0 and 1.
     #
@@ -44,7 +44,7 @@ module Hue
     # are capable of 153 (6500K) to 500 (2000K).
     #
     # @see http://en.wikipedia.org/wiki/Mired
-    attr_accessor :color_temperature
+    attr_reader :color_temperature
 
     # The alert effect, which is a temporary change to the bulb’s state.
     # This can take one of the following values:
@@ -58,12 +58,12 @@ module Hue
     # current state in an upcoming patch.
     #
     # @see http://developers.meethue.com/coreconcepts.html#some_extra_fun_stuff
-    attr_accessor :alert
+    attr_reader :alert
 
     # The dynamic effect of the light, can either be `none` or
     # `colorloop`. If set to colorloop, the light will cycle through
     # all hues using the current brightness and saturation settings.
-    attr_accessor :effect
+    attr_reader :effect
 
     # Indicates the color mode in which the light is working, this is
     # the last command type it received. Values are `hs` for Hue and

data/lib/hue/version.rb

@@ -1,3 +1,3 @@
 module Hue
-  VERSION = '0.1.5'
+  VERSION = '0.3.0'
 end

data/test/hue/client_test.rb

@@ -0,0 +1,25 @@
+require 'test_helper'
+
+class ClientTest < Minitest::Test
+  def before_setup
+    super
+
+    stub_request(:get, "https://discovery.meethue.com/").
+      to_return(:body => '[{"id":"ffa57b3b257200065704","internalipaddress":"192.168.0.1"},{"id":"63c2fc01391276a319f9","internalipaddress":"192.168.0.2"}]')
+
+    stub_request(:get, %r{http://192.168.0.1/api/*}).to_return(:body => '[{"success":true}]')
+    stub_request(:get, %r{http://192.168.0.2/api/*}).to_return(:body => '[{"success":true}]')
+  end
+
+  def test_with_bridge_id
+    client = Hue::Client.new(use_mdns: false)
+    client.stub :find_bridge_id, '63c2fc01391276a319f9' do
+      assert_equal '63c2fc01391276a319f9', client.bridge.id
+    end
+  end
+
+  def test_without_bridge_id
+    client = Hue::Client.new(use_mdns: false)
+    assert_equal 'ffa57b3b257200065704', client.bridge.id
+  end
+end

data/test/hue/light_test.rb

@@ -0,0 +1,24 @@
+require 'test_helper'
+
+class LightTest < Minitest::Test
+  def before_setup
+    super
+
+    stub_request(:get, "https://discovery.meethue.com/").
+      to_return(:body => '[{"internalipaddress":"localhost"}]')
+
+    stub_request(:get, %r{http://localhost/api/*}).to_return(:body => '[{"success":true}]')
+    stub_request(:post, 'http://localhost/api').to_return(:body => '[{"success":{"username":"ruby"}}]')
+    stub_request(:put, %r{http://localhost/api*}).to_return(:body => '[{}]')
+  end
+
+  %w{on hue saturation brightness color_temperature alert effect}.each do |attribute|
+    define_method "test_setting_#{attribute}" do
+      client = Hue::Client.new(use_mdns: false)
+      light = Hue::Light.new(client, client.bridge, 0, {"state" => {}})
+
+      light.send("#{attribute}=", 24)
+      assert_requested :put, %r{http://localhost/api/.*/lights/0}
+    end
+  end
+end

data/test/test_helper.rb

@@ -0,0 +1,6 @@
+$LOAD_PATH.unshift File.expand_path('../../lib', __FILE__)
+require 'hue'
+
+require 'minitest'
+require 'webmock/minitest'
+require 'minitest/autorun'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: hue
 version: !ruby/object:Gem::Version
-  version: 0.1.5
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Soffes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2015-03-27 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -66,6 +66,34 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Work with Philips Hue light bulbs.
 email:
 - sam@soff.es
@@ -74,13 +102,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- Contributing.markdown
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
-- Readme.markdown
-- Todo.markdown
 - bin/hue
 - hue.gemspec
 - lib/hue.rb
@@ -94,11 +121,14 @@ files:
 - lib/hue/scene.rb
 - lib/hue/translate_keys.rb
 - lib/hue/version.rb
+- test/hue/client_test.rb
+- test/hue/light_test.rb
+- test/test_helper.rb
 homepage: https://github.com/soffes/hue
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -106,16 +136,18 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: 1.9.3
+      version: 2.1.0
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.4.5
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: Work with Philips Hue light bulbs from Ruby.
-test_files: []
+test_files:
+- test/hue/client_test.rb
+- test/hue/light_test.rb
+- test/test_helper.rb

data/Contributing.markdown

@@ -1,19 +0,0 @@
-## Submitting a Pull Request
-
-1. [Fork the repository.][fork]
-2. [Create a topic branch.][branch]
-3. Add tests for your unimplemented feature or bug fix.
-4. Run `bundle exec rake`. If your tests pass, return to step 3.
-5. Implement your feature or bug fix.
-6. Run `bundle exec rake`. If your tests fail, return to step 5.
-7. Run `open coverage/index.html`. If your changes are not completely covered
-   by your tests, return to step 3.
-8. Add documentation for your feature or bug fix.
-9. Run `bundle exec rake doc`. If your changes are not 100% documented, go
-   back to step 8.
-10. Add, commit, and push your changes.
-11. [Submit a pull request.][pr]
-
-[fork]: http://help.github.com/fork-a-repo/
-[branch]: http://learn.github.com/p/branching.html
-[pr]: http://help.github.com/send-pull-requests/

data/Todo.markdown

@@ -1,8 +0,0 @@
-# To Do
-
-* RGB translation
-* Hex translation
-* Scheduling
-* Effects
-* User management
-* Configuration