Changed return type of the search endpoint to include the total number of hits. Breaking change for clients. Closes #55.

Author: bhermann

src/main/scala/de/upb/cs/swt/delphi/webapi/DelphiRoutes.scala

@@ -24,6 +24,7 @@ import akka.http.scaladsl.server.Route
 import akka.pattern.ask
 import akka.stream.scaladsl.Source
 import de.upb.cs.swt.delphi.core.model.ArtifactJson._
+import de.upb.cs.swt.delphi.webapi.search.SearchResultsJson._
 import de.upb.cs.swt.delphi.webapi.FeatureJson._
 import de.upb.cs.swt.delphi.webapi.IpLogActor._
 import de.upb.cs.swt.delphi.webapi.StatisticsJson._

src/main/scala/de/upb/cs/swt/delphi/webapi/artifacts/ArtifactTransformer.scala

@@ -25,6 +25,7 @@ import spray.json.JsArray
 import scala.io.Source
 import spray.json._
 import de.upb.cs.swt.delphi.webapi.FeatureJson._
+import de.upb.cs.swt.delphi.webapi.search.SearchResults
 
 object ArtifactTransformer {
   private lazy val internalFeatures = Source.fromResource("features.json")
@@ -66,8 +67,8 @@ object ArtifactTransformer {
   }
 
 
-  def transformResults(hits: SearchHits): Array[Artifact] = {
-    hits.hits.map(h => transformResult(h))
+  def transformResults(hits: SearchHits): SearchResults = {
+    SearchResults(hits.total, hits.hits.map(h => transformResult(h)))
   }
 
   val baseFields = Seq("source", "discovered", "identifier.groupId", "identifier.artifactId", "identifier.version")

src/main/scala/de/upb/cs/swt/delphi/webapi/search/SearchQuery.scala

@@ -160,7 +160,7 @@ class SearchQuery(configuration: Configuration, featureExtractor: FeatureQuery)
     }
   }
 
-  def search(query: QueryRequest): Try[Array[Artifact]] = {
+  def search(query: QueryRequest): Try[SearchResults] = {
     lazy val size = checkValidSize
     val validSize = size.exists(query.limit.getOrElse(defaultFetchSize) <= _)
     if (validSize) {

src/main/scala/de/upb/cs/swt/delphi/webapi/search/SearchResults.scala

@@ -0,0 +1,12 @@
+package de.upb.cs.swt.delphi.webapi.search
+
+import de.upb.cs.swt.delphi.core.model.Artifact
+import de.upb.cs.swt.delphi.core.model.ArtifactJson._
+import org.joda.time.DateTime
+import spray.json.DefaultJsonProtocol
+
+case class SearchResults(totalHits : Long, hits : Array[Artifact], queried : DateTime = DateTime.now())
+
+object SearchResultsJson extends DefaultJsonProtocol {
+  implicit val SearchResultsFormat = jsonFormat3(SearchResults)
+}