Merge pull request #1 from ai91/dev

Dev

Author: ai91

README.md

@@ -78,7 +78,7 @@ By default, logging is performed to console. Optionally it's possible to configu
 The basic configuration is responsible for communication and application itself. 
 
 Meanwhile, there is an extended configuration, which describes your smart home configuration, rules, and value mappings between your home automation system and Alisa Smart Home Skill. 
-The extended configuration is takes place in the [config/devices.json](config/devices.json).
+The extended configuration takes place in the [config/devices.json](config/devices.json).
 
 The **devices.json** configuration is a bit sophisticated, therefore I provide it in the dedicated [document](config/)
 

alisamqttbridge/src/main/java/by/ibn/alisamqttbridge/JWTSecurityConfig.java

@@ -29,6 +29,7 @@ public class JWTSecurityConfig extends WebSecurityConfigurerAdapter {
     protected void configure(HttpSecurity http) throws Exception {
         http
           .authorizeRequests(authz -> authz
+        	.antMatchers("/").permitAll()
             .antMatchers("/user/**").hasAuthority("SCOPE_" + scope)
             .anyRequest().authenticated())
           .oauth2ResourceServer(oauth2 -> oauth2.jwt());

alisamqttbridge/src/main/java/by/ibn/alisamqttbridge/controllers/LivenessController.java

@@ -0,0 +1,35 @@
+package by.ibn.alisamqttbridge.controllers;
+
+import org.slf4j.Logger;
+import org.slf4j.LoggerFactory;
+import org.springframework.http.HttpStatus;
+import org.springframework.http.ResponseEntity;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.bind.annotation.RequestMethod;
+import org.springframework.web.bind.annotation.RestController;
+
+import by.ibn.alisamqttbridge.resources.Response;
+
+/**
+ * Entry point liveness check
+ *
+ * @author Anar Ibragimoff
+ *
+ */
+@RestController
+public class LivenessController {
+
+	private Logger log = LoggerFactory.getLogger(LivenessController.class);
+
+	@RequestMapping(
+			path = "/", 
+			method = RequestMethod.HEAD)
+	public ResponseEntity<Response> head() {
+
+		log.trace("Processing request");
+
+		return new ResponseEntity<Response>(HttpStatus.OK);
+		
+	}
+
+}

alisamqttbridge/src/main/java/by/ibn/alisamqttbridge/service/DevicesService.java

@@ -1,10 +1,7 @@
 package by.ibn.alisamqttbridge.service;
 
-import java.net.InetAddress;
-import java.net.UnknownHostException;
-import java.util.UUID;
-
 import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.beans.factory.annotation.Value;
 import org.springframework.stereotype.Service;
 
 import by.ibn.alisamqttbridge.resources.Payload;
@@ -15,18 +12,17 @@ public class DevicesService {
 
 	@Autowired
 	private DeviceRepository devicesRepository;
+	
+	@Value("${devices.payload.userId:66211404}")
+	private String userId;
 
 	public Response getDevices(String requestId) {
 
 		Response response = new Response();
 
 		response.requestId = requestId;
 		response.payload = new Payload();
-		try {
-			response.payload.userId = InetAddress.getLocalHost().getHostName();
-		} catch (UnknownHostException e) {
-			response.payload.userId = UUID.randomUUID().toString();
-		}
+		response.payload.userId = userId;
 
 		response.payload.devices = devicesRepository.getDeviceResources();
 

alisamqttbridge/src/test/java/by/ibn/alisamqttbridge/controllers/LivenessControllerTest.java

@@ -0,0 +1,39 @@
+package by.ibn.alisamqttbridge.controllers;
+
+import org.eclipse.paho.client.mqttv3.IMqttClient;
+import org.eclipse.paho.client.mqttv3.MqttConnectOptions;
+import org.junit.jupiter.api.Test;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.boot.test.autoconfigure.web.servlet.AutoConfigureMockMvc;
+import org.springframework.boot.test.context.SpringBootTest;
+import org.springframework.boot.test.mock.mockito.MockBean;
+import org.springframework.test.context.ActiveProfiles;
+import org.springframework.test.web.servlet.MockMvc;
+import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
+import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
+
+import by.ibn.alisamqttbridge.MQTTConfiguration;
+
+@SpringBootTest
+@AutoConfigureMockMvc
+@ActiveProfiles("test")
+class LivenessControllerTest {
+
+	// just to disable
+	@MockBean MQTTConfiguration mqtt;
+	@MockBean IMqttClient mqttClient;
+	@MockBean MqttConnectOptions mqttConnectOptions;
+
+	@Autowired
+	private MockMvc mvc;
+	
+	@Test
+	void testHead() throws Exception {
+
+		mvc
+		.perform(MockMvcRequestBuilders.head("/"))
+		.andExpect(MockMvcResultMatchers.status().isOk());
+
+	}
+	
+}

config/README.md

@@ -20,9 +20,9 @@ Each `rule` object may contain following nodes:
 - `valueMapsToMqtt` - mapping rules, when it's necessary to convert a value received from `devices/action` before publish to MQTT
 
 #### rule.alexa
-This node may contain following nodes:
-- `alisa.instance` - is an Alisa controller instance under `state` node.
-- `alisa.subvalue` - when reporting state to Alisa, the `state` should be a complex node, rather than a simple value. It defines a subnode name under `state` for providing state. For example for `devices.capabilities.color_setting` with `color_model`=`hsv`, the expected report value must be like that:
+This node may contain following subnodes:
+- `alisa.instance` - is an `instance` under `state` node in communication with Alisa.
+- `alisa.subvalue` - when reporting state to Alisa, the `value` should be a complex node, rather than a simple value. It defines a subnode name under `state.value` for providing state. For example for `devices.capabilities.color_setting` with `color_model`=`hsv`, the expected report value must be like that:
 
 ```json
 ...
@@ -74,7 +74,7 @@ to achieve that, it's necessary to define 3 rules, one per subvalue:
 ```
 
 #### rule.mqtt
-This node may contain following nodes:
+This node may contain following subnodes:
 - `mqtt.state` - topic name with values received from Home Automation System. Used as a value-source for `devices/query` responses.
 - `mqtt.commands` - topic name for commands to be sent to Home Automation System. Used as target-topic for `devices/action` commands received from Alexa.
 
@@ -192,6 +192,13 @@ in this case, one can use <code>h</code>, <code>s</code>, and <code>v</code> as
 
 When rule contains multiple mappings, they are attempted to be applied in order from first to last. If some mapping can't be applied (for example `value` mapping doesn't match `from` field), then this mapping is skipped, and verified next one. Iteration stopped after first successful conversion.    
 
+Though most of mapping types (except `linearRange`) are having output definitions as strings, when sent to Alisa as a query-response, they get casted to appropriate type automatically. For example:
+-  `{ "type": "static", "value": "abc" }`, produces string: `{ "state": { "value": "abc" } }`
+-  `{ "type": "static", "value": "1" }`, produces integer: `{ "state": { "value": 1 } }`
+-  `{ "type": "static", "value": "1.0" }`, produces float: `{ "state": { "value": 1.0 } }`
+-  `{ "type": "static", "value": "true" }`, produces boolean: `{ "state": { "value": true } }`
+-  `{ "type": "static", "value": "{\"h\":255,\"s\":50,\"v\":100}" }`, produces json: `{ "state": { "value": { "h": 255, "s": 50, "v": 100 } } }`
+
 # Troubleshooting
 Potential misconfigurations may cause either stop of the whole application, or some devices or rules may be ignored.