Сlient module #140
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -77,7 +77,6 @@ project/plugins/project/ | |
| /project/.sbtboot | ||
| /project/.boot/ | ||
| /project/.ivy/ | ||
|
|
||
| # Molecule | ||
| .molecule/ | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| package com.azavea.stac4s.api.client | ||
jisantuc marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| import com.azavea.stac4s.Bbox | ||
| import com.azavea.stac4s.api.client.utils.ClientCodecs | ||
| import com.azavea.stac4s.geometry.Geometry | ||
| import com.azavea.stac4s.types.TemporalExtent | ||
|
|
||
| import eu.timepit.refined.types.numeric.NonNegInt | ||
| import io.circe._ | ||
| import io.circe.generic.semiauto._ | ||
| import io.circe.refined._ | ||
|
|
||
| case class SearchFilters( | ||
| bbox: Option[Bbox] = None, | ||
| datetime: Option[TemporalExtent] = None, | ||
| intersects: Option[Geometry] = None, | ||
| collections: List[String] = Nil, | ||
| items: List[String] = Nil, | ||
| limit: Option[NonNegInt] = None, | ||
| query: Map[String, List[Query]] = Map.empty, | ||
| next: Option[PaginationToken] = None | ||
| ) | ||
|
|
||
| object SearchFilters extends ClientCodecs { | ||
|
|
||
| implicit val searchFilterDecoder: Decoder[SearchFilters] = { c => | ||
| for { | ||
| bbox <- c.downField("bbox").as[Option[Bbox]] | ||
| datetime <- c.downField("datetime").as[Option[TemporalExtent]] | ||
| intersects <- c.downField("intersects").as[Option[Geometry]] | ||
| collectionsOption <- c.downField("collections").as[Option[List[String]]] | ||
| itemsOption <- c.downField("items").as[Option[List[String]]] | ||
| limit <- c.downField("limit").as[Option[NonNegInt]] | ||
| query <- c.get[Option[Map[String, List[Query]]]]("query") | ||
| paginationToken <- c.get[Option[PaginationToken]]("next") | ||
| } yield { | ||
| SearchFilters( | ||
| bbox, | ||
| datetime, | ||
| intersects, | ||
| collectionsOption.getOrElse(Nil), | ||
| itemsOption.getOrElse(Nil), | ||
| limit, | ||
| query getOrElse Map.empty, | ||
| paginationToken | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| implicit val searchFilterEncoder: Encoder[SearchFilters] = deriveEncoder | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package com.azavea.stac4s.api.client | ||
|
|
||
| import cats.MonadError | ||
| import sttp.client3.SttpBackend | ||
| import sttp.model.Uri | ||
|
|
||
| object SttpStacClient { | ||
|
|
||
| def apply[F[_]: MonadError[*[_], Throwable]]( | ||
| client: SttpBackend[F, Any], | ||
| baseUri: Uri | ||
| ): SttpStacClient[F] = | ||
| SttpStacClientF.instance[F, SearchFilters](client, baseUri) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| package com.azavea.stac4s.api | ||
|
|
||
| package object client { | ||
| type SttpStacClient[F[_]] = SttpStacClientF.Aux[F, SearchFilters] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package com.azavea.stac4s.api.client | ||
|
|
||
| import com.azavea.stac4s.testing.JsInstances | ||
|
|
||
| import sttp.client3.UriContext | ||
|
|
||
| class SttpStacClientSpec extends SttpStacClientFSpec with JsInstances { | ||
| lazy val client = SttpStacClient(backend, uri"http://localhost:9090") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,51 @@ | ||
| package com.azavea.stac4s.api.client | ||
|
|
||
| import com.azavea.stac4s.Bbox | ||
| import com.azavea.stac4s.api.client.utils.ClientCodecs | ||
| import com.azavea.stac4s.types.TemporalExtent | ||
|
|
||
| import eu.timepit.refined.types.numeric.NonNegInt | ||
| import geotrellis.vector.{io => _, _} | ||
| import io.circe._ | ||
| import io.circe.generic.semiauto._ | ||
| import io.circe.refined._ | ||
|
|
||
| case class SearchFilters( | ||
| bbox: Option[Bbox] = None, | ||
| datetime: Option[TemporalExtent] = None, | ||
| intersects: Option[Geometry] = None, | ||
| collections: List[String] = Nil, | ||
| items: List[String] = Nil, | ||
| limit: Option[NonNegInt] = None, | ||
| query: Map[String, List[Query]] = Map.empty, | ||
| next: Option[PaginationToken] = None | ||
| ) | ||
|
|
||
| object SearchFilters extends ClientCodecs { | ||
|
|
||
| implicit val searchFilterDecoder: Decoder[SearchFilters] = { c => | ||
| for { | ||
| bbox <- c.downField("bbox").as[Option[Bbox]] | ||
| datetime <- c.downField("datetime").as[Option[TemporalExtent]] | ||
| intersects <- c.downField("intersects").as[Option[Geometry]] | ||
| collectionsOption <- c.downField("collections").as[Option[List[String]]] | ||
| itemsOption <- c.downField("items").as[Option[List[String]]] | ||
| limit <- c.downField("limit").as[Option[NonNegInt]] | ||
| query <- c.get[Option[Map[String, List[Query]]]]("query") | ||
| paginationToken <- c.get[Option[PaginationToken]]("next") | ||
| } yield { | ||
| SearchFilters( | ||
| bbox, | ||
| datetime, | ||
| intersects, | ||
| collectionsOption.getOrElse(Nil), | ||
| itemsOption.getOrElse(Nil), | ||
| limit, | ||
| query getOrElse Map.empty, | ||
| paginationToken | ||
| ) | ||
| } | ||
| } | ||
|
|
||
| implicit val searchFilterEncoder: Encoder[SearchFilters] = deriveEncoder | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,14 @@ | ||
| package com.azavea.stac4s.api.client | ||
|
|
||
| import cats.MonadError | ||
| import sttp.client3.SttpBackend | ||
| import sttp.model.Uri | ||
|
|
||
| object SttpStacClient { | ||
|
|
||
| def apply[F[_]: MonadError[*[_], Throwable]]( | ||
| client: SttpBackend[F, Any], | ||
| baseUri: Uri | ||
| ): SttpStacClient[F] = | ||
| SttpStacClientF.instance[F, SearchFilters](client, baseUri) | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,5 @@ | ||
| package com.azavea.stac4s.api | ||
|
|
||
| package object client { | ||
| type SttpStacClient[F[_]] = SttpStacClientF.Aux[F, SearchFilters] | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,9 @@ | ||
| package com.azavea.stac4s.api.client | ||
|
|
||
| import com.azavea.stac4s.testing.JvmInstances | ||
|
|
||
| import sttp.client3.UriContext | ||
|
|
||
| class SttpStacClientSpec extends SttpStacClientFSpec with JvmInstances { | ||
| lazy val client = SttpStacClient(backend, uri"http://localhost:9090") | ||
| } |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,43 @@ | ||
| package com.azavea.stac4s.api.client | ||
|
|
||
| import cats.syntax.either._ | ||
| import eu.timepit.refined.types.numeric.PosInt | ||
| import io.circe | ||
| import io.circe.generic.semiauto._ | ||
| import io.circe.parser.parse | ||
| import io.circe.refined._ | ||
| import io.circe.syntax._ | ||
| import io.circe.{Decoder, Encoder} | ||
|
|
||
| import java.time.Instant | ||
| import java.util.Base64 | ||
|
|
||
| final case class PaginationToken(timestampAtLeast: Instant, serialIdGreaterThan: PosInt) | ||
|
There was a problem hiding this comment. This is correct for Franklin's implementation of pagination, but only for Franklin's -- the particular pagination strategy is left open to implementers. So there are a few things that are a bit weird as a result --
So I think this shouldn't work There was a problem hiding this comment. I'd say this is fine; since it is a default implementation (i.e. if smth doesn't work user can always define theirs own STACClient with a redefined search filters: see https://github.com/azavea/stac4s/blob/7f6abceeebea59dfc9a605891c73fc121116610b/modules/client/jvm/src/main/scala/com/azavea/stac4s/api/client/SttpStacClient.scala#L9-L13 - they only need to define their own version of There was a problem hiding this comment. Opened an issue for that #198 There was a problem hiding this comment. I'm not really talking about streaming here though -- I don't think this pagination encoding will work, and the tests included here don't exercise pagination. Since the pagination implementation here isn't exercised and I think won't work, I think it should just be omitted until someone is working on #198 There was a problem hiding this comment. Oops forgot to push not tested codecs |
||
|
|
||
| /** Circe codecs should encode token into a base64 string | ||
| * https://github.com/azavea/franklin/blob/f5be8ddf48661c5bc43cbd22cb7277e961641803/application/src/main/scala/com/azavea/franklin/api/schemas/package.scala#L84-L85 | ||
| */ | ||
| object PaginationToken { | ||
| val b64Encoder = Base64.getEncoder | ||
| val b64Decoder = Base64.getDecoder | ||
|
|
||
| val defaultDecoder: Decoder[PaginationToken] = deriveDecoder | ||
| val defaultEncoder: Encoder[PaginationToken] = deriveEncoder | ||
|
|
||
| def encPaginationToken(token: PaginationToken): String = b64Encoder.encodeToString( | ||
| token.asJson(defaultEncoder).noSpaces.getBytes | ||
| ) | ||
|
|
||
| def decPaginationToken(encoded: String): Either[circe.Error, PaginationToken] = { | ||
| val jsonString = new String(b64Decoder.decode(encoded)) | ||
| for { | ||
| js <- parse(jsonString) | ||
| decoded <- js.as[PaginationToken](defaultDecoder) | ||
| } yield decoded | ||
| } | ||
|
|
||
| implicit val dec: Decoder[PaginationToken] = | ||
| Decoder.decodeString.emap(str => decPaginationToken(str).leftMap(_.getMessage)) | ||
|
|
||
| implicit val enc: Encoder[PaginationToken] = { encPaginationToken(_).asJson } | ||
| } | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.