orgprojects

Documentation

Index

• Constants
• Variables
• type AggregatedProject
• type CSVExport
  • func NewCSVExport(project AggregatedProject) CSVExport
  • func (c CSVExport) GetHeaders() []string
  • func (c CSVExport) ToRow() []string
• type Group
• type GroupData
• type OrgProjects
• type Page
• type Repository
• type Service
  • func NewService(repository Repository) *Service
  • func (s Service) Export(ctx context.Context, orgID string) ([]byte, string, error)
  • func (s Service) Search(ctx context.Context, orgID string, query *rql.Query) (OrgProjects, error)

Constants

const CSVContentType = "text/csv"

Variables

var ErrNoContent = errors.New("no content")

Types

type AggregatedProject

type AggregatedProject struct {
	ID             string        `rql:"name=id,type=string"`
	Name           string        `rql:"name=name,type=string"`
	Title          string        `rql:"name=title,type=string"`
	State          project.State `rql:"name=state,type=string"`
	MemberCount    int64         `rql:"name=member_count,type=number"`
	CreatedAt      time.Time     `rql:"name=created_at,type=datetime"`
	OrganizationID string        `rql:"name=organization_id,type=string"`
	UserIDs        []string
}

type CSVExport

type CSVExport struct {
	ProjectID      string `csv:"Project ID"`
	Name           string `csv:"Name"`
	Title          string `csv:"Title"`
	State          string `csv:"State"`
	MemberCount    string `csv:"Member Count"`
	UserIDs        string `csv:"User IDs"`
	CreatedAt      string `csv:"Created At"`
	OrganizationID string `csv:"Organization ID"`
}

CSVExport represents the structure for CSV export of organization projects

func NewCSVExport

func NewCSVExport(project AggregatedProject) CSVExport

NewCSVExport converts AggregatedProject to CSVExport

func (CSVExport) GetHeaders

func (c CSVExport) GetHeaders() []string

GetHeaders returns the CSV headers based on struct tags

func (CSVExport) ToRow

func (c CSVExport) ToRow() []string

ToRow converts the struct to a string slice for CSV writing

type Group

type Group struct {
	Name string      `json:"name"`
	Data []GroupData `json:"data"`
}

type GroupData

type GroupData struct {
	Name  string `json:"name"`
	Count int    `json:"count"`
}

type OrgProjects

type OrgProjects struct {
	Projects   []AggregatedProject `json:"projects"`
	Group      Group               `json:"group"`
	Pagination Page                `json:"pagination"`
}

type Page

type Page struct {
	Limit  int `json:"limit"`
	Offset int `json:"offset"`
}

type Repository

type Repository interface {
	Search(ctx context.Context, orgID string, query *rql.Query) (OrgProjects, error)
}

type Service

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

func NewService

func NewService(repository Repository) *Service

func (Service) Export

func (s Service) Export(ctx context.Context, orgID string) ([]byte, string, error)

Export generates a CSV file containing organization projects data

func (Service) Search

func (s Service) Search(ctx context.Context, orgID string, query *rql.Query) (OrgProjects, error)