configuration.go

/*
 * Tecent Cloud Archive Storage Golang SDK.
 *
 * Tecent Cloud Archive Storage Golang SDK.
 *
 * API version: 1.5.0
 * Contact: chennqqi@qq.com
 * Generated by: OpenAPI Generator (https://openapi-generator.tech)
 */

package cas

import (
	"fmt"
	"net/http"
	"strings"
	"time"
)

// contextKeys are used to identify the type of value in the context.
// Since these are string, it is possible to get a short description of the
// context key for logging and debugging using key.String().

type contextKey string

func (c contextKey) String() string {
	return "auth " + string(c)
}

var (
	// ContextOAuth2 takes an oauth2.TokenSource as authentication for the request.
	ContextOAuth2 = contextKey("token")

	// ContextBasicAuth takes BasicAuth as authentication for the request.
	ContextBasicAuth = contextKey("basic")

	// ContextAccessToken takes a string oauth2 access token as authentication for the request.
	ContextAccessToken = contextKey("accesstoken")

	// ContextAPIKey takes an APIKey as authentication for the request
	ContextAPIKey = contextKey("apikey")
)

// BasicAuth provides basic http authentication to a request passed via context using ContextBasicAuth
type BasicAuth struct {
	UserName string `json:"userName,omitempty"`
	Password string `json:"password,omitempty"`
}

// APIKey provides API key based authentication to a request passed via context using ContextAPIKey
type APIKey struct {
	Key    string
	Prefix string
}

// ServerVariable stores the information about a server variable
type ServerVariable struct {
	Description  string
	DefaultValue string
	EnumValues   []string
}

// ServerConfiguration stores the information about a server
type ServerConfiguration struct {
	Url         string
	Description string
	Variables   map[string]ServerVariable
}

// Configuration stores the configuration of the API client
type Configuration struct {
	Region       string        `json:"region"`
	AppId        string        `json:"appid"`
	AccessKey    string        `json:"access_key"`
	AccessSecret string        `json:"access_secret"`
	SignExpire   time.Duration `json:"secret_expire"`
	SignKey      string        `json:"sign_key"`
	SignKeyStart int64         `json:"sign_key_start"`
	SignKeyEnd   int64         `json:"sing_key_end"`

	BasePath      string            `json:"basePath,omitempty"`
	Host          string            `json:"host,omitempty"`
	Scheme        string            `json:"scheme,omitempty"`
	DefaultHeader map[string]string `json:"defaultHeader,omitempty"`
	UserAgent     string            `json:"userAgent,omitempty"`
	Debug         bool              `json:"debug,omitempty"`
	Servers       []ServerConfiguration
	HTTPClient    *http.Client
}

// NewConfiguration returns a new Configuration object
func NewConfiguration() *Configuration {
	cfg := &Configuration{
		BasePath:      "http://cas.ap-beijing.myqcloud.com/-",
		DefaultHeader: make(map[string]string),
		UserAgent:     "OpenAPI-Generator/1.0.0/go",
		Debug:         false,
		Servers: []ServerConfiguration{
			{
				Url:         "http://cas.ap-{region}.myqcloud.com/{basePath}",
				Description: "The production API server",
				Variables: map[string]ServerVariable{
					"basePath": ServerVariable{
						Description:  "appId or as named UID",
						DefaultValue: "-",
					},
					"region": ServerVariable{
						Description:  "cas region, options [chengdu/beijing/guangzhou/shanghai]",
						DefaultValue: "beijing",
						EnumValues: []string{
							"beijing",
							"chengdu",
							"guangzhou",
							"shanghai",
						},
					},
					// "appid": ServerVariable{
					// 	Description:  "appid of cas resource owner, if api secret is main user,this is opiton param",
					// 	DefaultValue: "-",
					// },
					// "access_key": ServerVariable{
					// 	Description:  "tecent cloud api key, required",
					// 	DefaultValue: "",
					// },
					// "access_secret": ServerVariable{
					// 	Description:  "api secret, secret mode, secret_expire is required.",
					// 	DefaultValue: "",
					// },
					// "secret_expire": ServerVariable{
					// 	Description:  "tecent cloud api secret",
					// 	DefaultValue: "86400s",
					// },
					// "sign_key": ServerVariable{
					// 	Description:  "sign_key, if use sign_key mode, sign_key_start,sign_key_end are required",
					// 	DefaultValue: "",
					// },
					// "sign_key_start": ServerVariable{
					// 	Description:  "unix timestamp of sign_key start time",
					// 	DefaultValue: "0",
					// },
					// "sign_key_end": ServerVariable{
					// 	Description:  "unix timestamp of sign_key end time",
					// 	DefaultValue: "0",
					// },
				},
			},
		},
	}
	return cfg
}

// AddDefaultHeader adds a new HTTP header to the default header in the request
func (c *Configuration) AddDefaultHeader(key string, value string) {
	c.DefaultHeader[key] = value
}

// ServerUrl returns URL based on server settings
func (c *Configuration) ServerUrl(index int, variables map[string]string) (string, error) {
	if index < 0 || len(c.Servers) <= index {
		return "", fmt.Errorf("Index %v out of range %v", index, len(c.Servers)-1)
	}
	server := c.Servers[index]
	url := server.Url

	// go through variables and replace placeholders
	for name, variable := range server.Variables {
		if value, ok := variables[name]; ok {
			found := bool(len(variable.EnumValues) == 0)
			for _, enumValue := range variable.EnumValues {
				if value == enumValue {
					found = true
				}
			}
			if !found {
				return "", fmt.Errorf("The variable %s in the server URL has invalid value %v. Must be %v", name, value, variable.EnumValues)
			}
			url = strings.Replace(url, "{"+name+"}", value, -1)
		} else {
			url = strings.Replace(url, "{"+name+"}", variable.DefaultValue, -1)
		}
	}
	return url, nil
}