Merge pull request #28 from philips-software/feature/cdr

CDR tenant onboarding

Author: loafoe

README.md

@@ -13,8 +13,8 @@ The current implement covers only a subset of HSDP APIs. Basically we implement
 
 - [x] Cartel c.q. Container Host management ([examples](cartel/README.md))
 - [x] IronIO tasks, codes and schedules management ([examples](iron/README.md))
-- [x] HSDP PKI services
-- [x] HSDP IAM/IDM management
+- [x] PKI services
+- [x] IAM/IDM management
   - [x] Groups
   - [x] Organizations
   - [x] Permissions
@@ -29,6 +29,16 @@ The current implement covers only a subset of HSDP APIs. Basically we implement
   - [x] Password Policies
 - [x] Logging ([examples](logging/README.md))
 - [ ] Auditing
+- [x] Clinical Data Repository (CDR)
+  - [x] Tenant Onboarding
+  - [ ] Subscription management
+  - [x] FHIR Patch 
+  - [x] FHIR Post
+  - [ ] FHIR Put
+  - [ ] FHIR Delete
+- [x] Telemetry Data Repository (TDR)
+  - [x] Contract management
+  - [x] Data Item management
 - [x] S3 Credentials Policy management
 - [x] Hosted Application Streaming (HAS) management
 - [x] Configuration

cdr/client.go

@@ -0,0 +1,237 @@
+// Package pki provides support for HSDP CDR service
+//
+// We only intent to support the CDR FHIR STU3 and newer with this library.
+package cdr
+
+import (
+	"bytes"
+	"encoding/json"
+	"fmt"
+	"io"
+	"io/ioutil"
+	"net/http"
+	"net/http/httputil"
+	"net/url"
+	"os"
+	"strings"
+
+	"github.com/google/fhir/go/jsonformat"
+
+	"github.com/philips-software/go-hsdp-api/iam"
+)
+
+const (
+	libraryVersion = "0.27.0"
+	userAgent      = "go-hsdp-api/cdr/" + 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
+	RootOrgID   string
+	CDRURL      string
+	FHIRStore   string
+	TimeZone    string
+	DebugLog    string
+}
+
+// A Client manages communication with HSDP CDR API
+type Client struct {
+	// HTTP client used to communicate with IAM API
+	iamClient *iam.Client
+
+	config *Config
+
+	fhirStoreURL *url.URL
+
+	// User agent used when communicating with the HSDP IAM API.
+	UserAgent string
+
+	TenantSTU3     *TenantSTU3Service
+	OperationsSTU3 *OperationsSTU3Service
+
+	debugFile *os.File
+}
+
+// NewClient returns a new HSDP CDR API client. Configured console and IAM clients
+// must be provided as the underlying API requires tokens from respective services
+func NewClient(iamClient *iam.Client, config *Config) (*Client, error) {
+	return newClient(iamClient, config)
+}
+
+func newClient(iamClient *iam.Client, config *Config) (*Client, error) {
+	c := &Client{iamClient: iamClient, config: config, UserAgent: userAgent}
+	fhirStore := config.FHIRStore
+	if fhirStore == "" {
+		fhirStore = config.CDRURL + "/store/fhir/"
+	}
+	if err := c.SetFHIRStoreURL(fhirStore); err != nil {
+		return nil, err
+	}
+	if config.DebugLog != "" {
+		var err error
+		c.debugFile, err = os.OpenFile(config.DebugLog, os.O_APPEND|os.O_CREATE|os.O_WRONLY, 0600)
+		if err != nil {
+			c.debugFile = nil
+		}
+	}
+	ma, err := jsonformat.NewMarshaller(false, "", "", jsonformat.STU3)
+	if err != nil {
+		return nil, err
+	}
+	um, err := jsonformat.NewUnmarshaller(config.TimeZone, jsonformat.STU3)
+	if err != nil {
+		return nil, err
+	}
+
+	c.TenantSTU3 = &TenantSTU3Service{timeZone: config.TimeZone, client: c, ma: ma, um: um}
+	c.OperationsSTU3 = &OperationsSTU3Service{timeZone: config.TimeZone, client: c, ma: ma, um: um}
+
+	return c, nil
+}
+
+// Close releases allocated resources of clients
+func (c *Client) Close() {
+	if c.debugFile != nil {
+		_ = c.debugFile.Close()
+		c.debugFile = nil
+	}
+}
+
+// GetFHIRStoreURL returns the base FHIR Store URL as configured
+func (c *Client) GetFHirStoreURL() string {
+	if c.fhirStoreURL == nil {
+		return ""
+	}
+	return c.fhirStoreURL.String()
+}
+
+// SetFHIRStoreURL sets the base URL for API requests to a custom endpoint. urlStr
+// should always be specified with a trailing slash.
+func (c *Client) SetFHIRStoreURL(urlStr string) error {
+	if urlStr == "" {
+		return ErrCDRURLCannotBeEmpty
+	}
+	// Make sure the given URL end with a slash
+	if !strings.HasSuffix(urlStr, "/") {
+		urlStr += "/"
+	}
+
+	var err error
+	c.fhirStoreURL, err = url.Parse(urlStr)
+	return err
+}
+
+// NewCDRRequest creates an new CDR Service API request. A relative URL path can be provided in
+// urlStr, in which case it is resolved relative to the base URL of the Client.
+// Relative URL paths should always be specified without a preceding slash. If
+// specified, the value pointed to by body is JSON encoded and included as the
+// request body.
+func (c *Client) NewCDRRequest(method, path string, bodyBytes []byte, options []OptionFunc) (*http.Request, error) {
+	u := *c.fhirStoreURL
+	// Set the encoded opaque data
+	u.Opaque = c.fhirStoreURL.Path + c.config.RootOrgID + "/" + path
+
+	req := &http.Request{
+		Method:     method,
+		URL:        &u,
+		Proto:      "HTTP/1.1",
+		ProtoMajor: 1,
+		ProtoMinor: 1,
+		Header:     make(http.Header),
+		Host:       u.Host,
+	}
+
+	for _, fn := range options {
+		if fn == nil {
+			continue
+		}
+
+		if err := fn(req); err != nil {
+			return nil, err
+		}
+	}
+
+	if method == "POST" || method == "PUT" || method == "PATCH" {
+		bodyReader := bytes.NewReader(bodyBytes)
+
+		u.RawQuery = ""
+		req.Body = ioutil.NopCloser(bodyReader)
+		req.ContentLength = int64(bodyReader.Len())
+	}
+
+	req.Header.Set("Accept", "*/*")
+	req.Header.Set("Authorization", "Bearer "+c.iamClient.Token())
+	req.Header.Set("API-Version", APIVersion)
+
+	if c.UserAgent != "" {
+		req.Header.Set("User-Agent", c.UserAgent)
+	}
+	return req, nil
+}
+
+// Response is a HSDP IAM API response. This wraps the standard http.Response
+// returned from HSDP IAM and provides convenient access to things like errors
+type Response struct {
+	*http.Response
+}
+
+// newResponse creates a new Response for the provided http.Response.
+func newResponse(r *http.Response) *Response {
+	response := &Response{Response: r}
+	return response
+}
+
+// Do executes 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) {
+	if c.debugFile != nil {
+		dumped, _ := httputil.DumpRequest(req, true)
+		out := fmt.Sprintf("[go-hsdp-api] --- Request start ---\n%s\n[go-hsdp-api] Request end ---\n", string(dumped))
+		_, _ = c.debugFile.WriteString(out)
+	}
+	resp, err := c.iamClient.HttpClient().Do(req)
+	if c.debugFile != nil && resp != nil {
+		dumped, _ := httputil.DumpResponse(resp, true)
+		out := fmt.Sprintf("[go-hsdp-api] --- Response start ---\n%s\n[go-hsdp-api] --- Response end ---\n", string(dumped))
+		_, _ = c.debugFile.WriteString(out)
+	}
+	if err != nil {
+		return nil, err
+	}
+
+	response := newResponse(resp)
+
+	err = 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 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
+}
+
+// CheckResponse checks the API response for errors, and returns them if present.
+func CheckResponse(r *http.Response) error {
+	switch r.StatusCode {
+	case 200, 201, 202, 204, 304:
+		return nil
+	}
+	return ErrNonHttp20xResponse
+}