fcannizzaro/ksoup

Kotlin Wrapper for Jsoup

ksoup

Kotlin Wrapper for Jsoup using Pojo and Delegated Properties

Gradle Dependency

Step 1.

Add the JitPack repository to your build file

allprojects {
  repositories {
    ...
    maven { url 'https://jitpack.io' }
  }
}

Step 2.

Add the dependency

dependencies {
  compile 'com.github.fcannizzaro:ksoup:1.0.4'
}

Usage

val html = Jsoup.connect("https://www.npmjs.com/").get()
val ksoup = Ksoup(html)

/*
*  Scrape!
*/

val npm : NPM = ksoup.from(html, NPM())

// or

val packages: List<Package> = ksoup.fromList(html, Package())

See Sample Code

Model

IKsoup([query: String])

afterBind

method called after object binding is completed.

class Package : IKsoup(".item") {

  // properties

  override fun afterBind() {
    // called after object binding is completed.
  }

}

Delegated Methods

trim param is always true

bindText(query: String, [trim: Boolean]) : String?

val title by bindText("head > title")

bindImage(query: String, [trim: Boolean]) : String?

val image by bindImage(".icon")

bindLink(query: String, [trim: Boolean]) : String?

val link by bindLink("a")

bindAttr(query: String, attr: String | KAttr, [trim: Boolean]) : String?

val checked by bindAttr("form > checkbox", KAttr.checked)

bindList(clazz: IKsoup) : List

val items : List<Package> by bindList(Package())

bindClass(clazz: IKsoup, parent: IKsoup) : T

class Package : IKsoup(".item") {

  class Info : IKsoup(".subitem") {
    // Info properties
  }

  // Package properties

  val info: Info by bindClass(Info(), this)

}

Author

Francesco Saverio Cannizzaro (fcannizzaro)

License

Copyright 2017 Francesco Saverio Cannizzaro

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.