structures

Documentation

Overview

Package structures provides functions to parse Slack data types.

Index

• Variables
• func FixMpIMmembers(ch *slack.Channel, users []slack.User) (*slack.Channel, error)
• func FormatSlackTS(ts time.Time) string
• func HasExcludePrefix(s string) bool
• func IsURL(s string) bool
• func IsValidSlackURL(s string) bool
• func ParseSlackTS(timestamp string) (time.Time, error)
• func ParseThreadID(threadID string) (time.Time, error)
• func ResolveURLs(idsOrURLs []string) ([]string, error)
• type EntityList
  • func LoadEntityList(filename string) (*EntityList, error)
  • func NewEntityList(entities []string) (*EntityList, error)
  • func (el *EntityList) HasExcludes() bool
  • func (el *EntityList) HasIncludes() bool
  • func (el *EntityList) Index() map[string]bool
  • func (el *EntityList) IsEmpty() bool
• type SlackLink
  • func ParseLink(link string) (SlackLink, error)
  • func ParseURL(slackURL string) (*SlackLink, error)
  • func (u SlackLink) IsThread() bool
  • func (u SlackLink) IsValid() bool
  • func (u SlackLink) String() string
• type UserIndex
  • func NewUserIndex(us []slack.User) UserIndex
  • func (idx UserIndex) ChannelName(channel *slack.Channel) (who string)
  • func (idx UserIndex) DisplayName(id string) string
  • func (idx UserIndex) IsDeleted(id string) bool
  • func (idx UserIndex) Sender(msg *slack.Message) string
  • func (idx UserIndex) Username(id string) string

Variables

var (
	ErrUnsupportedURL = errors.New("unsupported URL type")
	ErrNoURL          = errors.New("no url provided")
	ErrNotSlackURL    = errors.New("not a slack URL")
	ErrInvalidLink    = errors.New("invalid link")
)

Functions

func FixMpIMmembers

func FixMpIMmembers(ch *slack.Channel, users []slack.User) (*slack.Channel, error)

FixMpIMmembers verifies Channel.Members to contain all channel members, if not, it attempts to populate it by parsing out the usernames from name_normalized, and populating Channel.Members with IDs of the users discovered. usernameIDs is a mapping of username -> user_id.

func FormatSlackTS

func FormatSlackTS(ts time.Time) string

func HasExcludePrefix

func HasExcludePrefix(s string) bool

func IsURL

func IsURL(s string) bool

func IsValidSlackURL

func IsValidSlackURL(s string) bool

IsValidSlackURL returns true if the value looks like valid Slack URL, false if not.

func ParseSlackTS

func ParseSlackTS(timestamp string) (time.Time, error)

ParseSlackTS parses the slack timestamp.

func ParseThreadID

func ParseThreadID(threadID string) (time.Time, error)

ParseThreadID parses the thread id (ie. p1577694990000400) and returns time.Time.

func ResolveURLs

func ResolveURLs(idsOrURLs []string) ([]string, error)

ResolveURLs normalises all channels to ID form. If the idsOrURLs[i] is a channel ID, it is unmodified, if it is URL - it is parsed and replaced with the channel ID. If the channel is marked for exclusion in the list it will retain this status.

Types

type EntityList

type EntityList struct {
	Include []string
	Exclude []string
}

EntityList is an Inclusion/Exclusion list

func LoadEntityList

func LoadEntityList(filename string) (*EntityList, error)

MakeEntityList creates an EntityList from a slice of IDs or URLs (entities).

func NewEntityList

func NewEntityList(entities []string) (*EntityList, error)

NewEntityList creates an EntityList from a slice of IDs or URLs (entities).

func (*EntityList) HasExcludes

func (el *EntityList) HasExcludes() bool

func (*EntityList) HasIncludes

func (el *EntityList) HasIncludes() bool

func (*EntityList) Index

func (el *EntityList) Index() map[string]bool

Index returns a map where key is entity, and value show if the entity should be processed (true) or not (false).

func (*EntityList) IsEmpty

func (el *EntityList) IsEmpty() bool

type SlackLink

type SlackLink struct {
	Channel  string
	ThreadTS string
}

func ParseLink

func ParseLink(link string) (SlackLink, error)

ParseLink parses the slack link string. It supports the following formats:

• XXXXXXX - channel ID
• XXXXXXX:99999999.99999 - channel ID and thread ID
• https://<valid slack URL> - slack URL link.

It returns the SlackLink or error.

func ParseURL

func ParseURL(slackURL string) (*SlackLink, error)

ParseURL parses the slack link in the format of https://xxxx.slack.com/archives/XXXXX[/p99999999]

func (SlackLink) IsThread

func (u SlackLink) IsThread() bool

func (SlackLink) IsValid

func (u SlackLink) IsValid() bool

func (SlackLink) String

func (u SlackLink) String() string

type UserIndex

type UserIndex map[string]*slack.User

UserIndex is a mapping of user ID to the *slack.User.

func NewUserIndex

func NewUserIndex(us []slack.User) UserIndex

NewUserIndex creates a new UserIndex from slack Users slice

func (UserIndex) ChannelName

func (idx UserIndex) ChannelName(channel *slack.Channel) (who string)

ChannelName return the "beautified" name of the channel.

func (UserIndex) DisplayName

func (idx UserIndex) DisplayName(id string) string

DisplayName tries to resolve the display name by ID. if the index is empty, it returns the user ID. If the user is not found in index, is assumes that it is an external user and returns ID with "external" prefix. If it does find the user and display name is unavailble, it returns the Real Name.

func (UserIndex) IsDeleted

func (idx UserIndex) IsDeleted(id string) bool

IsDeleted checks if the user is deleted and returns appropriate value. It will assume user is not deleted, if it's not present in the user index.

func (UserIndex) Sender

func (idx UserIndex) Sender(msg *slack.Message) string

Sender returns username for the message

func (UserIndex) Username

func (idx UserIndex) Username(id string) string

Username tries to resolve the username by ID. If it fails, it returns the user ID. If the user is not found in index, is assumes that it is an external user and returns ID with "external" prefix.