lifx_api 0.1.2 → 0.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 7063a23a72264177f1c0390f2f166c9786b89dde
-  data.tar.gz: 5612881962ec05bd1fa756162ada974d52812f05
+  metadata.gz: bfc68d8f7402d1601df1501e8c1e4651167b4ec3
+  data.tar.gz: 85e218c1af08c463dfc303baf55ed00ddeadbab0
 SHA512:
-  metadata.gz: d0af62c3c50bf5b19da43f0315dabbd21b3dec47a116722463ef0378b6423d4eb7aedf5f3ea4011fd0a28a23393f89ad892502297ea7c28759d4c492bd5d4fb2
-  data.tar.gz: eb95de0ae02a7bbb1eb17235b904f347decc4ecb67ad5ed93354edb821881eb6ad567483f96f508a9c9c7d848ccf12dd8a5a0c17c3d6f4ec64dd9fa6f9c8e1ad
+  metadata.gz: 669bd924831b096444fb8ef7c7b6620776aecfec6fa2a4ed9c636b6598d44ce54b8231af3b540c69f068d390afcb156019a1ad4b0e67d8873b6c8efb90abe0c8
+  data.tar.gz: 3a0803ad3a792973ec00a0629d74f6bf93772a653ed22e7e44070d84a1151742b0bb288ca41ea2319e5a8a5d9e18571fef31e81a2fcb410bf90511de1d733bc1

data/CHANGELOG

@@ -1,3 +1,7 @@
+=== 0.1.3
+
+* Fix documentation and specification of `cycle` endpoint
+
 === 0.1.2
 
 * Better validation of :selectors
@@ -12,4 +16,4 @@
 
 === 0.0.1
 
-* Initial release
+* Initial release

data/README.md

@@ -48,7 +48,7 @@ See [LIFX HTTP API](https://api.developer.lifx.com/) for the official documentat
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all |
+`:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
 
 ### set_state
 
@@ -56,7 +56,7 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all |
+`: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.
 `:brightness` | numeric |  |  | The brightness level from 0.0 to 1.0. Overrides any brightness set in color (if any).
@@ -69,8 +69,8 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:states` |  | ✔ |  |
-`:defaults` | hash |  |  |
+`:states` |  array of states | ✔ |  | 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.
 
 ### stage_delta
 
@@ -78,8 +78,8 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all |
-`:power` | on_off |  |  | The power state you want to set on the selector. on or off
+`: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.
@@ -93,7 +93,7 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all |
+`:selector` | selector |  | all | See [selector](https://api.developer.lifx.com/docs/selectors) documentation on the LIFX website
 `:duration` | numeric |  | 1.0 | The time is seconds to spend perfoming the power toggle.
 
 ### breathe_effect
@@ -102,7 +102,7 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all |
+`: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.
 `: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.
@@ -117,7 +117,7 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all |
+`: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 pulse 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.
@@ -131,9 +131,10 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:states` | array of mixed | ✔ |  | Array of state hashes as per Set State. Must have 2 to 5 entries.
-`:defaults` | object |  |  | Default values to use when not specified in each states[] object.
-`:direction` | stringforward |  |  | Direction in which to cycle through the list. Can be forward or backward
+`: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".
 
 ### list_scenes
 
@@ -148,7 +149,7 @@ 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` | object |  |  | A state object as per Set State specifying properties to apply to all devices in the scene, overriding those configured in 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.
 
 ### validate_color
 
@@ -156,11 +157,11 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:color` | string | ✔ |  |
+`:color` | string | ✔ |  | Color string you'd like to validate
 
 ## Deviation from the API spec
 
-Some API endpoints require a mandatory [`selector`](https://api.developer.lifx.com/docs/selectors) parameter, which defines which bulbs to apply your action to. This client will default the `selector` parameter to `'all`', if no selector is provided.
+Some API endpoints require a mandatory [`selector`](https://api.developer.lifx.com/docs/selectors) parameter, which defines which bulbs to apply your action to. This client will default the `selector` parameter to `'all'`, if no selector is provided.
 
 ```ruby
 # which means that you can call
@@ -181,7 +182,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 `:state` and `:array_of_states` is poor
 * Validation of endpoints is non-existent
 
 ## Contributing

data/lib/lifx_api/endpoints.rb

@@ -89,6 +89,9 @@ class LifxApi
 		method_name: :cycle,
 		http_method: :post,
 		path: '/v1/lights/%{selector}/cycle',
+		path_params: {
+			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.'},

data/lib/lifx_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx_api
 version: !ruby/object:Gem::Version
-  version: 0.1.2
+  version: 0.1.3
 platform: ruby
 authors:
 - cyclotron3k
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-28 00:00:00.000000000 Z
+date: 2017-09-29 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler