chore: Rename Recommendation -> Personalization (#745)

Author: VladislavFitz

Sources/AlgoliaSearchClient/Client/RecommendationClient.swift renamed to Sources/AlgoliaSearchClient/Client/PersonalizationClient.swift

@@ -1,16 +1,16 @@
 //
-//  RecommendationClient.swift
+//  PersonalizationClient.swift
 //  
 //
-//  Created by Vladislav Fitc on 27/05/2020.
+//  Created by Vladislav Fitc on 05/07/2021.
 //
 
 import Foundation
 #if canImport(FoundationNetworking)
 import FoundationNetworking
 #endif
 
-public struct RecommendationClient: Credentials {
+public struct PersonalizationClient: Credentials {
 
   let transport: Transport
   let operationLauncher: OperationLauncher
@@ -26,7 +26,7 @@ public struct RecommendationClient: Credentials {
 
   public init(appID: ApplicationID, apiKey: APIKey, region: Region? = nil) {
 
-    let configuration = RecommendationConfiguration(applicationID: appID, apiKey: apiKey, region: region)
+    let configuration = PersonalizationConfiguration(applicationID: appID, apiKey: apiKey, region: region)
     let sessionConfiguration: URLSessionConfiguration = .default
     sessionConfiguration.httpAdditionalHeaders = configuration.defaultHeaders
 
@@ -36,7 +36,7 @@ public struct RecommendationClient: Credentials {
 
   }
 
-  public init(configuration: RecommendationConfiguration, requester: HTTPRequester) {
+  public init(configuration: PersonalizationConfiguration, requester: HTTPRequester) {
 
     let queue = OperationQueue()
     queue.qualityOfService = .userInitiated
@@ -64,9 +64,9 @@ public struct RecommendationClient: Credentials {
 
 }
 
-extension RecommendationClient: TransportContainer {}
+extension PersonalizationClient: TransportContainer {}
 
-public extension RecommendationClient {
+public extension PersonalizationClient {
 
   // MARK: - Set personalization strategy
 
@@ -125,3 +125,8 @@ public extension RecommendationClient {
   }
 
 }
+
+
+
+@available(*, deprecated, renamed: "PersonalizationClient")
+public typealias RecommendationClient = PersonalizationClient

Sources/AlgoliaSearchClient/Models/Personalization/RecommendationConfiguration.swift renamed to Sources/AlgoliaSearchClient/Models/Personalization/PersonalizationConfiguration.swift

@@ -1,13 +1,13 @@
 //
-//  RecommendationConfiguration.swift
+//  PersonalizationConfiguration.swift
 //  
 //
-//  Created by Vladislav Fitc on 27/05/2020.
+//  Created by Vladislav Fitc on 05/07/2021.
 //
 
 import Foundation
 
-public struct RecommendationConfiguration: Configuration, Credentials {
+public struct PersonalizationConfiguration: Configuration, Credentials {
 
   public let applicationID: ApplicationID
 
@@ -44,3 +44,6 @@ public struct RecommendationConfiguration: Configuration, Credentials {
   }
 
 }
+
+@available(*, deprecated, renamed: "PersonalizationConfiguration")
+public typealias RecommendationConfiguration = PersonalizationConfiguration

Tests/AlgoliaSearchClientTests/Doc/Methods/PersonalizationSnippets.swift

@@ -10,20 +10,20 @@ import AlgoliaSearchClient
 
 struct PersonalizationSnippets: SnippetsCollection {
 
-  let recommendationClient = RecommendationClient(appID: "", apiKey: "")
+  let personalizationClient = PersonalizationClient(appID: "", apiKey: "")
 }
 
 //MARK: - Set region
 extension PersonalizationSnippets {
 
   func personalization_region() {
-    let recommendationClient = RecommendationClient(
+    let personalizationClient = PersonalizationClient(
       appID: "YourApplicationID",
       apiKey: "YourAdminAPIKey",
       region: .init(rawValue: "eu") // defaults to 'us'
     )
 
-    recommendationClient.getPersonalizationStrategy { result in
+    personalizationClient.getPersonalizationStrategy { result in
       if case .success(let response) = result {
         print("Response: \(response)")
       }
@@ -44,7 +44,7 @@ extension PersonalizationSnippets {
   """
 
   func addStrategy() {
-    let recommendationClient = RecommendationClient(appID: "YourApplicationID", apiKey: "YourAPIKey")
+    let personalizationClient = PersonalizationClient(appID: "YourApplicationID", apiKey: "YourAPIKey")
 
     let eventsScoring: [EventScoring] = [
       .init(eventName: "Add to cart", eventType: .conversion, score: 50),
@@ -60,7 +60,7 @@ extension PersonalizationSnippets {
                                            facetsScoring: facetsScoring,
                                            personalizationImpact: 0)
 
-    recommendationClient.setPersonalizationStrategy(strategy) { result in
+    personalizationClient.setPersonalizationStrategy(strategy) { result in
       if case .success(let response) = result {
         print("Response: \(response)")
       }
@@ -80,7 +80,7 @@ extension PersonalizationSnippets {
   """
 
   func getStrategy() {
-    recommendationClient.getPersonalizationStrategy { result in
+    personalizationClient.getPersonalizationStrategy { result in
       if case .success(let response) = result {
         print("Response: \(response)")
       }

Tests/AlgoliaSearchClientTests/Integration/PersonalizationIntegrationTests.swift

@@ -19,13 +19,13 @@ class PersonalizationIntegrationTests: IntegrationTestCase {
   }
 
   func getStrategy() throws {
-    let recommendationClient = RecommendationClient(appID: client.applicationID, apiKey: client.apiKey, region: .custom("eu"))
+    let recommendationClient = PersonalizationClient(appID: client.applicationID, apiKey: client.apiKey, region: .custom("eu"))
     let _ = try recommendationClient.getPersonalizationStrategy()
   }
 
   func setStrategy() throws {
 
-    let recommendationClient = RecommendationClient(appID: client.applicationID, apiKey: client.apiKey, region: .custom("us"))
+    let personalizationClient = PersonalizationClient(appID: client.applicationID, apiKey: client.apiKey, region: .custom("us"))
 
     let strategy = PersonalizationStrategy(
       eventsScoring: [
@@ -40,7 +40,7 @@ class PersonalizationIntegrationTests: IntegrationTestCase {
     )
 
     do {
-      try recommendationClient.setPersonalizationStrategy(strategy)
+      try personalizationClient.setPersonalizationStrategy(strategy)
     } catch let httpError as HTTPError where httpError.statusCode == HTTPStatusСode.tooManyRequests {
       // The personalization API is now limiting the number of setPersonalizationStrategy()` successful calls
       // to 15 per day. If the 429 error is returned, the response is considered a "success".