shorturl

README

ShortURL

Generic implementation for interacting with various URL shortening services in Go.

Usage

As usual you can install the package by issuing:

$ go get github.com/subosito/shorturl

Features

Shortening URL

ShortURL provides simple API to shorten a long URL, here's how:

// import "github.com/subosito/shorturl"

provider := "tinyurl"
u, err := shorturl.Shorten("http://example.com/", provider)
if err == nil {
	fmt.Println(u)
}

Alternatively, you can initialize desired provider:

// import "github.com/subosito/shorturl/tinyurl"

s := tinyurl.New()
u, err := s.Shorten("http://example.com/")
if err == nil {
	fmt.Println(u)
}

Expanding short URL

ShortURL also provides simple API to expand short URL into its original long URL:

// import "github.com/subosito/shorturl"

u, err := shorturl.Expand("http://bit.ly/13M3JX5")
if err == nil {
	fmt.Println(u)
}

Notes: Currently, adf.ly is not supported.

Supported Services

Package	Service	Enviroment Variables
adfly	http://adf.ly/	-
bitly	https://bitly.com/	BITLY_API_KEY, BITLY_LOGIN
catchy	http://catchylink.com/	-
cligs	http://cli.gs/	-
gggg	http://gg.gg/	-
gitio	http://git.io/	-
googl	http://goo.gl/	GOOGL_API_KEY
isgd	http://is.gd/	-
moourl	http://moourl.com/	-
pendekin	http://pendek.in/	-
rddme	http://rdd.me/	-
shorl	http://shorl.com/	-
snipurl	http://snipurl.com/	-
tinyurl	http://tinyurl.com/	-
vamu	http://va.mu/	-

Credits

Inspiration comes from Rubygem shorturl by @robbyrussell

Documentation

Overview

package shorturl providers generic implementation for interacting with various URL shortening services.

Index

• func Expand(u string) ([]byte, error)
• func Shorten(u, provider string) ([]byte, error)
• type Client
  • func NewClient(provider string) *Client
  • func (c *Client) Shorten(u string) ([]byte, error)

Functions

func Expand

func Expand(u string) ([]byte, error)

func Shorten

func Shorten(u, provider string) ([]byte, error)

Types

type Client

type Client struct {
	Provider string
	Params   map[string]string
}

func NewClient

func NewClient(provider string) *Client

func (*Client) Shorten

func (c *Client) Shorten(u string) ([]byte, error)