Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rustedbones/capturl
Scala/Java library for Internationalized Resource Identifier (IRIs) support
https://github.com/rustedbones/capturl
internationalization iri java punycode scala unicode uri url
Last synced: 26 days ago
JSON representation
Scala/Java library for Internationalized Resource Identifier (IRIs) support
- Host: GitHub
- URL: https://github.com/rustedbones/capturl
- Owner: RustedBones
- License: apache-2.0
- Created: 2019-02-02T09:40:56.000Z (almost 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-09T21:59:19.000Z (almost 4 years ago)
- Last Synced: 2024-04-22T13:08:31.233Z (7 months ago)
- Topics: internationalization, iri, java, punycode, scala, unicode, uri, url
- Language: Scala
- Homepage:
- Size: 159 KB
- Stars: 2
- Watchers: 4
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# capturl
[](https://github.com/RustedBones/capturl/actions?query=branch%3Amaster+workflow%3A"Continuous+Integration")
[](https://maven-badges.herokuapp.com/maven-central/fr.davit/capturl_2.12)
[](LICENSE)
Capturl is a Scala/Java library that provide parsers and models to work with Internationalized Resource Identifier aka
[IRIs](https://en.wikipedia.org/wiki/Internationalized_Resource_Identifier).
The implementation is strongly inspired by the great [`akka-http`](https://github.com/akka/akka-http)
[Uri model](https://doc.akka.io/docs/akka-http/current/common/uri-model.html) with modularity and simplicity in mind.
## Setup
Add to your `build.sbt`:
```scala
libraryDependencies += "fr.davit" %% "capturl" % ""
```
## Parsers
All the `apply`/`create` methods accepting String input will be validated against
[RFC 3987](https://tools.ietf.org/rfc/rfc3987.txt) compliant parsers to create the model classes.
**Warning**: Exception is made for spaces in path, query and fragment which are allowed at the moment (see TODOs)
If you are sure about your input, and want to skip validation for efficiency reason, you can construct the models
using the implementation classes. eg:
```scala
Scheme("b@d_scheme") // throws a parsing exception
Scheme.Protocol("b@d_scheme") // this is very wrong but will create your scheme
```
## Normalization
Those are the IRI normalization steps:
- Scheme
- lower case normalization
- Hosts
- NamedHost are lower cased and decoded (punycode)
- IPv4 and [IPv6](https://tools.ietf.org/html/rfc5952#section-4) are normalized
- Path
- collapse current folder
- collapse parent folder
- Query
- spaces are replaced by '+'
- Iri
- omit custom port if matches the scheme default port
- root path is added for absolute / host relative iris
- default port is hidden
- General
- all encoded characters are decoded
### IRI string interpolation
Add to your `build.sbt`:
```scala
libraryDependencies += "fr.davit" %% "capturl-contextual" %
```
This sub module provides compile time string interpolation to create IRIs:
```scala
val iri = iri"http://localhost:8080/path?key#identifier"
```
If iri string is not valid, the scala compiler will notify you:
```scala
val iri = iri"http://user{[email protected]/"
```
```
[error] Invalid IRI http://user{[email protected]/
[error] iri"http://user{[email protected]/"
[error] ^
[error] one error found
```
### TODO
- provide strict / relax parser mode
- provide more normalization options
- support holes in interpolation
## capturl-akka-http
Add to your `build.sbt`:
```scala
libraryDependencies += "fr.davit" %% "capturl-akka-http" %
```
This sub module provides all the necessary implicits in [`UriConverters`](/src/main/scala/fr/davit/capturl/akka/http/UriConverters.scala)
to go from an `Iri` to the akka `Uri` model.
### TODO
- provide converters for akka-http javadsl model