Method overloading structure converted to Builder Pattern

Author: Levent KARAGÖL

examples/main.cpp

@@ -5,10 +5,10 @@ using namespace lklibs;
 
 void simpleGet() {
 
-    HttpClient httpClient("https://httpbun.com/get");
+    HttpRequest httpRequest("https://httpbun.com/get");
 
     // The simplest but slowest method if multiple calls will be made
-    auto response = httpClient
+    auto response = httpRequest
             .setQueryString("param1=7&param2=test")
             .send()
             .get();
@@ -20,14 +20,14 @@ void simpleGet() {
 
 void nonBlockingGet() {
 
-    HttpClient httpClient1("https://httpbun.com/get");
-    HttpClient httpClient2("https://httpbun.com/get");
-    HttpClient httpClient3("https://httpbun.com/get");
+    HttpRequest httpRequest1("https://httpbun.com/get");
+    HttpRequest httpRequest2("https://httpbun.com/get");
+    HttpRequest httpRequest3("https://httpbun.com/get");
 
     // All requests are made one after the other without waiting for a response
-    auto future1 = httpClient1.setQueryString("param1=1&param2=test1").send();
-    auto future2 = httpClient2.setQueryString("param1=2&param2=test2").send();
-    auto future3 = httpClient3.setQueryString("param1=3&param2=test3").send();
+    auto future1 = httpRequest1.setQueryString("param1=1&param2=test1").send();
+    auto future2 = httpRequest2.setQueryString("param1=2&param2=test2").send();
+    auto future3 = httpRequest3.setQueryString("param1=3&param2=test3").send();
 
     // Then all the answers are received. Thus, 3 requests are sent in parallel
     auto response1 = future1.get();
@@ -49,10 +49,10 @@ void nonBlockingGet() {
 
 void receiveBinaryData() {
 
-    HttpClient httpClient("https://httpbun.com/bytes/100");
+    HttpRequest httpRequest("https://httpbun.com/bytes/100");
 
     // If you need to retrieve binary data such as an image, just call the "returnAsBinary" method
-    auto response = httpClient
+    auto response = httpRequest
             .returnAsBinary()
             .send()
             .get();
@@ -66,10 +66,10 @@ void receiveBinaryData() {
 
 void receiveError() {
 
-    HttpClient httpClient("https://httpbun.com/not_found");
+    HttpRequest httpRequest("https://httpbun.com/not_found");
 
     // This is an exception free library. If an error occurs, no exception is thrown
-    auto response = httpClient.send().get();
+    auto response = httpRequest.send().get();
 
     // Instead, the succeed field of the response object is set to false
     std::cout << "Succeed: " << response.succeed << std::endl;
@@ -83,10 +83,10 @@ void receiveError() {
 
 void sendingHttpHeaders() {
 
-    HttpClient httpClient("https://httpbun.com/get?param1=7&param2=test");
+    HttpRequest httpRequest("https://httpbun.com/get?param1=7&param2=test");
 
     // You can send custom headers as key-value pairs
-    auto response = httpClient
+    auto response = httpRequest
             .addHeader("Custom-Header1", "value1")
             .addHeader("Custom-Header2", "value2")
             .send()
@@ -97,10 +97,10 @@ void sendingHttpHeaders() {
 
 void simplePostWithFormData() {
 
-    HttpClient httpClient("https://httpbun.com/post");
+    HttpRequest httpRequest("https://httpbun.com/post");
 
     // You can send a POST request with form data in the payload
-    auto response = httpClient
+    auto response = httpRequest
             .setMethod(HttpMethod::POST)
             .setPayload("param1=7&param2=test")
             .send()
@@ -113,10 +113,10 @@ void simplePostWithFormData() {
 
 void simplePostWithJSONData() {
 
-    HttpClient httpClient("https://httpbun.com/post");
+    HttpRequest httpRequest("https://httpbun.com/post");
 
     // 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 response = httpClient
+    auto response = httpRequest
             .setMethod(HttpMethod::POST)
             .setPayload(R"({"param1": 7, "param2": "test"})")
             .addHeader("Content-Type", "application/json")
@@ -130,10 +130,10 @@ void simplePostWithJSONData() {
 
 void simplePutWithFormData() {
 
-    HttpClient httpClient("https://httpbun.com/put");
+    HttpRequest httpRequest("https://httpbun.com/put");
 
     // You can send a PUT request with form data in the payload just like POST
-    auto response = httpClient
+    auto response = httpRequest
             .setMethod(HttpMethod::PUT)
             .setPayload("param1=7&param2=test")
             .send()
@@ -146,10 +146,10 @@ void simplePutWithFormData() {
 
 void simpleDeleteWithFormData() {
 
-    HttpClient httpClient("https://httpbun.com/delete");
+    HttpRequest httpRequest("https://httpbun.com/delete");
 
     // You can send a DELETE request with form data in the payload just like POST
-    auto response = httpClient
+    auto response = httpRequest
             .setMethod(HttpMethod::DELETE_)
             .setPayload("param1=7&param2=test")
             .send()
@@ -162,10 +162,10 @@ void simpleDeleteWithFormData() {
 
 void simplePatch() {
 
-    HttpClient httpClient("https://httpbun.com/patch");
+    HttpRequest httpRequest("https://httpbun.com/patch");
 
     // You can send a PATCH request with QueryString just like GET
-    auto response = httpClient
+    auto response = httpRequest
             .setMethod(HttpMethod::PATCH)
             .setQueryString("param1=7&param2=test")
             .send()
@@ -178,10 +178,10 @@ void simplePatch() {
 
 void ignoreSslErrors() {
 
-    HttpClient httpClient("https://self-signed-cert.httpbun.com");
+    HttpRequest httpRequest("https://self-signed-cert.httpbun.com");
 
     // If you need to ignore SSL errors, you can call "ignoreSslErrors" method before sending the request
-    auto response = httpClient.ignoreSslErrors().send().get();
+    auto response = httpRequest.ignoreSslErrors().send().get();
 
     std::cout << "Succeed: " << response.succeed << std::endl;
     std::cout << "Http Status Code: " << response.statusCode << std::endl;

src/libcpp-http-client.hpp

@@ -89,24 +89,24 @@ namespace lklibs {
     };
 
     /**
-     * @brief HTTP client class that makes asynchronous HTTP requests
+     * @brief HTTP request class that makes asynchronous HTTP calls
      */
-    class HttpClient {
+    class HttpRequest {
     public:
 
         /**
-         * @brief Constructor for the HttpClient class
+         * @brief Constructor for the HttpRequest class
          *
          * @param url: URL for the request
          */
-        explicit HttpClient(const std::string &url) {
+        explicit HttpRequest(const std::string &url) {
 
             this->url = url;
 
             curl_global_init(CURL_GLOBAL_DEFAULT);
         }
 
-        ~HttpClient() {
+        ~HttpRequest() {
             curl_global_cleanup();
         }
 
@@ -115,7 +115,7 @@ namespace lklibs {
          *
          * @param method: HTTP method to be used for the request
          */
-        HttpClient &setMethod(const HttpMethod &method) {
+        HttpRequest &setMethod(const HttpMethod &method) {
 
             this->method = [method] {
                 switch (method) {
@@ -142,7 +142,7 @@ namespace lklibs {
          *
          * @param queryString: Query string to be sent with the request
          */
-        HttpClient &setQueryString(const std::string &queryString) {
+        HttpRequest &setQueryString(const std::string &queryString) {
 
             if (this->url.find('?') != std::string::npos) {
 
@@ -163,7 +163,7 @@ namespace lklibs {
          *
          * @param payload: Payload to be sent with the request
          */
-        HttpClient &setPayload(const std::string &payload) {
+        HttpRequest &setPayload(const std::string &payload) {
 
             this->payload = payload;
 
@@ -173,7 +173,7 @@ namespace lklibs {
         /**
          * @brief Set the return format for the request as binary
          */
-        HttpClient &returnAsBinary() {
+        HttpRequest &returnAsBinary() {
 
             this->returnFormat = ReturnFormat::BINARY;
 
@@ -183,7 +183,7 @@ namespace lklibs {
         /**
          * @brief Ignore SSL errors when making HTTP requests
          */
-        HttpClient &ignoreSslErrors() {
+        HttpRequest &ignoreSslErrors() {
 
             this->sslErrorsWillBeIgnored = true;
 
@@ -196,7 +196,7 @@ namespace lklibs {
          * @param key: Header key
          * @param value: Header value
          */
-        HttpClient &addHeader(const std::string &key, const std::string &value) {
+        HttpRequest &addHeader(const std::string &key, const std::string &value) {
 
             this->headers[key] = value;