Extract the application core from infrastructure

backend/src/main/java/pl/itrack/airqeye/store/dataclient/luftdaten/mapper/AddressMapper.java

@@ -3,8 +3,8 @@
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
 import pl.itrack.airqeye.store.dataclient.luftdaten.model.Location;
-import pl.itrack.airqeye.store.measurement.entity.Address;
-import pl.itrack.airqeye.store.measurement.mapper.DefaultMapperConfig;
+import pl.itrack.airqeye.store.measurement.domain.model.Address;
+import pl.itrack.airqeye.store.measurement.infrastructure.mapper.DefaultMapperConfig;
 
 @Mapper(config = DefaultMapperConfig.class)
 interface AddressMapper {

backend/src/main/java/pl/itrack/airqeye/store/dataclient/luftdaten/mapper/InstallationMapper.java

@@ -3,8 +3,8 @@
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
 import pl.itrack.airqeye.store.dataclient.luftdaten.model.LuftdatenMeasurement;
-import pl.itrack.airqeye.store.measurement.entity.Installation;
-import pl.itrack.airqeye.store.measurement.mapper.DefaultMapperConfig;
+import pl.itrack.airqeye.store.measurement.domain.model.Installation;
+import pl.itrack.airqeye.store.measurement.infrastructure.mapper.DefaultMapperConfig;
 
 @Mapper(config = DefaultMapperConfig.class,
     uses = {LocationMapper.class, AddressMapper.class, SensorMapper.class})

backend/src/main/java/pl/itrack/airqeye/store/dataclient/luftdaten/mapper/LocationMapper.java

@@ -2,8 +2,8 @@
 
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
-import pl.itrack.airqeye.store.measurement.entity.Location;
-import pl.itrack.airqeye.store.measurement.mapper.DefaultMapperConfig;
+import pl.itrack.airqeye.store.measurement.domain.model.Location;
+import pl.itrack.airqeye.store.measurement.infrastructure.mapper.DefaultMapperConfig;
 
 @Mapper(config = DefaultMapperConfig.class)
 interface LocationMapper {

backend/src/main/java/pl/itrack/airqeye/store/dataclient/luftdaten/mapper/MeasurementMapper.java

@@ -16,9 +16,9 @@
 import org.mapstruct.Mapping;
 import pl.itrack.airqeye.store.dataclient.luftdaten.model.LuftdatenMeasurement;
 import pl.itrack.airqeye.store.dataclient.luftdaten.model.SensorData;
-import pl.itrack.airqeye.store.measurement.entity.Measurement;
-import pl.itrack.airqeye.store.measurement.enumeration.Country;
-import pl.itrack.airqeye.store.measurement.mapper.DefaultMapperConfig;
+import pl.itrack.airqeye.store.measurement.domain.model.Measurement;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.Country;
+import pl.itrack.airqeye.store.measurement.infrastructure.mapper.DefaultMapperConfig;
 
 @Mapper(config = DefaultMapperConfig.class,
     uses = {MeasurementValueMapper.class, InstallationMapper.class})

backend/src/main/java/pl/itrack/airqeye/store/dataclient/luftdaten/mapper/MeasurementValueMapper.java

@@ -11,10 +11,10 @@
 import org.mapstruct.Mapping;
 import org.mapstruct.Named;
 import pl.itrack.airqeye.store.dataclient.luftdaten.model.SensorData;
-import pl.itrack.airqeye.store.measurement.entity.MeasurementValue;
-import pl.itrack.airqeye.store.measurement.enumeration.MeasurementType;
-import pl.itrack.airqeye.store.measurement.enumeration.MeasurementUnit;
-import pl.itrack.airqeye.store.measurement.mapper.DefaultMapperConfig;
+import pl.itrack.airqeye.store.measurement.domain.model.MeasurementValue;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.MeasurementType;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.MeasurementUnit;
+import pl.itrack.airqeye.store.measurement.infrastructure.mapper.DefaultMapperConfig;
 
 @Mapper(config = DefaultMapperConfig.class)
 interface MeasurementValueMapper {

backend/src/main/java/pl/itrack/airqeye/store/dataclient/luftdaten/mapper/SensorMapper.java

@@ -2,8 +2,8 @@
 
 import org.mapstruct.Mapper;
 import org.mapstruct.Mapping;
-import pl.itrack.airqeye.store.measurement.entity.Sensor;
-import pl.itrack.airqeye.store.measurement.mapper.DefaultMapperConfig;
+import pl.itrack.airqeye.store.measurement.domain.model.Sensor;
+import pl.itrack.airqeye.store.measurement.infrastructure.mapper.DefaultMapperConfig;
 
 @Mapper(config = DefaultMapperConfig.class)
 interface SensorMapper {

backend/src/main/java/pl/itrack/airqeye/store/dataclient/luftdaten/service/LuftdatenService.java

@@ -1,49 +1,52 @@
 package pl.itrack.airqeye.store.dataclient.luftdaten.service;
 
 import java.util.List;
-import java.util.function.Supplier;
 import org.springframework.stereotype.Service;
 import org.springframework.transaction.annotation.Transactional;
 import pl.itrack.airqeye.store.dataclient.luftdaten.LuftdatenClient;
 import pl.itrack.airqeye.store.dataclient.luftdaten.mapper.MeasurementMapper;
-import pl.itrack.airqeye.store.measurement.entity.Measurement;
-import pl.itrack.airqeye.store.measurement.enumeration.Feeder;
-import pl.itrack.airqeye.store.measurement.service.HasUpdatableDataFeed;
-import pl.itrack.airqeye.store.measurement.service.MeasurementService;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.Feeder;
+import pl.itrack.airqeye.store.measurement.domain.model.Measurement;
+import pl.itrack.airqeye.store.measurement.domain.service.HasUpdatableDataFeed;
+import pl.itrack.airqeye.store.measurement.infrastructure.service.MeasurementServiceAdapter;
 
+@Transactional
 @Service
 public class LuftdatenService implements HasUpdatableDataFeed {
 
   private LuftdatenClient luftdatenClient;
 
   private MeasurementMapper measurementMapper;
 
-  private MeasurementService measurementService;
+  private MeasurementServiceAdapter measurementService;
 
   public LuftdatenService(
       final LuftdatenClient luftdatenClient,
       final MeasurementMapper measurementMapper,
-      final MeasurementService measurementService) {
+      final MeasurementServiceAdapter measurementService) {
     this.luftdatenClient = luftdatenClient;
     this.measurementMapper = measurementMapper;
     this.measurementService = measurementService;
   }
 
-  // TODO: Data should be separately retrieved and persisted by some background job.
-  @Override
-  @Transactional
-  public void refreshDataIfRequired() {
-    final Supplier<List<Measurement>> luftdatenFeed = this::retrieveData;
-    measurementService.refreshDataIfRequired(luftdatenFeed, Feeder.LUFTDATEN);
-  }
-
   /**
    * Calls Luftdaten data feed and converts retrieved data to entities ready for persistence.
    *
    * @return list of measurements
    */
+  @Override
   @Transactional(readOnly = true)
-  List<Measurement> retrieveData() {
+  public List<Measurement> retrieveData() {
     return measurementMapper.fromDtos(luftdatenClient.getMeasurements());
   }
+
+  @Override
+  public MeasurementServiceAdapter getMeasurementService() {
+    return measurementService;
+  }
+
+  @Override
+  public Feeder getFeederType() {
+    return Feeder.LUFTDATEN;
+  }
 }

backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/config/MeasurementProperties.java

@@ -0,0 +1,6 @@
+package pl.itrack.airqeye.store.measurement.domain.config;
+
+public interface MeasurementProperties {
+
+  int getUpdateFrequencyInMinutes();
+}

backend/src/main/java/pl/itrack/airqeye/store/measurement/enumeration/Country.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/enumeration/Country.java

@@ -1,6 +1,6 @@
-package pl.itrack.airqeye.store.measurement.enumeration;
+package pl.itrack.airqeye.store.measurement.domain.enumeration;
 
-import java.util.Arrays;
+import java.util.stream.Stream;
 
 public enum Country {
   AE, AL, AR, AT, AU, BA, BE, BG, BO, BY, CA, CD, CH, CL, CN, CR, CY, CZ, DE, DK, DO, ES, FI, FR,
@@ -14,7 +14,7 @@ public enum Country {
    * @return true if success, otherwise false
    */
   public static boolean contains(final String testedValue) {
-    return Arrays.stream(values())
+    return Stream.of(values())
         .map(Enum::name)
         .anyMatch(code -> code.equals(testedValue));
   }

backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/enumeration/Feeder.java

@@ -0,0 +1,5 @@
+package pl.itrack.airqeye.store.measurement.domain.enumeration;
+
+public enum Feeder {
+  LUFTDATEN, AIRLY, ARMAAG, GIOS
+}

backend/src/main/java/pl/itrack/airqeye/store/measurement/enumeration/MeasurementType.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/enumeration/MeasurementType.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.enumeration;
+package pl.itrack.airqeye.store.measurement.domain.enumeration;
 
 public enum MeasurementType {
   PM1, PM25, PM10, PRESSURE, HUMIDITY, TEMPERATURE

backend/src/main/java/pl/itrack/airqeye/store/measurement/enumeration/MeasurementUnit.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/enumeration/MeasurementUnit.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.enumeration;
+package pl.itrack.airqeye.store.measurement.domain.enumeration;
 
 /**
  * Units: °C, µg/m3.

backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/enumeration/Province.java

@@ -0,0 +1,5 @@
+package pl.itrack.airqeye.store.measurement.domain.enumeration;
+
+public enum Province {
+  POMORSKIE // TODO: add the rest
+}

backend/src/main/java/pl/itrack/airqeye/store/measurement/entity/Address.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/model/Address.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.entity;
+package pl.itrack.airqeye.store.measurement.domain.model;
 
 import javax.persistence.Column;
 import javax.persistence.Embeddable;
@@ -7,8 +7,8 @@
 import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
-import pl.itrack.airqeye.store.measurement.enumeration.Country;
-import pl.itrack.airqeye.store.measurement.enumeration.Province;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.Country;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.Province;
 
 @Data
 @Builder

backend/src/main/java/pl/itrack/airqeye/store/measurement/entity/Installation.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/model/Installation.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.entity;
+package pl.itrack.airqeye.store.measurement.domain.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.util.ArrayList;
@@ -21,7 +21,7 @@
 import lombok.EqualsAndHashCode;
 import lombok.NoArgsConstructor;
 import lombok.ToString;
-import pl.itrack.airqeye.store.measurement.enumeration.Feeder;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.Feeder;
 
 @Data
 @Builder(toBuilder = true)

backend/src/main/java/pl/itrack/airqeye/store/measurement/entity/Location.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/model/Location.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.entity;
+package pl.itrack.airqeye.store.measurement.domain.model;
 
 import javax.persistence.Column;
 import javax.persistence.Embeddable;

backend/src/main/java/pl/itrack/airqeye/store/measurement/entity/Measurement.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/model/Measurement.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.entity;
+package pl.itrack.airqeye.store.measurement.domain.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import java.time.LocalDateTime;

backend/src/main/java/pl/itrack/airqeye/store/measurement/entity/MeasurementValue.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/model/MeasurementValue.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.entity;
+package pl.itrack.airqeye.store.measurement.domain.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import javax.persistence.Column;
@@ -12,8 +12,8 @@
 import lombok.Builder;
 import lombok.Data;
 import lombok.NoArgsConstructor;
-import pl.itrack.airqeye.store.measurement.enumeration.MeasurementType;
-import pl.itrack.airqeye.store.measurement.enumeration.MeasurementUnit;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.MeasurementType;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.MeasurementUnit;
 
 @Data
 @Builder(toBuilder = true)

backend/src/main/java/pl/itrack/airqeye/store/measurement/entity/Sensor.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/model/Sensor.java

@@ -1,4 +1,4 @@
-package pl.itrack.airqeye.store.measurement.entity;
+package pl.itrack.airqeye.store.measurement.domain.model;
 
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import javax.persistence.Column;

backend/src/main/java/pl/itrack/airqeye/store/dataclient/FeederRegistry.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/service/FeederRegistry.java

@@ -1,8 +1,7 @@
-package pl.itrack.airqeye.store.dataclient;
+package pl.itrack.airqeye.store.measurement.domain.service;
 
 import java.util.List;
 import org.springframework.stereotype.Component;
-import pl.itrack.airqeye.store.measurement.service.HasUpdatableDataFeed;
 
 /**
  * The component collects a list of available data feeders.

backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/service/HasUpdatableDataFeed.java

@@ -0,0 +1,18 @@
+package pl.itrack.airqeye.store.measurement.domain.service;
+
+import java.util.List;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.Feeder;
+import pl.itrack.airqeye.store.measurement.domain.model.Measurement;
+
+public interface HasUpdatableDataFeed {
+
+  default void refreshDataIfRequired() {
+    getMeasurementService().refreshDataIfRequired(this::retrieveData, getFeederType());
+  }
+
+  List<Measurement> retrieveData();
+
+  MeasurementService getMeasurementService();
+
+  Feeder getFeederType();
+}

backend/src/main/java/pl/itrack/airqeye/store/measurement/service/InstallationNotFoundException.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/service/InstallationNotFoundException.java

@@ -1,8 +1,8 @@
-package pl.itrack.airqeye.store.measurement.service;
+package pl.itrack.airqeye.store.measurement.domain.service;
 
 public class InstallationNotFoundException extends RuntimeException {
 
-  InstallationNotFoundException(final Long id) {
+  public InstallationNotFoundException(final Long id) {
     super("Could not find installation " + id);
   }
 }

backend/src/main/java/pl/itrack/airqeye/store/measurement/domain/service/MeasurementService.java

@@ -0,0 +1,66 @@
+package pl.itrack.airqeye.store.measurement.domain.service;
+
+import java.time.LocalDateTime;
+import java.time.ZoneOffset;
+import java.util.List;
+import java.util.function.Supplier;
+import pl.itrack.airqeye.store.measurement.domain.config.MeasurementProperties;
+import pl.itrack.airqeye.store.measurement.domain.enumeration.Feeder;
+import pl.itrack.airqeye.store.measurement.domain.model.Measurement;
+
+/**
+ * The main service handling the measurement related processes.
+ */
+public interface MeasurementService {
+
+  /**
+   * Retrieves measurements from all providers.
+   *
+   * @return a list of all measurements
+   */
+  List<Measurement> retrieveMeasurements();
+
+  /**
+   * Provides the latest measurements related to given feeders's installation.
+   *
+   * @param stationId - related installation
+   * @param feeder    - related data provider
+   * @return measurements
+   */
+  List<Measurement> retrieveMeasurements(Long stationId, Feeder feeder);
+
+  /**
+   * Performs data refresh if outdated
+   *
+   * @param dataFeed     - lazy data feed
+   * @param dataProvider - data provider (feeder)
+   */
+  void refreshDataIfRequired(Supplier<List<Measurement>> dataFeed, Feeder dataProvider);
+
+  /**
+   * Checks whether data related to given feeder is outdated
+   *
+   * @param feeder - data provider
+   * @return true if update is required
+   */
+  default boolean isUpdateRequired(Feeder feeder) {
+    LocalDateTime lastUpdateUtc = getLatestUpdate(feeder);
+    return LocalDateTime.now(ZoneOffset.UTC).isAfter(
+        lastUpdateUtc.plusMinutes(getMeasurementProperties().getUpdateFrequencyInMinutes()));
+  }
+
+  /**
+   * Finds the latest measurement date for given feeder.
+   *
+   * @param dataProvider - the feeder
+   * @return date time of the last measurement
+   */
+  LocalDateTime getLatestUpdate(Feeder dataProvider);
+
+  /**
+   * Provides module settings specific for run environment
+   *
+   * @return measurement properties
+   */
+  MeasurementProperties getMeasurementProperties();
+}

backend/src/main/java/pl/itrack/airqeye/store/measurement/adapters/config/MeasurementProperties.java → backend/src/main/java/pl/itrack/airqeye/store/measurement/infrastructure/config/MeasurementPropertiesAdapter.java

@@ -1,18 +1,20 @@
-package pl.itrack.airqeye.store.measurement.adapters.config;
+package pl.itrack.airqeye.store.measurement.infrastructure.config;
 
 import org.springframework.beans.factory.annotation.Value;
 import org.springframework.context.annotation.Configuration;
+import pl.itrack.airqeye.store.measurement.domain.config.MeasurementProperties;
 
 @Configuration
-public class MeasurementProperties {
+public class MeasurementPropertiesAdapter implements MeasurementProperties {
 
   private int updateFrequencyInMinutes;
 
-  public MeasurementProperties(
+  public MeasurementPropertiesAdapter(
       @Value("${airq-eye.update-frequency-in-minutes:10}") int updateFrequencyInMinutes) {
     this.updateFrequencyInMinutes = updateFrequencyInMinutes;
   }
 
+  @Override
   public int getUpdateFrequencyInMinutes() {
     return updateFrequencyInMinutes;
   }