rewards

Documentation

Index

• Variables
• func CanonicalUserAgentProduct(product string) string
• type PartnerInfo
  • func (p *PartnerInfo) UserAgent() string
• type PartnerList
  • func DefaultPartners() PartnerList
  • func PartnersListFromJSONFile(path string) (*PartnerList, error)
• type PartnersDB
• type PartnersService
  • func NewPartnersService(log *zap.Logger, db PartnersDB) *PartnersService
  • func (service *PartnersService) All(ctx context.Context) ([]PartnerInfo, error)
  • func (service *PartnersService) ByName(ctx context.Context, name string) (PartnerInfo, error)
  • func (service *PartnersService) ByUserAgent(ctx context.Context, userAgentString string) (PartnerInfo, error)
• type PartnersStaticDB
  • func NewPartnersStaticDB(list *PartnerList) (*PartnersStaticDB, error)
  • func (db *PartnersStaticDB) All(ctx context.Context) ([]PartnerInfo, error)
  • func (db *PartnersStaticDB) ByID(ctx context.Context, id string) (PartnerInfo, error)
  • func (db *PartnersStaticDB) ByName(ctx context.Context, name string) (PartnerInfo, error)
  • func (db *PartnersStaticDB) ByUserAgent(ctx context.Context, agent string) (PartnerInfo, error)

Variables

var (
	// ErrPartners is the default error class for partners package.
	ErrPartners = errs.Class("partners")

	// ErrPartnerNotExist is returned when a particular partner does not exist.
	ErrPartnerNotExist = errs.Class("partner does not exist")
)

var DefaultPartnersDB = func() PartnersDB {
	list := DefaultPartners()
	db, err := NewPartnersStaticDB(&list)
	if err != nil {
		panic(err)
	}
	return db
}()

DefaultPartnersDB is current default settings.

Functions

func CanonicalUserAgentProduct

func CanonicalUserAgentProduct(product string) string

CanonicalUserAgentProduct returns canonicalizes the user agent product, which is suitable for lookups.

Types

type PartnerInfo

type PartnerInfo struct {
	Name string
	ID   string
	UUID uuid.UUID
}

PartnerInfo contains information about a partner.

func (*PartnerInfo) UserAgent

func (p *PartnerInfo) UserAgent() string

UserAgent returns canonical user agent.

type PartnerList

type PartnerList struct {
	Partners []PartnerInfo
}

PartnerList defines a json struct for defining partners.

func DefaultPartners

func DefaultPartners() PartnerList

DefaultPartners lists Storj default open-source partners.

func PartnersListFromJSONFile

func PartnersListFromJSONFile(path string) (*PartnerList, error)

PartnersListFromJSONFile loads a json definition of partners.

type PartnersDB

type PartnersDB interface {
	// All returns all partners.
	All(ctx context.Context) ([]PartnerInfo, error)
	// ByName returns partner definitions for a given name.
	ByName(ctx context.Context, name string) (PartnerInfo, error)
	// ByID returns partner definition corresponding to an id.
	ByID(ctx context.Context, id string) (PartnerInfo, error)
	// ByUserAgent returns partner definition corresponding to an user agent string.
	ByUserAgent(ctx context.Context, agent string) (PartnerInfo, error)
}

PartnersDB allows access to partners database.

architecture: Database

type PartnersService

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

PartnersService allows manipulating and accessing partner information.

architecture: Service

func NewPartnersService

func NewPartnersService(log *zap.Logger, db PartnersDB) *PartnersService

NewPartnersService returns a service for handling partner information.

func (*PartnersService) All

func (service *PartnersService) All(ctx context.Context) ([]PartnerInfo, error)

All returns all partners.

func (*PartnersService) ByName

func (service *PartnersService) ByName(ctx context.Context, name string) (PartnerInfo, error)

ByName looks up partner by name.

func (*PartnersService) ByUserAgent

func (service *PartnersService) ByUserAgent(ctx context.Context, userAgentString string) (PartnerInfo, error)

ByUserAgent looks up partner by user agent.

type PartnersStaticDB

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

PartnersStaticDB implements partner lookup based on a static definition.

architecture: Database Implementation

func NewPartnersStaticDB

func NewPartnersStaticDB(list *PartnerList) (*PartnersStaticDB, error)

NewPartnersStaticDB creates a new PartnersStaticDB.

func (*PartnersStaticDB) All

func (db *PartnersStaticDB) All(ctx context.Context) ([]PartnerInfo, error)

All returns all partners.

func (*PartnersStaticDB) ByID

func (db *PartnersStaticDB) ByID(ctx context.Context, id string) (PartnerInfo, error)

ByID returns partner definition corresponding to an id.

func (*PartnersStaticDB) ByName

func (db *PartnersStaticDB) ByName(ctx context.Context, name string) (PartnerInfo, error)

ByName returns partner definitions for a given name. Name is case insensitive.

func (*PartnersStaticDB) ByUserAgent

func (db *PartnersStaticDB) ByUserAgent(ctx context.Context, agent string) (PartnerInfo, error)

ByUserAgent returns partner definition corresponding to an user agent product string.