-
Notifications
You must be signed in to change notification settings - Fork 76
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Merge pull request #1484 from adpi2/add-stable-api
Add stable API v1
- Loading branch information
Showing
114 changed files
with
1,902 additions
and
1,654 deletions.
There are no files selected for viewing
This file contains 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
7 changes: 3 additions & 4 deletions
7
modules/core/shared/src/main/scala/scaladex/core/api/AutocompletionParams.scala
This file contains 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
160 changes: 127 additions & 33 deletions
160
modules/core/shared/src/main/scala/scaladex/core/api/Endpoints.scala
This file contains 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 |
|---|---|---|
| @@ -1,61 +1,155 @@ | ||
| package scaladex.core.api | ||
|
|
||
| import scaladex.core.model.Artifact | ||
| import scaladex.core.model.Project | ||
| import endpoints4s.Validated | ||
| import scaladex.core.model._ | ||
|
|
||
| trait Endpoints | ||
| extends JsonSchemas | ||
| with endpoints4s.algebra.Endpoints | ||
| with endpoints4s.algebra.JsonEntitiesFromSchemas { | ||
|
|
||
| val v0 = None | ||
| val v1: Some[String] = Some("v1") | ||
|
|
||
| private val root: Path[Unit] = path / "api" | ||
| private def api(version: Option[String]): Path[Unit] = version.fold(root)(version => root / version) | ||
| private val projectsPath: Path[Unit] = staticPathSegment("projects") | ||
| private val artifactsPath: Path[Unit] = staticPathSegment("artifacts") | ||
|
|
||
| private val organizationSegment: Path[Project.Organization] = | ||
| segment[Project.Organization]("organization")(stringSegment.xmap(Project.Organization(_))(_.value)) | ||
| private val repositorySegment: Path[Project.Repository] = | ||
| segment[Project.Repository]("repository")(stringSegment.xmap(Project.Repository(_))(_.value)) | ||
| private val groupIdSegment: Path[Artifact.GroupId] = | ||
| segment[Artifact.GroupId]("groupId")(stringSegment.xmap(Artifact.GroupId(_))(_.value)) | ||
| private val artifactIdSegment: Path[Artifact.ArtifactId] = | ||
| segment[Artifact.ArtifactId]("artifactId")(stringSegment.xmap(Artifact.ArtifactId(_))(_.value)) | ||
| private val versionSegment: Path[Version] = segment[Version]("version")(stringSegment.xmap(Version(_))(_.value)) | ||
|
|
||
| private val projectPath: Path[Project.Reference] = | ||
| (segment[String]("organization") / segment[String]("repository")) | ||
| .xmap { case (org, repo) => Project.Reference.from(org, repo) }(ref => | ||
| (ref.organization.value, ref.repository.value) | ||
| ) | ||
|
|
||
| private val artifactPath: Path[Artifact.MavenReference] = | ||
| (segment[String]("groupId") / segment[String]("artifactId") / segment[String]("version")) | ||
| .xmap { case (groupId, artifactId, version) => Artifact.MavenReference(groupId, artifactId, version) }(ref => | ||
| (ref.groupId, ref.artifactId, ref.version) | ||
| ) | ||
|
|
||
| private val autocompletionQueryString: QueryString[AutocompletionParams] = ( | ||
| (projectsPath / organizationSegment / repositorySegment) | ||
| .xmap((Project.Reference.apply _).tupled)(Function.unlift(Project.Reference.unapply)) | ||
|
|
||
| private val projectVersionsPath: Path[Project.Reference] = projectPath / "versions" | ||
| private val projectArtifactsPath: Path[Project.Reference] = projectPath / "artifacts" | ||
|
|
||
| private val artifactPath: Path[Artifact.Reference] = | ||
| (artifactsPath / groupIdSegment / artifactIdSegment / versionSegment) | ||
| .xmap((Artifact.Reference.apply _).tupled)(Function.unlift(Artifact.Reference.unapply)) | ||
|
|
||
| private implicit val platformQueryString: QueryStringParam[Platform] = stringQueryString | ||
| .xmapPartial(v => Validated.fromOption(Platform.parse(v))(s"Cannot parse $v"))(_.value) | ||
| private implicit val languageQueryString: QueryStringParam[Language] = stringQueryString | ||
| .xmapPartial(v => Validated.fromOption(Language.parse(v))(s"Cannot parse $v"))(_.value) | ||
| private implicit val binaryVersionQueryString: QueryStringParam[BinaryVersion] = stringQueryString | ||
| .xmapPartial(v => Validated.fromOption(BinaryVersion.parse(v))(s"Cannot parse $v"))(_.value) | ||
|
|
||
| private val languageFilters = qs[Seq[Language]]( | ||
| "language", | ||
| qsDoc("Filter on language versions", Seq("3", "2.13", "2.12", "2.11", "java")) | ||
| ) | ||
|
|
||
| private val platformFilters = qs[Seq[Platform]]( | ||
| "platform", | ||
| qsDoc("Filter on platform versions", Seq("jvm", "sjs1", "native0.5", "sbt1.0", "mill0.11")) | ||
| ) | ||
|
|
||
| private val binaryVersionFilters: QueryString[Seq[BinaryVersion]] = | ||
| qs( | ||
| "binary-version", | ||
| qsDoc("Filter on binary versions", Seq("_2.13", "_3", "_sjs1_3", "_2.12_1.0", "_mill0.11_2.13")) | ||
| ) | ||
|
|
||
| private val binaryVersionFilter: QueryString[Option[BinaryVersion]] = | ||
| qs[Option[BinaryVersion]]( | ||
| "binary-version", | ||
| qsDoc("Filter on binary version", Seq("_2.13", "_3", "_sjs1_3", "_2.12_1.0", "_mill0.11_2.13")) | ||
| ) | ||
|
|
||
| private val artifactNameFilters = qs[Seq[String]]( | ||
| "artifact-name", | ||
| qsDoc("Filter on artifact names", Seq("cats-core", "cats-free")) | ||
| ).xmap(_.map(Artifact.Name.apply))(_.map(_.value)) | ||
|
|
||
| private val artifactNameFilter = qs[Option[String]]( | ||
| "artifact-name", | ||
| qsDoc("Filter on artifact name", Seq("cats-core", "cats-free")) | ||
| ).xmap(_.map(Artifact.Name.apply))(_.map(_.value)) | ||
|
|
||
| private val stableOnlyFilter = | ||
| qs[Option[Boolean]]("stable-only", Some("Keep only stable versions. (Default is true)")) | ||
| .xmap(o => o.getOrElse(true))(b => Option.when(!b)(b)) | ||
|
|
||
| private val projectsParams: QueryString[ProjectsParams] = | ||
| (languageFilters & platformFilters) | ||
| .xmap((ProjectsParams.apply _).tupled)(Function.unlift(ProjectsParams.unapply)) | ||
|
|
||
| private val projectVersionsParams: QueryString[ProjectVersionsParams] = | ||
| (binaryVersionFilters & artifactNameFilters & stableOnlyFilter) | ||
| .xmap((ProjectVersionsParams.apply _).tupled)(Function.unlift(ProjectVersionsParams.unapply)) | ||
|
|
||
| private val projectArtifactsParams: QueryString[ProjectArtifactsParams] = | ||
| (binaryVersionFilter & artifactNameFilter & stableOnlyFilter) | ||
| .xmap((ProjectArtifactsParams.apply _).tupled)(Function.unlift(ProjectArtifactsParams.unapply)) | ||
|
|
||
| private val autocompletionParams: QueryString[AutocompletionParams] = ( | ||
| qs[String]("q", docs = Some("Main query (e.g., 'json', 'testing', etc.)")) & | ||
| qs[Seq[String]]("topics", docs = Some("Filter on Github topics")) & | ||
| qs[Seq[String]]( | ||
| "languages", | ||
| docs = Some("Filter on language versions (e.g., '3', '2.13', '2.12', '2.11', 'java')") | ||
| ) & | ||
| qs[Seq[String]]( | ||
| "platforms", | ||
| docs = Some("Filter on runtime platforms (e.g., 'jvm', 'sjs1', 'native0.4', 'sbt1.0')") | ||
| ) & | ||
| qs[Seq[String]]("topic", docs = Some("Filter on Github topics")) & | ||
| languageFilters & | ||
| platformFilters & | ||
| qs[Option[Boolean]]("contributingSearch").xmap(_.getOrElse(false))(Option.when(_)(true)) & | ||
| qs[Option[String]]("you", docs = Some("internal usage")).xmap[Boolean](_.contains("✓"))(Option.when(_)("✓")) | ||
| ).xmap((AutocompletionParams.apply _).tupled)(Function.unlift(AutocompletionParams.unapply)) | ||
|
|
||
| val listProjects: Endpoint[Unit, Seq[Project.Reference]] = | ||
| def getProjects(v: Option[String]): Endpoint[ProjectsParams, Seq[Project.Reference]] = | ||
| endpoint( | ||
| get(path / "api" / "projects"), | ||
| get(api(v) / projectsPath /? projectsParams), | ||
| ok(jsonResponse[Seq[Project.Reference]]) | ||
| ) | ||
|
|
||
| val listProjectArtifacts: Endpoint[Project.Reference, Seq[Artifact.MavenReference]] = | ||
| val getProjectV1: Endpoint[Project.Reference, Option[ProjectResponse]] = | ||
| endpoint(get(api(v1) / projectPath), ok(jsonResponse[ProjectResponse]).orNotFound()) | ||
|
|
||
| val getProjectVersionsV1: Endpoint[(Project.Reference, ProjectVersionsParams), Seq[Version]] = | ||
| endpoint(get(api(v1) / projectVersionsPath /? projectVersionsParams), ok(jsonResponse[Seq[Version]])) | ||
|
|
||
| val getLatestProjectVersionV1: Endpoint[Project.Reference, Seq[Artifact.Reference]] = | ||
| endpoint(get(api(v1) / projectVersionsPath / "latest"), ok(jsonResponse[Seq[Artifact.Reference]])) | ||
|
|
||
| val getProjectVersionV1: Endpoint[(Project.Reference, Version), Seq[Artifact.Reference]] = | ||
| endpoint(get(api(v1) / projectVersionsPath / versionSegment), ok(jsonResponse[Seq[Artifact.Reference]])) | ||
|
|
||
| def getProjectArtifacts( | ||
| v: Option[String] | ||
| ): Endpoint[(Project.Reference, ProjectArtifactsParams), Seq[Artifact.Reference]] = | ||
| endpoint( | ||
| get(api(v) / projectArtifactsPath /? projectArtifactsParams), | ||
| ok(jsonResponse[Seq[Artifact.Reference]]) | ||
| ) | ||
|
|
||
| def getArtifactVersions( | ||
| v: Option[String] | ||
| ): Endpoint[(Artifact.GroupId, Artifact.ArtifactId, Boolean), Seq[Version]] = | ||
| endpoint( | ||
| get(path / "api" / "projects" / projectPath / "artifacts"), | ||
| ok(jsonResponse[Seq[Artifact.MavenReference]]) | ||
| get(api(v) / artifactsPath / groupIdSegment / artifactIdSegment /? stableOnlyFilter), | ||
| ok(jsonResponse[Seq[Version]]) | ||
| ) | ||
|
|
||
| val getArtifact: Endpoint[Artifact.MavenReference, Option[ArtifactResponse]] = | ||
| def getLatestArtifactV1: Endpoint[(Artifact.GroupId, Artifact.ArtifactId), Option[ArtifactResponse]] = | ||
| endpoint( | ||
| get(path / "api" / "artifacts" / artifactPath), | ||
| get(api(v1) / artifactsPath / groupIdSegment / artifactIdSegment / "latest"), | ||
| ok(jsonResponse[ArtifactResponse]).orNotFound() | ||
| ) | ||
|
|
||
| def getArtifact(v: Option[String]): Endpoint[Artifact.Reference, Option[ArtifactResponse]] = | ||
| endpoint(get(api(v) / artifactPath), ok(jsonResponse[ArtifactResponse]).orNotFound()) | ||
|
|
||
| val autocomplete: Endpoint[AutocompletionParams, Seq[AutocompletionResponse]] = | ||
| endpoint( | ||
| get(path / "api" / "autocomplete" /? autocompletionQueryString), | ||
| ok(jsonResponse[Seq[AutocompletionResponse]]) | ||
| endpoint(get(root / "autocomplete" /? autocompletionParams), ok(jsonResponse[Seq[AutocompletionResponse]])) | ||
|
|
||
| private def qsDoc(desc: String, examples: Seq[String]): Some[String] = | ||
| Some( | ||
| s"""|$desc. | ||
| |Examples: ${examples.mkString(", ")}""".stripMargin | ||
| ) | ||
| } |
This file contains 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
10 changes: 10 additions & 0 deletions
10
modules/core/shared/src/main/scala/scaladex/core/api/ProjectArtifactsParams.scala
This file contains 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,10 @@ | ||
| package scaladex.core.api | ||
|
|
||
| import scaladex.core.model.Artifact | ||
| import scaladex.core.model.BinaryVersion | ||
|
|
||
| final case class ProjectArtifactsParams( | ||
| binaryVersion: Option[BinaryVersion], | ||
| artifactName: Option[Artifact.Name], | ||
| stableOnly: Boolean | ||
| ) |
3 changes: 0 additions & 3 deletions
3
modules/core/shared/src/main/scala/scaladex/core/api/ProjectParams.scala
This file was deleted.
Oops, something went wrong.
Oops, something went wrong.