Add device_id field to SignInProperties (#1329)

Add device_id property to the SignInProperties for implementing
rate limiting by device functionality.

Relates-To: OLPEDGE-2745

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

Author: dudnyk

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2020 HERE Europe B.V.
+ * Copyright (C) 2019-2022 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.
@@ -51,7 +51,8 @@ namespace authentication {
 class AuthenticationClientImpl;
 
 /**
- * @brief Provides programmatic access to the HERE Account Authentication Service.
+ * @brief Provides programmatic access to the HERE Account Authentication
+ * Service.
  *
  * The supported APIs mirror the REST APIs currently available for the HERE
  * Account Authentication Service.
@@ -67,6 +68,14 @@ class AUTHENTICATION_API AuthenticationClient {
      */
     boost::optional<std::string> scope{boost::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};
+
     /**
      * @brief (Optional) The number of seconds left before the access
      * token expires.

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2020-2021 HERE Europe B.V.
+ * Copyright (C) 2020-2022 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.
@@ -68,6 +68,7 @@ constexpr auto kEmail = "email";
 constexpr auto kFirstName = "firstname";
 constexpr auto kGrantType = "grantType";
 constexpr auto kScope = "scope";
+constexpr auto kDeviceId = "deviceId";
 constexpr auto kInviteToken = "inviteToken";
 constexpr auto kLanguage = "language";
 constexpr auto kLastName = "lastname";
@@ -792,6 +793,12 @@ client::OlpClient::RequestBodyType AuthenticationClientImpl::GenerateClientBody(
     writer.Key(kScope);
     writer.String(properties.scope.get().c_str());
   }
+
+  if (properties.device_id) {
+    writer.Key(kDeviceId);
+    writer.String(properties.device_id.get().c_str());
+  }
+
   writer.EndObject();
   auto content = data.GetString();
   return std::make_shared<RequestBodyData>(content, content + data.GetSize());

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

@@ -1,5 +1,5 @@
 /*
- * Copyright (C) 2019-2021 HERE Europe B.V.
+ * Copyright (C) 2019-2022 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.
@@ -2310,3 +2310,42 @@ TEST_F(AuthenticationClientTest, Timeout) {
     testing::Mock::VerifyAndClearExpectations(network_.get());
   }
 }
+
+TEST_F(AuthenticationClientTest, SignInWithDevice) {
+  auth::AuthenticationSettings settings;
+  settings.network_request_handler = network_;
+  settings.token_endpoint_url = kTokenEndpointUrl;
+  settings.task_scheduler =
+      client::OlpClientSettingsFactory::CreateDefaultTaskScheduler();
+
+  std::string body =
+      R"({"grantType":"client_credentials","deviceId":"my-device-1"})";
+
+  EXPECT_CALL(*network_,
+              Send(testing::AllOf(HeadersContainAuthorization(), BodyEq(body),
+                                  IsPostRequest(kRequestAuth)),
+                   _, _, _, _))
+      .WillOnce(ReturnHttpResponse(
+          GetResponse(http::HttpStatusCode::OK).WithError(kErrorOk),
+          std::string()));
+
+  std::promise<void> request;
+  auth::AuthenticationClient::SignInClientResponse response;
+  auth::AuthenticationClient::SignInProperties properties;
+  properties.device_id = "my-device-1";
+
+  auto client =
+      std::make_unique<auth::AuthenticationClient>(std::move(settings));
+
+  client->SignInClient(
+      auth::AuthenticationCredentials(key_, secret_), properties,
+      [&](const auth::AuthenticationClient::SignInClientResponse& value) {
+        response = value;
+        request.set_value();
+      });
+
+  request.get_future().wait();
+  EXPECT_TRUE(response.IsSuccessful());
+
+  ::testing::Mock::VerifyAndClearExpectations(network_.get());
+}