Use std::optional if available.

Currently, SDK requires C++11 minimum.
So, boost::optional type is used for optional values.
For C++17 and above more convenient is to use std::optional instead.
The task NLAM-23 is about making this type configurable.
This commit is a second part of the task: olp-cpp-sdk-authentication.

Relates-To: NLAM-23
Signed-off-by: sopov <[email protected]>

Author: asopov-here

olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationClient.h

@@ -36,7 +36,7 @@
 #include <olp/authentication/Types.h>
 #include <olp/core/client/ApiResponse.h>
 #include <olp/core/client/CancellationToken.h>
-#include <boost/optional.hpp>
+#include <olp/core/porting/optional.hpp>
 
 /**
  * @brief Rules all the other namespaces.
@@ -65,15 +65,15 @@ class AUTHENTICATION_API AuthenticationClient {
     /**
      * @brief (Optional) The scope assigned to the access token.
      */
-    boost::optional<std::string> scope{boost::none};
+    porting::optional<std::string> scope{porting::none};
 
     /**
      * @brief (Optional) The device ID assigned to the access token.
      *
      * @note This field is only necessary if you want to apply a oauth rate
      * limit on a particular device.
      */
-    boost::optional<std::string> device_id{boost::none};
+    porting::optional<std::string> device_id{porting::none};
 
     /**
      * @brief (Optional) The number of seconds left before the access
@@ -89,7 +89,7 @@ class AUTHENTICATION_API AuthenticationClient {
      * requires it. Fully overrides default body and resets the request content
      * type.
      */
-    boost::optional<std::string> custom_body{boost::none};
+    porting::optional<std::string> custom_body{olp::porting::none};
   };
 
   /**

olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationCredentials.h

@@ -21,7 +21,7 @@
 
 #include <string>
 
-#include <boost/optional/optional.hpp>
+#include <olp/core/porting/optional.hpp>
 #include "AuthenticationApi.h"
 
 namespace olp {
@@ -58,7 +58,7 @@ class AUTHENTICATION_API AuthenticationCredentials {
    * @return An optional value with your credentials if the credentials were
    * read successfully, or no value in case of failure.
    */
-  static boost::optional<AuthenticationCredentials> ReadFromStream(
+  static porting::optional<AuthenticationCredentials> ReadFromStream(
       std::istream& stream);
 
   /**
@@ -81,7 +81,7 @@ class AUTHENTICATION_API AuthenticationCredentials {
    * @return The optional value with your credentials if the credentials were
    * read successfully, or no value in case of failure.
    */
-  static boost::optional<AuthenticationCredentials> ReadFromFile(
+  static porting::optional<AuthenticationCredentials> ReadFromFile(
       std::string filename = {});
   AuthenticationCredentials() = delete;
 

olp-cpp-sdk-authentication/include/olp/authentication/AuthenticationSettings.h

@@ -25,7 +25,7 @@
 #include <olp/authentication/AuthenticationApi.h>
 #include <olp/core/client/RetrySettings.h>
 #include <olp/core/http/NetworkProxySettings.h>
-#include <boost/optional.hpp>
+#include <olp/core/porting/optional.hpp>
 
 namespace olp {
 namespace http {
@@ -50,9 +50,9 @@ struct AUTHENTICATION_API AuthenticationSettings {
   /**
    * @brief The configuration settings for the network layer.
    *
-   * To remove any existing proxy settings, set to boost::none.
+   * To remove any existing proxy settings, set to olp::porting::none.
    */
-  boost::optional<http::NetworkProxySettings> network_proxy_settings{};
+  porting::optional<http::NetworkProxySettings> network_proxy_settings{};
 
   /**
    * @brief The network instance that is used to internally operate with the

olp-cpp-sdk-authentication/include/olp/authentication/AuthorizeRequest.h

@@ -19,11 +19,11 @@
 
 #pragma once
 
-#include <boost/optional.hpp>
 #include <string>
 #include <vector>
 
 #include <olp/authentication/AuthenticationApi.h>
+#include <olp/core/porting/optional.hpp>
 
 namespace olp {
 namespace authentication {
@@ -83,7 +83,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return The service ID.
    */
-  inline const std::string& GetServiceId() const { return service_id_; }
+  const std::string& GetServiceId() const { return service_id_; }
 
   /**
    * @brief Sets the service ID.
@@ -92,7 +92,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return A reference to the updated `DecisionRequest` instance.
    */
-  inline AuthorizeRequest& WithServiceId(std::string service_id) {
+  AuthorizeRequest& WithServiceId(std::string service_id) {
     service_id_ = std::move(service_id);
     return *this;
   }
@@ -109,7 +109,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return The contract ID or an error.
    */
-  inline const boost::optional<std::string>& GetContractId() const {
+  const porting::optional<std::string>& GetContractId() const {
     return contract_id_;
   }
 
@@ -122,9 +122,9 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return A reference to the updated `DecisionRequest` instance.
    */
-  inline AuthorizeRequest& WithContractId(
-      boost::optional<std::string> contract_id) {
-    contract_id_ = std::move(contract_id);
+  template <class T = porting::optional<std::string>>
+  AuthorizeRequest& WithContractId(T&& contract_id) {
+    contract_id_ = std::forward<T>(contract_id);
     return *this;
   }
 
@@ -137,7 +137,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return A reference to the updated `DecisionRequest` instance.
    */
-  inline AuthorizeRequest& WithContractId(std::string contract_id) {
+  AuthorizeRequest& WithContractId(std::string contract_id) {
     contract_id_ = std::move(contract_id);
     return *this;
   }
@@ -159,8 +159,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return A reference to the updated `DecisionRequest` instance.
    */
-  inline AuthorizeRequest& WithAction(std::string action,
-                                      std::string resource = "") {
+  AuthorizeRequest& WithAction(std::string action, std::string resource = "") {
     actions_.emplace_back(std::move(action), std::move(resource));
     return *this;
   }
@@ -174,7 +173,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return The operator type.
    */
-  inline DecisionOperatorType GetOperatorType() const { return operator_type_; }
+  DecisionOperatorType GetOperatorType() const { return operator_type_; }
 
   /**
    * @brief Sets the operator type for the request.
@@ -185,8 +184,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return A reference to the updated `DecisionRequest` instance.
    */
-  inline AuthorizeRequest& WithOperatorType(
-      DecisionOperatorType operator_type) {
+  AuthorizeRequest& WithOperatorType(DecisionOperatorType operator_type) {
     operator_type_ = operator_type;
     return *this;
   }
@@ -196,7 +194,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return The diagnostics flag.
    */
-  inline bool GetDiagnostics() const { return diagnostics_; }
+  bool GetDiagnostics() const { return diagnostics_; }
 
   /**
    * @brief Sets the diagnostics flag for the request.
@@ -206,7 +204,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
    *
    * @return A reference to the updated `DecisionRequest` instance.
    */
-  inline AuthorizeRequest& WithDiagnostics(bool diagnostics) {
+  AuthorizeRequest& WithDiagnostics(bool diagnostics) {
     diagnostics_ = diagnostics;
     return *this;
   }
@@ -220,7 +218,7 @@ class AUTHENTICATION_API AuthorizeRequest final {
 
  private:
   std::string service_id_;
-  boost::optional<std::string> contract_id_;
+  porting::optional<std::string> contract_id_;
   Actions actions_;
   DecisionOperatorType operator_type_{DecisionOperatorType::kAnd};
   bool diagnostics_{false};

olp-cpp-sdk-authentication/include/olp/authentication/Settings.h

@@ -19,12 +19,12 @@
 
 #pragma once
 
-#include <boost/optional.hpp>
 #include <memory>
 #include <string>
 
 #include <olp/core/client/RetrySettings.h>
 #include <olp/core/http/NetworkProxySettings.h>
+#include <olp/core/porting/optional.hpp>
 
 #include "AuthenticationApi.h"
 #include "AuthenticationCredentials.h"
@@ -77,7 +77,7 @@ struct AUTHENTICATION_API Settings {
   /**
    * @brief (Optional) The configuration settings for the network layer.
    */
-  boost::optional<http::NetworkProxySettings> network_proxy_settings;
+  porting::optional<http::NetworkProxySettings> network_proxy_settings;
 
   /**
    * @brief (Optional) The server URL of the token endpoint.
@@ -108,7 +108,7 @@ struct AUTHENTICATION_API Settings {
   /**
    * @brief (Optional) The scope to be assigned to an access token requests.
    */
-  boost::optional<std::string> scope;
+  porting::optional<std::string> scope;
 };
 
 }  // namespace authentication

olp-cpp-sdk-authentication/include/olp/authentication/TokenResult.h

@@ -19,7 +19,7 @@
 
 #pragma once
 
-#include <boost/optional.hpp>
+#include <olp/core/porting/optional.hpp>
 #include <chrono>
 #include <ctime>
 #include <string>
@@ -47,7 +47,7 @@ class AUTHENTICATION_API TokenResult {
    * @param scope The scope assigned to the access token.
    */
   TokenResult(std::string access_token, time_t expiry_time,
-              boost::optional<std::string> scope);
+              porting::optional<std::string> scope);
 
   /**
    * @brief Creates the `TokenResult` instance.
@@ -57,7 +57,7 @@ class AUTHENTICATION_API TokenResult {
    * @param scope The scope assigned to the access token.
    */
   TokenResult(std::string access_token, std::chrono::seconds expires_in,
-              boost::optional<std::string> scope);
+              porting::optional<std::string> scope);
   /**
    * @brief Creates the default `TokenResult` instance.
    */
@@ -92,13 +92,13 @@ class AUTHENTICATION_API TokenResult {
    * @return The optional string that contains the scope assigned to the access
    * token.
    */
-  const boost::optional<std::string>& GetScope() const;
+  const porting::optional<std::string>& GetScope() const;
 
  private:
   std::string access_token_;
   time_t expiry_time_{};
   std::chrono::seconds expires_in_{};
-  boost::optional<std::string> scope_;
+  porting::optional<std::string> scope_;
 };
 
 }  // namespace authentication

olp-cpp-sdk-authentication/src/AuthenticationClientImpl.cpp

@@ -265,24 +265,24 @@ Response<SignInResponseType> AuthenticationClientImpl::GetSignInResponse(
 }
 
 template <>
-boost::optional<SignInResult> AuthenticationClientImpl::FindInCache(
+porting::optional<SignInResult> AuthenticationClientImpl::FindInCache(
     const std::string& key) {
   return client_token_cache_->locked(
       [&](utils::LruCache<std::string, SignInResult>& cache) {
         auto it = cache.Find(key);
-        return it != cache.end() ? boost::make_optional(it->value())
-                                 : boost::none;
+        return it != cache.end() ? porting::make_optional(it->value())
+                                 : porting::none;
       });
 }
 
 template <>
-boost::optional<SignInUserResult> AuthenticationClientImpl::FindInCache(
+porting::optional<SignInUserResult> AuthenticationClientImpl::FindInCache(
     const std::string& key) {
   return user_token_cache_->locked(
       [&](utils::LruCache<std::string, SignInUserResult>& cache) {
         auto it = cache.Find(key);
-        return it != cache.end() ? boost::make_optional(it->value())
-                                 : boost::none;
+        return it != cache.end() ? porting::make_optional(it->value())
+                                 : porting::none;
       });
 }
 
@@ -325,7 +325,7 @@ client::CancellationToken AuthenticationClientImpl::SignInClient(
     // endpoint with it. Construction of the `OlpClient` requires the host part
     // of URL, while `CallAuth` method - the rest of URL, hence we need to split
     // URL passed in the Credentials object.
-    const auto credentials_endpoint = credentials.GetEndpointUrl();
+    const auto& credentials_endpoint = credentials.GetEndpointUrl();
     const auto maybe_host_and_rest =
         olp::utils::Url::ParseHostAndRest(credentials_endpoint);
     if (maybe_host_and_rest) {
@@ -338,7 +338,7 @@ client::CancellationToken AuthenticationClientImpl::SignInClient(
     // settings object.
     auto settings = settings_;
     settings.token_endpoint_url = olp_client_host;
-    auto client = CreateOlpClient(settings, boost::none, false);
+    auto client = CreateOlpClient(settings, porting::none, false);
 
     RequestTimer timer = CreateRequestTimer(client, context);
 
@@ -472,7 +472,7 @@ client::CancellationToken AuthenticationClientImpl::SignInApple(
       return client::ApiError::Cancelled();
     }
 
-    auto client = CreateOlpClient(settings_, boost::none);
+    auto client = CreateOlpClient(settings_, porting::none);
 
     auto auth_response = CallApi(client, kOauthEndpoint, context,
                                  properties.GetAccessToken(), request_body);
@@ -534,7 +534,7 @@ client::CancellationToken AuthenticationClientImpl::HandleUserRequest(
       return client::ApiError::Cancelled();
     }
 
-    auto client = CreateOlpClient(settings_, boost::none, false);
+    auto client = CreateOlpClient(settings_, porting::none, false);
 
     RequestTimer timer = CreateRequestTimer(client, context);
 
@@ -834,12 +834,12 @@ client::OlpClient::RequestBodyType AuthenticationClientImpl::GenerateClientBody(
 
   if (properties.scope) {
     writer.Key(kScope);
-    writer.String(properties.scope.get().c_str());
+    writer.String(properties.scope->c_str());
   }
 
   if (properties.device_id) {
     writer.Key(kDeviceId);
-    writer.String(properties.device_id.get().c_str());
+    writer.String(properties.device_id->c_str());
   }
 
   writer.EndObject();

olp-cpp-sdk-authentication/src/AuthenticationClientImpl.h

@@ -178,7 +178,7 @@ class AuthenticationClientImpl {
       const client::CancellationContext& context, const std::string& key);
 
   template <typename SignInResponseType>
-  boost::optional<SignInResponseType> FindInCache(const std::string& key);
+  porting::optional<SignInResponseType> FindInCache(const std::string& key);
 
   template <typename SignInResponseType>
   void StoreInCache(const std::string& key, SignInResponseType);