API voor live gas verbruik #562

Author: dennissiemensma

docs/changelog.rst

@@ -21,7 +21,7 @@ v2.1.0 - 2019-**-**
 **Tickets resolved in this release:**
 
 
-- [`#xxxxxxxxx <https://github.com/dennissiemensma/dsmr-reader/issues/xxxxxxxxxx>`_] yyyyyyyyyyyyyyy
+- [`#562 <https://github.com/dennissiemensma/dsmr-reader/issues/562>`_] API voor live gas verbruik
 
 
 ----

dsmr_api/tests/v2/test_consumption.py

@@ -5,6 +5,7 @@
 from dsmr_api.tests.v2 import APIv2TestCase
 from dsmr_consumption.models.energysupplier import EnergySupplierPrice
 from dsmr_datalogger.models.statistics import MeterStatistics
+from dsmr_consumption.models.consumption import GasConsumption
 
 
 class TestToday(APIv2TestCase):
@@ -49,7 +50,7 @@ def test_get(self, now_mock):
 
         # Without prices.
         result = self._request('electricity-live')
-        self.assertEqual(result['timestamp'], '2016-07-01T20:00:00Z')
+        self.assertEqual(result['timestamp'], '2016-07-01T22:00:00+02:00')
         self.assertEqual(result['currently_returned'], 123)
         self.assertEqual(result['currently_delivered'], 1123)
 
@@ -63,12 +64,45 @@ def test_get(self, now_mock):
         MeterStatistics.objects.update(electricity_tariff=1)
 
         result = self._request('electricity-live')
-        self.assertEqual(result['timestamp'], '2016-07-01T20:00:00Z')
+        self.assertEqual(result['timestamp'], '2016-07-01T22:00:00+02:00')
         self.assertEqual(result['currently_returned'], 123)
         self.assertEqual(result['currently_delivered'], 1123)
         self.assertEqual(result['cost_per_hour'], '0.02')
 
 
+class GasLive(APIv2TestCase):
+    @mock.patch('django.utils.timezone.now')
+    def test_get(self, now_mock):
+        now_mock.return_value = timezone.make_aware(timezone.datetime(2019, 4, 20))
+        GasConsumption.objects.create(**{
+            "read_at": "2019-04-19T12:00:00+02:00",
+            "delivered": "123.456",
+            "currently_delivered": "0.000"
+        })
+        GasConsumption.objects.create(**{
+            "read_at": "2019-04-19T13:00:00+02:00",
+            "delivered": "125.000",
+            "currently_delivered": "1.544"
+        })
+
+        # Without prices.
+        result = self._request('gas-live')
+        self.assertEqual(result['timestamp'], '2019-04-19T13:00:00+02:00')
+        self.assertEqual(result['currently_delivered'], 1.544)
+
+        # Now with prices.
+        EnergySupplierPrice.objects.create(
+            start=timezone.now().date(),
+            end=(timezone.now() + timezone.timedelta(hours=24)).date(),
+            gas_price=0.50,
+        )
+
+        result = self._request('gas-live')
+        self.assertEqual(result['timestamp'], '2019-04-19T13:00:00+02:00')
+        self.assertEqual(result['currently_delivered'], 1.544)
+        self.assertEqual(result['cost_per_hour'], '0.78')
+
+
 class TestElectricity(APIv2TestCase):
     fixtures = ['dsmr_api/test_electricity_consumption.json']
 

dsmr_api/urls/v2.py

@@ -18,6 +18,7 @@
     path('gas', views.GasConsumptionViewSet.as_view({'get': 'list'}), name='gas-consumption'),
     path('today', views.TodayConsumptionView.as_view(), name='today-consumption'),
     path('electricity-live', views.ElectricityLiveView.as_view(), name='electricity-live'),
+    path('gas-live', views.GasLiveView.as_view(), name='gas-live'),
 ]
 
 statistics_url_patterns = [

dsmr_api/views/v2.py

@@ -71,6 +71,12 @@ def get(self, request):
         return Response(dsmr_consumption.services.live_electricity_consumption(use_naturaltime=False))
 
 
+class GasLiveView(APIView):
+    """ Returns the current gas usage. """
+    def get(self, request):
+        return Response(dsmr_consumption.services.live_gas_consumption())
+
+
 class ElectricityConsumptionViewSet(viewsets.ReadOnlyModelViewSet):
     """ Lists electricity consumption. """
     FIELD = 'read_at'

dsmr_consumption/services.py

@@ -282,7 +282,7 @@ def day_consumption(day):
 
 
 def live_electricity_consumption(use_naturaltime=True):
-    """ Returns the current latest/live consumption. """
+    """ Returns the current latest/live electricity consumption. """
     data = {}
 
     try:
@@ -291,7 +291,7 @@ def live_electricity_consumption(use_naturaltime=True):
         # Don't even bother when no data available.
         return data
 
-    latest_timestamp = latest_reading.timestamp
+    latest_timestamp = timezone.localtime(latest_reading.timestamp)
 
     # In case the smart meter is running a clock in the future.
     if latest_timestamp > timezone.now():
@@ -327,6 +327,39 @@ def live_electricity_consumption(use_naturaltime=True):
         data['cost_per_hour'] = formats.number_format(
             round_decimal(cost_per_hour)
         )
+
+    return data
+
+
+def live_gas_consumption():
+    """ Returns the current latest/live gas consumption. """
+    data = {}
+
+    try:
+        latest_data = GasConsumption.objects.all().order_by('-read_at')[0]
+    except IndexError:
+        # Don't even bother when no data available.
+        return data
+
+    latest_timestamp = timezone.localtime(latest_data.read_at)
+
+    # In case the smart meter is running a clock in the future.
+    if latest_timestamp > timezone.now():
+        latest_timestamp = timezone.now()
+
+    data['timestamp'] = latest_timestamp
+    data['currently_delivered'] = latest_data.currently_delivered
+
+    try:
+        # This WILL fail when we either have no prices at all or conflicting ranges.
+        prices = EnergySupplierPrice.objects.by_date(target_date=timezone.now().date())
+    except (EnergySupplierPrice.DoesNotExist, EnergySupplierPrice.MultipleObjectsReturned):
+        return data
+
+    data['cost_per_hour'] = formats.number_format(
+        round_decimal(latest_data.currently_delivered * prices.gas_price)
+    )
+
     return data