{"id":27876895,"url":"https://github.com/ethauvin/isgd-shorten","last_synced_at":"2025-08-31T12:08:26.927Z","repository":{"id":57737834,"uuid":"249098055","full_name":"ethauvin/isgd-shorten","owner":"ethauvin","description":"is.gd Shortner for Kotlin, Java \u0026 Android","archived":false,"fork":false,"pushed_at":"2025-07-11T18:44:26.000Z","size":694,"stargazers_count":2,"open_issues_count":0,"forks_count":1,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-07-26T11:35:33.080Z","etag":null,"topics":["android","isgd","java","kotlin","library","shorten","shorten-links","shorten-urls","shortener","shortener-service","shorturl","url-shortener","vgd"],"latest_commit_sha":null,"homepage":"","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"bsd-3-clause","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/ethauvin.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2020-03-22T02:23:01.000Z","updated_at":"2025-07-11T18:44:31.000Z","dependencies_parsed_at":"2023-11-12T09:22:46.921Z","dependency_job_id":"3f2e16b5-9f28-42f8-a66c-ac5b604415ad","html_url":"https://github.com/ethauvin/isgd-shorten","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"purl":"pkg:github/ethauvin/isgd-shorten","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethauvin%2Fisgd-shorten","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethauvin%2Fisgd-shorten/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethauvin%2Fisgd-shorten/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethauvin%2Fisgd-shorten/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/ethauvin","download_url":"https://codeload.github.com/ethauvin/isgd-shorten/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/ethauvin%2Fisgd-shorten/sbom","scorecard":{"id":383874,"data":{"date":"2025-08-11","repo":{"name":"github.com/ethauvin/isgd-shorten","commit":"dce566447f5eb2b07166354cb4b7bfe8ca654018"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.6,"checks":[{"name":"Maintained","score":5,"reason":"6 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 5","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Code-Review","score":0,"reason":"Found 0/30 approved changesets -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/bld.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"SAST","score":0,"reason":"no SAST tool detected","details":["Warn: no pull requests merged into dev branch"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bld.yml:21: update your workflow using https://app.stepsecurity.io/secureworkflow/ethauvin/isgd-shorten/bld.yml/master?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/bld.yml:26: update your workflow using https://app.stepsecurity.io/secureworkflow/ethauvin/isgd-shorten/bld.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/bld.yml:32: update your workflow using https://app.stepsecurity.io/secureworkflow/ethauvin/isgd-shorten/bld.yml/master?enable=pin","Warn: third-party GitHubAction not pinned by hash: .github/workflows/bld.yml:67: update your workflow using https://app.stepsecurity.io/secureworkflow/ethauvin/isgd-shorten/bld.yml/master?enable=pin","Info:   0 out of   2 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   2 third-party GitHubAction dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Binary-Artifacts","score":7,"reason":"binaries present in source code","details":["Warn: binary detected: examples/bld/lib/bld/bld-wrapper.jar:1","Warn: binary detected: examples/gradle/gradle/wrapper/gradle-wrapper.jar:1","Warn: binary detected: lib/bld/bld-wrapper.jar:1"],"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: BSD 3-Clause \"New\" or \"Revised\" License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Vulnerabilities","score":10,"reason":"0 existing vulnerabilities detected","details":null,"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-18T16:07:46.997Z","repository_id":57737834,"created_at":"2025-08-18T16:07:46.997Z","updated_at":"2025-08-18T16:07:46.997Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":272977054,"owners_count":25025049,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-08-31T02:00:09.071Z","response_time":79,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","isgd","java","kotlin","library","shorten","shorten-links","shorten-urls","shortener","shortener-service","shorturl","url-shortener","vgd"],"created_at":"2025-05-05T02:53:36.150Z","updated_at":"2025-08-31T12:08:26.908Z","avatar_url":"https://github.com/ethauvin.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![License (3-Clause BSD)](https://img.shields.io/badge/license-BSD%203--Clause-blue.svg?style=flat-square)](https://opensource.org/licenses/BSD-3-Clause)\n[![Kotlin](https://img.shields.io/badge/kotlin-2.2.0-7f52ff)](https://kotlinlang.org/)\n[![bld](https://img.shields.io/badge/2.3.0-FA9052?label=bld\u0026labelColor=2392FF)](https://rife2.com/bld)\n[![release](https://img.shields.io/github/release/ethauvin/isgd-shorten.svg)](https://github.com/ethauvin/isgd-shorten/releases/latest)\n[![Maven Central](https://img.shields.io/maven-central/v/net.thauvin.erik/isgd-shorten.svg?color=blue)](https://central.sonatype.com/artifact/net.thauvin.erik/isgd-shorten)\n[![Maven metadata URL](https://img.shields.io/maven-metadata/v?metadataUrl=https%3A%2F%2Fcentral.sonatype.com%2Frepository%2Fmaven-snapshots%2Fnet%2Fthauvin%2Ferik%2Fisgd-shorten%2Fmaven-metadata.xml\u0026label=snapshot)](https://github.com/ethauvin/isgd-shorten/packages/2260776/versions)\n\n\n[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=ethauvin_isgd-shorten\u0026metric=alert_status)](https://sonarcloud.io/dashboard?id=ethauvin_isgd-shorten)\n[![GitHub CI](https://github.com/ethauvin/isgd-shorten/actions/workflows/bld.yml/badge.svg)](https://github.com/ethauvin/isgd-shorten/actions/workflows/bld.yml)\n[![CircleCI](https://circleci.com/gh/ethauvin/isgd-shorten/tree/master.svg?style=shield)](https://circleci.com/gh/ethauvin/isgd-shorten/tree/master)\n\n# [is.gd](https://is.gd/developers.php) Shortener for Kotlin, Java \u0026 Android\n\nA simple implementation of the [is.gd](https://is.gd/) URL shortening and lookup [APIs](https://is.gd/developers.php).\n\n## Examples (TL;DR)\n\n```kotlin\nimport net.thauvin.erik.isgd.Isgd\n\n// ...\n\nIsgd.shorten(\"https://www.example.com/\") // returns https://is.gd/Pt2sET\nIsgd.lookup(\"https://is.gd/Pt2sET\") // returns https://www.example.com\n\n```\n\n- View [bld](https://github.com/ethauvin/isgd-shorten/blob/master/examples/bld) or [Gradle](https://github.com/ethauvin/isgd-shorten/blob/master/examples/gradle) Examples.\n\n## JSON or XML\n\nThe [is.gd API](https://is.gd/developers.php) can return data in plain text (default), JSON or XML.\n\n```kotlin\nIsgd.shorten(\"https://www.example.com/\", format = Format.JSON)\n```\n\nreturns:\n\n```json\n{ \"shorturl\": \"https://is.gd/Pt2sET\" }\n```\n\n## Parameters\n\nAll of the [is.gd API](https://is.gd/developers.php) parameters are supported:\n\n```kotlin\nIsgd.shorten(\n    url = url,\n    shorturl=\"foobar\",\n    callback = \"test\",\n    logstats = true,\n    format = Format.JSON)\n```\n\nreturns:\n\n```js\ntest({ \"shorturl\": \"https://is.gd/foobar\" });\n```\n\n## bld\n\nTo use with [bld](https://rife2.com/bld), include the following dependency in your [build](https://github.com/ethauvin/isgd-shorten/blob/master/examples/bld/src/bld/java/com/example/ExampleBuild.java) file:\n\n```java\nrepositories = List.of(MAVEN_CENTRAL, CENTRAL_SNAPSHOTS);\n\nscope(compile)\n    .include(\"net.thauvin.erik:isgd-shorten:1.1.0\");\n```\n\n## Gradle, Maven, etc...\n\nTo use with [Gradle](https://gradle.org/), include the following dependency in your [build](https://github.com/ethauvin/isgd-shorten/blob/master/examples/gradle/build.gradle.kts) file:\n\n```gradle\nrepositories {\n    mavenCentral()\n    maven { url = uri(\"https://central.sonatype.com/repository/maven-snapshots/\") } // only needed for SNAPSHOT\n}\n\ndependencies {\n    implementation(\"net.thauvin.erik:isgd-shorten:1.1.0\")\n}\n```\n\nInstructions for using with Maven, Ivy, etc. can be found on [Maven Central](https://central.sonatype.com/artifact/net.thauvin.erik/isgd-shorten).\n\n## Java\n\nTo make it easier to use the library with Java, configuration builders are available:\n\n```java\nvar config = new ShortenConfig.Builder(\"https://www.example.com/\")\n        .shorturl(\"foobar\")\n        .callback(\"test\")\n        .logstats(true)\n        .format(Format.JSON)\n        .build();\n\nIsgd.shorten(config);\n```\n\n```java\nvar config = new LookupConfig.Builder(\"https://is.gd/Pt2sET\")\n        .callback(\"test\")\n        .format(Format.XML)\n        .build();\n\nIsgd.lookup(config);\n```\n\n## Errors\n\nAn `IsgdException` is thrown when an API error occurs. The error message (text, XML or JSON) and HTTP status code can be retrieved as follows:\n\n```kotlin\ntry {\n    Isgd.shorten(\"https://is.gd/Pt2sET\") // already shorten\n} catch (e: IsgdException)\n    println(\"Status Code: ${e.statusCode}\")\n    println(\"${e.message})\n}\n```\n\n```console\nStatus Code: 400\nError: Sorry, the URL you entered is on our internal blacklist. It may have been used abusively in the past, or it may link to another URL redirection service.\n```\n\n## v.gd\n\nAdditionally, link can be shortened using [v.gd](https://v.gd/) by setting the `isVgd` flag:\n\n```kotlin\nIsgd.shorten(\"https://www.example.com/\", isVgd = true) // returns https://v.gd/2z2ncj\n```\n\n## Contributing\n\nIf you want to contribute to this project, all you have to do is clone the GitHub\nrepository:\n\n```console\ngit clone git@github.com:ethauvin/isgd-shorten.git\n```\n\nThen use [bld](https://rife2.com/bld) to build:\n\n```console\ncd isgd-shorten\n./bld compile\n```\n\nThe project has an [IntelliJ IDEA](https://www.jetbrains.com/idea/) project structure. You can just open it after all the dependencies were downloaded and peruse the code.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethauvin%2Fisgd-shorten","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fethauvin%2Fisgd-shorten","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fethauvin%2Fisgd-shorten/lists"}