WS client version bump (0.4.0)

Author: peterbanda

README.md

@@ -1,5 +1,5 @@
 # Pinecone Scala Client 🗂️
-[![version](https://img.shields.io/badge/version-0.1.2-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
+[![version](https://img.shields.io/badge/version-0.1.3-green.svg)](https://cequence.io) [![License](https://img.shields.io/badge/License-MIT-lightgrey.svg)](https://opensource.org/licenses/MIT) ![GitHub Stars](https://img.shields.io/github/stars/cequence-io/pinecone-scala?style=social) [![Twitter Follow](https://img.shields.io/twitter/follow/0xbnd?style=social)](https://twitter.com/0xbnd)
 
 This is an intuitive async Scala client for Pinecone API supporting all the available vector and index/collection operations/endpoints, provided in two convenient services called [PineconeVectorService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeVectorService.scala) and [PineconeIndexService](./pinecone-core/src/main/scala/io/cequence/pineconescala/service/PineconeIndexService.scala). The supported calls are: 
 
@@ -22,7 +22,7 @@ The currently supported Scala versions are **2.12, 2.13**, and **3**.
 To pull the library you have to add the following dependency to your *build.sbt*
 
 ```
-"io.cequence" %% "pinecone-scala-client" % "0.1.2"
+"io.cequence" %% "pinecone-scala-client" % "0.1.3"
 ```
 
 or to *pom.xml* (if you use maven)
@@ -31,7 +31,7 @@ or to *pom.xml* (if you use maven)
 <dependency>
     <groupId>io.cequence</groupId>
     <artifactId>pinecone-scala-client_2.12</artifactId>
-    <version>0.1.2</version>
+    <version>0.1.3</version>
 </dependency>
 ```
 
@@ -428,7 +428,7 @@ pinecone-scala-client {
 }
 ```
 
-2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.1.2/pinecone-scala-client_2.13-0.1.2.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_
+2. _I got an exception like `com.typesafe.config.ConfigException$UnresolvedSubstitution: pinecone-scala-client.conf @ jar:file:.../io/cequence/pinecone-scala-client_2.13/0.1.3/pinecone-scala-client_2.13-0.1.3.jar!/pinecone-scala-client.conf: 4: Could not resolve substitution to a value: ${PINECONE_SCALA_CLIENT_API_KEY}`. What should I do?_
 
    Set the env. variable `PINECONE_SCALA_CLIENT_API_KEY`. If you don't have one register [here](https://app.pinecone.io/?sessionType=signup).
 

build.sbt

@@ -8,7 +8,7 @@ val scala33 = "3.3.1"
 
 ThisBuild / organization := "io.cequence"
 ThisBuild / scalaVersion := scala212
-ThisBuild / version := "0.1.2"
+ThisBuild / version := "0.1.3"
 ThisBuild / isSnapshot := false
 
 lazy val core = (project in file("pinecone-core"))

pinecone-client/build.sbt

@@ -2,26 +2,11 @@ import Dependencies.Versions._
 
 name := "pinecone-scala-client"
 
-description := "Scala client for Pinecone API implemented with Play WS lib."
+libraryDependencies ++= Seq(
+  "io.cequence" %% "ws-client-core" % wsClient,
+  "io.cequence" %% "ws-client-play" % wsClient,
 
-libraryDependencies += "org.scalactic" %% "scalactic" % "3.2.18"
-libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.18" % Test
-libraryDependencies += "org.scalatestplus" %% "mockito-4-11" % "3.2.18.0" % Test
-
-libraryDependencies += "io.cequence" %% "ws-client-core" % wsClient
-libraryDependencies += "io.cequence" %% "ws-client-play" % wsClient
-
-lazy val playWsVersion = settingKey[String]("Play WS version")
-inThisBuild(
-  playWsVersion := {
-    scalaVersion.value match {
-      case "2.12.18" => "2.1.10"
-      case "2.13.11" => "2.2.0-M3"
-      case "3.2.2" =>
-        "2.2.0-M2" // Version "2.2.0-M3" was produced by an unstable release: Scala 3.3.0-RC3
-      case _ => "2.1.10"
-    }
-  }
+  "org.scalactic" %% "scalactic" % "3.2.18",
+  "org.scalatest" %% "scalatest" % "3.2.18" % Test,
+  "org.scalatestplus" %% "mockito-4-11" % "3.2.18.0" % Test
 )
-
-libraryDependencies += "com.typesafe.play" %% "play-ws-standalone-json" % playWsVersion.value

pinecone-client/src/main/scala/io/cequence/pineconescala/service/EndPoint.scala

@@ -1,7 +1,7 @@
 package io.cequence.pineconescala.service
 
 import io.cequence.pineconescala.domain.settings.IndexSettings.{CreatePodBasedIndexSettings, CreateServerlessIndexSettings}
-import io.cequence.wsclient.domain.{EnumValue, NamedEnumValue}
+import io.cequence.wsclient.domain.NamedEnumValue
 
 sealed abstract class EndPoint(value: String = "") extends NamedEnumValue(value)
 
@@ -54,10 +54,8 @@ object Tag {
   case object spec extends Tag
   case object shards extends Tag
   case object inputs extends Tag
-  case object input_type extends Tag
   case object model extends Tag
   case object parameters extends Tag
-  case object truncate extends Tag
 
   // TODO: move elsewhere
   def fromCreatePodBasedIndexSettings(

pinecone-client/src/main/scala/io/cequence/pineconescala/service/PineconeIndexServiceImpl.scala

@@ -13,10 +13,10 @@ import io.cequence.pineconescala.domain.settings.IndexSettings.{
 import io.cequence.pineconescala.domain.settings._
 import io.cequence.pineconescala.domain.{Metric, PodType}
 import io.cequence.wsclient.JsonUtil.JsonOps
-import io.cequence.wsclient.domain.WsRequestContext
+import io.cequence.wsclient.ResponseImplicits._
+import io.cequence.wsclient.domain.{RichResponse, WsRequestContext}
 import io.cequence.wsclient.service.ws.{Timeouts, WSRequestHelper}
 import play.api.libs.json.JsValue
-import play.api.libs.ws.StandaloneWSRequest
 
 import scala.concurrent.{ExecutionContext, Future}
 
@@ -59,7 +59,7 @@ private final class ServerlessIndexServiceImpl(
     dimension: Int,
     settings: CreateServerlessIndexSettings
   ): Future[CreateResponse] =
-    execPOSTWithStatus(
+    execPOSTRich(
       indexesEndpoint,
       bodyParams = {
         jsonBodyParams(
@@ -120,7 +120,7 @@ private final class PineconePodPineconeBasedImpl(
     dimension: Int,
     settings: CreatePodBasedIndexSettings
   ): Future[CreateResponse] =
-    execPOSTWithStatus(
+    execPOSTRich(
       indexesEndpoint,
       bodyParams = jsonBodyParams(
         Tag.fromCreatePodBasedIndexSettings(name, dimension, settings): _*
@@ -133,21 +133,22 @@ private final class PineconePodPineconeBasedImpl(
     replicas: Option[Int],
     podType: Option[PodType]
   ): Future[ConfigureIndexResponse] =
-    execPATCHWithStatus(
+    execPATCRich(
       indexesEndpoint,
       endPointParam = Some(indexName),
       bodyParams = jsonBodyParams(
         Tag.replicas -> replicas,
         Tag.pod_type -> podType.map(_.toString)
       )
-    ).map { response =>
-      val (statusCode, message) = statusCodeAndMessage(response)
+    ).map { richResponse =>
+      val status = richResponse.status
 
-      statusCode match {
+      status.code match {
         case 202 => ConfigureIndexResponse.Updated
         case 400 => ConfigureIndexResponse.BadRequestNotEnoughQuota
         case 404 => ConfigureIndexResponse.NotFound
-        case _   => throw new PineconeScalaClientException(s"Code ${statusCode} : ${message}")
+        case _ =>
+          throw new PineconeScalaClientException(s"Code ${status.code} : ${status.message}")
       }
     }
 
@@ -165,7 +166,7 @@ private final class PineconePodPineconeBasedImpl(
     name: String,
     source: String
   ): Future[CreateResponse] =
-    execPOSTWithStatus(
+    execPOSTRich(
       EndPoint.collections,
       bodyParams = jsonBodyParams(
         Tag.name -> Some(name),
@@ -175,7 +176,8 @@ private final class PineconePodPineconeBasedImpl(
     ).map(handleCreateResponse)
 
   override def listCollections: Future[Seq[String]] =
-    execGET(EndPoint.collections).map(response => response.asSafe[Seq[String]]
+    execGET(EndPoint.collections).map(
+      _.asSafeJson[Seq[String]]
 //      response
 //        .asSafe[Seq[String]](response \ "collections")
 //        .asOpt[Seq[JsValue]]
@@ -206,41 +208,44 @@ abstract class PineconeIndexServiceImpl[S <: IndexSettings](
   override protected type PEP = EndPoint
   override protected type PT = Tag
 
-  override protected val requestContext = WsRequestContext(explTimeouts = explicitTimeouts)
+  override protected val requestContext = WsRequestContext(
+    authHeaders = Seq(("Api-Key", apiKey)),
+    explTimeouts = explicitTimeouts
+  )
 
   def isPodBasedIndex: Boolean = environment.isDefined
   def isServerlessIndex: Boolean = !isPodBasedIndex
 
   override def describeCollection(
     collectionName: String
   ): Future[Option[CollectionInfo]] =
-    execGETWithStatus(
+    execGETRich(
       EndPoint.collections,
       endPointParam = Some(collectionName)
     ).map { response =>
       handleNotFoundAndError(response).map(
-        _.asSafe[CollectionInfo]
+        _.asSafeJson[CollectionInfo]
       )
     }
 
   override def deleteCollection(
     collectionName: String
   ): Future[DeleteResponse] =
-    execDELETEWithStatus(
+    execDELETERich(
       EndPoint.collections,
       endPointParam = Some(collectionName),
       acceptableStatusCodes = Nil // don't parse response at all
     ).map(handleDeleteResponse)
 
   override def listIndexes: Future[Seq[String]] =
     execGET(indexesEndpoint).map(response =>
-      (response \ "indexes")
+      (response.json \ "indexes")
         .asOpt[Seq[JsValue]]
         .map(indexes => {
           indexes.flatMap(index => (index \ "name").asOpt[String])
         })
         .getOrElse(
-          response.asSafe[Seq[String]]
+          response.asSafeJson[Seq[String]]
         )
     )
 
@@ -249,17 +254,19 @@ abstract class PineconeIndexServiceImpl[S <: IndexSettings](
   override def describeIndex(
     indexName: String
   ): Future[Option[IndexInfo]] =
-    execGETWithStatus(
+    execGETRich(
       indexesEndpoint,
       endPointParam = Some(indexName)
-    ).map { response: RichJsResponse =>
-      handleNotFoundAndError(response).map(describeIndexResponse)
+    ).map { richResponse: RichResponse =>
+      handleNotFoundAndError(richResponse).map(response =>
+        describeIndexResponse(response.json)
+      )
     }
 
   override def deleteIndex(
     indexName: String
   ): Future[DeleteResponse] =
-    execDELETEWithStatus(
+    execDELETERich(
       indexesEndpoint,
       endPointParam = Some(indexName),
       acceptableStatusCodes = Nil // don't parse response at all
@@ -271,25 +278,6 @@ abstract class PineconeIndexServiceImpl[S <: IndexSettings](
   // otherwise (serverless arch) we use indexes endpoint
   protected def indexesEndpoint: PEP // Either[EndPoint.databases.type, EndPoint.indexes.type]
 
-  // TODO: remove this and use WsRequestContext instead
-  override protected def addHeaders(request: StandaloneWSRequest): StandaloneWSRequest = {
-    val apiKeyHeader = ("Api-Key", apiKey)
-    request.addHttpHeaders(apiKeyHeader)
-  }
-
-  protected def statusCodeAndMessage(
-    response: RichJsResponse
-  ): (Int, String) =
-    response match {
-      case Right(statusCodeAndMessage) => statusCodeAndMessage
-
-      // should never happen
-      case Left(json) =>
-        throw new IllegalArgumentException(
-          s"Status code and message expected but got a json value '${json}'."
-        )
-    }
-
   /**
    * This operation creates a Pinecone index. You can use it to specify the measure of
    * similarity, the dimension of vectors to be stored in the index, the numbers of replicas to
@@ -318,27 +306,27 @@ abstract class PineconeIndexServiceImpl[S <: IndexSettings](
   ): Nothing =
     throw new PineconeScalaClientException(s"Code ${httpCode} : ${message}")
 
-  protected def handleCreateResponse(response: RichJsResponse): CreateResponse = {
-    val (statusCode, message) = statusCodeAndMessage(response)
-
-    statusCode match {
+  protected def handleCreateResponse(response: RichResponse): CreateResponse =
+    response.status.code match {
       case 201 => CreateResponse.Created
       // Encountered when request exceeds quota or an invalid index name.
       case 400 => CreateResponse.BadRequest
       case 409 => CreateResponse.AlreadyExists
-      case _   => throw new PineconeScalaClientException(s"Code ${statusCode} : ${message}")
+      case _ =>
+        throw new PineconeScalaClientException(
+          s"Code ${response.status.code} : ${response.status.message}"
+        )
     }
-  }
 
-  protected def handleDeleteResponse(response: RichJsResponse): DeleteResponse = {
-    val (statusCode, message) = statusCodeAndMessage(response)
-
-    statusCode match {
+  protected def handleDeleteResponse(response: RichResponse): DeleteResponse =
+    response.status.code match {
       case 202 => DeleteResponse.Deleted
       case 404 => DeleteResponse.NotFound
-      case _   => throw new PineconeScalaClientException(s"Code ${statusCode} : ${message}")
+      case _ =>
+        throw new PineconeScalaClientException(
+          s"Code ${response.status.code} : ${response.status.message}"
+        )
     }
-  }
 }
 
 object PineconeIndexServiceFactory extends PineconeServiceFactoryHelper {