client

Documentation

Index

• type Config
  • func (cfg *Config) Delete(ep string, args sprawl.Request) error
  • func (cfg *Config) Get(ep string, args sprawl.Request) ([]byte, error)
  • func (cfg *Config) GetLoginToken() error
  • func (cfg *Config) Post(ep string, args sprawl.Request) ([]byte, error)
  • func (cfg *Config) Put(ep string, args sprawl.Request) error
  • func (cfg *Config) Save(fn string) error
• type SprawlClient
  • func New(fn string) (*SprawlClient, error)
  • func NewWithSettings(host, username, password string) *SprawlClient
  • func (c *SprawlClient) AddSiteMember(site, name, data string, admin bool) error
  • func (c *SprawlClient) CreatePermission(name, description string) error
  • func (c *SprawlClient) CreateSite(name string) error
  • func (c *SprawlClient) CreateUser(name, password string) error
  • func (c *SprawlClient) DeletePermission(name string) error
  • func (c *SprawlClient) DeleteSite(name string) error
  • func (c *SprawlClient) DeleteUser(name string) error
  • func (c *SprawlClient) GetUser(name string) (sprawl.User, error)
  • func (c *SprawlClient) ListPermissions() (sprawl.PermissionList, error)
  • func (c *SprawlClient) ListSiteMembers(site string) ([]sprawl.User, error)
  • func (c *SprawlClient) ListSites() ([]sprawl.Site, error)
  • func (c *SprawlClient) ListUsers() ([]sprawl.User, error)
  • func (c *SprawlClient) RemoveSiteMember(site, name string) error
  • func (c *SprawlClient) UpdatePermission(name, description string) error
  • func (c *SprawlClient) UpdateUser(name, password string) error

Types

type Config

type Config struct {
	// URL for the sprawl server.
	URL string `json:"url"`
	// Username for an administrator.
	Username string `json:"username"`
	// Password for the same administrator.
	Password string `json:"password"`
	// Token for session.
	Token string
}

Config for a Sprawl connection.

func (*Config) Delete

func (cfg *Config) Delete(ep string, args sprawl.Request) error

Delete is for removal.

func (*Config) Get

func (cfg *Config) Get(ep string, args sprawl.Request) ([]byte, error)

Get is for retrieval.

func (*Config) GetLoginToken

func (cfg *Config) GetLoginToken() error

GetLoginToken gets a speawl login token or the current stored token if valid.

func (*Config) Post

func (cfg *Config) Post(ep string, args sprawl.Request) ([]byte, error)

Post is for creation.

func (*Config) Put

func (cfg *Config) Put(ep string, args sprawl.Request) error

Put is for updates.

func (*Config) Save

func (cfg *Config) Save(fn string) error

Save Config to JSON file.

type SprawlClient

type SprawlClient struct {
	*Config
}

SprawlClient is used to access the Sprawl API.

func New

func New(fn string) (*SprawlClient, error)

New creates a new SprawlClient.

func NewWithSettings

func NewWithSettings(host, username, password string) *SprawlClient

NewWithSettings creates a new SprawlClient from variables in the environment.

func (*SprawlClient) AddSiteMember

func (c *SprawlClient) AddSiteMember(site, name, data string, admin bool) error

func (*SprawlClient) CreatePermission

func (c *SprawlClient) CreatePermission(name, description string) error

func (*SprawlClient) CreateSite

func (c *SprawlClient) CreateSite(name string) error

func (*SprawlClient) CreateUser

func (c *SprawlClient) CreateUser(name, password string) error

CreateUser creates a new user with a username and password. Use UpdateUser() to set additional fields.

func (*SprawlClient) DeletePermission

func (c *SprawlClient) DeletePermission(name string) error

func (*SprawlClient) DeleteSite

func (c *SprawlClient) DeleteSite(name string) error

func (*SprawlClient) DeleteUser

func (c *SprawlClient) DeleteUser(name string) error

func (*SprawlClient) GetUser

func (c *SprawlClient) GetUser(name string) (sprawl.User, error)

func (*SprawlClient) ListPermissions

func (c *SprawlClient) ListPermissions() (sprawl.PermissionList, error)

func (*SprawlClient) ListSiteMembers

func (c *SprawlClient) ListSiteMembers(site string) ([]sprawl.User, error)

func (*SprawlClient) ListSites

func (c *SprawlClient) ListSites() ([]sprawl.Site, error)

func (*SprawlClient) ListUsers

func (c *SprawlClient) ListUsers() ([]sprawl.User, error)

func (*SprawlClient) RemoveSiteMember

func (c *SprawlClient) RemoveSiteMember(site, name string) error

func (*SprawlClient) UpdatePermission

func (c *SprawlClient) UpdatePermission(name, description string) error

func (*SprawlClient) UpdateUser

func (c *SprawlClient) UpdateUser(name, password string) error