add raw client and noaa helper

Author: ArthurHlt

README.md

@@ -15,6 +15,7 @@ package main
 
 import (
 	"github.com/cloudfoundry-community/go-cf-clients-helper" // package name is clients
+	"fmt"
 )
 
 func main() {
@@ -45,5 +46,20 @@ func main() {
 
 	// Get access to logs api and metrics through noaa
 	session.NOAA()
+	// you can use helper for retrieving log messages for an app
+	h := clients.NewNOAAHelper(session.NOAA(), session.ConfigStore())
+	msgs, err := h.RecentLogs("app-guid", 0) // 0 means no limit of messages to see
+	if err != nil {
+        panic(err)
+    }
+	fmt.Println(msgs)
+	
+	// Get an http client which pass authorization header to call api(s) directly 
+	session.Raw()
+    
+	// Get config store for client which need, for example, current access token (e.g.: NOAA) 
+	session.ConfigStore()
+	
+	
 }
 ```

noaahelper.go

@@ -0,0 +1,58 @@
+package clients
+
+import (
+	"code.cloudfoundry.org/cli/util/configv3"
+	"fmt"
+	noaaconsumer "github.com/cloudfoundry/noaa/consumer"
+	"github.com/cloudfoundry/sonde-go/events"
+	"strings"
+	"time"
+)
+
+const LogTimestampFormat = "2006-01-02T15:04:05.00-0700"
+
+type NOAAHelper struct {
+	consumer    *noaaconsumer.Consumer
+	configStore *configv3.Config
+}
+
+func NewNOAAHelper(consumer *noaaconsumer.Consumer, configStore *configv3.Config) *NOAAHelper {
+	return &NOAAHelper{
+		consumer:    consumer,
+		configStore: configStore,
+	}
+}
+
+func (c NOAAHelper) RecentLogs(appGUID string, maxMessages int) (string, error) {
+	logMsgs, err := c.consumer.RecentLogs(appGUID, c.configStore.AccessToken())
+	if err != nil {
+		return "", err
+	}
+	maxLen := maxMessages
+	if maxLen < 0 || len(logMsgs) < maxLen {
+		maxLen = len(logMsgs)
+	}
+	if maxLen-1 < 0 {
+		return "", nil
+	}
+	logs := ""
+	for i := maxLen - 1; i >= 0; i-- {
+		logMsg := logMsgs[i]
+		t := time.Unix(0, logMsg.GetTimestamp()).In(time.Local).Format(LogTimestampFormat)
+		typeMessage := "OUT"
+		if logMsg.GetMessageType() != events.LogMessage_OUT {
+			typeMessage = "ERR"
+		}
+		header := fmt.Sprintf("%s [%s/%s] %s ",
+			t,
+			logMsg.GetSourceType(),
+			logMsg.GetSourceInstance(),
+			typeMessage,
+		)
+		message := string(logMsg.GetMessage())
+		for _, line := range strings.Split(message, "\n") {
+			logs += fmt.Sprintf("\t%s%s\n", header, strings.TrimRight(line, "\r\n"))
+		}
+	}
+	return logs, nil
+}

rawclient.go

@@ -0,0 +1,78 @@
+package clients
+
+import (
+	"code.cloudfoundry.org/cli/api/cloudcontroller"
+	"code.cloudfoundry.org/cli/api/cloudcontroller/ccv3"
+	"crypto/tls"
+	"io"
+	"net"
+	"net/http"
+	"strings"
+	"time"
+)
+
+type rawConnection struct {
+	httpClient *http.Client
+}
+
+func (c rawConnection) Make(request *cloudcontroller.Request, passedResponse *cloudcontroller.Response) error {
+	response, err := c.httpClient.Do(request.Request)
+	if err != nil {
+		return err
+	}
+	passedResponse.HTTPResponse = response
+	return nil
+}
+
+// RawClientConfig - configuration for RawClient
+type RawClientConfig struct {
+	DialTimeout       time.Duration
+	SkipSSLValidation bool
+	ApiEndpoint       string
+}
+
+// Raw http client has uaa client authentication to make raw request with golang native api.
+type RawClient struct {
+	connection  cloudcontroller.Connection
+	apiEndpoint string
+	wrappers    []ccv3.ConnectionWrapper
+}
+
+// NewRawClient -
+func NewRawClient(config RawClientConfig, wrappers ...ccv3.ConnectionWrapper) *RawClient {
+	httpClient := &http.Client{
+		Transport: &http.Transport{
+			TLSClientConfig: &tls.Config{
+				InsecureSkipVerify: config.SkipSSLValidation,
+			},
+			Proxy: http.ProxyFromEnvironment,
+			DialContext: (&net.Dialer{
+				KeepAlive: 30 * time.Second,
+				Timeout:   config.DialTimeout,
+			}).DialContext,
+		},
+	}
+	var connection cloudcontroller.Connection = &rawConnection{httpClient}
+	for _, wrapper := range wrappers {
+		connection = wrapper.Wrap(connection)
+	}
+	return &RawClient{
+		connection:  connection,
+		apiEndpoint: strings.TrimSuffix(config.ApiEndpoint, "/"),
+		wrappers:    wrappers,
+	}
+}
+
+// Do - Do the request with given http client and wrappers
+func (c RawClient) Do(req *http.Request) (*http.Response, error) {
+	resp := &cloudcontroller.Response{}
+	err := c.connection.Make(&cloudcontroller.Request{
+		Request: req,
+	}, resp)
+	return resp.HTTPResponse, err
+}
+
+// NewRequest - Create a new request with setting api endpoint to the path
+func (c RawClient) NewRequest(method, path string, body io.ReadCloser) (*http.Request, error) {
+	return http.NewRequest(method, c.apiEndpoint+path, body)
+}

session.go

@@ -25,6 +25,7 @@ type Session struct {
 	clientV2  *ccv2.Client
 	clientV3  *ccv3.Client
 	clientUAA *uaa.Client
+	rawClient *RawClient
 
 	// To call tcp routing with this router
 	routerClient *router.Client
@@ -35,7 +36,8 @@ type Session struct {
 	// netClient permit to access to networking policy api
 	netClient *cfnetv1.Client
 
-	config Config
+	config      Config
+	configStore *configv3.Config
 }
 
 // NewSession -
@@ -68,6 +70,7 @@ func NewSession(c Config) (s *Session, err error) {
 			BinaryName: "terraform-provider",
 		},
 	}
+	s.configStore = config
 	uaaClientId := c.UaaClientID
 	uaaClientSecret := c.UaaClientSecret
 	if uaaClientId == "" {
@@ -120,6 +123,16 @@ func (s *Session) NOAA() *noaaconsumer.Consumer {
 	return s.noaaClient
 }
 
+// Give an http client which pass authorization header to call api(s) directly
+func (s *Session) Raw() *RawClient {
+	return s.rawClient
+}
+
+// Give config store for client which need access token (e.g.: NOAA)
+func (s *Session) ConfigStore() *configv3.Config {
+	return s.configStore
+}
+
 func (s *Session) init(config *configv3.Config, configUaa *configv3.Config, configSess Config) error {
 	// -------------------------
 	// Create v3 and v2 clients
@@ -299,7 +312,11 @@ func (s *Session) init(config *configv3.Config, configUaa *configv3.Config, conf
 	if s.IsDebugMode() {
 		rawWrappers = append(rawWrappers, ccWrapper.NewRequestLogger(NewRequestLogger()))
 	}
-
+	s.rawClient = NewRawClient(RawClientConfig{
+		ApiEndpoint:       config.Target(),
+		SkipSSLValidation: config.SkipSSLValidation(),
+		DialTimeout:       config.DialTimeout(),
+	}, rawWrappers...)
 	// -------------------------
 
 	// -------------------------