models

Documentation

Overview

Package models describes models for database communication.

Index

• Variables
• func MakeInvalidBatchTypeError(t UsersBatchType) error
• type DiffHistory
  • func MakeDiffHistory(dt DiffType) DiffHistory
  • func (d *DiffHistory) Add(batches ...UsersBatch)
  • func (d *DiffHistory) Get(date time.Time) []UsersBatch
• type DiffType
  • func (i DiffType) String() string
• type Limits
• type User
  • func MakeUser(id int64, username, fullname string) User
• type UsersBatch
  • func MakeUsersBatch(bt UsersBatchType, users []User, created time.Time) UsersBatch
• type UsersBatchType
  • func (i UsersBatchType) String() string
  • func (i UsersBatchType) Valid() bool

Variables

var ErrInvalidUsersBatchType = errors.New("invalid users batch type")

ErrInvalidUsersBatchType means that batch type not supported.

Functions

func MakeInvalidBatchTypeError

func MakeInvalidBatchTypeError(t UsersBatchType) error

MakeInvalidBatchTypeError returns ErrInvalidUsersBatchType with added bathtype info.

Types

type DiffHistory

type DiffHistory struct {
	DiffType DiffType
	History  map[time.Time][]UsersBatch
}

DiffHistory represents history of account changes.

func MakeDiffHistory

func MakeDiffHistory(dt DiffType) DiffHistory

MakeDiffHistory constructs DiffHistory.

func (*DiffHistory) Add

func (d *DiffHistory) Add(batches ...UsersBatch)

Add adds user batch to the history.

func (*DiffHistory) Get

func (d *DiffHistory) Get(date time.Time) []UsersBatch

Get returns all UsersBatch for specified date.

type DiffType

type DiffType uint

DiffType marks what is the type of diff hostory is.

const (
	// DiffTypeUnknown is unknown type, to cover default value case.
	DiffTypeUnknown DiffType = iota

	// DiffTypeFollowers represents followers history.
	DiffTypeFollowers
	// DiffTypeFollowings represents followings history.
	DiffTypeFollowings
)

func (DiffType) String

func (i DiffType) String() string

type Limits

type Limits struct {
	Follow   int
	UnFollow int
}

Limits represents action limits.

type User

type User struct {
	ID       int64  `bson:"id"`
	UserName string `bson:"user_name"`
	FullName string `bson:"full_name"`
}

User stores information about user.

func MakeUser

func MakeUser(id int64, username, fullname string) User

MakeUser creates User with passed values.

type UsersBatch

type UsersBatch struct {
	Users     []User         `bson:"users"`
	Type      UsersBatchType `bson:"batch_type"`
	CreatedAt time.Time      `bson:"created_at"`
}

UsersBatch represents info about specific type of users (followers, followings).

func MakeUsersBatch

func MakeUsersBatch(bt UsersBatchType, users []User, created time.Time) UsersBatch

MakeUsersBatch constructs UsersBatch.

type UsersBatchType

type UsersBatchType int

UsersBatchType marks what is the type of users stored in the batch.

const (
	// UsersBatchTypeUnknown is unknown type, to cover default value case.
	UsersBatchTypeUnknown UsersBatchType = iota

	// UsersBatchTypeFollowers represents user's followers.
	UsersBatchTypeFollowers
	// UsersBatchTypeFollowings represents user's followings.
	UsersBatchTypeFollowings
	// UsersBatchTypeNotMutual represents users that not following back.
	UsersBatchTypeNotMutual
	// UsersBatchTypeUselessFollowers represents business accounts, bots and mass followers.
	UsersBatchTypeUselessFollowers
	// UsersBatchTypeLostFollowers represents lost followers.
	UsersBatchTypeLostFollowers
	// UsersBatchTypeNewFollowers represents new followers.
	UsersBatchTypeNewFollowers
	// UsersBatchTypeNewFollowings represents new followings.
	UsersBatchTypeNewFollowings
	// UsersBatchTypeLostFollowings represents lost followings.
	UsersBatchTypeLostFollowings
)

func (UsersBatchType) String

func (i UsersBatchType) String() string

func (UsersBatchType) Valid

func (i UsersBatchType) Valid() bool

Valid checks if value is valid type.