lifx_api 0.1.3 → 0.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: bfc68d8f7402d1601df1501e8c1e4651167b4ec3
-  data.tar.gz: 85e218c1af08c463dfc303baf55ed00ddeadbab0
+SHA256:
+  metadata.gz: 0dcc8bfc7bb623baf95b44cdd9e822aeefcf1e2fae6f6204d1e5e6875030b9a3
+  data.tar.gz: 8e326e904ed90c4ef575f3a722a426cd3569f9371f09d505c00a0e46bdc8728e
 SHA512:
-  metadata.gz: 669bd924831b096444fb8ef7c7b6620776aecfec6fa2a4ed9c636b6598d44ce54b8231af3b540c69f068d390afcb156019a1ad4b0e67d8873b6c8efb90abe0c8
-  data.tar.gz: 3a0803ad3a792973ec00a0629d74f6bf93772a653ed22e7e44070d84a1151742b0bb288ca41ea2319e5a8a5d9e18571fef31e81a2fcb410bf90511de1d733bc1
+  metadata.gz: a6b3657d033c9e8845fd088d985406037eb78b96881317a1f2d9d7e356d91039a5ebbb2b0389762fb7f9d5932b3acd229116952c52e5b28b30b60fa4689c9b0d
+  data.tar.gz: b46765d79a097ad2162abe4ccdfbd2a15ce71d34e8df3130c957e03a5c360c7eb2705a8c1c2c742dccc407faad24719099e5c10ac7c0eb6c6e8be7bb4add3480

data/.travis.yml

@@ -0,0 +1,10 @@
+---
+language: ruby
+cache: bundler
+rvm:
+  - 2.5
+  - 2.6
+  - 2.7
+  - jruby
+script:
+  - bundle exec rake test

data/CHANGELOG

@@ -1,3 +1,12 @@
+=== 0.2.0
+
+* Add `fast` parameter to `LifxApi#set_state` and `LifxApi#set_states`
+* Add `LifxApi#state_delta`, and deprecate `LifxApi#stage_delta`
+* Add `LifxApi#move_effect`
+* Add `LifxApi#morph_effect`
+* Add `LifxApi#flame_effect`
+* Add `LifxApi#effects_off`
+
 === 0.1.3
 
 * Fix documentation and specification of `cycle` endpoint

data/README.md

@@ -1,4 +1,4 @@
-# LifxApi
+# LifxApi [![Build Status](https://travis-ci.org/cyclotron3k/lifx_api.svg?branch=master)](https://travis-ci.org/cyclotron3k/lifx_api)
 
 A Ruby client for the LIFX API.
 
@@ -57,11 +57,12 @@ Key | Type | Mandatory | Default | Description
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
 `:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
-`:power` | string |  |  | The power state you want to set on the selector. on or off
-`:color` | string |  |  | The color to set the light to.
+`:power` | string |  |  | The power state you want to set on the selector. Must be `on` or `off`.
+`:color` | color |  |  | The color to set the light to.
 `:brightness` | numeric |  |  | The brightness level from 0.0 to 1.0. Overrides any brightness set in color (if any).
 `:duration` | numeric |  | 1.0 | How long in seconds you want the power action to take. Range: 0.0 - 3155760000.0 (100 years)
-`:infrared` | numeric |  |  | The maximum brightness of the infrared channel.
+`:infrared` | numeric |  |  | The maximum brightness of the infrared channel from `0.0` to `1.0`.
+`:fast` | boolean |  | false | Execute the query fast, without initial state checks and wait for no results.
 
 ### set_states
 
@@ -69,23 +70,40 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:states` |  array of states | ✔ |  | Array of state hashes as per `#set_state`. No more than 50 entries.
+`:states` | array of hashes | ✔ |  | Array of state hashes as per `#set_state`. No more than 50 entries.
 `:defaults` | hash |  |  | Default values to use when not specified in each `states[]` hash.
+`:fast` | boolean |  | false | Execute the query fast, without initial state checks and wait for no results.
+
+### state_delta
+
+#### Parameters
+
+Key | Type | Mandatory | Default | Description
+--- | --- | --- | --- | ---
+`:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
+`:power` | string |  |  | The power state you want to set on the selector. Must be `on` or `off`.
+`:duration` | numeric |  | 1.0 | How long in seconds you want the power action to take. Range: `0.0` - `3155760000.0` (100 years)
+`:infrared` | numeric |  |  | The maximum brightness of the infrared channel.
+`:hue` | numeric |  |  | Rotate the hue by this angle in degrees. Range: `-360.0` - `360.0` degrees.
+`:saturation` | numeric |  |  | Change the saturation by this additive amount; the resulting saturation is clipped to `[0, 1]`.
+`:brightness` | numeric |  |  | Change the brightness by this additive amount; the resulting brightness is clipped to `[0, 1]`.
+`:kelvin` | numeric |  |  | Change the kelvin by this additive amount; the resulting kelvin is clipped to `[2500, 9000]`.
 
 ### stage_delta
+[DEPRECATED] `#stage_delta` is deprecated, please use `#state_delta` instead
 
 #### Parameters
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
 `:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
-`:power` | string |  |  | The power state you want to set on the selector. Must be "on" or "off".
-`:duration` | numeric |  | 1.0 | How long in seconds you want the power action to take. Range: 0.0 - 3155760000.0 (100 years)
+`:power` | string |  |  | The power state you want to set on the selector. Must be `on` or `off`.
+`:duration` | numeric |  | 1.0 | How long in seconds you want the power action to take. Range: `0.0` - `3155760000.0` (100 years)
 `:infrared` | numeric |  |  | The maximum brightness of the infrared channel.
-`:hue` | numeric |  |  | Rotate the hue by this angle in degrees.
-`:saturation` | numeric |  |  | Change the saturation by this additive amount; the resulting saturation is clipped to [0, 1].
-`:brightness` | numeric |  |  | Change the brightness by this additive amount; the resulting brightness is clipped to [0, 1].
-`:kelvin` | numeric |  |  | Change the kelvin by this additive amount; the resulting kelvin is clipped to [2500, 9000].
+`:hue` | numeric |  |  | Rotate the hue by this angle in degrees. Range: `-360.0` - `360.0` degrees.
+`:saturation` | numeric |  |  | Change the saturation by this additive amount; the resulting saturation is clipped to `[0, 1]`.
+`:brightness` | numeric |  |  | Change the brightness by this additive amount; the resulting brightness is clipped to `[0, 1]`.
+`:kelvin` | numeric |  |  | Change the kelvin by this additive amount; the resulting kelvin is clipped to `[2500, 9000]`.
 
 ### toggle_power
 
@@ -103,13 +121,48 @@ Key | Type | Mandatory | Default | Description
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
 `:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
-`:color` | string | ✔ |  | The color to use for the breathe effect.
+`:color` | color | ✔ |  | The color to use for the breathe effect.
 `:from_color` | string |  | current bulb color | The color to start the effect from. If this parameter is omitted then the color the bulb is currently set to is used instead.
 `:period` | numeric |  | 1.0 | The time in seconds for one cyles of the effect.
 `:cycles` | numeric |  | 1.0 | The number of times to repeat the effect.
-`:persist` | boolean |  | false | If false set the light back to its previous value when effect ends, if true leave the last effect color.
-`:power_on` | boolean |  | true | If true, turn the bulb on if it is not already on.
-`:peak` | numeric |  | 0.5 | Defines where in a period the target color is at its maximum. Minimum 0.0, maximum 1.0.
+`:persist` | boolean |  | false | If `false` set the light back to its previous value when effect ends, if true leave the last effect color.
+`:power_on` | boolean |  | true | If `true`, turn the bulb on if it is not already on.
+`:peak` | numeric |  | 0.5 | Defines where in a period the target color is at its maximum. Minimum `0.0`, maximum `1.0`.
+
+### move_effect
+
+#### Parameters
+
+Key | Type | Mandatory | Default | Description
+--- | --- | --- | --- | ---
+`:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
+`:direction` | string |  | forward | Move direction, can be `forward` or `backward`.
+`:period` | numeric |  | 1.0 | The time in seconds for one cyles of the effect.
+`:cycles` | numeric |  | infinite | The number of times to move the pattern across the device. Special cases are `0` to switch the effect off, and unspecified to continue indefinitely.
+`:power_on` | boolean |  | true | Switch any selected device that is off to on before performing the effect.
+
+### morph_effect
+
+#### Parameters
+
+Key | Type | Mandatory | Default | Description
+--- | --- | --- | --- | ---
+`:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
+`:period` | numeric |  | 5.0 | This controls how quickly the morph runs. It is measured in seconds. A lower number means the animation is faster.
+`:duration` | numeric |  | infinite | How long the animation lasts for in seconds. Not specifying a duration makes the animation never stop. Specifying `0` makes the animation stop. Note that there is a known bug where the tile remains in the animation once it has completed if duration is nonzero.
+`:palette` | array of colors |  | 7 colours across the spectrum | You can control the colors in the animation by specifying a list of color specifiers. For example `["red", "hue:100 saturation:1"]`.
+`:power_on` | boolean |  | true | Switch any selected device that is off to on before performing the effect.
+
+### flame_effect
+
+#### Parameters
+
+Key | Type | Mandatory | Default | Description
+--- | --- | --- | --- | ---
+`:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
+`:period` | numeric |  | 5.0 | This controls how quickly the flame runs. It is measured in seconds. A lower number means the animation is faster.
+`:duration` | numeric |  | infinite | How long the animation lasts for in seconds. Not specifying a duration makes the animation never stop. Specifying `0` makes the animation stop. Note that there is a known bug where the tile remains in the animation once it has completed if duration is nonzero.
+`:power_on` | boolean |  | true | Switch any selected device that is off to on before performing the effect.
 
 ### pulse_effect
 
@@ -122,8 +175,17 @@ Key | Type | Mandatory | Default | Description
 `:from_color` | string |  | current bulb color | The color to start the effect from. If this parameter is omitted then the color the bulb is currently set to is used instead.
 `:period` | numeric |  | 1.0 | The time in seconds for one cyles of the effect.
 `:cycles` | numeric |  | 1.0 | The number of times to repeat the effect.
-`:persist` | boolean |  | false | If false set the light back to its previous value when effect ends, if true leave the last effect color.
-`:power_on` | boolean |  | true | If true, turn the bulb on if it is not already on.
+`:persist` | boolean |  | false | If `false` set the light back to its previous value when effect ends, if true leave the last effect color.
+`:power_on` | boolean |  | true | If `true`, turn the bulb on if it is not already on.
+
+### effects_off
+
+#### Parameters
+
+Key | Type | Mandatory | Default | Description
+--- | --- | --- | --- | ---
+`:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
+`:power_off` | boolean |  | false | If `true`, the devices will also be turned off.
 
 ### cycle
 
@@ -132,9 +194,9 @@ Key | Type | Mandatory | Default | Description
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
 `:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
-`:states` | array of states | ✔ |  | Array of state hashes as per `#set_state`. Must have 2 to 5 entries.
-`:defaults` | hash |  |  | Default values to use when not specified in each states[] object.
-`:direction` | string |  |  | Direction in which to cycle through the list. Can be "forward" or "backward".
+`:states` | array of hashes | ✔ |  | Array of state hashes as per `#set_state`. Must have 2 to 5 entries.
+`:defaults` | hash |  |  | Default values to use when not specified in each `states[]` object.
+`:direction` | direction |  | forward | Direction in which to cycle through the list. Can be `forward` or `backward`.
 
 ### list_scenes
 
@@ -148,8 +210,8 @@ Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
 `:scene_uuid` | uuid | ✔ |  | The UUID for the scene you wish to activate
 `:duration` | numeric |  | 1.0 | The time in seconds to spend performing the scene transition.
-`:ignore` | array of strings |  |  | Any of "power", "infrared", "duration", "intensity", "hue", "saturation", "brightness" or "kelvin", specifying that these properties should not be changed on devices when applying the scene.
-`:overrides` | hash |  |  | A state object as per Set State specifying properties to apply to all devices in the scene, overriding those configured in the scene.
+`:ignore` | array of strings |  |  | Any of `power`, `infrared`, `duration`, `intensity`, `hue`, `saturation`, `brightness` or `kelvin`, specifying that these properties should not be changed on devices when applying the scene.
+`:overrides` | hash |  |  | A state hash as per `#set_state` specifying properties to apply to all devices in the scene, overriding those configured in the scene.
 
 ### validate_color
 
@@ -157,7 +219,8 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:color` | string | ✔ |  | Color string you'd like to validate
+`:color` | color | ✔ |  | Color string you'd like to validate
+
 
 ## Deviation from the API spec
 
@@ -174,7 +237,7 @@ client.list_bulbs selector: 'all'
 
 ## Exceptions
 
-If there is an error, LifxApi will raise an exception. The exception message will usually give a good indication of what went wrong, but you can also rescue the exception and access the request, response and decoded JSON objects, via the `request`, `response` and `data` methods.
+If there is an error, `LifxApi` will raise an exception. The exception message will usually give a good indication of what went wrong, but you can also rescue the exception and access the request, response and decoded JSON objects, via the `request`, `response` and `data` methods.
 
 ## Development
 
@@ -183,6 +246,7 @@ Run `rake test` to run the tests and `rake console` to start an interactive pry
 ## TODO
 
 * Validation of `:state` and `:array_of_states` is poor
+* Validation of `:color` and `:array_of_colors` is poor
 * Validation of endpoints is non-existent
 
 ## Contributing

data/lib/lifx_api.rb

@@ -24,6 +24,9 @@ class LifxApi
 
 	ENDPOINTS.each do |endpoint_spec|
 		define_method endpoint_spec[:method_name], Proc.new { |params={}|
+			if endpoint_spec[:deprecation_message]
+				warn "[DEPRECATED] #{endpoint_spec[:deprecation_message]}"
+			end
 			parsed_params = parse_params endpoint_spec, params
 			request = create_request endpoint_spec, parsed_params
 			process_request request
@@ -70,6 +73,8 @@ class LifxApi
 			value.is_a?(String) and ['forward', 'backward'].include? value
 		when :array_of_states
 			value.is_a?(Array) and value.count <= 50 and value.all? { |state| valid? state, :state }
+		when :array_of_colors
+			value.is_a?(Array) and value.all? { |state| valid? state, :color }
 		when :state
 			value.is_a?(Hash) and (value.keys - [:selector, :power, :color, :brightness, :duration, :infrared]).empty? and value.all? { |k, v| valid? v, k }
 		else

data/lib/lifx_api/endpoints.rb

@@ -14,36 +14,55 @@ class LifxApi
 			selector: {required: true, type: :selector, default: 'all'},
 		},
 		body_params: {
-			power: {type: :string, description: 'The power state you want to set on the selector. on or off'},
-			color: {type: :string, description: 'The color to set the light to.'},
+			power: {type: :string, description: 'The power state you want to set on the selector. Must be `on` or `off`.'},
+			color: {type: :color, description: 'The color to set the light to.'},
 			brightness: {type: :numeric, description: 'The brightness level from 0.0 to 1.0. Overrides any brightness set in color (if any).'},
 			duration: {type: :numeric, default_description: '1.0', description: 'How long in seconds you want the power action to take. Range: 0.0 - 3155760000.0 (100 years)'},
-			infrared: {type: :numeric, description: 'The maximum brightness of the infrared channel.'},
+			infrared: {type: :numeric, description: 'The maximum brightness of the infrared channel from `0.0` to `1.0`.'},
+			fast: {type: :boolean, default_description: 'false', description: 'Execute the query fast, without initial state checks and wait for no results.'},
 		},
 	}, {
 		method_name: :set_states,
 		http_method: :put,
 		path: '/v1/lights/states',
 		body_params: {
-			states: {required: true, type: :array_of_states},
-			defaults: {type: :hash},
+			states: {required: true, type: :array_of_states, description: 'Array of state hashes as per `#set_state`. No more than 50 entries.'},
+			defaults: {type: :hash, description: 'Default values to use when not specified in each `states[]` hash.'},
+			fast: {type: :boolean, default_description: 'false', description: 'Execute the query fast, without initial state checks and wait for no results.'},
 		},
 	}, {
-		method_name: :stage_delta,
+		method_name: :state_delta,
 		http_method: :post,
 		path: '/v1/lights/%{selector}/state/delta',
 		path_params: {
 			selector: {required: true, type: :selector, default: 'all'}
 		},
 		body_params: {
-			power: {type: :on_off, description: 'The power state you want to set on the selector. on or off'},
-			duration: {type: :numeric, default_description: '1.0', description: 'How long in seconds you want the power action to take. Range: 0.0 - 3155760000.0 (100 years)'},
+			power: {type: :on_off, description: 'The power state you want to set on the selector. Must be `on` or `off`.'},
+			duration: {type: :numeric, default_description: '1.0', description: 'How long in seconds you want the power action to take. Range: `0.0` - `3155760000.0` (100 years)'},
 			infrared: {type: :numeric, description: 'The maximum brightness of the infrared channel.'},
-			hue: {type: :numeric, description: 'Rotate the hue by this angle in degrees.'},
-			saturation: {type: :numeric, description: 'Change the saturation by this additive amount; the resulting saturation is clipped to [0, 1].'},
-			brightness: {type: :numeric, description: 'Change the brightness by this additive amount; the resulting brightness is clipped to [0, 1].'},
-			kelvin: {type: :numeric, description: 'Change the kelvin by this additive amount; the resulting kelvin is clipped to [2500, 9000].'},
+			hue: {type: :numeric, description: 'Rotate the hue by this angle in degrees. Range: `-360.0` - `360.0` degrees.'},
+			saturation: {type: :numeric, description: 'Change the saturation by this additive amount; the resulting saturation is clipped to `[0, 1]`.'},
+			brightness: {type: :numeric, description: 'Change the brightness by this additive amount; the resulting brightness is clipped to `[0, 1]`.'},
+			kelvin: {type: :numeric, description: 'Change the kelvin by this additive amount; the resulting kelvin is clipped to `[2500, 9000]`.'},
+		}
+	}, {
+		method_name: :stage_delta,
+		deprecation_message: '`#stage_delta` is deprecated, please use `#state_delta` instead',
+		http_method: :post,
+		path: '/v1/lights/%{selector}/state/delta',
+		path_params: {
+			selector: {required: true, type: :selector, default: 'all'}
 		},
+		body_params: {
+			power: {type: :on_off, description: 'The power state you want to set on the selector. Must be `on` or `off`.'},
+			duration: {type: :numeric, default_description: '1.0', description: 'How long in seconds you want the power action to take. Range: `0.0` - `3155760000.0` (100 years)'},
+			infrared: {type: :numeric, description: 'The maximum brightness of the infrared channel.'},
+			hue: {type: :numeric, description: 'Rotate the hue by this angle in degrees. Range: `-360.0` - `360.0` degrees.'},
+			saturation: {type: :numeric, description: 'Change the saturation by this additive amount; the resulting saturation is clipped to `[0, 1]`.'},
+			brightness: {type: :numeric, description: 'Change the brightness by this additive amount; the resulting brightness is clipped to `[0, 1]`.'},
+			kelvin: {type: :numeric, description: 'Change the kelvin by this additive amount; the resulting kelvin is clipped to `[2500, 9000]`.'},
+		}
 	}, {
 		method_name: :toggle_power,
 		http_method: :post,
@@ -52,7 +71,7 @@ class LifxApi
 			selector: {required: true, type: :selector, default: 'all'},
 		},
 		body_params: {
-			duration:	{type: :numeric, default_description: '1.0', description: 'The time is seconds to spend perfoming the power toggle.'},
+			duration: {type: :numeric, default_description: '1.0', description: 'The time is seconds to spend perfoming the power toggle.'},
 		},
 	}, {
 		method_name: :breathe_effect,
@@ -62,13 +81,51 @@ class LifxApi
 			selector: {required: true, type: :selector, default: 'all'},
 		},
 		body_params: {
-			color: {required: :true, type: :string, description: 'The color to use for the breathe effect.'},
+			color: {required: :true, type: :color, description: 'The color to use for the breathe effect.'},
 			from_color:	{type: :string, default_description: 'current bulb color', description: 'The color to start the effect from. If this parameter is omitted then the color the bulb is currently set to is used instead.'},
 			period: {type: :numeric, default_description: '1.0', description: 'The time in seconds for one cyles of the effect.'},
 			cycles: {type: :numeric, default_description: '1.0', description: 'The number of times to repeat the effect.'},
-			persist: {type: :boolean, default_description: 'false', description: 'If false set the light back to its previous value when effect ends, if true leave the last effect color.'},
-			power_on: {type: :boolean, default_description: 'true', description: 'If true, turn the bulb on if it is not already on.'},
-			peak: {type: :numeric, default_description: '0.5', description: 'Defines where in a period the target color is at its maximum. Minimum 0.0, maximum 1.0.'},
+			persist: {type: :boolean, default_description: 'false', description: 'If `false` set the light back to its previous value when effect ends, if true leave the last effect color.'},
+			power_on: {type: :boolean, default_description: 'true', description: 'If `true`, turn the bulb on if it is not already on.'},
+			peak: {type: :numeric, default_description: '0.5', description: 'Defines where in a period the target color is at its maximum. Minimum `0.0`, maximum `1.0`.'},
+		}
+	}, {
+		method_name: :move_effect,
+		http_method: :post,
+		path: '/v1/lights/%{selector}/effects/move',
+		path_params: {
+			selector: {required: true, type: :selector, default: 'all'},
+		},
+		body_params: {
+			direction: {type: :string, default_description: 'forward', description: 'Move direction, can be `forward` or `backward`.'},
+			period: {type: :numeric, default_description: '1.0', description: 'The time in seconds for one cyles of the effect.'},
+			cycles: {type: :numeric, default_description: 'infinite', description: 'The number of times to move the pattern across the device. Special cases are `0` to switch the effect off, and unspecified to continue indefinitely.'},
+			power_on: {type: :boolean, default_description: 'true', description: 'Switch any selected device that is off to on before performing the effect.'},
+		}
+	}, {
+		method_name: :morph_effect,
+		http_method: :post,
+		path: '/v1/lights/%{selector}/effects/morph',
+		path_params: {
+			selector: {required: true, type: :selector, default: 'all'},
+		},
+		body_params: {
+			period: {type: :numeric, default_description: '5.0', description: 'This controls how quickly the morph runs. It is measured in seconds. A lower number means the animation is faster.'},
+			duration: {type: :numeric, default_description: 'infinite', description: 'How long the animation lasts for in seconds. Not specifying a duration makes the animation never stop. Specifying `0` makes the animation stop. Note that there is a known bug where the tile remains in the animation once it has completed if duration is nonzero.'},
+			palette: {type: :array_of_colors, default_description: '7 colours across the spectrum', description: 'You can control the colors in the animation by specifying a list of color specifiers. For example `["red", "hue:100 saturation:1"]`.'},
+			power_on: {type: :boolean, default_description: 'true', description: 'Switch any selected device that is off to on before performing the effect.'},
+		}
+	}, {
+		method_name: :flame_effect,
+		http_method: :post,
+		path: '/v1/lights/%{selector}/effects/flame',
+		path_params: {
+			selector: {required: true, type: :selector, default: 'all'},
+		},
+		body_params: {
+			period: {type: :numeric, default_description: '5.0', description: 'This controls how quickly the flame runs. It is measured in seconds. A lower number means the animation is faster.'},
+			duration: {type: :numeric, default_description: 'infinite', description: 'How long the animation lasts for in seconds. Not specifying a duration makes the animation never stop. Specifying `0` makes the animation stop. Note that there is a known bug where the tile remains in the animation once it has completed if duration is nonzero.'},
+			power_on: {type: :boolean, default_description: 'true', description: 'Switch any selected device that is off to on before performing the effect.'},
 		}
 	}, {
 		method_name: :pulse_effect,
@@ -82,8 +139,18 @@ class LifxApi
 			from_color: {type: :string, default_description: 'current bulb color', description: 'The color to start the effect from. If this parameter is omitted then the color the bulb is currently set to is used instead.'},
 			period: {type: :numeric, default_description: '1.0', description: 'The time in seconds for one cyles of the effect.'},
 			cycles: {type: :numeric, default_description: '1.0', description: 'The number of times to repeat the effect.'},
-			persist: {type: :boolean, default_description: 'false', description: 'If false set the light back to its previous value when effect ends, if true leave the last effect color.'},
-			power_on: {type: :boolean, default_description: 'true', description: 'If true, turn the bulb on if it is not already on.'},
+			persist: {type: :boolean, default_description: 'false', description: 'If `false` set the light back to its previous value when effect ends, if true leave the last effect color.'},
+			power_on: {type: :boolean, default_description: 'true', description: 'If `true`, turn the bulb on if it is not already on.'},
+		}
+	}, {
+		method_name: :effects_off,
+		http_method: :post,
+		path: '/v1/lights/%{selector}/effects/off',
+		path_params: {
+			selector: {required: true, type: :selector, default: 'all'},
+		},
+		body_params: {
+			power_off: {type: :boolean, default_description: 'false', description: 'If `true`, the devices will also be turned off.'},
 		}
 	}, {
 		method_name: :cycle,
@@ -93,9 +160,9 @@ class LifxApi
 			selector: {required: true, type: :selector, default: 'all'},
 		},
 		body_params: {
-			states: {required: true, type: :array_of_states, description: 'Array of state hashes as per Set State. Must have 2 to 5 entries.'},
-			defaults: {type: :state, description: 'Default values to use when not specified in each states[] object.'},
-			direction: {type: :direction, description: 'Direction in which to cycle through the list. Can be forward or backward'},
+			states: {required: true, type: :array_of_states, description: 'Array of state hashes as per `#set_state`. Must have 2 to 5 entries.'},
+			defaults: {type: :state, description: 'Default values to use when not specified in each `states[]` object.'},
+			direction: {type: :direction, default_description: 'forward', description: 'Direction in which to cycle through the list. Can be `forward` or `backward`.'},
 		}
 	}, {
 		method_name: :list_scenes,
@@ -110,15 +177,15 @@ class LifxApi
 		},
 		body_params: {
 			duration: {type: :numeric, default_description: '1.0', description: 'The time in seconds to spend performing the scene transition.'},
-			ignore: {type: :ignore_array, description: 'Any of "power", "infrared", "duration", "intensity", "hue", "saturation", "brightness" or "kelvin", specifying that these properties should not be changed on devices when applying the scene.'},
-			overrides: {type: :state, description: 'A state object as per Set State specifying properties to apply to all devices in the scene, overriding those configured in the scene.'},
+			ignore: {type: :ignore_array, description: 'Any of `power`, `infrared`, `duration`, `intensity`, `hue`, `saturation`, `brightness` or `kelvin`, specifying that these properties should not be changed on devices when applying the scene.'},
+			overrides: {type: :state, description: 'A state hash as per `#set_state` specifying properties to apply to all devices in the scene, overriding those configured in the scene.'},
 		}
 	}, {
 		method_name: :validate_color,
 		http_method: :put,
 		path: '/v1/color',
 		query_params: {
-			color: {type: :string, required: true},
-		},
+			color: {type: :color, required: true, description: 'Color string you\'d like to validate'},
+		}
 	}]
 end

data/lib/lifx_api/version.rb

@@ -1,3 +1,3 @@
 class LifxApi
-	VERSION = '0.1.3'
+	VERSION = '0.2.0'
 end

data/lifx_api.gemspec

@@ -18,8 +18,7 @@ Gem::Specification.new do |spec|
 
 	spec.require_paths = ["lib"]
 
-	spec.add_development_dependency "bundler", "~> 1.15"
-	spec.add_development_dependency "rake", "~> 10.0"
 	spec.add_development_dependency "minitest", "~> 5.0"
 	spec.add_development_dependency "pry", "~> 0.10"
+	spec.add_development_dependency "rake"
 end

metadata

@@ -1,71 +1,57 @@
 --- !ruby/object:Gem::Specification
 name: lifx_api
 version: !ruby/object:Gem::Version
-  version: 0.1.3
+  version: 0.2.0
 platform: ruby
 authors:
 - cyclotron3k
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-29 00:00:00.000000000 Z
+date: 2020-04-25 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
-  name: bundler
-  requirement: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-  type: :development
-  prerelease: false
-  version_requirements: !ruby/object:Gem::Requirement
-    requirements:
-    - - "~>"
-      - !ruby/object:Gem::Version
-        version: '1.15'
-- !ruby/object:Gem::Dependency
-  name: rake
+  name: minitest
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: '5.0'
 - !ruby/object:Gem::Dependency
-  name: minitest
+  name: pry
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '5.0'
+        version: '0.10'
 - !ruby/object:Gem::Dependency
-  name: pry
+  name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '0.10'
+        version: '0'
 description: 
 email: 
 executables: []
@@ -73,6 +59,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- ".travis.yml"
 - CHANGELOG
 - Gemfile
 - LICENSE.txt
@@ -102,8 +89,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.5.1
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: A client for the LIFX HTTP API