...
▽

Package urls

import "github.com/matrix-org/go-neb/realms/jira/urls"
Overview
Index

Overview ▾

Package urls handles converting between various JIRA URL representations in a consistent way. There exists three main types of JIRA URL which Go-NEB cares about: 

- URL Keys => matrix.org/jira
- Base URLs => https://matrix.org/jira/
- REST URLs => https://matrix.org/jira/rest/api/2/issue/12680

When making outbound requests to JIRA, Go-NEB needs to use the Base URL representation. Likewise, when Go-NEB sends Matrix messages with JIRA URLs in them, the Base URL needs to be used to form the URL. The URL Key is used to determine equivalence of various JIRA installations and is mainly required when searching the database. The REST URLs are present on incoming webhook events and are the only way to map the event to a JIRA installation.

func SameJIRAURL

func SameJIRAURL(a, b string) bool

SameJIRAURL returns true if the two given JIRA URLs are pointing to the same JIRA installation. Equivalence is determined solely by the provided URLs, by sanitising them then comparing.

type JIRAURL

type JIRAURL struct {
    Base string // The base URL of the JIRA installation. Always has a trailing / and a protocol.
    Key  string // The URL key of the JIRA installation. Never has a trailing / or a protocol.
    Raw  string // The raw input URL, if given. Freeform.
}

JIRAURL contains the parsed representation of a JIRA URL

func ParseJIRAURL

func ParseJIRAURL(u string) (j JIRAURL, err error)

ParseJIRAURL parses a raw input URL and returns a struct which has various JIRA URL representations. The input URL can be a JIRA REST URL, a speculative base JIRA URL from a client, or a URL key. The input string will be stored as under JIRAURL.Raw. If a URL key is given, this struct will default to https as the protocol.