common

Documentation

Index

• func Init() (*config.Config, *gocql.Session)
• type Refs
  • func FetchRefs(author, repo string) (Refs, error)
  • func NewRefs(data []byte) (Refs, error)
  • func (refsData Refs) Reserialize(versionRefName, versionRefHash string) []byte
• type RequestContext
  • func NewRequestContext(dbSession *gocql.Session) RequestContext

Functions

func Init

func Init() (*config.Config, *gocql.Session)

Init initializes a gophr backend component. Returns all the pre-requisites to starting up successfully.

Types

type Refs

type Refs struct {
	Data                 []byte
	DataStr              string
	DataLen              int
	DataStrLen           int
	Candidates           semver.SemverCandidateList
	MasterRefHash        string
	IndexHeadLineEnd     int
	IndexHeadLineStart   int
	IndexMasterLineEnd   int
	IndexMasterLineStart int
}

Refs collects information about git references for one specific repository.

func FetchRefs

func FetchRefs(author, repo string) (Refs, error)

FetchRefs downloads and processes refs data from Github and ultimately contructs a Refs instance with it.

func NewRefs

func NewRefs(data []byte) (Refs, error)

NewRefs creates a new Refs instance from raw refs data fetched from Github (or elsewhere).

func (Refs) Reserialize

func (refsData Refs) Reserialize(versionRefName, versionRefHash string) []byte

Reserialize changes the refs data to incorporate the selected version as the HEAD instead of the default HEAD.

This code was written by Gustavo Niemeyer, Nathan Youngman and Geert-Johan Riemer.

type RequestContext

type RequestContext struct {
	DB        *gocql.Session
	RequestID string
}

RequestContext is a struct that keeps track of information that is relevant to one specific request.

func NewRequestContext

func NewRequestContext(dbSession *gocql.Session) RequestContext

NewRequestContext creates a new RequestContext.