zephinzer/dev

package gitlab

// AccountConfigs defines a list of AccountConfig instances which can be
// operated on internally
type AccountConfigs []AccountConfig

// GetSanitized returns a copy of this AccountConfigs instance without
// sensitive credentials
func (a AccountConfigs) GetSanitized() []AccountConfig {
    accounts := []AccountConfig{}
    for _, account := range a {
        if account.Public {
            accounts = append(accounts, account.GetSanitized())
        }
    }
    return accounts
}

// AccountConfig defines the configuration structure for a logical Gitlab
// account to be consumed
type AccountConfig struct {
    // Name is the user-defined label for this account
    Name string `json:"name" yaml:"name,omitempty"`
    // Description is a user-defined description of what this account is for
    Description string `json:"description" yaml:"description,omitempty"`
    // Hostname is the hostname of the Gitlab installation. If this is not provided
    // this should default to "gitlab.com"
    Hostname string `json:"hostname" yaml:"hostname,omitempty"`
    // AccessToken is your Gitlab Personal Access Token which can be generated
    // from this page at https://gitlab.com/profile/personal_access_tokens
    //
    // The required Scopes are as follows:
    // - read_user
    // - read_api
    // - read_repository
    // - read_registry
    AccessToken string `json:"accessToken" yaml:"accessToken"`
    // Public indicates whether this account should be public, if so, the /platforms
    // endpoint on the dev server will expose this account; this is done to accomodate
    // using both personal and work accounts, note that even if this is set to true,
    // the AccessToken should not be exposed
    Public bool `json:"public" yaml:"public,omitempty"`
}

// GetSanitized returns a copy of this Account instance without
// sensitive credentials
func (a AccountConfig) GetSanitized() AccountConfig {
    return AccountConfig{
        Name:        a.Name,
        Description: a.Description,
        AccessToken: "[REDACTED]",
        Hostname:    a.Hostname,
        Public:      a.Public,
    }
}