+
+
+
+
-
-
diff --git a/seed/static/seed/scss/style.scss b/seed/static/seed/scss/style.scss
index 473431333b..3a10d3ee77 100755
--- a/seed/static/seed/scss/style.scss
+++ b/seed/static/seed/scss/style.scss
@@ -3891,6 +3891,16 @@ $pairedCellWidth: 60px;
padding-left: 5px;
}
+.pad-bottom-10 {
+ padding-bottom: 10px;
+}
+
+.right-bar {
+ padding-left: 10px;
+ padding-right: 25px;
+ border-right: 1px solid #999;
+}
+
.matching-column-header .ui-grid-header-cell-label {
font-weight: bolder;
}
diff --git a/seed/tests/test_reports.py b/seed/tests/test_reports.py
index 9eb8c1bef3..d9f202bf97 100644
--- a/seed/tests/test_reports.py
+++ b/seed/tests/test_reports.py
@@ -33,12 +33,9 @@ def setUp(self):
'email': 'test_user@demo.com'
}
self.client.login(**user_details)
-
- def test_report_export_excel_workbook(self):
- cycle_factory = FakeCycleFactory(organization=self.org, user=self.user)
+ self.cycle_factory = FakeCycleFactory(organization=self.org, user=self.user)
start = datetime.datetime(2016, 1, 1, tzinfo=timezone.get_current_timezone())
- # import pdb; pdb.set_trace()
- self.cycle_2 = cycle_factory.get_cycle(name="Cycle 2", start=start)
+ self.cycle_2 = self.cycle_factory.get_cycle(name="Cycle 2", start=start)
# create 5 records with site_eui and gross_floor_area in each cycle
for i in range(1, 6):
@@ -66,17 +63,17 @@ def test_report_export_excel_workbook(self):
cycle_id=self.cycle_2.id
)
+ def test_report_export_excel_workbook(self):
url = reverse('api:v3:organizations-report-export', args=[self.org.pk])
# needs to be turned into post?
- response = self.client.get(url + '?{}={}&{}={}&{}={}&{}={}&{}={}&{}={}'.format(
- 'start', '2014-12-31T00:00:00-07:53',
- 'end', '2017-12-31T00:00:00-07:53',
- 'x_var', 'site_eui',
- 'x_label', 'Site EUI',
- 'y_var', 'gross_floor_area',
- 'y_label', 'Gross Floor Area'
- ))
+ response = self.client.get(url, data={
+ 'cycle_ids': [self.cycle.id, self.cycle_2.id],
+ 'x_var': 'site_eui',
+ 'x_label': 'Site EUI',
+ 'y_var': 'gross_floor_area',
+ 'y_label': 'Gross Floor Area',
+ })
self.assertEqual(200, response.status_code)
@@ -110,3 +107,56 @@ def test_report_export_excel_workbook(self):
self.assertEqual('Gross Floor Area', agg_sheet.cell(0, 1).value)
self.assertEqual('0-99k', agg_sheet.cell(1, 1).value)
self.assertEqual('0-99k', agg_sheet.cell(2, 1).value)
+
+ def test_report(self):
+ url = reverse('api:v3:organizations-report', args=[self.org.pk])
+ data = {
+ 'cycle_ids': [self.cycle.id, self.cycle_2.id],
+ 'x_var': 'site_eui',
+ 'y_var': 'gross_floor_area',
+ }
+ response = self.client.get(url, data)
+
+ assert response.json()["data"]["property_counts"] == [
+ {'yr_e': '2016', 'num_properties': 5, 'num_properties_w-data': 5},
+ {'yr_e': '2015', 'num_properties': 5, 'num_properties_w-data': 5}
+ ]
+
+ data["cycle_ids"] = [self.cycle.id]
+ response = self.client.get(url, data)
+
+ assert response.json()["data"]["property_counts"] == [
+ {'yr_e': '2015', 'num_properties': 5, 'num_properties_w-data': 5}
+ ]
+
+ def test_report_aggregated(self):
+ url = reverse('api:v3:organizations-report-aggregated', args=[self.org.pk])
+ data = {
+ 'cycle_ids': [self.cycle.id, self.cycle_2.id],
+ 'x_var': 'site_eui',
+ 'y_var': 'gross_floor_area',
+ }
+ response = self.client.get(url, data)
+
+ assert response.json()["aggregated_data"]["property_counts"] == [
+ {'yr_e': '2016', 'num_properties': 5, 'num_properties_w-data': 5},
+ {'yr_e': '2015', 'num_properties': 5, 'num_properties_w-data': 5}
+ ]
+
+ data["cycle_ids"] = [self.cycle.id]
+ response = self.client.get(url, data)
+
+ assert response.json()["aggregated_data"]["property_counts"] == [
+ {'yr_e': '2015', 'num_properties': 5, 'num_properties_w-data': 5}
+ ]
+
+ def test_report_missing_arg(self):
+ url = reverse('api:v3:organizations-report-aggregated', args=[self.org.pk])
+ data = {
+ 'cycle_ids': [self.cycle.id, self.cycle_2.id],
+ 'x_var': 'site_eui',
+ # 'y_var': 'gross_floor_area', it's missing!
+ }
+ response = self.client.get(url, data)
+
+ assert response.status_code == 400
diff --git a/seed/views/v3/organizations.py b/seed/views/v3/organizations.py
index 493ecedae9..ec8422858d 100644
--- a/seed/views/v3/organizations.py
+++ b/seed/views/v3/organizations.py
@@ -9,7 +9,6 @@
from io import BytesIO
from pathlib import Path
-import dateutil
from django.conf import settings
from django.contrib.auth.decorators import permission_required
from django.contrib.auth.forms import PasswordResetForm
@@ -20,7 +19,6 @@
from django.utils.decorators import method_decorator
from drf_yasg import openapi
from drf_yasg.utils import swagger_auto_schema
-from past.builtins import basestring
from rest_framework import status, viewsets
from rest_framework.decorators import action
from rest_framework.response import Response
@@ -785,35 +783,6 @@ def geocoding_columns(self, request, pk=None):
return JsonResponse(geocoding_columns)
- def get_cycles(self, start, end, organization_id):
- if not isinstance(start, type(end)):
- raise TypeError('start and end not same types')
- # if of type int or convertable assume they are cycle ids
- try:
- start = int(start)
- end = int(end)
- except ValueError:
- # assume string is JS date
- if isinstance(start, basestring):
- start_datetime = dateutil.parser.parse(start)
- end_datetime = dateutil.parser.parse(end)
- else:
- raise Exception('Date is not a string')
- # get date times from cycles
- if isinstance(start, int):
- cycle = Cycle.objects.get(pk=start, organization_id=organization_id)
- start_datetime = cycle.start
- if start == end:
- end_datetime = cycle.end
- else:
- end_datetime = Cycle.objects.get(
- pk=end, organization_id=organization_id
- ).end
- return Cycle.objects.filter(
- start__gte=start_datetime, end__lte=end_datetime,
- organization_id=organization_id
- ).order_by('start')
-
def get_data(self, property_view, x_var, y_var, matching_columns):
result = {}
state = property_view.state
@@ -896,42 +865,31 @@ def get_raw_report_data(self, organization_id, cycles, x_var, y_var, addtional_c
def report(self, request, pk=None):
"""Retrieve a summary report for charting x vs y
"""
- params = {}
- missing_params = []
- error = ''
- for param in ['x_var', 'y_var', 'start', 'end']:
- val = request.query_params.get(param, None)
- if not val:
- missing_params.append(param)
- else:
- params[param] = val
+ params = {
+ "x_var": request.query_params.get("x_var", None),
+ "y_var": request.query_params.get("y_var", None),
+ "cycle_ids": request.query_params.getlist("cycle_ids", None),
+ }
+
+ excepted_params = ["x_var", "y_var", "cycle_ids"]
+ missing_params = [p for p in excepted_params if p not in params]
if missing_params:
- error = "{} Missing params: {}".format(
- error, ", ".join(missing_params)
+ return Response(
+ {'status': 'error', 'message': "Missing params: {}".format(", ".join(missing_params))},
+ status=status.HTTP_400_BAD_REQUEST
)
- if error:
- status_code = status.HTTP_400_BAD_REQUEST
- result = {'status': 'error', 'message': error}
- else:
- cycles = self.get_cycles(params['start'], params['end'], pk)
- data = self.get_raw_report_data(
- pk, cycles, params['x_var'], params['y_var']
- )
- for datum in data:
- if datum['property_counts']['num_properties_w-data'] != 0:
- break
- property_counts = []
- chart_data = []
- for datum in data:
- property_counts.append(datum['property_counts'])
- chart_data.extend(datum['chart_data'])
- data = {
- 'property_counts': property_counts,
- 'chart_data': chart_data,
- }
- result = {'status': 'success', 'data': data}
- status_code = status.HTTP_200_OK
- return Response(result, status=status_code)
+
+ cycles = Cycle.objects.filter(id__in=params["cycle_ids"])
+ data = self.get_raw_report_data(pk, cycles, params['x_var'], params['y_var'])
+ data = {
+ "chart_data": sum([d["chart_data"] for d in data], []),
+ "property_counts": [d["property_counts"] for d in data]
+ }
+
+ return Response(
+ {'status': 'success', 'data': data},
+ status=status.HTTP_200_OK
+ )
@swagger_auto_schema(
manual_parameters=[
@@ -964,59 +922,52 @@ def report(self, request, pk=None):
def report_aggregated(self, request, pk=None):
"""Retrieve a summary report for charting x vs y aggregated by y_var
"""
- valid_y_values = ['gross_floor_area', 'property_type', 'year_built']
- params = {}
- missing_params = []
- empty = True
- error = ''
- for param in ['x_var', 'y_var', 'start', 'end']:
- val = request.query_params.get(param, None)
- if not val:
- missing_params.append(param)
- elif param == 'y_var' and val not in valid_y_values:
- error = "{} {} is not a valid value for {}.".format(
- error, val, param
- )
- else:
- params[param] = val
+ # get params
+ params = {
+ "x_var": request.query_params.get("x_var", None),
+ "y_var": request.query_params.get("y_var", None),
+ "cycle_ids": request.query_params.getlist("cycle_ids", None)
+ }
+
+ # error if missing
+ excepted_params = ["x_var", "y_var", "cycle_ids"]
+ missing_params = [p for p in excepted_params if p not in params]
if missing_params:
- error = "{} Missing params: {}".format(
- error, ", ".join(missing_params)
+ return Response(
+ {'status': 'error', 'message': "Missing params: {}".format(", ".join(missing_params))},
+ status=status.HTTP_400_BAD_REQUEST
)
- if error:
- status_code = status.HTTP_400_BAD_REQUEST
- result = {'status': 'error', 'message': error}
- else:
- cycles = self.get_cycles(params['start'], params['end'], pk)
- x_var = params['x_var']
- y_var = params['y_var']
- data = self.get_raw_report_data(pk, cycles, x_var, y_var)
- for datum in data:
- if datum['property_counts']['num_properties_w-data'] != 0:
- empty = False
- break
- if empty:
- result = {'status': 'error', 'message': 'No data found'}
- status_code = status.HTTP_404_NOT_FOUND
- if not empty or not error:
- chart_data = []
- property_counts = []
- for datum in data:
- buildings = datum['chart_data']
- yr_e = datum['property_counts']['yr_e']
- chart_data.extend(self.aggregate_data(yr_e, y_var, buildings)),
- property_counts.append(datum['property_counts'])
- # Send back to client
- aggregated_data = {
+
+ # error if y_var invalid
+ valid_y_values = ['gross_floor_area', 'property_type', 'year_built']
+ if params["y_var"] not in valid_y_values:
+ return Response(
+ {'status': 'error', 'message': f"{params['y_var']} is not a valid value for y_var"},
+ status=status.HTTP_400_BAD_REQUEST
+ )
+
+ # get data
+ cycles = Cycle.objects.filter(id__in=params["cycle_ids"])
+ data = self.get_raw_report_data(pk, cycles, params["x_var"], params["y_var"])
+
+ chart_data = []
+ property_counts = []
+ for datum in data:
+ buildings = datum['chart_data']
+ yr_e = datum['property_counts']['yr_e']
+ chart_data.extend(self.aggregate_data(yr_e, params["y_var"], buildings)),
+ property_counts.append(datum['property_counts'])
+
+ # Send back to client
+ result = {
+ 'status': 'success',
+ 'aggregated_data': {
'chart_data': chart_data,
'property_counts': property_counts
- }
- result = {
- 'status': 'success',
- 'aggregated_data': aggregated_data,
- }
- status_code = status.HTTP_200_OK
- return Response(result, status=status_code)
+ },
+ }
+
+ return Response(result, status=status.HTTP_200_OK)
def aggregate_data(self, yr_e, y_var, buildings):
aggregation_method = {
@@ -1141,23 +1092,23 @@ def report_export(self, request, pk=None):
"""
Export a report as a spreadsheet
"""
- params = {}
- missing_params = []
- error = ''
- for param in ['x_var', 'x_label', 'y_var', 'y_label', 'start', 'end']:
- val = request.query_params.get(param, None)
- if not val:
- missing_params.append(param)
- else:
- params[param] = val
+ # get params
+ params = {
+ "x_var": request.query_params.get("x_var", None),
+ "x_label": request.query_params.get("x_label", None),
+ "y_var": request.query_params.get("y_var", None),
+ "y_label": request.query_params.get("y_label", None),
+ "cycle_ids": request.query_params.getlist("cycle_ids", None)
+ }
+
+ # error if missing
+ excepted_params = ["x_var", "x_label", "y_var", "y_label", "cycle_ids"]
+ missing_params = [p for p in excepted_params if p not in params]
if missing_params:
- error = "{} Missing params: {}".format(
- error, ", ".join(missing_params)
+ return Response(
+ {'status': 'error', 'message': "Missing params: {}".format(", ".join(missing_params))},
+ status=status.HTTP_400_BAD_REQUEST
)
- if error:
- status_code = status.HTTP_400_BAD_REQUEST
- result = {'status': 'error', 'message': error}
- return Response(result, status=status_code)
response = HttpResponse(content_type='application/vnd.openxmlformats-officedocument.spreadsheetml.sheet')
response['Content-Disposition'] = 'attachment; filename="report-data"'
@@ -1186,7 +1137,7 @@ def report_export(self, request, pk=None):
agg_sheet.write(data_row_start, data_col_start + 2, 'Year Ending', bold)
# Gather base data
- cycles = self.get_cycles(params['start'], params['end'], pk)
+ cycles = Cycle.objects.filter(id__in=params["cycle_ids"])
matching_columns = Column.objects.filter(organization_id=pk, is_matching_criteria=True, table_name="PropertyState")
data = self.get_raw_report_data(
pk, cycles, params['x_var'], params['y_var'], matching_columns