#include <http_lib_connection.h>

Public Types
using	RETRIEVER
	Allows replacing CURL fetches with a mock for testing.

Public Member Functions
	HTTP_LIB_CONNECTION (const HTTP_LIB_SOURCE &aSource, bool aTestConnectionNow)

	HTTP_LIB_CONNECTION (const HTTP_LIB_SOURCE &aSource, bool aTestConnectionNow, RETRIEVER aRetriever)

virtual	~HTTP_LIB_CONNECTION ()=default

bool	IsValidEndpoint () const

bool	SelectOne (const std::string &aPartID, HTTP_LIB_PART &aFetchedPart)
	Retrieve a single part with full details from the HTTP library.

bool	SelectAll (const HTTP_LIB_CATEGORY &aCategory, std::vector< HTTP_LIB_PART > &aParts)
	Retrieve all parts from a specific category from the HTTP library.

std::string	GetLastError () const

std::vector< HTTP_LIB_CATEGORY >	getCategories () const

std::string	getCategoryDescription (const std::string &aCategoryName) const

bool	HasCachedParts () const

bool	GetCachedPartRelation (const std::string &aPartName, std::string &aPartId, std::string &aCategoryId) const
	Resolve a cached part name to its part ID and category ID.

void	ClearPartCache ()

Private Member Functions
bool	validateHttpLibraryEndpoints ()

bool	syncCategories ()

bool	retrieve (const std::string &aUrl, int &aStatusCode, std::string &aBody)
	Fetch `aUrl` through the transport.

bool	checkServerResponse (int aStatusCode)

wxString	httpErrorCodeDescription (uint16_t aHttpCode)
	HTTP response status codes indicate whether a specific HTTP request has been successfully completed.

Private Attributes
std::mutex	m_queryMutex

HTTP_LIB_SOURCE	m_source

RETRIEVER	m_retriever

bool	m_endpointValid = false

std::string	m_lastError

std::vector< HTTP_LIB_CATEGORY >	m_categories

std::map< std::string, std::string >	m_categoryDescriptions

std::map< std::string, std::string >	m_parts

std::map< std::string, HTTP_LIB_PART >	m_cachedParts

std::map< std::string, std::tuple< std::string, std::string > >	m_cache

Detailed Description

Definition at line 47 of file http_lib_connection.h.

Member Typedef Documentation

◆ RETRIEVER

using HTTP_LIB_CONNECTION::RETRIEVER

Initial value:

std::function<bool( const std::string& aUrl, int& aStatusCode,

std::string& aBody, std::string& aError )>

Allows replacing CURL fetches with a mock for testing.

Parameters

aUrl	the URL to retrieve
aStatusCode	receives the HTTP status (0 when no response was received)
aBody	receives the response body
aError	receives a failure reason when the request could not be completed

Returns: true when a response was obtained (regardless of status code); false when the request could not be completed at the transport level

Definition at line 60 of file http_lib_connection.h.

Constructor & Destructor Documentation

◆ HTTP_LIB_CONNECTION() [1/2]

HTTP_LIB_CONNECTION::HTTP_LIB_CONNECTION	(	const HTTP_LIB_SOURCE &	aSource,
		bool	aTestConnectionNow )

Definition at line 67 of file http_lib_connection.cpp.

References HTTP_LIB_CONNECTION(), and makeDefaultRetriever().

Referenced by HTTP_LIB_CONNECTION().

◆ HTTP_LIB_CONNECTION() [2/2]

HTTP_LIB_CONNECTION::HTTP_LIB_CONNECTION	(	const HTTP_LIB_SOURCE &	aSource,
		bool	aTestConnectionNow,
		RETRIEVER	aRetriever )

Definition at line 73 of file http_lib_connection.cpp.

References m_retriever, m_source, move, and validateHttpLibraryEndpoints().

◆ ~HTTP_LIB_CONNECTION()

virtual HTTP_LIB_CONNECTION::~HTTP_LIB_CONNECTION ( )

virtualdefault

Member Function Documentation

◆ checkServerResponse()

bool HTTP_LIB_CONNECTION::checkServerResponse ( int aStatusCode )

private

Definition at line 455 of file http_lib_connection.cpp.

References _, httpErrorCodeDescription(), and m_lastError.

Referenced by SelectOne(), syncCategories(), and validateHttpLibraryEndpoints().

◆ ClearPartCache()

void HTTP_LIB_CONNECTION::ClearPartCache ( )

inline

Definition at line 139 of file http_lib_connection.h.

References m_cache, m_cachedParts, and m_queryMutex.

◆ GetCachedPartRelation()

bool HTTP_LIB_CONNECTION::GetCachedPartRelation	(	const std::string &	aPartName,
		std::string &	aPartId,
		std::string &	aCategoryId ) const

inline

Resolve a cached part name to its part ID and category ID.

Parameters

aPartName	the name to look up
aPartId	receives the part ID on a hit
aCategoryId	receives the category ID on a hit

Returns: true if the name was found; false otherwise

Definition at line 125 of file http_lib_connection.h.

References m_cache, and m_queryMutex.

Referenced by BOOST_AUTO_TEST_CASE().

◆ getCategories()

std::vector< HTTP_LIB_CATEGORY > HTTP_LIB_CONNECTION::getCategories ( ) const

inline

Definition at line 95 of file http_lib_connection.h.

References m_categories, and m_queryMutex.

Referenced by BOOST_AUTO_TEST_CASE().

◆ getCategoryDescription()

std::string HTTP_LIB_CONNECTION::getCategoryDescription ( const std::string & aCategoryName ) const

inline

Definition at line 101 of file http_lib_connection.h.

References m_categoryDescriptions, and m_queryMutex.

Referenced by BOOST_AUTO_TEST_CASE().

◆ GetLastError()

std::string HTTP_LIB_CONNECTION::GetLastError ( ) const

inline

Definition at line 89 of file http_lib_connection.h.

References m_lastError, and m_queryMutex.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), and BOOST_AUTO_TEST_CASE().

◆ HasCachedParts()

bool HTTP_LIB_CONNECTION::HasCachedParts ( ) const

inline

Definition at line 111 of file http_lib_connection.h.

References m_cache, and m_queryMutex.

◆ httpErrorCodeDescription()

wxString HTTP_LIB_CONNECTION::httpErrorCodeDescription ( uint16_t aHttpCode )

private

HTTP response status codes indicate whether a specific HTTP request has been successfully completed.

Responses are grouped in five classes:

Informational responses (100 ? 199)
Successful responses (200 ? 299)
Redirection messages (300 ? 399)
Client error responses (400 ? 499)
Server error responses (500 ? 599)

see: https://developer.mozilla.org/en-US/docs/Web/HTTP/Status

Definition at line 468 of file http_lib_connection.cpp.

Referenced by checkServerResponse().

◆ IsValidEndpoint()

bool HTTP_LIB_CONNECTION::IsValidEndpoint ( ) const

inline

Definition at line 69 of file http_lib_connection.h.

References m_endpointValid.

Referenced by BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), BOOST_AUTO_TEST_CASE(), SelectAll(), SelectOne(), and syncCategories().

◆ retrieve()

bool HTTP_LIB_CONNECTION::retrieve	(	const std::string &	aUrl,
		int &	aStatusCode,
		std::string &	aBody )

private

Fetch aUrl through the transport.

Returns: false (with m_lastError populated) when the transport could not complete the request; true otherwise, even when aStatusCode is not 200.

Definition at line 441 of file http_lib_connection.cpp.

References m_lastError, and m_retriever.

Referenced by SelectAll(), SelectOne(), syncCategories(), and validateHttpLibraryEndpoints().