Add query methods

Author: Thomas Basche

Pipfile

@@ -9,3 +9,4 @@ name = "pypi"
 requests = "*"
 arrow = "*"
 six = "*"
+pendulum = "*"

reposit/data/api.py

@@ -4,6 +4,7 @@
 import logging
 
 import requests
+import pendulum
 
 from reposit.data.exceptions import InvalidControllerException
 from reposit.data.utils import is_valid_url, deepest_key, match_to_schema
@@ -64,11 +65,6 @@ def __init__(self, path, controller, schema, **kwargs):
 
         # a lookup of the response schema
         self.schema = schema
-        """
-        Various optional args here
-        """
-        # if the response a list?
-        self.is_list = kwargs.get('format_list', False)
 
     def get(self):
         """
@@ -91,6 +87,31 @@ def get(self):
         data = self._simple_format_for_fields(resp)
         return data
 
+    def query(self, start, end=None):
+        """
+        Similar to get() but with specified query parameters.
+        :param start: unix timestamp (start of query)
+        :param end: unix timestamp (end of query). If not specified
+        then this defaults to now()
+        :return:
+        """
+        if not end:
+            end = pendulum.now().int_timestamp
+
+        resp = requests.get(
+            '{}?start={}&end={}'.format(self.url, start, end),
+            headers=self.controller.auth_headers
+        )
+        try:
+            resp.raise_for_status()
+        except Exception as ex:
+            # Hijack the exception to log the exact issue.
+            logger.exception('Error retrieving data: {}'.format(self))
+            raise ex
+
+        data = self._simple_format_for_fields(resp)
+        return {'data': data[0]}  # because this is a list of lists
+
     def _simple_format_for_fields(self, api_response):
         """
         Based on the schema provided, format the data accordingly.

reposit/data/controller.py

@@ -80,6 +80,23 @@ def has_inverter(self):
         )
         return request.get()
 
+    def get_historical_generation(self, start, end):
+        """
+        Given a start and end timestamp return the generation
+        data.
+        :param start: unix timestamp
+        :param end: unix timestamp
+        :return: list of lists of data
+        """
+        request = ApiRequest(
+            path='v2/deployments/{}/generation/historical/p'.format(self.user_key),
+            controller=self,
+            schema={
+                'solarP': {}
+            }
+        )
+        return request.query(start, end)
+
     @property
     def latest_historical_generation(self):
         """
@@ -95,6 +112,23 @@ def latest_historical_generation(self):
         )
         return request.get()
 
+    def get_historical_house(self, start, end):
+        """
+        Given a start and end timestamp return the house
+        data.
+        :param start: unix timestamp
+        :param end: unix timestamp
+        :return: list of lists of data
+        """
+        request = ApiRequest(
+            path='v2/deployments/{}/house/historical'.format(self.user_key),
+            controller=self,
+            schema={
+                'houseP': {}
+            }
+        )
+        return request.query(start, end)
+
     @property
     def latest_historical_house(self):
         """
@@ -112,6 +146,23 @@ def latest_historical_house(self):
         )
         return request.get()
 
+    def get_historical_grid_credits(self, start, end):
+        """
+        Given a start and end timestamp return the gridcredits
+        data.
+        :param start: unix timestamp
+        :param end: unix timestamp
+        :return: list of lists of data
+        """
+        request = ApiRequest(
+            path='v2/deployments/{}/gridcredits/historical'.format(self.user_key),
+            controller=self,
+            schema={
+                'gridcredits': {}
+            }
+        )
+        return request.query(start, end)
+
     @property
     def latest_historical_grid_credits(self):
         """
@@ -128,6 +179,23 @@ def latest_historical_grid_credits(self):
         )
         return request.get()
 
+    def get_historical_inverter(self, start, end):
+        """
+        Given a start and end timestamp return the inverter
+        data.
+        :param start: unix timestamp
+        :param end: unix timestamp
+        :return: list of lists of data
+        """
+        request = ApiRequest(
+            path='v2/deployments/{}/inverter/historical/p'.format(self.user_key),
+            controller=self,
+            schema={
+                'inverterP': {}
+            }
+        )
+        return request.query(start, end)
+
     @property
     def latest_historical_inverter(self):
         """
@@ -143,6 +211,23 @@ def latest_historical_inverter(self):
         )
         return request.get()
 
+    def get_historical_meter(self, start, end):
+        """
+        Given a start and end timestamp return the meter
+        data.
+        :param start: unix timestamp
+        :param end: unix timestamp
+        :return: list of lists of data
+        """
+        request = ApiRequest(
+            path='v2/deployments/{}/meter/historical/p'.format(self.user_key),
+            controller=self,
+            schema={
+                'meterP': {}
+            }
+        )
+        return request.query(start, end)
+
     @property
     def latest_historical_meter(self):
         """