huebot 0.4.0 → 0.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 267bb3cc14e143785af2250a762b365f513bb18a3630b68edf10d3df3748de2a
-  data.tar.gz: 7afa69b3aa54a936deebbcea75b409f2411fa5482554b22cd29aff088ce351b6
+  metadata.gz: b919267fa7949b2e208ca3b62112c21f05aa1cb9e52a1cb175ab32a96e2b3411
+  data.tar.gz: 8ba14d33785521841fe31daff20786b6ead22592d15e3938b7b518202411b888
 SHA512:
-  metadata.gz: 442d3fb05c7f1e6610437ff5fc2f92d25694e2e9342ff9b16217ba80b7982538d48f807304e487fd583385864e9f4cf86491e33d2c66ba663b22449867ba780c
-  data.tar.gz: '01908c65fb9c472271904973e313bc080eb96d91b557ef2e8bb3902a5ea054f7fb71b3b37bf6f51f356bf742c5ab32a336e4c013059a0a537dc3a538955dfc97'
+  metadata.gz: 462cf2419a33689160a4471157b07302ab3fbbc48341903dde3d1c520f4cfc72a21fe6f1dc83262251270c692ad991aa04b666229f30b7218dc70d98f20ec398
+  data.tar.gz: 04c0e7d1fec4c384ceab06e022442ca90f9fefafbe0b15df9d6e3d8fd9db291ab16eca3af13e1db1edf0b8ea902e9d9e89bc36cdaa072e72fa956152db617c63

data/README.md

@@ -1,6 +1,6 @@
 # Huebot
 
-Orchestration and automation for Philips Hue devices. Huebot can be used as a Ruby library or a command line utility. Huebot programs are declared as YAML files.
+Program your Hue lights in YAML!
 
     $ huebot run dimmer.yml --light="Office Desk"
 
@@ -34,17 +34,18 @@ The variable `$all` refers to all lights and/or groups passed in on the command
 
     gem install huebot
 
-## License
+Having trouble with Hue Bridge auto discovery? Me too. If you know your bridge's IP (and ideally have assigned it a static one), you can set it manually:
 
-Huebot is licensed under the MIT license (see LICENSE file).
+    huebot set-ip <your bridge's IP>
 
-A patched version of the "hue" gem is bundled in huebot's codebase (to remove a dependency that's unnecessarily annoying to install). The license for it can be found at `lib/hue/LICENSE`.
+Configuration is stored in `~/.config/huebot`.
 
-## UNDER ACTIVE DEVELOPMENT
+## License
+
+Huebot is licensed under the MIT license (see LICENSE file).
 
 **TODO**
 
 * Validate number of inputs against compiled programs
-* Brief explanation various features
-* Wiki entry with more examples
-* Link to official Hue docs
+* More explanation various features in Wiki
+* More examples in Wiki

data/bin/huebot

@@ -9,15 +9,25 @@ require 'huebot/cli'
 Huebot::CLI.tap { |cli|
   case cli.get_cmd
   when :ls
-    client = Hue::Client.new
-    puts "Lights\n" + client.lights.map { |l| "  #{l.id}: #{l.name}" }.join("\n") + \
-      "\nGroups\n" + client.groups.map { |g| "  #{g.id}: #{g.name}" }.join("\n")
+    bridge, error = Huebot::Bridge.connect
+    if error
+      $stderr.puts error
+      exit 1
+    end
+
+    puts "Lights\n" + bridge.lights.map { |l| "  #{l.id}: #{l.name}" }.join("\n") + \
+      "\nGroups\n" + bridge.groups.map { |g| "  #{g.id}: #{g.name}" }.join("\n")
 
   when :run
     opts, sources = cli.get_input!
 
-    client = Hue::Client.new
-    device_mapper = Huebot::DeviceMapper.new(client, opts.inputs)
+    bridge, error = Huebot::Bridge.connect
+    if error
+      $stderr.puts error
+      exit 1
+    end
+
+    device_mapper = Huebot::DeviceMapper.new(bridge, opts.inputs)
     compiler = Huebot::Compiler.new(device_mapper)
 
     programs = sources.map { |src|
@@ -26,14 +36,19 @@ Huebot::CLI.tap { |cli|
     found_errors, _found_warnings = cli.check! programs, $stderr
     exit 1 if found_errors
 
-    bot = Huebot::Bot.new(client)
+    bot = Huebot::Bot.new(bridge)
     programs.each { |prog| bot.execute prog }
 
   when :check
     opts, sources = cli.get_input!
 
-    client = Hue::Client.new
-    device_mapper = Huebot::DeviceMapper.new(client, opts.inputs)
+    bridge, error = Huebot::Bridge.connect
+    if error
+      $stderr.puts error
+      exit 1
+    end
+
+    device_mapper = Huebot::DeviceMapper.new(bridge, opts.inputs)
     compiler = Huebot::Compiler.new(device_mapper)
 
     programs = sources.map { |src|
@@ -43,6 +58,21 @@ Huebot::CLI.tap { |cli|
     # TODO validate NUMBER of inputs against each program
     exit (found_errors || found_warnings) ? 1 : 0
 
+  when :"set-ip"
+    ip = cli.get_args(num: 1).first
+    config = Huebot::Config.new
+    config["ip"] = ip
+
+  when :"clear-ip"
+    cli.get_args(num: 0)
+    config = Huebot::Config.new
+    config["ip"] = nil
+
+  when :unregister
+    cli.get_args(num: 0)
+    config = Huebot::Config.new
+    config.clear
+
   else cli.help!
   end
 }

data/lib/huebot/bridge.rb

@@ -0,0 +1,24 @@
+module Huebot
+  class Bridge
+    def self.connect(config = Huebot::Config.new)
+      client = Client.new(config)
+      error = client.connect
+      return nil, error if error
+      return new(client)
+    end
+
+    attr_reader :client
+
+    def initialize(client)
+      @client = client
+    end
+
+    def lights
+      client.get!("/lights").map { |(id, attrs)| Light.new(client, id, attrs) }
+    end
+
+    def groups
+      client.get!("/groups").map { |(id, attrs)| Group.new(client, id, attrs) }
+    end
+  end
+end

data/lib/huebot/cli.rb

@@ -23,6 +23,31 @@ module Huebot
       ARGV[0].to_s.to_sym
     end
 
+    def self.get_args(min: nil, max: nil, num: nil)
+      args = ARGV[1..]
+      if num
+        if num != args.size
+          $stderr.puts "Expected #{num} args, found #{args.size}"
+          exit 1
+        end
+      elsif min and max
+        if args.size < min or args.size > max
+          $stderr.puts "Expected #{min}-#{max} args, found #{args.size}"
+        end
+      elsif min
+        if args.size < min
+          $stderr.puts "Expected at least #{num} args, found #{args.size}"
+          exit 1
+        end
+      elsif max
+        if args.size > max
+          $stderr.puts "Expected no more than #{num} args, found #{args.size}"
+          exit 1
+        end
+      end
+      args
+    end
+
     #
     # Parses and returns input from the CLI. Serious errors might result in the program exiting.
     #
@@ -37,7 +62,7 @@ module Huebot
       if files.empty? and !options.read_stdin
         puts parser.help
         exit 1
-      elsif (bad_paths = files.select { |p| !File.exists? p }).any?
+      elsif (bad_paths = files.select { |p| !File.exist? p }).any?
         $stderr.puts "Cannot find #{bad_paths.join ', '}"
         exit 1
       else
@@ -107,6 +132,13 @@ Run program(s):
 Validate programs and inputs:
     huebot check file1.yml [file2.yml [file3.yml ...]] [options]
 
+Manually set/clear the IP for your Hue Bridge (useful when on a VPN):
+    huebot set-ip 192.168.1.20
+    huebot clear-ip
+
+Clear all connection config:
+  huebot unregister
+
 Options:
         ).strip
         opts.on("-lLIGHT", "--light=LIGHT", "Light ID or name") { |l| options.inputs << LightInput.new(l) }

data/lib/huebot/client.rb

@@ -0,0 +1,131 @@
+require 'uri'
+require 'net/http'
+require 'json'
+
+module Huebot
+  class Client
+    DISCOVERY_URI = URI(ENV["HUE_DISCOVERY_API"] || "https://discovery.meethue.com/")
+    Bridge = Struct.new(:id, :ip)
+
+    attr_reader :config
+
+    def initialize(config = Huebot::Config.new)
+      @config = config
+      @ip = config["ip"] # NOTE will usually be null
+      @username = nil
+    end
+
+    def connect
+      if config["ip"]
+        @ip = config["ip"]
+      elsif config["id"]
+        @ip = bridges.detect { |b| b.id == id }&.ip
+        return "Unable to find Hue Bridge '#{config["id"]}' on your network" if @ip.nil?
+      else
+        bridge = bridges.first
+        return "Unable to find a Hue Bridge on your network" if bridge.nil?
+        config["id"] = bridge.id
+        @ip = bridge.ip
+      end
+
+      if config["username"]
+        if valid_username? config["username"]
+          @username = config["username"]
+        else
+          return "Invalid Hue Bridge username '#{config["username"]}'"
+        end
+      else
+        username, error = register
+        return error if error
+        config["username"] = @username = username
+      end
+      nil
+    end
+
+    def get!(path)
+      resp, error = get path
+      raise error if error
+      resp
+    end
+
+    def get(path)
+      url = "http://#{@ip}/api"
+      url << "/#{@username}" if @username
+      url << path
+      req = Net::HTTP::Get.new(URI(url))
+      req_json req
+    end
+
+    def post!(path, body)
+      resp, error = post path, body
+      raise error if error
+      resp
+    end
+
+    def post(path, body)
+      url = "http://#{@ip}/api"
+      url << "/#{@username}" if @username
+      url << path
+      req = Net::HTTP::Post.new(URI(url))
+      req["Content-Type"] = "application/json"
+      req.body = body.to_json
+      req_json req
+    end
+
+    def put!(path, body)
+      resp, error = put path, body
+      raise error if error
+      resp
+    end
+
+    def put(path, body)
+      url = "http://#{@ip}/api"
+      url << "/#{@username}" if @username
+      url << path
+      req = Net::HTTP::Put.new(URI(url))
+      req["Content-Type"] = "application/json"
+      req.body = body.to_json
+      req_json req
+    end
+
+    def req_json(req)
+      resp = Net::HTTP.start req.uri.host, req.uri.port, {use_ssl: false} do |http|
+        http.request req
+      end
+      case resp.code.to_i
+      when 200..201
+        data = JSON.parse(resp.body)
+        if data[0] and (error = data[0]["error"])
+          return nil, error.fetch("description")
+        else
+          return data, nil
+        end
+      else
+        raise "Unexpected response from Bridge (#{resp.code}): #{resp.body}"
+      end
+    end
+
+    def bridges
+      req = Net::HTTP::Get.new(DISCOVERY_URI)
+      resp = Net::HTTP.start req.uri.host, req.uri.port, {use_ssl: true} do |http|
+        http.request req
+      end
+      JSON.parse(resp.body).map { |x|
+        Bridge.new(x.fetch("id"), x.fetch("internalipaddress"))
+      }
+    end
+
+    private
+
+    def valid_username?(username)
+      _resp, error = get("/#{username}")
+      !error
+    end
+
+    def register
+      resp, error = post "/", {"devicetype": "huebot"}
+      return nil, error if error
+      resp[0].fetch("success").fetch("username")
+    end
+  end
+end

data/lib/huebot/compiler.rb

@@ -1,5 +1,7 @@
 module Huebot
   class Compiler
+    DEVICE_FIELDS = %i(light lights group groups device devices).freeze
+
     def initialize(device_mapper)
       @device_mapper = device_mapper
     end
@@ -130,9 +132,9 @@ module Huebot
       end
       state[:transitiontime] = t.delete("time") || t.delete(:time) || t.delete("transitiontime") || t.delete(:transitiontime) || 4
 
-      transition.state = t.merge(state).reduce({}) { |a, (key, val)|
-        a[key.to_sym] = val
-        a
+      transition.state = t.merge(state).each_with_object({}) { |(key, val), obj|
+        key = key.to_sym
+        obj[key] = val unless DEVICE_FIELDS.include? key
       }
       return errors, warnings, transition
     end

data/lib/huebot/config.rb

@@ -0,0 +1,41 @@
+require 'fileutils'
+require 'yaml'
+
+module Huebot
+  class Config
+    def initialize(path = "~/.config/huebot")
+      @path = File.expand_path(path)
+      @dir = File.dirname(@path)
+      @dir_exists = File.exist? @dir
+      @config = File.exist?(@path) ? YAML.load_file(@path) : {}
+    end
+
+    def [](attr)
+      @config[attr.to_s]
+    end
+
+    def []=(attr, val)
+      if val.nil?
+        @config.delete(attr.to_s)
+      else
+        @config[attr.to_s] = val
+      end
+      write
+    end
+
+    def clear
+      @config.clear
+      write
+    end
+
+    private
+
+    def write
+      unless @dir_exists
+        FileUtils.mkdir_p @dir
+        @dir_exists = true
+      end
+      File.write(@path, YAML.dump(@config))
+    end
+  end
+end

data/lib/huebot/device_mapper.rb

@@ -2,8 +2,8 @@ module Huebot
   class DeviceMapper
     Unmapped = Class.new(StandardError)
 
-    def initialize(client, inputs = [])
-      all_lights, all_groups = client.lights, client.groups
+    def initialize(bridge, inputs = [])
+      all_lights, all_groups = bridge.lights, bridge.groups
 
       @lights_by_id = all_lights.reduce({}) { |a, l| a[l.id] = l; a }
       @lights_by_name = all_lights.reduce({}) { |a, l| a[l.name] = l; a }

data/lib/huebot/device_state.rb

@@ -0,0 +1,7 @@
+module Huebot
+  module DeviceState
+    def set_state(state)
+      client.put!(state_url, state)
+    end
+  end
+end

data/lib/huebot/group.rb

@@ -0,0 +1,23 @@
+module Huebot
+  class Group
+    include DeviceState
+    attr_reader :client, :id, :name
+
+    def initialize(client, id, attrs)
+      @client = client
+      @id = id
+      @name = attrs.fetch("name")
+      @attrs = attrs
+    end
+
+    private
+
+    def state_url
+      url "/action"
+    end
+
+    def url(path)
+      "/groups/#{id}#{path}"
+    end
+  end
+end

data/lib/huebot/light.rb

@@ -0,0 +1,23 @@
+module Huebot
+  class Light
+    include DeviceState
+    attr_reader :client, :id, :name
+
+    def initialize(client, id, attrs)
+      @client = client
+      @id = id
+      @name = attrs.fetch("name")
+      @attrs = attrs
+    end
+
+    private
+
+    def state_url
+      url "/state"
+    end
+
+    def url(path)
+      "/lights/#{id}#{path}"
+    end
+  end
+end

data/lib/huebot/version.rb

@@ -1,4 +1,4 @@
 module Huebot
   # Gem version
-  VERSION = '0.4.0'
+  VERSION = '0.5.0'
 end

data/lib/huebot.rb

@@ -1,6 +1,10 @@
-require 'hue'
-
 module Huebot
+  autoload :Config, 'huebot/config'
+  autoload :Client, 'huebot/client'
+  autoload :Bridge, 'huebot/bridge'
+  autoload :DeviceState, 'huebot/device_state'
+  autoload :Light, 'huebot/light'
+  autoload :Group, 'huebot/group'
   autoload :DeviceMapper, 'huebot/device_mapper'
   autoload :Program, 'huebot/program'
   autoload :Compiler, 'huebot/compiler'

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: huebot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 0.5.0
 platform: ruby
 authors:
 - Jordan Hollinger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
+date: 2023-12-08 00:00:00.000000000 Z
 dependencies: []
 description: Declare and run YAML programs for Philips Hue devices
 email: jordan.hollinger@gmail.com
@@ -19,29 +19,24 @@ extra_rdoc_files: []
 files:
 - README.md
 - bin/huebot
-- lib/hue.rb
-- lib/hue/LICENSE
-- lib/hue/bridge.rb
-- lib/hue/client.rb
-- lib/hue/editable_state.rb
-- lib/hue/errors.rb
-- lib/hue/group.rb
-- lib/hue/light.rb
-- lib/hue/scene.rb
-- lib/hue/translate_keys.rb
-- lib/hue/version.rb
 - lib/huebot.rb
 - lib/huebot/bot.rb
+- lib/huebot/bridge.rb
 - lib/huebot/cli.rb
+- lib/huebot/client.rb
 - lib/huebot/compiler.rb
+- lib/huebot/config.rb
 - lib/huebot/device_mapper.rb
+- lib/huebot/device_state.rb
+- lib/huebot/group.rb
+- lib/huebot/light.rb
 - lib/huebot/program.rb
 - lib/huebot/version.rb
 homepage: https://github.com/jhollinger/huebot
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -56,8 +51,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3.1
-signing_key: 
+rubygems_version: 3.4.1
+signing_key:
 specification_version: 4
 summary: Orchestration for Hue devices
 test_files: []

data/lib/hue/LICENSE

@@ -1,22 +0,0 @@
-Copyright (c) 2013-2014 Sam Soffes, http://soff.es
-
-MIT License
-
-Permission is hereby granted, free of charge, to any person obtaining
-a copy of this software and associated documentation files (the
-"Software"), to deal in the Software without restriction, including
-without limitation the rights to use, copy, modify, merge, publish,
-distribute, sublicense, and/or sell copies of the Software, and to
-permit persons to whom the Software is furnished to do so, subject to
-the following conditions:
-
-The above copyright notice and this permission notice shall be
-included in all copies or substantial portions of the Software.
-
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
-NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
-LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
-OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
-WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.