-
Notifications
You must be signed in to change notification settings - Fork 13
/
apiresponse.go
118 lines (100 loc) · 3.62 KB
/
apiresponse.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
package platformclientv2
import (
"encoding/json"
"errors"
"fmt"
"net/http"
"strconv"
"strings"
)
// APIResponse is a friendly interface for a response from the API
type APIResponse struct {
Response *http.Response `json:"-"`
HasBody bool `json:"hasBody,omitempty"`
RawBody []byte `json:"rawBody,omitempty"`
IsSuccess bool `json:"isSuccess,omitempty"`
StatusCode int `json:"statusCode,omitempty"`
Status string `json:"status,omitempty"`
Error *APIError `json:"error,omitempty"`
ErrorMessage string `json:"errorMessage,omitempty"`
CorrelationID string `json:"correlationId,omitempty"`
Header map[string][]string `json:"header,omitempty"`
}
// String returns the JSON serialized object
func (r *APIResponse) String() string {
s, _ := json.Marshal(r)
str, _ := strconv.Unquote(strings.Replace(strconv.Quote(string(s)), `\\u`, `\u`, -1))
return str
}
// SetError returns the JSON serialized object
func (r *APIResponse) SetError(err *APIError) {
if err == nil {
return
}
r.Error = err
r.ErrorMessage = fmt.Sprintf("API Error: %v - %v (%v)", r.StatusCode, err.Message, r.CorrelationID)
}
// APIError is the standard error body from the API
type APIError struct {
Status int `json:"status,omitempty"`
Message string `json:"message,omitempty"`
MessageWithParams string `json:"messageWithParams,omitempty"`
MessageParams map[string]interface{} `json:"messageParams,omitempty"`
Code string `json:"code,omitempty"`
ContextID string `json:"contextId,omitempty"`
Details []Detail `json:"details,omitempty"`
}
// String returns the JSON serialized object
func (r *APIError) String() string {
s, _ := json.Marshal(r)
str, _ := strconv.Unquote(strings.Replace(strconv.Quote(string(s)), `\\u`, `\u`, -1))
return str
}
// NewAPIResponse creates an APIResponse from a http Response
func NewAPIResponse(r *http.Response, body []byte) (*APIResponse, error) {
response := &APIResponse{Response: r}
var apiError *APIError
response.StatusCode = r.StatusCode
response.Status = r.Status
response.HasBody = body != nil
response.IsSuccess = r.StatusCode >= 200 && r.StatusCode < 300
response.Header = r.Header
if header, exists := response.Header["Inin-Correlation-Id"]; exists {
response.CorrelationID = header[0]
}
if response.HasBody {
// Set body
response.RawBody = body
// Handle error body
if !response.IsSuccess {
// Note: an error will always be returned from this block.
// response.Error will only be set if the error is parsed from the HTTP response body
// Parse response body as error
err := json.Unmarshal(response.RawBody, &apiError)
if err != nil {
// Return response and json parse error
return response, err
}
// Ensure context id is set
if apiError.ContextID == "" {
apiError.ContextID = response.CorrelationID
}
// Set response error on the response
response.SetError(apiError)
// Return response and api error message
return response, errors.New(response.ErrorMessage)
}
}
// Return response and unknown API error.
// This shouldn't happen, but can if there isn't a response body for an unsuccessful request.
if !response.IsSuccess {
err := APIError{
Message: "API Error: Unknown API Error",
ContextID: response.CorrelationID,
}
response.SetError(&err)
return response, errors.New(response.ErrorMessage)
}
// Return response
return response, nil
}