fix(responses): Fix various responses formats (#460)

Closes #443
algolia · Feb 13, 2018 · f6ad92c · f6ad92c
1 parent 8204e7e
commit f6ad92c
Show file tree

Hide file tree

Showing 17 changed files with 52 additions and 38 deletions.
diff --git a/project/build.properties b/project/build.properties
@@ -1 +1 @@
-sbt.version=0.13.15
+sbt.version=0.13.15
diff --git a/project/plugins.sbt b/project/plugins.sbt
@@ -14,4 +14,4 @@ addSbtPlugin("com.eed3si9n" % "sbt-buildinfo" % "0.7.0")
 addSbtPlugin("net.virtual-void" % "sbt-dependency-graph" % "0.8.2")
 
 //Formatter
-addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "0.6.8")
+addSbtPlugin("com.geirsson" % "sbt-scalafmt" % "0.6.8")
diff --git a/src/main/scala/algolia/AlgoliaHttpClient.scala b/src/main/scala/algolia/AlgoliaHttpClient.scala
@@ -49,12 +49,12 @@ case class AlgoliaHttpClient(
       .setRequestTimeout(configuration.httpRequestTimeoutMs)
       .build
 
-  val dnsNameResolver: DnsNameResolver = new DnsNameResolverBuilder(
-    new NioEventLoopGroup(1).next()) //We only need 1 thread for DNS resolution
-    .channelType(classOf[NioDatagramChannel])
-    .queryTimeoutMillis(configuration.dnsTimeoutMs.toLong)
-    .maxQueriesPerResolve(2)
-    .build
+  val dnsNameResolver: DnsNameResolver =
+    new DnsNameResolverBuilder(new NioEventLoopGroup(1).next()) //We only need 1 thread for DNS resolution
+      .channelType(classOf[NioDatagramChannel])
+      .queryTimeoutMillis(configuration.dnsTimeoutMs.toLong)
+      .maxQueriesPerResolve(2)
+      .build
 
   val logger: Logger = LoggerFactory.getLogger("algoliasearch")
 

diff --git a/src/main/scala/algolia/definitions/MultiQueriesDefinition.scala b/src/main/scala/algolia/definitions/MultiQueriesDefinition.scala
@@ -51,7 +51,7 @@ case class MultiQueriesDefinition(
 
   override private[algolia] def build(): HttpPayload = {
     val parameters =
-      strategy.map(s => Some(Map("strategy" -> s.name))).getOrElse(None)
+      strategy.flatMap(s => Some(Map("strategy" -> s.name)))
 
     HttpPayload(
       POST,

diff --git a/src/main/scala/algolia/objects/Acl.scala b/src/main/scala/algolia/objects/Acl.scala
@@ -47,4 +47,8 @@ object Acl {
 
   case object listIndexes extends Acl
 
+  case object logs extends Acl
+
+  case object seeUnretrievableAttributes extends Acl
+
 }
diff --git a/src/main/scala/algolia/objects/QueryRules.scala b/src/main/scala/algolia/objects/QueryRules.scala
@@ -29,4 +29,5 @@ case class QueryRules(query: String,
                       anchoring: Option[String] = None,
                       context: Option[String] = None,
                       page: Option[Int] = None,
-                      hitsPerPage: Option[Int] = None)
+                      hitsPerPage: Option[Int] = None,
+                      nbPages: Option[Int] = None)
diff --git a/src/main/scala/algolia/responses/BrowseResult.scala b/src/main/scala/algolia/responses/BrowseResult.scala
@@ -25,15 +25,19 @@
 
 package algolia.responses
 
-import org.json4s.JObject
+import org.json4s.{DefaultFormats, JObject}
 
 case class BrowseResult(cursor: Option[String],
                         hits: Seq[JObject],
                         processingTimeMS: Int,
                         query: String,
-                        params: String) {
+                        params: String,
+                        nbHits: Option[Int],
+                        page: Option[Int],
+                        histPerPage: Option[Int],
+                        nbPages: Option[Int]) {
 
-  implicit val formats = org.json4s.DefaultFormats
+  implicit val formats: DefaultFormats = org.json4s.DefaultFormats
 
   def asHit[T <: Hit: Manifest]: Seq[T] = hits.map(_.extract[T])
 

diff --git a/src/main/scala/algolia/responses/SearchResult.scala b/src/main/scala/algolia/responses/SearchResult.scala
@@ -41,7 +41,10 @@ case class SearchResult(hits: Seq[JObject],
                         facets: Option[Map[String, Map[String, Int]]],
                         exhaustiveFacetsCount: Option[Boolean],
                         query: String,
-                        params: String) {
+                        params: String,
+                        // For multiqueries
+                        processed: Option[Boolean],
+                        index: Option[String]) {
 
   implicit val formats: Formats = org.json4s.DefaultFormats
 
@@ -74,11 +77,13 @@ trait Hit extends ObjectID {
 
   val _rankingInfo: Option[RankingInfo]
 
+  val _distinctSeqID: Option[Integer]
+
 }
 
 case class HighlightResult(value: String, matchLevel: String)
 
-case class SnippetResult(value: String)
+case class SnippetResult(value: String, matchLevel: String)
 
 case class RankingInfo(nbTypos: Int,
                        firstMatchedWord: Int,

diff --git a/src/main/scala/algolia/responses/Tasks.scala b/src/main/scala/algolia/responses/Tasks.scala
@@ -31,11 +31,12 @@ sealed trait AlgoliaTask {
 
 }
 
-case class Task(taskID: Long, createdAt: Option[String]) extends AlgoliaTask {
+case class Task(taskID: Long, createdAt: Option[String] = None, updatedAt: Option[String] = None)
+    extends AlgoliaTask {
   override def idToWaitFor(): Long = taskID
 }
 
-case class TasksSingleIndex(taskID: Long, objectIDs: Seq[String], createdAt: Option[String])
+case class TasksSingleIndex(taskID: Long, objectIDs: Seq[String], createdAt: Option[String] = None)
     extends AlgoliaTask {
   override def idToWaitFor(): Long = taskID
 }
@@ -47,7 +48,7 @@ case class TasksMultipleIndex(taskID: Map[String, Long],
   override def idToWaitFor(): Long = taskID.values.max
 }
 
-case class TaskIndexing(taskID: Long, objectID: String, createdAt: Option[String])
+case class TaskIndexing(taskID: Long, objectID: String, createdAt: Option[String] = None)
     extends AlgoliaTask {
   override def idToWaitFor(): Long = taskID
 }
diff --git a/src/test/scala/algolia/AlgoliaClientTest.scala b/src/test/scala/algolia/AlgoliaClientTest.scala
@@ -37,7 +37,7 @@ import scala.concurrent.{ExecutionContext, Future}
 
 class AlgoliaClientTest extends AlgoliaTest {
 
-  val notSoRandom = new AlgoliaUtils {
+  val notSoRandom: AlgoliaUtils = new AlgoliaUtils {
     override def shuffle(seq: Seq[String]): Seq[String] = seq
   }
 

diff --git a/src/test/scala/algolia/dsl/CopyIndexTest.scala b/src/test/scala/algolia/dsl/CopyIndexTest.scala
@@ -42,7 +42,7 @@ class CopyIndexTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "toto", "operation"),
-          body = Some("{\"operation\":\"copy\",\"destination\":\"tata\"}"),
+          body = Some("""{"operation":"copy","destination":"tata"}"""),
           isSearch = false,
           requestOptions = None
         )
@@ -62,8 +62,7 @@ class CopyIndexTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "toto", "operation"),
-          body =
-            Some("{\"operation\":\"copy\",\"destination\":\"tata\",\"scopes\":[\"settings\"]}"),
+          body = Some("""{"operation":"copy","destination":"tata","scopes":["settings"]}"""),
           isSearch = false,
           requestOptions = None
         )

diff --git a/src/test/scala/algolia/dsl/MoveIndexTest.scala b/src/test/scala/algolia/dsl/MoveIndexTest.scala
@@ -42,7 +42,7 @@ class MoveIndexTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "toto", "operation"),
-          body = Some("{\"operation\":\"move\",\"destination\":\"tata\"}"),
+          body = Some("""{"operation":"move","destination":"tata"}"""),
           isSearch = false,
           requestOptions = None
         )

diff --git a/src/test/scala/algolia/dsl/PartialUpdateObjectTest.scala b/src/test/scala/algolia/dsl/PartialUpdateObjectTest.scala
@@ -43,7 +43,7 @@ class PartialUpdateObjectTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "index", "myId", "partial"),
-          body = Some("{\"toto\":{\"_operation\":\"Increment\",\"value\":1}}"),
+          body = Some("""{"toto":{"_operation":"Increment","value":1}}"""),
           isSearch = false,
           requestOptions = None
         )
@@ -64,7 +64,7 @@ class PartialUpdateObjectTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "index", "myId", "partial"),
-          body = Some("{\"toto\":{\"_operation\":\"Decrement\",\"value\":1}}"),
+          body = Some("""{"toto":{"_operation":"Decrement","value":1}}"""),
           isSearch = false,
           requestOptions = None
         )
@@ -85,7 +85,7 @@ class PartialUpdateObjectTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "index", "myId", "partial"),
-          body = Some("{\"toto\":{\"_operation\":\"Add\",\"value\":\"truc\"}}"),
+          body = Some("""{"toto":{"_operation":"Add","value":"truc"}}"""),
           isSearch = false,
           requestOptions = None
         )
@@ -106,7 +106,7 @@ class PartialUpdateObjectTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "index", "myId", "partial"),
-          body = Some("{\"toto\":{\"_operation\":\"Remove\",\"value\":\"truc\"}}"),
+          body = Some("""{"toto":{"_operation":"Remove","value":"truc"}}"""),
           isSearch = false,
           requestOptions = None
         )
@@ -127,7 +127,7 @@ class PartialUpdateObjectTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "index", "myId", "partial"),
-          body = Some("{\"toto\":{\"_operation\":\"AddUnique\",\"value\":\"truc\"}}"),
+          body = Some("""{"toto":{"_operation":"AddUnique","value":"truc"}}"""),
           isSearch = false,
           requestOptions = None
         )
@@ -148,7 +148,7 @@ class PartialUpdateObjectTest extends AlgoliaTest {
         HttpPayload(
           POST,
           Seq("1", "indexes", "index", "myId", "partial"),
-          body = Some("{\"toto\":\"truc\"}"),
+          body = Some("""{"toto":"truc"}"""),
           isSearch = false,
           requestOptions = None
         )
@@ -170,7 +170,7 @@ class PartialUpdateObjectTest extends AlgoliaTest {
           POST,
           Seq("1", "indexes", "index", "myId", "partial"),
           queryParameters = Some(Map("createIfNotExists" -> "false")),
-          body = Some("{\"toto\":{\"_operation\":\"Increment\",\"value\":1}}"),
+          body = Some("""{"toto":{"_operation":"Increment","value":1}}"""),
           isSearch = false,
           requestOptions = None
         )

diff --git a/src/test/scala/algolia/dsl/RulesTest.scala b/src/test/scala/algolia/dsl/RulesTest.scala
@@ -178,7 +178,6 @@ class RulesTest extends AlgoliaTest {
       it("should save batches rules of an index") {
         save rules Seq(generateRule("rule1")) inIndex "toto" and forwardToSlaves and clearExistingRules
         save rules Seq(generateRule("rule2")) inIndex "toto" and forwardToReplicas and clearExistingRules
-
       }
 
       it("should call API") {

diff --git a/src/test/scala/algolia/dsl/SaveObjectTest.scala b/src/test/scala/algolia/dsl/SaveObjectTest.scala
@@ -48,7 +48,7 @@ class SaveObjectTest extends AlgoliaTest {
           HttpPayload(
             POST,
             List("1", "indexes", "toto"),
-            body = Some("{\"name\":\"algolia\",\"age\":2}"),
+            body = Some("""{"name":"algolia","age":2}"""),
             isSearch = false,
             requestOptions = None
           )
@@ -68,7 +68,7 @@ class SaveObjectTest extends AlgoliaTest {
               POST,
               List("1", "indexes", "toto", "batch"),
               body = Some(
-                "{\"requests\":[{\"body\":{\"name\":\"algolia\",\"age\":2},\"action\":\"addObject\"}]}"),
+                """{"requests":[{"body":{"name":"algolia","age":2},"action":"addObject"}]}"""),
               isSearch = false,
               requestOptions = None
             )
@@ -82,7 +82,7 @@ class SaveObjectTest extends AlgoliaTest {
               POST,
               List("1", "indexes", "toto", "batch"),
               body = Some(
-                "{\"requests\":[{\"body\":{\"name\":\"algolia\",\"age\":2,\"objectID\":\"id\"},\"action\":\"updateObject\"}]}"),
+                """{"requests":[{"body":{"name":"algolia","age":2,"objectID":"id"},"action":"updateObject"}]}"""),
               isSearch = false,
               requestOptions = None
             )
@@ -107,7 +107,7 @@ class SaveObjectTest extends AlgoliaTest {
           HttpPayload(
             PUT,
             List("1", "indexes", "toto", "1"),
-            body = Some("{\"name\":\"algolia\",\"age\":2}"),
+            body = Some("""{"name":"algolia","age":2}"""),
             isSearch = false,
             requestOptions = None
           )
@@ -127,7 +127,7 @@ class SaveObjectTest extends AlgoliaTest {
               POST,
               List("1", "indexes", "toto", "batch"),
               body = Some(
-                "{\"requests\":[{\"body\":{\"objectID\":\"1\",\"name\":\"algolia\",\"age\":2},\"action\":\"updateObject\"}]}"),
+                """{"requests":[{"body":{"objectID":"1","name":"algolia","age":2},"action":"updateObject"}]}"""),
               isSearch = false,
               requestOptions = None
             )

diff --git a/src/test/scala/algolia/dsl/SynonymsTest.scala b/src/test/scala/algolia/dsl/SynonymsTest.scala
@@ -156,7 +156,6 @@ class SynonymsTest extends AlgoliaTest {
       it("should save batches synonyms of an index") {
         save synonyms Seq(Placeholder("oid", "1", Seq("2", "3"))) inIndex "toto" and forwardToSlaves and replaceExistingSynonyms
         save synonyms Seq(Placeholder("oid", "1", Seq("2", "3"))) inIndex "toto" and forwardToReplicas and replaceExistingSynonyms
-
       }
 
       it("should call API") {

diff --git a/src/test/scala/algolia/integration/SearchIntegrationTest.scala b/src/test/scala/algolia/integration/SearchIntegrationTest.scala
@@ -97,6 +97,7 @@ class SearchIntegrationTest extends AlgoliaTest {
                               "563481290",
                               Some(Map("name" -> HighlightResult("<em>a</em>lgolia", "full"))),
                               None,
+                              None,
                               None)
         result.asHit[EnhanceTest].head should be(hit)
       }
@@ -235,7 +236,8 @@ case class EnhanceTest(name: String,
                        objectID: String,
                        _highlightResult: Option[Map[String, HighlightResult]],
                        _snippetResult: Option[Map[String, SnippetResult]],
-                       _rankingInfo: Option[RankingInfo])
+                       _rankingInfo: Option[RankingInfo],
+                       _distinctSeqID: Option[Integer])
     extends Hit
 
 case class Character(name: String, series: String)