provider

Documentation

Index

• Constants
• Variables
• type AggregateProvider
  • func (ap AggregateProvider) Geocode(q Query) (*Result, error)
• type CacheStore
• type GeocodingProvider
  • func NewGeocodingProvider(cs CacheStore, registry *prometheus.Registry, ...) (GeocodingProvider, error)
  • func NewGoogleGeocodeProvider(key string) (GeocodingProvider, error)
  • func NewOpencageProvider(key string) (GeocodingProvider, error)
• type GoogleProvider
  • func (g GoogleProvider) Geocode(q Query) (*Result, error)
• type OpencageProvider
  • func (o OpencageProvider) Geocode(q Query) (*Result, error)
• type Query
  • func (q Query) Hash() []byte
  • func (q Query) IsValid() bool
  • func (q Query) Key() []byte
• type Result
• type Store
  • func NewCacheStore(rc *redis.Client) (*Store, error)
  • func (s *Store) Del(key []byte) error
  • func (s *Store) Get(key []byte) (*Result, error)
  • func (s Store) Serialize(item *Result) ([]byte, error)
  • func (s *Store) Set(key []byte, item *Result) error
  • func (s Store) SetWithTTL(key []byte, item *Result, ttl time.Duration) error

Constants

const CacheTTL = 365 * 24 * time.Hour

const GoogleProviderType = "google"

const OpencageProviderType = "opencage"

Variables

var DefaultTTL = 180 * 24 * time.Hour

Types

type AggregateProvider

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

func (AggregateProvider) Geocode

func (ap AggregateProvider) Geocode(q Query) (*Result, error)

type CacheStore

type CacheStore interface {
	Get(key []byte) (*Result, error)
	Set(key []byte, item *Result) error
	SetWithTTL(key []byte, item *Result, ttl time.Duration) error
	Del(key []byte) error
}

type GeocodingProvider

type GeocodingProvider interface {
	Geocode(q Query) (*Result, error)
}

func NewGeocodingProvider

func NewGeocodingProvider(cs CacheStore, registry *prometheus.Registry, specification config.Specification) (GeocodingProvider, error)

func NewGoogleGeocodeProvider

func NewGoogleGeocodeProvider(key string) (GeocodingProvider, error)

func NewOpencageProvider

func NewOpencageProvider(key string) (GeocodingProvider, error)

type GoogleProvider

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

func (GoogleProvider) Geocode

func (g GoogleProvider) Geocode(q Query) (*Result, error)

type OpencageProvider

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

func (OpencageProvider) Geocode

func (o OpencageProvider) Geocode(q Query) (*Result, error)

type Query

type Query struct {
	Address  string
	Provider string
	Lat      float64
	Lng      float64
	Query    map[string]string
}

func (Query) Hash

func (q Query) Hash() []byte

func (Query) IsValid

func (q Query) IsValid() bool

func (Query) Key

func (q Query) Key() []byte

type Result

type Result struct {
	Provider  string
	Locations []*geocoder.Location
	Metadata  metadata.MD
}

type Store

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

func NewCacheStore

func NewCacheStore(rc *redis.Client) (*Store, error)

func (*Store) Del

func (s *Store) Del(key []byte) error

func (*Store) Get

func (s *Store) Get(key []byte) (*Result, error)

func (Store) Serialize

func (s Store) Serialize(item *Result) ([]byte, error)

func (*Store) Set

func (s *Store) Set(key []byte, item *Result) error

func (Store) SetWithTTL

func (s Store) SetWithTTL(key []byte, item *Result, ttl time.Duration) error