sarsoo/Overflow
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

initial commit with working southern water API

Browse Source
This commit is contained in:
Andy Pack 2024-06-08 18:03:11 +01:00
commit 1bc8bcf55e
Signed by: sarsoo
GPG Key ID: A55BA3536A5E0ED7
12 changed files with 675 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

436
.gitignore vendored Normal file
View File

@ -0,0 +1,436 @@
## Ignore Visual Studio temporary files, build results, and
## files generated by popular Visual Studio add-ons.
##
## Get latest from https://github.com/github/gitignore/blob/master/VisualStudio.gitignore
appsettings.Development.json
appsettings.Production.json
# User-specific files
*.rsuser
*.suo
*.user
*.userosscache
*.sln.docstates
# User-specific files (MonoDevelop/Xamarin Studio)
*.userprefs
# Mono auto generated files
mono_crash.*
# Build results
[Dd]ebug/
[Dd]ebugPublic/
[Rr]elease/
[Rr]eleases/
x64/
x86/
[Ww][Ii][Nn]32/
[Aa][Rr][Mm]/
[Aa][Rr][Mm]64/
bld/
[Bb]in/
[Oo]bj/
[Ll]og/
[Ll]ogs/
# Visual Studio 2015/2017 cache/options directory
.vs/
# Uncomment if you have tasks that create the project's static files in wwwroot
#wwwroot/
# Visual Studio 2017 auto generated files
Generated\ Files/
# MSTest test Results
[Tt]est[Rr]esult*/
[Bb]uild[Ll]og.*
# NUnit
*.VisualState.xml
TestResult.xml
nunit-*.xml
# Build Results of an ATL Project
[Dd]ebugPS/
[Rr]eleasePS/
dlldata.c
# Benchmark Results
BenchmarkDotNet.Artifacts/
# .NET Core
project.lock.json
project.fragment.lock.json
artifacts/
# ASP.NET Scaffolding
ScaffoldingReadMe.txt
# StyleCop
StyleCopReport.xml
# Files built by Visual Studio
*_i.c
*_p.c
*_h.h
*.ilk
*.meta
*.obj
*.iobj
*.pch
*.pdb
*.ipdb
*.pgc
*.pgd
*.rsp
*.sbr
*.tlb
*.tli
*.tlh
*.tmp
*.tmp_proj
*_wpftmp.csproj
*.log
*.tlog
*.vspscc
*.vssscc
.builds
*.pidb
*.svclog
*.scc
# Chutzpah Test files
_Chutzpah*
# Visual C++ cache files
ipch/
*.aps
*.ncb
*.opendb
*.opensdf
*.sdf
*.cachefile
*.VC.db
*.VC.VC.opendb
# Visual Studio profiler
*.psess
*.vsp
*.vspx
*.sap
# Visual Studio Trace Files
*.e2e
# TFS 2012 Local Workspace
$tf/
# Guidance Automation Toolkit
*.gpState
# ReSharper is a .NET coding add-in
_ReSharper*/
*.[Rr]e[Ss]harper
*.DotSettings.user
# TeamCity is a build add-in
_TeamCity*
# DotCover is a Code Coverage Tool
*.dotCover
# AxoCover is a Code Coverage Tool
.axoCover/*
!.axoCover/settings.json
# Coverlet is a free, cross platform Code Coverage Tool
coverage*.json
coverage*.xml
coverage*.info
# Visual Studio code coverage results
*.coverage
*.coveragexml
# NCrunch
_NCrunch_*
.*crunch*.local.xml
nCrunchTemp_*
# MightyMoose
*.mm.*
AutoTest.Net/
# Web workbench (sass)
.sass-cache/
# Installshield output folder
[Ee]xpress/
# DocProject is a documentation generator add-in
DocProject/buildhelp/
DocProject/Help/*.HxT
DocProject/Help/*.HxC
DocProject/Help/*.hhc
DocProject/Help/*.hhk
DocProject/Help/*.hhp
DocProject/Help/Html2
DocProject/Help/html
# Click-Once directory
publish/
# Publish Web Output
*.[Pp]ublish.xml
*.azurePubxml
# Note: Comment the next line if you want to checkin your web deploy settings,
# but database connection strings (with potential passwords) will be unencrypted
*.pubxml
*.publishproj
# Microsoft Azure Web App publish settings. Comment the next line if you want to
# checkin your Azure Web App publish settings, but sensitive information contained
# in these scripts will be unencrypted
PublishScripts/
# NuGet Packages
*.nupkg
# NuGet Symbol Packages
*.snupkg
# The packages folder can be ignored because of Package Restore
**/[Pp]ackages/*
# except build/, which is used as an MSBuild target.
!**/[Pp]ackages/build/
# Uncomment if necessary however generally it will be regenerated when needed
#!**/[Pp]ackages/repositories.config
# NuGet v3's project.json files produces more ignorable files
*.nuget.props
*.nuget.targets
# Nuget personal access tokens and Credentials
nuget.config
# Microsoft Azure Build Output
csx/
*.build.csdef
# Microsoft Azure Emulator
ecf/
rcf/
# Windows Store app package directories and files
AppPackages/
BundleArtifacts/
Package.StoreAssociation.xml
_pkginfo.txt
*.appx
*.appxbundle
*.appxupload
# Visual Studio cache files
# files ending in .cache can be ignored
*.[Cc]ache
# but keep track of directories ending in .cache
!?*.[Cc]ache/
# Others
ClientBin/
~$*
*~
*.dbmdl
*.dbproj.schemaview
*.jfm
*.pfx
*.publishsettings
orleans.codegen.cs
# Including strong name files can present a security risk
# (https://github.com/github/gitignore/pull/2483#issue-259490424)
#*.snk
# Since there are multiple workflows, uncomment next line to ignore bower_components
# (https://github.com/github/gitignore/pull/1529#issuecomment-104372622)
#bower_components/
# RIA/Silverlight projects
Generated_Code/
# Backup & report files from converting an old project file
# to a newer Visual Studio version. Backup files are not needed,
# because we have git ;-)
_UpgradeReport_Files/
Backup*/
UpgradeLog*.XML
UpgradeLog*.htm
ServiceFabricBackup/
*.rptproj.bak
# SQL Server files
*.mdf
*.ldf
*.ndf
# Business Intelligence projects
*.rdl.data
*.bim.layout
*.bim_*.settings
*.rptproj.rsuser
*- [Bb]ackup.rdl
*- [Bb]ackup ([0-9]).rdl
*- [Bb]ackup ([0-9][0-9]).rdl
# Microsoft Fakes
FakesAssemblies/
# GhostDoc plugin setting file
*.GhostDoc.xml
# Node.js Tools for Visual Studio
.ntvs_analysis.dat
node_modules/
# Visual Studio 6 build log
*.plg
# Visual Studio 6 workspace options file
*.opt
# Visual Studio 6 auto-generated workspace file (contains which files were open etc.)
*.vbw
# Visual Studio LightSwitch build output
**/*.HTMLClient/GeneratedArtifacts
**/*.DesktopClient/GeneratedArtifacts
**/*.DesktopClient/ModelManifest.xml
**/*.Server/GeneratedArtifacts
**/*.Server/ModelManifest.xml
_Pvt_Extensions
# Paket dependency manager
.paket/paket.exe
paket-files/
# FAKE - F# Make
.fake/
# CodeRush personal settings
.cr/personal
# Python Tools for Visual Studio (PTVS)
__pycache__/
*.pyc
# Cake - Uncomment if you are using it
# tools/**
# !tools/packages.config
# Tabs Studio
*.tss
# Telerik's JustMock configuration file
*.jmconfig
# BizTalk build output
*.btp.cs
*.btm.cs
*.odx.cs
*.xsd.cs
# OpenCover UI analysis results
OpenCover/
# Azure Stream Analytics local run output
ASALocalRun/
# MSBuild Binary and Structured Log
*.binlog
# NVidia Nsight GPU debugger configuration file
*.nvuser
# MFractors (Xamarin productivity tool) working folder
.mfractor/
# Local History for Visual Studio
.localhistory/
# BeatPulse healthcheck temp database
healthchecksdb
# Backup folder for Package Reference Convert tool in Visual Studio 2017
MigrationBackup/
# Ionide (cross platform F# VS Code tools) working folder
.ionide/
# Fody - auto-generated XML schema
FodyWeavers.xsd
# VS Code files for those working on multiple tools
.vscode/*
!.vscode/settings.json
!.vscode/tasks.json
!.vscode/launch.json
!.vscode/extensions.json
*.code-workspace
# Local History for Visual Studio Code
.history/
# Windows Installer files from build outputs
*.cab
*.msi
*.msix
*.msm
*.msp
# JetBrains Rider
.idea/
*.sln.iml
################################################################
# Typescript
lib-cov
*.seed
*.log
*.csv
*.dat
*.out
*.pid
*.gz
*.swp
pids
logs
results
tmp
# Build
public/css/main.css
# Coverage reports
coverage
# API keys and secrets
.env
# Dependency directory
node_modules
bower_components
# Editors
.idea
*.iml
# OS metadata
.DS_Store
Thumbs.db
# Ignore built ts files
dist/**/*
# ignore yarn.lock
yarn.lock

14
Overflow.Model/Overflow.Model.csproj Normal file
View File

@ -0,0 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.6" />
<PackageReference Include="Npgsql" Version="8.0.3" />
</ItemGroup>
</Project>

1
Overflow.Test/GlobalUsings.cs Normal file
View File

@ -0,0 +1 @@
global using NUnit.Framework;

24
Overflow.Test/Overflow.Test.csproj Normal file
View File

@ -0,0 +1,24 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
<IsPackable>false</IsPackable>
<IsTestProject>true</IsTestProject>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.NET.Test.Sdk" Version="17.6.0"/>
<PackageReference Include="NUnit" Version="3.13.3"/>
<PackageReference Include="NUnit3TestAdapter" Version="4.2.1"/>
<PackageReference Include="NUnit.Analyzers" Version="3.6.1"/>
<PackageReference Include="coverlet.collector" Version="6.0.0"/>
</ItemGroup>
<ItemGroup>
<ProjectReference Include="..\Overflow\Overflow.csproj" />
</ItemGroup>
</Project>

17
Overflow.Test/UnitTest1.cs Normal file
View File

@ -0,0 +1,17 @@
namespace Overflow.Test;
public class Tests
{
[SetUp]
public void Setup()
{
}
[Test]
public async Task Test1()
{
var southern = new SouthernWater.SouthernWater(new HttpClient());
await southern.LoadApiUrl();
var spills = await southern.GetSpills();
}
}

22
Overflow.sln Normal file
View File

@ -0,0 +1,22 @@

Microsoft Visual Studio Solution File, Format Version 12.00
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Overflow", "Overflow\Overflow.csproj", "{C49506EC-6BA3-4D6A-BCAF-68F6316E0C0E}"
EndProject
Project("{FAE04EC0-301F-11D3-BF4B-00C04F79EFBC}") = "Overflow.Test", "Overflow.Test\Overflow.Test.csproj", "{83ABAAB6-067A-400B-BF61-74D04B248CEB}"
EndProject
Global
GlobalSection(SolutionConfigurationPlatforms) = preSolution
Debug|Any CPU = Debug|Any CPU
Release|Any CPU = Release|Any CPU
EndGlobalSection
GlobalSection(ProjectConfigurationPlatforms) = postSolution
{C49506EC-6BA3-4D6A-BCAF-68F6316E0C0E}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{C49506EC-6BA3-4D6A-BCAF-68F6316E0C0E}.Debug|Any CPU.Build.0 = Debug|Any CPU
{C49506EC-6BA3-4D6A-BCAF-68F6316E0C0E}.Release|Any CPU.ActiveCfg = Release|Any CPU
{C49506EC-6BA3-4D6A-BCAF-68F6316E0C0E}.Release|Any CPU.Build.0 = Release|Any CPU
{83ABAAB6-067A-400B-BF61-74D04B248CEB}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
{83ABAAB6-067A-400B-BF61-74D04B248CEB}.Debug|Any CPU.Build.0 = Debug|Any CPU
{83ABAAB6-067A-400B-BF61-74D04B248CEB}.Release|Any CPU.ActiveCfg = Release|Any CPU
{83ABAAB6-067A-400B-BF61-74D04B248CEB}.Release|Any CPU.Build.0 = Release|Any CPU
EndGlobalSection
EndGlobal

14
Overflow/ApplicationDbContext.cs Normal file
View File

@ -0,0 +1,14 @@
using Microsoft.EntityFrameworkCore;
using Overflow.SouthernWater;
namespace Overflow;
public class ApplicationDbContext(DbContextOptions<ApplicationDbContext> options) : DbContext(options)
{
public DbSet<Spill> SouthernWaterSpill { get; set; }
protected override void OnModelCreating(ModelBuilder modelBuilder)
{
modelBuilder.Entity<Spill>();
}
}

11
Overflow/JsonSerialiser.cs Normal file
View File

@ -0,0 +1,11 @@
using System.Text.Json.Serialization;
using Overflow.SouthernWater;
namespace Overflow;
[JsonSourceGenerationOptions(WriteIndented = true)]
[JsonSerializable(typeof(PagedItems<Spill>))]
public partial class JsonSerialiser : JsonSerializerContext
{
}

14
Overflow/Overflow.csproj Normal file
View File

@ -0,0 +1,14 @@
<Project Sdk="Microsoft.NET.Sdk">
<PropertyGroup>
<TargetFramework>net8.0</TargetFramework>
<ImplicitUsings>enable</ImplicitUsings>
<Nullable>enable</Nullable>
</PropertyGroup>
<ItemGroup>
<PackageReference Include="Microsoft.EntityFrameworkCore" Version="8.0.6" />
<PackageReference Include="Npgsql" Version="8.0.3" />
</ItemGroup>
</Project>

9
Overflow/SouthernWater/PagedItems.cs Normal file
View File

@ -0,0 +1,9 @@
namespace Overflow.SouthernWater;
public class PagedItems<T>
{
public int currentPage { get; set; }
public int totalItems { get; set; }
public int totalPages { get; set; }
public List<T> items { get; set; }
}

95
Overflow/SouthernWater/SouthernWater.cs Normal file
View File

@ -0,0 +1,95 @@
using System.Net.Http.Json;
using System.Text.Json;
using System.Text.RegularExpressions;
namespace Overflow.SouthernWater;
public partial class SouthernWater
{
private readonly HttpClient _client;
private static readonly string spillsEndpoint = "Spills/GetHistoricSpills";
private string baseUrl;
private string apiKey;
public SouthernWater(HttpClient client)
{
_client = client;
}
[GeneratedRegex(@".*const APIURL = '(?<APIURL>.*)'.*\n.*const APIGWKEY = '(?<APIKEY>.*)'.*", RegexOptions.IgnoreCase)]
private static partial Regex ApiUrlAndKey();
public async Task LoadApiUrl()
{
var request = new HttpRequestMessage
{
RequestUri = new Uri("https://www.southernwater.co.uk/scripts/beachbuoyhistoricspillstable.js"),
Method = HttpMethod.Get,
Headers =
{
{"Accept", "*/*"},
{"Accept-Language", "en-GB,en;q=0.5"},
// {"Accept-Encoding", "gzip, deflate, br, zstd"},
{"Cache-Control", "no-cache"},
{"Connection", "keep-alive"},
{"DNT", "1"},
{"User-Agent", "Mozilla/5.0 (Windows NT 10.0; rv:126.0) Gecko/20100101 Firefox/126.0"},
{"Upgrade-Insecure-Requests", "1"},
{"Referer", "https://www.southernwater.co.uk/our-region/clean-rivers-and-seas-task-force/beachbuoy-historic-release-table/"}
}
};
var content = await _client.SendAsync(request);
content.EnsureSuccessStatusCode();
var contentString = await content.Content.ReadAsStringAsync();
Match m = ApiUrlAndKey().Match(contentString);
var apiUrlFound = m.Groups.TryGetValue("APIURL", out var apiUrl);
var apiKeyFound = m.Groups.TryGetValue("APIKEY", out var apiKey);
if (apiUrlFound)
{
baseUrl = apiUrl.Value;
}
if (apiKeyFound)
{
this.apiKey = apiKey.Value;
}
}
public async Task<PagedItems<Spill>?> GetSpills(int page = 1, JsonSerialiser? jsonSerialiser = null)
{
var request = new HttpRequestMessage()
{
RequestUri = new Uri(baseUrl + spillsEndpoint),
Method = HttpMethod.Get,
Headers =
{
{"Accept", "*/*"},
{"Accept-Language", "en-GB,en;q=0.5"},
// {"Accept-Encoding", "gzip, deflate, br, zstd"},
{"Cache-Control", "no-cache"},
{"Connection", "keep-alive"},
{"DNT", "1"},
{"User-Agent", "Mozilla/5.0 (Windows NT 10.0; rv:126.0) Gecko/20100101 Firefox/126.0"},
{"Upgrade-Insecure-Requests", "1"},
{"Referer", "https://www.southernwater.co.uk/our-region/clean-rivers-and-seas-task-force/beachbuoy-historic-release-table/"},
{"x-Gateway-APIKey", apiKey},
{"X-Requested-With", "XMLHttpRequest"},
}
};
request.Options.TryAdd("page", page);
var content = await _client.SendAsync(request);
content.EnsureSuccessStatusCode();
return (PagedItems<Spill>?) await content.Content.ReadFromJsonAsync(typeof(PagedItems<Spill>), jsonSerialiser ?? new JsonSerialiser());
}
}

18
Overflow/SouthernWater/Spill.cs Normal file
View File

@ -0,0 +1,18 @@
namespace Overflow.SouthernWater;
public class Spill
{
public int id { get; set; }
public int eventId { get; set; }
public int siteUnitNumber { get; set; }
public string bathingSite { get; set; }
public DateTime eventStart { get; set; }
public DateTime eventStop { get; set; }
public int duration { get; set; }
public string status { get; set; }
public int associatedSiteId { get; set; }
public string outfallName { get; set; }
public bool isImpacting { get; set; }
public int overFlowSiteId { get; set; }
public List<Spill> historicSpillsList { get; set; }
}