Merge pull request #1173 from simue/feature/delete-header

Getter function for Session::header_ to enable the user to read back all headers set and delete select ones

Author: COM8

CONTRIBUTING.md

@@ -1,10 +1,10 @@
 # Contributing to C++ Requests
 
-Please fork this repository and contribute back using [pull requests](https://github.com/whoshuu/cpr/pulls). Features can be requested using [issues](https://github.com/whoshuu/cpr/issues). All code, comments, and critiques are greatly appreciated.
+Please fork this repository and contribute back using [pull requests](https://github.com/libcpr/cpr/pulls). Features can be requested using [issues](https://github.com/libcpr/cpr/issues). All code, comments, and critiques are greatly appreciated.
 
 ## Formatting
 
-To avoid unproductive debates on formatting, this project uses `clang-format` to ensure a consistent style across all source files. Currently, `clang-format` 3.8 is the version of `clang-format` we use. The format file can be found [here](https://github.com/whoshuu/cpr/blob/master/.clang-format). To install `clang-format` on Ubuntu, run this:
+To avoid unproductive debates on formatting, this project uses `clang-format` to ensure a consistent style across all source files. Currently, `clang-format` 3.8 is the version of `clang-format` we use. The format file can be found [here](https://github.com/libcpr/cpr/blob/master/.clang-format). To install `clang-format` on Ubuntu, run this:
 
 ```
 apt-get install clang-format-3.8
@@ -21,7 +21,7 @@ Note that `brew` might install a later version of `clang-format`, but it should
 To run `clang-format` on every source file, run this in the root directory:
 
 ```
-./format-check.sh
+./scripts/run_clang_format.sh cpr include/cpr
 ```
 
 This should indicate which files need formatting and also show a diff of the requested changes. More specific usage instructions can be found on the official [LLVM website](http://releases.llvm.org/3.8.0/tools/clang/docs/ClangFormat.html).

cpr/error.cpp

@@ -1,11 +1,12 @@
 #include "cpr/error.h"
-#include <curl/curlver.h>
-#include <unordered_map>
 #include <cstdint>
 #include <curl/curl.h>
+#include <curl/curlver.h>
+#include <unordered_map>
 
 namespace cpr {
-static const std::unordered_map<std::int32_t, ErrorCode> curl_error_map = { // NOLINT - (needed because of static init)
+// NOLINTNEXTLINE - (needed because of static init)
+static const std::unordered_map<std::int32_t, ErrorCode> curl_error_map = {
         {CURLE_OK, ErrorCode::OK},
         {CURLE_UNSUPPORTED_PROTOCOL, ErrorCode::UNSUPPORTED_PROTOCOL},
         {CURLE_FAILED_INIT, ErrorCode::FAILED_INIT},

cpr/session.cpp

@@ -349,6 +349,14 @@ void Session::UpdateHeader(const Header& header) {
     }
 }
 
+Header& Session::GetHeader() {
+    return header_;
+}
+
+const Header& Session::GetHeader() const {
+    return header_;
+}
+
 void Session::SetTimeout(const Timeout& timeout) {
     curl_easy_setopt(curl_->handle, CURLOPT_TIMEOUT_MS, timeout.Milliseconds());
 }

include/cpr/async_wrapper.h

@@ -8,7 +8,7 @@
 #include "cpr/response.h"
 
 namespace cpr {
-enum class [[nodiscard]] CancellationResult { failure, success, invalid_operation };
+enum class [[nodiscard]] CancellationResult{failure, success, invalid_operation};
 
 /**
  * A class template intended to wrap results of async operations (instances of std::future<T>)

include/cpr/session.h

@@ -66,6 +66,8 @@ class Session : public std::enable_shared_from_this<Session> {
     void SetParameters(Parameters&& parameters);
     void SetHeader(const Header& header);
     void UpdateHeader(const Header& header);
+    [[nodiscard]] Header& GetHeader();
+    [[nodiscard]] const Header& GetHeader() const;
     void SetTimeout(const Timeout& timeout);
     void SetConnectTimeout(const ConnectTimeout& timeout);
     void SetAuth(const Authentication& auth);

include/cpr/timeout.h

@@ -11,8 +11,7 @@ class Timeout {
     // Template constructor to accept any chrono duration type and convert it to milliseconds
     // NOLINTNEXTLINE(google-explicit-constructor, hicpp-explicit-conversions)
     template <typename Rep, typename Period>
-    Timeout(const std::chrono::duration<Rep, Period>& duration)
-            : ms{std::chrono::duration_cast<std::chrono::milliseconds>(duration)} {}
+    Timeout(const std::chrono::duration<Rep, Period>& duration) : ms{std::chrono::duration_cast<std::chrono::milliseconds>(duration)} {}
 
     // NOLINTNEXTLINE(google-explicit-constructor, hicpp-explicit-conversions)
     Timeout(const std::int32_t& milliseconds) : Timeout{std::chrono::milliseconds(milliseconds)} {}

test/session_tests.cpp

@@ -262,14 +262,27 @@ TEST(MultipleGetTests, HeaderChangeMultipleGetTest) {
         EXPECT_EQ(200, response.status_code);
         EXPECT_EQ(ErrorCode::OK, response.error.code);
     }
-    session.SetHeader(Header{{"key", "value"}});
+    session.SetHeader(Header{{"key", "value"}, {"lorem", "ipsum"}});
     {
         Response response = session.Get();
         std::string expected_text{"Header reflect GET"};
         EXPECT_EQ(expected_text, response.text);
         EXPECT_EQ(url, response.url);
         EXPECT_EQ(std::string{"text/html"}, response.header["content-type"]);
         EXPECT_EQ(std::string{"value"}, response.header["key"]);
+        EXPECT_EQ(std::string{"ipsum"}, response.header["lorem"]);
+        EXPECT_EQ(200, response.status_code);
+        EXPECT_EQ(ErrorCode::OK, response.error.code);
+    }
+    Header& headerMap = session.GetHeader();
+    headerMap.erase("key");
+    {
+        Response response = session.Get();
+        std::string expected_text{"Header reflect GET"};
+        EXPECT_EQ(expected_text, response.text);
+        EXPECT_EQ(url, response.url);
+        EXPECT_EQ(std::string{"text/html"}, response.header["content-type"]);
+        EXPECT_EQ(std::string{"ipsum"}, response.header["lorem"]);
         EXPECT_EQ(200, response.status_code);
         EXPECT_EQ(ErrorCode::OK, response.error.code);
     }