Add internal models

These internal models are introduced to reduce decoupling. The idea is to operate internal model within the project boundaries and convert to appropriate Connect or SDK models in the places where it's necessary.

pkg/onepassword/model/file.go

@@ -0,0 +1,27 @@
+package model
+
+import (
+	"errors"
+)
+
+// File represents a file stored in 1Password.
+type File struct {
+	ID          string
+	Name        string
+	Size        int
+	ContentPath string
+	content     []byte
+}
+
+// Content returns the content of the file if they have been loaded and returns an error if they have not been loaded.
+// Use `client.GetFileContent(file *File)` instead to make sure the content is fetched automatically if not present.
+func (f *File) Content() ([]byte, error) {
+	if f.content == nil {
+		return nil, errors.New("file content not loaded")
+	}
+	return f.content, nil
+}
+
+func (f *File) SetContent(content []byte) {
+	f.content = content
+}

pkg/onepassword/model/item.go

@@ -0,0 +1,87 @@
+package model
+
+import (
+	"time"
+
+	connect "github.com/1Password/connect-sdk-go/onepassword"
+	sdk "github.com/1password/onepassword-sdk-go"
+)
+
+// Item represents 1Password item.
+type Item struct {
+	ID        string
+	VaultID   string
+	Version   int
+	Tags      []string
+	Fields    []ItemField
+	Files     []File
+	CreatedAt time.Time
+}
+
+// FromConnectItem populates the Item from a Connect item.
+func (i *Item) FromConnectItem(item *connect.Item) {
+	i.ID = item.ID
+	i.VaultID = item.Vault.ID
+	i.Version = item.Version
+
+	for _, tag := range item.Tags {
+		i.Tags = append(i.Tags, tag)
+	}
+
+	for _, field := range item.Fields {
+		i.Fields = append(i.Fields, ItemField{
+			Label: field.Label,
+			Value: field.Value,
+		})
+	}
+
+	for _, file := range item.Files {
+		i.Files = append(i.Files, File{
+			ID:   file.ID,
+			Name: file.Name,
+			Size: file.Size,
+		})
+	}
+
+	i.CreatedAt = item.CreatedAt
+}
+
+// FromSDKItem populates the Item from an SDK item.
+func (i *Item) FromSDKItem(item *sdk.Item) {
+	i.ID = item.ID
+	i.VaultID = item.VaultID
+	i.Version = int(item.Version)
+
+	for _, tag := range item.Tags {
+		i.Tags = append(i.Tags, tag)
+	}
+
+	for _, field := range item.Fields {
+		i.Fields = append(i.Fields, ItemField{
+			Label: field.Title,
+			Value: field.Value,
+		})
+	}
+
+	for _, file := range item.Files {
+		i.Files = append(i.Files, File{
+			ID:   file.Attributes.ID,
+			Name: file.Attributes.Name,
+			Size: int(file.Attributes.Size),
+		})
+	}
+
+	i.CreatedAt = item.CreatedAt
+}
+
+// FromSDKItemOverview populates the Item from an SDK item overview.
+func (i *Item) FromSDKItemOverview(item *sdk.ItemOverview) {
+	i.ID = item.ID
+	i.VaultID = item.VaultID
+
+	for _, tag := range item.Tags {
+		i.Tags = append(i.Tags, tag)
+	}
+
+	i.CreatedAt = item.CreatedAt
+}

pkg/onepassword/model/item_field.go

@@ -0,0 +1,7 @@
+package model
+
+// ItemField Representation of a single field on an Item
+type ItemField struct {
+	Label string
+	Value string
+}

pkg/onepassword/model/item_test.go

@@ -0,0 +1,108 @@
+package model
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	connect "github.com/1Password/connect-sdk-go/onepassword"
+	sdk "github.com/1password/onepassword-sdk-go"
+)
+
+func TestItem_FromConnectItem(t *testing.T) {
+	connectItem := &connect.Item{
+		ID: "test-item-id",
+		Vault: connect.ItemVault{
+			ID: "test-vault-id",
+		},
+		Version: 1,
+		Tags:    []string{"tag1", "tag2"},
+		Fields: []*connect.ItemField{
+			{Label: "field1", Value: "value1"},
+			{Label: "field2", Value: "value2"},
+		},
+		Files: []*connect.File{
+			{ID: "file1", Name: "file1.txt", Size: 1234},
+			{ID: "file2", Name: "file2.txt", Size: 1234},
+		},
+		CreatedAt: time.Now(),
+	}
+
+	item := &Item{}
+	item.FromConnectItem(connectItem)
+
+	require.Equal(t, connectItem.ID, item.ID)
+	require.Equal(t, connectItem.Vault.ID, item.VaultID)
+	require.Equal(t, connectItem.Version, item.Version)
+	require.ElementsMatch(t, connectItem.Tags, item.Tags)
+
+	for i, field := range connectItem.Fields {
+		require.Equal(t, field.Label, item.Fields[i].Label)
+		require.Equal(t, field.Value, item.Fields[i].Value)
+	}
+
+	for i, file := range connectItem.Files {
+		require.Equal(t, file.ID, item.Files[i].ID)
+		require.Equal(t, file.Name, item.Files[i].Name)
+		require.Equal(t, file.Size, item.Files[i].Size)
+	}
+
+	require.Equal(t, connectItem.CreatedAt, item.CreatedAt)
+}
+
+func TestItem_FromSDKItem(t *testing.T) {
+	sdkItem := &sdk.Item{
+		ID:      "test-item-id",
+		VaultID: "test-vault-id",
+		Version: 1,
+		Tags:    []string{"tag1", "tag2"},
+		Fields: []sdk.ItemField{
+			{ID: "1", Title: "field1", Value: "value1"},
+			{ID: "2", Title: "field2", Value: "value2"},
+		},
+		Files: []sdk.ItemFile{
+			{Attributes: sdk.FileAttributes{Name: "file1.txt", Size: 1234}, FieldID: "file1"},
+			{Attributes: sdk.FileAttributes{Name: "file2.txt", Size: 1234}, FieldID: "file2"},
+		},
+		CreatedAt: time.Now(),
+	}
+
+	item := &Item{}
+	item.FromSDKItem(sdkItem)
+
+	require.Equal(t, sdkItem.ID, item.ID)
+	require.Equal(t, sdkItem.VaultID, item.VaultID)
+	require.Equal(t, int(sdkItem.Version), item.Version)
+	require.ElementsMatch(t, sdkItem.Tags, item.Tags)
+
+	for i, field := range sdkItem.Fields {
+		require.Equal(t, field.Title, item.Fields[i].Label)
+		require.Equal(t, field.Value, item.Fields[i].Value)
+	}
+
+	for i, file := range sdkItem.Files {
+		require.Equal(t, file.Attributes.ID, item.Files[i].ID)
+		require.Equal(t, file.Attributes.Name, item.Files[i].Name)
+		require.Equal(t, int(file.Attributes.Size), item.Files[i].Size)
+	}
+
+	require.Equal(t, sdkItem.CreatedAt, item.CreatedAt)
+}
+
+func TestItem_FromSDKItemOverview(t *testing.T) {
+	sdkItemOverview := &sdk.ItemOverview{
+		ID:        "test-item-id",
+		VaultID:   "test-vault-id",
+		Tags:      []string{"tag1", "tag2"},
+		CreatedAt: time.Now(),
+	}
+
+	item := &Item{}
+	item.FromSDKItemOverview(sdkItemOverview)
+
+	require.Equal(t, sdkItemOverview.ID, item.ID)
+	require.Equal(t, sdkItemOverview.VaultID, item.VaultID)
+	require.ElementsMatch(t, sdkItemOverview.Tags, item.Tags)
+	require.Equal(t, sdkItemOverview.CreatedAt, item.CreatedAt)
+}

pkg/onepassword/model/vault.go

@@ -0,0 +1,23 @@
+package model
+
+import (
+	"time"
+
+	connect "github.com/1Password/connect-sdk-go/onepassword"
+	sdk "github.com/1password/onepassword-sdk-go"
+)
+
+type Vault struct {
+	ID        string
+	CreatedAt time.Time
+}
+
+func (v *Vault) FromConnectVault(vault *connect.Vault) {
+	v.ID = vault.ID
+	v.CreatedAt = vault.CreatedAt
+}
+
+func (v *Vault) FromSDKVault(vault *sdk.VaultOverview) {
+	v.ID = vault.ID
+	v.CreatedAt = time.Now() // TODO: add to SDK and use it instead of time.Now()
+}

pkg/onepassword/model/vault_test.go

@@ -0,0 +1,36 @@
+package model
+
+import (
+	"testing"
+	"time"
+
+	"github.com/stretchr/testify/require"
+
+	connect "github.com/1Password/connect-sdk-go/onepassword"
+	sdk "github.com/1password/onepassword-sdk-go"
+)
+
+func TestVault_FromConnectVault(t *testing.T) {
+	connectVault := &connect.Vault{
+		ID:        "test-id",
+		CreatedAt: time.Now(),
+	}
+
+	vault := &Vault{}
+	vault.FromConnectVault(connectVault)
+
+	require.Equal(t, connectVault.ID, vault.ID)
+	require.Equal(t, connectVault.CreatedAt, vault.CreatedAt)
+}
+
+// TODO: check CreatedAt when available
+func TestVault_FromSDKVault(t *testing.T) {
+	sdkVault := &sdk.VaultOverview{
+		ID: "test-id",
+	}
+
+	vault := &Vault{}
+	vault.FromSDKVault(sdkVault)
+
+	require.Equal(t, sdkVault.ID, vault.ID)
+}