toCurlCommand method has been added

Author: leventkaragol

README.md

@@ -28,6 +28,7 @@ Modern, non-blocking and exception free HTTP Client library for C++ (17+)
 * [How to set timeout?](#how-to-set-timeout)
 * [Setting the User Agent](#setting-the-user-agent)
 * [How can I limit download and upload bandwidth?](#how-can-i-limit-download-and-upload-bandwidth)
+* [How do I get the request as a curl command?](#how-do-i-get-the-request-as-a-curl-command)
 * [Semantic Versioning](#semantic-versioning)
 * [Full function list](#full-function-list)
 * [License](#license)
@@ -488,6 +489,35 @@ int main() {
 ```
 
 
+## How do I get the request as a curl command?
+
+If you want to receive the request as a curl command, you can call the toCurlCommand method after making the necessary preparations.
+
+```cpp
+#include <fstream>
+#include "libcpp-http-client.hpp"
+
+using namespace lklibs;
+
+int main() {
+    HttpRequest httpRequest("https://api.myproject.com");
+    
+    auto response = httpRequest
+                    .setMethod(HttpMethod::POST)
+                    .setPayload(R"({"param1": 7, "param2": "test"})")
+                    .addHeader("Content-Type", "application/json")
+                    .setTimeout(3)
+                    .setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36 Edg/124.0.0.0")
+                    .setDownloadBandwidthLimit(10240)
+                    .setUploadBandwidthLimit(20480);
+                    
+    std::string curlCommand = response.toCurlCommand();
+    
+    return 0;
+}
+```
+
+
 ## Semantic Versioning
 
 Versioning of the library is done using conventional semantic versioning. Accordingly, 

examples/main.cpp

@@ -248,6 +248,22 @@ void setDownloadAndUploadBandwidthLimit()
     std::cout << "Data: " << response.textData << std::endl;
 }
 
+void getCurlCommand()
+{
+    HttpRequest httpRequest("https://httpbun.com/post");
+
+    auto response = httpRequest
+                    .setMethod(HttpMethod::POST)
+                    .setPayload(R"({"param1": 7, "param2": "test"})")
+                    .addHeader("Content-Type", "application/json")
+                    .setTimeout(3)
+                    .setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36 Edg/124.0.0.0")
+                    .setDownloadBandwidthLimit(10240)
+                    .setUploadBandwidthLimit(20480);
+
+    // You can convert the request to a cURL command string with toCurlCommand method
+    std::cout << "Curl Command: " << response.toCurlCommand() << std::endl;
+}
 
 int main()
 {
@@ -281,5 +297,7 @@ int main()
 
     setDownloadAndUploadBandwidthLimit();
 
+    getCurlCommand();
+
     return 0;
 }

src/libcpp-http-client.hpp

@@ -1,7 +1,7 @@
 /*
 
 Modern, non-blocking and exception free HTTP Client library for C++ (17+)
-version 1.3.1
+version 1.4.0
 https://github.com/leventkaragol/libcpp-http-client
 
 If you encounter any issues, please submit a ticket at https://github.com/leventkaragol/libcpp-http-client/issues
@@ -38,7 +38,7 @@ SOFTWARE.
 #include <map>
 #include <memory>
 #include <mutex>
-#include <cstdlib>
+#include <sstream>
 #include <curl/curl.h>
 
 namespace lklibs
@@ -76,7 +76,7 @@ namespace lklibs
 
         HttpResult() = default;
 
-        HttpResult(bool succeed, std::string textData, std::vector<unsigned char> binaryData, int statusCode, std::string errorMessage)
+        HttpResult(const bool succeed, std::string textData, std::vector<unsigned char> binaryData, const int statusCode, std::string errorMessage)
             : succeed(succeed), textData(std::move(textData)), binaryData(std::move(binaryData)), statusCode(statusCode), errorMessage(std::move(errorMessage))
         {
         }
@@ -303,6 +303,55 @@ namespace lklibs
             return *this;
         }
 
+        /**
+         * @brief Convert the request to a cURL command string
+         * This can be useful for debugging or logging purposes
+         *
+         * @return cURL command string representing the request
+         */
+        [[nodiscard]] std::string toCurlCommand() const noexcept
+        {
+            std::ostringstream cmd;
+
+            cmd << "curl";
+
+            cmd << " -X " << method;
+
+            for (const auto& header : headers)
+            {
+                cmd << " -H \"" << header.first << ": " << header.second << "\"";
+            }
+
+            if (!userAgent.empty())
+            {
+                cmd << " -A \"" << userAgent << "\"";
+            }
+
+            if (timeout > 0)
+            {
+                cmd << " --max-time " << timeout;
+            }
+
+            if (sslErrorsWillBeIgnored)
+            {
+                cmd << " -k";
+            }
+
+            if (downloadBandwidthLimit > 0)
+            {
+                cmd << " --limit-rate " << downloadBandwidthLimit;
+            }
+
+            if (!payload.empty())
+            {
+                cmd << " --data '" << escapeSingleQuotes(payload) << "'";
+            }
+
+            cmd << " \"" << url << "\"";
+
+            return cmd.str();
+        }
+
         /**
          * @brief Send the HTTP request and return the result as a future
          * The result can be obtained by calling the get() method of the future
@@ -458,6 +507,25 @@ namespace lklibs
 
             return size * nmemb;
         }
+
+        static std::string escapeSingleQuotes(const std::string& input)
+        {
+            std::string output;
+
+            for (const char c : input)
+            {
+                if (c == '\'')
+                {
+                    output += "'\\''";
+                }
+                else
+                {
+                    output += c;
+                }
+            }
+
+            return output;
+        }
     };
 }
 

test/test.cpp

@@ -105,7 +105,7 @@ TEST(HttpGetTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpGetRequestMade
 
 TEST(HttpGetTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpGetRequestForAnotherError)
 {
-    HttpRequest httpRequest("https://httpbun.com/bearer");
+    HttpRequest httpRequest("https://httpbun.com/bearer/123");
 
     auto response = httpRequest.send().get();
 
@@ -246,7 +246,7 @@ TEST(HttpPostTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpPostRequestMa
 
 TEST(HttpPostTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpPostRequestForAnotherError)
 {
-    HttpRequest httpRequest("https://httpbun.com/bearer");
+    HttpRequest httpRequest("https://httpbun.com/bearer/123");
 
     auto response = httpRequest
                     .setMethod(HttpMethod::POST)
@@ -393,7 +393,7 @@ TEST(HttpPutTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpPutRequestMade
 
 TEST(HttpPutTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpPutRequestForAnotherError)
 {
-    HttpRequest httpRequest("https://httpbun.com/bearer");
+    HttpRequest httpRequest("https://httpbun.com/bearer/123");
 
     auto response = httpRequest
                     .setMethod(HttpMethod::PUT)
@@ -540,7 +540,7 @@ TEST(HttpDeleteTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpDeleteReque
 
 TEST(HttpDeleteTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpDeleteRequestForAnotherError)
 {
-    HttpRequest httpRequest("https://httpbun.com/bearer");
+    HttpRequest httpRequest("https://httpbun.com/bearer/123");
 
     auto response = httpRequest
                     .setMethod(HttpMethod::DELETE_)
@@ -685,7 +685,7 @@ TEST(HttpPatchTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpPatchRequest
 
 TEST(HttpPatchTest, AnErrorMessageShouldBeReturnedInResponseToAnHttpPatchRequestForAnotherError)
 {
-    HttpRequest httpRequest("https://httpbun.com/bearer");
+    HttpRequest httpRequest("https://httpbun.com/bearer/123");
 
     auto response = httpRequest.setMethod(HttpMethod::PATCH).send().get();
 
@@ -825,6 +825,22 @@ TEST(BandwidthLimitTest, UploadBandwidthLimitCanBeSet)
     ASSERT_TRUE(response.errorMessage.empty()) << "HTTP Error Message is not empty";
 }
 
+TEST(CurlCommandTest, CurlCommandCanBeGet)
+{
+    HttpRequest httpRequest("https://httpbun.com/post");
+
+    auto response = httpRequest
+                    .setMethod(HttpMethod::POST)
+                    .setPayload(R"({"param1": 7, "param2": "test"})")
+                    .addHeader("Content-Type", "application/json")
+                    .setTimeout(3)
+                    .setUserAgent("Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36 Edg/124.0.0.0")
+                    .setDownloadBandwidthLimit(10240)
+                    .setUploadBandwidthLimit(20480);
+
+    ASSERT_EQ(response.toCurlCommand(), "curl -X POST -H \"Content-Type: application/json\" -A \"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/124.0.0.0 Safari/537.36 Edg/124.0.0.0\" --max-time 3 --limit-rate 10240 --data '{\"param1\": 7, \"param2\": \"test\"}' \"https://httpbun.com/post\"") << "Curl command is invalid";
+}
+
 int main(int argc, char** argv)
 {
     testing::InitGoogleTest(&argc, argv);

vcpkg.json

@@ -4,12 +4,12 @@
   "builtin-baseline" : "0719a71389654b88d827501d88e37e58ea8cbd70",
   "dependencies" : [ {
     "name" : "gtest",
-    "version>=" : "1.14.0"
+    "version>=" : "1.17.0#1"
   }, {
     "name" : "nlohmann-json",
-    "version>=" : "3.11.3"
+    "version>=" : "3.12.0"
   }, {
     "name" : "curl",
-    "version>=" : "8.7.1#3"
+    "version>=" : "8.15.0"
   } ]
 }