Use the github URL as user-agent and specify a date-code as software …

…version in the sens-com upload message.

sensor-data-bridge/src/main/java/nl/bertriksikken/loraforwarder/AttributeMap.java

@@ -7,7 +7,7 @@ public final class AttributeMap extends HashMap<String, String> {
 
     private static final long serialVersionUID = 1L;
 
-    AttributeMap(Map<String, String> map) {
+    public AttributeMap(Map<String, String> map) {
         super(map);
     }
 

sensor-data-bridge/src/main/java/nl/bertriksikken/senscom/SensComConfig.java

@@ -6,7 +6,11 @@ public final class SensComConfig extends RestApiConfig {
 
     // jackson no-arg constructor
     public SensComConfig() {
-        super("https://api.sensor.community", 30);
+        this("https://api.sensor.community", 30);
+    }
+
+    SensComConfig(String host, int timeout) {
+        super(host, timeout);
     }
 
 }

sensor-data-bridge/src/main/java/nl/bertriksikken/senscom/SensComUploader.java

@@ -5,6 +5,7 @@
 import java.util.HashMap;
 import java.util.Locale;
 import java.util.Map;
+import java.util.Objects;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Executors;
 
@@ -19,7 +20,9 @@
 import nl.bertriksikken.loraforwarder.util.CatchingRunnable;
 import nl.bertriksikken.pm.ESensorItem;
 import nl.bertriksikken.pm.SensorData;
+import okhttp3.Interceptor.Chain;
 import okhttp3.OkHttpClient;
+import okhttp3.Request;
 import retrofit2.Response;
 import retrofit2.Retrofit;
 import retrofit2.converter.jackson.JacksonConverterFactory;
@@ -31,7 +34,8 @@
 public final class SensComUploader implements IUploader {
 
     private static final Logger LOG = LoggerFactory.getLogger(SensComUploader.class);
-    private static final String SOFTWARE_VERSION = "https://github.com/bertrik/sensor-data-bridge";
+    private static final String USER_AGENT = "github.com/bertrik/sensor-data-bridge";
+    private static final String SOFTWARE_VERSION = "20231015";
 
     private final ExecutorService executor = Executors.newSingleThreadExecutor();
     private final ObjectMapper mapper = new ObjectMapper();
@@ -46,7 +50,7 @@ public final class SensComUploader implements IUploader {
      * @param restClient the REST client
      */
     SensComUploader(ISensComApi restClient) {
-        this.restClient = restClient;
+        this.restClient = Objects.requireNonNull(restClient);
     }
 
     /**
@@ -55,15 +59,20 @@ public final class SensComUploader implements IUploader {
     public static SensComUploader create(SensComConfig config) {
         LOG.info("Creating new REST client for '{}' with timeout {}", config.getUrl(), config.getTimeout());
         Duration timeout = config.getTimeout();
-        OkHttpClient client = new OkHttpClient().newBuilder().connectTimeout(timeout).readTimeout(timeout)
-                .writeTimeout(timeout).build();
+        OkHttpClient client = new OkHttpClient().newBuilder().addInterceptor(SensComUploader::addUserAgent)
+                .connectTimeout(timeout).readTimeout(timeout).writeTimeout(timeout).build();
         Retrofit retrofit = new Retrofit.Builder().baseUrl(config.getUrl())
                 .addConverterFactory(ScalarsConverterFactory.create())
                 .addConverterFactory(JacksonConverterFactory.create()).client(client).build();
         ISensComApi restClient = retrofit.create(ISensComApi.class);
         return new SensComUploader(restClient);
     }
 
+    private static okhttp3.Response addUserAgent(Chain chain) throws IOException {
+        Request userAgentRequest = chain.request().newBuilder().header("User-Agent", USER_AGENT).build();
+        return chain.proceed(userAgentRequest);
+    }
+
     @Override
     public void start() {
         LOG.info("Starting sensor.community uploader");

sensor-data-bridge/src/test/java/nl/bertriksikken/senscom/RunSenscomUploader.java

@@ -0,0 +1,40 @@
+package nl.bertriksikken.senscom;
+
+import java.util.HashMap;
+import java.util.Map;
+
+import nl.bertriksikken.loraforwarder.AppDeviceId;
+import nl.bertriksikken.loraforwarder.AttributeMap;
+import nl.bertriksikken.pm.ESensorItem;
+import nl.bertriksikken.pm.SensorData;
+
+/**
+ * Runs the SensComUploader to send a basic message to a local server, in order
+ * to inspect the actual HTTP request.
+ * <p>
+ * Use with (for example):
+ * https://gist.github.com/mdonkers/63e115cc0c79b4f6b8b3a6b797e485c7
+ */
+public final class RunSenscomUploader {
+
+    public static void main(String[] args) {
+        RunSenscomUploader runner = new RunSenscomUploader();
+        runner.run();
+    }
+
+    private void run() {
+        SensComConfig config = new SensComConfig("http://localhost:8080", 10);
+        SensComUploader uploader = SensComUploader.create(config);
+        uploader.start();
+
+        AppDeviceId id = new AppDeviceId("app", "device");
+        Map<AppDeviceId, AttributeMap> attributes = new HashMap<>();
+        attributes.put(id, new AttributeMap(Map.of("senscom-id", "sensor")));
+        uploader.scheduleProcessAttributes(attributes);
+
+        SensorData sensorData = new SensorData();
+        sensorData.addValue(ESensorItem.TEMP, 12.34);
+        uploader.scheduleUpload(id, sensorData);
+    }
+
+}