snowdrift

README

Snowdrift

Snowdrift is a URL shortener written in Go. Take a look at the example.

Documentation

Index

• Variables
• func New(c *Config) *martini.Martini
• type Backend
  • func NewMemoryBackend() Backend
  • func NewRedisBackend(conn redis.Conn, prefix string) Backend
  • func NewRiakBackend(client *riak.Client, prefix string, idb IDBackend) Backend
• type Config
• type IDBackend
• type MemoryBackend
  • func (b *MemoryBackend) Add(url, digest, code string) error
  • func (b *MemoryBackend) GetCode(digest string) (string, error)
  • func (b *MemoryBackend) GetURL(code string) (string, error)
  • func (b *MemoryBackend) NextID(obscure bool) (int, error)
• type RedisBackend
  • func (b *RedisBackend) Add(url, digest, code string) error
  • func (b *RedisBackend) GetCode(digest string) (string, error)
  • func (b *RedisBackend) GetURL(code string) (string, error)
  • func (b *RedisBackend) NextID(obscure bool) (int, error)
• type RiakBackend
  • func (b *RiakBackend) Add(url, digest, code string) error
  • func (b *RiakBackend) GetCode(digest string) (string, error)
  • func (b *RiakBackend) GetURL(code string) (string, error)

Variables

var ErrCodeExists = errors.New("snowdrift: code already exists")

var ErrNotFound = errors.New("snowdrift: not found")

var ErrURLExists = errors.New("snowdrift: url already exists")

Functions

func New

func New(c *Config) *martini.Martini

Types

type Backend

type Backend interface {
	Add(url, digest, code string) error
	GetCode(digest string) (string, error)
	GetURL(code string) (string, error)
	NextID(obscure bool) (int, error)
}

func NewMemoryBackend

func NewMemoryBackend() Backend

func NewRedisBackend

func NewRedisBackend(conn redis.Conn, prefix string) Backend

func NewRiakBackend

func NewRiakBackend(client *riak.Client, prefix string, idb IDBackend) Backend

type Config

type Config struct {
	Backend        Backend
	HashSalt       string
	URLPrefix      string
	RootRedirect   string
	AllowedOrigins *regexp.Regexp
	ReportErr      func(err error, req *http.Request)
}

type IDBackend

type IDBackend interface {
	NextID(obscure bool) (int, error)
}

type MemoryBackend

type MemoryBackend struct {
	// contains filtered or unexported fields
}

func (*MemoryBackend) Add

func (b *MemoryBackend) Add(url, digest, code string) error

func (*MemoryBackend) GetCode

func (b *MemoryBackend) GetCode(digest string) (string, error)

func (*MemoryBackend) GetURL

func (b *MemoryBackend) GetURL(code string) (string, error)

func (*MemoryBackend) NextID

func (b *MemoryBackend) NextID(obscure bool) (int, error)

type RedisBackend

type RedisBackend struct {
	// contains filtered or unexported fields
}

func (*RedisBackend) Add

func (b *RedisBackend) Add(url, digest, code string) error

func (*RedisBackend) GetCode

func (b *RedisBackend) GetCode(digest string) (string, error)

func (*RedisBackend) GetURL

func (b *RedisBackend) GetURL(code string) (string, error)

func (*RedisBackend) NextID

func (b *RedisBackend) NextID(obscure bool) (int, error)

type RiakBackend

type RiakBackend struct {
	IDBackend
	// contains filtered or unexported fields
}

func (*RiakBackend) Add

func (b *RiakBackend) Add(url, digest, code string) error

func (*RiakBackend) GetCode

func (b *RiakBackend) GetCode(digest string) (string, error)

func (*RiakBackend) GetURL

func (b *RiakBackend) GetURL(code string) (string, error)