apiclient

Documentation

Overview

Package apiclient implements a client for the autodeb-server REST API

Index

• type APIClient
  • func New(serverURL, token string, httpClient HTTPClient) (*APIClient, error)
  • func (c *APIClient) Aptly() *aptly.APIClient
  • func (c *APIClient) CreateJob(job *models.Job) (*models.Job, error)
  • func (c *APIClient) GetArchiveUpgrade(id uint) (*models.ArchiveUpgrade, error)
  • func (c *APIClient) GetArchiveUpgradeJobs(id uint) ([]*models.Job, error)
  • func (c *APIClient) GetArchiveUpgradeSuccessfulBuilds(id uint) ([]*models.Job, error)
  • func (c *APIClient) GetArtifact(artifactID uint) (*models.Artifact, error)
  • func (c *APIClient) GetArtifactContent(artifactID uint) (io.Reader, error)
  • func (c *APIClient) GetCurrentUser() (*models.User, error)
  • func (c *APIClient) GetJob(jobID uint) (*models.Job, error)
  • func (c *APIClient) GetJobArtifactContent(jobID uint, filename string) (io.Reader, error)
  • func (c *APIClient) GetJobArtifacts(jobID uint) ([]*models.Artifact, error)
  • func (c *APIClient) GetJobLogContent(jobID uint) (io.Reader, error)
  • func (c *APIClient) GetUpload(jobID uint) (*models.Upload, error)
  • func (c *APIClient) GetUploadChanges(uploadID uint) (io.Reader, error)
  • func (c *APIClient) GetUploadChangesURL(uploadID uint) *url.URL
  • func (c *APIClient) GetUploadDSC(uploadID uint) (io.Reader, error)
  • func (c *APIClient) GetUploadDSCURL(uploadID uint) *url.URL
  • func (c *APIClient) GetUploadFile(uploadID uint, filename string) (io.Reader, error)
  • func (c *APIClient) GetUploadFiles(uploadID uint) ([]*models.FileUpload, error)
  • func (c *APIClient) SetJobStatus(jobID uint, status models.JobStatus) error
  • func (c *APIClient) SetToken(token string)
  • func (c *APIClient) SubmitJobArtifact(jobID uint, filename string, content io.Reader) (*models.Artifact, error)
  • func (c *APIClient) SubmitJobLog(jobID uint, jobLog io.Reader) error
  • func (c *APIClient) UnqueueNextJob() (*models.Job, error)
• type HTTPClient

Types

type APIClient

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

APIClient is a client for the autodeb-server REST API

func New

func New(serverURL, token string, httpClient HTTPClient) (*APIClient, error)

New creates a new APIClient

func (*APIClient) Aptly

func (c *APIClient) Aptly() *aptly.APIClient

Aptly returns a client to the aptly api

func (*APIClient) CreateJob

func (c *APIClient) CreateJob(job *models.Job) (*models.Job, error)

CreateJob will create a new job

func (*APIClient) GetArchiveUpgrade

func (c *APIClient) GetArchiveUpgrade(id uint) (*models.ArchiveUpgrade, error)

GetArchiveUpgrade will retrieve an archive upgrade by ID

func (*APIClient) GetArchiveUpgradeJobs

func (c *APIClient) GetArchiveUpgradeJobs(id uint) ([]*models.Job, error)

GetArchiveUpgradeJobs returns all jobs for an ArchiveUpgrade

func (*APIClient) GetArchiveUpgradeSuccessfulBuilds

func (c *APIClient) GetArchiveUpgradeSuccessfulBuilds(id uint) ([]*models.Job, error)

GetArchiveUpgradeSuccessfulBuilds returns all successful builds for an ArchiveUpgrade

func (*APIClient) GetArtifact

func (c *APIClient) GetArtifact(artifactID uint) (*models.Artifact, error)

GetArtifact will retrieve an artifact

func (*APIClient) GetArtifactContent

func (c *APIClient) GetArtifactContent(artifactID uint) (io.Reader, error)

GetArtifactContent will retrieve an artifact's content

func (*APIClient) GetCurrentUser

func (c *APIClient) GetCurrentUser() (*models.User, error)

GetCurrentUser will retrieve the current user

func (*APIClient) GetJob

func (c *APIClient) GetJob(jobID uint) (*models.Job, error)

GetJob will retrieve a job by ID

func (*APIClient) GetJobArtifactContent

func (c *APIClient) GetJobArtifactContent(jobID uint, filename string) (io.Reader, error)

GetJobArtifactContent will retrieve the content of a job's artifact

func (*APIClient) GetJobArtifacts

func (c *APIClient) GetJobArtifacts(jobID uint) ([]*models.Artifact, error)

GetJobArtifacts retrieves all artifacts associated with a job

func (*APIClient) GetJobLogContent

func (c *APIClient) GetJobLogContent(jobID uint) (io.Reader, error)

GetJobLogContent will retrieve the content of a job's log

func (*APIClient) GetUpload

func (c *APIClient) GetUpload(jobID uint) (*models.Upload, error)

GetUpload will retrieve an upload by its id

func (*APIClient) GetUploadChanges

func (c *APIClient) GetUploadChanges(uploadID uint) (io.Reader, error)

GetUploadChanges returns the .changes of an upload

func (*APIClient) GetUploadChangesURL

func (c *APIClient) GetUploadChangesURL(uploadID uint) *url.URL

GetUploadChangesURL returns the .changes URL for a given upload

func (*APIClient) GetUploadDSC

func (c *APIClient) GetUploadDSC(uploadID uint) (io.Reader, error)

GetUploadDSC returns the .dsc of an upload

func (*APIClient) GetUploadDSCURL

func (c *APIClient) GetUploadDSCURL(uploadID uint) *url.URL

GetUploadDSCURL returns the .dsc URL for a given upload

func (*APIClient) GetUploadFile

func (c *APIClient) GetUploadFile(uploadID uint, filename string) (io.Reader, error)

GetUploadFile returns an upload's file

func (*APIClient) GetUploadFiles

func (c *APIClient) GetUploadFiles(uploadID uint) ([]*models.FileUpload, error)

GetUploadFiles returns all files for an upload

func (*APIClient) SetJobStatus

func (c *APIClient) SetJobStatus(jobID uint, status models.JobStatus) error

SetJobStatus will set the Job Status

func (*APIClient) SetToken

func (c *APIClient) SetToken(token string)

SetToken will set the access token used by the client

func (*APIClient) SubmitJobArtifact

func (c *APIClient) SubmitJobArtifact(jobID uint, filename string, content io.Reader) (*models.Artifact, error)

SubmitJobArtifact will submit a job artifact

func (*APIClient) SubmitJobLog

func (c *APIClient) SubmitJobLog(jobID uint, jobLog io.Reader) error

SubmitJobLog will submit logs for a job

func (*APIClient) UnqueueNextJob

func (c *APIClient) UnqueueNextJob() (*models.Job, error)

UnqueueNextJob will return the next job on the queue

type HTTPClient

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

HTTPClient is needed for the APIClient to perform requests. Typically, it would be an &http.Client.