Merge pull request #183 from ctreminiom/feature/confluence-v2-module-…

…structure

📰 Implemented the first Confluence Cloud V2 services

.github/workflows/lint.yml

@@ -34,7 +34,7 @@ jobs:
 
           # Optional: golangci-lint command line arguments.
           # args: --issues-exit-code=0
-          args: --timeout=5m
+          args: --timeout=10m
 
           # Optional: show only new issues if it's a pull request. The default value is `false`.
           # only-new-issues: true

confluence/internal/page_impl.go

@@ -0,0 +1,294 @@
+package internal
+
+import (
+	"context"
+	"fmt"
+	model "github.com/ctreminiom/go-atlassian/pkg/infra/models"
+	"github.com/ctreminiom/go-atlassian/service"
+	"github.com/ctreminiom/go-atlassian/service/confluence"
+	"net/http"
+	"net/url"
+	"strconv"
+)
+
+func NewPageService(client service.Client) *PageService {
+	return &PageService{
+		internalClient: &internalPageImpl{c: client},
+	}
+}
+
+type PageService struct {
+	internalClient confluence.PageConnector
+}
+
+// Get returns a specific page.
+//
+// GET /wiki/api/v2/pages/{id}
+//
+// https://docs.go-atlassian.io/confluence-cloud/v2/page#get-page-by-id
+func (p *PageService) Get(ctx context.Context, pageId int, format string, draft bool, version int) (*model.PageScheme, *model.ResponseScheme, error) {
+	return p.internalClient.Get(ctx, pageId, format, draft, version)
+}
+
+// Bulk returns all pages.
+//
+// # The number of results is limited by the limit parameter and additional results
+//
+// (if available) will be available through the next cursor
+//
+// GET /wiki/api/v2/pages
+//
+// https://docs.go-atlassian.io/confluence-cloud/v2/page#get-pages
+func (p *PageService) Bulk(ctx context.Context, cursor string, limit int) (*model.PageChunkScheme, *model.ResponseScheme, error) {
+	return p.internalClient.Bulk(ctx, cursor, limit)
+}
+
+// GetsByLabel returns the pages of specified label.
+//
+// # The number of results is limited by the limit parameter and additional results
+//
+// (if available) will be available through the next cursor
+//
+// GET /wiki/api/v2/labels/{id}/pages
+//
+// https://docs.go-atlassian.io/confluence-cloud/v2/page#get-pages-for-label
+func (p *PageService) GetsByLabel(ctx context.Context, labelId int, sort, cursor string, limit int) (*model.PageChunkScheme, *model.ResponseScheme, error) {
+	return p.internalClient.GetsByLabel(ctx, labelId, sort, cursor, limit)
+}
+
+// GetsBySpace returns all pages in a space.
+//
+// The number of results is limited by the limit parameter and additional results (if available)
+//
+// will be available through the next cursor
+//
+// GET /wiki/api/v2/spaces/{id}/pages
+//
+// https://docs.go-atlassian.io/confluence-cloud/v2/page#get-pages-in-space
+func (p *PageService) GetsBySpace(ctx context.Context, spaceId int, cursor string, limit int) (*model.PageChunkScheme, *model.ResponseScheme, error) {
+	return p.internalClient.GetsBySpace(ctx, spaceId, cursor, limit)
+}
+
+// Create creates a page in the space.
+//
+// Pages are created as published by default unless specified as a draft in the status field.
+//
+// If creating a published page, the title must be specified.
+//
+// POST /wiki/api/v2/pages
+//
+// https://docs.go-atlassian.io/confluence-cloud/v2/page#create-page
+func (p *PageService) Create(ctx context.Context, payload *model.PageCreatePayloadScheme) (*model.PageScheme, *model.ResponseScheme, error) {
+	return p.internalClient.Create(ctx, payload)
+}
+
+// Update updates a page by id.
+//
+// PUT /wiki/api/v2/pages/{id}
+//
+// https://docs.go-atlassian.io/confluence-cloud/v2/page#update-page
+func (p *PageService) Update(ctx context.Context, pageId int, payload *model.PageUpdatePayloadScheme) (*model.PageScheme, *model.ResponseScheme, error) {
+	return p.internalClient.Update(ctx, pageId, payload)
+}
+
+// Delete deletes a page by id.
+//
+// DELETE /wiki/api/v2/pages/{id}
+//
+// https://docs.go-atlassian.io/confluence-cloud/v2/page#delete-page
+func (p *PageService) Delete(ctx context.Context, pageId int) (*model.ResponseScheme, error) {
+	return p.internalClient.Delete(ctx, pageId)
+}
+
+type internalPageImpl struct {
+	c service.Client
+}
+
+func (i *internalPageImpl) Get(ctx context.Context, pageId int, format string, draft bool, version int) (*model.PageScheme, *model.ResponseScheme, error) {
+
+	if pageId == 0 {
+		return nil, nil, model.ErrNoPageIDError
+	}
+
+	query := url.Values{}
+
+	if format != "" {
+		query.Add("body-format", format)
+	}
+
+	if draft {
+		query.Add("get-draft", "true")
+	}
+
+	if version != 0 {
+		query.Add("version", strconv.Itoa(version))
+	}
+
+	endpoint := fmt.Sprintf("wiki/api/v2/pages/%v?%v", pageId, query.Encode())
+
+	request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	page := new(model.PageScheme)
+	response, err := i.c.Call(request, page)
+	if err != nil {
+		return nil, response, err
+	}
+
+	return page, response, nil
+}
+
+func (i *internalPageImpl) Bulk(ctx context.Context, cursor string, limit int) (*model.PageChunkScheme, *model.ResponseScheme, error) {
+
+	query := url.Values{}
+	query.Add("limit", strconv.Itoa(limit))
+
+	if cursor != "" {
+		query.Add("cursor", cursor)
+	}
+
+	endpoint := fmt.Sprintf("wiki/api/v2/pages?%v", query.Encode())
+
+	request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	chunk := new(model.PageChunkScheme)
+	response, err := i.c.Call(request, chunk)
+	if err != nil {
+		return nil, response, err
+	}
+
+	return chunk, response, nil
+}
+
+func (i *internalPageImpl) GetsByLabel(ctx context.Context, labelId int, sort, cursor string, limit int) (*model.PageChunkScheme, *model.ResponseScheme, error) {
+
+	if labelId == 0 {
+		return nil, nil, model.ErrNoLabelIDError
+	}
+
+	query := url.Values{}
+	query.Add("limit", strconv.Itoa(limit))
+
+	if cursor != "" {
+		query.Add("cursor", cursor)
+	}
+
+	if sort != "" {
+		query.Add("sort", sort)
+	}
+
+	endpoint := fmt.Sprintf("wiki/api/v2/labels/%v/pages?%v", labelId, query.Encode())
+
+	request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	chunk := new(model.PageChunkScheme)
+	response, err := i.c.Call(request, chunk)
+	if err != nil {
+		return nil, response, err
+	}
+
+	return chunk, response, nil
+}
+
+func (i *internalPageImpl) GetsBySpace(ctx context.Context, spaceId int, cursor string, limit int) (*model.PageChunkScheme, *model.ResponseScheme, error) {
+
+	if spaceId == 0 {
+		return nil, nil, model.ErrNoSpaceIDError
+	}
+
+	query := url.Values{}
+	query.Add("limit", strconv.Itoa(limit))
+
+	if cursor != "" {
+		query.Add("cursor", cursor)
+	}
+
+	endpoint := fmt.Sprintf("wiki/api/v2/spaces/%v/pages?%v", spaceId, query.Encode())
+
+	request, err := i.c.NewRequest(ctx, http.MethodGet, endpoint, nil)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	chunk := new(model.PageChunkScheme)
+	response, err := i.c.Call(request, chunk)
+	if err != nil {
+		return nil, response, err
+	}
+
+	return chunk, response, nil
+}
+
+func (i *internalPageImpl) Create(ctx context.Context, payload *model.PageCreatePayloadScheme) (*model.PageScheme, *model.ResponseScheme, error) {
+
+	reader, err := i.c.TransformStructToReader(payload)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	endpoint := "wiki/api/v2/pages"
+
+	request, err := i.c.NewRequest(ctx, http.MethodPost, endpoint, reader)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	page := new(model.PageScheme)
+	response, err := i.c.Call(request, page)
+	if err != nil {
+		return nil, response, err
+	}
+
+	return page, response, nil
+}
+
+func (i *internalPageImpl) Update(ctx context.Context, pageId int, payload *model.PageUpdatePayloadScheme) (*model.PageScheme, *model.ResponseScheme, error) {
+
+	if pageId == 0 {
+		return nil, nil, model.ErrNoPageIDError
+	}
+
+	reader, err := i.c.TransformStructToReader(payload)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	endpoint := fmt.Sprintf("wiki/api/v2/pages/%v", pageId)
+
+	request, err := i.c.NewRequest(ctx, http.MethodPut, endpoint, reader)
+	if err != nil {
+		return nil, nil, err
+	}
+
+	page := new(model.PageScheme)
+	response, err := i.c.Call(request, page)
+	if err != nil {
+		return nil, response, err
+	}
+
+	return page, response, nil
+}
+
+func (i *internalPageImpl) Delete(ctx context.Context, pageId int) (*model.ResponseScheme, error) {
+
+	if pageId == 0 {
+		return nil, model.ErrNoPageIDError
+	}
+
+	endpoint := fmt.Sprintf("wiki/api/v2/pages/%v", pageId)
+
+	request, err := i.c.NewRequest(ctx, http.MethodDelete, endpoint, nil)
+	if err != nil {
+		return nil, err
+	}
+
+	return i.c.Call(request, nil)
+}