storage

Documentation

Overview

Package storage wraps access to the persistence layer.

Package storage is a wrapper package designed to simplify utilization of the MongoDB Go driver. It creates an interface that facilitates access to Get, Save, and Info functions related to the database storage and retrieval of shortened urls.

Index

• func GetInfo() ([]models.Shortener, error)
• func GetURL(code string) (string, error)
• func SaveURL(url string) (string, error)
• func SetStorage(s Storage)
• func URLExists(url string) (bool, error)
• type Storage

Functions

func GetInfo

func GetInfo() ([]models.Shortener, error)

GetInfo retrieves a slice of shortened urls from the database

func GetURL

func GetURL(code string) (string, error)

GetURL retrieves a URL from the database based on the encoded version of that url.

func SaveURL

func SaveURL(url string) (string, error)

SaveURL accepts a single url parameter and returns a string containing the encoded version of the url that has been saved in the database.

func SetStorage

func SetStorage(s Storage)

SetStorage is a function that accepts a single parameter of type Storage and assigns the repository type to the received variable param

func URLExists

func URLExists(url string) (bool, error)

URLExists checks if a string matches the url of a saved, shortened URL.

Types

type Storage

type Storage interface {
	GetURL(code string) (string, error)
	SaveURL(url string) (string, error)
	GetInfo() ([]models.Shortener, error)
	URLExists(code string) (bool, error)
}

Storage is an interface which provides details on the utilization of Get, Save and Info routines