Skip to content

Commit

Permalink
chore: Align naming for Roles and Permissions
Browse files Browse the repository at this point in the history 
In this commit we align the naming for the Role and Permission resources
with the rest of our SDKs. We will use a more generic term of Role and
Permission for every related endpoint
  • Loading branch information
@chanioxaris
chanioxaris committed Nov 13, 2023
1 parent 84ac7b7 commit e7e3aed
Show file tree
Hide file tree
Showing 4 changed files with 42 additions and 49 deletions.
12 changes: 6 additions & 6 deletions clerk/instance_organization_permissions.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import (
"net/http"
)

type OrganizationPermission struct {
type Permission struct {
Object string `json:"object"`
ID string `json:"id"`
Name string `json:"name"`
Expand All @@ -15,25 +15,25 @@ type OrganizationPermission struct {
UpdatedAt int64 `json:"updated_at"`
}

type OrganizationPermissionsResponse struct {
Data []OrganizationPermission `json:"data"`
TotalCount int64 `json:"total_count"`
type PermissionsResponse struct {
Data []Permission `json:"data"`
TotalCount int64 `json:"total_count"`
}

type ListInstanceOrganizationPermissionsParams struct {
Limit *int `json:"limit,omitempty"`
Offset *int `json:"offset,omitempty"`
}

func (s *InstanceService) ListOrganizationPermissions(params ListInstanceOrganizationPermissionsParams) (*OrganizationPermissionsResponse, error) {
func (s *InstanceService) ListOrganizationPermissions(params ListInstanceOrganizationPermissionsParams) (*PermissionsResponse, error) {
req, _ := s.client.NewRequest(http.MethodGet, OrganizationPermissionsUrl)

paginationParams := PaginationParams{Limit: params.Limit, Offset: params.Offset}
query := req.URL.Query()
addPaginationParams(query, paginationParams)
req.URL.RawQuery = query.Encode()

response := &OrganizationPermissionsResponse{}
response := &PermissionsResponse{}
_, err := s.client.Do(req, response)
if err != nil {
return nil, err
Expand Down
2 changes: 1 addition & 1 deletion clerk/instance_organization_permissions_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@ func TestInstanceService_List_happyPathWithParameters(t *testing.T) {
fmt.Fprint(w, expectedResponse)
})

want := &OrganizationPermissionsResponse{}
want := &PermissionsResponse{}
_ = json.Unmarshal([]byte(expectedResponse), want)

got, _ := client.Instances().ListOrganizationPermissions(ListInstanceOrganizationPermissionsParams{
Expand Down
53 changes: 24 additions & 29 deletions clerk/instance_organization_roles.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,75 +3,70 @@ package clerk
import (
"fmt"
"net/http"
"strconv"
)

type InsOrgRole struct {
Object string `json:"object"`
ID string `json:"id"`
Name string `json:"name"`
Key string `json:"key"`
Description string `json:"description"`
Permissions []OrganizationPermission `json:"permissions"`
CreatedAt int64 `json:"created_at"`
UpdatedAt int64 `json:"updated_at"`
type Role struct {
Object string `json:"object"`
ID string `json:"id"`
Name string `json:"name"`
Key string `json:"key"`
Description string `json:"description"`
Permissions []Permission `json:"permissions"`
CreatedAt int64 `json:"created_at"`
UpdatedAt int64 `json:"updated_at"`
}

type InsOrgRolesResponse struct {
Data []InsOrgRole `json:"data"`
TotalCount int64 `json:"total_count"`
type RolesResponse struct {
Data []Role `json:"data"`
TotalCount int64 `json:"total_count"`
}

type CreateInsOrgRoleParams struct {
type CreateInstanceOrganizationRoleParams struct {
Name string `json:"name"`
Key string `json:"key"`
Description string `json:"description"`
Permissions []string `json:"permissions,omitempty"`
}

func (s *InstanceService) CreateOrganizationRole(params CreateInsOrgRoleParams) (*InsOrgRole, error) {
func (s *InstanceService) CreateOrganizationRole(params CreateInstanceOrganizationRoleParams) (*Role, error) {
req, _ := s.client.NewRequest(http.MethodPost, OrganizationRolesUrl, &params)

var orgRole InsOrgRole
var orgRole Role
_, err := s.client.Do(req, &orgRole)
if err != nil {
return nil, err
}
return &orgRole, nil
}

type ListInsOrgRoleParams struct {
type ListInstanceOrganizationRoleParams struct {
Limit *int `json:"limit,omitempty"`
Offset *int `json:"offset,omitempty"`
}

func (s *InstanceService) ListOrganizationRole(params ListInsOrgRoleParams) (*InsOrgRolesResponse, error) {
func (s *InstanceService) ListOrganizationRole(params ListInstanceOrganizationRoleParams) (*RolesResponse, error) {
req, _ := s.client.NewRequest(http.MethodGet, OrganizationRolesUrl)

paginationParams := PaginationParams{Limit: params.Limit, Offset: params.Offset}
query := req.URL.Query()
if params.Limit != nil {
query.Set("limit", strconv.Itoa(*params.Limit))
}
if params.Offset != nil {
query.Set("offset", strconv.Itoa(*params.Offset))
}
addPaginationParams(query, paginationParams)
req.URL.RawQuery = query.Encode()

var orgRolesResponse *InsOrgRolesResponse
var orgRolesResponse *RolesResponse
_, err := s.client.Do(req, &orgRolesResponse)
if err != nil {
return nil, err
}
return orgRolesResponse, nil
}

func (s *InstanceService) ReadOrganizationRole(orgRoleID string) (*InsOrgRole, error) {
func (s *InstanceService) ReadOrganizationRole(orgRoleID string) (*Role, error) {
req, err := s.client.NewRequest(http.MethodGet, fmt.Sprintf("%s/%s", OrganizationRolesUrl, orgRoleID))
if err != nil {
return nil, err
}

var orgRole InsOrgRole
var orgRole Role
_, err = s.client.Do(req, &orgRole)
if err != nil {
return nil, err
Expand All @@ -86,10 +81,10 @@ type UpdateInsOrgRoleParams struct {
Permissions *[]string `json:"permissions,omitempty"`
}

func (s *InstanceService) UpdateOrganizationRole(orgRoleID string, params UpdateInsOrgRoleParams) (*InsOrgRole, error) {
func (s *InstanceService) UpdateOrganizationRole(orgRoleID string, params UpdateInsOrgRoleParams) (*Role, error) {
req, _ := s.client.NewRequest(http.MethodPatch, fmt.Sprintf("%s/%s", OrganizationRolesUrl, orgRoleID), &params)

var orgRole InsOrgRole
var orgRole Role
_, err := s.client.Do(req, &orgRole)
if err != nil {
return nil, err
Expand Down
24 changes: 11 additions & 13 deletions clerk/instance_organization_roles_test.go
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,7 +23,7 @@ func TestInstanceService_CreateOrgRole(t *testing.T) {
_, _ = fmt.Fprint(w, expectedResponse)
})

createParams := CreateInsOrgRoleParams{
createParams := CreateInstanceOrganizationRoleParams{
Name: "custom role",
Key: "org:custom_role",
Description: "my org custom role",
Expand All @@ -33,7 +33,7 @@ func TestInstanceService_CreateOrgRole(t *testing.T) {
got, err := client.Instances().CreateOrganizationRole(createParams)
assert.NoError(t, err)

var want InsOrgRole
var want Role
err = json.Unmarshal([]byte(expectedResponse), &want)
if err != nil {
t.Fatal(err)
Expand Down Expand Up @@ -61,7 +61,7 @@ func TestOrganizationRolesService_Read(t *testing.T) {
t.Fatal(err)
}

var want InsOrgRole
var want Role
err = json.Unmarshal([]byte(expectedResponse), &want)
if err != nil {
t.Fatal(err)
Expand Down Expand Up @@ -90,7 +90,7 @@ func TestOrganizationRolesService_Update(t *testing.T) {
t.Fatal(err)
}

var want InsOrgRole
var want Role
err = json.Unmarshal([]byte(expectedResponse), &want)
if err != nil {
t.Fatal(err)
Expand Down Expand Up @@ -127,10 +127,10 @@ func TestOrganizationsService_List_happyPath(t *testing.T) {
fmt.Fprint(w, expectedResponse)
})

var want *InsOrgRolesResponse
var want *RolesResponse
_ = json.Unmarshal([]byte(expectedResponse), &want)

got, _ := client.Instances().ListOrganizationRole(ListInsOrgRoleParams{})
got, _ := client.Instances().ListOrganizationRole(ListInstanceOrganizationRoleParams{})
if len(got.Data) != len(want.Data) {
t.Errorf("Was expecting %d organization roles to be returned, instead got %d", len(want.Data), len(got.Data))
}
Expand Down Expand Up @@ -162,14 +162,12 @@ func TestOrganizationsService_List_happyPathWithParameters(t *testing.T) {
fmt.Fprint(w, expectedResponse)
})

var want *InsOrgRolesResponse
var want *RolesResponse
_ = json.Unmarshal([]byte(expectedResponse), &want)

limit := 5
offset := 6
got, _ := client.Instances().ListOrganizationRole(ListInsOrgRoleParams{
Limit: &limit,
Offset: &offset,
got, _ := client.Instances().ListOrganizationRole(ListInstanceOrganizationRoleParams{
Limit: intToPtr(5),
Offset: intToPtr(6),
})
if len(got.Data) != len(want.Data) {
t.Errorf("Was expecting %d organization roles to be returned, instead got %d", len(want.Data), len(got.Data))
Expand All @@ -183,7 +181,7 @@ func TestOrganizationsService_List_happyPathWithParameters(t *testing.T) {
func TestOrganizationsService_List_invalidServer(t *testing.T) {
client, _ := NewClient("token")

orgRoles, err := client.Instances().ListOrganizationRole(ListInsOrgRoleParams{})
orgRoles, err := client.Instances().ListOrganizationRole(ListInstanceOrganizationRoleParams{})
if err == nil {
t.Errorf("Expected error to be returned")
}
Expand Down

0 comments on commit e7e3aed

Please sign in to comment.