Move classes from headers to classes (#1277)

Remove deprecated warnings
Move classes to src folder
Move constants from AutoRefreshingToken to TokenProvider

Resolves: OLPEDGE-2658

Signed-off-by: Yevhenii Dudnyk <[email protected]>

Author: dudnyk

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

@@ -25,22 +25,63 @@
 #include <utility>
 
 #include <olp/authentication/AuthenticationCredentials.h>
-#include <olp/authentication/AutoRefreshingToken.h>
+#include <olp/authentication/ErrorResponse.h>
 #include <olp/authentication/Settings.h>
-#include <olp/authentication/TokenEndpoint.h>
-#include <olp/authentication/TokenResult.h>
 #include <olp/authentication/Types.h>
 #include <olp/core/client/CancellationContext.h>
 #include <olp/core/client/OauthToken.h>
 #include <olp/core/http/HttpStatusCode.h>
-#include <olp/core/utils/WarningWorkarounds.h>
 
 namespace olp {
 namespace authentication {
 
-// Needed to avoid endless warnings from TokenRequest/TokenResult
-PORTING_PUSH_WARNINGS()
-PORTING_CLANG_GCC_DISABLE_WARNING("-Wdeprecated-declarations")
+static constexpr auto kDefaultMinimumValidity = 300ll;
+static constexpr auto kDefaultMinimumValiditySeconds =
+    std::chrono::seconds(kDefaultMinimumValidity);
+static constexpr auto kForceRefresh = std::chrono::seconds(0);
+
+namespace internal {
+
+class TokenProviderPrivate;
+
+/// An implementation of `TokenProvider`.
+/// @note This is a private implementation class for internal use only, and not
+/// bound to any API stability promises. Please do not use directly.
+class TokenProviderImpl {
+ public:
+  /**
+   * @brief Creates the `TokenProviderImpl` instance.
+   *
+   * @param settings The `Settings` object that is used to customize
+   * the `TokenEndpoint` instance.
+   * @param minimum_validity Sets the minimum validity period of
+   * the token in seconds.
+   */
+  TokenProviderImpl(Settings settings, std::chrono::seconds minimum_validity);
+
+  /// @copydoc TokenProvider::operator()()
+  std::string operator()() const;
+
+  /// @copydoc TokenProvider::operator()(client::CancellationContext&)
+  client::OauthTokenResponse operator()(
+      client::CancellationContext& context) const;
+
+  /// @copydoc TokenProvider::GetErrorResponse()
+  ErrorResponse GetErrorResponse() const;
+
+  /// @copydoc TokenProvider::GetHttpStatusCode()
+  int GetHttpStatusCode() const;
+
+  /// @copydoc TokenProvider::GetResponse()(client::CancellationContext&)
+  TokenResponse GetResponse(client::CancellationContext& context) const;
+
+  /// @copydoc TokenProvider::IsTokenResponseOK()
+  bool IsTokenResponseOK() const;
+
+ private:
+  std::shared_ptr<TokenProviderPrivate> impl_;
+};
+}  // namespace internal
 
 /**
  * @brief Provides the authentication tokens if the HERE platform
@@ -62,7 +103,7 @@ class TokenProvider {
    * the `TokenEndpoint` instance.
    */
   explicit TokenProvider(Settings settings)
-      : impl_(std::make_shared<TokenProviderImpl>(
+      : impl_(std::make_shared<internal::TokenProviderImpl>(
             std::move(settings), std::chrono::seconds(MinimumValidity))) {}
 
   /// A default copy constructor.
@@ -134,79 +175,12 @@ class TokenProvider {
   int GetHttpStatusCode() const { return impl_->GetHttpStatusCode(); }
 
  private:
-  class TokenProviderImpl {
-   public:
-    explicit TokenProviderImpl(Settings settings,
-                               std::chrono::seconds minimum_validity)
-        : minimum_validity_{minimum_validity},
-          token_(
-              TokenEndpoint(std::move(settings)).RequestAutoRefreshingToken()) {
-    }
-
-    /// @copydoc TokenProvider::operator()()
-    std::string operator()() const {
-      client::CancellationContext context;
-      const auto response = GetResponse(context);
-      return response ? response.GetResult().GetAccessToken() : "";
-    }
-
-    /// @copydoc TokenProvider::operator()(client::CancellationContext&)
-    client::OauthTokenResponse operator()(
-        client::CancellationContext& context) const {
-      const auto response = GetResponse(context);
-      return response ? client::OauthTokenResponse(
-                            {response.GetResult().GetAccessToken(),
-                             response.GetResult().GetExpiryTime()})
-                      : client::OauthTokenResponse(response.GetError());
-    }
-
-    /// @copydoc TokenProvider::GetErrorResponse()
-    ErrorResponse GetErrorResponse() const {
-      client::CancellationContext context;
-      const auto response = GetResponse(context);
-      return response ? response.GetResult().GetErrorResponse()
-                      : ErrorResponse{};
-    }
-
-    /// @copydoc TokenProvider::GetHttpStatusCode()
-    int GetHttpStatusCode() const {
-      client::CancellationContext context;
-      const auto response = GetResponse(context);
-      return response ? response.GetResult().GetHttpStatus()
-                      : response.GetError().GetHttpStatusCode();
-    }
-
-    /// Gets the token response from `AutoRefreshingToken` or requests a new
-    /// token if the token response expired or is not present.
-    TokenResponse GetResponse(client::CancellationContext& context) const {
-      // Mutex is needed to prevent multiple authorization requests that can
-      // happen when the token is not available, and multiple consumers
-      // requested it.
-      std::lock_guard<std::mutex> lock(request_mutex_);
-      return token_.GetToken(context, minimum_validity_);
-    }
-
-    /// Checks whether the available token response is valid.
-    bool IsTokenResponseOK() const {
-      client::CancellationContext context;
-
-      // Token response is successful if and only if we have a valid token.
-      return GetResponse(context).IsSuccessful();
-    }
-
-   private:
-    std::chrono::seconds minimum_validity_{kDefaultMinimumValidity};
-    AutoRefreshingToken token_;
-    mutable std::mutex request_mutex_;
-  };
-
-  std::shared_ptr<TokenProviderImpl> impl_;
+  std::shared_ptr<internal::TokenProviderImpl> impl_;
 };
 
 /// Provides the authentication tokens using the default minimum token
 /// validity.
 using TokenProviderDefault = TokenProvider<kDefaultMinimumValidity>;
 
-PORTING_POP_WARNINGS()
 }  // namespace authentication
 }  // namespace olp

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

@@ -17,15 +17,15 @@
  * License-Filename: LICENSE
  */
 
-#include "olp/authentication/AutoRefreshingToken.h"
+#include "AutoRefreshingToken.h"
 
 #include <chrono>
 #include <iostream>
 
-#include "olp/authentication/TokenEndpoint.h"
-#include "olp/core/client/CancellationToken.h"
-#include "olp/core/logging/Log.h"
-#include "olp/core/porting/warning_disable.h"
+#include <olp/core/client/CancellationToken.h>
+#include <olp/core/logging/Log.h>
+#include "TokenEndpoint.h"
+#include "TokenRequest.h"
 
 namespace {
 constexpr auto kLogTag = "authentication::AutoRefreshingToken";
@@ -47,8 +47,6 @@ std::chrono::steady_clock::time_point ComputeRefreshTime(
 
 namespace olp {
 namespace authentication {
-PORTING_PUSH_WARNINGS()
-PORTING_CLANG_GCC_DISABLE_WARNING("-Wdeprecated-declarations")
 
 struct AutoRefreshingToken::Impl {
   Impl(TokenEndpoint token_endpoint, TokenRequest token_request)
@@ -207,7 +205,6 @@ client::CancellationToken AutoRefreshingToken::GetToken(
     const std::chrono::seconds& minimum_validity) const {
   return impl_->GetToken(callback, minimum_validity);
 }
-PORTING_POP_WARNINGS()
 
 }  // namespace authentication
 }  // namespace olp

…olp/authentication/AutoRefreshingToken.h …authentication/src/AutoRefreshingToken.holp-cpp-sdk-authentication/include/olp/authentication/AutoRefreshingToken.h renamed to olp-cpp-sdk-authentication/src/AutoRefreshingToken.h olp-cpp-sdk-authentication/include/olp/authentication/AutoRefreshingToken.h renamed to olp-cpp-sdk-authentication/src/AutoRefreshingToken.h

@@ -23,36 +23,22 @@
 #include <functional>
 #include <memory>
 
-#include "AuthenticationApi.h"
+#include <olp/authentication/AuthenticationApi.h>
+#include <olp/core/client/CancellationContext.h>
+#include <olp/core/client/CancellationToken.h>
 #include "TokenEndpoint.h"
-#include "TokenRequest.h"
-#include "TokenResult.h"
-
-#include "olp/core/client/CancellationContext.h"
-#include "olp/core/client/CancellationToken.h"
-#include "olp/core/porting/warning_disable.h"
 
 namespace olp {
 namespace authentication {
 
-static constexpr auto kDefaultMinimumValidity = 300ll;
-static constexpr auto kDefaultMinimumValiditySeconds =
-    std::chrono::seconds(kDefaultMinimumValidity);
-static constexpr auto kForceRefresh = std::chrono::seconds(0);
-
 /**
  * @brief Manages token requests.
  *
  * Requests a new token from the token endpoint and automatically refreshes it
  * when the token is about to expire.
  */
-class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed by 10.2020.")
-    AutoRefreshingToken {
+class AutoRefreshingToken {
  public:
-  // Needed to avoid endless warnings from TokenRequest/TokenResult
-  PORTING_PUSH_WARNINGS()
-  PORTING_CLANG_GCC_DISABLE_WARNING("-Wdeprecated-declarations")
-
   /**
    * @brief Specifies the callback signature that is required
    * when the get token request is completed.
@@ -79,8 +65,7 @@ class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed by 10.2020.")
    * Otherwise, returns the cached `TokenResponse` instance.
    */
   TokenResponse GetToken(client::CancellationToken& cancellation_token,
-                         const std::chrono::seconds& minimum_validity =
-                             kDefaultMinimumValiditySeconds) const;
+                         const std::chrono::seconds& minimum_validity) const;
 
   /**
    * @brief Synchronously gets a token that is always fresh.
@@ -101,8 +86,7 @@ class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed by 10.2020.")
    * Otherwise, returns the cached `TokenResponse` instance.
    */
   TokenResponse GetToken(client::CancellationContext& context,
-                         const std::chrono::seconds& minimum_validity =
-                             kDefaultMinimumValiditySeconds) const;
+                         const std::chrono::seconds& minimum_validity) const;
 
   /**
    * @brief Synchronously gets a token that is always fresh.
@@ -121,8 +105,7 @@ class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed by 10.2020.")
    * @return The `TokenResponse` instance if the old one is expired.
    * Otherwise, the cached `TokenResponse` instance.
    */
-  TokenResponse GetToken(const std::chrono::seconds& minimum_validity =
-                             kDefaultMinimumValiditySeconds) const;
+  TokenResponse GetToken(const std::chrono::seconds& minimum_validity) const;
 
   /**
    * @brief Asynchronously gets a token that is always fresh.
@@ -141,8 +124,7 @@ class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed by 10.2020.")
    */
   client::CancellationToken GetToken(
       const GetTokenCallback& callback,
-      const std::chrono::seconds& minimum_validity =
-          kDefaultMinimumValiditySeconds) const;
+      const std::chrono::seconds& minimum_validity) const;
 
   /**
    * @brief Creates the `AutoRefreshingToken` instance.
@@ -153,8 +135,6 @@ class AUTHENTICATION_API OLP_SDK_DEPRECATED("Will be removed by 10.2020.")
    */
   AutoRefreshingToken(TokenEndpoint token_endpoint, TokenRequest token_request);
 
-  PORTING_POP_WARNINGS()
-
  private:
   struct Impl;
   std::shared_ptr<Impl> impl_;

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

@@ -17,15 +17,13 @@
  * License-Filename: LICENSE
  */
 
-#include <olp/authentication/TokenEndpoint.h>
-
-PORTING_PUSH_WARNINGS()
-PORTING_CLANG_GCC_DISABLE_WARNING("-Wdeprecated-declarations")
+#include "TokenEndpoint.h"
 
 #include <olp/authentication/AuthenticationClient.h>
-#include <olp/authentication/AutoRefreshingToken.h>
 #include <olp/core/logging/Log.h>
+#include "AutoRefreshingToken.h"
 #include "TokenEndpointImpl.h"
+#include "TokenRequest.h"
 
 namespace olp {
 namespace authentication {
@@ -82,6 +80,5 @@ AutoRefreshingToken TokenEndpoint::RequestAutoRefreshingToken(
   return AutoRefreshingToken(*this, token_request);
 }
 
-PORTING_POP_WARNINGS()
 }  // namespace authentication
 }  // namespace olp