Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Prenote outbound api calls #328

Merged
merged 9 commits into from
Sep 4, 2021
Merged

Prenote outbound api calls #328

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
a2f3a3d
Request Builder Functions
AndyTWF Aug 22, 2021
1abe8e5
Style
AndyTWF Aug 22, 2021
586b370
Tidy Up The Api Helper
AndyTWF Aug 22, 2021
9844a05
Add To ApiHelper
AndyTWF Aug 22, 2021
1f7c7cd
Formatting
AndyTWF Aug 22, 2021
df2b0f1
Merge remote-tracking branch 'upstream/feature/prenote-messages' into…
AndyTWF Aug 26, 2021
ca360c7
Fix missing constructor for ApiInterface
AndyTWF Aug 26, 2021
5857974
Fix Method
AndyTWF Aug 26, 2021
f24932f
Merge remote-tracking branch 'upstream/feature/prenote-messages' into…
AndyTWF Aug 30, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
719 changes: 339 additions & 380 deletions src/utils/api/ApiHelper.cpp
View file
Open in desktop

Large diffs are not rendered by default.

216 changes: 100 additions & 116 deletions src/utils/api/ApiHelper.h
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,126 +1,110 @@
#pragma once
#include "api/ApiResponse.h"
#include "api/ApiRequestBuilder.h"
#include "api/ApiInterface.h"
#include "api/ApiRequestBuilder.h"
#include "api/ApiResponse.h"

namespace UKControllerPlugin {
namespace Curl {
class CurlInterface;
class CurlRequest;
} // namespace Curl
namespace Windows {
class WinApiInterface;
} // namespace Windows
} // namespace UKControllerPlugin

namespace UKControllerPlugin {
namespace Api {

/*
A class for making requests to the UKCP API.
*/
class ApiHelper : public UKControllerPlugin::Api::ApiInterface
{
public:
ApiHelper(
UKControllerPlugin::Curl::CurlInterface & curlApi,
ApiRequestBuilder requestBuilder
);
namespace UKControllerPlugin::Curl {
class CurlInterface;
class CurlRequest;
} // namespace UKControllerPlugin::Curl

UKControllerPlugin::Squawk::ApiSquawkAllocation CreateGeneralSquawkAssignment(
std::string callsign,
std::string origin,
std::string destination
) const override;
UKControllerPlugin::Squawk::ApiSquawkAllocation CreateLocalSquawkAssignment(
std::string callsign,
std::string unit,
std::string flightRules
) const override;
bool CheckApiAuthorisation(void) const override;
void DeleteSquawkAssignment(std::string callsign) const override;
std::string FetchRemoteFile(std::string uri) const override;
UKControllerPlugin::Squawk::ApiSquawkAllocation GetAssignedSquawk(std::string callsign) const override;
std::string GetApiDomain(void) const override;
std::string GetApiKey(void) const override;
nlohmann::json GetDependencyList(void) const override;
nlohmann::json GetHoldDependency(void) const override;
nlohmann::json GetAssignedHolds(void) const override;;
void AssignAircraftToHold(std::string callsign, std::string navaid) const override;
void UnassignAircraftHold(std::string callsign) const override;
nlohmann::json GetMinStackLevels(void) const override;
nlohmann::json GetRegionalPressures(void) const override;
nlohmann::json GetUri(std::string uri) const;
nlohmann::json SearchSrd(Srd::SrdSearchParameters params) const override;
nlohmann::json GetAssignedStands(void) const override;
void AssignStandToAircraft(std::string callsign, int standId) const override;
void DeleteStandAssignmentForAircraft(std::string callsign) const override;
void SendEnrouteRelease(
std::string aircraftCallsign,
std::string sendingController,
std::string targetController,
int releaseType
) const override;
void SendEnrouteReleaseWithReleasePoint(
std::string aircraftCallsign,
std::string sendingController,
std::string targetController,
int releaseType,
std::string releasePoint
) const override;
nlohmann::json GetUpdateDetails() const override;
nlohmann::json GetAllNotifications() const override;
nlohmann::json GetUnreadNotifications() const override;
nlohmann::json SyncPluginEvents() const override;
nlohmann::json GetLatestPluginEvents(int lastEventId) const override;
void AcknowledgeDepartureReleaseRequest(int releaseId, int controllerPositionId) const override;
void RejectDepartureReleaseRequest(int releaseId, int controllerPositionId) const override;
void ApproveDepartureReleaseRequest(
int releaseId,
int controllerPositionId,
std::chrono::system_clock::time_point releasedAt,
int expiresInSeconds
) const override;
nlohmann::json RequestDepartureRelease(
std::string callsign,
int requestingControllerId,
int targetControllerId,
int expiresInSeconds
) const override;
void CancelDepartureReleaseRequest(int releaseId) const override;
void ReadNotification(int id) const override;
int UpdateCheck(std::string version) const override;
void SetApiKey(std::string key) override;
void SetApiDomain(std::string domain) override;
namespace UKControllerPlugin::Api {

// The HTTP status codes that may be returned by the API
static const uint64_t STATUS_OK = 200L;
static const uint64_t STATUS_CREATED = 201L;
static const uint64_t STATUS_NO_CONTENT = 204L;
static const uint64_t STATUS_BAD_REQUEST = 400L;
static const uint64_t STATUS_UNAUTHORISED = 401L;
static const uint64_t STATUS_FORBIDDEN = 403L;
static const uint64_t STATUS_NOT_FOUND = 404L;
static const uint64_t STATUS_TEAPOT = 418L;
static const uint64_t STATUS_SERVER_ERROR = 500L;
static const uint64_t STATUS_SERVICE_UNAVAILBLE = 503L;
/*
A class for making requests to the UKCP API.
*/
class ApiHelper : public UKControllerPlugin::Api::ApiInterface
{
public:
ApiHelper(UKControllerPlugin::Curl::CurlInterface& curlApi, ApiRequestBuilder requestBuilder);

private:
[[nodiscard]] auto
CreateGeneralSquawkAssignment(std::string callsign, std::string origin, std::string destination) const
-> UKControllerPlugin::Squawk::ApiSquawkAllocation override;
[[nodiscard]] auto
CreateLocalSquawkAssignment(std::string callsign, std::string unit, std::string flightRules) const
-> UKControllerPlugin::Squawk::ApiSquawkAllocation override;
[[nodiscard]] auto CheckApiAuthorisation() const -> bool override;
void DeleteSquawkAssignment(std::string callsign) const override;
[[nodiscard]] auto FetchRemoteFile(std::string uri) const -> std::string override;
[[nodiscard]] auto GetAssignedSquawk(std::string callsign) const
-> UKControllerPlugin::Squawk::ApiSquawkAllocation override;
[[nodiscard]] auto GetApiDomain() const -> std::string override;
[[nodiscard]] auto GetApiKey() const -> std::string override;
[[nodiscard]] auto GetDependencyList() const -> nlohmann::json override;
[[nodiscard]] auto GetHoldDependency() const -> nlohmann::json override;
[[nodiscard]] auto GetAssignedHolds() const -> nlohmann::json override;
;
void AssignAircraftToHold(std::string callsign, std::string navaid) const override;
void UnassignAircraftHold(std::string callsign) const override;
[[nodiscard]] auto GetMinStackLevels() const -> nlohmann::json override;
[[nodiscard]] auto GetRegionalPressures() const -> nlohmann::json override;
[[nodiscard]] auto GetUri(std::string uri) const -> nlohmann::json override;
[[nodiscard]] auto SearchSrd(Srd::SrdSearchParameters params) const -> nlohmann::json override;
[[nodiscard]] auto GetAssignedStands() const -> nlohmann::json override;
void AssignStandToAircraft(std::string callsign, int standId) const override;
void DeleteStandAssignmentForAircraft(std::string callsign) const override;
void SendEnrouteRelease(
std::string aircraftCallsign,
std::string sendingController,
std::string targetController,
int releaseType) const override;
void SendEnrouteReleaseWithReleasePoint(
std::string aircraftCallsign,
std::string sendingController,
std::string targetController,
int releaseType,
std::string releasePoint) const override;
[[nodiscard]] auto GetUpdateDetails() const -> nlohmann::json override;
[[nodiscard]] auto GetAllNotifications() const -> nlohmann::json override;
[[nodiscard]] auto GetUnreadNotifications() const -> nlohmann::json override;
[[nodiscard]] auto SyncPluginEvents() const -> nlohmann::json override;
[[nodiscard]] auto GetLatestPluginEvents(int lastEventId) const -> nlohmann::json override;
void AcknowledgeDepartureReleaseRequest(int releaseId, int controllerPositionId) const override;
void RejectDepartureReleaseRequest(int releaseId, int controllerPositionId) const override;
void ApproveDepartureReleaseRequest(
int releaseId,
int controllerPositionId,
std::chrono::system_clock::time_point releasedAt,
int expiresInSeconds) const override;
[[nodiscard]] auto RequestDepartureRelease(
std::string callsign, int requestingControllerId, int targetControllerId, int expiresInSeconds) const
-> nlohmann::json override;
void CancelDepartureReleaseRequest(int releaseId) const override;
void ReadNotification(int id) const override;
void SetApiKey(std::string key) override;
void SetApiDomain(std::string domain) override;
[[nodiscard]] auto CreatePrenoteMessage(
const std::string& callsign,
const std::string& departureAirfield,
const std::string& departureSid,
const std::string& destinationAirfield,
int requestingController,
int targetController,
int requestExpiry) const -> nlohmann::json override;
void AcknowledgePrenoteMessage(int messageId, int controllerId) const override;
void DeletePrenoteMessage(int messageId) const override;

ApiResponse MakeApiRequest(
const UKControllerPlugin::Curl::CurlRequest request
) const;
// The HTTP status codes that may be returned by the API
static const uint64_t STATUS_OK = 200L;
static const uint64_t STATUS_CREATED = 201L;
static const uint64_t STATUS_NO_CONTENT = 204L;
static const uint64_t STATUS_BAD_REQUEST = 400L;
static const uint64_t STATUS_UNAUTHORISED = 401L;
static const uint64_t STATUS_FORBIDDEN = 403L;
static const uint64_t STATUS_NOT_FOUND = 404L;
static const uint64_t STATUS_SERVER_ERROR = 500L;
static const uint64_t STATUS_SERVICE_UNAVAILBLE = 503L;

UKControllerPlugin::Squawk::ApiSquawkAllocation ProcessSquawkResponse(
const ApiResponse response,
std::string callsign
) const;
private:
[[nodiscard]] auto MakeApiRequest(const UKControllerPlugin::Curl::CurlRequest& request) const -> ApiResponse;
[[nodiscard]] static auto ProcessSquawkResponse(const ApiResponse& response, const std::string& callsign)
-> UKControllerPlugin::Squawk::ApiSquawkAllocation;

// The API request builder, that builds our CurlRequests
UKControllerPlugin::Api::ApiRequestBuilder requestBuilder;
// The API request builder, that builds our CurlRequests
UKControllerPlugin::Api::ApiRequestBuilder requestBuilder;

// An interface to the Curl library.
UKControllerPlugin::Curl::CurlInterface & curlApi;
};
} // namespace Api
} // namespace UKControllerPlugin
// An interface to the Curl library.
UKControllerPlugin::Curl::CurlInterface& curlApi;
};
} // namespace UKControllerPlugin::Api