blih

Documentation

Index

• Constants
• type ApiMessageResponse
• type BoolString
  • func (bs BoolString) UnmarshalJSON(b []byte) error
• type DateTime
  • func (d *DateTime) UnmarshalJSON(b []byte) error
• type KeyListResponse
• type Repository
• type RepositoryACL
  • func (a *RepositoryACL) Validate() bool
• type RepositoryACLResponse
• type RepositoryInfosResponse
• type RepositoryListEntry
• type RepositoryListResponse
• type RepositoryService
  • func NewRepositoryService(s *Service) *RepositoryService
  • func (s *RepositoryService) Create(repo *Repository) (*ApiMessageResponse, error)
  • func (s *RepositoryService) Delete(name string) (*ApiMessageResponse, error)
  • func (s *RepositoryService) GetACL(name string) (*RepositoryACLResponse, error)
  • func (s *RepositoryService) Infos(name string) (*RepositoryInfosResponse, error)
  • func (s *RepositoryService) List() (*RepositoryListResponse, error)
  • func (s *RepositoryService) SetACL(name string, acl *RepositoryACL) (*ApiMessageResponse, error)
• type SSHKey
• type SSHKeyService
  • func NewSSHKeyService(s *Service) *SSHKeyService
  • func (s *SSHKeyService) Create(key *SSHKey) (*ApiMessageResponse, error)
  • func (s *SSHKeyService) Delete(name string) (*ApiMessageResponse, error)
  • func (s *SSHKeyService) List() (*KeyListResponse, error)
• type Service
  • func New(user, token string, ctx context.Context) *Service
  • func (c *Service) NewRequest(endpoint, method string, body interface{}) (*http.Request, error)
  • func (c *Service) SendRequest(endpoint, method string, body interface{}) (*http.Response, error)
  • func (c *Service) SignData(data interface{}) (io.Reader, error)
• type SignedData
• type UtilsService
  • func NewUtilsService(s *Service) *UtilsService
  • func (s *UtilsService) Ping() (time.Duration, error)
  • func (s *UtilsService) WhoAmI() (*ApiMessageResponse, error)

Constants

const (
	DefaultApiBaseURL = "https://blih.epitech.eu/"
	DefaultUserAgent  = "go-blih"
)

const (
	DefaultRepositoryType = "git"
)

Types

type ApiMessageResponse

type ApiMessageResponse struct {
	Message string `json:"message"`
}

type BoolString

type BoolString bool

func (BoolString) UnmarshalJSON

func (bs BoolString) UnmarshalJSON(b []byte) error

type DateTime

type DateTime struct {
	time.Time
}

func (*DateTime) UnmarshalJSON

func (d *DateTime) UnmarshalJSON(b []byte) error

type KeyListResponse

type KeyListResponse map[string]string

type Repository

type Repository struct {
	// The repository name
	Name string `json:"name"`

	// The repository type (usually "git")
	Type string `json:"type"`

	// An optional description
	Description string `json:"description,omitempty"`
}

A structure which represents a Blih repository.

type RepositoryACL

type RepositoryACL struct {
	User string `json:"user"`
	ACL  string `json:"acl"`
}

func (*RepositoryACL) Validate

func (a *RepositoryACL) Validate() bool

type RepositoryACLResponse

type RepositoryACLResponse map[string]string

type RepositoryInfosResponse

type RepositoryInfosResponse struct {
	Message struct {
		URL          string     `json:"url"`
		UUID         string     `json:"uuid"`
		Public       BoolString `json:"public,string"`
		Description  string     `json:"description"`
		CreationTime DateTime   `json:"creation_time,string"`
	}
}

type RepositoryListEntry

type RepositoryListEntry struct {
	UUID string `json:"uuid"`
	URL  string `json:"url"`
}

type RepositoryListResponse

type RepositoryListResponse struct {
	Message      string                         `json:"message"`
	Repositories map[string]RepositoryListEntry `json:"repositories"`
}

type RepositoryService

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

func NewRepositoryService

func NewRepositoryService(s *Service) *RepositoryService

func (*RepositoryService) Create

func (s *RepositoryService) Create(repo *Repository) (*ApiMessageResponse, error)

func (*RepositoryService) Delete

func (s *RepositoryService) Delete(name string) (*ApiMessageResponse, error)

func (*RepositoryService) GetACL

func (s *RepositoryService) GetACL(name string) (*RepositoryACLResponse, error)

func (*RepositoryService) Infos

func (s *RepositoryService) Infos(name string) (*RepositoryInfosResponse, error)

func (*RepositoryService) List

func (s *RepositoryService) List() (*RepositoryListResponse, error)

func (*RepositoryService) SetACL

func (s *RepositoryService) SetACL(name string, acl *RepositoryACL) (*ApiMessageResponse, error)

type SSHKey

type SSHKey struct {
	SSHKey string `json:"sshkey"`
}

type SSHKeyService

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

func NewSSHKeyService

func NewSSHKeyService(s *Service) *SSHKeyService

func (*SSHKeyService) Create

func (s *SSHKeyService) Create(key *SSHKey) (*ApiMessageResponse, error)

func (*SSHKeyService) Delete

func (s *SSHKeyService) Delete(name string) (*ApiMessageResponse, error)

func (*SSHKeyService) List

func (s *SSHKeyService) List() (*KeyListResponse, error)

type Service

type Service struct {
	User string

	BaseURL   string
	UserAgent string

	Utils      *UtilsService
	Repository *RepositoryService
	SSHKey     *SSHKeyService
	// contains filtered or unexported fields
}

func New

func New(user, token string, ctx context.Context) *Service

func (*Service) NewRequest

func (c *Service) NewRequest(endpoint, method string, body interface{}) (*http.Request, error)

func (*Service) SendRequest

func (c *Service) SendRequest(endpoint, method string, body interface{}) (*http.Response, error)

func (*Service) SignData

func (c *Service) SignData(data interface{}) (io.Reader, error)

type SignedData

type SignedData struct {
	User      string      `json:"user"`
	Signature string      `json:"signature"`
	Data      interface{} `json:"data,omitempty"`
}

type UtilsService

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

func NewUtilsService

func NewUtilsService(s *Service) *UtilsService

func (*UtilsService) Ping

func (s *UtilsService) Ping() (time.Duration, error)

func (*UtilsService) WhoAmI

func (s *UtilsService) WhoAmI() (*ApiMessageResponse, error)