LIFX::HTTP

A nice Ruby client for the LIFX HTTP API that has no external dependencies. Generate a personal access token at https://cloud.lifx.com/settings.

lifx     = LIFX::HTTP::Client.new(access_token: 'c87c73a896b554367fac61f71dd3656af8d93a525a4e87df5952c6078a89d192')
response = lifx.set_lights_color(selector: 'all', color: 'blue', duration: 3)
response.success? # => true
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

Note: This is not an official LIFX project and the API may continue to change.

Installation

Add this line to your Gemfile.

gem 'lifx-http', require: 'lifx/http', github: 'tatey/lifx-http-client-ruby'

Run bundler to install it.

$ bundle

Usage

Determining if a response was successful

Use the success? predicate to determine if the response was successful.

response = lifx.set_lights_power(selector: 'all', state: 'on')
if response.success?
  response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]
end

Alternatively, you can opt-in to an exception on failure or self on success.

# Failure
response = lifx.set_lights_power(selector: 'all', state: 'off').success! # => LIFX::HTTP:UnexpectedStatusError

# Success
response = lifx.set_lights_power(selector: 'all', state: 'on').success!
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

List of operations

Get all lights.

response = lifx.lights
response.lights # => [#<LIFX::HTTP::Loader::Device id: "d073d5017100", uuid: "02780349-7558-4842-84bb-8a98778eefd5", label: "Lefty", connected: true, power: "off", brightness: 0.0, color: #<LIFX::HTTP::Loader::Color hue: 249.9977111467155, saturation: 1.0, kelvin: 3500>, group: #<LIFX::HTTP::Loader::Group id: "1c8de82b81f445e7cfaafae49b259c71", name: "Test Group">, location: #<LIFX::HTTP::Loader::Location id: "1d6fe8ef0fde4c6d77b0012dc736662c", name: "Test Location">, last_seen: 2015-03-02 20:03:46 +1000, seconds_since_seen: 0.002248558>, ...]

Get only the lights which match the given selector.

response = lifx.lights(selector: 'id:43b2f2d97452')
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

Turns the lights on or off.

response = lifx.set_lights_power(selector: 'all', state: 'on')
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

Toggle the lights between on and off.

response = lifx.toggle(selector: 'all')
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

Change the color of the lights.

response = lifx.set_color(selector: 'all', color: 'blue')
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

Run the breathe effect on the lights.

response = lifx.run_breathe_effect(selector: 'all', color: 'blue', cycles: 3)
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

Run the pulse effect on the lights.

response = lifx.run_pulse_effect(selector: 'all', color: 'blue', cycles: 3)
response.results # => [#<LIFX::HTTP::Loader::Result id: "43b2f2d97452", status: "ok">, ...]

Differences from the API

All successful responses will contain an array of objects, even if a single object is returned. This makes it easier to consume the result.

Tests

Run the entire test suite.

$ [bundle exec] rake

Contributing

1. Fork it (https://github.com/tatey/lifx-http-client-ruby/fork)
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 a new Pull Request