Three legged model translation requirements

.gitignore

@@ -65,3 +65,6 @@ crashlytics.properties
 crashlytics-build.properties
 fabric.properties
 .idea/
+
+# Mac
+.DS_Store

assets/TestFile.txt

@@ -0,0 +1 @@
+Test test 1 2 3

dm/bucket.go

@@ -3,12 +3,9 @@ package dm
 import (
 	"bytes"
 	"encoding/json"
-	"errors"
-	"io/ioutil"
 	"net/http"
 	"strconv"
-
-	"github.com/apprentice3d/forge-api-go-client/oauth"
+	"github.com/outer-labs/forge-api-go-client/oauth"
 )
 
 // BucketAPI holds the necessary data for making Bucket related calls to Forge Data Management service
@@ -46,6 +43,11 @@ type BucketDetails struct {
 // ErrorResult reflects the body content when a request failed (g.e. Bad request or key conflict)
 type ErrorResult struct {
 	Reason string `json:"reason"`
+  StatusCode int
+}
+
+func (e *ErrorResult) Error() string{
+  return "[" + strconv.Itoa(e.StatusCode) + "] " + e.Reason
 }
 
 // ListedBuckets reflects the response when query Data Management API for buckets associated with current Forge secrets.
@@ -61,7 +63,6 @@ type ListedBuckets struct {
 
 // CreateBucket creates and returns details of created bucket, or an error on failure
 func (api BucketAPI) CreateBucket(bucketKey, policyKey string) (result BucketDetails, err error) {
-
 	bearer, err := api.Authenticate("bucket:create")
 	if err != nil {
 		return
@@ -106,10 +107,6 @@ func (api BucketAPI) GetBucketDetails(bucketKey string) (result BucketDetails, e
 	return getBucketDetails(path, bucketKey, bearer.AccessToken)
 }
 
-
-
-
-
 /*
  *	SUPPORT FUNCTIONS
  */
@@ -132,13 +129,13 @@ func getBucketDetails(path, bucketKey, token string) (result BucketDetails, err
 	}
 	defer response.Body.Close()
 
+  decoder := json.NewDecoder(response.Body)
 	if response.StatusCode != http.StatusOK {
-		content, _ := ioutil.ReadAll(response.Body)
-		err = errors.New("[" + strconv.Itoa(response.StatusCode) + "] " + string(content))
+    err = &ErrorResult{StatusCode:response.StatusCode}
+    decoder.Decode(err)
 		return
 	}
 
-	decoder := json.NewDecoder(response.Body)
 	err = decoder.Decode(&result)
 
 	return
@@ -175,14 +172,13 @@ func listBuckets(path, region, limit, startAt, token string) (result ListedBucke
 		return
 	}
 	defer response.Body.Close()
-
+  decoder := json.NewDecoder(response.Body)
 	if response.StatusCode != http.StatusOK {
-		content, _ := ioutil.ReadAll(response.Body)
-		err = errors.New("[" + strconv.Itoa(response.StatusCode) + "] " + string(content))
+    err = &ErrorResult{StatusCode:response.StatusCode}
+    decoder.Decode(err)
 		return
 	}
 
-	decoder := json.NewDecoder(response.Body)
 	err = decoder.Decode(&result)
 
 	return
@@ -217,14 +213,13 @@ func createBucket(path, bucketKey, policyKey, token string) (result BucketDetail
 	}
 	defer response.Body.Close()
 
+	decoder := json.NewDecoder(response.Body)
 	if response.StatusCode != http.StatusOK {
-		content, _ := ioutil.ReadAll(response.Body)
-		err = errors.New("[" + strconv.Itoa(response.StatusCode) + "] " + string(content))
+    	err = &ErrorResult{StatusCode:response.StatusCode}
+    	decoder.Decode(err)
 		return
 	}
 
-	decoder := json.NewDecoder(response.Body)
-
 	err = decoder.Decode(&result)
 
 	return
@@ -248,10 +243,10 @@ func deleteBucket(path, bucketKey, token string) (err error) {
 		return
 	}
 	defer response.Body.Close()
-
+  decoder := json.NewDecoder(response.Body)
 	if response.StatusCode != http.StatusOK {
-		content, _ := ioutil.ReadAll(response.Body)
-		err = errors.New("[" + strconv.Itoa(response.StatusCode) + "] " + string(content))
+    err = &ErrorResult{StatusCode:response.StatusCode}
+    decoder.Decode(err)
 		return
 	}
 

dm/bucket_test.go

@@ -2,17 +2,22 @@ package dm_test
 
 import (
 	"fmt"
-	"github.com/apprentice3d/forge-api-go-client/dm"
-	"log"
 	"os"
 	"testing"
+
+	"github.com/outer-labs/forge-api-go-client/dm"
 )
 
 func TestBucketAPI_CreateBucket(t *testing.T) {
 
 	// prepare the credentials
 	clientID := os.Getenv("FORGE_CLIENT_ID")
 	clientSecret := os.Getenv("FORGE_CLIENT_SECRET")
+
+	if clientID == "" || clientSecret == "" {
+		t.Skipf("No Forge credentials present; skipping test")
+	}
+
 	bucketAPI := dm.NewBucketAPIWithCredentials(clientID, clientSecret)
 
 	t.Run("Create a bucket", func(t *testing.T) {
@@ -53,6 +58,11 @@ func TestBucketAPI_GetBucketDetails(t *testing.T) {
 	// prepare the credentials
 	clientID := os.Getenv("FORGE_CLIENT_ID")
 	clientSecret := os.Getenv("FORGE_CLIENT_SECRET")
+
+	if clientID == "" || clientSecret == "" {
+		t.Skipf("No Forge credentials present; skipping test")
+	}
+
 	bucketAPI := dm.NewBucketAPIWithCredentials(clientID, clientSecret)
 
 	testBucketKey := "my_test_bucket_key_for_go"
@@ -95,6 +105,11 @@ func TestBucketAPI_ListBuckets(t *testing.T) {
 	// prepare the credentials
 	clientID := os.Getenv("FORGE_CLIENT_ID")
 	clientSecret := os.Getenv("FORGE_CLIENT_SECRET")
+
+	if clientID == "" || clientSecret == "" {
+		t.Skipf("No Forge credentials present; skipping test")
+	}
+
 	bucketAPI := dm.NewBucketAPIWithCredentials(clientID, clientSecret)
 
 	t.Run("List available buckets", func(t *testing.T) {
@@ -106,7 +121,9 @@ func TestBucketAPI_ListBuckets(t *testing.T) {
 	})
 
 	t.Run("Create a bucket and find it among listed", func(t *testing.T) {
+
 		testBucketKey := "just_for_testing"
+
 		_, err := bucketAPI.CreateBucket(testBucketKey, "transient")
 
 		if err != nil {
@@ -122,6 +139,7 @@ func TestBucketAPI_ListBuckets(t *testing.T) {
 		found := false
 
 		for _, bucket := range list.Items {
+
 			if bucket.BucketKey == testBucketKey {
 				found = true
 				break
@@ -144,12 +162,13 @@ func ExampleBucketAPI_CreateBucket() {
 	// prepare the credentials
 	clientID := os.Getenv("FORGE_CLIENT_ID")
 	clientSecret := os.Getenv("FORGE_CLIENT_SECRET")
+
 	bucketAPI := dm.NewBucketAPIWithCredentials(clientID, clientSecret)
 
 	bucket, err := bucketAPI.CreateBucket("some_unique_name", "transient")
 
 	if err != nil {
-		log.Fatalf("Failed to create a bucket: %s\n", err.Error())
+		// handle error
 	}
 
 	fmt.Printf("Bucket %s was created with policy %s\n",

dm/bucket_three_legged.go

@@ -0,0 +1,66 @@
+package dm
+
+import (
+	"github.com/outer-labs/forge-api-go-client/oauth"
+)
+
+// BucketAPI holds the necessary data for making Bucket related calls to Forge Data Management service
+type BucketAPI3L struct {
+	Auth           oauth.ThreeLeggedAuth
+	Token          TokenRefresher
+	BucketsAPIPath string
+}
+
+// NewBucketAPIWithCredentials returns a Bucket API client with default configurations
+func NewBucketAPI3LWithCredentials(auth oauth.ThreeLeggedAuth, token TokenRefresher) *BucketAPI3L {
+	return &BucketAPI3L{
+		Auth:           auth,
+		Token:          token,
+		BucketsAPIPath: "/oss/v2/buckets",
+	}
+}
+
+// CreateBucket creates and returns details of created bucket, or an error on failure
+func (api BucketAPI3L) CreateBucket3L(bucketKey, policyKey string) (result BucketDetails, err error) {
+	if err = api.Token.RefreshTokenIfRequired(api.Auth); err != nil {
+		return
+	}
+
+	path := api.Auth.Host + api.BucketsAPIPath
+	result, err = createBucket(path, bucketKey, policyKey, api.Token.Bearer().AccessToken)
+
+	return
+}
+
+// DeleteBucket deletes bucket given its key.
+// 	WARNING: The bucket delete call is undocumented.
+func (api BucketAPI3L) DeleteBucket3L(bucketKey string) error {
+	if err := api.Token.RefreshTokenIfRequired(api.Auth); err != nil {
+		return err
+	}
+
+	path := api.Auth.Host + api.BucketsAPIPath
+
+	return deleteBucket(path, bucketKey, api.Token.Bearer().AccessToken)
+}
+
+// ListBuckets returns a list of all buckets created or associated with Forge secrets used for token creation
+func (api BucketAPI3L) ListBuckets3L(region, limit, startAt string) (result ListedBuckets, err error) {
+	if err = api.Token.RefreshTokenIfRequired(api.Auth); err != nil {
+		return
+	}
+
+	path := api.Auth.Host + api.BucketsAPIPath
+
+	return listBuckets(path, region, limit, startAt, api.Token.Bearer().AccessToken)
+}
+
+// GetBucketDetails returns information associated to a bucket. See BucketDetails struct.
+func (api BucketAPI3L) GetBucketDetails3L(bucketKey string) (result BucketDetails, err error) {
+	if err = api.Token.RefreshTokenIfRequired(api.Auth); err != nil {
+		return
+	}
+
+	path := api.Auth.Host + api.BucketsAPIPath
+	return getBucketDetails(path, bucketKey, api.Token.Bearer().AccessToken)
+}

dm/common.go

@@ -0,0 +1,101 @@
+package dm
+
+type ForgeResponseObject struct {
+	JsonApi  JsonAPI `json:"jsonApi`
+	Links    Links   `json:"links"`
+	Data     Data    `json:"data"`
+	Included *[]Data `json:"included, omitempty"`
+}
+
+type ForgeResponseArray struct {
+	JsonApi  JsonAPI `json:"jsonApi`
+	Links    Links   `json:"links"`
+	Data     []Data  `json:"data"`
+	Included *[]Data `json:"included, omitempty"`
+}
+
+type JsonAPI struct {
+	Version string `json:"version"`
+}
+
+type Links struct {
+	Self    *Href `json:"self, omitempty"`
+	Related *Href `json:"related, omitempty"`
+	First   *Href `json:"first, omitempty"`
+	Prev    *Href `json:"prev, omitempty"`
+	Next    *Href `json:"next, omitempty"`
+}
+
+type Data struct {
+	Type          string         `json:"type"`
+	Id            string         `json:"id"`
+	Attributes    *Attributes    `json:"attributes, omitempty"`
+	Relationships *Relationships `json:"relationships, omitempty"`
+	Links         *Links         `json:"links, omitempty"`
+}
+
+type Attributes struct {
+	Name                 string    `json:"name"`
+	Extension            Extension `json:"extension"`
+	Region               *string   `json:"region, omitempty"`
+	Scopes               *[]string `json:"scopes, omitempty"`
+	DisplayName          *string   `json:"displayName, omitempty"`
+	ObjectCount          *int      `json:"objectCount, omitempty"`
+	CreateTime           *string   `json:"createTime, omitempty"`
+	CreateUserId         *string   `json:"createUserId, omitempty"`
+	CreateUserName       *string   `json:"createUserName, omitempty"`
+	LastModifiedTime     *string   `json:"lastModifiedTime, omitempty"`
+	LastModifiedUserId   *string   `json:"lastModifiedUserId, omitempty"`
+	LastModifiedUserName *string   `json:"lastModifiedUserName, omitempty"`
+	Hidden               *bool     `json:"displayName, omitempty"`
+	VersionNumber        *int      `json:"versionNumber, omitempty"`
+	Mimetype             *string   `json:"mimeType, omitempty"`
+	FileType             *string   `json:"fileType, omitempty"`
+	StorageSize          *int      `json:"storageSize, omitempty"`
+	Reserved             *bool     `json:"reserved, omitempty"`
+	ReservedTime         *string   `json:"reservedTime, omitempty"`
+	ReservedUserId       *string   `json:"reservedUserId, omitempty"`
+	ReservedUserName     *string   `json:"reservedUserName, omitempty"`
+	PathInProject        *string   `json:"pathInProject, omitempty"`
+}
+
+type Relationships struct {
+	Hub             *RelatedLinks `json:"hub, omitempty"`
+	Projects        *RelatedLinks `json:projects, omitempty"`
+	RootFolder      *RelatedLinks `json:"rootFolder, omitempty"`
+	TopFolders      *RelatedLinks `json:"topFolders, omitempty"`
+	Parent          *RelatedLinks `json:"parent, omitempty"`
+	Tip             *RelatedLinks `json:"tip, omitempty"`
+	Versions        *RelatedLinks `json:"versions, omitempty"`
+	Contents        *RelatedLinks `json:"contents, omitempty"`
+	Refs            *RelatedLinks `json:"refs, omitempty"`
+	Links           *RelatedLinks `json:"links, omitempty"`
+	Item            *RelatedLinks `json:"item, omitempty"`
+	Storage         *RelatedLinks `json:"storage, omitempty"`
+	Derivatives     *RelatedLinks `json:"derivatives, omitempty"`
+	Thumbnails      *RelatedLinks `json:"thumbnails, omitempty"`
+	DownloadFormats *RelatedLinks `json:"downloadFormats, omitempty"`
+}
+
+type Extension struct {
+	Type    string   `json:"type"`
+	Version string   `json:"version"`
+	Schema  Href     `json:"schema"`
+	Data    struct{} `json:"data"`
+}
+
+type RelatedLinks struct {
+	Meta  *Meta  `json:"meta, omitempty"`
+	Links *Links `json:"links, omitempty"`
+	Data  *Data  `json:"data, omitempty"`
+}
+
+type Meta struct {
+	Link Href `json:"href"`
+}
+
+type Href struct {
+	Href string `json:"href"`
+}
+
+// Note on use of omitempty: https://www.sohamkamani.com/blog/golang/2018-07-19-golang-omitempty/