Rename HTTPPackage and HTTPPackageParser + change HTTPRequestType type

DreamerDeLy · DreamerDeLy · commit 952d01b8c167 · 2023-03-15T13:28:17.000+02:00
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -13,5 +13,5 @@ jobs:
       - run: pio ci --board=esp32dev examples/Values/ --lib src/
       - run: pio ci --board=esp32dev examples/Timer_Basic/ --lib src/
       - run: pio ci --board=esp32dev examples/Timer_Callbacks/ --lib src/
-      - run: pio ci --board=esp32dev examples/HTTPPackage/ --lib src/
-      - run: pio ci --board=esp32dev examples/HTTPParser/ --lib src/
+      - run: pio ci --board=esp32dev examples/HTTPRequest/ --lib src/
+      - run: pio ci --board=esp32dev examples/HTTPResponse/ --lib src/
diff --git a/examples/HTTPRequest/HTTPRequest.ino b/examples/HTTPRequest/HTTPRequest.ino
@@ -1,6 +1,6 @@
 
 // Include library
-#include <net/HTTPPackage.h>
+#include <net/HTTPRequest.h>
 
 using namespace dream;
 
@@ -13,7 +13,7 @@ void setup()
 	Serial.begin(115200);
 	
 	// Create GET request
-	HTTPPackage get = HTTPPackage(HTTPRequestType::GET, "google.com", "/")
+	HTTPRequest get = HTTPRequest(GET, "google.com", "/")
 		.setUserAgent("ESP")
 		.addHeader("X-My-Header", "value")
 		.setEmptyBody();
@@ -23,7 +23,7 @@ void setup()
 	Serial.println();
 
 	// Create POST request
-	HTTPPackage post = HTTPPackage(HTTPRequestType::POST, "eco-city.org.ua", "/")
+	HTTPRequest post = HTTPRequest(POST, "eco-city.org.ua", "/")
 		.setUserAgent("ESP")
 		.setContentType("application/json");
 
diff --git a/examples/HTTPResponse/HTTPResponse.ino b/examples/HTTPResponse/HTTPResponse.ino
@@ -1,6 +1,6 @@
 
 // Include library
-#include <net/HTTPPackageParser.h>
+#include <net/HTTPResponse.h>
 
 using namespace dream;
 
@@ -13,7 +13,7 @@ void setup()
 	String package = "HTTP/1.1 200 OK\r\nDate: Tue, 14 Mar 2023 11:37:03 GMT\r\nServer: Apache/2.4.38 (Debian)\r\nCache-Control: no-cache, must-revalidate\r\nExpires: Sat, 26 Jul 1997 05:00:00 GMT\r\nVary: Accept-Encoding\r\nContent-Length: 19\r\nConnection: close\r\nContent-Type: application/json\r\n\r\n{\n    \"key\": true\n}";
 
 	// Parse package
-	HTTPPackageParser parser = HTTPPackageParser(package);
+	HTTPResponse parser = HTTPResponse(package);
 
 	// Print general values
 	Serial.println("HTTP status: " + String(parser.getStatus()));
diff --git a/src/net/HTTPRequest.h b/src/net/HTTPRequest.h
@@ -22,48 +22,48 @@
 
 namespace dream
 {
-	class HTTPPackage
+	class HTTPRequest
 	{
 		protected: //-----------------------------------------------------------
 
 		String _buffer = "";
 
 		public: //--------------------------------------------------------------
 
-		HTTPPackage(HTTPRequestType type, const String &host, const String &url)
+		HTTPRequest(HTTPRequestType type, const String &host, const String &url)
 		{
 			_buffer += HTTPTypeToString(type) + " " + url + " HTTP/1.1\r\n";
 			_buffer += "Host: " + host + "\r\n";
 		}
 
 		// Add custom header
-		HTTPPackage& addHeader(const String &name, const String &value)
+		HTTPRequest& addHeader(const String &name, const String &value)
 		{
 			_buffer += (name + ": " + value + "\r\n");
 			return *this;
 		}
 
 		// Set User-Agent header
-		HTTPPackage& setUserAgent(const String &user_agent)
+		HTTPRequest& setUserAgent(const String &user_agent)
 		{
 			return addHeader(F("User-Agent"), user_agent);
 		}
 
 		// Set Content-Type header
-		HTTPPackage& setContentType(const String &content_type)
+		HTTPRequest& setContentType(const String &content_type)
 		{
 			return addHeader(F("Content-Type"), content_type);
 		}
 
 		// Set BasicAuth 
-		HTTPPackage& setAuthorization(const String &user, const String &pass)
+		HTTPRequest& setAuthorization(const String &user, const String &pass)
 		{
 			_buffer += "Authorization: Basic " + base64::encode(user + ":" + pass);
 			return *this;
 		}
 
 		// Add package body
-		HTTPPackage& setBody(const String &data)
+		HTTPRequest& setBody(const String &data)
 		{
 			addHeader(F("Content-Length"), String(data.length()));
 
@@ -74,7 +74,7 @@ namespace dream
 		}
 
 		// End package
-		HTTPPackage& setEmptyBody()
+		HTTPRequest& setEmptyBody()
 		{
 			_buffer += "Connection: close\r\n\r\n";
 			return *this;
diff --git a/src/net/HTTPRequestType.h b/src/net/HTTPRequestType.h
@@ -5,7 +5,7 @@
 
 namespace dream
 {
-	enum class HTTPRequestType 
+	enum HTTPRequestType 
 	{ 
 		GET,
 		POST,
diff --git a/src/net/HTTPResponse.h b/src/net/HTTPResponse.h
@@ -19,11 +19,12 @@
 
 namespace dream
 {
-	class HTTPPackageParser
+	class HTTPResponse
 	{
 		private: //-------------------------------------------------------------
 
-		struct HTTPRequestHeader
+		// Object of HTTP package header
+		struct HTTPHeader
 		{
 			String name;
 			String value;
@@ -36,8 +37,9 @@ namespace dream
 		int _http_code;
 
 		// Headers
-		std::vector<HTTPRequestHeader> _headers;
+		std::vector<HTTPHeader> _headers;
 
+		// Some common headers as values
 		int _content_length;
 		String _content_type;
 		String _location;
@@ -132,7 +134,7 @@ namespace dream
 
 		public: //--------------------------------------------------------------
 
-		HTTPPackageParser(const String &package) 
+		HTTPResponse(const String &package) 
 		{
 			_buffer = package;
 			_buffer.trim();
@@ -141,37 +143,42 @@ namespace dream
 			headersDataToValues();
 		}
 
+		// Get some of most common headers
 		int getStatus() { return _http_code; }
 		int getContentLength() { return _content_length; } 
 		String getContentType() { return _content_type; } 
 		String getLocation() { return _location; } 
 		String getDate() { return _date; } 
 
-		std::vector<HTTPRequestHeader> getHeaders()
+		// Get list of headers
+		std::vector<HTTPHeader> getHeaders()
 		{
 			return _headers;
 		}
 
+		// Check if package has header
 		bool hasHeader(const String &name)
 		{
-			for (const HTTPRequestHeader &h : _headers)
+			for (const HTTPHeader &h : _headers)
 			{
 				if (h.name == name) return true;
 			}
 
 			return false;
 		}
 
+		// Get value of header
 		String getHeader(const String &name)
 		{
-			for (const HTTPRequestHeader &h : _headers)
+			for (const HTTPHeader &h : _headers)
 			{
 				if (h.name == name) return h.value;
 			}
 
 			return "";
 		}
 
+		// Get body data
 		String getBody()
 		{
 			return _body;

Original file line number	Diff line number	Diff line change
`@@ -22,48 +22,48 @@`
`22`	`22`
`23`	`23`	`namespace dream`
`24`	`24`	`{`
`25`		`- class HTTPPackage`
	`25`	`+ class HTTPRequest`
`26`	`26`	`{`
`27`	`27`	`protected: //-----------------------------------------------------------`
`28`	`28`
`29`	`29`	`String _buffer = "";`
`30`	`30`
`31`	`31`	`public: //--------------------------------------------------------------`
`32`	`32`
`33`		`- HTTPPackage(HTTPRequestType type, const String &host, const String &url)`
	`33`	`+ HTTPRequest(HTTPRequestType type, const String &host, const String &url)`
`34`	`34`	`{`
`35`	`35`	`_buffer += HTTPTypeToString(type) + " " + url + " HTTP/1.1\r\n";`
`36`	`36`	`_buffer += "Host: " + host + "\r\n";`
`37`	`37`	`}`
`38`	`38`
`39`	`39`	`// Add custom header`
`40`		`- HTTPPackage& addHeader(const String &name, const String &value)`
	`40`	`+ HTTPRequest& addHeader(const String &name, const String &value)`
`41`	`41`	`{`
`42`	`42`	`_buffer += (name + ": " + value + "\r\n");`
`43`	`43`	`return *this;`
`44`	`44`	`}`
`45`	`45`
`46`	`46`	`// Set User-Agent header`
`47`		`- HTTPPackage& setUserAgent(const String &user_agent)`
	`47`	`+ HTTPRequest& setUserAgent(const String &user_agent)`
`48`	`48`	`{`
`49`	`49`	`return addHeader(F("User-Agent"), user_agent);`
`50`	`50`	`}`
`51`	`51`
`52`	`52`	`// Set Content-Type header`
`53`		`- HTTPPackage& setContentType(const String &content_type)`
	`53`	`+ HTTPRequest& setContentType(const String &content_type)`
`54`	`54`	`{`
`55`	`55`	`return addHeader(F("Content-Type"), content_type);`
`56`	`56`	`}`
`57`	`57`
`58`	`58`	`// Set BasicAuth`
`59`		`- HTTPPackage& setAuthorization(const String &user, const String &pass)`
	`59`	`+ HTTPRequest& setAuthorization(const String &user, const String &pass)`
`60`	`60`	`{`
`61`	`61`	`_buffer += "Authorization: Basic " + base64::encode(user + ":" + pass);`
`62`	`62`	`return *this;`
`63`	`63`	`}`
`64`	`64`
`65`	`65`	`// Add package body`
`66`		`- HTTPPackage& setBody(const String &data)`
	`66`	`+ HTTPRequest& setBody(const String &data)`
`67`	`67`	`{`
`68`	`68`	`addHeader(F("Content-Length"), String(data.length()));`
`69`	`69`
`@@ -74,7 +74,7 @@ namespace dream`
`74`	`74`	`}`
`75`	`75`
`76`	`76`	`// End package`
`77`		`- HTTPPackage& setEmptyBody()`
	`77`	`+ HTTPRequest& setEmptyBody()`
`78`	`78`	`{`
`79`	`79`	`_buffer += "Connection: close\r\n\r\n";`
`80`	`80`	`return *this;`
Original file line number	Diff line number	Diff line change
`@@ -5,7 +5,7 @@`
`5`	`5`
`6`	`6`	`namespace dream`
`7`	`7`	`{`
`8`		`- enum class HTTPRequestType`
	`8`	`+ enum HTTPRequestType`
`9`	`9`	`{`
`10`	`10`	`GET,`
`11`	`11`	`POST,`
Original file line number	Diff line number	Diff line change
`@@ -19,11 +19,12 @@`
`19`	`19`
`20`	`20`	`namespace dream`
`21`	`21`	`{`
`22`		`- class HTTPPackageParser`
	`22`	`+ class HTTPResponse`
`23`	`23`	`{`
`24`	`24`	`private: //-------------------------------------------------------------`
`25`	`25`
`26`		`- struct HTTPRequestHeader`
	`26`	`+ // Object of HTTP package header`
	`27`	`+ struct HTTPHeader`
`27`	`28`	`{`
`28`	`29`	`String name;`
`29`	`30`	`String value;`
`@@ -36,8 +37,9 @@ namespace dream`
`36`	`37`	`int _http_code;`
`37`	`38`
`38`	`39`	`// Headers`
`39`		`- std::vector<HTTPRequestHeader> _headers;`
	`40`	`+ std::vector<HTTPHeader> _headers;`
`40`	`41`
	`42`	`+ // Some common headers as values`
`41`	`43`	`int _content_length;`
`42`	`44`	`String _content_type;`
`43`	`45`	`String _location;`
`@@ -132,7 +134,7 @@ namespace dream`
`132`	`134`
`133`	`135`	`public: //--------------------------------------------------------------`
`134`	`136`
`135`		`- HTTPPackageParser(const String &package)`
	`137`	`+ HTTPResponse(const String &package)`
`136`	`138`	`{`
`137`	`139`	`_buffer = package;`
`138`	`140`	`_buffer.trim();`
`@@ -141,37 +143,42 @@ namespace dream`
`141`	`143`	`headersDataToValues();`
`142`	`144`	`}`
`143`	`145`
	`146`	`+ // Get some of most common headers`
`144`	`147`	`int getStatus() { return _http_code; }`
`145`	`148`	`int getContentLength() { return _content_length; }`
`146`	`149`	`String getContentType() { return _content_type; }`
`147`	`150`	`String getLocation() { return _location; }`
`148`	`151`	`String getDate() { return _date; }`
`149`	`152`
`150`		`- std::vector<HTTPRequestHeader> getHeaders()`
	`153`	`+ // Get list of headers`
	`154`	`+ std::vector<HTTPHeader> getHeaders()`
`151`	`155`	`{`
`152`	`156`	`return _headers;`
`153`	`157`	`}`
`154`	`158`
	`159`	`+ // Check if package has header`
`155`	`160`	`bool hasHeader(const String &name)`
`156`	`161`	`{`
`157`		`- for (const HTTPRequestHeader &h : _headers)`
	`162`	`+ for (const HTTPHeader &h : _headers)`
`158`	`163`	`{`
`159`	`164`	`if (h.name == name) return true;`
`160`	`165`	`}`
`161`	`166`
`162`	`167`	`return false;`
`163`	`168`	`}`
`164`	`169`
	`170`	`+ // Get value of header`
`165`	`171`	`String getHeader(const String &name)`
`166`	`172`	`{`
`167`		`- for (const HTTPRequestHeader &h : _headers)`
	`173`	`+ for (const HTTPHeader &h : _headers)`
`168`	`174`	`{`
`169`	`175`	`if (h.name == name) return h.value;`
`170`	`176`	`}`
`171`	`177`
`172`	`178`	`return "";`
`173`	`179`	`}`
`174`	`180`
	`181`	`+ // Get body data`
`175`	`182`	`String getBody()`
`176`	`183`	`{`
`177`	`184`	`return _body;`