urlexpander

Documentation

Overview

Package urlexpander provides a library to expand shortened urls from services like goo.gl, bitly.com, tinyurl.com

Index

• Variables
• type Config
• type UrlExpander
  • func New() UrlExpander
  • func NewFromConfig(config Config) UrlExpander

Variables

var ErrDisallowedByRobotsTxt = errors.New("Provided URL is disallowed by robots.txt")

var ErrInvalidUrl = errors.New("Provided URL is not valid")

var ErrLongUrl = errors.New("Provided URL is not shortened")

Types

type Config

type Config struct {
	// User agent string used when translating shortened url.
	UserAgent string

	// Maximum length of shortened url. It is assumed that no shortened url is longer than that.
	ShortUrlMaxLength int

	// Expanded urls are cached for repeated use. Using this option cache capacity can be set.
	CacheCapacity int

	// Expanded urls are cached for repeated use. Using this option expiration timeout can be set.
	CacheExpiration time.Duration
}

type UrlExpander

type UrlExpander interface {
	// Expand given shortened url to its original form.
	// Return either an expanded url as a string or an error.
	ExpandUrl(shortenedUrl string) (string, error)
}

func New

func New() UrlExpander

Create a new UrlExpander with default config

func NewFromConfig

func NewFromConfig(config Config) UrlExpander

Create a new UrlExpander with provided config