huemote 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 9be51c602e6af5ead50c6971f39506a6a5032421
+  data.tar.gz: 114b210e64560c8a666030a6098e37767da0bc2e
+SHA512:
+  metadata.gz: 4b2a0ff35970f5de67a3dc2997370f0cc758200ea12e01224abd329872365555b17ed6350e60af22481d00416efaaa82f0fb6c2097ece58f3c76da56154cfd5a
+  data.tar.gz: 63f14a307fce18f9cbeaeb9552de0b8612a57547c576ee702f8025a571f6803f192521786af8cb647652b588530782201ea2d2b7c6ead929afe559e44f24bd39

data/.gitignore

@@ -0,0 +1,20 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.swp
+*.swo
+*~

data/.travis.yml

@@ -0,0 +1,8 @@
+language: ruby
+rvm:
+  - 2.1.0
+  - 2.0.0
+  - 1.9.3
+  - rbx
+  - ruby-head
+  - jruby-head

data/Gemfile

@@ -0,0 +1,6 @@
+source 'https://rubygems.org'
+gemspec
+
+gem 'httparty'
+gem 'rspec'
+gem 'rake'

data/LICENSE.txt

@@ -0,0 +1,20 @@
+Copyright (c) 2014 Kevin Gisi
+
+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/README.md

@@ -0,0 +1,59 @@
+# Huemote [![Build Status](https://travis-ci.org/gisikw/huemote.png?branch=master)](https://travis-ci.org/gisikw/huemote) [![Gem Version](https://badge.fury.io/rb/huemote.png)](http://badge.fury.io/rb/huemote) [![Code Climate](https://codeclimate.com/github/gisikw/huemote.png)](https://codeclimate.com/github/gisikw/huemote)
+
+Huemote is an interface for controlling Philips Hue lights. Unlike other implementations, it does not rely on Philips backend servers for upnp discovery.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'huemote'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install huemote
+
+## Usage
+
+You can fetch all lights on your network via:
+
+```ruby
+lights = Huemote::Light.all #=> [#<Huemote::Light:0x511ee8dd @name="Hallway", @id="1">, #<Huemote::Light:0x444a2ec6 @name="Main Room", @id="2">, #<Huemote::Light:0x6244ec30 @name="Bathroom 1", @id="3">, #<Huemote::Light:0x1aee75b7 @name="Bathroom 2", @id="4">, #<Huemote::Light:0x1d724f31 @name="Bathroom 3", @id="5">]
+```
+
+Or select a light by its friendly name:
+
+```ruby
+switch = Huemote::Light.find('Hallway') #=> #<Huemote::Light:0x511ee8dd @name="Hallway", @id="1">
+```
+
+Given a Light instance, you can call the following methods:
+```ruby
+light.off? #=> [true,false]
+light.on? #=> [true,false]
+light.on!
+light.off!
+light.toggle!
+light.brightness(250)
+light.saturation(50)
+light.effect('colorloop')
+light.alert('select')
+light.hue(5)
+light.xy([0.123,0.425])
+light.ct(300)
+```
+
+## Performance
+
+Huemote is designed to be performant - and as such, it will leverage the best HTTP library available for making requests. Currently, Wemote will use (in order of preference): `manticore`, `typhoeus`, `httparty`, and finally (miserably) `net/http`. Because you probably like things fast too, we recommend you `gem install manticore` on JRuby, or `gem install typhoeus` on another engine. In order to keep the gem as flexible as possible, none of these are direct dependencies. They just make Wemote happy and fast.
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1,8 @@
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec) do |spec|
+  spec.pattern = 'spec/**/*_spec.rb'
+  spec.rspec_opts = ['--tty --color --format documentation']
+end
+
+task :default => :spec

data/huemote.gemspec

@@ -0,0 +1,21 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'huemote/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "huemote"
+  spec.version       = Huemote::VERSION
+  spec.authors       = ["Kevin Gisi"]
+  spec.email         = ["kevin@kevingisi.com"]
+  spec.description   = %q{Huemote is a Ruby gem for managing Philips Hue lights}
+  spec.summary       = %q{Huemote is a Ruby gem for managing Philips Hue lights}
+  spec.homepage      = "https://github.com/gisikw/huemote"
+  spec.license       = "MIT"
+  spec.platform      = 'ruby'
+
+  spec.files         = `git ls-files`.split($/)
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ["lib"]
+end

data/lib/huemote.rb

@@ -0,0 +1,15 @@
+require 'json'
+
+require_relative './huemote/version'
+
+module Huemote
+  require_relative './huemote/client'
+  require_relative './huemote/light'
+  require_relative './huemote/bridge'
+
+  class << self
+    def discover(socket=nil)
+      Huemote::Bridge.discover
+    end
+  end
+end

data/lib/huemote/bridge.rb

@@ -0,0 +1,136 @@
+require 'socket'
+require 'ipaddr'
+
+module Huemote
+  class Bridge
+    DEVICE_TYPE = "Huemote"
+    USERNAME = "HuemoteRubyGem"
+    MULTICAST_ADDR = '239.255.255.250'
+    BIND_ADDR = '0.0.0.0'
+    PORT = 1900
+    DISCOVERY= <<-EOF
+M-SEARCH * HTTP/1.1\r
+HOST: 239.255.255.250:1900\r
+MAN: "ssdp:discover"\r
+MX: 10\r
+ST: urn:schemas-upnp-org:device:Basic:1\r
+\r
+EOF
+
+    class << self
+      def get
+        @bridge ||= begin
+          client = Huemote::Client.new
+          body = nil
+          device = fetch_upnp.detect{|host,port|body = client.get("http://#{host}:#{port}/description.xml").body; body.match('<modelURL>http://www.meethue.com</modelURL>')}
+          self.new(*device,body)
+        end
+      end
+
+      private
+
+      def discover(socket = nil)
+        @bridge = nil
+        client  = Huemote::Client.new
+        body    = nil
+
+        devices, socket = fetch_upnp(true,socket)
+        device = devices.detect{|host,port|body = client.get("http://#{host}:#{port}/description.xml").body; body.match('<modelURL>http://www.meethue.com</modelURL>')}
+        @bridge = self.new(*device,body)
+
+        socket
+      end
+
+      def ssdp_socket
+        socket = UDPSocket.new
+        socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_ADD_MEMBERSHIP, IPAddr.new(MULTICAST_ADDR).hton + IPAddr.new(BIND_ADDR).hton)
+        socket.setsockopt(Socket::IPPROTO_IP, Socket::IP_MULTICAST_TTL, 1)
+        socket.setsockopt(Socket::SOL_SOCKET, Socket::SO_REUSEPORT, 1)
+        socket.bind(BIND_ADDR,PORT)
+        socket
+      end
+
+      def listen(socket,devices)
+        sleep 1
+        Thread.start do
+          loop do
+            message, _ = socket.recvfrom(1024)
+            match = message.match(/LOCATION:\s+http:\/\/([^\/]+)/)
+            devices << match[1].split(':') if match
+          end
+        end
+      end
+
+      def fetch_upnp(return_socket=false,socket=nil)
+        socket ||= ssdp_socket
+        devices = []
+
+        3.times { socket.send(DISCOVERY, 0, MULTICAST_ADDR, PORT) }
+
+        # The following is a bit silly, but is necessary for JRuby support,
+        # which seems to have some issues with socket interruption. If you have
+        # a working JRuby solution that doesn't require this kind of hackery,
+        # by all means, submit a pull request!
+
+        listen(socket,devices).tap{|l|sleep 1; l.kill}
+        devices.uniq!
+
+        if return_socket
+          [devices,socket]
+        else
+          socket.close
+          devices
+        end
+      end
+    end
+
+    attr_accessor :name
+
+    def initialize(host,port,body)
+      @host, @port = host, port
+      @name = body.match(/<friendlyName>([^<]+)<\/friendlyName>/)[1]
+    end
+
+    def _get(path,params={})
+      request(:get,path,params)
+    end
+
+    def _post(path,params={})
+      request(:post,path,params)
+    end
+
+    def _put(path,params={})
+      request(:put,path,params)
+    end
+
+    private
+
+    def request(method,path,params)
+      auth! unless authed?
+      JSON.parse(client.send(method,"#{base_url}/api/#{USERNAME}/#{path}",params.to_json).body)
+    end
+
+    def base_url
+      @base_url ||= "http://#{@host}:#{@port}"
+    end
+
+    def authed?
+      @authed ||= !client.get("#{base_url}/api/#{USERNAME}/lights").body.match('unauthorized user')
+    end
+
+    def auth!
+      unless authed?
+        body = client.post("#{base_url}/api",{devicetype:DEVICE_TYPE,username:USERNAME}.to_json).body
+        if body.match('link button not pressed')
+          puts "In order for the Hue Bridge to interact, please press the button just this once and try again."
+          false
+        end
+      end
+    end
+
+    def client
+      @client ||= Huemote::Client.new
+    end
+
+  end
+end

data/lib/huemote/client.rb

@@ -0,0 +1,83 @@
+module Huemote
+  class Client
+
+    def self.technique
+      @technique ||= begin
+        constants.collect {|const_name| const_get(const_name)}.select {|const| const.class == Module}.detect do |mod|
+          fulfilled = false
+          begin
+            next unless mod.const_defined?(:DEPENDENCIES)
+            mod.const_get(:DEPENDENCIES).map{|d|require d}
+            fulfilled = true
+          rescue LoadError
+          end
+          fulfilled
+        end
+      end
+    end
+
+    module SmartLib
+      %w{get post put}.each do |name|
+        define_method name do |*args|
+          _req(@lib,name,*args).tap{|r|r.call if @call}
+        end
+      end
+    end
+
+    module Manticore
+      DEPENDENCIES = ['manticore']
+      def self.extended(base)
+        base.instance_variable_set(:@lib,::Manticore)
+        base.instance_variable_set(:@call,true)
+        base.extend(SmartLib)
+      end
+    end
+
+    module Typhoeus
+      DEPENDENCIES = ['typhoeus']
+      def self.extended(base)
+        base.instance_variable_set(:@lib,::Typhoeus)
+        base.extend(SmartLib)
+      end
+    end
+
+    module HTTParty
+      DEPENDENCIES = ['httparty']
+      def self.extended(base)
+        base.instance_variable_set(:@lib,::HTTParty)
+        base.extend(SmartLib)
+      end
+    end
+
+    module NetHTTP
+      DEPENDENCIES = ['net/http','uri']
+
+      def request(klass,url,body=nil,headers=nil)
+        uri = URI.parse(url)
+        http = Net::HTTP.new(uri.host, uri.port)
+        request = klass.new(uri.request_uri)
+        headers.map{|k,v|request[k]=v} if headers
+        (request.body = body) if body
+        response = http.request(request)
+      end
+
+      %w{get post put}.each do |name|
+        define_method name do |*args|
+          request(Net::HTTP.const_get(name.capitalize),*args)
+        end
+      end
+
+    end
+
+    def initialize
+      extend Huemote::Client.technique
+    end
+
+    private
+
+    def _req(lib,method,url,body=nil,headers=nil)
+      lib.send(method,url,{body:body,headers:headers})
+    end
+
+  end
+end

data/lib/huemote/light.rb

@@ -0,0 +1,76 @@
+module Huemote
+  class Light
+
+    STATES = {
+      brightness: 'bri',
+      saturation: 'sat',
+      effect:     'effect',
+      alert:      'alert',
+      hue:        'hue',
+      xy:         'xy',
+      ct:         'ct'
+    }
+
+    class << self
+
+      def all(refresh=false)
+        @lights = nil if refresh
+        @lights ||= bridge._get('lights').map{|id,h|self.new(id,h['name'])}
+      end
+
+      def find(name)
+        all.detect{|l|l.name == name}
+      end
+
+      private
+
+      def bridge
+        @bridge ||= Huemote::Bridge.get
+      end
+
+    end
+
+    attr_accessor :name
+
+    def initialize(id,name)
+      @id, @name = id, name
+    end
+
+    def on!
+      set!(on:true)
+    end
+
+    def off!
+      set!(on:false)
+    end
+
+    def on?
+      bridge._get("lights/#{@id}")['state']['on']
+    end
+
+    def off?
+      !on?
+    end
+
+    def toggle!
+      on? ? off! : on!
+    end
+
+    STATES.each do |name,state|
+      define_method name do |arg|
+        set!(state => arg)
+      end
+    end
+
+    private
+
+    def set!(params)
+      bridge._put("lights/#{@id}/state",params)
+    end
+
+    def bridge
+      @bridge ||= Huemote::Bridge.get
+    end
+
+  end
+end

data/lib/huemote/version.rb

@@ -0,0 +1,3 @@
+module Huemote
+  VERSION = '0.0.2'
+end

data/spec/huemote/bridge_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Huemote::Bridge do
+  describe 'initialize' do
+    it 'should set the host, port and friendly name' do
+      bridge = Huemote::Bridge.new('fakehost',1234,'<friendlyName>Bob</friendlyName>')
+      bridge.instance_variable_get(:@host).should == 'fakehost'
+      bridge.instance_variable_get(:@port).should == 1234
+      bridge.instance_variable_get(:@name).should == 'Bob'
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1 @@
+require 'huemote'

metadata

@@ -0,0 +1,61 @@
+--- !ruby/object:Gem::Specification
+name: huemote
+version: !ruby/object:Gem::Version
+  version: 0.0.2
+platform: ruby
+authors:
+- Kevin Gisi
+autorequire:
+bindir: bin
+cert_chain: []
+date: 2014-03-07 00:00:00.000000000 Z
+dependencies: []
+description: Huemote is a Ruby gem for managing Philips Hue lights
+email:
+- kevin@kevingisi.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- .gitignore
+- .travis.yml
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- huemote.gemspec
+- lib/huemote.rb
+- lib/huemote/bridge.rb
+- lib/huemote/client.rb
+- lib/huemote/light.rb
+- lib/huemote/version.rb
+- spec/huemote/bridge_spec.rb
+- spec/spec_helper.rb
+homepage: https://github.com/gisikw/huemote
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - '>='
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project:
+rubygems_version: 2.2.2
+signing_key:
+specification_version: 4
+summary: Huemote is a Ruby gem for managing Philips Hue lights
+test_files:
+- spec/huemote/bridge_spec.rb
+- spec/spec_helper.rb
+has_rdoc: