Linting, add new PHP selector plugin selection support

Author: wolveix

README.md

@@ -20,7 +20,7 @@ package main
 
 import (
 	"time"
-	
+
 	"github.com/levelzerotechnology/directadmin-go"
 )
 
@@ -42,6 +42,7 @@ func main() {
 
 	userCtx.User.Usage = *usage
 }
+
 ```
 
 From here, you can call user functions via `userCtx`.
@@ -51,22 +52,14 @@ For example, if you wanted to print each of your databases to your terminal:
 ```go
 dbs, err := userCtx.GetDatabases()
 if err != nil {
-log.Fatalln(err)
+    log.Fatalln(err)
 }
 
 for _, db := range dbs {
-fmt.Println(db.Name)
+    fmt.Println(db.Name)
 }
 ```
 
-## Roadmap
-
-- [ ] Cleanup repo structure (e.g. redis actions being within `admin.go` could go into a dedicated `redis.go` file
-  perhaps)
-- [ ] Explore DA's new API's update versions of old functions (e.g. user config/usage)
-- [ ] Implement testing for all functions
-- [ ] Reach stable v1.0
-
 ## License
 
 BSD licensed. See the [LICENSE](LICENSE) file for details.

admin.go

@@ -1,9 +1,12 @@
 package directadmin
 
-import "net/http"
+import (
+	"errors"
+	"net/http"
+)
 
 type (
-	// Admin inherits Reseller which inherits User
+	// Admin inherits Reseller which inherits User.
 	Admin struct {
 		Reseller
 	}
@@ -18,6 +21,7 @@ type (
 	}
 )
 
+// ConvertResellerToUser (admin) converts the given reseller to a user account.
 func (c *AdminContext) ConvertResellerToUser(username string, reseller string) error {
 	if _, err := c.makeRequestNew(http.MethodPost, "convert-reseller-to-user", convertAccount{Account: username, Creator: reseller}, nil); err != nil {
 		return err
@@ -26,6 +30,7 @@ func (c *AdminContext) ConvertResellerToUser(username string, reseller string) e
 	return nil
 }
 
+// ConvertUserToReseller (admin) converts the given user account to a reseller account.
 func (c *AdminContext) ConvertUserToReseller(username string) error {
 	if _, err := c.makeRequestNew(http.MethodPost, "convert-user-to-reseller", convertAccount{Account: username}, nil); err != nil {
 		return err
@@ -34,6 +39,7 @@ func (c *AdminContext) ConvertUserToReseller(username string) error {
 	return nil
 }
 
+// DisableRedis (admin) disables Redis for the server.
 func (c *AdminContext) DisableRedis() error {
 	var response apiGenericResponseNew
 
@@ -44,6 +50,7 @@ func (c *AdminContext) DisableRedis() error {
 	return nil
 }
 
+// EnableRedis (admin) enables Redis for the server.
 func (c *AdminContext) EnableRedis() error {
 	var response apiGenericResponseNew
 
@@ -54,7 +61,7 @@ func (c *AdminContext) EnableRedis() error {
 	return nil
 }
 
-// GetAllUsers (admin) returns an array of all users
+// GetAllUsers (admin) returns an array of all users.
 func (c *AdminContext) GetAllUsers() ([]string, error) {
 	var users []string
 
@@ -65,7 +72,21 @@ func (c *AdminContext) GetAllUsers() ([]string, error) {
 	return users, nil
 }
 
-// GetResellers (admin) returns an array of all resellers
+// GetRedisStatus (admin) returns whether Redis is enabled and it's version.
+func (c *AdminContext) GetRedisStatus() (bool, string, error) {
+	var resp struct {
+		Active  bool   `json:"active"`
+		Version string `json:"version"`
+	}
+
+	if _, err := c.makeRequestNew(http.MethodGet, "redis/status", nil, &resp); err != nil {
+		return false, "", err
+	}
+
+	return resp.Active, resp.Version, nil
+}
+
+// GetResellers (admin) returns an array of all resellers.
 func (c *AdminContext) GetResellers() ([]string, error) {
 	var users []string
 
@@ -76,6 +97,7 @@ func (c *AdminContext) GetResellers() ([]string, error) {
 	return users, nil
 }
 
+// MoveUserToReseller (admin) moves the given user to the given reseller.
 func (c *AdminContext) MoveUserToReseller(username string, reseller string) error {
 	if _, err := c.makeRequestNew(http.MethodPost, "change-user-creator", convertAccount{Account: username, Creator: reseller}, nil); err != nil {
 		return err
@@ -84,6 +106,7 @@ func (c *AdminContext) MoveUserToReseller(username string, reseller string) erro
 	return nil
 }
 
+// RestartDirectAdmin (admin) restarts the DirectAdmin process on the server.
 func (c *AdminContext) RestartDirectAdmin() error {
 	var response apiGenericResponseNew
 
@@ -94,6 +117,7 @@ func (c *AdminContext) RestartDirectAdmin() error {
 	return nil
 }
 
+// UpdateDirectAdmin (admin) initiates a DirectAdmin update on the server.
 func (c *AdminContext) UpdateDirectAdmin() error {
 	var response apiGenericResponseNew
 
@@ -103,3 +127,16 @@ func (c *AdminContext) UpdateDirectAdmin() error {
 
 	return nil
 }
+
+// UpdateHostname (admin) updates the server's hostname.
+func (c *AdminContext) UpdateHostname(hostname string) error {
+	if hostname == "" {
+		return errors.New("missing hostname")
+	}
+
+	if _, err := c.makeRequestNew(http.MethodPost, "server-settings/change-hostname", map[string]string{"hostname": hostname}, nil); err != nil {
+		return err
+	}
+
+	return nil
+}

auth.go

@@ -26,7 +26,7 @@ type (
 		Created       time.Time `json:"created"`
 		CreatedBy     string    `json:"createdBy"`
 		Expires       time.Time `json:"expires"`
-		Id            string    `json:"id"`
+		ID            string    `json:"id"`
 		RedirectURL   string    `json:"redirectURL"`
 		URL           string    `json:"url"`
 	}
@@ -52,7 +52,7 @@ func (c *AdminContext) GetLoginHistory() ([]*LoginHistory, error) {
 	}
 
 	if len(loginHistory) == 0 {
-		return nil, fmt.Errorf("no login history found")
+		return nil, errors.New("no login history found")
 	}
 
 	return loginHistory, nil
@@ -69,7 +69,7 @@ func (c *UserContext) GetLoginURLs() ([]*LoginKeyURL, error) {
 }
 
 // GetMyUsername returns the current user's username. This is particularly useful when logging in as another user, as it
-// trims the admin/reseller username automatically
+// trims the admin/reseller username automatically.
 func (c *UserContext) GetMyUsername() string {
 	// If the user is logged in via reseller, we need to remove the reseller username from the context's username.
 	if strings.Contains(c.credentials.username, "|") {
@@ -79,6 +79,7 @@ func (c *UserContext) GetMyUsername() string {
 	return c.credentials.username
 }
 
+// Login checks whether the configured credentials work against the configured API.
 func (c *UserContext) Login() error {
 	var response apiGenericResponse
 
@@ -94,7 +95,7 @@ func (c *UserContext) Login() error {
 }
 
 // LoginAsAdmin verifies the provided credentials against the DA API, then returns an admin-level context.
-// The passkey can either be the user's password, or a login key
+// The passkey can either be the user's password, or a login key.
 func (a *API) LoginAsAdmin(username string, passkey string) (*AdminContext, error) {
 	userCtx, err := a.login(username, passkey)
 	if err != nil {
@@ -115,7 +116,7 @@ func (a *API) LoginAsAdmin(username string, passkey string) (*AdminContext, erro
 }
 
 // LoginAsReseller verifies the provided credentials against the DA API, then returns a reseller-level context.
-// The passkey can either be the user's password, or a login key
+// The passkey can either be the user's password, or a login key.
 func (a *API) LoginAsReseller(username string, passkey string) (*ResellerContext, error) {
 	userCtx, err := a.login(username, passkey)
 	if err != nil {
@@ -134,7 +135,7 @@ func (a *API) LoginAsReseller(username string, passkey string) (*ResellerContext
 }
 
 // LoginAsUser verifies the provided credentials against the DA API, then returns a user-level context.
-// The passkey can either be the user's password, or a login key
+// The passkey can either be the user's password, or a login key.
 func (a *API) LoginAsUser(username string, passkey string) (*UserContext, error) {
 	userCtx, err := a.login(username, passkey)
 	if err != nil {
@@ -148,14 +149,18 @@ func (a *API) LoginAsUser(username string, passkey string) (*UserContext, error)
 	return userCtx, nil
 }
 
+// LoginAsMyReseller logs the current admin into the given reseller's account.
 func (c *AdminContext) LoginAsMyReseller(username string) (*ResellerContext, error) {
 	return c.api.LoginAsReseller(c.credentials.username+"|"+username, c.credentials.passkey)
 }
 
+// LoginAsMyUser logs the current reseller into the given user's account.
 func (c *ResellerContext) LoginAsMyUser(username string) (*UserContext, error) {
 	return c.api.LoginAsUser(c.credentials.username+"|"+username, c.credentials.passkey)
 }
 
+// login sets up the user context's cookie jar, verifies that the credentials work against the API, and pulls the user's
+// config.
 func (a *API) login(username string, passkey string) (*UserContext, error) {
 	jar, err := cookiejar.New(nil)
 	if err != nil {

backup.go

@@ -6,7 +6,7 @@ import (
 	"net/url"
 )
 
-// CreateBackup (user) creates an account backup for the given domain, and the given items
+// CreateBackup (user) creates an account backup for the given domain, and the given items.
 func (c *UserContext) CreateBackup(domain string, backupItems ...string) error {
 	var response apiGenericResponse
 
@@ -30,7 +30,7 @@ func (c *UserContext) CreateBackup(domain string, backupItems ...string) error {
 	return nil
 }
 
-// CreateBackupAllItems (user) wraps around CreateBackup and provides all available backup items
+// CreateBackupAllItems (user) wraps around CreateBackup and provides all available backup items.
 func (c *UserContext) CreateBackupAllItems(domain string) error {
 	return c.CreateBackup(
 		domain,
@@ -51,7 +51,7 @@ func (c *UserContext) CreateBackupAllItems(domain string) error {
 	)
 }
 
-// GetBackups (user) returns an array of the session user's backups for the given domain
+// GetBackups (user) returns an array of the session user's backups for the given domain.
 func (c *UserContext) GetBackups(domain string) ([]string, error) {
 	var backups []string
 
@@ -62,7 +62,7 @@ func (c *UserContext) GetBackups(domain string) ([]string, error) {
 	return backups, nil
 }
 
-// RestoreBackup (user) restores an account backup for the given domain, and the given items
+// RestoreBackup (user) restores an account backup for the given domain, and the given items.
 func (c *UserContext) RestoreBackup(domain string, backupFilename string, backupItems ...string) error {
 	var response apiGenericResponse
 
@@ -87,7 +87,7 @@ func (c *UserContext) RestoreBackup(domain string, backupFilename string, backup
 	return nil
 }
 
-// RestoreBackupAllItems (user) wraps around RestoreBackup and provides all available backup items
+// RestoreBackupAllItems (user) wraps around RestoreBackup and provides all available backup items.
 func (c *UserContext) RestoreBackupAllItems(domain string, backupFilename string) error {
 	return c.RestoreBackup(
 		domain,