refactor: rename RecommendationClient to PersonalizationClient (#634)

Author: aallam

build.sbt

@@ -62,7 +62,8 @@ scalacOptions ++= Seq(
   "UTF-8",
   "-unchecked", //Enable additional warnings where generated code depends on assumptions
   "-Ywarn-dead-code",
-  "-Ywarn-numeric-widen"
+  "-Ywarn-numeric-widen",
+  "-deprecation:false"
 )
 
 headerLicense := Some(

src/main/scala/algolia/AlgoliaClient.scala

@@ -26,8 +26,7 @@
 package algolia
 
 import algolia.http.HttpPayload
-import algolia.objects.{DictionaryEntry, Query}
-import algolia.responses.SearchDictionaryResult
+import algolia.objects.Query
 import org.slf4j.{Logger, LoggerFactory}
 
 import java.nio.charset.Charset
@@ -94,7 +93,11 @@ class AlgoliaClient(
 
   val analyticsHost: String = "https://analytics.algolia.com"
   val insightsHost: String = "https://insights.algolia.io"
-  /* Recommendation default host is set as 'var' because the region might be overridden. */
+
+  /* Personalization default host is set as 'var' because the region might be overridden. */
+  var personalizationHost: String = "https://personalization.us.algolia.com"
+
+  @deprecated("use personalization instead", "1.40.0")
   var recommendationHost: String = "https://recommendation.us.algolia.com"
 
   val userAgent =
@@ -172,6 +175,8 @@ class AlgoliaClient(
       requestAnalytics(payload)
     } else if (payload.isInsights) {
       requestInsights(payload)
+    } else if (payload.isPersonalization) {
+      requestPersonalization(payload)
     } else if (payload.isRecommendation) {
       requestRecommendation(payload)
     } else {
@@ -190,6 +195,19 @@ class AlgoliaClient(
     }
   }
 
+  private[algolia] def requestPersonalization[T: Manifest](
+      payload: HttpPayload
+  )(implicit executor: ExecutionContext): Future[T] = {
+    httpClient.request[T](personalizationHost, headers, payload).andThen {
+      case Failure(e) =>
+        logger.debug("Personalization API call failed", e)
+        Future.failed(
+          new AlgoliaClientException("Personalization API call failed", e)
+        )
+    }
+  }
+
+  @deprecated("use personalization instead", "1.40.0")
   private[algolia] def requestRecommendation[T: Manifest](
       payload: HttpPayload
   )(implicit executor: ExecutionContext): Future[T] = {

src/main/scala/algolia/definitions/PersonalizationDefinition.scala

@@ -0,0 +1,127 @@
+/*
+ * The MIT License (MIT)
+ *
+ * Copyright (c) 2016 Algolia
+ * http://www.algolia.com/
+ *
+ * Permission is hereby granted, free of charge, to any person obtaining a copy
+ * of this software and associated documentation files (the "Software"), to deal
+ * in the Software without restriction, including without limitation the rights
+ * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the Software is
+ * furnished to do so, subject to the following conditions:
+ *
+ * The above copyright notice and this permission notice shall be included in
+ * all copies or substantial portions of the Software.
+ *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+ * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+ * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+ * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+ * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+ * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+ * THE SOFTWARE.
+ */
+
+package algolia.definitions
+
+import algolia.http.{DELETE, GET, HttpPayload, POST}
+import algolia.objects.{RequestOptions, SetStrategyRequest}
+import org.json4s.Formats
+import org.json4s.native.Serialization.write
+
+case class GeStrategyDefinition(
+    requestOptions: Option[RequestOptions] = None
+)(implicit val formats: Formats)
+    extends Definition {
+
+  override type T = GeStrategyDefinition
+
+  override def options(
+      requestOptions: RequestOptions
+  ): GeStrategyDefinition =
+    copy(requestOptions = Some(requestOptions))
+
+  override private[algolia] def build(): HttpPayload = {
+    HttpPayload(
+      GET,
+      Seq("1", "strategies", "personalization"),
+      isSearch = false,
+      isPersonalization = true,
+      requestOptions = requestOptions
+    )
+  }
+
+}
+
+case class SetStrategyDefinition(
+    s: SetStrategyRequest,
+    requestOptions: Option[RequestOptions] = None
+)(implicit val formats: Formats)
+    extends Definition {
+
+  override type T = SetStrategyDefinition
+
+  override def options(
+      requestOptions: RequestOptions
+  ): SetStrategyDefinition =
+    copy(requestOptions = Some(requestOptions))
+
+  override private[algolia] def build(): HttpPayload = {
+    HttpPayload(
+      POST,
+      Seq("1", "strategies", "personalization"),
+      body = Some(write(s)),
+      isSearch = false,
+      isPersonalization = true,
+      requestOptions = requestOptions
+    )
+  }
+
+}
+
+case class GetPersonalizationProfileDefinition(
+    userToken: String,
+    requestOptions: Option[RequestOptions] = None
+)(implicit val formats: Formats)
+    extends Definition {
+  override type T = GetPersonalizationProfileDefinition
+
+  override def options(
+      requestOptions: RequestOptions
+  ): GetPersonalizationProfileDefinition =
+    copy(requestOptions = Some(requestOptions))
+
+  override private[algolia] def build() = {
+    HttpPayload(
+      GET,
+      Seq("1", "profiles", "personalization", userToken),
+      isSearch = false,
+      isPersonalization = true,
+      requestOptions = requestOptions
+    )
+  }
+}
+
+case class DeletePersonalizationProfileDefinition(
+    userToken: String,
+    requestOptions: Option[RequestOptions] = None
+)(implicit val formats: Formats)
+    extends Definition {
+  override type T = DeletePersonalizationProfileDefinition
+
+  override def options(
+      requestOptions: RequestOptions
+  ): DeletePersonalizationProfileDefinition =
+    copy(requestOptions = Some(requestOptions))
+
+  override private[algolia] def build() = {
+    HttpPayload(
+      DELETE,
+      Seq("1", "profiles", userToken),
+      isSearch = false,
+      isPersonalization = true,
+      requestOptions = requestOptions
+    )
+  }
+}

src/main/scala/algolia/definitions/RecommendationDefinition.scala

@@ -30,6 +30,7 @@ import algolia.objects.{RequestOptions, SetStrategyRequest}
 import org.json4s.Formats
 import org.json4s.native.Serialization.write
 
+@deprecated("use personalization instead", "1.41.0")
 case class GetRecommendationStrategyDefinition(
     requestOptions: Option[RequestOptions] = None
 )(implicit val formats: Formats)
@@ -54,6 +55,7 @@ case class GetRecommendationStrategyDefinition(
 
 }
 
+@deprecated("use personalization instead", "1.41.0")
 case class SetRecommendationStrategyDefinition(
     s: SetStrategyRequest,
     requestOptions: Option[RequestOptions] = None

src/main/scala/algolia/definitions/StrategyDefinition.scala

@@ -31,6 +31,7 @@ import algolia.objects.RequestOptions
 import org.json4s.Formats
 import org.json4s.native.Serialization.write
 
+@deprecated("use personalization instead", "1.41.0")
 case class GetPersonalizationStrategyDefinition(
     requestOptions: Option[RequestOptions] = None
 )(implicit val formats: Formats)
@@ -54,6 +55,7 @@ case class GetPersonalizationStrategyDefinition(
 
 }
 
+@deprecated("use personalization instead", "1.41.0")
 case class SetPersonalizationStrategyDefinition(
     s: Strategy,
     requestOptions: Option[RequestOptions] = None

src/main/scala/algolia/dsl/DeleteDsl.scala

@@ -28,7 +28,7 @@ package algolia.dsl
 import algolia.definitions._
 import algolia.inputs.SafeDeleteObjectOperation
 import algolia.objects.{Dictionary, DictionaryEntry}
-import algolia.responses.Task
+import algolia.responses.{DeletePersonalizationProfileResponse, Task}
 import algolia.{AlgoliaClient, Executable}
 import org.json4s.Formats
 
@@ -66,6 +66,10 @@ trait DeleteDsl {
 
     def dictionary(dictionary: Dictionary[_ <: DictionaryEntry]) =
       DeleteDictionaryDefinition(dictionary)
+
+    // Personalization
+    def personalizationProfile(userToken: String) =
+      DeletePersonalizationProfileDefinition(userToken)
   }
 
   implicit object DeleteObjectDefinitionExecutable
@@ -105,4 +109,19 @@ trait DeleteDsl {
     }
   }
 
+  implicit object DeletePersonalizationProfileExecutable
+      extends Executable[
+        DeletePersonalizationProfileDefinition,
+        DeletePersonalizationProfileResponse
+      ] {
+    override def apply(
+        client: AlgoliaClient,
+        query: DeletePersonalizationProfileDefinition
+    )(
+        implicit executor: ExecutionContext
+    ): Future[DeletePersonalizationProfileResponse] = {
+      client.request[DeletePersonalizationProfileResponse](query.build())
+    }
+  }
+
 }

src/main/scala/algolia/dsl/GetDsl.scala

@@ -68,15 +68,24 @@ trait GetDsl {
     def userID(userID: String) = GetUserIDDefinition(userID)
 
     // Personalization
+    def strategy(): GeStrategyDefinition = GeStrategyDefinition()
+
     @deprecated(
-      "Method is deprecated, please use personalizationRecommendationStrategy methods instead",
+      "Method is deprecated, please use strategy methods instead",
       "1.34"
     )
     def personalizationStrategy() = GetPersonalizationStrategyDefinition()
 
+    @deprecated(
+      "Method is deprecated, please use strategy methods instead",
+      "1.40.0"
+    )
     def personalizationRecommendationStrategy() =
       GetRecommendationStrategyDefinition()
 
+    def personalizationProfile(userToken: String) =
+      GetPersonalizationProfileDefinition(userToken)
+
     def dictionarySettings: GetSettingsDictionaryDefinition =
       GetSettingsDictionaryDefinition()
 
@@ -122,8 +131,17 @@ trait GetDsl {
     }
   }
 
+  implicit object GetStrategyExecutable
+      extends Executable[GeStrategyDefinition, GetStrategyResponse] {
+    override def apply(client: AlgoliaClient, query: GeStrategyDefinition)(
+        implicit executor: ExecutionContext
+    ): Future[GetStrategyResponse] = {
+      client.request[GetStrategyResponse](query.build())
+    }
+  }
+
   @deprecated(
-    "Method is deprecated, please use personalizationRecommendationStrategy methods instead",
+    "Method is deprecated, please use strategy methods instead",
     "1.34"
   )
   implicit object GetPersonalizationStrategyExecutable
@@ -136,6 +154,10 @@ trait GetDsl {
     }
   }
 
+  @deprecated(
+    "Method is deprecated, please use strategy methods instead",
+    "1.40.0"
+  )
   implicit object GetPersonalizationRecommendationStrategy
       extends Executable[
         GetRecommendationStrategyDefinition,
@@ -149,4 +171,18 @@ trait GetDsl {
     }
   }
 
+  implicit object GetPersonalizationProfileExecutable
+      extends Executable[
+        GetPersonalizationProfileDefinition,
+        PersonalizationProfileResponse
+      ] {
+    override def apply(
+        client: AlgoliaClient,
+        query: GetPersonalizationProfileDefinition
+    )(
+        implicit executor: ExecutionContext
+    ): Future[PersonalizationProfileResponse] = {
+      client.request[PersonalizationProfileResponse](query.build())
+    }
+  }
 }