api.go
author Mikael Berthe <mikael@lilotux.net>
Fri, 07 Sep 2018 19:17:12 +0200
changeset 243 7386c6a454a8
parent 240 80c81e9b77b4
child 248 f287d505dfda
permissions -rw-r--r--
Change the way parameter lists are handled internally Instead of trying to guess if a query key is a list (to strip the index number, since Rails expects list IDs without index number), we prefix the key name with the index when dealing with lists. E.g.: [0]ids: "one" [1]ids: "two" will be sent as ids[]=one&ids[]=two It makes it more reliable and let us differenciate between arrays and objects (objects are untouched and sent as-is).
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
130
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     1
/*
207
301d5b94be3f Update copyrights
Mikael Berthe <mikael@lilotux.net>
parents: 169
diff changeset
     2
Copyright 2017-2018 Mikael Berthe
130
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     3
Copyright 2017 Ollivier Robert
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     4
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     5
Licensed under the MIT license.  Please see the LICENSE file is this directory.
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     6
*/
c450bb73f59a Update credits
Mikael Berthe <mikael@lilotux.net>
parents: 128
diff changeset
     7
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
     8
package madon
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
     9
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    10
import (
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    11
	"bytes"
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    12
	"encoding/json"
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    13
	"fmt"
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    14
	"net/http"
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    15
	"net/url"
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    16
	"regexp"
149
5f922977d7c7 Add support for limits and paging ({since,max}_id) API parameters
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
    17
	"strconv"
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    18
	"strings"
239
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
    19
	"time"
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    20
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
    21
	"github.com/pkg/errors"
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    22
	"github.com/sendgrid/rest"
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    23
)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    24
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    25
type apiLinks struct {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    26
	next, prev *LimitParams
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    27
}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    28
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    29
func parseLink(links []string) (*apiLinks, error) {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    30
	if len(links) == 0 {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    31
		return nil, nil
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    32
	}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    33
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    34
	al := new(apiLinks)
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    35
	linkRegex := regexp.MustCompile(`<([^>]+)>; rel="([^"]+)`)
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    36
	for _, l := range links {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    37
		m := linkRegex.FindAllStringSubmatch(l, -1)
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    38
		for _, submatch := range m {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    39
			if len(submatch) != 3 {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    40
				continue
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    41
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    42
			// Parse URL
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    43
			u, err := url.Parse(submatch[1])
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    44
			if err != nil {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    45
				return al, err
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    46
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    47
			var lp *LimitParams
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    48
			since := u.Query().Get("since_id")
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    49
			max := u.Query().Get("max_id")
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    50
			lim := u.Query().Get("limit")
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    51
			if since == "" && max == "" {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    52
				continue
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    53
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    54
			lp = new(LimitParams)
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    55
			if since != "" {
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
    56
				lp.SinceID, err = strconv.ParseInt(since, 10, 64)
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    57
				if err != nil {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    58
					return al, err
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    59
				}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    60
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    61
			if max != "" {
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
    62
				lp.MaxID, err = strconv.ParseInt(max, 10, 64)
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    63
				if err != nil {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    64
					return al, err
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    65
				}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    66
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    67
			if lim != "" {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    68
				lp.Limit, err = strconv.Atoi(lim)
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    69
				if err != nil {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    70
					return al, err
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    71
				}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    72
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    73
			switch submatch[2] {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    74
			case "prev":
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    75
				al.prev = lp
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    76
			case "next":
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    77
				al.next = lp
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    78
			}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    79
		}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    80
	}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    81
	return al, nil
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    82
}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
    83
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    84
// restAPI actually does the HTTP query
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    85
// It is a copy of rest.API with better handling of parameters with multiple values
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    86
func restAPI(request rest.Request) (*rest.Response, error) {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    87
	c := &rest.Client{HTTPClient: http.DefaultClient}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    88
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    89
	// Build the HTTP request object.
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    90
	if len(request.QueryParams) != 0 {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    91
		// Add parameters to the URL
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    92
		request.BaseURL += "?"
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    93
		urlp := url.Values{}
243
7386c6a454a8 Change the way parameter lists are handled internally
Mikael Berthe <mikael@lilotux.net>
parents: 240
diff changeset
    94
		arrayRe := regexp.MustCompile(`^\[\d+\](.*)$`)
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    95
		for key, value := range request.QueryParams {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    96
			// It seems Mastodon doesn't like parameters with index
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    97
			// numbers, but it needs the brackets.
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
    98
			// Let's check if the key matches '^.+\[.*\]$'
231
741291bb4772 Fix (hopefully) handling of arrays in API calls
Mikael Berthe <mikael@lilotux.net>
parents: 207
diff changeset
    99
			// Do not proceed if there's another bracket pair.
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   100
			klen := len(key)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   101
			if klen == 0 {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   102
				continue
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   103
			}
243
7386c6a454a8 Change the way parameter lists are handled internally
Mikael Berthe <mikael@lilotux.net>
parents: 240
diff changeset
   104
			if m := arrayRe.FindStringSubmatch(key); len(m) > 0 {
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   105
				// This is an array, let's remove the index number
243
7386c6a454a8 Change the way parameter lists are handled internally
Mikael Berthe <mikael@lilotux.net>
parents: 240
diff changeset
   106
				key = m[1] + "[]"
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   107
			}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   108
			urlp.Add(key, value)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   109
		}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   110
		urlpstr := urlp.Encode()
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   111
		request.BaseURL += urlpstr
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   112
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   113
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   114
	req, err := http.NewRequest(string(request.Method), request.BaseURL, bytes.NewBuffer(request.Body))
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   115
	if err != nil {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   116
		return nil, err
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   117
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   118
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   119
	for key, value := range request.Headers {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   120
		req.Header.Set(key, value)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   121
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   122
	_, exists := req.Header["Content-Type"]
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   123
	if len(request.Body) > 0 && !exists {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   124
		req.Header.Set("Content-Type", "application/json")
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   125
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   126
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   127
	// Build the HTTP client and make the request.
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   128
	res, err := c.MakeRequest(req)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   129
	if err != nil {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   130
		return nil, err
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   131
	}
169
d84b2b83813d Better handling of server error pages
Mikael Berthe <mikael@lilotux.net>
parents: 162
diff changeset
   132
	if res.StatusCode < 200 || res.StatusCode >= 300 {
240
80c81e9b77b4 Support search v2 API
Mikael Berthe <mikael@lilotux.net>
parents: 239
diff changeset
   133
		// Please note that the error string code is used by Search()
80c81e9b77b4 Support search v2 API
Mikael Berthe <mikael@lilotux.net>
parents: 239
diff changeset
   134
		// to check the error cause.
80c81e9b77b4 Support search v2 API
Mikael Berthe <mikael@lilotux.net>
parents: 239
diff changeset
   135
		const errFormatString = "bad server status code (%d)"
80c81e9b77b4 Support search v2 API
Mikael Berthe <mikael@lilotux.net>
parents: 239
diff changeset
   136
		return nil, errors.Errorf(errFormatString+": %s",
169
d84b2b83813d Better handling of server error pages
Mikael Berthe <mikael@lilotux.net>
parents: 162
diff changeset
   137
			res.StatusCode, http.StatusText(res.StatusCode))
d84b2b83813d Better handling of server error pages
Mikael Berthe <mikael@lilotux.net>
parents: 162
diff changeset
   138
	}
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   139
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   140
	// Build Response object.
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   141
	response, err := rest.BuildResponse(res)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   142
	if err != nil {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   143
		return nil, err
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   144
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   145
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   146
	return response, nil
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   147
}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   148
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   149
// prepareRequest inserts all pre-defined stuff
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   150
func (mc *Client) prepareRequest(target string, method rest.Method, params apiCallParams) (rest.Request, error) {
128
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   151
	var req rest.Request
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   152
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   153
	if mc == nil {
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   154
		return req, ErrUninitializedClient
128
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   155
	}
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   156
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   157
	endPoint := mc.APIBase + "/" + target
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   158
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   159
	// Request headers
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   160
	hdrs := make(map[string]string)
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   161
	hdrs["User-Agent"] = fmt.Sprintf("madon/%s", MadonVersion)
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   162
	if mc.UserToken != nil {
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   163
		hdrs["Authorization"] = fmt.Sprintf("Bearer %s", mc.UserToken.AccessToken)
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   164
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   165
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   166
	req = rest.Request{
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   167
		BaseURL:     endPoint,
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   168
		Headers:     hdrs,
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   169
		Method:      method,
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   170
		QueryParams: params,
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   171
	}
128
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   172
	return req, nil
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   173
}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   174
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   175
// apiCall makes a call to the Mastodon API server
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   176
// If links is not nil, the prev/next links from the API response headers
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   177
// will be set (if they exist) in the structure.
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   178
func (mc *Client) apiCall(endPoint string, method rest.Method, params apiCallParams, limitOptions *LimitParams, links *apiLinks, data interface{}) error {
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   179
	if mc == nil {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   180
		return errors.New("use of uninitialized madon client")
128
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   181
	}
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   182
149
5f922977d7c7 Add support for limits and paging ({since,max}_id) API parameters
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   183
	if limitOptions != nil {
5f922977d7c7 Add support for limits and paging ({since,max}_id) API parameters
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   184
		if params == nil {
5f922977d7c7 Add support for limits and paging ({since,max}_id) API parameters
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   185
			params = make(apiCallParams)
150
cd328b30af77 Fix mistake in previous changeset
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
   186
		}
cd328b30af77 Fix mistake in previous changeset
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
   187
		if limitOptions.Limit > 0 {
cd328b30af77 Fix mistake in previous changeset
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
   188
			params["limit"] = strconv.Itoa(limitOptions.Limit)
cd328b30af77 Fix mistake in previous changeset
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
   189
		}
cd328b30af77 Fix mistake in previous changeset
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
   190
		if limitOptions.SinceID > 0 {
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
   191
			params["since_id"] = strconv.FormatInt(limitOptions.SinceID, 10)
150
cd328b30af77 Fix mistake in previous changeset
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
   192
		}
cd328b30af77 Fix mistake in previous changeset
Mikael Berthe <mikael@lilotux.net>
parents: 149
diff changeset
   193
		if limitOptions.MaxID > 0 {
159
408aa794d9bb s/int/int64/ for IDs and time integers
Mikael Berthe <mikael@lilotux.net>
parents: 155
diff changeset
   194
			params["max_id"] = strconv.FormatInt(limitOptions.MaxID, 10)
149
5f922977d7c7 Add support for limits and paging ({since,max}_id) API parameters
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   195
		}
5f922977d7c7 Add support for limits and paging ({since,max}_id) API parameters
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   196
	}
5f922977d7c7 Add support for limits and paging ({since,max}_id) API parameters
Mikael Berthe <mikael@lilotux.net>
parents: 138
diff changeset
   197
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   198
	// Prepare query
138
23d3a518d0ad Update package name in source files
Mikael Berthe <mikael@lilotux.net>
parents: 130
diff changeset
   199
	req, err := mc.prepareRequest(endPoint, method, params)
128
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   200
	if err != nil {
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   201
		return err
a5a00fad7a32 Add checks for client initialization
Mikael Berthe <mikael@lilotux.net>
parents: 125
diff changeset
   202
	}
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   203
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   204
	// Make API call
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   205
	r, err := restAPI(req)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   206
	if err != nil {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   207
		return errors.Wrapf(err, "API query (%s) failed", endPoint)
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   208
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   209
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   210
	if links != nil {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   211
		pLinks, err := parseLink(r.Headers["Link"])
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   212
		if err != nil {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   213
			return errors.Wrapf(err, "cannot decode header links (%s)", method)
155
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   214
		}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   215
		if pLinks != nil {
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   216
			*links = *pLinks
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   217
		}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   218
	}
0c581e0108da Use links from headers
Mikael Berthe <mikael@lilotux.net>
parents: 150
diff changeset
   219
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   220
	// Check for error reply
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   221
	var errorResult Error
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   222
	if err := json.Unmarshal([]byte(r.Body), &errorResult); err == nil {
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   223
		// The empty object is not an error
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   224
		if errorResult.Text != "" {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   225
			return errors.New(errorResult.Text)
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   226
		}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   227
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   228
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   229
	// Not an error reply; let's unmarshal the data
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   230
	err = json.Unmarshal([]byte(r.Body), &data)
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   231
	if err != nil {
162
68df3a01e1a7 Use github.com/pkg/errors
Mikael Berthe <mikael@lilotux.net>
parents: 159
diff changeset
   232
		return errors.Wrapf(err, "cannot decode API response (%s)", method)
125
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   233
	}
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   234
	return nil
2bbb72b9ebf6 Rework the API wrappers to handle arrays of parameters
Mikael Berthe <mikael@lilotux.net>
parents:
diff changeset
   235
}
239
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   236
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   237
/* Mastodon timestamp handling */
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   238
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   239
// MastodonDate is a custom type for the timestamps returned by some API calls
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   240
// It is used, for example, by 'v1/instance/activity' and 'v2/search'.
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   241
// The date returned by those Mastodon API calls is a string containing a
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   242
// timestamp in seconds...
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   243
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   244
// UnmarshalJSON handles deserialization for custom MastodonDate type
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   245
func (act *MastodonDate) UnmarshalJSON(b []byte) error {
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   246
	s, err := strconv.ParseInt(strings.Trim(string(b), "\""), 10, 64)
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   247
	if err != nil {
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   248
		return err
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   249
	}
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   250
	if s == 0 {
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   251
		act.Time = time.Time{}
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   252
		return nil
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   253
	}
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   254
	act.Time = time.Unix(s, 0)
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   255
	return nil
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   256
}
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   257
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   258
// MarshalJSON handles serialization for custom MastodonDate type
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   259
func (act *MastodonDate) MarshalJSON() ([]byte, error) {
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   260
	return []byte(fmt.Sprintf("\"%d\"", act.Unix())), nil
ca5639b4768e Introduce new type: MastodonDate
Mikael Berthe <mikael@lilotux.net>
parents: 231
diff changeset
   261
}