lifx-http 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 865b3dc88e318a175a2150d10de44183d9ea9c39
+  data.tar.gz: 2b34e96d9020ddd814fa3b7ebee607784e3e5296
+SHA512:
+  metadata.gz: 7cee8f7b1766ab4ed48ddeefb97a2e12f7aaf2d86ab6ad183ed14c508c509ab048dc6d0cbb020d64153a0646df5ae22a61f6835c9ac8b4ed614edfaf59fcbbe4
+  data.tar.gz: 5296e1ca15be060808e0beac32416e329ce592a2a7e599c448af18cd436409e7ad1b86ce77e17902c88c45c587b32c21120a107e3c70ee3ee1f1e1f69c0c739a

data/.gitignore

@@ -0,0 +1,2 @@
+/log
+/tmp

data/Gemfile

@@ -0,0 +1,3 @@
+source "https://rubygems.org"
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,87 @@
+PATH
+  remote: .
+  specs:
+    lifx-http (0.2.0)
+      grape (~> 0.6)
+      grape-entity (~> 0.4)
+      grape-swagger (~> 0.7)
+      lifx (= 0.4.5)
+      rack (~> 1.5)
+      rack-cors (~> 0.2)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (4.0.4)
+      i18n (~> 0.6, >= 0.6.9)
+      minitest (~> 4.2)
+      multi_json (~> 1.3)
+      thread_safe (~> 0.1)
+      tzinfo (~> 0.3.37)
+    atomic (1.1.16)
+    axiom-types (0.1.1)
+      descendants_tracker (~> 0.0.4)
+      ice_nine (~> 0.11.0)
+      thread_safe (~> 0.3, >= 0.3.1)
+    bindata (2.0.0)
+    builder (3.2.2)
+    coercible (1.0.0)
+      descendants_tracker (~> 0.0.1)
+    configatron (3.0.2)
+    descendants_tracker (0.0.4)
+      thread_safe (~> 0.3, >= 0.3.1)
+    equalizer (0.0.9)
+    grape (0.6.1)
+      activesupport
+      builder
+      hashie (>= 1.2.0)
+      multi_json (>= 1.3.2)
+      multi_xml (>= 0.5.2)
+      rack (>= 1.3.0)
+      rack-accept
+      rack-mount
+      virtus (>= 1.0.0)
+    grape-entity (0.4.1)
+      activesupport
+      multi_json (>= 1.3.2)
+    grape-swagger (0.7.2)
+      grape (>= 0.2.0)
+      grape-entity (>= 0.3.0)
+      kramdown (>= 1.3.1)
+    hashie (2.0.5)
+    i18n (0.6.9)
+    ice_nine (0.11.0)
+    kramdown (1.3.3)
+    lifx (0.4.5)
+      bindata (~> 2.0)
+      configatron (~> 3.0)
+      timers (~> 1.0)
+      yell (~> 2.0)
+    minitest (4.7.5)
+    multi_json (1.9.2)
+    multi_xml (0.5.5)
+    rack (1.5.2)
+    rack-accept (0.4.5)
+      rack (>= 0.4)
+    rack-cors (0.2.9)
+    rack-mount (0.8.3)
+      rack (>= 1.0.0)
+    rake (10.2.2)
+    thread_safe (0.3.1)
+      atomic (>= 1.1.7, < 2)
+    timers (1.1.0)
+    tzinfo (0.3.39)
+    virtus (1.0.2)
+      axiom-types (~> 0.1)
+      coercible (~> 1.0)
+      descendants_tracker (~> 0.0.3)
+      equalizer (~> 0.0.9)
+    yell (2.0.4)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.3)
+  lifx-http!
+  rake (~> 10.1)

data/LICENSE

@@ -0,0 +1,23 @@
+Copyright (c) 2014 Jack "chendo" Chen
+
+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/README.md

@@ -0,0 +1,51 @@
+# LIFX HTTP API
+
+[![Gem Version](https://badge.fury.io/rb/lifx-http.png)](https://rubygems.org/gems/lifx-http) 
+
+This is an **unofficial** JSON RESTful API service for controlling LIFX devices. This API adds some reliability that the [LIFX gem](https://github.com/LIFX/lifx-gem) does not include.
+
+## Requirements
+
+* Ruby 2.0+
+* Tested on OS X Mavericks, but should work for other *nix platforms.
+
+## Usage
+
+* Install the gem: `gem install lifx-http`
+* Run in foreground (no daemonizing yet): `lifx-http`
+* Test if working: `curl http://localhost:56780/lights.json`
+* Toggle all lights: `curl -XPUT http://localhost:56780/lights/all/toggle`
+* Set all lights to green:
+  * URL params: `curl -XPUT http://localhost:56780/lights/all/color?hue=120&saturation=1&brightness=1&duration=2 -d ''`
+  * JSON body: `curl -XPUT http://localhost:56780/lights/all/color -H "Content-Type: application/json" -d '{"hue": 120, "saturation": 1, "brightness": 1, "duration":2}'`
+  * Override method by setting `_method`: `curl http://localhost:56780/lights/all/color?hue=120&saturation=1&brightness=1&duration=2&_method=put`
+
+
+## API
+
+* `selector` is either:
+  * `all` for all lights
+  * `label:[label]` for light with label `label`
+  * `tag:[tag]` for lights with tag `tag`
+  * `[light_id]` for light with id `light_id`
+* `GET /lights` - Lists all lights
+* `GET /lights/{selector}` - Lists lights matching `selector`
+* `PUT /lights/{selector}/on` - Turns lights matching `selector` on
+* `PUT /lights/{selector}/off` - Turns lights matching `selector` off
+* `PUT /lights/{selector}/toggle` - Toggle lights matching `selector`. If any lights in `selector` is on, it will turn them off
+* `PUT /lights/{selector}/color` - Sets the color for lights matching `selector`. Color data can be passed as URL parameters or form parameters (JSON)
+* `PUT /lights/{light_id}/label` - Changes the label of light with id `light_id`
+* `POST /lights/{light_id}/tag` - Adds a tag to the light
+* `DELETE /lights/{light_id}/tag` - Removes a tag from the light
+
+## Documentation
+
+This API is documented using [Swagger](https://github.com/wordnik/swagger-ui).
+To view documentation and play with the API, start the API server locally, then visit http://swagger.wordnik.com and put `http://localhost:3000/swagger_doc.json` in the first text box, then hit `Explore`.
+
+You should see something like this:
+![Swagger screenshot](doc.png)
+
+## License
+
+MIT. See [LICENSE](LICENSE)

data/bin/lifx-http

@@ -0,0 +1,31 @@
+#!/usr/bin/env ruby
+require "lifx-http"
+require "rack/cors"
+require "lifx-http/method_override"
+require "webrick"
+require "optparse"
+
+options = {
+  port: 56780
+}
+OptionParser.new do |parser|
+  parser.banner = "Usage: lifx-http [options]"
+  parser.version = LIFXHTTP::VERSION
+  parser.on("-p PORT", "--port PORT", "Specify the port to run lifx-http on. Defaults to #{options[:port]}") do |port|
+    options[:port] = port.to_i
+  end
+end.parse!
+
+app = Rack::Builder.new do
+  use LIFXHTTP::MethodOverride
+  use Rack::Cors do
+    allow do
+      origins '*'
+      resource '*', headers: :any, methods: [:get, :post, :put, :delete, :options]
+    end
+  end
+
+  run LIFXHTTP::API
+end
+
+Rack::Handler::WEBrick.run(app, Port: options[:port])

data/lib/lifx-http.rb

@@ -0,0 +1,192 @@
+require 'grape'
+require 'grape-entity'
+require 'grape-swagger'
+require 'lifx'
+
+LIFX::Client.lan.discover
+
+module LIFXHTTP
+  class API < Grape::API
+    module Entities
+      class Light < Grape::Entity
+        format_with(:iso_timestamp) { |dt| dt.iso8601 }
+        expose :id
+        expose :label do |light, options|
+          light.label(fetch: false)
+        end
+        expose :site_id
+        expose :tags
+        expose :on do |light, options|
+          light.on?(fetch: false)
+        end
+        expose :color
+        expose :last_seen
+        expose :seconds_since_seen
+      end
+    end
+
+    format :json
+    default_format :json
+    helpers do
+      def lifx
+        @lifx ||= LIFX::Client.lan
+      end
+
+      def ensure_light_target!
+        error!('Must target a single light', 400) unless @target.is_a?(LIFX::Light)
+      end
+
+      def present_target(target)
+        if target.is_a?(LIFX::LightCollection)
+          present target.to_a, with: Entities::Light
+        else
+          present target, with: Entities::Light
+        end
+      end
+
+      def set_power(target, state)
+        if target.is_a?(LIFX::LightCollection)
+          wait_until -> { target.to_a.all? { |light| light.power(fetch: false) == state} }, retry_interval: 1, timeout: 10 do
+            target.set_power(state)
+            target.refresh
+          end
+        else
+          target.set_power!(state)
+        end
+      rescue Timeout::Error
+
+      end
+
+      def wait_until(condition_proc, timeout: 5, retry_interval: 0.5, &action_block)
+        Timeout.timeout(timeout) do
+          while !condition_proc.call
+            action_block.call if action_block
+            sleep(retry_interval)
+          end
+        end
+      end
+    end
+
+    desc "List of all known lights"
+    get "lights" do
+      present_target(lifx.lights.lights)
+    end
+
+    resources :lights do
+      params do
+        requires :selector, type: String, desc: "Can be 'all', 'label:[label]', 'tag:[tag]' and '[light id]'"
+      end
+
+      namespace ":selector" do
+        after_validation do
+          selector = params[:selector]
+          case selector
+          when /^tag:(.+)$/
+            @target = lifx.lights.with_tag($1)
+          when /^label:(.+)$/
+            @target = lifx.lights.with_label($1)
+          when /^all$/
+            @target = lifx.lights
+          else
+            @target = lifx.lights.with_id(selector)
+          end
+
+          if @target.nil?
+            error! "Could not resolve selector: selector", 404
+          end
+        end
+
+        desc "Returns light(s) based on selector"
+        get do
+          present_target(@target)
+        end
+
+        desc "Turn light(s) on"
+        put :on do
+          set_power(@target, :on)
+          present_target(@target)
+        end
+
+        desc "Turn light(s) off"
+        put :off do
+          set_power(@target, :off)
+          present_target(@target)
+        end
+
+        desc "Toggle light(s) power state. Will turn lights off if any are on."
+        put :toggle do
+          if @target.is_a?(LIFX::LightCollection)
+            on = @target.to_a.any? { |light| light.on? }
+            desired_state = on ? :off : :on
+            set_power(@target, desired_state)
+            present_target(@target)
+          else
+            desired_state = @target.on? ? :off : :on
+            set_power(@target, desired_state)
+            present_target(@target)
+          end
+        end
+
+        desc "Set colour of light(s)"
+        params do
+          requires :hue, type: Float, desc: "Hue: 0-360"
+          requires :saturation, type: Float, desc: "Saturation: 0-1"
+          requires :brightness, type: Float, desc: "Brightness: 0-1"
+          optional :kelvin, type: Integer, default: 3_500, desc: "Kelvin: 2500-10000. Defaults to 3500"
+          optional :duration, type: Float, default: 1, desc: "Duration in seconds. Defaults to 1.0"
+        end
+        put :color do
+          color = LIFX::Color.hsbk(
+            params[:hue],
+            params[:saturation],
+            params[:brightness],
+            params[:kelvin]
+          )
+          lifx.sync { 3.times { @target.set_color(color, duration: params[:duration]) } } # Retry 
+          present_target(@target)
+        end
+      end
+
+      params do
+        requires :light_id, type: String, desc: "Light ID"
+      end
+      namespace ":light_id" do
+        after_validation do
+          @target = lifx.lights.with_id(params[:light_id])
+          if @target.nil?
+            error!("Could not find light with ID: #{params[:light_id]}", 404)
+          end
+        end
+        desc "Sets label on light"
+        params do
+          requires :label, type: String, regexp: /^.{,32}$/, desc: "Label"
+        end
+        put :label do
+          ensure_light_target!
+          present_target(@target.set_label(params[:label]))
+        end
+
+        desc "Adds a tag a light"
+        params do
+          requires :tag, type: String, regexp: /^.{1,32}$/, desc: "Tag"
+        end
+        post :tag do
+          ensure_light_target!
+          present_target(@target.add_tag(params[:tag]))
+        end
+
+        desc "Removes a tag from a light"
+        params do
+          requires :tag, type: String, regexp: /^.{1,32}$/, desc: "Tag"
+        end
+        delete :tag do
+          ensure_light_target!
+          present_target(@target.remove_tag(params[:tag]))
+        end
+      end
+    end
+
+    add_swagger_documentation(markdown: true)
+  end
+end
+require "lifx-http/version"

data/lib/lifx-http/method_override.rb

@@ -0,0 +1,29 @@
+module LIFXHTTP
+  class MethodOverride
+    HTTP_METHODS = %w(GET HEAD PUT POST DELETE OPTIONS PATCH LINK UNLINK)
+
+    METHOD_OVERRIDE_PARAM_KEY = "_method".freeze
+    HTTP_METHOD_OVERRIDE_HEADER = "HTTP_X_HTTP_METHOD_OVERRIDE".freeze
+
+    def initialize(app)
+      @app = app
+    end
+
+    def call(env)
+      method = method_override(env)
+      if HTTP_METHODS.include?(method)
+        env["rack.methodoverride.original_method"] = env["REQUEST_METHOD"]
+        env["REQUEST_METHOD"] = method
+      end
+
+      @app.call(env)
+    end
+
+    def method_override(env)
+      req = Rack::Request.new(env)
+      method = req.params[METHOD_OVERRIDE_PARAM_KEY] ||
+        env[HTTP_METHOD_OVERRIDE_HEADER]
+      method.to_s.upcase
+    end
+  end
+end

data/lib/lifx-http/version.rb

@@ -0,0 +1,3 @@
+module LIFXHTTP
+  VERSION = "0.2.0"
+end

data/lifx-http.gemspec

@@ -0,0 +1,30 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'lifx-http/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "lifx-http"
+  spec.version       = LIFXHTTP::VERSION
+  spec.authors       = ["Jack Chen (chendo)"]
+  spec.email         = ["github+lifx-http@chen.do"]
+  spec.description   = %q{A HTTP API for LIFX.}
+  spec.summary       = %q{A HTTP API for interacting with LIFX devices.}
+  spec.homepage      = "https://github.com/chendo/lifx-http"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files`.split($/).reject { |f| f =~ /^script\// }
+  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"]
+  spec.required_ruby_version = ">= 2.0"
+
+  spec.add_dependency "rack", "~> 1.5"
+  spec.add_dependency "rack-cors", "~> 0.2"
+  spec.add_dependency "lifx", "= 0.4.5"
+  spec.add_dependency "grape", "~> 0.6"
+  spec.add_dependency "grape-entity", "~> 0.4"
+  spec.add_dependency "grape-swagger", "~> 0.7"
+  spec.add_development_dependency "bundler", "~> 1.3"
+  spec.add_development_dependency "rake", "~> 10.1"
+end

data/start.sh

@@ -0,0 +1,3 @@
+bundle exec thin stop 2> /dev/null
+sleep 1
+bundle exec thin -R config.ru -d start

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: lifx-http
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Jack Chen (chendo)
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-03-28 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rack
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rack-cors
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.2'
+- !ruby/object:Gem::Dependency
+  name: lifx
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '='
+      - !ruby/object:Gem::Version
+        version: 0.4.5
+- !ruby/object:Gem::Dependency
+  name: grape
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.6'
+- !ruby/object:Gem::Dependency
+  name: grape-entity
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.4'
+- !ruby/object:Gem::Dependency
+  name: grape-swagger
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.7'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.3'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.1'
+description: A HTTP API for LIFX.
+email:
+- github+lifx-http@chen.do
+executables:
+- lifx-http
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- bin/lifx-http
+- doc.png
+- lib/lifx-http.rb
+- lib/lifx-http/method_override.rb
+- lib/lifx-http/version.rb
+- lifx-http.gemspec
+- start.sh
+homepage: https://github.com/chendo/lifx-http
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.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: A HTTP API for interacting with LIFX devices.
+test_files: []
+has_rdoc: