tulip/utils/scope.go

package utils

import (
	"errors"
	"strings"
)

var ErrInvalidScope = errors.New("Invalid scope")

var scopeDescription = map[string]string{
	"openid":    "Verify your user identity",
	"name":      "Access your name",
	"username":  "Access your username",
	"profile":   "Access your public profile",
	"email":     "Access your email",
	"birthdate": "Access your birthdate",
	"age":       "Access your current age",
	"zoneinfo":  "Access time zone setting",
	"locale":    "Access your language setting",
}

func ScopesExist(scope string) bool {
	_, err := internalGetScopes(scope, func(key, desc string) string { return "" })
	return err == nil
}

// FancyScopeList takes a scope string and outputs a slice of scope descriptions
func FancyScopeList(scope string) (arr []string) {
	a, err := internalGetScopes(scope, func(key, desc string) string {
		return desc
	})
	if err != nil {
		return nil
	}
	return a
}

func internalGetScopes(scope string, f func(key, desc string) string) (arr []string, err error) {
	seen := make(map[string]struct{})
outer:
	for {
		n := strings.IndexAny(scope, ", ")
		var key string
		switch n {
		case 0:
			// first char is matching, no key name found, just continue
			scope = scope[1:]
			continue outer
		case -1:
			// no more matching chars, if scope is empty then we are done
			if len(scope) == 0 {
				return
			}

			// otherwise set the key and empty scope
			key = scope
			scope = ""
		default:
			// set the key and trim from scope
			key = scope[:n]
			scope = scope[n+1:]
		}

		// check if key has been seen already
		if _, ok := seen[key]; ok {
			continue outer
		}

		// set seen flag
		seen[key] = struct{}{}

		// output the description
		if d, ok := scopeDescription[key]; ok && d != "" {
			arr = append(arr, f(key, d))
			continue
		}

		err = ErrInvalidScope
	}
}