hue 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 06f9987573ff54e807b7cb86f72237c6ed8c825f
-  data.tar.gz: 1150180432174f58f9e19d4f9fa45cb8f98ddd99
+SHA256:
+  metadata.gz: af74df93c5514679bab0613c9c6c87b0a0dfae19b919fc903ad42a8fafe9b681
+  data.tar.gz: 0afb9bd5b7ee11be0a1dce6b56846c6d13fa7cd9a9b67e2f9c8014c8d03f0fb7
 SHA512:
-  metadata.gz: d5b848f3b17020b64327b235be4ef897b3c31d41aadb69b245b14ab8b0b7caa3a7b2e0469bd8cac8deb20cf1bfdaa67d27f52f5f7ec9e598d48b44f5e2a7a892
-  data.tar.gz: a01dcd6e0385d5b327c34fa308d6fd37381073b22270af0a692e498ef2f2172dab8a045e3d90f24fd0850d29f2684765705f44b3a2eb68c7202f902f3b5d9b49
+  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
 
@@ -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,10 @@
 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
+
+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,11 +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 'rspec', '~> 3.2.0'
+  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,15 +1,16 @@
 require 'net/http'
 require 'json'
+require 'resolv'
 require 'curb'
 
 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 +24,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 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
@@ -32,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
@@ -120,6 +119,42 @@ module Hue
       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
+      return 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)
+      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

data/lib/hue/version.rb

@@ -1,3 +1,3 @@
 module Hue
-  VERSION = '0.2.0'
+  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.2.0
+  version: 0.3.0
 platform: ruby
 authors:
 - Sam Soffes
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2016-04-05 00:00:00.000000000 Z
+date: 2024-01-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: thor
@@ -67,19 +67,19 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: rspec
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: 3.2.0
+        version: '5.0'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -102,14 +102,12 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/main.yml"
 - ".gitignore"
-- ".rspec"
-- Contributing.markdown
 - Gemfile
 - LICENSE
+- README.md
 - Rakefile
-- Readme.markdown
-- Todo.markdown
 - bin/hue
 - hue.gemspec
 - lib/hue.rb
@@ -123,13 +121,14 @@ files:
 - lib/hue/scene.rb
 - lib/hue/translate_keys.rb
 - lib/hue/version.rb
-- spec/hue/light_spec.rb
-- spec/spec_helper.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
@@ -137,18 +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.5.1
-signing_key: 
+rubygems_version: 3.4.22
+signing_key:
 specification_version: 4
 summary: Work with Philips Hue light bulbs from Ruby.
 test_files:
-- spec/hue/light_spec.rb
-- spec/spec_helper.rb
+- test/hue/client_test.rb
+- test/hue/light_test.rb
+- test/test_helper.rb

data/.rspec

@@ -1,2 +0,0 @@
---color
---require spec_helper

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

data/spec/hue/light_spec.rb

@@ -1,24 +0,0 @@
-RSpec.describe Hue::Light do
-  %w{on hue saturation brightness color_temperature alert effect}.each do |attribute|
-    before do
-      stub_request(:get, "https://www.meethue.com/api/nupnp").
-        to_return(:body => '[{"internalipaddress":"localhost"}]')
-
-      stub_request(:get, %r{http://localhost/api/*}).
-        to_return(:body => '[{"success":true}]')
-
-      stub_request(:put, %r{http://localhost/api*}).
-        to_return(:body => '[{}]')
-    end
-
-    describe "##{attribute}=" do
-      it "PUTs the new attribute value" do
-        client = Hue::Client.new
-        light = Hue::Light.new(client, client.bridge, 0, {"state" => {}})
-
-        light.send("#{attribute}=", 24)
-        expect(a_request(:put, %r{http://localhost/api/.*/lights/0})).to have_been_made
-      end
-    end
-  end
-end

data/spec/spec_helper.rb

@@ -1,94 +0,0 @@
-require_relative '../lib/hue'
-require 'webmock/rspec'
-
-# This file was generated by the `rspec --init` command. Conventionally, all
-# specs live under a `spec` directory, which RSpec adds to the `$LOAD_PATH`.
-# The generated `.rspec` file contains `--require spec_helper` which will cause
-# this file to always be loaded, without a need to explicitly require it in any
-# files.
-#
-# Given that it is always loaded, you are encouraged to keep this file as
-# light-weight as possible. Requiring heavyweight dependencies from this file
-# will add to the boot time of your test suite on EVERY test run, even for an
-# individual file that may not need all of that loaded. Instead, consider making
-# a separate helper file that requires the additional dependencies and performs
-# the additional setup, and require it from the spec files that actually need
-# it.
-#
-# The `.rspec` file also contains a few flags that are not defaults but that
-# users commonly want.
-#
-# See http://rubydoc.info/gems/rspec-core/RSpec/Core/Configuration
-RSpec.configure do |config|
-  # rspec-expectations config goes here. You can use an alternate
-  # assertion/expectation library such as wrong or the stdlib/minitest
-  # assertions if you prefer.
-  config.expect_with :rspec do |expectations|
-    # This option will default to `true` in RSpec 4. It makes the `description`
-    # and `failure_message` of custom matchers include text for helper methods
-    # defined using `chain`, e.g.:
-    #     be_bigger_than(2).and_smaller_than(4).description
-    #     # => "be bigger than 2 and smaller than 4"
-    # ...rather than:
-    #     # => "be bigger than 2"
-    expectations.include_chain_clauses_in_custom_matcher_descriptions = true
-  end
-
-  # rspec-mocks config goes here. You can use an alternate test double
-  # library (such as bogus or mocha) by changing the `mock_with` option here.
-  config.mock_with :rspec do |mocks|
-    # Prevents you from mocking or stubbing a method that does not exist on
-    # a real object. This is generally recommended, and will default to
-    # `true` in RSpec 4.
-    mocks.verify_partial_doubles = true
-  end
-
-# The settings below are suggested to provide a good initial experience
-# with RSpec, but feel free to customize to your heart's content.
-=begin
-  # These two settings work together to allow you to limit a spec run
-  # to individual examples or groups you care about by tagging them with
-  # `:focus` metadata. When nothing is tagged with `:focus`, all examples
-  # get run.
-  config.filter_run :focus
-  config.run_all_when_everything_filtered = true
-
-  # Limits the available syntax to the non-monkey patched syntax that is
-  # recommended. For more details, see:
-  #   - http://myronmars.to/n/dev-blog/2012/06/rspecs-new-expectation-syntax
-  #   - http://teaisaweso.me/blog/2013/05/27/rspecs-new-message-expectation-syntax/
-  #   - http://myronmars.to/n/dev-blog/2014/05/notable-changes-in-rspec-3#new__config_option_to_disable_rspeccore_monkey_patching
-  config.disable_monkey_patching!
-
-  # This setting enables warnings. It's recommended, but in some cases may
-  # be too noisy due to issues in dependencies.
-  config.warnings = true
-
-  # Many RSpec users commonly either run the entire suite or an individual
-  # file, and it's useful to allow more verbose output when running an
-  # individual spec file.
-  if config.files_to_run.one?
-    # Use the documentation formatter for detailed output,
-    # unless a formatter has already been configured
-    # (e.g. via a command-line flag).
-    config.default_formatter = 'doc'
-  end
-
-  # Print the 10 slowest examples and example groups at the
-  # end of the spec run, to help surface which specs are running
-  # particularly slow.
-  config.profile_examples = 10
-
-  # Run specs in random order to surface order dependencies. If you find an
-  # order dependency and want to debug it, you can fix the order by providing
-  # the seed, which is printed after each run.
-  #     --seed 1234
-  config.order = :random
-
-  # Seed global randomization in this process using the `--seed` CLI option.
-  # Setting this allows you to use `--seed` to deterministically reproduce
-  # test failures related to randomization by passing the same `--seed` value
-  # as the one that triggered the failure.
-  Kernel.srand config.seed
-=end
-end