blend4go

README

blend4go

Galaxy API client library for Golang

See the documentation for more information.

Contributing

PRs are welcome, please conform to all Golang format and design recommendations.

A number of subpackages are unimplemented. They will be implemented as interest in this project grows. Currently, this project only exists to serve the requirements of the Galaxy Terraform Provider.

Documentation

Overview

blend4go Galaxy API client library for Golang

For most use cases, NewGalaxyInstance and GetAPIKey are the only functions in the root package that should be used. Subpackages provide their own implementations of the remaining functions and those should be preferred. Subpackages are organised by subject. See workflows, users, tools, roles, repositories, libraries, jobs, histories, groups, or datatypes subpackages for more information.

A number of subpackages are currently unimplemented, they will be implemented with interest in this project or as needed

Index

• func GetAPIKey(ctx context.Context, host, username, password string) (string, error)
• func HandleResponse(response *resty.Response) (interface{}, error)
• type ErrorResponse
  • func (e *ErrorResponse) Error() string
  • func (e *ErrorResponse) String() string
• type GalaxyID
• type GalaxyInstance
  • func NewGalaxyInstance(host, apiKey string) (g *GalaxyInstance)
  • func NewGalaxyInstanceLogger(host, apiKey string, logWriter io.Writer, logLevel LogLevel) (g *GalaxyInstance)
  • func (g *GalaxyInstance) Debug(v ...interface{})
  • func (g *GalaxyInstance) Debugf(format string, v ...interface{})
  • func (g *GalaxyInstance) Delete(ctx context.Context, model GalaxyModel, params *map[string]string) error
  • func (g *GalaxyInstance) Error(v ...interface{})
  • func (g *GalaxyInstance) Errorf(format string, v ...interface{})
  • func (g *GalaxyInstance) Get(ctx context.Context, id GalaxyID, model GalaxyModel, params *map[string]string) (GalaxyModel, error)
  • func (g *GalaxyInstance) HandleResponse(response *resty.Response) (interface{}, error)
  • func (g *GalaxyInstance) Info(v ...interface{})
  • func (g *GalaxyInstance) Infof(format string, v ...interface{})
  • func (g *GalaxyInstance) List(ctx context.Context, path string, models interface{}, ...) (interface{}, error)
  • func (g *GalaxyInstance) Patch(ctx context.Context, model GalaxyModel, params *map[string]string) (GalaxyModel, error)
  • func (g *GalaxyInstance) Put(ctx context.Context, model GalaxyModel, params *map[string]string) (GalaxyModel, error)
  • func (g *GalaxyInstance) R(ctx context.Context) GalaxyRequest
  • func (g *GalaxyInstance) ToolSheds(ctx context.Context) ([]*ToolShed, error)
  • func (g *GalaxyInstance) Version(ctx context.Context) (string, error)
• type GalaxyModel
• type GalaxyRequest
• type LogLevel
• type StatusResponse
• type ToolShed

Functions

func GetAPIKey

func GetAPIKey(ctx context.Context, host, username, password string) (string, error)

returns an API key for authenticated user based on BaseAuth headers Username is the users email address until https://github.com/galaxyproject/galaxy/pull/10521

func HandleResponse

func HandleResponse(response *resty.Response) (interface{}, error)

Handle responses from Galaxy API, checking for errors

Types

type ErrorResponse

type ErrorResponse struct {
	URL      string
	Method   string
	Message1 string `json:"message"`
	Code1    string `json:"code"`
	Message  string `json:"err_msg"`
	Code     int    `json:"err_code"`
}

func (*ErrorResponse) Error

func (e *ErrorResponse) Error() string

func (*ErrorResponse) String

func (e *ErrorResponse) String() string

type GalaxyID

type GalaxyID = string

https://blog.golang.org/publishing-go-modules https://github.com/go-resty/resty https://pkg.go.dev/github.com/go-resty/resty

type GalaxyInstance

type GalaxyInstance struct {
	Client *resty.Client
	// contains filtered or unexported fields
}

func NewGalaxyInstance

func NewGalaxyInstance(host, apiKey string) (g *GalaxyInstance)

func NewGalaxyInstanceLogger

func NewGalaxyInstanceLogger(host, apiKey string, logWriter io.Writer, logLevel LogLevel) (g *GalaxyInstance)

Create a new connection handle to an instance of Galaxy

func (*GalaxyInstance) Debug

func (g *GalaxyInstance) Debug(v ...interface{})

func (*GalaxyInstance) Debugf

func (g *GalaxyInstance) Debugf(format string, v ...interface{})

func (*GalaxyInstance) Delete

func (g *GalaxyInstance) Delete(ctx context.Context, model GalaxyModel, params *map[string]string) error

Helper to make generic DELETE requests to delete single objects params is a map of query parameters to add to the request

func (*GalaxyInstance) Error

func (g *GalaxyInstance) Error(v ...interface{})

func (*GalaxyInstance) Errorf

func (g *GalaxyInstance) Errorf(format string, v ...interface{})

func (*GalaxyInstance) Get

func (g *GalaxyInstance) Get(ctx context.Context, id GalaxyID, model GalaxyModel, params *map[string]string) (GalaxyModel, error)

Helper to make generic requests against Galaxy API that returns single object params is a map of query parameters to add to the request

func (*GalaxyInstance) HandleResponse

func (g *GalaxyInstance) HandleResponse(response *resty.Response) (interface{}, error)

func (*GalaxyInstance) Info

func (g *GalaxyInstance) Info(v ...interface{})

func (*GalaxyInstance) Infof

func (g *GalaxyInstance) Infof(format string, v ...interface{})

func (*GalaxyInstance) List

func (g *GalaxyInstance) List(ctx context.Context, path string, models interface{}, params *map[string]string) (interface{}, error)

Helper to make generic requests against Galaxy API that return lists of objects params is a map of query parameters to add to the request

func (*GalaxyInstance) Patch

func (g *GalaxyInstance) Patch(ctx context.Context, model GalaxyModel, params *map[string]string) (GalaxyModel, error)

Helper to make generic PATCH requests to Galaxy API to update objects params is a map of query parameters to add to the request

func (*GalaxyInstance) Put

func (g *GalaxyInstance) Put(ctx context.Context, model GalaxyModel, params *map[string]string) (GalaxyModel, error)

Helper to make generic PUT requests to Galaxy API to update objects params is a map of query parameters to add to the request

func (*GalaxyInstance) R

func (g *GalaxyInstance) R(ctx context.Context) GalaxyRequest

Helper to create a new request to the Galaxy API Use this if one of the other functions in this package are not appropriate for the request

func (*GalaxyInstance) ToolSheds

func (g *GalaxyInstance) ToolSheds(ctx context.Context) ([]*ToolShed, error)

Get a list of toolsheds configured in the galaxy instance

func (*GalaxyInstance) Version

func (g *GalaxyInstance) Version(ctx context.Context) (string, error)

Return a description of the major version of Galaxy (e.g. 15.03).

type GalaxyModel

type GalaxyModel interface {
	GetBasePath() string
	SetGalaxyInstance(*GalaxyInstance)
	GetID() GalaxyID
	SetID(GalaxyID)
}

type GalaxyRequest

type GalaxyRequest = *resty.Request

type LogLevel

type LogLevel int

const (
	NONE LogLevel = iota
	ERROR
	WARN
	INFO
	DEBUG
)

type StatusResponse

type StatusResponse struct {
	Status  string `json:"status"`
	Message string `json:"message"`
}

type ToolShed

type ToolShed struct {
	Name string `json:"name"`
	Url  string `json:"url"`
}