ducky/devices

Paddy 2016-01-02 Parent:b6494e1a499e

20:ed1b5ba69551 Go to Latest

ducky/devices/vendor/golang.org/x/net/context/ctxhttp/ctxhttp.go

Add updating devices to apiv1. We needed a way to be able to update devices after they were created. This is supported in the devices package, we just needed to expose it using apiv1 endpoints. In doing so, it became apparent that allowing users to change the Owner of their Devices wasn't properly thought through, and pending a reason to use it, I'm just removing it. The biggest issue came when trying to return usable error messages; we couldn't distinguish between "you don't own the device you're trying to update" and "you're not allowed to change the owner of the device". I also couldn't figure out _who should be able to_ change the owner of the device, which is generally an indication that I'm building a feature before I have a use case for it. To support this change, the apiv1.DeviceChange type needed its Owner property removed. I also needed to add deviceFromAPI and devicesFromAPI helpers to return devices.Device types from apiv1.Device types. There's now a new validateDeviceUpdate helper that checks to ensure that a device update request is valid and the user has the appropriate permissions. The createRequest type now accepts a slice of Devices, not a slice of DeviceChanges, because we want to pass the Owner in. A new updateRequest type is created, which accepts a DeviceChange to apply. A new handleUpdateDevice handler is created, which is assigned to the endpoint for PATCH requests against a device ID. It checks that the user is logged in, the Device they're trying to update exists, and that it's a valid update. If all of that is true, the device is updated and the updated device is returned. Finally, we had to add two new scopes to support new functionality: ScopeUpdateOtherUserDevices allows a user to update other user's devices, and ScopeUpdateLastSeen allows a user to update the LastSeen property of a device. Pending some better error messages, this should be a full implementation of updating a device, which leaves only the deletion endpoint to deal with.

Download raw file
View source Diff to previous Annotate
History
1 // Copyright 2015 The Go Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style
3 // license that can be found in the LICENSE file.
4
5 // Package ctxhttp provides helper functions for performing context-aware HTTP requests.
6 package ctxhttp
7
8 import (
9 "io"
10 "net/http"
11 "net/url"
12 "strings"
13
14 "golang.org/x/net/context"
15 )
16
17 // Do sends an HTTP request with the provided http.Client and returns an HTTP response.
18 // If the client is nil, http.DefaultClient is used.
19 // If the context is canceled or times out, ctx.Err() will be returned.
20 func Do(ctx context.Context, client *http.Client, req *http.Request) (*http.Response, error) {
21 if client == nil {
22 client = http.DefaultClient
23 }
24
25 // Request cancelation changed in Go 1.5, see cancelreq.go and cancelreq_go14.go.
26 cancel := canceler(client, req)
27
28 type responseAndError struct {
29 resp *http.Response
30 err error
31 }
32 result := make(chan responseAndError, 1)
33
34 go func() {
35 resp, err := client.Do(req)
36 result <- responseAndError{resp, err}
37 }()
38
39 select {
40 case <-ctx.Done():
41 cancel()
42 return nil, ctx.Err()
43 case r := <-result:
44 return r.resp, r.err
45 }
46 }
47
48 // Get issues a GET request via the Do function.
49 func Get(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
50 req, err := http.NewRequest("GET", url, nil)
51 if err != nil {
52 return nil, err
53 }
54 return Do(ctx, client, req)
55 }
56
57 // Head issues a HEAD request via the Do function.
58 func Head(ctx context.Context, client *http.Client, url string) (*http.Response, error) {
59 req, err := http.NewRequest("HEAD", url, nil)
60 if err != nil {
61 return nil, err
62 }
63 return Do(ctx, client, req)
64 }
65
66 // Post issues a POST request via the Do function.
67 func Post(ctx context.Context, client *http.Client, url string, bodyType string, body io.Reader) (*http.Response, error) {
68 req, err := http.NewRequest("POST", url, body)
69 if err != nil {
70 return nil, err
71 }
72 req.Header.Set("Content-Type", bodyType)
73 return Do(ctx, client, req)
74 }
75
76 // PostForm issues a POST request via the Do function.
77 func PostForm(ctx context.Context, client *http.Client, url string, data url.Values) (*http.Response, error) {
78 return Post(ctx, client, url, "application/x-www-form-urlencoded", strings.NewReader(data.Encode()))
79 }