location

package

v0.0.0-...-be0919c Latest Latest Go to latest Published: Oct 12, 2018 License: GPL-3.0 Imports: 4 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

func NewResolverFake(country string) *resolverFake

NewResolverFake returns resolverFake which uses statically entered country

func NewResolverFakeFailing(err error) *resolverFake

NewResolverFakeFailing returns resolverFake with entered error

type Cache interface {
	Get() Location
	RefreshAndGet() (Location, error)
}

Cache allows caching location

func NewLocationCache(locationDetector Detector) Cache

NewLocationCache constructs Cache

type Detector interface {
	DetectLocation() (Location, error)
}

Detector allows detecting location by current ip

func NewDetector(ipResolver ip.Resolver, locationResolver Resolver) Detector

NewDetector constructs Detector instance

func NewDetectorFake(ipAddress string, country string) Detector

NewDetectorFake constructs Detector instance with faked data

func NewDetectorFakeFailing(err error) Detector

NewDetectorFakeFailing constructs Detector instance with faked error

type Location struct {
	// IP address
	// example: 127.0.0.1
	IP string `json:"ip"`

	// example: NL
	Country string `json:"country"`
}

Location structure

type Resolver interface {
	ResolveCountry(ip string) (string, error)
}

Resolver allows resolving location by ip

func NewResolver(databasePath string) Resolver

NewResolver returns Resolver which uses country database