New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Add support for Reserved IP addresses #532
Merged
andrewsomething
merged 2 commits into
digitalocean:main
from
senorprogrammer:reserved-ip-fields
Jun 15, 2022
Merged
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,145 @@ | ||
| package godo | ||
|
|
||
| import ( | ||
| "context" | ||
| "fmt" | ||
| "net/http" | ||
| ) | ||
|
|
||
| const resourceType = "ReservedIP" | ||
| const reservedIPsBasePath = "v2/reserved_ips" | ||
|
|
||
| // ReservedIPsService is an interface for interfacing with the reserved IPs | ||
| // endpoints of the Digital Ocean API. | ||
| // See: https://docs.digitalocean.com/reference/api/api-reference/#tag/Reserved-IPs | ||
| type ReservedIPsService interface { | ||
| List(context.Context, *ListOptions) ([]ReservedIP, *Response, error) | ||
| Get(context.Context, string) (*ReservedIP, *Response, error) | ||
| Create(context.Context, *ReservedIPCreateRequest) (*ReservedIP, *Response, error) | ||
| Delete(context.Context, string) (*Response, error) | ||
| } | ||
|
|
||
| // ReservedIPsServiceOp handles communication with the reserved IPs related methods of the | ||
| // DigitalOcean API. | ||
| type ReservedIPsServiceOp struct { | ||
| client *Client | ||
| } | ||
|
|
||
| var _ ReservedIPsService = &ReservedIPsServiceOp{} | ||
|
|
||
| // ReservedIP represents a Digital Ocean reserved IP. | ||
| type ReservedIP struct { | ||
| Region *Region `json:"region"` | ||
| Droplet *Droplet `json:"droplet"` | ||
| IP string `json:"ip"` | ||
| } | ||
|
|
||
| func (f ReservedIP) String() string { | ||
| return Stringify(f) | ||
| } | ||
|
|
||
| // URN returns the reserved IP in a valid DO API URN form. | ||
| func (f ReservedIP) URN() string { | ||
| return ToURN(resourceType, f.IP) | ||
| } | ||
|
|
||
| type reservedIPsRoot struct { | ||
| ReservedIPs []ReservedIP `json:"reserved_ips"` | ||
| Links *Links `json:"links"` | ||
| Meta *Meta `json:"meta"` | ||
| } | ||
|
|
||
| type reservedIPRoot struct { | ||
| ReservedIP *ReservedIP `json:"reserved_ip"` | ||
| Links *Links `json:"links,omitempty"` | ||
| } | ||
|
|
||
| // ReservedIPCreateRequest represents a request to create a reserved IP. | ||
| // Specify DropletID to assign the reserved IP to a Droplet or Region | ||
| // to reserve it to the region. | ||
| type ReservedIPCreateRequest struct { | ||
| Region string `json:"region,omitempty"` | ||
| DropletID int `json:"droplet_id,omitempty"` | ||
| } | ||
|
|
||
| // List all reserved IPs. | ||
| func (r *ReservedIPsServiceOp) List(ctx context.Context, opt *ListOptions) ([]ReservedIP, *Response, error) { | ||
| path := reservedIPsBasePath | ||
| path, err := addOptions(path, opt) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| req, err := r.client.NewRequest(ctx, http.MethodGet, path, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| root := new(reservedIPsRoot) | ||
| resp, err := r.client.Do(ctx, req, root) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
| if l := root.Links; l != nil { | ||
| resp.Links = l | ||
| } | ||
| if m := root.Meta; m != nil { | ||
| resp.Meta = m | ||
| } | ||
|
|
||
| return root.ReservedIPs, resp, err | ||
| } | ||
|
|
||
| // Get an individual reserved IP. | ||
| func (r *ReservedIPsServiceOp) Get(ctx context.Context, ip string) (*ReservedIP, *Response, error) { | ||
| path := fmt.Sprintf("%s/%s", reservedIPsBasePath, ip) | ||
|
|
||
| req, err := r.client.NewRequest(ctx, http.MethodGet, path, nil) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| root := new(reservedIPRoot) | ||
| resp, err := r.client.Do(ctx, req, root) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
|
|
||
| return root.ReservedIP, resp, err | ||
| } | ||
|
|
||
| // Create a reserved IP. If the DropletID field of the request is not empty, | ||
| // the reserved IP will also be assigned to the droplet. | ||
| func (r *ReservedIPsServiceOp) Create(ctx context.Context, createRequest *ReservedIPCreateRequest) (*ReservedIP, *Response, error) { | ||
| path := reservedIPsBasePath | ||
|
|
||
| req, err := r.client.NewRequest(ctx, http.MethodPost, path, createRequest) | ||
| if err != nil { | ||
| return nil, nil, err | ||
| } | ||
|
|
||
| root := new(reservedIPRoot) | ||
| resp, err := r.client.Do(ctx, req, root) | ||
| if err != nil { | ||
| return nil, resp, err | ||
| } | ||
| if l := root.Links; l != nil { | ||
| resp.Links = l | ||
| } | ||
|
|
||
| return root.ReservedIP, resp, err | ||
| } | ||
|
|
||
| // Delete a reserved IP. | ||
| func (r *ReservedIPsServiceOp) Delete(ctx context.Context, ip string) (*Response, error) { | ||
| path := fmt.Sprintf("%s/%s", reservedIPsBasePath, ip) | ||
|
|
||
| req, err := r.client.NewRequest(ctx, http.MethodDelete, path, nil) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| resp, err := r.client.Do(ctx, req, nil) | ||
|
|
||
| return resp, err | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is a pedantic change that has no functional impact. The routes in the returned JSON were incorrect for the resource type.