cloudsigma / cloudsigma-sdk-go

CloudSigma SDK for the Go programming language.

CloudSigma SDK for Go

cloudsigma-sdk-go is the official CloudSigma SDK for the Go programming language.

Installation

# X.Y.Z is the version you need
go get github.com/cloudsigma/[email protected]


# for non Go modules usage or latest version
go get github.com/cloudsigma/cloudsigma-sdk-go

Usage

import "github.com/cloudsigma/cloudsigma-sdk-go"

Create a new CloudSigma client, then use the exposed services to access different parts of the CloudSigma API.

Authentication

Currently, HTTP Basic Authentication is the only method of authenticating with the API. You can then use your credentials to create a new client:

cred := cloudsigma.NewUsernamePasswordCredentialsProvider("[email protected]", "my-secure-password")
client := cloudsigma.NewClient(cred)

If you want to specify more parameters by client initialization, use With... methods and pass via option pattern:

cred := cloudsigma.NewUsernamePasswordCredentialsProvider("[email protected]", "my-secure-password")
client := cloudsigma.NewClient(cred,
  cloudsigma.WithLocation("fra"),
  cloudsigma.WithHTTPClient(customHTTPClient),
)

Examples

List all servers for the user.

func main() {
  cred := cloudsigma.NewUsernamePasswordCredentialsProvider("[email protected]", "my-secure-password")
  client := cloudsigma.NewClient(cred)

  // list all servers for the authenticated user
  ctx := context.Background()
  servers, _, err := client.Servers.List(ctx)
}

Contributing

We love pull requests! Please see the contribution guidelines.

License

This SDK is distributed under the BSD 3-Clause License, see LICENSE for more information.

cloudsigma-sdk-go's Issues

Make cloudsigma API URL configurable again

Feature Request

What is the problem that this feature solves?

Trying to update the sdk module to the latest version on terraform-provider-cloudsigma, I've found that the API URL is not configurable anymore. See here. This makes at least for me impossible to use the latest version, as in the terraform provider the URL was always configurable.

Are you planning to change this either here making the URL configurable again or removing the URL configuration on terraform side?

Describe the feature

Notes

RDP

Bug report

Describe the issue

System information

• cloudsigma-sdk-go version:
• golang version:
• OS:

Reproduction instructions

Expected behavior

Notes

Implement Stringer interface for CloudSigma struct types

Feature Request

Implement String() method for CloudSigma struct types, so it will be possible to see real values (and not pointer values) in .Printf methods.

What is the problem that this feature solves?

By create/update requests we want to see payload we send to the API.

Describe the feature

Use https://golang.org/pkg/fmt/#Stringer by implementation.

Notes

Add pagination support for List() methods

Feature Request

Default limit of objects is 20, so we should add a pagination support to be able to iterate over all values.

What is the problem that this feature solves?

Currently there is no way to iterate over all objects without custom logic on consumer side of the SDK.

Describe the feature

• add ListOption struct and optional parameter to List methods
• in case it's defined, add query params to the URL string (use RawQuery)
• add unit tests

Notes

Information about pagination is already in Meta of cloudsigma.Response struct.