-
Notifications
You must be signed in to change notification settings - Fork 11
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
1 parent
81bc374
commit d877417
Showing
9 changed files
with
748 additions
and
23 deletions.
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
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,225 @@ | ||
| // Package dbs provides support the HSDP Data Broker services | ||
| package dbs | ||
|
|
||
| import ( | ||
| "bytes" | ||
| "encoding/json" | ||
| "fmt" | ||
| "io" | ||
| "net/http" | ||
| "net/url" | ||
| "path" | ||
| "strings" | ||
|
|
||
| "github.com/go-playground/validator/v10" | ||
| "github.com/google/go-querystring/query" | ||
| autoconf "github.com/philips-software/go-hsdp-api/config" | ||
| "github.com/philips-software/go-hsdp-api/iam" | ||
| "github.com/philips-software/go-hsdp-api/internal" | ||
| ) | ||
|
|
||
| const ( | ||
| userAgent = "go-hsdp-api/dbs/" + internal.LibraryVersion | ||
| APIVersion = "1" | ||
| ) | ||
|
|
||
| // OptionFunc is the function signature function for options | ||
| type OptionFunc func(*http.Request) error | ||
|
|
||
| // Config contains the configuration of a Client | ||
| type Config struct { | ||
| Region string | ||
| Environment string | ||
| BaseURL string | ||
| DebugLog io.Writer | ||
| Retry int | ||
| } | ||
|
|
||
| // A Client manages communication with HSDP Data Broker APIs | ||
| type Client struct { | ||
| // HTTP Client used to communicate with IAM API | ||
| *iam.Client | ||
| config *Config | ||
| baseURL *url.URL | ||
|
|
||
| // User agent used when communicating with the HSDP Blob Repository API | ||
| UserAgent string | ||
|
|
||
| validate *validator.Validate | ||
|
|
||
| Subscribers *SubscribersService | ||
| Subscriptions *SubscriptionService | ||
| } | ||
|
|
||
| // NewClient returns a new DBS client | ||
| func NewClient(iamClient *iam.Client, config *Config) (*Client, error) { | ||
| validate := validator.New() | ||
| if err := validate.Struct(config); err != nil { | ||
| return nil, err | ||
| } | ||
| if iamClient == nil { | ||
| return nil, fmt.Errorf("iamClient cannot be nil") | ||
| } | ||
| doAutoconf(config) | ||
| c := &Client{Client: iamClient, config: config, UserAgent: userAgent, validate: validator.New()} | ||
|
|
||
| if err := c.SetBaseURL(config.BaseURL); err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| c.Subscribers = &SubscribersService{Client: c, validate: validator.New()} | ||
| c.Subscriptions = &SubscriptionService{Client: c, validate: validator.New()} | ||
|
|
||
| return c, nil | ||
| } | ||
|
|
||
| func doAutoconf(config *Config) { | ||
| if config.Region != "" && config.Environment != "" { | ||
| c, err := autoconf.New( | ||
| autoconf.WithRegion(config.Region), | ||
| autoconf.WithEnv(config.Environment)) | ||
| if err == nil { | ||
| theService := c.Service("dbs") | ||
| if theService.URL != "" && config.BaseURL == "" { | ||
| config.BaseURL = theService.URL | ||
| } | ||
| } | ||
| } | ||
| } | ||
|
|
||
| // Close releases allocated resources of clients | ||
| func (c *Client) Close() { | ||
| } | ||
|
|
||
| // GetBaseURL returns the base URL as configured | ||
| func (c *Client) GetBaseURL() string { | ||
| if c.baseURL == nil { | ||
| return "" | ||
| } | ||
| return c.baseURL.String() | ||
| } | ||
|
|
||
| // SetBaseURL sets the base URL for API requests | ||
| func (c *Client) SetBaseURL(urlStr string) error { | ||
| if urlStr == "" { | ||
| return ErrBaseURLCannotBeEmpty | ||
| } | ||
| // Make sure the given URL ends with a slash | ||
| if !strings.HasSuffix(urlStr, "/") { | ||
| urlStr += "/" | ||
| } | ||
| var err error | ||
| c.baseURL, err = url.Parse(urlStr) | ||
| return err | ||
| } | ||
|
|
||
| // GetEndpointURL returns the Discovery Endpoint URL as configured | ||
| func (c *Client) GetEndpointURL() string { | ||
| return c.GetBaseURL() | ||
| } | ||
|
|
||
| func (c *Client) NewRequest(method, requestPath string, opt interface{}, options ...OptionFunc) (*http.Request, error) { | ||
| u := *c.baseURL | ||
| // Set the encoded opaque data | ||
| u.Opaque = path.Join(c.baseURL.Path, requestPath) | ||
|
|
||
| req := &http.Request{ | ||
| Method: method, | ||
| URL: &u, | ||
| Proto: "HTTP/1.1", | ||
| ProtoMajor: 1, | ||
| ProtoMinor: 1, | ||
| Header: make(http.Header), | ||
| Host: u.Host, | ||
| } | ||
| if opt != nil { | ||
| q, err := query.Values(opt) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| u.RawQuery = strings.Replace(q.Encode(), "+", "%20", -1) // https://github.com/golang/go/issues/4013 | ||
| } | ||
|
|
||
| if method == "POST" || method == "PUT" { | ||
| bodyBytes, err := json.Marshal(opt) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| bodyReader := bytes.NewReader(bodyBytes) | ||
|
|
||
| u.RawQuery = "" | ||
| req.Body = io.NopCloser(bodyReader) | ||
| req.ContentLength = int64(bodyReader.Len()) | ||
| req.Header.Set("Content-Type", "application/json") | ||
| } | ||
| token, err := c.Token() | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
| req.Header.Set("Accept", "application/json") | ||
| req.Header.Set("Authorization", "Bearer "+token) | ||
| req.Header.Set("API-Version", APIVersion) | ||
| if c.UserAgent != "" { | ||
| req.Header.Set("User-Agent", c.UserAgent) | ||
| } | ||
| for _, fn := range options { | ||
| if fn == nil { | ||
| continue | ||
| } | ||
| if err := fn(req); err != nil { | ||
| return nil, err | ||
| } | ||
| } | ||
| return req, nil | ||
| } | ||
|
|
||
| // Response is a HSDP DBS API response. This wraps the standard http.Response | ||
| // returned from HSDP DBS and provides convenient access to things like errors | ||
| type Response struct { | ||
| *http.Response | ||
| } | ||
|
|
||
| func (r *Response) StatusCode() int { | ||
| if r.Response != nil { | ||
| return r.Response.StatusCode | ||
| } | ||
| return 0 | ||
| } | ||
|
|
||
| // newResponse creates a new Response for the provided http.Response. | ||
| func newResponse(r *http.Response) *Response { | ||
| response := &Response{Response: r} | ||
| return response | ||
| } | ||
|
|
||
| // Do performs a http request. If v implements the io.Writer | ||
| // interface, the raw response body will be written to v, without attempting to | ||
| // first decode it. | ||
| func (c *Client) Do(req *http.Request, v interface{}) (*Response, error) { | ||
| resp, err := c.HttpClient().Do(req) | ||
| if err != nil { | ||
| return nil, err | ||
| } | ||
|
|
||
| response := newResponse(resp) | ||
|
|
||
| err = internal.CheckResponse(resp) | ||
| if err != nil { | ||
| // even though there was an error, we still return the response | ||
| // in case the caller wants to inspect it further | ||
| return response, err | ||
| } | ||
|
|
||
| if v != nil { | ||
| defer func() { | ||
| _ = resp.Body.Close() | ||
| }() // Only close if we plan to read it | ||
| if w, ok := v.(io.Writer); ok { | ||
| _, err = io.Copy(w, resp.Body) | ||
| } else { | ||
| err = json.NewDecoder(resp.Body).Decode(v) | ||
| } | ||
| } | ||
|
|
||
| return response, err | ||
| } |
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,22 @@ | ||
| package dbs | ||
|
|
||
| import ( | ||
| "errors" | ||
| ) | ||
|
|
||
| var ( | ||
| ErrNotFound = errors.New("entity not found") | ||
| ErrBaseURLCannotBeEmpty = errors.New("base URL cannot be empty") | ||
| ErrEmptyResult = errors.New("empty result") | ||
| ErrInvalidEndpointURL = errors.New("invalid endpoint URL") | ||
| ErrMissingName = errors.New("missing name value") | ||
| ErrMissingDescription = errors.New("missing description value") | ||
| ErrMalformedInputValue = errors.New("malformed input value") | ||
| ErrMissingOrganization = errors.New("missing organization") | ||
| ErrMissingProposition = errors.New("missing proposition") | ||
| ErrMissingGlobalReference = errors.New("missing global reference") | ||
| ErrNotImplementedByHSDP = errors.New("method not implemented by HSDP") | ||
| ErrEmptyResults = errors.New("empty results") | ||
| ErrOperationFailed = errors.New("operation failed") | ||
| ErrCouldNoReadResourceAfterCreate = errors.New("could not read resource after create") | ||
| ) |
Oops, something went wrong.