ppetru/opensprinkler-weather
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Merge pull request #72 from Derpthemeus/improve-pws-support

Browse Source 
Split PWS ID and API key into 2 parameters
This commit is contained in:
Samer Albahra
2019-07-06 06:43:37 -07:00
committed by GitHub
parent 7ea1824048 c53e60e090
commit 61ecb3a8e0
2 changed files with 23 additions and 25 deletions
Download Patch File Download Diff File Expand all files Collapse all files

4
routes/adjustmentMethods/AdjustmentMethod.ts
View File

@@ -57,6 +57,8 @@ export interface AdjustmentMethodResponse {
} }
export interface AdjustmentOptions { export interface AdjustmentOptions {
/** Information about the PWS to use in the format "pws:API_KEY@PWS_ID". */ /** The ID of the PWS to use, prefixed with "pws:". */
pws?: string; pws?: string;
/** The API key to use to access PWS data. */
key?: string;
} }

44
routes/weather.ts
View File

@@ -218,15 +218,29 @@ export const getWateringData = async function( req: express.Request, res: expres
let timeData: TimeData = getTimeData( coordinates ); let timeData: TimeData = getTimeData( coordinates );
// Parse the PWS information. // Parse the PWS information.
const pwsString: string | undefined = adjustmentOptions.pws;
let pws: PWS | undefined = undefined; let pws: PWS | undefined = undefined;
if ( pwsString ) { if ( adjustmentOptions.pws ) {
try { if ( !adjustmentOptions.key ) {
pws = parsePWS( pwsString ); res.send("Error: An API key must be provided when using a PWS.");
} catch ( err ) {
res.send( `Error: ${ err }` );
return; return;
} }
const idMatch = adjustmentOptions.pws.match( /^pws:([a-zA-Z\d]+)$/ );
const pwsId = idMatch ? idMatch[ 1 ] : undefined;
const keyMatch = adjustmentOptions.key.match( /^[a-f\d]{32}$/ );
const apiKey = keyMatch ? keyMatch[ 0 ] : undefined;
// Make sure that the PWS ID and API key look valid.
if ( !pwsId ) {
res.send("Error: PWS ID does not appear to be valid.");
return;
}
if ( !apiKey ) {
res.send("Error: PWS API key does not appear to be valid.");
return;
}
pws = { id: pwsId, apiKey: apiKey };
} }
const weatherProvider = pws ? PWS_WEATHER_PROVIDER : WEATHER_PROVIDER; const weatherProvider = pws ? PWS_WEATHER_PROVIDER : WEATHER_PROVIDER;
@@ -474,21 +488,3 @@ function getParameter( parameter: string | string[] ): string {
// Return an empty string if the parameter is undefined. // Return an empty string if the parameter is undefined.
return parameter || ""; return parameter || "";
} }
/**
* Creates a PWS object from a string.
* @param pwsString Information about the PWS in the format "pws:API_KEY@PWS_ID".
* @return The PWS specified by the string.
* @throws Throws an error message if the string is in an invalid format and cannot be parsed.
*/
function parsePWS( pwsString: string): PWS {
const match = pwsString.match( /^pws:([a-f\d]{32})@([a-zA-Z\d]+)$/ );
if ( !match ) {
throw "Invalid PWS format.";
}
return {
apiKey: match[ 1 ],
id: match[ 2 ]
};
}