huebot 0.4.0 → 1.0.0

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

@@ -1,51 +1,65 @@
 module Huebot
   class DeviceMapper
-    Unmapped = Class.new(StandardError)
+    Unmapped = Class.new(Error)
 
-    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 }
       @groups_by_id = all_groups.reduce({}) { |a, g| a[g.id] = g; a }
       @groups_by_name = all_groups.reduce({}) { |a, g| a[g.name] = g; a }
-      @devices_by_var = inputs.each_with_index.reduce({}) { |a, (x, idx)|
-        dev = case x
-              when LightInput then @lights_by_id[x.val] || @lights_by_name[x.val]
-              when GroupInput then @groups_by_id[x.val] || @groups_by_name[x.val]
-              else raise "Invalid input: #{x}"
-              end || raise(Unmapped, "Could not find #{x.class.name[8..-6].downcase} with id or name '#{x.val}'")
-        a["$#{idx + 1}"] = dev
-        a
+      @devices_by_var = inputs.each_with_index.each_with_object({}) { |(x, idx), obj|
+        obj[idx + 1] =
+          case x
+          when Light::Input then @lights_by_id[x.val.to_i] || @lights_by_name[x.val]
+          when Group::Input then @groups_by_id[x.val.to_i] || @groups_by_name[x.val]
+          else raise Error, "Invalid input: #{x}"
+          end || raise(Unmapped, "Could not find #{x.class.name[8..-6].downcase} with id or name '#{x.val}'")
       }
       @all = @devices_by_var.values
     end
 
+    def each
+      if block_given?
+        @all.each { |device| yield device }
+      else
+        @all.each
+      end
+    end
+
     def light!(id)
-      case id
-      when Integer
-        @lights_by_id[id]
-      when String
-        @lights_by_name[id]
-      end || (raise Unmapped, "Unmapped light '#{id}'")
+      @lights_by_id[id] || @lights_by_name[id] || (raise Unmapped, "Unmapped light '#{id}'")
     end
 
     def group!(id)
-      case id
-      when Integer
-        @groups_by_id[id]
-      when String
-        @groups_by_name[id]
-      end || (raise Unmapped, "Unmapped group '#{id}'")
+      @groups_by_id[id] || @groups_by_name[id] || (raise Unmapped, "Unmapped group '#{id}'")
     end
 
     def var!(id)
       case id
-      when "$all"
+      when :all
         @all
       else
-        @devices_by_var[id]
-      end || (raise Unmapped, "Unmapped device '#{id}'")
+        @devices_by_var[id] || (raise Unmapped, "Unmapped device '#{id}'")
+      end
+    end
+
+    def missing_lights(names)
+      names - @lights_by_name.keys
+    end
+
+    def missing_groups(names)
+      names - @groups_by_name.keys
+    end
+
+    def missing_vars(vars)
+      missing = vars - @devices_by_var.keys
+      if @all.any?
+        missing - [:all]
+      else
+        missing
+      end
     end
   end
 end

data/lib/huebot/device_state.rb

@@ -0,0 +1,11 @@
+module Huebot
+  module DeviceState
+    def set_state(state)
+      client.put!(state_change_url, state)
+    end
+
+    def get_state
+      client.get!(url).fetch("state")
+    end
+  end
+end

data/lib/huebot/group.rb

@@ -0,0 +1,30 @@
+module Huebot
+  class Group
+    #
+    # Struct for specifying a Group input (id or name)
+    #
+    # @attr val [Integer|String] id or name
+    #
+    Input = Struct.new(:val)
+
+    include DeviceState
+    attr_reader :client, :id, :name
+
+    def initialize(client, id, attrs)
+      @client = client
+      @id = id.to_i
+      @name = attrs.fetch("name")
+      @attrs = attrs
+    end
+
+    private
+
+    def state_change_url
+      url "/action"
+    end
+
+    def url(path = "")
+      "/groups/#{id}#{path}"
+    end
+  end
+end

data/lib/huebot/light.rb

@@ -0,0 +1,30 @@
+module Huebot
+  class Light
+    #
+    # Struct for specifying a Light input (id or name)
+    #
+    # @attr val [Integer|String] id or name
+    #
+    Input = Struct.new(:val)
+
+    include DeviceState
+    attr_reader :client, :id, :name
+
+    def initialize(client, id, attrs)
+      @client = client
+      @id = id.to_i
+      @name = attrs.fetch("name")
+      @attrs = attrs
+    end
+
+    private
+
+    def state_change_url
+      url "/state"
+    end
+
+    def url(path = "")
+      "/lights/#{id}#{path}"
+    end
+  end
+end

data/lib/huebot/program.rb

@@ -1,32 +1,82 @@
 module Huebot
   class Program
-    Transition = Struct.new(:wait, :state, :devices)
-    ParallelTransition = Struct.new(:wait, :children)
+    #
+    # Struct for storing a program's Intermediate Representation and source filepath.
+    #
+    # @attr tokens [Hash]
+    # @attr filepath [String]
+    # @attr api_version [Float] API version
+    #
+    Src = Struct.new(:tokens, :filepath, :api_version) do
+      def default_name
+        File.basename(filepath, ".*")
+      end
+    end
 
-    attr_accessor :name
-    attr_accessor :initial_state
-    attr_accessor :transitions
-    attr_accessor :final_state
-    attr_accessor :loop
-    attr_accessor :loops
-    attr_accessor :errors
-    attr_accessor :warnings
-
-    def initialize
-      @name = nil
-      @initial_state = nil
-      @transitions = []
-      @final_state = nil
-      @loop = false
-      @loops = 0
-      @errors = []
-      @warnings = []
+    module AST
+      Node = Struct.new(:instruction, :children, :errors, :warnings)
+
+      Transition = Struct.new(:state, :devices, :sleep)
+      SerialControl = Struct.new(:loop, :sleep)
+      ParallelControl = Struct.new(:loop, :sleep)
+
+      InfiniteLoop = Struct.new(:pause)
+      CountedLoop = Struct.new(:n, :pause)
+      TimerLoop = Struct.new(:hours, :minutes, :pause)
+      DeadlineLoop = Struct.new(:stop_time, :pause)
+
+      DeviceRef = Struct.new(:ref)
+      Light = Struct.new(:name)
+      Group = Struct.new(:name)
+      NoOp = Struct.new(:x)
     end
 
+    attr_accessor :name
+    attr_accessor :api_version
+    attr_accessor :data
+
     def valid?
       errors.empty?
     end
 
-    alias_method :loop?, :loop
+    # Returns all light names hard-coded into the program
+    def light_names(node = data)
+      devices(AST::Light).uniq.map(&:name)
+    end
+
+    # Returns all group names hard-coded into the program
+    def group_names(node = data)
+      devices(AST::Group).uniq.map(&:name)
+    end
+
+    # Returns all device refs (e.g. $all, $1, $2) in the program
+    def device_refs(node = data)
+      devices(AST::DeviceRef).uniq.map(&:ref)
+    end
+
+    def errors(node = data)
+      node.children.reduce(node.errors) { |errors, child|
+        errors + child.errors
+      }
+    end
+
+    def warnings(node = data)
+      node.children.reduce(node.warnings) { |warnings, child|
+        warnings + child.warnings
+      }
+    end
+
+    private
+
+    def devices(type, node = data)
+      case node.instruction
+      when AST::Transition
+        node.instruction.devices.select { |d| d.is_a? type }
+      when AST::SerialControl, AST::ParallelControl
+        node.children.map { |n| devices type, n }.flatten
+      else
+        []
+      end
+    end
   end
 end

data/lib/huebot/version.rb

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

data/lib/huebot.rb

@@ -1,31 +1,16 @@
-require 'hue'
-
 module Huebot
+  Error = Class.new(StandardError)
+
+  autoload :Config, 'huebot/config'
+  autoload :Client, 'huebot/client'
+  autoload :CLI, 'huebot/cli'
+  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'
   autoload :Bot, 'huebot/bot'
   autoload :VERSION, 'huebot/version'
-
-  #
-  # Struct for storing a program's Intermediate Representation and source filepath.
-  #
-  # @attr ir [Hash]
-  # @attr filepath [String]
-  #
-  ProgramSrc = Struct.new(:ir, :filepath)
-
-  #
-  # Struct for specifying a Light input (id or name)
-  #
-  # @attr val [Integer|String] id or name
-  #
-  LightInput = Struct.new(:val)
-
-  #
-  # Struct for specifying a Group input (id or name)
-  #
-  # @attr val [Integer|String] id or name
-  #
-  GroupInput = Struct.new(:val)
 end

metadata

@@ -1,15 +1,43 @@
 --- !ruby/object:Gem::Specification
 name: huebot
 version: !ruby/object:Gem::Version
-  version: 0.4.0
+  version: 1.0.0
 platform: ruby
 authors:
 - Jordan Hollinger
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2021-12-17 00:00:00.000000000 Z
-dependencies: []
+date: 2023-12-18 00:00:00.000000000 Z
+dependencies:
+- !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: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '13.0'
 description: Declare and run YAML programs for Philips Hue devices
 email: jordan.hollinger@gmail.com
 executables:
@@ -19,29 +47,27 @@ 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/cli/helpers.rb
+- lib/huebot/cli/runner.rb
+- lib/huebot/client.rb
 - lib/huebot/compiler.rb
+- lib/huebot/compiler/api_v1.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 +82,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.

data/lib/hue/bridge.rb

@@ -1,140 +0,0 @@
-module Hue
-  class Bridge
-    # ID of the bridge.
-    attr_reader :id
-
-    # Name of the bridge. This is also its uPnP name, so will reflect the
-    # actual uPnP name after any conflicts have been resolved.
-    attr_accessor :name
-
-    # IP address of the bridge.
-    attr_reader :ip
-
-    # MAC address of the bridge.
-    attr_reader :mac_address
-
-    # IP Address of the proxy server being used.
-    attr_reader :proxy_address
-
-    # Port of the proxy being used by the bridge. If set to 0 then a proxy is
-    # not being used.
-    attr_reader :proxy_port
-
-    # Software version of the bridge.
-    attr_reader :software_version
-
-    # Contains information related to software updates.
-    attr_reader :software_update
-
-    # An array of whitelisted user IDs.
-    attr_reader :ip_whitelist
-
-    # Network mask of the bridge.
-    attr_reader :network_mask
-
-    # Gateway IP address of the bridge.
-    attr_reader :gateway
-
-    # Whether the IP address of the bridge is obtained with DHCP.
-    attr_reader :dhcp
-
-    def initialize(client, hash)
-      @client = client
-      unpack(hash)
-    end
-
-    # Current time stored on the bridge.
-    def utc
-      json = get_configuration
-      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']
-    end
-
-    # This indicates whether the bridge is registered to synchronize data with a
-    # portal account.
-    def has_portal_services?
-      json = get_configuration
-      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|
-          Light.new(@client, self, key, value)
-        end
-      end
-    end
-
-    def add_lights
-      uri = URI.parse("#{base_url}/lights")
-      http = Net::HTTP.new(uri.host)
-      response = http.request_post(uri.path, nil)
-      (response.body).first
-    end
-
-    def groups
-      @groups ||= begin
-        json = JSON(Net::HTTP.get(URI.parse("#{base_url}/groups")))
-        json.map do |id, data|
-          Group.new(@client, self, id, data)
-        end
-      end
-    end
-
-    def scenes
-      @scenes ||= begin
-        json = JSON(Net::HTTP.get(URI.parse("#{base_url}/scenes")))
-        json.map do |id, data|
-          Scene.new(@client, self, id, data)
-        end
-      end
-    end
-
-  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,
-    }
-
-    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)
-      end
-    end
-
-    def get_configuration
-      JSON(Net::HTTP.get(URI.parse("#{base_url}/config")))
-    end
-
-    def base_url
-      "http://#{ip}/api/#{@client.username}"
-    end
-  end
-end