From b5d1b9378adfd8337b3a949b3565b989e0f07db4 Mon Sep 17 00:00:00 2001 From: Dylan Bolger Date: Sun, 15 Oct 2023 11:34:02 -0500 Subject: Initial commit: RESTful API to grab energy usage --- .gitignore | 2 + constants.py | 110 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ energy_request.py | 78 ++++++++++++++++++++++++++++++++++++++ energy_service.py | 10 +++++ login.py | 53 ++++++++++++++++++++++++++ requirements.txt | 3 ++ 6 files changed, 256 insertions(+) create mode 100644 .gitignore create mode 100644 constants.py create mode 100644 energy_request.py create mode 100644 energy_service.py create mode 100644 login.py create mode 100644 requirements.txt diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..0bc94f9 --- /dev/null +++ b/.gitignore @@ -0,0 +1,2 @@ +__pycache__/ +credentials.py \ No newline at end of file diff --git a/constants.py b/constants.py new file mode 100644 index 0000000..ed594ec --- /dev/null +++ b/constants.py @@ -0,0 +1,110 @@ +from credentials import * + +# TODO: Organize this better + +# Shared +genericRequestHeaders = { + # set csrftoken + 'Accept': 'application/json, text/javascript, */*; q=0.01', + 'Accept-Language': 'en-US,en;q=0.9,la;q=0.8', + 'Cache-Control': 'no-cache', + 'Connection': 'keep-alive', + 'Content-Type': 'application/json; charset=UTF-8', + 'DNT': '1', + 'Origin': 'https://myaccount.cityutilities.net', + 'Pragma': 'no-cache', + 'Referer': 'https://myaccount.cityutilities.net/', + 'Sec-Fetch-Dest': 'empty', + 'Sec-Fetch-Mode': 'cors', + 'Sec-Fetch-Site': 'same-origin', + 'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36', + 'X-Requested-With': 'XMLHttpRequest', + 'isajax': '1', + 'sec-ch-ua': '"Chromium";v="118", "Google Chrome";v="118", "Not=A?Brand";v="99"', + 'sec-ch-ua-mobile': '?0', + 'sec-ch-ua-platform': '"Linux"', +} +################################################################ +# Login +loginPageHeaders = { + # no setting needed + 'Accept': 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,image/apng,*/*;q=0.8,application/signed-exchange;v=b3;q=0.7', + 'Accept-Language': 'en-US,en;q=0.9,la;q=0.8', + 'Cache-Control': 'no-cache', + 'Connection': 'keep-alive', + 'DNT': '1', + 'Pragma': 'no-cache', + 'Sec-Fetch-Dest': 'document', + 'Sec-Fetch-Mode': 'navigate', + 'Sec-Fetch-Site': 'none', + 'Sec-Fetch-User': '?1', + 'Upgrade-Insecure-Requests': '1', + 'User-Agent': 'Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/118.0.0.0 Safari/537.36', + 'sec-ch-ua': '"Chromium";v="118", "Google Chrome";v="118", "Not=A?Brand";v="99"', + 'sec-ch-ua-mobile': '?0', + 'sec-ch-ua-platform': '"Linux"', +} + +loginRequestJson = { + # no setting needed + 'username': username, + 'password': password, + 'rememberme': False, + 'calledFrom': 'LN', + 'ExternalLoginId': '', + 'LoginMode': '1', + 'utilityAcountNumber': '', +} +################################################################ +# Usage + +usageRequestCookies = { + # set the following: + # ApplicationGatewayAffinityCORS + # ApplicationGatewayAffinity + # ASP.NET_SessionId + # SCP + 'HomeInfoStatus': 'JTvtoeyEoms3X37GlOdLTgqBBOA=', + 'ClientTimeZone': 'fHqu9CayhyHioR9w4GOAmCGNfuI=', + 'ClientTimeId': 'YHGrE6y4VMYjLFGwicApVDP8CQ==', + 'Language_code': 'FAeYmCxPzfN/s2ABidwmk2yR', + 'IsModernStyle': 'BTvtoZ0jt+/Sat+a9yZhduxHX60=', + 'Language_Name': 'FCf/qJCh2GYtR4LS0rM5/Zpmrv4n89w=', + 'UName': uName, +} + +electricUsageRequestJson = { + # Set Mode + 'UsageOrGeneration': '1', + 'Type': 'K', + 'strDate': '', + 'hourlyType': 'H', + 'SeasonId': '', + 'weatherOverlay': 0, + 'usageyear': '', + 'MeterNumber': electricMeterNumber, + 'DateFromDaily': '', + 'DateToDaily': '', +} + +waterUsageRequestJson = { + # Set Mode + "Type":"W", + "strDate":"", + "hourlyType":"H", + "seasonId":"", + "weatherOverlay":0, + "usageyear":"", + "MeterNumber": waterMeterNumber, + "DateFromDaily":"", + "DateToDaily":"", + "isNoDashboard":True +} + +################################################################ +# Endpoints/URIs + +waterRequestEndpoint = 'https://myaccount.cityutilities.net/Portal/Usages.aspx/LoadWaterUsage' +electricRequestEndpoint = 'https://myaccount.cityutilities.net/Portal/Usages.aspx/LoadUsage' +loginRequestEndpoint = 'https://myaccount.cityutilities.net/Portal/Default.aspx/validateLogin' +loginPageUri = 'https://myaccount.cityutilities.net/Portal/default.aspx' \ No newline at end of file diff --git a/energy_request.py b/energy_request.py new file mode 100644 index 0000000..9b8542a --- /dev/null +++ b/energy_request.py @@ -0,0 +1,78 @@ +import json +import requests +from constants import usageRequestCookies, genericRequestHeaders, electricUsageRequestJson, waterUsageRequestJson, waterRequestEndpoint, electricRequestEndpoint + +# Electric + +def dayElectricRequest(): + electricUsageRequestJson['Mode'] = 'D' + return performElectricRequest() + +def monthElectricRequest(): + electricUsageRequestJson['Mode'] = 'M' + return performElectricRequest() + +def performElectricRequest(): + electricUsageResponse = requests.post( + electricRequestEndpoint, + cookies=usageRequestCookies, + headers=genericRequestHeaders, + json=electricUsageRequestJson + ) + return parseResponse(electricUsageResponse) + +def requestElectric(): + return { + "day": dayElectricRequest(), + "month": monthElectricRequest() + } + +# Water + +def dayWaterRequest(): + waterUsageRequestJson['Mode'] = 'D' + return performWaterRequest() + +def monthWaterRequest(): + waterUsageRequestJson['Mode'] = 'M' + return performWaterRequest() + +def performWaterRequest(): + waterUsageResponse = requests.post( + waterRequestEndpoint, + cookies=usageRequestCookies, + headers=genericRequestHeaders, + json=waterUsageRequestJson + ) + return parseResponse(waterUsageResponse) + +def requestWater(): + return { + "day": dayWaterRequest(), + "month": monthWaterRequest() + } + +# Utility methods + +def parseResponse(response): + # such an icky response from an endpoint + # TODO: Remove unneeded JSON entries? + return json.loads(response.text.replace("\\\"", "\"").replace("\\\"", "\"").replace("\"{\"", "{\"").replace("}\"}", "}}"))['d']['objUsageGenerationResultSetTwo'] + +def setupRequestParameters(parameters): + # Setup cookies and csrftoken to perform requests + usageRequestCookies['ApplicationGatewayAffinityCORS'] = parameters['aga'] + usageRequestCookies['ApplicationGatewayAffinity'] = parameters['aga'] + usageRequestCookies['ASP.NET_SessionId'] = parameters['asi'] + usageRequestCookies['SCP'] = parameters['lt'] + genericRequestHeaders['csrftoken'] = parameters['ct'] + +# Service calling method + +def request(requestParameters): + setupRequestParameters(requestParameters) + return { + "electric": requestElectric(), + "water": requestWater() + } + diff --git a/energy_service.py b/energy_service.py new file mode 100644 index 0000000..ac3f6fe --- /dev/null +++ b/energy_service.py @@ -0,0 +1,10 @@ +from fastapi import FastAPI +from login import login +from energy_request import request + +app = FastAPI(docs_url=None, redoc_url=None) + +@app.get('/get') +def get(): + sessionKeys = login() + return request(sessionKeys) \ No newline at end of file diff --git a/login.py b/login.py new file mode 100644 index 0000000..67f4f67 --- /dev/null +++ b/login.py @@ -0,0 +1,53 @@ +import requests +import re +from constants import loginPageHeaders, loginRequestJson, genericRequestHeaders, loginPageUri, loginRequestEndpoint + +def login(): + # Grab generated session keys from viewing the webpage + aga, asi, ct = grabRequiredKeys() + # Perform a login request using keys found on the page and JSON data (credentials) + lt = performLoginRequest(aga, asi, ct) + # Return the keys required to make endpoint calls + return { + "lt": lt, + "aga": aga, + "asi": asi, + "ct": ct + } + + +def grabRequiredKeys(): + loginPageResponse = requests.get(loginPageUri, headers=loginPageHeaders) + affinityMatcher = re.compile("CORS=(.+?);") + affinityResults = affinityMatcher.search(loginPageResponse.headers['Set-Cookie']) + appGatewayAffinity = affinityResults.group(1) + + aspNetSessionIdMatcher = re.compile("ASP\.NET\_SessionId=(.+?);") + aspnetResults = aspNetSessionIdMatcher.search(loginPageResponse.headers['Set-Cookie']) + aspNetSessionId = aspnetResults.group(1) + + csrfMatcher = re.compile("id=\"hdnCSRFToken\" value=\"(.+)\"") + csrfResults = csrfMatcher.search(loginPageResponse.text) + csrfToken = csrfResults.group(1) + return appGatewayAffinity, aspNetSessionId, csrfToken + +def performLoginRequest(appGatewayAffinity, aspNetSessionId, csrfToken): + loginRequestCookies = { + 'ApplicationGatewayAffinityCORS': appGatewayAffinity, + 'ApplicationGatewayAffinity': appGatewayAffinity, + 'ASP.NET_SessionId': aspNetSessionId, + } + + genericRequestHeaders['csrftoken'] = csrfToken + + loginResponse = requests.post( + loginRequestEndpoint, + cookies=loginRequestCookies, + headers=genericRequestHeaders, + json=loginRequestJson, + ) + + scpMatcher = re.compile("SCP=(.{36});") + scpSearchResults = scpMatcher.search(loginResponse.headers['Set-Cookie']) + loginToken = scpSearchResults.group(1) + return loginToken diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..0d8f6e3 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,3 @@ +fastapi +requests +uvicorn \ No newline at end of file -- cgit v1.2.3