tracker

README

= Tracker

image:https://travis-ci.org/xoebus/go-tracker.svg?branch=master["Build Status", link="https://travis-ci.org/xoebus/go-tracker"]
image:https://coveralls.io/repos/xoebus/go-tracker/badge.png["Coverage Status", link="https://coveralls.io/r/xoebus/go-tracker"]

A Pivotal Tracker API client written in Go

Documentation

Index

• Constants
• Variables
• type Activity
• type ActivityQuery
  • func (query ActivityQuery) Query() url.Values
• type Client
  • func NewClient(token string) *Client
  • func (c Client) InProject(projectId int) ProjectClient
  • func (c Client) Me() (me Me, err error)
• type Me
• type Project
• type ProjectClient
  • func (p ProjectClient) CreateStory(story Story) error
  • func (p ProjectClient) DeliverStory(storyId int) error
  • func (p ProjectClient) Stories(query StoriesQuery) (stories []Story, err error)
  • func (p ProjectClient) StoryActivity(storyId int, query ActivityQuery) (activities []Activity, err error)
• type Query
• type StoriesQuery
  • func (query StoriesQuery) Query() url.Values
• type Story
• type StoryState
• type StoryType

Constants

const (
	StoryTypeFeature = "feature"
	StoryTypeBug     = "bug"
	StoryTypeChore   = "chore"
	StoryTypeRelease = "release"
)

const (
	StoryStateUnscheduled = "unscheduled"
	StoryStatePlanned     = "planned"
	StoryStateStarted     = "started"
	StoryStateFinished    = "finished"
	StoryStateDelivered   = "delivered"
	StoryStateAccepted    = "accepted"
	StoryStateRejected    = "rejected"
)

Variables

var DefaultURL = "https://www.pivotaltracker.com"

Types

type Activity

type Activity struct {
	Kind             string        `json:"kind"`
	GUID             string        `json:"guid"`
	ProjectVersion   int           `json:"project_version"`
	Message          string        `json:"message"`
	Highlight        string        `json:"highlight"`
	Changes          []interface{} `json:"changes"`
	PrimaryResources []interface{} `json:"primary_resources"`
	Project          interface{}   `json:"project"`
	PerformedBy      interface{}   `json:"performed_by"`
	OccurredAt       int64         `json:"occurred_at"`
}

type ActivityQuery

type ActivityQuery struct {
	Limit          int
	Offset         int
	OccurredBefore int64
	OccurredAfter  int64
	SinceVersion   int
}

func (ActivityQuery) Query

func (query ActivityQuery) Query() url.Values

type Client

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

func NewClient

func NewClient(token string) *Client

func (Client) InProject

func (c Client) InProject(projectId int) ProjectClient

func (Client) Me

func (c Client) Me() (me Me, err error)

type Me

type Me struct {
	Username string `json:"username"`
	Name     string `json:"name"`
	Initials string `json:"initials"`
	ID       int    `json:"id"`
	Email    string `json:"email"`
}

type Project

type Project struct {
	Id int
}

type ProjectClient

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

func (ProjectClient) CreateStory

func (p ProjectClient) CreateStory(story Story) error

func (ProjectClient) DeliverStory

func (p ProjectClient) DeliverStory(storyId int) error

func (ProjectClient) Stories

func (p ProjectClient) Stories(query StoriesQuery) (stories []Story, err error)

func (ProjectClient) StoryActivity

func (p ProjectClient) StoryActivity(storyId int, query ActivityQuery) (activities []Activity, err error)

type Query

type Query interface {
	Query() url.Values
}

type StoriesQuery

type StoriesQuery struct {
	State StoryState
	Label string

	Limit int
}

func (StoriesQuery) Query

func (query StoriesQuery) Query() url.Values

type Story

type Story struct {
	ID        int `json:"id,omitempty"`
	ProjectID int `json:"project_id,omitempty"`

	Name        string     `json:"name,omitempty"`
	Description string     `json:"description,omitempty"`
	Type        StoryType  `json:"story_type,omitempty"`
	State       StoryState `json:"current_state,omitempty"`
}

type StoryState

type StoryState string

type StoryType

type StoryType string