Remove deprecated SignInClient method. (#708)

Relates-To: OLPEDGE-1662

Signed-off-by: Mykhailo Kuchma <[email protected]>

Author: mykhailo-kuchma

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -328,33 +328,6 @@ class AUTHENTICATION_API AuthenticationClient {
   using SignOutUserCallback =
       std::function<void(const SignOutUserResponse& response)>;
 
-  /**
-   * @brief Deprecated. Use the `SignInClient` method that has the `properties`
-   * parameter.
-   *
-   * Signs in with your HERE Account client credentials. Requests the client
-   * access token. Client access tokens cannot be refreshed. Instead,
-   * request a new client access token using your client credentials.
-   *
-   * @param credentials The `AuthenticationCredentials` instance.
-   * @param callback The`SignInClientCallback` method that is called when
-   * the client sign-in request is completed. If successful, the returned HTTP
-   * status is 200. Otherwise, check the response error.
-   * @param expires_in (Optional) The number of seconds left before the access
-   * token expires. Ignored if it is zero or greater than the default expiration
-   * time supported by the application.
-   *
-   * @return The `CancellationToken` instance that can be used to cancel
-   * the equest.
-   */
-  OLP_SDK_DEPRECATED(
-      "Deprecated. Please use version with properties parameter. Will be "
-      "removed by 03.2020")
-  client::CancellationToken SignInClient(
-      const AuthenticationCredentials& credentials,
-      const SignInClientCallback& callback,
-      const std::chrono::seconds& expires_in = std::chrono::seconds(0));
-
   /**
    * @brief Signs in with your HERE Account client credentials and reuests
    * the client access token.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -1232,15 +1232,6 @@ AuthenticationClient::AuthenticationClient(AuthenticationSettings settings)
 
 AuthenticationClient::~AuthenticationClient() = default;
 
-client::CancellationToken AuthenticationClient::SignInClient(
-    const AuthenticationCredentials& credentials,
-    const SignInClientCallback& callback,
-    const std::chrono::seconds& expires_in) {
-  SignInProperties properties;
-  properties.expires_in = expires_in;
-  return impl_->SignInClient(credentials, properties, callback);
-}
-
 client::CancellationToken AuthenticationClient::SignInClient(
     AuthenticationCredentials credentials, SignInProperties properties,
     SignInClientCallback callback) {

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -37,27 +37,30 @@ constexpr auto kLogTag = "here::account::oauth2::TokenEndpoint";
 
 namespace olp {
 namespace authentication {
+
+namespace {
+AuthenticationSettings ConvertSettings(Settings settings) {
+  AuthenticationSettings auth_settings;
+  auth_settings.network_proxy_settings = settings.network_proxy_settings;
+  auth_settings.task_scheduler = settings.task_scheduler;
+  auth_settings.network_request_handler = settings.network_request_handler;
+  auth_settings.token_endpoint_url = settings.token_endpoint_url;
+  return auth_settings;
+}
+
+}  // namespace
+
 struct TokenEndpoint::Impl {
   explicit Impl(Settings settings)
-      : auth_client_(std::move(settings.token_endpoint_url)),
-        auth_credentials_(std::move(settings.credentials)) {
-    PORTING_PUSH_WARNINGS()
-    PORTING_CLANG_GCC_DISABLE_WARNING("-Wdeprecated-declarations")
-    if (settings.network_proxy_settings) {
-      auth_client_.SetNetworkProxySettings(
-          settings.network_proxy_settings.get());
-    }
-    auth_client_.SetNetwork(std::move(settings.network_request_handler));
-    auth_client_.SetTaskScheduler(std::move(settings.task_scheduler));
-    PORTING_POP_WARNINGS()
-  }
+      : auth_client_(ConvertSettings(settings)),
+        auth_credentials_(std::move(settings.credentials)) {}
 
-  PORTING_PUSH_WARNINGS()
-  PORTING_CLANG_GCC_DISABLE_WARNING("-Wdeprecated-declarations")
   client::CancellationToken RequestToken(const TokenRequest& token_request,
                                          const RequestTokenCallback& callback) {
+    AuthenticationClient::SignInProperties properties;
+    properties.expires_in = token_request.GetExpiresIn();
     return auth_client_.SignInClient(
-        auth_credentials_,
+        auth_credentials_, properties,
         [callback](
             const AuthenticationClient::SignInClientResponse& signInResponse) {
           if (signInResponse.IsSuccessful()) {
@@ -69,8 +72,7 @@ struct TokenEndpoint::Impl {
           } else {
             callback(signInResponse.GetError());
           }
-        },
-        token_request.GetExpiresIn());
+        });
   }
 
   std::future<TokenResponse> RequestToken(
@@ -132,7 +134,6 @@ AutoRefreshingToken TokenEndpoint::RequestAutoRefreshingToken(
     const TokenRequest& token_request) {
   return AutoRefreshingToken(*this, token_request);
 }
-PORTING_POP_WARNINGS()
 
 }  // namespace authentication
 }  // namespace olp

tests/functional/olp-cpp-sdk-authentication/AuthenticationClientTest.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -55,12 +55,15 @@ class AuthenticationClientTest : public AuthenticationCommonTestFixture {
       auto request_future = request.get_future();
 
       now = std::time(nullptr);
+
+      AuthenticationClient::SignInProperties props;
+      props.expires_in = std::chrono::seconds(expires_in);
+
       auto cancel_token = client_->SignInClient(
-          credentials,
+          credentials, props,
           [&](const AuthenticationClient::SignInClientResponse& resp) {
             request.set_value(resp);
-          },
-          std::chrono::seconds(expires_in));
+          });
 
       if (do_cancel) {
         cancel_token.Cancel();

tests/functional/olp-cpp-sdk-authentication/AuthenticationProductionTest.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -69,12 +69,15 @@ TEST_F(AuthenticationProductionTest, SignInClient) {
       CustomParameters::getArgument("production_service_secret"));
   std::promise<AuthenticationClient::SignInClientResponse> request;
   auto request_future = request.get_future();
+
+  AuthenticationClient::SignInProperties props_1;
+  props_1.expires_in = std::chrono::seconds(kExpiryTime);
+
   client_->SignInClient(
-      credentials,
+      credentials, props_1,
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request.set_value(response);
-      },
-      std::chrono::seconds(kExpiryTime));
+      });
 
   AuthenticationClient::SignInClientResponse response = request_future.get();
   std::time_t now = std::time(nullptr);
@@ -92,12 +95,14 @@ TEST_F(AuthenticationProductionTest, SignInClient) {
   std::promise<AuthenticationClient::SignInClientResponse> request_2;
   now = std::time(nullptr);
   auto request_future_2 = request_2.get_future();
+
+  AuthenticationClient::SignInProperties props_2;
+  props_2.expires_in = std::chrono::seconds(kExtendedExpiryTime);
   client_->SignInClient(
-      credentials,
+      credentials, props_2,
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request_2.set_value(response);
-      },
-      std::chrono::seconds(kExtendedExpiryTime));
+      });
 
   AuthenticationClient::SignInClientResponse response_2 =
       request_future_2.get();
@@ -112,12 +117,14 @@ TEST_F(AuthenticationProductionTest, SignInClient) {
   std::promise<AuthenticationClient::SignInClientResponse> request_3;
   now = std::time(nullptr);
   auto request_future_3 = request_3.get_future();
+
+  AuthenticationClient::SignInProperties props_3;
+  props_3.expires_in = std::chrono::seconds(kCustomExpiryTime);
   client_->SignInClient(
-      credentials,
+      credentials, props_3,
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request_3.set_value(response);
-      },
-      std::chrono::seconds(kCustomExpiryTime));
+      });
 
   AuthenticationClient::SignInClientResponse response_3 =
       request_future_3.get();
@@ -138,8 +145,9 @@ TEST_F(AuthenticationProductionTest, SignInClientMaxExpiration) {
   std::promise<AuthenticationClient::SignInClientResponse> request;
   auto request_future = request.get_future();
   time_t now = std::time(nullptr);
+
   client_->SignInClient(
-      credentials,
+      credentials, {},
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request.set_value(response);
       });
@@ -154,12 +162,14 @@ TEST_F(AuthenticationProductionTest, SignInClientMaxExpiration) {
   std::promise<AuthenticationClient::SignInClientResponse> request_2;
   auto request_future_2 = request_2.get_future();
   now = std::time(nullptr);
+
+  AuthenticationClient::SignInProperties props;
+  props.expires_in = std::chrono::seconds(90000);
   client_->SignInClient(
-      credentials,
+      credentials, props,
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request_2.set_value(response);
-      },
-      std::chrono::seconds(90000));
+      });
 
   AuthenticationClient::SignInClientResponse response_2 =
       request_future_2.get();
@@ -179,7 +189,7 @@ TEST_F(AuthenticationProductionTest, InvalidCredentials) {
   std::promise<AuthenticationClient::SignInClientResponse> request;
   auto request_future = request.get_future();
   client_->SignInClient(
-      credentials,
+      credentials, {},
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request.set_value(response);
       });

tests/integration/olp-cpp-sdk-authentication/AuthenticationClientTest.cpp

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019 HERE Europe B.V.
+ * Copyright (C) 2019-2020 HERE Europe B.V.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -197,7 +197,7 @@ class AuthenticationClientTest : public ::testing::Test {
         });
 
     client_->SignInClient(
-        credentials,
+        credentials, {},
         [&](const AuthenticationClient::SignInClientResponse& response) {
           request.set_value(response);
         });
@@ -355,7 +355,7 @@ TEST_F(AuthenticationClientTest, SignInClientData) {
 
   std::time_t now = std::time(nullptr);
   client_->SignInClient(
-      credentials,
+      credentials, {},
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request.set_value(response);
       });
@@ -375,7 +375,7 @@ TEST_F(AuthenticationClientTest, SignInClientData) {
   auto request_future_2 = request_2.get_future();
   std::time_t now_2 = std::time(nullptr);
   client_->SignInClient(
-      credentials,
+      credentials, {},
       [&](const AuthenticationClient::SignInClientResponse& response) {
         request_2.set_value(response);
       });