Skip to content

Commit 372845a

Browse files
vlastahajekvlastahajek
authored
Merge pull request #156 from bonitoo-io/fix/naming-conventions
Fix/naming conventions
2 parents cf466f3 + e8aa4ff commit 372845a

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

45 files changed

+3982
-2004
lines changed

‎.circleci/config.yml

+1-1
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ jobs:
3232
# fi
3333
- run: go get -v -t -d ./...
3434
- run: go vet ./...
35-
- run: go get honnef.co/go/tools/cmd/staticcheck && staticcheck ./...
35+
- run: go get honnef.co/go/tools/cmd/staticcheck && staticcheck --checks="all" --tags e2e ./...
3636
- run:
3737
name: "Create a temp directory for artifacts"
3838
command: |

‎CHANGELOG.md

+9-1
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,17 @@
1-
## 1.4.0 [2020-06-19]
1+
## 1.4.0 [in progress]
2+
### Breaking change
3+
1. [#156](https://github.com/influxdata/influxdb-client-go/pull/156) Fixing Go naming and code style violations:
4+
- Introducing new *API interfaces with proper name of types, methods and arguments.
5+
- This also affects the `Client` interface and the `Options` type.
6+
- Affected types and methods have been deprecated and they will be removed in the next release.
7+
8+
29
### Bug fixes
310
1. [#152](https://github.com/influxdata/influxdb-client-go/pull/152) Allow connecting to server on a URL path
411
1. [#154](https://github.com/influxdata/influxdb-client-go/pull/154) Use idiomatic go style for write channels (internal)
512
1. [#155](https://github.com/influxdata/influxdb-client-go/pull/155) Fix panic in FindOrganizationByName in case of no permissions
613

14+
715
## 1.3.0 [2020-06-19]
816
### Features
917
1. [#131](https://github.com/influxdata/influxdb-client-go/pull/131) Labels API

‎api/authorizations.go

+42-30
Original file line numberDiff line numberDiff line change
@@ -9,39 +9,43 @@ import (
99
"github.com/influxdata/influxdb-client-go/domain"
1010
)
1111

12-
// AuthorizationsApi provides methods for organizing Authorization in a InfluxDB server
13-
type AuthorizationsApi interface {
12+
// AuthorizationsAPI provides methods for organizing Authorization in a InfluxDB server
13+
type AuthorizationsAPI interface {
1414
// GetAuthorizations returns all authorizations
1515
GetAuthorizations(ctx context.Context) (*[]domain.Authorization, error)
1616
// FindAuthorizationsByUserName returns all authorizations for given userName
1717
FindAuthorizationsByUserName(ctx context.Context, userName string) (*[]domain.Authorization, error)
18-
// FindAuthorizationsByUserId returns all authorizations for given userID
19-
FindAuthorizationsByUserId(ctx context.Context, userId string) (*[]domain.Authorization, error)
18+
// FindAuthorizationsByUserID returns all authorizations for given userID
19+
FindAuthorizationsByUserID(ctx context.Context, userID string) (*[]domain.Authorization, error)
2020
// FindAuthorizationsByOrgName returns all authorizations for given organization name
2121
FindAuthorizationsByOrgName(ctx context.Context, orgName string) (*[]domain.Authorization, error)
22-
// FindAuthorizationsByUserId returns all authorizations for given organization id
23-
FindAuthorizationsByOrgId(ctx context.Context, orgId string) (*[]domain.Authorization, error)
22+
// FindAuthorizationsByOrgID returns all authorizations for given organization id
23+
FindAuthorizationsByOrgID(ctx context.Context, orgID string) (*[]domain.Authorization, error)
2424
// CreateAuthorization creates new authorization
2525
CreateAuthorization(ctx context.Context, authorization *domain.Authorization) (*domain.Authorization, error)
26-
// CreateAuthorizationWithOrgId creates new authorization with given permissions scoped to given orgId
27-
CreateAuthorizationWithOrgId(ctx context.Context, orgId string, permissions []domain.Permission) (*domain.Authorization, error)
28-
// UpdateAuthorizationStatus updates status of authorization with authId
29-
UpdateAuthorizationStatus(ctx context.Context, authId string, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error)
30-
// DeleteAuthorization deletes authorization with authId
31-
DeleteAuthorization(ctx context.Context, authId string) error
26+
// CreateAuthorizationWithOrgID creates new authorization with given permissions scoped to given orgID
27+
CreateAuthorizationWithOrgID(ctx context.Context, orgID string, permissions []domain.Permission) (*domain.Authorization, error)
28+
// UpdateAuthorizationStatus updates status of authorization
29+
UpdateAuthorizationStatus(ctx context.Context, authorization *domain.Authorization, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error)
30+
// UpdateAuthorizationStatusWithID updates status of authorization with authID
31+
UpdateAuthorizationStatusWithID(ctx context.Context, authID string, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error)
32+
// DeleteAuthorization deletes authorization
33+
DeleteAuthorization(ctx context.Context, authorization *domain.Authorization) error
34+
// DeleteAuthorization deletes authorization with authID
35+
DeleteAuthorizationWithID(ctx context.Context, authID string) error
3236
}
3337

34-
type authorizationsApiImpl struct {
38+
type authorizationsAPI struct {
3539
apiClient *domain.ClientWithResponses
3640
}
3741

38-
func NewAuthorizationApi(apiClient *domain.ClientWithResponses) AuthorizationsApi {
39-
return &authorizationsApiImpl{
42+
func NewAuthorizationsAPI(apiClient *domain.ClientWithResponses) AuthorizationsAPI {
43+
return &authorizationsAPI{
4044
apiClient: apiClient,
4145
}
4246
}
4347

44-
func (a *authorizationsApiImpl) GetAuthorizations(ctx context.Context) (*[]domain.Authorization, error) {
48+
func (a *authorizationsAPI) GetAuthorizations(ctx context.Context) (*[]domain.Authorization, error) {
4549
authQuery := &domain.GetAuthorizationsParams{}
4650
auths, err := a.listAuthorizations(ctx, authQuery)
4751
if err != nil {
@@ -50,7 +54,7 @@ func (a *authorizationsApiImpl) GetAuthorizations(ctx context.Context) (*[]domai
5054
return auths.Authorizations, nil
5155
}
5256

53-
func (a *authorizationsApiImpl) FindAuthorizationsByUserName(ctx context.Context, userName string) (*[]domain.Authorization, error) {
57+
func (a *authorizationsAPI) FindAuthorizationsByUserName(ctx context.Context, userName string) (*[]domain.Authorization, error) {
5458
authQuery := &domain.GetAuthorizationsParams{User: &userName}
5559
auths, err := a.listAuthorizations(ctx, authQuery)
5660
if err != nil {
@@ -59,16 +63,16 @@ func (a *authorizationsApiImpl) FindAuthorizationsByUserName(ctx context.Context
5963
return auths.Authorizations, nil
6064
}
6165

62-
func (a *authorizationsApiImpl) FindAuthorizationsByUserId(ctx context.Context, userId string) (*[]domain.Authorization, error) {
63-
authQuery := &domain.GetAuthorizationsParams{UserID: &userId}
66+
func (a *authorizationsAPI) FindAuthorizationsByUserID(ctx context.Context, userID string) (*[]domain.Authorization, error) {
67+
authQuery := &domain.GetAuthorizationsParams{UserID: &userID}
6468
auths, err := a.listAuthorizations(ctx, authQuery)
6569
if err != nil {
6670
return nil, err
6771
}
6872
return auths.Authorizations, nil
6973
}
7074

71-
func (a *authorizationsApiImpl) FindAuthorizationsByOrgName(ctx context.Context, orgName string) (*[]domain.Authorization, error) {
75+
func (a *authorizationsAPI) FindAuthorizationsByOrgName(ctx context.Context, orgName string) (*[]domain.Authorization, error) {
7276
authQuery := &domain.GetAuthorizationsParams{Org: &orgName}
7377
auths, err := a.listAuthorizations(ctx, authQuery)
7478
if err != nil {
@@ -77,16 +81,16 @@ func (a *authorizationsApiImpl) FindAuthorizationsByOrgName(ctx context.Context,
7781
return auths.Authorizations, nil
7882
}
7983

80-
func (a *authorizationsApiImpl) FindAuthorizationsByOrgId(ctx context.Context, orgId string) (*[]domain.Authorization, error) {
81-
authQuery := &domain.GetAuthorizationsParams{OrgID: &orgId}
84+
func (a *authorizationsAPI) FindAuthorizationsByOrgID(ctx context.Context, orgID string) (*[]domain.Authorization, error) {
85+
authQuery := &domain.GetAuthorizationsParams{OrgID: &orgID}
8286
auths, err := a.listAuthorizations(ctx, authQuery)
8387
if err != nil {
8488
return nil, err
8589
}
8690
return auths.Authorizations, nil
8791
}
8892

89-
func (a *authorizationsApiImpl) listAuthorizations(ctx context.Context, query *domain.GetAuthorizationsParams) (*domain.Authorizations, error) {
93+
func (a *authorizationsAPI) listAuthorizations(ctx context.Context, query *domain.GetAuthorizationsParams) (*domain.Authorizations, error) {
9094
if query == nil {
9195
query = &domain.GetAuthorizationsParams{}
9296
}
@@ -100,7 +104,7 @@ func (a *authorizationsApiImpl) listAuthorizations(ctx context.Context, query *d
100104
return response.JSON200, nil
101105
}
102106

103-
func (a *authorizationsApiImpl) CreateAuthorization(ctx context.Context, authorization *domain.Authorization) (*domain.Authorization, error) {
107+
func (a *authorizationsAPI) CreateAuthorization(ctx context.Context, authorization *domain.Authorization) (*domain.Authorization, error) {
104108
params := &domain.PostAuthorizationsParams{}
105109
response, err := a.apiClient.PostAuthorizationsWithResponse(ctx, params, domain.PostAuthorizationsJSONRequestBody(*authorization))
106110
if err != nil {
@@ -115,20 +119,20 @@ func (a *authorizationsApiImpl) CreateAuthorization(ctx context.Context, authori
115119
return response.JSON201, nil
116120
}
117121

118-
func (a *authorizationsApiImpl) CreateAuthorizationWithOrgId(ctx context.Context, orgId string, permissions []domain.Permission) (*domain.Authorization, error) {
122+
func (a *authorizationsAPI) CreateAuthorizationWithOrgID(ctx context.Context, orgID string, permissions []domain.Permission) (*domain.Authorization, error) {
119123
status := domain.AuthorizationUpdateRequestStatusActive
120124
auth := &domain.Authorization{
121125
AuthorizationUpdateRequest: domain.AuthorizationUpdateRequest{Status: &status},
122-
OrgID: &orgId,
126+
OrgID: &orgID,
123127
Permissions: &permissions,
124128
}
125129
return a.CreateAuthorization(ctx, auth)
126130
}
127131

128-
func (a *authorizationsApiImpl) UpdateAuthorizationStatus(ctx context.Context, authId string, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error) {
132+
func (a *authorizationsAPI) UpdateAuthorizationStatusWithID(ctx context.Context, authID string, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error) {
129133
params := &domain.PatchAuthorizationsIDParams{}
130134
body := &domain.PatchAuthorizationsIDJSONRequestBody{Status: &status}
131-
response, err := a.apiClient.PatchAuthorizationsIDWithResponse(ctx, authId, params, *body)
135+
response, err := a.apiClient.PatchAuthorizationsIDWithResponse(ctx, authID, params, *body)
132136
if err != nil {
133137
return nil, err
134138
}
@@ -138,9 +142,17 @@ func (a *authorizationsApiImpl) UpdateAuthorizationStatus(ctx context.Context, a
138142
return response.JSON200, nil
139143
}
140144

141-
func (a *authorizationsApiImpl) DeleteAuthorization(ctx context.Context, authId string) error {
145+
func (a *authorizationsAPI) UpdateAuthorizationStatus(ctx context.Context, authorization *domain.Authorization, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error) {
146+
return a.UpdateAuthorizationStatusWithID(ctx, *authorization.Id, status)
147+
}
148+
149+
func (a *authorizationsAPI) DeleteAuthorization(ctx context.Context, authorization *domain.Authorization) error {
150+
return a.DeleteAuthorizationWithID(ctx, *authorization.Id)
151+
}
152+
153+
func (a *authorizationsAPI) DeleteAuthorizationWithID(ctx context.Context, authID string) error {
142154
params := &domain.DeleteAuthorizationsIDParams{}
143-
response, err := a.apiClient.DeleteAuthorizationsIDWithResponse(ctx, authId, params)
155+
response, err := a.apiClient.DeleteAuthorizationsIDWithResponse(ctx, authID, params)
144156
if err != nil {
145157
return err
146158
}

‎api/authorizations_deprecated.go

+83
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,83 @@
1+
// Copyright 2020 InfluxData, Inc. All rights reserved.
2+
// Use of this source code is governed by MIT
3+
// license that can be found in the LICENSE file.
4+
5+
package api
6+
7+
import (
8+
"context"
9+
"github.com/influxdata/influxdb-client-go/domain"
10+
)
11+
12+
//lint:file-ignore ST1003 This is deprecated API to be removed in next release
13+
14+
// AuthorizationsApi provides methods for organizing Authorization in a InfluxDB server
15+
// Deprecated: Use AuthorizationsAPI instead
16+
type AuthorizationsApi interface {
17+
// GetAuthorizations returns all authorizations
18+
GetAuthorizations(ctx context.Context) (*[]domain.Authorization, error)
19+
// FindAuthorizationsByUserName returns all authorizations for given userName
20+
FindAuthorizationsByUserName(ctx context.Context, userName string) (*[]domain.Authorization, error)
21+
// FindAuthorizationsByUserId returns all authorizations for given userID
22+
FindAuthorizationsByUserId(ctx context.Context, userId string) (*[]domain.Authorization, error)
23+
// FindAuthorizationsByOrgName returns all authorizations for given organization name
24+
FindAuthorizationsByOrgName(ctx context.Context, orgName string) (*[]domain.Authorization, error)
25+
// FindAuthorizationsByUserId returns all authorizations for given organization id
26+
FindAuthorizationsByOrgId(ctx context.Context, orgId string) (*[]domain.Authorization, error)
27+
// CreateAuthorization creates new authorization
28+
CreateAuthorization(ctx context.Context, authorization *domain.Authorization) (*domain.Authorization, error)
29+
// CreateAuthorizationWithOrgId creates new authorization with given permissions scoped to given orgId
30+
CreateAuthorizationWithOrgId(ctx context.Context, orgId string, permissions []domain.Permission) (*domain.Authorization, error)
31+
// UpdateAuthorizationStatus updates status of authorization with authId
32+
UpdateAuthorizationStatus(ctx context.Context, authId string, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error)
33+
// DeleteAuthorization deletes authorization with authId
34+
DeleteAuthorization(ctx context.Context, authId string) error
35+
}
36+
37+
type authorizationsApiImpl struct {
38+
authorizationsAPI AuthorizationsAPI
39+
}
40+
41+
// NewAuthorizationsApi creates instance of AuthorizationsApi
42+
// Deprecated: Use NewAuthorizationsAPI instead.
43+
func NewAuthorizationsApi(apiClient *domain.ClientWithResponses) AuthorizationsApi {
44+
return &authorizationsApiImpl{
45+
authorizationsAPI: NewAuthorizationsAPI(apiClient),
46+
}
47+
}
48+
49+
func (a *authorizationsApiImpl) GetAuthorizations(ctx context.Context) (*[]domain.Authorization, error) {
50+
return a.authorizationsAPI.GetAuthorizations(ctx)
51+
}
52+
53+
func (a *authorizationsApiImpl) FindAuthorizationsByUserName(ctx context.Context, userName string) (*[]domain.Authorization, error) {
54+
return a.authorizationsAPI.FindAuthorizationsByUserName(ctx, userName)
55+
}
56+
57+
func (a *authorizationsApiImpl) FindAuthorizationsByUserId(ctx context.Context, userId string) (*[]domain.Authorization, error) {
58+
return a.authorizationsAPI.FindAuthorizationsByUserID(ctx, userId)
59+
}
60+
61+
func (a *authorizationsApiImpl) FindAuthorizationsByOrgName(ctx context.Context, orgName string) (*[]domain.Authorization, error) {
62+
return a.authorizationsAPI.FindAuthorizationsByOrgName(ctx, orgName)
63+
}
64+
65+
func (a *authorizationsApiImpl) FindAuthorizationsByOrgId(ctx context.Context, orgId string) (*[]domain.Authorization, error) {
66+
return a.authorizationsAPI.FindAuthorizationsByOrgID(ctx, orgId)
67+
}
68+
69+
func (a *authorizationsApiImpl) CreateAuthorization(ctx context.Context, authorization *domain.Authorization) (*domain.Authorization, error) {
70+
return a.authorizationsAPI.CreateAuthorization(ctx, authorization)
71+
}
72+
73+
func (a *authorizationsApiImpl) CreateAuthorizationWithOrgId(ctx context.Context, orgId string, permissions []domain.Permission) (*domain.Authorization, error) {
74+
return a.authorizationsAPI.CreateAuthorizationWithOrgID(ctx, orgId, permissions)
75+
}
76+
77+
func (a *authorizationsApiImpl) UpdateAuthorizationStatus(ctx context.Context, authId string, status domain.AuthorizationUpdateRequestStatus) (*domain.Authorization, error) {
78+
return a.authorizationsAPI.UpdateAuthorizationStatusWithID(ctx, authId, status)
79+
}
80+
81+
func (a *authorizationsApiImpl) DeleteAuthorization(ctx context.Context, authId string) error {
82+
return a.authorizationsAPI.DeleteAuthorizationWithID(ctx, authId)
83+
}

0 commit comments

Comments
 (0)