-
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.
`GET /api/projects` to get the lists of all project references, except the ones that are moved or deleted on Github. `GET /api/projects/<org>/<repo>/artifacts` to get the lists of artifact refs of a project. `GET /api/artifacts/<groupid>/<artifactid>/<version>` to get some info about an artifact (language, platform, licenses, release date etc). There are no filter anymore. Later we can (re-)introduce the `language` and `platform` filters. There is no pagination and I don't plan on working on it.
- Loading branch information
Showing
37 changed files
with
322 additions
and
495 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
35 changes: 35 additions & 0 deletions
35
modules/core/shared/src/main/scala/scaladex/core/api/ArtifactResponse.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,35 @@ | ||
package scaladex.core.api | ||
|
||
import scaladex.core.model.Artifact | ||
import scaladex.core.model.SemanticVersion | ||
import scaladex.core.model.Project | ||
import java.time.Instant | ||
import scaladex.core.model.License | ||
import scaladex.core.model.Platform | ||
import scaladex.core.model.Language | ||
|
||
final case class ArtifactResponse( | ||
groupId: Artifact.GroupId, | ||
artifactId: String, | ||
version: SemanticVersion, | ||
artifactName: Artifact.Name, | ||
project: Project.Reference, | ||
releaseDate: Instant, | ||
licenses: Seq[License], | ||
language: Language, | ||
platform: Platform | ||
) | ||
|
||
object ArtifactResponse { | ||
def apply(artifact: Artifact): ArtifactResponse = ArtifactResponse( | ||
artifact.groupId, | ||
artifact.artifactId, | ||
artifact.version, | ||
artifact.artifactName, | ||
artifact.projectRef, | ||
artifact.releaseDate, | ||
artifact.licenses.toSeq, | ||
artifact.language, | ||
artifact.platform | ||
) | ||
} |
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
61 changes: 61 additions & 0 deletions
61
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 |
---|---|---|
@@ -0,0 +1,61 @@ | ||
package scaladex.core.api | ||
|
||
import scaladex.core.model.Project | ||
import scaladex.core.model.Artifact | ||
|
||
trait Endpoints | ||
extends JsonSchemas | ||
with endpoints4s.algebra.Endpoints | ||
with endpoints4s.algebra.JsonEntitiesFromSchemas { | ||
|
||
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] = ( | ||
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[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]] = | ||
endpoint( | ||
get(path / "api" / "projects"), | ||
ok(jsonResponse[Seq[Project.Reference]]) | ||
) | ||
|
||
val listProjectArtifacts: Endpoint[Project.Reference, Seq[Artifact.MavenReference]] = | ||
endpoint( | ||
get(path / "api" / "projects" / projectPath / "artifacts"), | ||
ok(jsonResponse[Seq[Artifact.MavenReference]]) | ||
) | ||
|
||
val getArtifact: Endpoint[Artifact.MavenReference, Option[ArtifactResponse]] = | ||
endpoint( | ||
get(path / "api" / "artifacts" / artifactPath), | ||
ok(jsonResponse[ArtifactResponse]).orNotFound() | ||
) | ||
|
||
val autocomplete: Endpoint[AutocompletionParams, Seq[AutocompletionResponse]] = | ||
endpoint( | ||
get(path / "api" / "autocomplete" /? autocompletionQueryString), | ||
ok(jsonResponse[Seq[AutocompletionResponse]]) | ||
) | ||
} |
50 changes: 50 additions & 0 deletions
50
modules/core/shared/src/main/scala/scaladex/core/api/JsonSchemas.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,50 @@ | ||
package scaladex.core.api | ||
|
||
import scaladex.core.model.Artifact | ||
import scaladex.core.model.SemanticVersion | ||
import scaladex.core.model.Project | ||
import java.time.Instant | ||
import scaladex.core.model.License | ||
import scaladex.core.model.Language | ||
import scaladex.core.model.Platform | ||
|
||
/** | ||
* The Json schema of the Scaladex API | ||
*/ | ||
trait JsonSchemas extends endpoints4s.algebra.JsonSchemas { | ||
implicit val projectReferenceSchema: JsonSchema[Project.Reference] = | ||
field[String]("organization") | ||
.zip(field[String]("repository")) | ||
.xmap(Function.tupled(Project.Reference.from(_, _)))(ref => (ref.organization.value, ref.repository.value)) | ||
|
||
implicit val mavenReferenceSchema: JsonSchema[Artifact.MavenReference] = | ||
field[String]("groupId") | ||
.zip(field[String]("artifactId")) | ||
.zip(field[String]("version")) | ||
.xmap(Function.tupled(Artifact.MavenReference.apply _))(Function.unlift(Artifact.MavenReference.unapply)) | ||
|
||
implicit val getArtifactResponseSchema: JsonSchema[ArtifactResponse] = | ||
field[String]("groupId").xmap(Artifact.GroupId.apply)(_.value) | ||
.zip(field[String]("artifactId")) | ||
.zip(field[String]("version").xmap(SemanticVersion.from)(_.encode)) | ||
.zip(field[String]("artifactName").xmap(Artifact.Name.apply)(_.value)) | ||
.zip(field[String]("project").xmap(Project.Reference.from)(_.toString)) | ||
.zip(field[Long]("releaseDate").xmap(Instant.ofEpochMilli)(_.toEpochMilli)) | ||
.zip(field[Seq[String]]("licenses").xmap(_.flatMap(License.get))(_.map(_.shortName))) | ||
.zip(field[String]("language").xmap(Language.fromLabel(_).get)(_.label)) | ||
.zip(field[String]("platform").xmap(Platform.fromLabel(_).get)(_.label)) | ||
.xmap { | ||
case (groupId, artifactId, version, artifactName, project, releaseDate, licenses, language, platform) => | ||
ArtifactResponse(groupId, artifactId, version, artifactName, project, releaseDate, licenses, language, platform) | ||
} (Function.unlift(ArtifactResponse.unapply)) | ||
|
||
implicit val autocompletionResponseSchema: JsonSchema[AutocompletionResponse] = | ||
field[String]("organization") | ||
.zip(field[String]("repository")) | ||
.zip(field[String]("description")) | ||
.xmap[AutocompletionResponse] { | ||
case (organization, repository, description) => AutocompletionResponse(organization, repository, description) | ||
} { autocompletionResponse => | ||
(autocompletionResponse.organization, autocompletionResponse.repository, autocompletionResponse.description) | ||
} | ||
} |
25 changes: 0 additions & 25 deletions
25
modules/core/shared/src/main/scala/scaladex/core/api/PaginationSchema.scala
This file was deleted.
Oops, something went wrong.
3 changes: 3 additions & 0 deletions
3
modules/core/shared/src/main/scala/scaladex/core/api/ProjectParams.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,3 @@ | ||
package scaladex.core.api | ||
|
||
final case class ProjectParams(language: Option[String], platform: Option[String]) |
45 changes: 0 additions & 45 deletions
45
modules/core/shared/src/main/scala/scaladex/core/api/SearchEndpoints.scala
This file was deleted.
Oops, something went wrong.
23 changes: 0 additions & 23 deletions
23
modules/core/shared/src/main/scala/scaladex/core/api/artifact/ArtifactEndpointSchema.scala
This file was deleted.
Oops, something went wrong.
45 changes: 0 additions & 45 deletions
45
modules/core/shared/src/main/scala/scaladex/core/api/artifact/ArtifactEndpoints.scala
This file was deleted.
Oops, something went wrong.
3 changes: 0 additions & 3 deletions
3
modules/core/shared/src/main/scala/scaladex/core/api/artifact/ArtifactMetadataParams.scala
This file was deleted.
Oops, something went wrong.
9 changes: 0 additions & 9 deletions
9
modules/core/shared/src/main/scala/scaladex/core/api/artifact/ArtifactMetadataResponse.scala
This file was deleted.
Oops, something went wrong.
3 changes: 0 additions & 3 deletions
3
modules/core/shared/src/main/scala/scaladex/core/api/artifact/ArtifactParams.scala
This file was deleted.
Oops, something went wrong.
3 changes: 0 additions & 3 deletions
3
modules/core/shared/src/main/scala/scaladex/core/api/artifact/ArtifactResponse.scala
This file was deleted.
Oops, something went wrong.
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
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
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
Oops, something went wrong.