Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/t-fowl/ktor-jsoup
Ktor client feature for un-marshalling into Jsoup's Document class
https://github.com/t-fowl/ktor-jsoup
html jsoup kotlin ktor rss xml
Last synced: about 2 months ago
JSON representation
Ktor client feature for un-marshalling into Jsoup's Document class
- Host: GitHub
- URL: https://github.com/t-fowl/ktor-jsoup
- Owner: T-Fowl
- License: mit
- Created: 2019-05-23T12:33:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-08-18T05:10:12.000Z (4 months ago)
- Last Synced: 2024-08-18T06:28:45.080Z (4 months ago)
- Topics: html, jsoup, kotlin, ktor, rss, xml
- Language: Kotlin
- Homepage: https://t-fowl.github.io/ktor-jsoup/
- Size: 982 KB
- Stars: 14
- Watchers: 1
- Forks: 1
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# Ktor: Jsoup
The Jsoup plugin allows you to handle xml and html content in your ktor application easily using the [Jsoup](https://jsoup.org/) library.
This plugin provides a [HttpClientPlugin](https://ktor.io/docs/http-client-plugins.html) which provides a response transformer for the Jsoup [Document](https://jsoup.org/apidocs/org/jsoup/nodes/Document.html) type.
## Usage
Install the plugin in your `HttpClient`
```kotlin
install(JsoupPlugin)
```
You can optionally configure more content types for Jsoup to parse
```kotlin
install(JsoupPlugin) {
parsers[ContentType.Application.Rss] = Parser.xmlParser()
}
```
With the plugin installed you can receive Documents by using `response.body()`.
```kotlin
HttpClient(engine) {
install(JsoupPlugin) {
parsers[ContentType.Application.Rss] = Parser.xmlParser()
}
}.use { client ->
val feed = client.get(url).body()
}
```
## Versions
Compatible / Recommended version pairings between `ktor` and `ktor-jsoup`
| ktor | ktor-jsoup | notes |
|----------|------------|--------------------------------------|
| `1.5.4+` | `1.5.4` | |
| `1.6.3+` | `1.6.4` | |
| `2.0.0+` | `2.0.0` | |
| `2.3.0+` | `2.3.0` | Kotlin `1.8.10` binary compatability |
## Download
Add a gradle dependency to your project:
Groovy
```groovy
repositories {
mavenCentral()
}
implementation "com.tfowl.ktor:ktor-jsoup:$ktorJsoupVersion"
// Recommend overriding ktor & jsoup versions
```
Kotlin DSL
```kotlin
repositories {
mavenCentral()
}
implementation("com.tfowl.ktor:ktor-jsoup:$ktorJsoupVersion")
// Recommend overriding ktor & jsoup versions
```
Add a maven dependency to your project:
```xml
com.tfowl.ktor
ktor-jsoup
${ktorJsoupVersion}
```
## License
```
MIT License
Copyright (c) 2023 Thomas Fowler
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
```