lifx_api 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: d724c2ee6d1e686079cbcf9bda0f888547d8db20
-  data.tar.gz: e5a883b787b636d093401004320b6d44cac66510
+  metadata.gz: 7063a23a72264177f1c0390f2f166c9786b89dde
+  data.tar.gz: 5612881962ec05bd1fa756162ada974d52812f05
 SHA512:
-  metadata.gz: 186ec61411ed72701e4e72c98ab795c6c55f16ee026d0e10533579d831cbffd776a3d91027457e03abc743e610d346bb9716011d848df083b546a95696954ac8
-  data.tar.gz: d9febdadb923782c658e73158557ad5c9970ef263868f90addd0435a970ce133c1fc484d91f1076bcad9f0269353a0ee7bf090bcbcdee81ee77cd135ed7f8a5f
+  metadata.gz: d0af62c3c50bf5b19da43f0315dabbd21b3dec47a116722463ef0378b6423d4eb7aedf5f3ea4011fd0a28a23393f89ad892502297ea7c28759d4c492bd5d4fb2
+  data.tar.gz: eb95de0ae02a7bbb1eb17235b904f347decc4ecb67ad5ed93354edb821881eb6ad567483f96f508a9c9c7d848ccf12dd8a5a0c17c3d6f4ec64dd9fa6f9c8e1ad

data/CHANGELOG

@@ -0,0 +1,15 @@
+=== 0.1.2
+
+* Better validation of :selectors
+
+* Unit tests for validators
+
+* Fix some errors in the endpoints definition
+
+=== 0.1.1
+
+* Added endpoint documentation
+
+=== 0.0.1
+
+* 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 |
 
 ### set_state
 
@@ -56,7 +56,7 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all | 
+`:selector` | selector |  | all |
 `: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` |  | ✔ |  |
+`:defaults` | hash |  |  |
 
 ### stage_delta
 
@@ -78,7 +78,7 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all | 
+`:selector` | selector |  | all |
 `:power` | on_off |  |  | The power state you want to set on the selector. 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.
@@ -93,7 +93,7 @@ Key | Type | Mandatory | Default | Description
 
 Key | Type | Mandatory | Default | Description
 --- | --- | --- | --- | ---
-`:selector` | selector |  | all | 
+`:selector` | selector |  | all |
 `: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 |
 `: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 |
 `: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.
@@ -179,6 +179,11 @@ If there is an error, LifxApi will raise an exception. The exception message wil
 
 Run `rake test` to run the tests and `rake console` to start an interactive pry console.
 
+## TODO
+
+* Validation of `:state' and ':array_of_states' is poor
+* Validation of endpoints is non-existent
+
 ## Contributing
 
 Bug reports and pull requests are welcome on GitHub at https://github.com/cyclotron3k/lifx_api.

data/lib/lifx_api.rb

@@ -49,21 +49,31 @@ class LifxApi
 	def valid?(value, value_format)
 		case value_format
 		when :selector
-			value =~ /^((label|id|(location|group)(_id)?|scene_id):.*|all)$/
-		when :numeric
-			value.is_a?(Numeric) or value =~ /^[\d\.]+$/
+			value.split(',').all? do |selector|
+				/^((label|id|(location|group)(_id)?|scene_id):.*|all)(:random|(\|[-\d]+)+)?$/ === selector
+			end
+		when :numeric, :brightness, :duration, :infrared
+			value.is_a?(Numeric) or /^[\d\.]+$/ === value
 		when :boolean
 			['true', 'false', true, false].include? value
-		when :on_off
+		when :on_off, :power
 			['on', 'off'].include? value
 		when :hash
 			value.is_a? Hash
-		when :string
+		when :string, :color
 			value.is_a? String
 		when :uuid
-			value.is_a?(String) and value =~ /^[\da-f]{4}([\da-f]{4}-){4}[\da-f]{12}$/
+			value.is_a?(String) and /^[\da-f]{4}([\da-f]{4}-){4}[\da-f]{12}$/ === value
+		when :ignore_array
+			value.is_a?(Array) and (value - ['power', 'infrared', 'duration', 'intensity', 'hue', 'saturation', 'brightness', 'kelvin']).empty?
+		when :direction
+			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 :state
+			value.is_a?(Hash) and (value.keys - [:selector, :power, :color, :brightness, :duration, :infrared]).empty? and value.all? { |k, v| valid? v, k }
 		else
-			puts "Don't know how to validate #{value_format}" if DEBUG
+			raise ArgumentError, "Don't know how to validate #{value_format}"
 			true
 		end
 	end

data/lib/lifx_api/endpoints.rb

@@ -25,7 +25,7 @@ class LifxApi
 		http_method: :put,
 		path: '/v1/lights/states',
 		body_params: {
-			states: {required: true},
+			states: {required: true, type: :array_of_states},
 			defaults: {type: :hash},
 		},
 	}, {
@@ -90,9 +90,9 @@ class LifxApi
 		http_method: :post,
 		path: '/v1/lights/%{selector}/cycle',
 		body_params: {
-			states: {required: true, type: 'array of mixed', description: 'Array of state hashes as per Set State. Must have 2 to 5 entries.'},
-			defaults: {type: 'object', description: 'Default values to use when not specified in each states[] object.'},
-			direction: {type: 'stringforward', 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, description: 'Direction in which to cycle through the list. Can be forward or backward'},
 		}
 	}, {
 		method_name: :list_scenes,
@@ -107,8 +107,8 @@ class LifxApi
 		},
 		body_params: {
 			duration: {type: :numeric, default_description: '1.0', description: 'The time in seconds to spend performing the scene transition.'},
-			ignore: {type: 'array of strings', 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: 'object', 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 object as per Set State specifying properties to apply to all devices in the scene, overriding those configured in the scene.'},
 		}
 	}, {
 		method_name: :validate_color,

data/lib/lifx_api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: lifx_api
 version: !ruby/object:Gem::Version
-  version: 0.1.1
+  version: 0.1.2
 platform: ruby
 authors:
 - cyclotron3k
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2017-09-21 00:00:00.000000000 Z
+date: 2017-09-28 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -73,6 +73,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - ".gitignore"
+- CHANGELOG
 - Gemfile
 - LICENSE.txt
 - README.md