shurl

README

coopgo/shurl

coopgo/shurl is an url shortener library, using badger as a key/value store.

Project Status

This project is still in development. You can use the example cmd/server as an url shortener website.

Contributing

We welcome any contributions following theses guidelines :

• Any change to the code of the library must not break any transport or backend. Any new feature should be implemented for all if applicable.
• Write simple, clear and maintainable code and avoid technical debt.
• Leave the code cleaner than when you started.
• Refactoring existing code for better performance, better readability or better testing wins over creating a new feature.

If you want to contribute, you can fork the repository and create a pull request.

Bug report

For reporting a bug, you can open an issue using the Bug Report template. Try to write a bug report that is easy to understand and explain how to reproduce the bug. Do not duplicate an existing issue and keep each issue specific to an individual bug.

License

coopgo/shurl is under the Apache 2.0 license. Please refer to the LICENSE file for details.

Documentation

Overview

shurl is an url shortener library using badger.

Index

• Constants
• type Handler
  • func New(opts ...Options) (*Handler, error)
  • func (h *Handler) Close()
  • func (h *Handler) Get(id string) (string, error)
  • func (h *Handler) Post(url string, opts ...ReqOptions) (string, error)
  • func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)
• type Logger
• type NilLogger
  • func (NilLogger) Debugf(string, ...interface{})
  • func (NilLogger) Errorf(string, ...interface{})
  • func (NilLogger) Infof(string, ...interface{})
  • func (NilLogger) Warningf(string, ...interface{})
• type Options
  • func WithDbPath(path string) Options
  • func WithDefaultLength(length int) Options
  • func WithDefaultTTL(ttl time.Duration) Options
  • func WithLogger(logger badger.Logger) Options
• type ReqOptions
  • func WithLength(length int) ReqOptions
  • func WithTTL(ttl time.Duration) ReqOptions

Constants

const (
	DefaultDbPath = "/tmp/badger"
	DefaultLength = 8
)

Types

type Handler

type Handler struct {
	TTL    time.Duration
	Length int
	Scheme string
	// contains filtered or unexported fields
}

Handler is the handler for our library. It should be created with the New() function.

func New

func New(opts ...Options) (*Handler, error)

New creates a new Handler. It implements the option pattern to change the default value of our handler.

func (*Handler) Close

func (h *Handler) Close()

Close stops the database connection.

func (*Handler) Get

func (h *Handler) Get(id string) (string, error)

Get search the store for the url linked to the given id.

func (*Handler) Post

func (h *Handler) Post(url string, opts ...ReqOptions) (string, error)

Post will take a url, store it and return an id linked to it.

func (*Handler) ServeHTTP

func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

ServeHTTP is an http.HandleFunc that will redirect the client to the url linked to the id given in the request url. This id is the last part of request url path. eg: "domain.com/r/{id}"

type Logger

type Logger badger.Logger

type NilLogger

type NilLogger struct{}

NilLogger is a logger that doesn't log

func (NilLogger) Debugf

func (NilLogger) Debugf(string, ...interface{})

func (NilLogger) Errorf

func (NilLogger) Errorf(string, ...interface{})

func (NilLogger) Infof

func (NilLogger) Infof(string, ...interface{})

func (NilLogger) Warningf

func (NilLogger) Warningf(string, ...interface{})

type Options

type Options func(*Handler)

func WithDbPath

func WithDbPath(path string) Options

func WithDefaultLength

func WithDefaultLength(length int) Options

func WithDefaultTTL

func WithDefaultTTL(ttl time.Duration) Options

func WithLogger

func WithLogger(logger badger.Logger) Options

type ReqOptions

type ReqOptions func(*req)

func WithLength

func WithLength(length int) ReqOptions

func WithTTL

func WithTTL(ttl time.Duration) ReqOptions