Method overloading structure converted to Builder Pattern

Author: leventkaragol

README.md

@@ -70,10 +70,13 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
+    HttpRequest httpRequest("https://api.myproject.com");
 
     // The simplest but slowest method if multiple calls will be made
-    auto response = httpRequest.getRequest("https://api.myproject.com?param1=7&param2=test").get();
+    auto response = httpRequest
+            .setQueryString("param1=7&param2=test")
+            .send()
+            .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
@@ -98,13 +101,17 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
-
-    auto response1 = httpRequest.getRequest("https://api.myproject.com/foo").get();
-    auto response2 = httpRequest.getRequest("https://api.myproject.com/bar").get();
-    auto response3 = httpRequest.getRequest("https://api.myproject.com/baz").get();
-    auto response4 = httpRequest.getRequest("https://api.myproject.com/qux").get();
-    auto response5 = httpRequest.getRequest("https://api.myproject.com/quux").get();
+    HttpRequest httpRequest1("https://api.myproject.com/foo");
+    HttpRequest httpRequest2("https://api.myproject.com/bar");
+    HttpRequest httpRequest3("https://api.myproject.com/baz");
+    HttpRequest httpRequest4("https://api.myproject.com/qux");
+    HttpRequest httpRequest5("https://api.myproject.com/quux");
+
+    auto response1 = httpRequest1.send().get();
+    auto response2 = httpRequest2.send().get();
+    auto response3 = httpRequest3.send().get();
+    auto response4 = httpRequest4.send().get();
+    auto response5 = httpRequest5.send().get();
 
     // Takes 2.5 seconds in total
 
@@ -124,13 +131,17 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
-
-    auto future1 = httpRequest.getRequest("https://api.myproject.com/foo");
-    auto future2 = httpRequest.getRequest("https://api.myproject.com/bar");
-    auto future3 = httpRequest.getRequest("https://api.myproject.com/baz");
-    auto future4 = httpRequest.getRequest("https://api.myproject.com/qux");
-    auto future5 = httpRequest.getRequest("https://api.myproject.com/quux");
+    HttpRequest httpRequest1("https://api.myproject.com/foo");
+    HttpRequest httpRequest2("https://api.myproject.com/bar");
+    HttpRequest httpRequest3("https://api.myproject.com/baz");
+    HttpRequest httpRequest4("https://api.myproject.com/qux");
+    HttpRequest httpRequest5("https://api.myproject.com/quux");
+
+    auto future1 = httpRequest.send();
+    auto future2 = httpRequest.send();
+    auto future3 = httpRequest.send();
+    auto future4 = httpRequest.send();
+    auto future5 = httpRequest.send();
 
     auto response1 = future1.get();
     auto response2 = future2.get();
@@ -166,9 +177,9 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
+    HttpRequest httpRequest("https://www.myinvalidurl.com");
 
-    auto response = httpRequest.getRequest("https://www.myinvalidurl.com").get();
+    auto response = httpRequest.send().get();
 
     // Instead of throwing an exception, the succeed field of the response object is set to false
     std::cout << "Succeed: " << response.succeed << std::endl;
@@ -200,10 +211,13 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
+    HttpRequest httpRequest("https://api.myproject.com/image/7");
 
-    // If you need to retrieve binary data such as an image, just pass the "returnAsBinary" parameter as true
-    auto response = httpRequest.getRequest("https://api.myproject.com/image/7", true).get();
+    // If you need to retrieve binary data such as an image, just call the "returnAsBinary" method before send
+    auto response = httpRequest
+            .returnAsBinary()
+            .send()
+            .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
@@ -229,16 +243,15 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
-
-    // You can send custom headers in a string/string map
-    auto headers = std::map<std::string, std::string>();
-
-    headers["Custom-Header1"] = "value1";
-    headers["Custom-Header2"] = "value2";
-
-    auto response = httpRequest.getRequest("https://api.myproject.com?param1=7&param2=test", headers).get();
-
+    HttpRequest httpRequest("https://api.myproject.com?param1=7&param2=test");
+
+    // You can send custom headers as key-value pairs
+    auto response = httpRequest
+            .addHeader("Custom-Header1", "value1")
+            .addHeader("Custom-Header2", "value2")
+            .send()
+            .get();
+    
     std::cout << "Succeed: " << response.succeed << std::endl;
 
     return 0;
@@ -259,12 +272,14 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
+    HttpRequest httpRequest("https://api.myproject.com");
 
     // You can send a POST request with form data in the payload
-    std::string payload = "param1=7&param2=test";
-
-    auto response = httpRequest.postRequest("https://api.myproject.com", payload).get();
+    auto response = httpRequest
+            .setMethod(HttpMethod::POST)
+            .setPayload("param1=7&param2=test")
+            .send()
+            .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
@@ -288,16 +303,15 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
-
-    std::string payload = R"({"param1": 7, "param2": "test"})";
-
+    HttpRequest httpRequest("https://api.myproject.com");
+    
     // You need to send the "Content-Type" as "application/json" in the HTTP Header, if you need to send json data in the payload
-    auto headers = std::map<std::string, std::string>();
-
-    headers["Content-Type"] = "application/json";
-
-    auto response = httpRequest.postRequest("https://api.myproject.com", payload, headers).get();
+    auto response = httpRequest
+            .setMethod(HttpMethod::POST)
+            .setPayload(R"({"param1": 7, "param2": "test"})")
+            .addHeader("Content-Type", "application/json")
+            .send()
+            .get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;
@@ -320,13 +334,29 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
+    HttpRequest httpRequest1("https://api.myproject.com");
 
-    std::string payload = "param1=7&param2=test";
+    auto future1 = httpRequest
+            .setMethod(HttpMethod::PUT)
+            .setPayload("param1=7&param2=test")
+            .send()
+            .get();
+    
+    HttpRequest httpRequest2("https://api.myproject.com");
 
-    auto future1 = httpRequest.putRequest("https://api.myproject.com", payload);
-    auto future2 = httpRequest.deleteRequest("https://api.myproject.com", payload);
-    auto future3 = httpRequest.patchRequest("https://api.myproject.com?param1=7&param2=test");
+    auto future2 = httpRequest
+            .setMethod(HttpMethod::DELETE_)
+            .setPayload("param1=7&param2=test")
+            .send()
+            .get();
+    
+    HttpRequest httpRequest3("https://api.myproject.com");
+    
+    auto future3 = httpRequest
+            .setMethod(HttpMethod::PATCH)
+            .setQueryString("param1=7&param2=test")
+            .send()
+            .get();
 
     auto response1 = future1.get();
     auto response2 = future2.get();
@@ -351,12 +381,10 @@ using namespace lklibs;
 
 int main() {
 
-    HttpRequest httpRequest;
-    
-    // If you need to ignore SSL errors, you can set the "ignoreSslErrors" field to true
-    httpRequest.ignoreSslErrors = true;
+    HttpRequest httpRequest("https://api.myinvalidssl.com");
 
-    auto response = httpRequest.getRequest("https://api.myinvalidssl.com").get();
+    // If you need to ignore SSL errors, you can call "ignoreSslErrors" method before sending the request
+    auto response = httpRequest.ignoreSslErrors().send().get();
 
     return 0;
 }
@@ -381,58 +409,21 @@ section to the documentation.
 
 ## Full function list
 
-You can find the complete list of functions in the library below. In fact, they are just 
-overloaded versions of 5 functions in total.
+You can find the complete list of functions in the library below. Since all methods except 
+send return the class itself, they can be added one after the other like a chain.
 
 > [!TIP]
 > All methods and parameters descriptions are also available within the code as comment for IDEs.
 
 ```cpp
-- getRequest
-    - std::future<HttpResult> getRequest(const std::string &url)
-    - std::future<HttpResult> getRequest(const std::string &url, bool returnAsBinary)
-    - std::future<HttpResult> getRequest(const std::string &url, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> getRequest(const std::string &url, bool returnAsBinary, const std::map<std::string, std::string> &headers)
-
-
-- postRequest
-    - std::future<HttpResult> postRequest(const std::string &url)
-    - std::future<HttpResult> postRequest(const std::string &url, const std::string &payload)
-    - std::future<HttpResult> postRequest(const std::string &url, bool returnAsBinary)
-    - std::future<HttpResult> postRequest(const std::string &url, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> postRequest(const std::string &url, const std::string &payload, bool returnAsBinary)
-    - std::future<HttpResult> postRequest(const std::string &url, const std::string &payload, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> postRequest(const std::string &url, bool returnAsBinary, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> postRequest(const std::string &url, const std::string &payload, bool returnAsBinary, const std::map<std::string, std::string> &headers)
-
-
-- putRequest
-    - std::future<HttpResult> putRequest(const std::string &url)
-    - std::future<HttpResult> putRequest(const std::string &url, const std::string &payload)
-    - std::future<HttpResult> putRequest(const std::string &url, bool returnAsBinary)
-    - std::future<HttpResult> putRequest(const std::string &url, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> putRequest(const std::string &url, const std::string &payload, bool returnAsBinary)
-    - std::future<HttpResult> putRequest(const std::string &url, const std::string &payload, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> putRequest(const std::string &url, bool returnAsBinary, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> putRequest(const std::string &url, const std::string &payload, bool returnAsBinary, const std::map<std::string, std::string> &headers)
-
-
-- deleteRequest
-    - std::future<HttpResult> deleteRequest(const std::string &url)
-    - std::future<HttpResult> deleteRequest(const std::string &url, const std::string &payload)
-    - std::future<HttpResult> deleteRequest(const std::string &url, bool returnAsBinary)
-    - std::future<HttpResult> deleteRequest(const std::string &url, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> deleteRequest(const std::string &url, const std::string &payload, bool returnAsBinary)
-    - std::future<HttpResult> deleteRequest(const std::string &url, const std::string &payload, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> deleteRequest(const std::string &url, bool returnAsBinary, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> deleteRequest(const std::string &url, const std::string &payload, bool returnAsBinary, const std::map<std::string, std::string> &headers)
-
-
-- patchRequest
-    - std::future<HttpResult> patchRequest(const std::string &url)
-    - std::future<HttpResult> patchRequest(const std::string &url, bool returnAsBinary)
-    - std::future<HttpResult> patchRequest(const std::string &url, const std::map<std::string, std::string> &headers)
-    - std::future<HttpResult> patchRequest(const std::string &url, bool returnAsBinary, const std::map<std::string, std::string> &headers)
+- HttpRequest &setMethod(const HttpMethod &method)
+- HttpRequest &setQueryString(const std::string &queryString)
+- HttpRequest &setPayload(const std::string &payload)
+- HttpRequest &returnAsBinary()
+- HttpRequest &ignoreSslErrors()
+- HttpRequest &addHeader(const std::string &key, const std::string &value)
+- std::future<HttpResult> send() noexcept
+
 ```
 
 

examples/main.cpp

@@ -51,7 +51,7 @@ void receiveBinaryData() {
 
     HttpRequest httpRequest("https://httpbun.com/bytes/100");
 
-    // If you need to retrieve binary data such as an image, just call the "returnAsBinary" method
+    // If you need to retrieve binary data such as an image, just call the "returnAsBinary" method before send
     auto response = httpRequest
             .returnAsBinary()
             .send()