terraform/vendor/github.com/digitalocean/godo
Paul Stack 6f8ae776bc provider/digitalocean: Bump godo SDK to 1.1.0 (#15121)
This allows support for DigitalOcean Firewalls
2017-06-06 19:16:43 +03:00
..
context provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
CHANGELOG.md provider/digitalocean: Bump godo SDK to 1.1.0 (#15121) 2017-06-06 19:16:43 +03:00
CONTRIBUTING.md Vendor all dependencies w/ Godep 2016-01-29 15:08:48 -06:00
LICENSE.txt Vendor all dependencies w/ Godep 2016-01-29 15:08:48 -06:00
README.md provider/digitalocean: Bump godo SDK to 1.1.0 (#15121) 2017-06-06 19:16:43 +03:00
account.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
action.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
certificates.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
doc.go Vendor all dependencies w/ Godep 2016-01-29 15:08:48 -06:00
domains.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
droplet_actions.go provider/digitalocean: Bump godo SDK to 1.1.0 (#15121) 2017-06-06 19:16:43 +03:00
droplets.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
errors.go Vendor all dependencies w/ Godep 2016-01-29 15:08:48 -06:00
firewalls.go provider/digitalocean: Bump godo SDK to 1.1.0 (#15121) 2017-06-06 19:16:43 +03:00
floating_ips.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
floating_ips_actions.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
godo.go provider/digitalocean: Bump godo SDK to 1.1.0 (#15121) 2017-06-06 19:16:43 +03:00
image_actions.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
images.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
keys.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
links.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
load_balancers.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
regions.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
sizes.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
snapshots.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
storage.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
storage_actions.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
strings.go provider/digitalocean: Bump SDK version of godo for loadbalancer support (#11964) 2017-02-15 14:35:41 +00:00
tags.go provider/digitalocean: Update godo for Certificates support 2017-05-17 17:20:40 +02:00
timestamp.go Vendor all dependencies w/ Godep 2016-01-29 15:08:48 -06:00

README.md

Build Status

Godo

Godo is a Go client library for accessing the DigitalOcean V2 API.

You can view the client API docs here: http://godoc.org/github.com/digitalocean/godo

You can view DigitalOcean API docs here: https://developers.digitalocean.com/documentation/v2/

Usage

import "github.com/digitalocean/godo"

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

Authentication

Currently, Personal Access Token (PAT) is the only method of authenticating with the API. You can manage your tokens at the DigitalOcean Control Panel Applications Page.

You can then use your token to create a new client:

import "golang.org/x/oauth2"

pat := "mytoken"
type TokenSource struct {
    AccessToken string
}

func (t *TokenSource) Token() (*oauth2.Token, error) {
    token := &oauth2.Token{
        AccessToken: t.AccessToken,
    }
    return token, nil
}

tokenSource := &TokenSource{
    AccessToken: pat,
}
oauthClient := oauth2.NewClient(context.Background(), tokenSource)
client := godo.NewClient(oauthClient)

Examples

To create a new Droplet:

dropletName := "super-cool-droplet"

createRequest := &godo.DropletCreateRequest{
    Name:   dropletName,
    Region: "nyc3",
    Size:   "512mb",
    Image: godo.DropletCreateImage{
        Slug: "ubuntu-14-04-x64",
    },
}

ctx := context.TODO()

newDroplet, _, err := client.Droplets.Create(ctx, createRequest)

if err != nil {
    fmt.Printf("Something bad happened: %s\n\n", err)
    return err
}

Pagination

If a list of items is paginated by the API, you must request pages individually. For example, to fetch all Droplets:

func DropletList(ctx context.Context, client *godo.Client) ([]godo.Droplet, error) {
    // create a list to hold our droplets
    list := []godo.Droplet{}

    // create options. initially, these will be blank
    opt := &godo.ListOptions{}
    for {
        droplets, resp, err := client.Droplets.List(ctx, opt)
        if err != nil {
            return nil, err
        }

        // append the current page's droplets to our list
        for _, d := range droplets {
            list = append(list, d)
        }

        // if we are at the last page, break out the for loop
        if resp.Links == nil || resp.Links.IsLastPage() {
            break
        }

        page, err := resp.Links.CurrentPage()
        if err != nil {
            return nil, err
        }

        // set the page we want for the next request
        opt.Page = page + 1
    }

    return list, nil
}

Versioning

Each version of the client is tagged and the version is updated accordingly.

Since Go does not have a built-in versioning, a package management tool is recommended - a good one that works with git tags is gopkg.in.

To see the list of past versions, run git tag.

Documentation

For a comprehensive list of examples, check out the API documentation.

For details on all the functionality in this library, see the GoDoc documentation.

Contributing

We love pull requests! Please see the contribution guidelines.