Fix incorrect authenticate function signature.

Author: RicardRC

Satori/Source/SatoriBlueprints/Private/SatoriClientRequests.cpp

@@ -1,24 +1,24 @@
 #include "SatoriClientRequests.h"
 #include "SatoriUtils.h"
 
-USatoriClientAuthenticateCustom* USatoriClientAuthenticateCustom::AuthenticateCustom(
-	USatoriClient* Client, 
-	const FString& UserID,
-	const FString& Username,
-	bool CreateAccount, 
-	const TMap<FString, FString>& Vars)
+USatoriClientAuthenticate* USatoriClientAuthenticate::Authenticate(
+	USatoriClient* Client,
+	const FString& ID,
+	const TMap<FString, FString>& DefaultProperties,
+	const TMap<FString, FString>& CustomProperties,
+	const bool bNoSession)
 {
-	USatoriClientAuthenticateCustom* Node = NewObject<USatoriClientAuthenticateCustom>();
+	USatoriClientAuthenticate* Node = NewObject<USatoriClientAuthenticate>();
 	Node->SatoriClient = Client;
-	Node->UserID = UserID;
-	Node->Username = Username;
-	Node->bCreateAccount = CreateAccount;
-	Node->Vars = Vars;
+	Node->ID = ID;
+	Node->DefaultProperties = DefaultProperties;
+	Node->CustomProperties = CustomProperties;
+	Node->bNoSession = bNoSession;
 
 	return Node;
 }
 
-void USatoriClientAuthenticateCustom::Activate()
+void USatoriClientAuthenticate::Activate()
 {
 	if (!SatoriClient)
 	{
@@ -52,7 +52,7 @@ void USatoriClientAuthenticateCustom::Activate()
 			SetReadyToDestroy();
 		};
 
-	SatoriClient->AuthenticateCustom(UserID, Username, bCreateAccount, Vars, successCallback, errorCallback);
+	SatoriClient->Authenticate(ID, DefaultProperties, CustomProperties, bNoSession, successCallback, errorCallback);
 }
 
 USatoriClientAuthenticateRefresh* USatoriClientAuthenticateRefresh::AuthenticateRefresh(USatoriClient* Client, USatoriSession* Session)

Satori/Source/SatoriBlueprints/Public/SatoriClientRequests.h

@@ -10,7 +10,7 @@
 #include "SatoriClientRequests.generated.h"
 
 // Delegates
-DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSatoriAuthenticateCustom, USatoriSession*, Session, FSatoriError, Error);
+DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSatoriAuthenticate, USatoriSession*, Session, FSatoriError, Error);
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSatoriAuthenticateRefresh, USatoriSession*, Session, FSatoriError, Error);
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnSatoriAuthenticateLogout, FSatoriError, Error);
 DECLARE_DYNAMIC_MULTICAST_DELEGATE_TwoParams(FOnSatoriIdentify, USatoriSession*, Session, FSatoriError, Error);
@@ -37,7 +37,7 @@ DECLARE_DYNAMIC_MULTICAST_DELEGATE_OneParam(FOnSatoriDeleteMessage, FSatoriError
  */
 
 UCLASS()
-class SATORIBLUEPRINTS_API USatoriClientAuthenticateCustom : public UBlueprintAsyncActionBase
+class SATORIBLUEPRINTS_API USatoriClientAuthenticate : public UBlueprintAsyncActionBase
 {
 	GENERATED_BODY()
 
@@ -47,36 +47,36 @@ class SATORIBLUEPRINTS_API USatoriClientAuthenticateCustom : public UBlueprintAs
 	TObjectPtr<USatoriClient> SatoriClient;
 
 	UPROPERTY(BlueprintAssignable)
-	FOnSatoriAuthenticateCustom OnSuccess;
+	FOnSatoriAuthenticate OnSuccess;
 
 	UPROPERTY(BlueprintAssignable)
-	FOnSatoriAuthenticateCustom OnError;
+	FOnSatoriAuthenticate OnError;
 
 	/**
-	 * Authenticate a user with a custom id.
-	 * @param Client The Client to use.
-	 * @param UserID A custom identifier usually obtained from an external authentication service.
-	 * @param Username A username used to create the user.
-	 * @param CreateAccount True if the user should be created when authenticated.
-	 * @param Vars Extra information that will be bundled in the session token.
+	 * Authenticate to get a satori session.
+	 * @param ID Must be between eight and 128 characters (inclusive). Must be an alphanumeric string with only underscores and hyphens allowed.
+	 * @param DefaultProperties Optional default properties to update with this call. If not set, properties are left as they are on the server.
+	 * @param CustomProperties Optional custom properties to update with this call. If not set, properties are left as they are on the server.
+	 * @param bNoSession Modifies the request to only create/update an identity without creating a new session. If set to 'true' the response won't include a token and a refresh token.
+	 * @param Success Delegate called upon successful authentication, providing the user session.
+	 * @param Error Delegate called on authentication failure with error details.
 	 */
 	UFUNCTION(BlueprintCallable, Category = "Satori|Authentication", meta = (BlueprintInternalUseOnly = "true", AutoCreateRefTerm = "Vars"))
-	static USatoriClientAuthenticateCustom* AuthenticateCustom(
+	static USatoriClientAuthenticate* Authenticate(
 		USatoriClient *Client,
-		const FString& UserID,
-		const FString& Username,
-		bool CreateAccount,
-		const TMap<FString, FString>& Vars);
+		const FString& ID,
+		const TMap<FString, FString>& DefaultProperties,
+		const TMap<FString, FString>& CustomProperties,
+		const bool bNoSession);
 
 	virtual void Activate() override;
 
 private:
 
-	FString UserID;
-	FString Username;
-	bool bCreateAccount;
-	TMap<FString, FString> Vars;
-
+	FString ID;
+	TMap<FString, FString> DefaultProperties;
+	TMap<FString, FString> CustomProperties;
+	bool bNoSession;
 };
 
 

Satori/Source/SatoriUnreal/Private/SatoriClient.cpp

@@ -100,11 +100,11 @@ USatoriClient* USatoriClient::CreateDefaultClient(
 	return NewClient;
 }
 
-void USatoriClient::AuthenticateCustom(
-	const FString& UserID,
-	const FString& Username,
-	bool CreateAccount, 
-	const TMap<FString, FString>& Vars,
+void USatoriClient::Authenticate(
+	const FString& ID,
+	const TMap<FString, FString>& DefaultProperties,
+	const TMap<FString, FString>& CustomProperties,
+	const bool bNoSession,
 	FOnSatoriAuthUpdate Success,
 	FOnSatoriError Error)
 {
@@ -127,29 +127,39 @@ void USatoriClient::AuthenticateCustom(
 	// A custom identifier must contain alphanumeric
 	// characters with dashesand be between 6 and 128 bytes.
 
-	AuthenticateCustom(UserID, Username, CreateAccount, Vars, successCallback, errorCallback);
+	Authenticate(ID, DefaultProperties, CustomProperties, bNoSession, successCallback, errorCallback);
 }
 
-void USatoriClient::AuthenticateCustom(
-	const FString& CustomId,
-	const FString& Username,
-	bool bCreate,
-	const TMap<FString, FString>& Vars,
+void USatoriClient::Authenticate(
+	const FString& ID,
+	const TMap<FString, FString>& DefaultProperties,
+	const TMap<FString, FString>& CustomProperties,
+	const bool bNoSession,
 	TFunction<void(USatoriSession* UserSession)> SuccessCallback,
 	TFunction<void(const FSatoriError& Error)> ErrorCallback)
 {
 	// Setup the endpoint
 	const FString Endpoint = TEXT("/v1/authenticate");
 
-	// Setup the query parameters
-	TMultiMap<FString, FString> QueryParams;
-	QueryParams.Add(TEXT("create"), FSatoriUtils::BoolToString(bCreate));
-	QueryParams.Add(TEXT("username"), FGenericPlatformHttp::UrlEncode(Username));
-
 	// Setup the request content
 	const TSharedPtr<FJsonObject> ContentJson = MakeShared<FJsonObject>();
-	ContentJson->SetStringField(TEXT("id"), CustomId);
-	FSatoriUtils::AddVarsToJson(ContentJson, Vars);
+
+	ContentJson->SetStringField(TEXT("id"), ID);
+	ContentJson->SetBoolField(TEXT("no_session"), bNoSession);
+
+	TSharedPtr<FJsonObject> DefaultPropertiesJson = MakeShared<FJsonObject>();
+	for (const TPair<FString, FString>& Pair : DefaultProperties)
+	{
+		DefaultPropertiesJson->SetStringField(Pair.Key, Pair.Value);
+	}
+	ContentJson->SetObjectField(TEXT("default"), DefaultPropertiesJson);
+
+	TSharedPtr<FJsonObject> CustomPropertiesJson = MakeShared<FJsonObject>();
+	for (const TPair<FString, FString>& Pair : DefaultProperties)
+	{
+		CustomPropertiesJson->SetStringField(Pair.Key, Pair.Value);
+	}
+	ContentJson->SetObjectField(TEXT("custom"), CustomPropertiesJson);
 
 	// Serialize the request content
 	FString Content;
@@ -161,7 +171,7 @@ void USatoriClient::AuthenticateCustom(
 	}
 
 	// Make the request
-	const auto HttpRequest = MakeRequest(Endpoint, Content, ESatoriRequestMethod::POST, QueryParams, "");
+	const auto HttpRequest = MakeRequest(Endpoint, Content, ESatoriRequestMethod::POST, TMultiMap<FString, FString>(), "");
 
 	// Set the basic authorization header
 	FSatoriUtils::SetBasicAuthorizationHeader(HttpRequest, ServerKey);
@@ -347,7 +357,7 @@ void USatoriClient::AuthenticateRefresh(
 			// Remove the HttpRequest from ActiveRequests
 			ActiveRequests.Remove(Request);
 		}
-		});
+	});
 
 	// Process the request
 	HttpRequest->ProcessRequest();

Satori/Source/SatoriUnreal/Public/SatoriClient.h

@@ -130,31 +130,31 @@ class SATORIUNREAL_API USatoriClient : public UObject
 	// --- Authentication --- //
 
 	/**
-	 * Authenticate a user with a custom id.
+	 * Authenticate to get a satori session.
 	 *
-	 * @param UserID A custom identifier usually obtained from an external authentication service.
-	 * @param Username A username used to create the user.
-	 * @param CreateAccount True if the user should be created when authenticated.
-	 * @param Vars Extra information that will be bundled in the session token.
+	 * @param ID Must be between eight and 128 characters (inclusive). Must be an alphanumeric string with only underscores and hyphens allowed.
+	 * @param DefaultProperties Optional default properties to update with this call. If not set, properties are left as they are on the server.
+	 * @param CustomProperties Optional custom properties to update with this call. If not set, properties are left as they are on the server.
+	 * @param bNoSession Modifies the request to only create/update an identity without creating a new session. If set to 'true' the response won't include a token and a refresh token.
 	 * @param Success Delegate called upon successful authentication, providing the user session.
 	 * @param Error Delegate called on authentication failure with error details.
 	 */
 
 	UFUNCTION(Category = "Satori|Authentication")
-	void AuthenticateCustom(
-		const FString& UserID,
-		const FString& Username,
-		bool CreateAccount,
-		const TMap<FString, FString>& Vars,
+	void Authenticate(
+		const FString& ID,
+		const TMap<FString, FString>& DefaultProperties,
+		const TMap<FString, FString>& CustomProperties,
+		const bool bNoSession,
 		FOnSatoriAuthUpdate Success,
 		FOnSatoriError Error
 	);
 
-	void AuthenticateCustom(
-		const FString& UserID,
-		const FString& Username,
-		bool bCreate,
-		const TMap<FString, FString>& Vars,
+	void Authenticate(
+		const FString& ID,
+		const TMap<FString, FString>& DefaultProperties,
+		const TMap<FString, FString>& CustomProperties,
+		const bool bNoSession,
 		TFunction<void(USatoriSession* UserSession)> SuccessCallback,
 		TFunction<void(const FSatoriError& Error)> ErrorCallback
 	);