erik/isgd-shorten
erik/isgd-shorten
1
1
Fork 0
Code Issues Pull requests Releases Activity

Reworked config builder.

Browse source 
Added parameters' documentation.
This commit is contained in:
Erik C. Thauvin 2024-05-25 21:14:15 -07:00
parent f0b7902cab
commit cfa49e7e3e
Signed by: erik
GPG key ID: 776702A6A2DA330E
7 changed files with 109 additions and 36 deletions
Download patch file Download diff file Expand all files Collapse all files

98
src/main/kotlin/net/thauvin/erik/isgd/Config.kt
View file

@ -34,41 +34,83 @@ package net.thauvin.erik.isgd
/**
* Provides a builder to create/lookup an is.gd shortlink.
*/
class Config private constructor(
val url: String,
val shorturl: String,
val callback: String,
val logstats: Boolean,
val format: Format,
val isVgd: Boolean
class Config(
var url: String = "",
var shorturl: String = "",
var callback: String = "",
var logstats: Boolean = false,
var format: Format = Format.SIMPLE,
var isVgd: Boolean = false
) {
constructor(builder: Builder) : this() {
url = builder.url
shorturl = builder.shorturl
callback = builder.callback
logstats = builder.logstats
format = builder.format
isVgd = builder.isVgd
}
/**
* Configures the parameters to create/lookup an is.gd shortlink.
*
* See the [is.gd API](https://is.gd/apishorteningreference.php).
* See the [is.gd Shortening](https://is.gd/apishorteningreference.php) or
* [is.gd Lookup](https://is.gd/apilookupreference.php) APIs.
*/
data class Builder(
private var url: String = "",
private var shorturl: String = "",
private var callback: String = "",
private var logstats: Boolean = false,
private var format: Format = Format.SIMPLE,
private var isVgd: Boolean = false
var url: String = "",
var shorturl: String = "",
var callback: String = "",
var logstats: Boolean = false,
var format: Format = Format.SIMPLE,
var isVgd: Boolean = false
) {
fun url(url: String) = apply { this.url = url }
fun shortUrl(shortUrl: String) = apply { this.shorturl = shortUrl }
fun callback(callback: String) = apply { this.callback = callback }
fun logStats(logStats: Boolean) = apply { this.logstats = logStats }
fun format(format: Format) = apply { this.format = format }
fun isVgd(isVgd: Boolean) = apply { this.isVgd = isVgd }
/**
* The url parameter is the address that you want to shorten.
*/
fun url(url: String): Builder = apply { this.url = url }
fun build() = Config(
url,
shorturl,
callback,
logstats,
format,
isVgd
)
/**
* You can specify the shorturl parameter if you'd like to pick a shortened URL instead of
* having is.gd randomly generate one. These must be between 5 and 30 characters long and can only contain
* alphanumeric characters and underscores. Shortened URLs are case sensitive. Bear in mind that a desired
* short URL might already be taken (this is very often the case with common words) so if you're using this
* option be prepared to respond to an error and get an alternative choice from your app's user.
*/
fun shortUrl(shortUrl: String): Builder = apply { this.shorturl = shortUrl }
/**
* The callback parameter is used to specify a callback function to wrap the returned data in
* when using JSON format. This can be useful when working with cross domain data. Even when using JSON format
* this parameter is optional.
*/
fun callback(callback: String): Builder = apply { this.callback = callback }
/**
* Turns on logging of detailed statistics when the shortened URL you create is accessed. This
* allows you to see how many times the link was accessed on a given day, what pages referred people to the
* link, what browser visitors were using etc. You can access these stats via the link preview page for your
* shortened URL (add a hyphen/dash to the end of the shortened URL to get to it). Creating links with
* statistics turned on has twice the "cost" towards our rate limit of other shortened links, so leave this
* parameter out of your API call if you don't require statistics on usage. See the
* [usage limits page](https://is.gd/usagelimits.php) for more information on this.
*/
fun logStats(logStats: Boolean): Builder = apply { this.logstats = logStats }
/**
* The format parameter determines what format is.gd uses to send output back to you (e.g. to
* tell you what your new shortened URL is or if an error has occurred).
*/
fun format(format: Format): Builder = apply { this.format = format }
/**
* Shorten using the `v.gd` domain.
*/
fun isVgd(isVgd: Boolean): Builder = apply { this.isVgd = isVgd }
/**
* Builds a new configuration.
*/
fun build() = Config(this)
}
}

30
src/main/kotlin/net/thauvin/erik/isgd/Isgd.kt
View file

@ -88,6 +88,16 @@ class Isgd private constructor() {
* Lookup a shortlink.
*
* See the [is.gd API](https://is.gd/apilookupreference.php).
*
* @param The shorturl parameter is the shortened is.gd URL that you want to look up. You can either submit the
* full address (e.g. https://is.gd/example) or only the unique part (e.g. example). The address you submit
* should be properly formed; the API lookup function is not guaranteed to handle malformed URLs the same way as when you visit them manually.
* @param callback The callback parameter is used to specify a callback function to wrap the returned data in
* when using JSON format. This can be useful when working with cross domain data. Even when using JSON format
* this parameter is optional.
* @param format The format parameter determines what format is.gd uses to send output back to you (e.g. to
* tell you what your new shortened URL is or if an error has occurred).
* @param isVgd Lookup using the `v.gd` domain.
*/
@JvmStatic
@JvmOverloads
@ -133,6 +143,26 @@ class Isgd private constructor() {
* Shortens a link.
*
* See the [is.gd API](https://is.gd/apishorteningreference.php).
*
* @param url The url parameter is the address that you want to shorten.
* @param shorturl You can specify the shorturl parameter if you'd like to pick a shortened URL instead of
* having is.gd randomly generate one. These must be between 5 and 30 characters long and can only contain
* alphanumeric characters and underscores. Shortened URLs are case sensitive. Bear in mind that a desired
* short URL might already be taken (this is very often the case with common words) so if you're using this
* option be prepared to respond to an error and get an alternative choice from your app's user.
* @param callback The callback parameter is used to specify a callback function to wrap the returned data in
* when using JSON format. This can be useful when working with cross domain data. Even when using JSON format
* this parameter is optional.
* @param logstats Turns on logging of detailed statistics when the shortened URL you create is accessed. This
* allows you to see how many times the link was accessed on a given day, what pages referred people to the
* link, what browser visitors were using etc. You can access these stats via the link preview page for your
* shortened URL (add a hyphen/dash to the end of the shortened URL to get to it). Creating links with
* statistics turned on has twice the "cost" towards our rate limit of other shortened links, so leave this
* parameter out of your API call if you don't require statistics on usage. See the
* [usage limits page](https://is.gd/usagelimits.php) for more information on this.
* @param format The format parameter determines what format is.gd uses to send output back to you (e.g. to
* tell you what your new shortened URL is or if an error has occurred).
* @param isVgd Shorten using the `v.gd` domain.
*/
@JvmStatic
@JvmOverloads