HOME-1781: extracted templates separately, added tests

lokalise · Sep 30, 2024 · 6a75066 · 6a75066
1 parent b6d5cbf
commit 6a75066
Show file tree

Hide file tree

Showing 5 changed files with 131 additions and 110 deletions.
diff --git a/api.go b/api.go
@@ -26,6 +26,7 @@ type Api struct {
 	Teams                func() *TeamService
 	TeamUserGroups       func() *TeamUserGroupService
 	TeamUsers            func() *TeamUserService
+	PermissionTemplates  func() *PermissionTemplateService
 	TranslationProviders func() *TranslationProviderService
 	Translations         func() *TranslationService
 	TranslationStatuses  func() *TranslationStatusService
@@ -57,6 +58,7 @@ func New(apiToken string, options ...ClientOption) (*Api, error) {
 	c.Projects = func() *ProjectService { return &ProjectService{BaseService: bs, opts: prjOpts} }
 	c.Branches = func() *BranchService { return &BranchService{bs} }
 	c.Teams = func() *TeamService { return &TeamService{bs} }
+	c.PermissionTemplates = func() *PermissionTemplateService { return &PermissionTemplateService{bs} }
 	c.TeamUsers = func() *TeamUserService { return &TeamUserService{bs} }
 	c.TeamUserGroups = func() *TeamUserGroupService { return &TeamUserGroupService{bs} }
 

diff --git a/svc_permissiontemplates.go b/svc_permissiontemplates.go
@@ -0,0 +1,41 @@
+package lokalise
+
+import "fmt"
+
+const (
+	pathTemplates = "teams/%d/roles"
+)
+
+// The PermissionTemplate service
+type PermissionTemplateService struct {
+	BaseService
+}
+
+type PermissionTemplate struct {
+	ID                             int      `json:"id"`
+	Role                           string   `json:"role"`
+	Permissions                    []string `json:"permissions"`
+	Description                    string   `json:"description"`
+	Tag                            string   `json:"tag"`
+	TagColor                       string   `json:"tagColor"`
+	TagInfo                        string   `json:"tagInfo"`
+	DoesEnableAllReadOnlyLanguages bool     `json:"doesEnableAllReadOnlyLanguages"`
+}
+
+type PermissionRoleResponse struct {
+	Roles []PermissionTemplate `json:"roles"`
+}
+
+// List all possible permission roles
+func (c *PermissionTemplateService) ListPermissionRoles(teamID int64) (r PermissionRoleResponse, err error) {
+	resp, err := c.getWithOptions(c.Ctx(), pathPermissionRoles(teamID), &r, c.PageOpts())
+
+	if err != nil {
+		return r, err
+	}
+	return r, apiError(resp)
+}
+
+func pathPermissionRoles(teamID int64) string {
+	return fmt.Sprintf(pathTemplates, teamID)
+}
diff --git a/svc_permissiontemplates_test.go b/svc_permissiontemplates_test.go
@@ -0,0 +1,88 @@
+package lokalise
+
+import (
+	"fmt"
+	"net/http"
+	"reflect"
+	"testing"
+)
+
+func TestTeamPermissionTemplates_List(t *testing.T) {
+	client, mux, _, teardown := setup()
+	defer teardown()
+
+	mux.HandleFunc(
+		"/teams/1/roles",
+		func(w http.ResponseWriter, r *http.Request) {
+			w.Header().Set("Content-Type", "application/json")
+			testMethod(t, r, "GET")
+			testHeader(t, r, apiTokenHeader, testApiToken)
+
+			_, _ = fmt.Fprint(w, `{
+				"roles": [
+					{
+						"id": 1,
+						"role": "Localisation management",
+						"permissions": [
+							"activity",
+							"branches_main_modify"
+						],
+						"description": "Manage project settings, contributors and tasks",
+						"tag": "Full access",
+						"tagColor": "green",
+						"doesEnableAllReadOnlyLanguages": true
+					},
+					{
+						"id": 2,
+						"role": "Developer",
+						"permissions": [
+							"download",
+							"upload"
+						],
+						"description": "Create keys, upload and download content",
+						"tag": "Advanced",
+						"tagColor": "cyan",
+						"doesEnableAllReadOnlyLanguages": true
+					}
+				]
+			}`)
+		})
+
+	r, err := client.PermissionTemplates().ListPermissionRoles(1)
+	if err != nil {
+		t.Errorf("Teams.List returned error: %v", err)
+	}
+
+	want := PermissionRoleResponse{
+		Roles: []PermissionTemplate{
+			{
+				ID:   1,
+				Role: "Localisation management",
+				Permissions: []string{
+					"activity",
+					"branches_main_modify",
+				},
+				Description:                    "Manage project settings, contributors and tasks",
+				Tag:                            "Full access",
+				TagColor:                       "green",
+				DoesEnableAllReadOnlyLanguages: true,
+			},
+			{
+				ID:   2,
+				Role: "Developer",
+				Permissions: []string{
+					"download",
+					"upload",
+				},
+				Description:                    "Create keys, upload and download content",
+				Tag:                            "Advanced",
+				TagColor:                       "cyan",
+				DoesEnableAllReadOnlyLanguages: true,
+			},
+		},
+	}
+
+	if !reflect.DeepEqual(r, want) {
+		t.Errorf("Team.PermissionRoles.List returned %+v, want %+v", r, want)
+	}
+}
diff --git a/svc_team.go b/svc_team.go
@@ -1,7 +1,5 @@
 package lokalise
 
-import "fmt"
-
 const (
 	pathTeams = "teams"
 )
@@ -32,20 +30,6 @@ type Quota struct {
 	MAU      int64 `json:"mau"`
 }
 
-type PermissionRole struct {
-	ID                             int      `json:"id"`
-	Role                           string   `json:"role"`
-	Permissions                    []string `json:"permissions"`
-	Description                    string   `json:"description"`
-	Tag                            string   `json:"tag"`
-	TagColor                       string   `json:"tagColor"`
-	DoesEnableAllReadOnlyLanguages bool     `json:"doesEnableAllReadOnlyLanguages"`
-}
-
-type PermissionRoleResponse struct {
-	Roles []PermissionRole `json:"roles"`
-}
-
 // ‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾‾
 // Service request/response objects
 // _____________________________________________________________________________________________________________________
@@ -69,17 +53,3 @@ func (c *TeamService) List() (r TeamsResponse, err error) {
 	applyPaged(resp, &r.Paged)
 	return r, apiError(resp)
 }
-
-// List all possible permission roles
-func (c *TeamService) ListPermissionRoles(teamID int64) (r PermissionRoleResponse, err error) {
-	resp, err := c.getWithOptions(c.Ctx(), pathPermissionRoles(teamID), &r, c.PageOpts())
-
-	if err != nil {
-		return r, err
-	}
-	return r, apiError(resp)
-}
-
-func pathPermissionRoles(teamID int64) string {
-	return fmt.Sprintf("teams/%d/roles", teamID)
-}
diff --git a/svc_team_test.go b/svc_team_test.go
@@ -78,83 +78,3 @@ func TestTeamService_List(t *testing.T) {
 		t.Errorf("Screenshots.List returned %+v, want %+v", r.Teams, want)
 	}
 }
-
-func TestTeamPermissionRoles_List(t *testing.T) {
-	client, mux, _, teardown := setup()
-	defer teardown()
-
-	mux.HandleFunc(
-		"/teams/1/roles",
-		func(w http.ResponseWriter, r *http.Request) {
-			w.Header().Set("Content-Type", "application/json")
-			testMethod(t, r, "GET")
-			testHeader(t, r, apiTokenHeader, testApiToken)
-
-			_, _ = fmt.Fprint(w, `{
-				"roles": [
-					{
-						"id": 1,
-						"role": "Localisation management",
-						"permissions": [
-							"activity",
-							"branches_main_modify"
-						],
-						"description": "Manage project settings, contributors and tasks",
-						"tag": "Full access",
-						"tagColor": "green",
-						"doesEnableAllReadOnlyLanguages": true
-					},
-					{
-						"id": 2,
-						"role": "Developer",
-						"permissions": [
-							"download",
-							"upload"
-						],
-						"description": "Create keys, upload and download content",
-						"tag": "Advanced",
-						"tagColor": "cyan",
-						"doesEnableAllReadOnlyLanguages": true
-					}
-				]
-			}`)
-		})
-
-	r, err := client.Teams().ListPermissionRoles(1)
-	if err != nil {
-		t.Errorf("Teams.List returned error: %v", err)
-	}
-
-	want := PermissionRoleResponse{
-		Roles: []PermissionRole{
-			{
-				ID:   1,
-				Role: "Localisation management",
-				Permissions: []string{
-					"activity",
-					"branches_main_modify",
-				},
-				Description:                    "Manage project settings, contributors and tasks",
-				Tag:                            "Full access",
-				TagColor:                       "green",
-				DoesEnableAllReadOnlyLanguages: true,
-			},
-			{
-				ID:   2,
-				Role: "Developer",
-				Permissions: []string{
-					"download",
-					"upload",
-				},
-				Description:                    "Create keys, upload and download content",
-				Tag:                            "Advanced",
-				TagColor:                       "cyan",
-				DoesEnableAllReadOnlyLanguages: true,
-			},
-		},
-	}
-
-	if !reflect.DeepEqual(r, want) {
-		t.Errorf("Team.PermissionRoles.List returned %+v, want %+v", r, want)
-	}
-}