Added a method to perform a post form upload.

Fixed code indentation to comply with Cpplint.

Added web proxy tunneling support.

this adds support for using proxies corresponding to the CURLOPT_PROXY
and CURLOPT_HTTPPROXYTUNNEL config options in libcurl.

closes mrtazz#68

default to 10s timeout in unit tests

this makes the conn object in unit tests default to a 10s timeout in
order to fail fast if something is up with the connection or configured
hosts.

Author: embeddedmz

README.md

@@ -28,6 +28,25 @@ RestClient::Response r = RestClient::post("http://url.com/post", "text/json", "{
 RestClient::Response r = RestClient::put("http://url.com/put", "text/json", "{\"foo\": \"bla\"}")
 RestClient::Response r = RestClient::del("http://url.com/delete")
 RestClient::Response r = RestClient::head("http://url.com")
+
+// Post Form Upload
+/* Filling information about the form in a Helpers::PostFormInfo object */
+Helpers::PostFormInfo uploadInfo;
+/* "submitted" is the name of the "file" input and "TestPostForm.txt"
+is the location of the file to submit.
+<input type="file" name="submitted">
+*/
+uploadInfo.addFormFile("submitted", "TestPostForm.txt");
+/* In some rare cases, some fields related to the form can be filled with
+addFormContent(), the 1st argument is the name of the input element and
+the 2nd argument is the value assigned to it.
+<input type="text" name="filename" value=""/>
+<input type="submit" name="submit" value="send">
+*/
+uploadInfo.addFormContent("filename", "myfile.cpp");
+uploadInfo.addFormContent("submit", "send");
+/* Performing a post form upload with the information provided above */
+RestClient::Response res = RestClient::postForm("http://posttestserver.com/post.php?dir=restclientcpptests", uploadInfo);
 ```
 
 The response is of type [RestClient::Response][restclient_response] and has

include/restclient-cpp/connection.h

@@ -180,6 +180,8 @@ class Connection {
     RestClient::Response get(const std::string& uri);
     RestClient::Response post(const std::string& uri,
                               const std::string& data);
+    RestClient::Response postForm(const std::string& uri,
+                                  const Helpers::PostFormInfo& data);
     RestClient::Response put(const std::string& uri,
                              const std::string& data);
     RestClient::Response del(const std::string& uri);

include/restclient-cpp/helpers.h

@@ -9,6 +9,8 @@
 #ifndef INCLUDE_RESTCLIENT_CPP_HELPERS_H_
 #define INCLUDE_RESTCLIENT_CPP_HELPERS_H_
 
+#include <curl/curl.h>
+
 #include <string>
 #include <algorithm>
 #include <functional>
@@ -25,6 +27,24 @@ namespace RestClient {
   */
 namespace Helpers {
 
+/** @struct PostFormInfo
+  * @brief This struct represents the form information to send on
+  * POST Form requests
+  */
+struct PostFormInfo {
+  PostFormInfo();
+  ~PostFormInfo();
+  /* Fill in the file upload field */
+  void addFormFile(const std::string& fieldName,
+                   const std::string& fieldValue);
+  /* Fill in the filename or the submit field */
+  void addFormContent(const std::string& fieldName,
+                        const std::string& fieldValue);
+
+  struct curl_httppost* formPtr;
+  struct curl_httppost* lastFormPtr;
+};
+
   /** @struct UploadObject
     *  @brief This structure represents the payload to upload on POST
     *  requests

include/restclient-cpp/restclient.h

@@ -14,6 +14,7 @@
 #include <map>
 #include <cstdlib>
 
+#include "restclient-cpp/helpers.h"
 #include "restclient-cpp/version.h"
 
 /**
@@ -54,6 +55,8 @@ Response get(const std::string& url);
 Response post(const std::string& url,
               const std::string& content_type,
               const std::string& data);
+Response postForm(const std::string& url,
+                  const RestClient::Helpers::PostFormInfo& data);
 Response put(const std::string& url,
               const std::string& content_type,
               const std::string& data);

source/connection.cc

@@ -448,6 +448,26 @@ RestClient::Connection::post(const std::string& url,
 
   return this->performCurlRequest(url);
 }
+/**
+ * @brief HTTP POST Form method
+ *
+ * @param url to query
+ * @param data form info
+ *
+ * @return response struct
+ */
+RestClient::Response
+RestClient::Connection::postForm(const std::string& url,
+                             const Helpers::PostFormInfo& data) {
+  /** Now specify we want to POST data */
+  curl_easy_setopt(this->curlHandle, CURLOPT_POST, 1L);
+  /* stating that Expect: 100-continue is not wanted */
+  AppendHeader("Expect", "");
+  /** set post form */
+  curl_easy_setopt(this->curlHandle, CURLOPT_HTTPPOST, data.formPtr);
+
+  return this->performCurlRequest(url);
+}
 /**
  * @brief HTTP PUT method
  *

source/helpers.cc

@@ -36,6 +36,7 @@ size_t RestClient::Helpers::write_callback(void *data, size_t size,
  * @param size of data
  * @param nmemb memblock
  * @param userdata pointer to user data object to save headr data
+ *
  * @return size * nmemb;
  */
 size_t RestClient::Helpers::header_callback(void *data, size_t size,
@@ -88,3 +89,51 @@ size_t RestClient::Helpers::read_callback(void *data, size_t size,
   /** return copied size */
   return copy_size;
 }
+
+/**
+ * @brief PostFormInfo constructor
+ */
+RestClient::Helpers::PostFormInfo::PostFormInfo()
+        : formPtr(NULL), lastFormPtr(NULL) {
+}
+
+/**
+ * @brief PostFormInfo destructor
+ */
+RestClient::Helpers::PostFormInfo::~PostFormInfo() {
+  // cleanup the formpost chain
+  if (this->formPtr) {
+    curl_formfree(this->formPtr);
+    this->formPtr = NULL;
+    this->lastFormPtr = NULL;
+  }
+}
+
+/**
+ * @brief set the name and the value of the HTML "file" form's input
+ *
+ * @param fieldName name of the "file" input
+ * @param fieldValue path to the file to upload
+ */
+void RestClient::Helpers::PostFormInfo::addFormFile(
+          const std::string& fieldName, const std::string& fieldValue) {
+  curl_formadd(&this->formPtr, &this->lastFormPtr,
+               CURLFORM_COPYNAME, fieldName.c_str(),
+               CURLFORM_FILE, fieldValue.c_str(),
+               CURLFORM_END);
+}
+
+/**
+ * @brief set the name and the value of an HTML form's input 
+ * (other than "file" like "text", "hidden" or "submit")
+ *
+ * @param fieldName name of the input element
+ * @param fieldValue value to be assigned to the input element
+ */
+void RestClient::Helpers::PostFormInfo::addFormContent(
+          const std::string& fieldName, const std::string& fieldValue) {
+  curl_formadd(&this->formPtr, &this->lastFormPtr,
+               CURLFORM_COPYNAME, fieldName.c_str(),
+               CURLFORM_COPYCONTENTS, fieldValue.c_str(),
+               CURLFORM_END);
+}

source/restclient.cc

@@ -73,6 +73,23 @@ RestClient::Response RestClient::post(const std::string& url,
   return ret;
 }
 
+/**
+ * @brief HTTP POST Form method
+ *
+ * @param url to query
+ * @param data post form information
+ *
+ * @return response struct
+ */
+RestClient::Response RestClient::postForm(const std::string& url,
+                    const RestClient::Helpers::PostFormInfo& data) {
+  RestClient::Response ret;
+  RestClient::Connection *conn = new RestClient::Connection("");
+  ret = conn->postForm(url, data);
+  delete conn;
+  return ret;
+}
+
 /**
  * @brief HTTP PUT method
  *

test/test_connection.cc

@@ -22,6 +22,7 @@ class ConnectionTest : public ::testing::Test
     virtual void SetUp()
     {
       conn = new RestClient::Connection("https://httpbin.org");
+      conn->SetTimeout(10);
     }
 
     virtual void TearDown()

test/test_restclient.cc

@@ -1,7 +1,11 @@
 #include "restclient-cpp/restclient.h"
+#include "restclient-cpp/helpers.h"
 #include <gtest/gtest.h>
 #include <json/json.h>
+#include <cstdio>
+#include <fstream>
 #include <string>
+#include <sstream>
 
 class RestClientTest : public ::testing::Test
 {
@@ -107,6 +111,36 @@ TEST_F(RestClientTest, TestRestClientPostBody)
   EXPECT_EQ("http://httpbin.org/post", root.get("url", "no url set").asString());
   EXPECT_EQ("restclient-cpp/" RESTCLIENT_VERSION, root["headers"].get("User-Agent", "no url set").asString());
 }
+TEST_F(RestClientTest, TestRestClientPostForm)
+{
+  // generating a file name with a timestamp
+  std::ostringstream fileName;
+  time_t rawtime;
+  tm * timeinfo;
+  time(&rawtime);
+  timeinfo = localtime( &rawtime );
+  
+  fileName << "TestPostForm_" << (timeinfo->tm_year)+1900 << "_" << timeinfo->tm_mon+1
+  << "_" << timeinfo->tm_mday << "-" << timeinfo->tm_hour
+  << "_"<< timeinfo->tm_min << "_" << timeinfo->tm_sec << ".txt";
+
+  // creating a dummy file to upload via a post form request
+  std::ofstream ofDummyFile(fileName.str().c_str());
+  ASSERT_TRUE(static_cast<bool>(ofDummyFile));
+  ofDummyFile << "Dummy file for the unit test 'TestRestClientPostForm' of the restclient-cpp Project.";
+  ASSERT_TRUE(static_cast<bool>(ofDummyFile));
+  ofDummyFile.close();
+
+  // uploading the dummy file
+  RestClient::Helpers::PostFormInfo UploadInfo;
+  UploadInfo.addFormFile("submitted", fileName.str());
+  UploadInfo.addFormContent("filename", fileName.str());
+  RestClient::Response res = RestClient::postForm("http://posttestserver.com/post.php?dir=restclientcpptests", UploadInfo);
+  EXPECT_EQ(200, res.code);
+
+  // remove dummy file
+  remove(fileName.str().c_str());
+}
 // check for failure
 TEST_F(RestClientTest, TestRestClientPOSTFailureCode)
 {