huebot 0.3.0 → 0.5.0

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

data/lib/hue/client.rb

@@ -1,141 +0,0 @@
-require 'net/http'
-require 'json'
-
-module Hue
-  class Client
-    attr_reader :username
-
-    def initialize(username = nil)
-      @bridge_id = nil
-      @username = username || find_username
-
-      if @username
-        begin
-          validate_user
-        rescue Hue::UnauthorizedUser
-          register_user
-        end
-      else
-        register_user
-      end
-    end
-
-    def bridge
-      @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
-
-    # Patched by Jordan Hollinger to remove use of "curb" gem
-    # TODO handle redirects? That's what curb was used for.
-    def bridges
-      req = Net::HTTP::Get.new(URI("https://www.meethue.com/api/nupnp"))
-      resp = Net::HTTP.start req.uri.host, req.uri.port, {use_ssl: true} do |http|
-        http.request req
-      end
-
-      JSON(resp.body).lazy.map { |x|
-        Bridge.new(self, x)
-      }
-
-    rescue Net::OpenTimeout, Net::ReadTimeout, JSON::ParserError
-      []
-    end
-
-    def lights
-      bridge.lights
-    end
-
-    def add_lights
-      bridge.add_lights
-    end
-
-    def light(id)
-      id = id.to_s
-      lights.select { |l| l.id == id }.first
-    end
-
-    def groups
-      bridge.groups
-    end
-
-    def group(id = nil)
-      return Group.new(self, bridge) if id.nil?
-
-      id = id.to_s
-      groups.select { |g| g.id == id }.first
-    end
-
-    def scenes
-      bridge.scenes
-    end
-
-    def scene(id)
-      id = id.to_s
-      scenes.select { |s| s.id == id }.first
-    end
-
-    private
-
-    def find_username
-      return ENV['HUE_USERNAME'] if ENV['HUE_USERNAME']
-
-      json = JSON(File.read(File.expand_path('~/.hue')))
-      json['username']
-    rescue
-      return nil
-    end
-
-    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
-
-    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
-
-      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
-      return nil
-    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/editable_state.rb

@@ -1,27 +0,0 @@
-module Hue
-  module EditableState
-    def on?
-      @state['on']
-    end
-
-    def on!
-      self.on = true
-    end
-
-    def off!
-      self.on = false
-    end
-
-    %w{on hue saturation brightness color_temperature alert effect}.each do |key|
-      define_method "#{key}=".to_sym do |value|
-        set_state({key.to_sym => value})
-        instance_variable_set("@#{key}".to_sym, value)
-      end
-    end
-
-    def set_xy(x, y)
-      set_state({:xy => [x, y]})
-      @x, @y = x, y
-    end
-  end
-end

data/lib/hue/errors.rb

@@ -1,38 +0,0 @@
-module Hue
-  class Error < StandardError; end
-
-  class UnauthorizedUser < Error; end
-  class InvalidJSON < Error; end
-  class ResourceNotAvailable < Error; end
-  class MethodNotAvailable < Error; end
-  class MissingBody < Error; end
-  class ParameterNotAvailable < Error; end
-  class InvalidValueForParameter < Error; end
-  class ParameterNotModifiable < Error; end
-  class InternalError < Error; end
-  class LinkButtonNotPressed < Error; end
-  class ParameterNotModifiableWhileOff < ParameterNotModifiable; end
-  class TooManyGroups < Error; end
-  class GroupTooFull < Error; end
-
-  class InvalidUsername < Error; end
-  class UnknownError < Error; end
-  class NoBridgeFound < Error; end
-
-  # Status code to exception map
-  ERROR_MAP = {
-      1 => Hue::UnauthorizedUser,
-      2 => Hue::InvalidJSON,
-      3 => Hue::ResourceNotAvailable,
-      4 => Hue::MethodNotAvailable,
-      5 => Hue::MissingBody,
-      6 => Hue::ParameterNotAvailable,
-      7 => Hue::InvalidValueForParameter,
-      8 => Hue::ParameterNotModifiable,
-    901 => Hue::InternalError,
-    101 => Hue::LinkButtonNotPressed,
-    201 => Hue::ParameterNotModifiableWhileOff,
-    301 => Hue::TooManyGroups,
-    302 => Hue::GroupTooFull
-  }
-end

data/lib/hue/group.rb

@@ -1,181 +0,0 @@
-module Hue
-  class Group
-    include Enumerable
-    include TranslateKeys
-    include EditableState
-
-    # Unique identification number.
-    attr_reader :id
-
-    # Bridge the group is associated with
-    attr_reader :bridge
-
-    # A unique, editable name given to the group.
-    attr_accessor :name
-
-    # Hue of the group. 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
-
-    # Saturation of the group. 255 is the most saturated (colored)
-    # and 0 is the least saturated (white).
-    attr_accessor :saturation
-
-    # Brightness of the group. This is a scale from the minimum
-    # brightness the group is capable of, 0, to the maximum capable
-    # brightness, 255. Note a brightness of 0 is not off.
-    attr_accessor :brightness
-
-    # The x coordinate of a color in CIE color space. Between 0 and 1.
-    #
-    # @see http://developers.meethue.com/coreconcepts.html#color_gets_more_complicated
-    attr_reader :x
-
-    # The y coordinate of a color in CIE color space. Between 0 and 1.
-    #
-    # @see http://developers.meethue.com/coreconcepts.html#color_gets_more_complicated
-    attr_reader :y
-
-    # The Mired Color temperature of the light. 2012 connected lights
-    # are capable of 153 (6500K) to 500 (2000K).
-    #
-    # @see http://en.wikipedia.org/wiki/Mired
-    attr_accessor :color_temperature
-
-    # A fixed name describing the type of group.
-    attr_reader :type
-
-    def initialize(client, bridge, id = nil, data = {})
-      @client = client
-      @bridge = bridge
-      @id = id
-
-      unpack(data)
-    end
-
-    def each(&block)
-      lights.each(&block)
-    end
-
-    def lights
-      @lights ||= begin
-        @light_ids.map do |light_id|
-          @client.light(light_id)
-        end
-      end
-    end
-
-    def name=(name)
-      resp = set_group_state({:name => name})
-      @name = new? ? name : resp[0]['success']["/groups/#{id}/name"]
-    end
-
-    def lights=(light_ids)
-      light_ids.map! do |light_id|
-        light_id.is_a?(Light) ? light_id.id : light_id.to_s
-      end
-
-      @light_ids = light_ids.uniq
-      @lights = nil # resets the memoization
-
-      set_group_state({:lights => @light_ids})
-    end
-
-    def scene=(scene)
-      scene_id = scene.is_a?(Scene) ? scene.id : scene
-      set_group_state({:scene => scene_id})
-    end
-
-    def <<(light_id)
-      @light_ids << light_id
-      set_group_state({:lights => @light_ids})
-    end
-    alias_method :add_light, :<<
-
-    def set_group_state(attributes)
-      return if new?
-      body = translate_keys(attributes, GROUP_KEYS_MAP)
-
-      uri = URI.parse(base_url)
-      http = Net::HTTP.new(uri.host)
-      response = http.request_put(uri.path, JSON.dump(body))
-      JSON(response.body)
-    end
-
-    def set_state(attributes)
-      return if new?
-      body = translate_keys(attributes, STATE_KEYS_MAP)
-
-      uri = URI.parse("#{base_url}/action")
-      http = Net::HTTP.new(uri.host)
-      response = http.request_put(uri.path, JSON.dump(body))
-      JSON(response.body)
-    end
-
-    def refresh
-      json = JSON(Net::HTTP.get(URI.parse(base_url)))
-      unpack(json)
-      @lights = nil
-    end
-
-    def create!
-      body = {
-        :name => @name,
-        :lights => @light_ids,
-      }
-
-      uri = URI.parse("http://#{@bridge.ip}/api/#{@client.username}/groups")
-      http = Net::HTTP.new(uri.host)
-      response = http.request_post(uri.path, JSON.dump(body))
-      json = JSON(response.body)
-
-      @id = json[0]['success']['id']
-    end
-
-    def destroy!
-      uri = URI.parse(base_url)
-      http = Net::HTTP.new(uri.host)
-      response = http.delete(uri.path)
-      json = JSON(response.body)
-      @id = nil if json[0]['success']
-    end
-
-    def new?
-      @id.nil?
-    end
-
-    private
-
-    GROUP_KEYS_MAP = {
-      :name => :name,
-      :light_ids => :lights,
-      :type => :type,
-      :state => :action
-    }
-
-    STATE_KEYS_MAP = {
-      :on => :on,
-      :brightness => :bri,
-      :hue => :hue,
-      :saturation => :sat,
-      :xy => :xy,
-      :color_temperature => :ct,
-      :alert => :alert,
-      :effect => :effect,
-      :color_mode => :colormode,
-    }
-
-    def unpack(data)
-      unpack_hash(data, GROUP_KEYS_MAP)
-
-      unless new?
-        unpack_hash(@state, STATE_KEYS_MAP)
-        @x, @y = @state['xy']
-      end
-    end
-
-    def base_url
-      "http://#{@bridge.ip}/api/#{@client.username}/groups/#{id}"
-    end
-  end
-end

data/lib/hue/light.rb

@@ -1,177 +0,0 @@
-module Hue
-  class Light
-    include TranslateKeys
-    include EditableState
-
-    HUE_RANGE = 0..65535
-    SATURATION_RANGE = 0..255
-    BRIGHTNESS_RANGE = 0..255
-    COLOR_TEMPERATURE_RANGE = 153..500
-
-    # Unique identification number.
-    attr_reader :id
-
-    # Bridge the light is associated with
-    attr_reader :bridge
-
-    # A unique, editable name given to the light.
-    attr_accessor :name
-
-    # 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_reader :hue
-
-    # Saturation of the light. 255 is the most saturated (colored)
-    # and 0 is the least saturated (white).
-    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_reader :brightness
-
-    # The x coordinate of a color in CIE color space. Between 0 and 1.
-    #
-    # @see http://developers.meethue.com/coreconcepts.html#color_gets_more_complicated
-    attr_reader :x
-
-    # The y coordinate of a color in CIE color space. Between 0 and 1.
-    #
-    # @see http://developers.meethue.com/coreconcepts.html#color_gets_more_complicated
-    attr_reader :y
-
-    # The Mired Color temperature of the light. 2012 connected lights
-    # are capable of 153 (6500K) to 500 (2000K).
-    #
-    # @see http://en.wikipedia.org/wiki/Mired
-    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:
-    # * `none` – The light is not performing an alert effect.
-    # * `select` – The light is performing one breathe cycle.
-    # * `lselect` – The light is performing breathe cycles for 30 seconds
-    #     or until an "alert": "none" command is received.
-    #
-    # Note that in version 1.0 this contains the last alert sent to the
-    # light and not its current state. This will be changed to contain the
-    # current state in an upcoming patch.
-    #
-    # @see http://developers.meethue.com/coreconcepts.html#some_extra_fun_stuff
-    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_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
-    # Saturation, `xy` for XY and `ct` for Color Temperature. This
-    # parameter is only present when the light supports at least one
-    # of the values.
-    attr_reader :color_mode
-
-    # A fixed name describing the type of light.
-    attr_reader :type
-
-    # The hardware model of the light.
-    attr_reader :model
-
-    # An identifier for the software version running on the light.
-    attr_reader :software_version
-
-    # Reserved for future functionality.
-    attr_reader :point_symbol
-
-    def initialize(client, bridge, id, hash)
-      @client = client
-      @bridge = bridge
-      @id = id
-      unpack(hash)
-    end
-
-    def name=(new_name)
-      unless (1..32).include?(new_name.length)
-        raise InvalidValueForParameter, 'name must be between 1 and 32 characters.'
-      end
-
-      body = {
-        :name => new_name
-      }
-
-      uri = URI.parse(base_url)
-      http = Net::HTTP.new(uri.host)
-      response = http.request_put(uri.path, JSON.dump(body))
-      response = JSON(response.body).first
-      if response['success']
-        @name = new_name
-      # else
-        # TODO: Error
-      end
-    end
-
-    # Indicates if a light can be reached by the bridge. Currently
-    # always returns true, functionality will be added in a future
-    # patch.
-    def reachable?
-      @state['reachable']
-    end
-
-    # @param transition The duration of the transition from the light’s current
-    #   state to the new state. This is given as a multiple of 100ms and
-    #   defaults to 4 (400ms). For example, setting transistiontime:10 will
-    #   make the transition last 1 second.
-    def set_state(attributes, transition = nil)
-      body = translate_keys(attributes, STATE_KEYS_MAP)
-
-      # Add transition
-      body.merge!({:transitiontime => transition}) if transition
-
-      uri = URI.parse("#{base_url}/state")
-      http = Net::HTTP.new(uri.host)
-      response = http.request_put(uri.path, JSON.dump(body))
-      JSON(response.body)
-    end
-
-    # Refresh the state of the lamp
-    def refresh
-      json = JSON(Net::HTTP.get(URI.parse(base_url)))
-      unpack(json)
-    end
-
-  private
-
-    KEYS_MAP = {
-      :state => :state,
-      :type => :type,
-      :name => :name,
-      :model => :modelid,
-      :software_version => :swversion,
-      :point_symbol => :pointsymbol
-    }
-
-    STATE_KEYS_MAP = {
-      :on => :on,
-      :brightness => :bri,
-      :hue => :hue,
-      :saturation => :sat,
-      :xy => :xy,
-      :color_temperature => :ct,
-      :alert => :alert,
-      :effect => :effect,
-      :color_mode => :colormode,
-      :reachable => :reachable,
-    }
-
-    def unpack(hash)
-      unpack_hash(hash, KEYS_MAP)
-      unpack_hash(@state, STATE_KEYS_MAP)
-      @x, @y = @state['xy']
-    end
-
-    def base_url
-      "http://#{@bridge.ip}/api/#{@client.username}/lights/#{id}"
-    end
-  end
-end