rallyresttoolkit

package module
v1.0.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Nov 14, 2019 License: Apache-2.0 Imports: 9 Imported by: 0

README

rally-rest-toolkit

Rest Toolkit for Rally in Golang

Purpose

To provide an intuitive API in Golang for accessing Rally data through the REST API.

Usage
go get github.com/comcast/rally-rest-toolkit
Dependencies
go get github.com/tools/godep
go get github.com/onsi/gomega
go get github.com/onsi/ginkgo

References

Rally Web Services Documentation

Elements Supported

  • Hierarchical Requirement
  • Defect
  • Changeset
  • Build Definition
  • Build
  • Task

Examples

Examples are located in the examples folder

export API_KEY="insert your api key"
godep go run runme.go

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Build 

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

Build - struct to hold client

func NewBuild 

func NewBuild(client *RallyClient) (de *Build)

NewBuild - creates new Build

func (*Build) CreateBuild 

func (s *Build) CreateBuild(build models.Build) (der models.Build, err error)

CreateBuild - abstraction for CreateRequest

func (*Build) DeleteBuild 

func (s *Build) DeleteBuild(objectID string) (err error)

DeleteBuild - abstraction for DeleteRequest

func (*Build) GetBuild 

func (s *Build) GetBuild(objectID string) (de models.Build, err error)

GetBuild - abstraction for GetRequest

func (*Build) QueryBuild 

func (s *Build) QueryBuild(query map[string]string) (des []models.Build, err error)

QueryBuild - abstraction for QueryRequest

func (*Build) UpdateBuild 

func (s *Build) UpdateBuild(build models.Build) (buildr models.Build, err error)

UpdateBuild - abstraction for UpdateRequest

type BuildDefinition 

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

BuildDefinition - struct to hold client

func NewBuildDefinition 

func NewBuildDefinition(client *RallyClient) (de *BuildDefinition)

NewBuildDefinition - creates new BuildDefinition

func (*BuildDefinition) CreateBuildDefinition 

func (s *BuildDefinition) CreateBuildDefinition(buildDefinition models.BuildDefinition) (der models.BuildDefinition, err error)

CreateBuildDefinition - abstraction for CreateRequest

func (*BuildDefinition) DeleteBuildDefinition 

func (s *BuildDefinition) DeleteBuildDefinition(objectID string) (err error)

DeleteBuildDefinition - abstraction for DeleteRequest

func (*BuildDefinition) GetBuildDefinition 

func (s *BuildDefinition) GetBuildDefinition(objectID string) (de models.BuildDefinition, err error)

GetBuildDefinition - abstraction for GetRequest

func (*BuildDefinition) QueryBuildDefinition 

func (s *BuildDefinition) QueryBuildDefinition(query map[string]string) (des []models.BuildDefinition, err error)

QueryBuildDefinition - abstraction for QueryRequest

func (*BuildDefinition) UpdateBuildDefinition 

func (s *BuildDefinition) UpdateBuildDefinition(buildDefinition models.BuildDefinition) (buildDefinitionr models.BuildDefinition, err error)

UpdateBuildDefinition - abstraction for UpdateRequest

type Changeset 

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

Changeset - struct to hold client

func NewChangeset 

func NewChangeset(client *RallyClient) (cs *Changeset)

NewChangeset - creates new Changeset

func (*Changeset) CreateChangeset 

func (s *Changeset) CreateChangeset(changeset models.Changeset) (der models.Changeset, err error)

CreateChangeset - abstraction for CreateRequest

func (*Changeset) DeleteChangeset 

func (s *Changeset) DeleteChangeset(objectID string) (err error)

DeleteChangeset - abstraction for DeleteRequest

func (*Changeset) GetChangeset 

func (s *Changeset) GetChangeset(objectID string) (de models.Changeset, err error)

GetChangeset - abstraction for GetRequest

func (*Changeset) QueryChangeset 

func (s *Changeset) QueryChangeset(query map[string]string) (des []models.Changeset, err error)

QueryChangeset - abstraction for QueryRequest

func (*Changeset) UpdateChangeset 

func (s *Changeset) UpdateChangeset(changeset models.Changeset) (changesetr models.Changeset, err error)

UpdateChangeset - abstraction for UpdateRequest

type ClientDoer 

type ClientDoer interface {
	Do(*http.Request) (*http.Response, error)
}

ClientDoer - interface

type CreateBuildDefinitionRequest 

type CreateBuildDefinitionRequest struct {
	BuildDefinition models.BuildDefinition
}

CreateBuildDefinitionRequest - Struct to contain request

type CreateBuildDefinitionResponse 

type CreateBuildDefinitionResponse struct {
	CreateResult buildDefinitionResult
}

type CreateBuildRequest 

type CreateBuildRequest struct {
	Build models.Build
}

CreateBuildRequest - Struct to contain request

type CreateBuildResponse 

type CreateBuildResponse struct {
	CreateResult buildResult
}

type CreateChangesetRequest 

type CreateChangesetRequest struct {
	Changeset models.Changeset
}

CreateChangesetRequest - Struct to contain request

type CreateChangesetResponse 

type CreateChangesetResponse struct {
	CreateResult changesetResult
}

type CreateDefectRequest 

type CreateDefectRequest struct {
	Defect models.Defect
}

CreateDefectRequest - Struct to contain request

type CreateDefectResponse 

type CreateDefectResponse struct {
	CreateResult deResult
}

type CreateHierarchicalRequirementResponse 

type CreateHierarchicalRequirementResponse struct {
	CreateResult HrResult
}

CreateHierarchicalRequirementResponse - reponse struct

type CreateTaskRequest 

type CreateTaskRequest struct {
	Task models.Task
}

CreateTaskRequest - Struct to contain request

type CreateTaskResponse 

type CreateTaskResponse struct {
	CreateResult taskResult
}

type Defect 

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

Defect - struct to hold client

func NewDefect 

func NewDefect(client *RallyClient) (de *Defect)

NewDefect - creates new Defect

func (*Defect) CreateDefect 

func (s *Defect) CreateDefect(de models.Defect) (der models.Defect, err error)

CreateDefect - abstraction for CreateRequest

func (*Defect) DeleteDefect 

func (s *Defect) DeleteDefect(objectID string) (err error)

DeleteDefect - abstraction for DeleteRequest

func (*Defect) GetDefect 

func (s *Defect) GetDefect(objectID string) (de models.Defect, err error)

GetDefect - abstraction for GetRequest

func (*Defect) QueryDefect 

func (s *Defect) QueryDefect(query map[string]string) (des []models.Defect, err error)

QueryDefect - abstraction for QueryRequest

func (*Defect) UpdateDefect 

func (s *Defect) UpdateDefect(de models.Defect) (der models.Defect, err error)

UpdateDefect - abstraction for UpdateRequest

type GetBuildDefinitionResponse 

type GetBuildDefinitionResponse struct {
	BuildDefinition models.BuildDefinition
}

GetBuildDefinitionResponse - Struct to contain response

type GetBuildResponse 

type GetBuildResponse struct {
	Build models.Build
}

GetBuildResponse - Struct to contain response

type GetChangesetResponse 

type GetChangesetResponse struct {
	Changeset models.Changeset
}

GetChangesetResponse - Struct to contain response

type GetDefectResponse 

type GetDefectResponse struct {
	Defect models.Defect
}

GetDefectResponse - Struct to contain response

type GetHierarchicalRequirementResponse 

type GetHierarchicalRequirementResponse struct {
	HierarchicalRequirement models.HierarchicalRequirement
}

GetHierarchicalRequirementResponse - Struct to contain response

type GetTaskResponse 

type GetTaskResponse struct {
	Task models.Task
}

GetTaskResponse - Struct to contain response

type HierarchicalRequirement 

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

HierarchicalRequirement - struct to hold client

func NewHierarchicalRequirement 

func NewHierarchicalRequirement(client *RallyClient) (hr *HierarchicalRequirement)

NewHierarchicalRequirement - creates new HierarchicalRequirement

func (*HierarchicalRequirement) CreateHierarchicalRequirement 

func (s *HierarchicalRequirement) CreateHierarchicalRequirement(hr models.HierarchicalRequirement) (hrr models.HierarchicalRequirement, err error)

CreateHierarchicalRequirement - abstraction for CreateRequest

func (*HierarchicalRequirement) DeleteHierarchicalRequirement 

func (s *HierarchicalRequirement) DeleteHierarchicalRequirement(objectID string) (err error)

DeleteHierarchicalRequirement - abstraction for DeleteRequest

func (*HierarchicalRequirement) GetHierarchicalRequirement 

func (s *HierarchicalRequirement) GetHierarchicalRequirement(objectID string) (hr models.HierarchicalRequirement, err error)

GetHierarchicalRequirement - abstraction for GetRequest

func (*HierarchicalRequirement) QueryHierarchicalRequirement 

func (s *HierarchicalRequirement) QueryHierarchicalRequirement(query map[string]string) (hrs []models.HierarchicalRequirement, err error)

QueryHierarchicalRequirement - abstraction for QueryRequest

func (*HierarchicalRequirement) UpdateHierarchicalRequirement 

func (s *HierarchicalRequirement) UpdateHierarchicalRequirement(hr models.HierarchicalRequirement) (hrr models.HierarchicalRequirement, err error)

UpdateHierarchicalRequirement - abstraction for UpdateRequest

type HierarchicalRequirementRequest 

type HierarchicalRequirementRequest struct {
	HierarchicalRequirement models.HierarchicalRequirement
}

HierarchicalRequirementRequest - Struct to contain request for creates and updates.

type HrResult 

type HrResult struct {
	Object models.HierarchicalRequirement
}

HrResult - struct to contain result from request.

type OperationResponse 

type OperationResponse struct {
	OperationalResult HrResult
}

OperationResponse - struct to contain response

type QueryBuildDefinitionResponse 

type QueryBuildDefinitionResponse struct {
	QueryResult struct {
		Results          []models.BuildDefinition
		TotalResultCount int
	}
}

QueryBuildDefinitionResponse - struct to contain query response

type QueryBuildResponse 

type QueryBuildResponse struct {
	QueryResult struct {
		Results          []models.Build
		TotalResultCount int
	}
}

QueryBuildResponse - struct to contain query response

type QueryChangesetResponse 

type QueryChangesetResponse struct {
	QueryResult struct {
		Results          []models.Changeset
		TotalResultCount int
	}
}

QueryChangesetResponse - struct to contain query response

type QueryDefectResponse 

type QueryDefectResponse struct {
	QueryResult struct {
		Results          []models.Defect
		TotalResultCount int
	}
}

QueryDefectResponse - struct to contain query response

type QueryHierarchicalRequirementResponse 

type QueryHierarchicalRequirementResponse struct {
	QueryResult struct {
		Results          []models.HierarchicalRequirement
		TotalResultCount int
	}
}

QueryHierarchicalRequirementResponse - struct to contain query response

type QueryTaskResponse 

type QueryTaskResponse struct {
	QueryResult struct {
		Results          []models.Task
		TotalResultCount int
	}
}

QueryTaskResponse - struct to contain query response

type RallyClient 

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

RallyClient - struct

func New 

func New(apikey string, apiurl string, client ClientDoer) *RallyClient

New - creates a new RallyClient

func (*RallyClient) CreateRequest 

func (s *RallyClient) CreateRequest(queryType string, input interface{}, output interface{}) (err error)

func (*RallyClient) DeleteRequest 

func (s *RallyClient) DeleteRequest(objectID string, queryType string, output interface{}) (err error)

func (*RallyClient) GetRequest 

func (s *RallyClient) GetRequest(objectID string, queryType string, output interface{}) (err error)

GetRequest - Function to perform GET requests when objectID is known.

func (*RallyClient) HTTPClient 

func (s *RallyClient) HTTPClient() ClientDoer

HTTPClient - returns the internal client object

func (*RallyClient) QueryRequest 

func (s *RallyClient) QueryRequest(query map[string]string, queryType string, output interface{}) (err error)

QueryRequest - function to search for an object.

func (*RallyClient) UpdateRequest 

func (s *RallyClient) UpdateRequest(objectID string, queryType string, input interface{}, output interface{}) (err error)

type Task 

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

Task - struct to hold client

func NewTask 

func NewTask(client *RallyClient) (de *Task)

NewTask - creates new Task

func (*Task) CreateTask 

func (s *Task) CreateTask(task models.Task) (der models.Task, err error)

CreateTask - abstraction for CreateRequest

func (*Task) DeleteTask 

func (s *Task) DeleteTask(objectID string) (err error)

DeleteTask - abstraction for DeleteRequest

func (*Task) GetTask 

func (s *Task) GetTask(objectID string) (de models.Task, err error)

GetTask - abstraction for GetRequest

func (*Task) QueryTask 

func (s *Task) QueryTask(query map[string]string) (des []models.Task, err error)

QueryTask - abstraction for QueryRequest

func (*Task) UpdateTask 

func (s *Task) UpdateTask(task models.Task) (taskr models.Task, err error)

UpdateTask - abstraction for UpdateRequest

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.