/
dimensions.go
381 lines (320 loc) · 10.1 KB
/
dimensions.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
package population
import (
"context"
"encoding/json"
"fmt"
"net/http"
"net/url"
"strconv"
"strings"
"github.com/ONSdigital/dp-api-clients-go/v2/clientlog"
dperrors "github.com/ONSdigital/dp-api-clients-go/v2/errors"
"github.com/ONSdigital/log.go/v2/log"
"github.com/pkg/errors"
)
// Dimension is an area-type model with ID and Label
type Dimension struct {
ID string `json:"id"`
Label string `json:"label"`
Description string `json:"description"`
Categories []Category `json:"categories"`
TotalCount int `json:"total_count"`
QualityStatementText string `json:"quality_statement_text"`
DefaultCategorisation bool `json:"default_categorisation"`
}
type DimensionCategory struct {
Id string `json:"id"`
Label string `json:"label"`
Categories []DimensionCategoryItem `json:"categories"`
}
type DimensionCategoryItem struct {
ID string `json:"id"`
Label string `json:"label"`
}
type Category struct {
ID string `json:"id"`
Label string `json:"label"`
QualityStatementText string `json:"quality_statement_text"`
}
type GetDimensionCategoryInput struct {
AuthTokens
PaginationParams
PopulationType string
Dimensions []string
}
type GetDimensionsInput struct {
AuthTokens
PaginationParams
PopulationType string
SearchString string
}
type GetDimensionsDescriptionInput struct {
AuthTokens
PopulationType string
DimensionIDs []string
}
type GetCategorisationsInput struct {
AuthTokens
PaginationParams
PopulationType string
Dimension string
}
type GetDimensionCategoriesResponse struct {
PaginationResponse
Categories []DimensionCategory `json:"items"`
}
// GetDimensionsResponse is the response object for GetDimensions
type GetDimensionsResponse struct {
PaginationResponse
Dimensions []Dimension `json:"items"`
}
type GetCategorisationsResponse struct {
PaginationResponse
Items []Dimension `json:"items"`
}
type GetBaseVariableInput struct {
AuthTokens
PopulationType string
Variable string
}
type GetBaseVariableResponse struct {
ID string `json:"id"`
Label string `json:"label"`
}
func (c *Client) GetDimensionCategories(ctx context.Context, input GetDimensionCategoryInput) (GetDimensionCategoriesResponse, error) {
logData := log.Data{
"method": http.MethodGet,
"limit": input.Limit,
"offset": input.Offset,
"population_type": input.PopulationType,
"dimensions": input.Dimensions,
}
urlPath := fmt.Sprintf("population-types/%s/dimension-categories", input.PopulationType)
dimensionsString := strings.Join(input.Dimensions[:], ",")
urlValues := url.Values{
"dims": []string{dimensionsString},
"limit": []string{strconv.Itoa(input.Limit)},
"offset": []string{strconv.Itoa(input.Offset)},
}
req, err := c.createGetRequest(ctx, input.UserAuthToken, input.ServiceAuthToken, urlPath, urlValues)
if err != nil {
return GetDimensionCategoriesResponse{}, dperrors.New(
err,
dperrors.StatusCode(err),
logData,
)
}
clientlog.Do(ctx, "getting dimension categories", service, req.URL.String(), logData)
resp, err := c.hcCli.Client.Do(ctx, req)
if err != nil {
return GetDimensionCategoriesResponse{}, dperrors.New(
errors.Wrap(err, "failed to get response from Population types API"),
http.StatusInternalServerError,
logData,
)
}
defer func() {
if err := resp.Body.Close(); err != nil {
log.Error(ctx, "error closing http response body", err)
}
}()
if err := checkGetResponse(resp); err != nil {
return GetDimensionCategoriesResponse{}, err
}
var dimensionCategories GetDimensionCategoriesResponse
if err := json.NewDecoder(resp.Body).Decode(&dimensionCategories); err != nil {
return GetDimensionCategoriesResponse{}, dperrors.New(
errors.Wrap(err, "unable to deserialize areas response"),
http.StatusInternalServerError,
logData,
)
}
return dimensionCategories, nil
}
func (c *Client) GetDimensions(ctx context.Context, input GetDimensionsInput) (GetDimensionsResponse, error) {
logData := log.Data{
"method": http.MethodGet,
"limit": input.Limit,
"offset": input.Offset,
"population_type": input.PopulationType,
"search_string": input.SearchString,
}
urlPath := fmt.Sprintf("population-types/%s/dimensions", input.PopulationType)
urlValues := url.Values{
"limit": []string{strconv.Itoa(input.Limit)},
"offset": []string{strconv.Itoa(input.Offset)},
}
if input.SearchString != "" {
urlValues["q"] = []string{input.SearchString}
}
req, err := c.createGetRequest(ctx, input.UserAuthToken, input.ServiceAuthToken, urlPath, urlValues)
if err != nil {
return GetDimensionsResponse{}, dperrors.New(
err,
dperrors.StatusCode(err),
logData,
)
}
clientlog.Do(ctx, "getting dimensions", service, req.URL.String(), logData)
resp, err := c.hcCli.Client.Do(ctx, req)
if err != nil {
return GetDimensionsResponse{}, dperrors.New(
errors.Wrap(err, "failed to get response from Population types API"),
http.StatusInternalServerError,
logData,
)
}
defer func() {
if err := resp.Body.Close(); err != nil {
log.Error(ctx, "error closing http response body", err)
}
}()
if err := checkGetResponse(resp); err != nil {
return GetDimensionsResponse{}, err
}
var dimensions GetDimensionsResponse
if err := json.NewDecoder(resp.Body).Decode(&dimensions); err != nil {
return GetDimensionsResponse{}, dperrors.New(
errors.Wrap(err, "unable to deserialize areas response"),
http.StatusInternalServerError,
logData,
)
}
return dimensions, nil
}
func (c *Client) GetDimensionsDescription(ctx context.Context, input GetDimensionsDescriptionInput) (GetDimensionsResponse, error) {
logData := log.Data{
"method": http.MethodGet,
"dimensionIDs": input.DimensionIDs,
}
urlPath := fmt.Sprintf("population-types/%s/dimensions-description", input.PopulationType)
var urlValues url.Values
if input.DimensionIDs != nil {
urlValues = make(url.Values)
urlValues["q"] = input.DimensionIDs
}
req, err := c.createGetDimensionsDescriptionRequest(ctx, input.UserAuthToken, input.ServiceAuthToken, urlPath, urlValues)
if err != nil {
return GetDimensionsResponse{}, dperrors.New(
err,
dperrors.StatusCode(err),
logData,
)
}
clientlog.Do(ctx, "getting dimensions", service, req.URL.String(), logData)
resp, err := c.hcCli.Client.Do(ctx, req)
if err != nil {
return GetDimensionsResponse{}, dperrors.New(
errors.Wrap(err, "failed to get response from Population types API"),
http.StatusInternalServerError,
logData,
)
}
defer func() {
if err := resp.Body.Close(); err != nil {
log.Error(ctx, "error closing http response body", err)
}
}()
if err := checkGetResponse(resp); err != nil {
return GetDimensionsResponse{}, err
}
var dimensions GetDimensionsResponse
if err := json.NewDecoder(resp.Body).Decode(&dimensions); err != nil {
return GetDimensionsResponse{}, dperrors.New(
errors.Wrap(err, "unable to deserialize areas response"),
http.StatusInternalServerError,
logData,
)
}
return dimensions, nil
}
func (c *Client) GetCategorisations(ctx context.Context, input GetCategorisationsInput) (GetCategorisationsResponse, error) {
logData := log.Data{
"method": http.MethodGet,
"limit": input.Limit,
"offset": input.Offset,
"population_type": input.PopulationType,
"dimension": input.Dimension,
}
urlPath := fmt.Sprintf("population-types/%s/dimensions/%s/categorisations", input.PopulationType, input.Dimension)
urlValues := url.Values{
"limit": []string{strconv.Itoa(input.Limit)},
"offset": []string{strconv.Itoa(input.Offset)},
}
req, err := c.createGetRequest(ctx, input.UserAuthToken, input.ServiceAuthToken, urlPath, urlValues)
if err != nil {
return GetCategorisationsResponse{}, dperrors.New(
err,
dperrors.StatusCode(err),
logData,
)
}
clientlog.Do(ctx, "getting dimension categorisations", service, req.URL.String(), logData)
res, err := c.hcCli.Client.Do(ctx, req)
if err != nil {
return GetCategorisationsResponse{}, dperrors.New(
errors.Wrap(err, "failed to get response from Population types API"),
http.StatusInternalServerError,
logData,
)
}
defer func() {
if err := res.Body.Close(); err != nil {
log.Error(ctx, "error closing http response body", err)
}
}()
if err := checkGetResponse(res); err != nil {
return GetCategorisationsResponse{}, err
}
var resp GetCategorisationsResponse
if err := json.NewDecoder(res.Body).Decode(&resp); err != nil {
return GetCategorisationsResponse{}, dperrors.New(
errors.Wrap(err, "unable to deserialize categorisations response"),
http.StatusInternalServerError,
logData,
)
}
return resp, nil
}
func (c *Client) GetBaseVariable(ctx context.Context, input GetBaseVariableInput) (GetBaseVariableResponse, error) {
logData := log.Data{
"method": http.MethodGet,
"population_type": input.PopulationType,
"variable": input.Variable,
}
urlPath := fmt.Sprintf("population-types/%s/dimensions/%s/base", input.PopulationType, input.Variable)
req, err := c.createGetRequest(ctx, input.UserAuthToken, input.ServiceAuthToken, urlPath, nil)
if err != nil {
return GetBaseVariableResponse{}, dperrors.New(
err,
dperrors.StatusCode(err),
logData,
)
}
clientlog.Do(ctx, "getting base variable", service, req.URL.String(), logData)
res, err := c.hcCli.Client.Do(ctx, req)
if err != nil {
return GetBaseVariableResponse{}, dperrors.New(
errors.Wrap(err, "failed to get response from Population types API"),
http.StatusInternalServerError,
logData,
)
}
defer func() {
if err := res.Body.Close(); err != nil {
log.Error(ctx, "error closing http response body", err)
}
}()
if err := checkGetResponse(res); err != nil {
return GetBaseVariableResponse{}, err
}
var resp GetBaseVariableResponse
if err := json.NewDecoder(res.Body).Decode(&resp); err != nil {
return GetBaseVariableResponse{}, dperrors.New(
errors.Wrap(err, "unable to deserialize base variable response"),
http.StatusInternalServerError,
logData,
)
}
return resp, nil
}