Skip to content

Commit 0e8f0be

Browse files
richaardevrichaardev
committed
refact: nomenclatures
1 parent 85d86f8 commit 0e8f0be

File tree

3 files changed

+55
-55
lines changed

3 files changed

+55
-55
lines changed

‎rest/applications.go

Lines changed: 38 additions & 38 deletions
Original file line numberDiff line numberDiff line change
@@ -21,32 +21,32 @@ type Applications interface {
2121

2222
PostApplications(reader io.Reader, options ...RequestOpt) (*squarecloud.ApplicationUploaded, error)
2323

24-
GetApplication(appId string, options ...RequestOpt) (squarecloud.Application, error)
25-
GetApplicationStatus(appId string, options ...RequestOpt) (squarecloud.ApplicationStatus, error)
24+
GetApplication(appID string, options ...RequestOpt) (squarecloud.Application, error)
25+
GetApplicationStatus(appID string, options ...RequestOpt) (squarecloud.ApplicationStatus, error)
2626

27-
GetApplicationLogs(appId string, options ...RequestOpt) (squarecloud.ApplicationLogs, error)
28-
PostApplicationSignal(appId string, signal squarecloud.ApplicationSignal, options ...RequestOpt) error
29-
PostApplicationCommit(appId string, reader io.Reader, options ...RequestOpt) error
27+
GetApplicationLogs(appID string, options ...RequestOpt) (squarecloud.ApplicationLogs, error)
28+
PostApplicationSignal(appID string, signal squarecloud.ApplicationSignal, options ...RequestOpt) error
29+
PostApplicationCommit(appID string, reader io.Reader, options ...RequestOpt) error
3030

31-
GetApplicationBackups(appId string, options ...RequestOpt) ([]squarecloud.ApplicationBackup, error)
32-
CreateApplicationBackup(appId string, options ...RequestOpt) (squarecloud.ApplicationBackupCreated, error)
31+
GetApplicationBackups(appID string, options ...RequestOpt) ([]squarecloud.ApplicationBackup, error)
32+
CreateApplicationBackup(appID string, options ...RequestOpt) (squarecloud.ApplicationBackupCreated, error)
3333

34-
// GetApplicationFileContent(appId string, path string, options ...RequestOption) error
35-
// GetApplicationFiles(appId string, path string, options ...RequestOption) error
36-
// CreateApplicationFile(appId string, path string, options ...RequestOption) error
37-
// PatchApplicationFile(appId string, path string, to string, options ...RequestOption) error
38-
// DeleteApplicationFile(appId string, path string, options ...RequestOption) error
34+
// GetApplicationFileContent(appID string, path string, options ...RequestOption) error
35+
// GetApplicationFiles(appID string, path string, options ...RequestOption) error
36+
// CreateApplicationFile(appID string, path string, options ...RequestOption) error
37+
// PatchApplicationFile(appID string, path string, to string, options ...RequestOption) error
38+
// DeleteApplicationFile(appID string, path string, options ...RequestOption) error
3939

40-
// GetApplicationDeployments(appId string, options ...RequestOption) error
41-
// GetApplicationCurrentDeployments(appId string, options ...RequestOption) error
42-
// PostApplicationDeployWebhook(appId string, options ...RequestOption) error
40+
// GetApplicationDeployments(appID string, options ...RequestOption) error
41+
// GetApplicationCurrentDeployments(appID string, options ...RequestOption) error
42+
// PostApplicationDeployWebhook(appID string, options ...RequestOption) error
4343

44-
// GetApplicationDNSRecords(appId string, options ...RequestOption) error
45-
// GetApplicationAnalytics(appId string, options ...RequestOption) error
46-
// PostApplicationCustomDomain(appId string, options ...RequestOption) error
47-
// PostApplicationPurgeCache(appId string, options ...RequestOption) error
44+
// GetApplicationDNSRecords(appID string, options ...RequestOption) error
45+
// GetApplicationAnalytics(appID string, options ...RequestOption) error
46+
// PostApplicationCustomDomain(appID string, options ...RequestOption) error
47+
// PostApplicationPurgeCache(appID string, options ...RequestOption) error
4848

49-
DeleteApplication(appId string, options ...RequestOpt) error
49+
DeleteApplication(appID string, options ...RequestOpt) error
5050
}
5151

5252
type applicationsImpl struct {
@@ -95,14 +95,14 @@ func (s *applicationsImpl) PostApplications(reader io.Reader, opts ...RequestOpt
9595
return &r.Response, err
9696
}
9797

98-
func (s *applicationsImpl) GetApplication(appId string, opts ...RequestOpt) (squarecloud.Application, error) {
98+
func (s *applicationsImpl) GetApplication(appID string, opts ...RequestOpt) (squarecloud.Application, error) {
9999
var r squarecloud.APIResponse[squarecloud.Application]
100-
err := s.client.Request(http.MethodGet, EndpointApplicationInformation(appId), nil, &r, opts...)
100+
err := s.client.Request(http.MethodGet, EndpointApplicationInformation(appID), nil, &r, opts...)
101101

102102
return r.Response, err
103103
}
104104

105-
func (c *applicationsImpl) PostApplicationCommit(appId string, reader io.Reader, options ...RequestOpt) error {
105+
func (c *applicationsImpl) PostApplicationCommit(appID string, reader io.Reader, options ...RequestOpt) error {
106106
bodyBuffer := &bytes.Buffer{}
107107
writer := multipart.NewWriter(bodyBuffer)
108108

@@ -122,54 +122,54 @@ func (c *applicationsImpl) PostApplicationCommit(appId string, reader io.Reader,
122122
options = append(options, WithHeader("Content-Type", writer.FormDataContentType()))
123123

124124
var r squarecloud.APIResponse[any]
125-
return c.client.Request(http.MethodPost, EndpointApplicationCommit(appId), bodyBuffer.Bytes(), &r, options...)
125+
return c.client.Request(http.MethodPost, EndpointApplicationCommit(appID), bodyBuffer.Bytes(), &r, options...)
126126
}
127127

128-
func (s *applicationsImpl) GetApplicationStatus(appId string, opts ...RequestOpt) (squarecloud.ApplicationStatus, error) {
128+
func (s *applicationsImpl) GetApplicationStatus(appID string, opts ...RequestOpt) (squarecloud.ApplicationStatus, error) {
129129
var r squarecloud.APIResponse[squarecloud.ApplicationStatus]
130-
err := s.client.Request(http.MethodGet, EndpointApplicationStatus(appId), nil, &r, opts...)
130+
err := s.client.Request(http.MethodGet, EndpointApplicationStatus(appID), nil, &r, opts...)
131131

132132
return r.Response, err
133133
}
134134

135-
func (s *applicationsImpl) GetApplicationLogs(appId string, opts ...RequestOpt) (squarecloud.ApplicationLogs, error) {
135+
func (s *applicationsImpl) GetApplicationLogs(appID string, opts ...RequestOpt) (squarecloud.ApplicationLogs, error) {
136136
var r squarecloud.APIResponse[squarecloud.ApplicationLogs]
137-
err := s.client.Request(http.MethodGet, EndpointApplicationLogs(appId), nil, &r, opts...)
137+
err := s.client.Request(http.MethodGet, EndpointApplicationLogs(appID), nil, &r, opts...)
138138

139139
return r.Response, err
140140
}
141141

142-
func (s *applicationsImpl) PostApplicationSignal(appId string, signal squarecloud.ApplicationSignal, opts ...RequestOpt) error {
142+
func (s *applicationsImpl) PostApplicationSignal(appID string, signal squarecloud.ApplicationSignal, opts ...RequestOpt) error {
143143
var r squarecloud.APIResponse[any]
144144
var endpoint string
145145

146146
switch signal {
147147
case squarecloud.ApplicationSignalStart:
148-
endpoint = EndpointApplicationStart(appId)
148+
endpoint = EndpointApplicationStart(appID)
149149
case squarecloud.ApplicationSignalRestart:
150-
endpoint = EndpointApplicationRestart(appId)
150+
endpoint = EndpointApplicationRestart(appID)
151151
case squarecloud.ApplicationSignalStop:
152-
endpoint = EndpointApplicationStop(appId)
152+
endpoint = EndpointApplicationStop(appID)
153153
}
154154

155155
return s.client.Request(http.MethodPost, endpoint, nil, &r, opts...)
156156
}
157157

158-
func (s *applicationsImpl) GetApplicationBackups(appId string, opts ...RequestOpt) ([]squarecloud.ApplicationBackup, error) {
158+
func (s *applicationsImpl) GetApplicationBackups(appID string, opts ...RequestOpt) ([]squarecloud.ApplicationBackup, error) {
159159
var r squarecloud.APIResponse[[]squarecloud.ApplicationBackup]
160-
err := s.client.Request(http.MethodGet, EndpointApplicationSnapshots(appId), nil, &r, opts...)
160+
err := s.client.Request(http.MethodGet, EndpointApplicationSnapshots(appID), nil, &r, opts...)
161161

162162
return r.Response, err
163163
}
164164

165-
func (s *applicationsImpl) CreateApplicationBackup(appId string, opts ...RequestOpt) (squarecloud.ApplicationBackupCreated, error) {
165+
func (s *applicationsImpl) CreateApplicationBackup(appID string, opts ...RequestOpt) (squarecloud.ApplicationBackupCreated, error) {
166166
var r squarecloud.APIResponse[squarecloud.ApplicationBackupCreated]
167-
err := s.client.Request(http.MethodPost, EndpointApplicationSnapshots(appId), nil, &r, opts...)
167+
err := s.client.Request(http.MethodPost, EndpointApplicationSnapshots(appID), nil, &r, opts...)
168168

169169
return r.Response, err
170170
}
171171

172-
func (s *applicationsImpl) DeleteApplication(appId string, opts ...RequestOpt) error {
172+
func (s *applicationsImpl) DeleteApplication(appID string, opts ...RequestOpt) error {
173173
var r squarecloud.APIResponse[any]
174-
return s.client.Request(http.MethodDelete, EndpointApplicationInformation(appId), nil, &r, opts...)
174+
return s.client.Request(http.MethodDelete, EndpointApplicationInformation(appID), nil, &r, opts...)
175175
}

‎rest/endpoints.go

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,8 +5,8 @@ import (
55
)
66

77
var (
8-
ApiVersion = 2
9-
ApiURL = fmt.Sprintf("https://api.squarecloud.app/v%d", ApiVersion)
8+
APIVersion = 2
9+
APIURL = fmt.Sprintf("https://api.squarecloud.app/v%d", APIVersion)
1010
)
1111

1212
var (
@@ -19,24 +19,24 @@ var (
1919
// Application
2020
EndpointApplication = func() string { return "/apps" }
2121
EndpointApplicationListStatus = func() string { return "/apps/status" }
22-
EndpointApplicationInformation = func(appId string) string { return fmt.Sprintf("/apps/%s", appId) }
23-
EndpointApplicationStatus = func(appId string) string { return fmt.Sprintf("/apps/%s/status", appId) }
24-
EndpointApplicationLogs = func(appId string) string { return fmt.Sprintf("/apps/%s/logs", appId) }
25-
EndpointApplicationStart = func(appId string) string { return fmt.Sprintf("/apps/%s/start", appId) }
26-
EndpointApplicationRestart = func(appId string) string { return fmt.Sprintf("/apps/%s/restart", appId) }
27-
EndpointApplicationStop = func(appId string) string { return fmt.Sprintf("/apps/%s/stop", appId) }
28-
EndpointApplicationSnapshots = func(appId string) string { return fmt.Sprintf("/apps/%s/snapshots", appId) }
29-
EndpointApplicationCommit = func(appId string) string { return fmt.Sprintf("/apps/%s/commit", appId) }
22+
EndpointApplicationInformation = func(appID string) string { return fmt.Sprintf("/apps/%s", appID) }
23+
EndpointApplicationStatus = func(appID string) string { return fmt.Sprintf("/apps/%s/status", appID) }
24+
EndpointApplicationLogs = func(appID string) string { return fmt.Sprintf("/apps/%s/logs", appID) }
25+
EndpointApplicationStart = func(appID string) string { return fmt.Sprintf("/apps/%s/start", appID) }
26+
EndpointApplicationRestart = func(appID string) string { return fmt.Sprintf("/apps/%s/restart", appID) }
27+
EndpointApplicationStop = func(appID string) string { return fmt.Sprintf("/apps/%s/stop", appID) }
28+
EndpointApplicationSnapshots = func(appID string) string { return fmt.Sprintf("/apps/%s/snapshots", appID) }
29+
EndpointApplicationCommit = func(appID string) string { return fmt.Sprintf("/apps/%s/commit", appID) }
3030

3131
// Application File Manager
32-
EndpointApplicationFiles = func(appId, path string) string { return fmt.Sprintf("/apps/%s/files?path=%s", appId, path) }
33-
EndpointApplicationFileRead = func(appId, path string) string { return fmt.Sprintf("/apps/%s/files/content?path=%s", appId, path) }
32+
EndpointApplicationFiles = func(appID, path string) string { return fmt.Sprintf("/apps/%s/files?path=%s", appID, path) }
33+
EndpointApplicationFileRead = func(appID, path string) string { return fmt.Sprintf("/apps/%s/files/content?path=%s", appID, path) }
3434

3535
// Application Deploy
36-
EndpointApplicationDeploys = func(appId string) string { return fmt.Sprintf("/apps/%s/deploy/list", appId) }
37-
EndpointApplicationGithubIntegration = func(appId string) string { return fmt.Sprintf("/apps/%s/deploy/git-webhook", appId) }
36+
EndpointApplicationDeploys = func(appID string) string { return fmt.Sprintf("/apps/%s/deploy/list", appID) }
37+
EndpointApplicationGithubIntegration = func(appID string) string { return fmt.Sprintf("/apps/%s/deploy/git-webhook", appID) }
3838

3939
// Application Network
40-
EndpointApplicationNetwork = func(appId string) string { return fmt.Sprintf("/apps/%s/network/analytics", appId) }
41-
EndpointApplicationCustomDomain = func(appId, domain string) string { return fmt.Sprintf("/apps/%s/network/custom/%s", appId, domain) }
40+
EndpointApplicationNetwork = func(appID string) string { return fmt.Sprintf("/apps/%s/network/analytics", appID) }
41+
EndpointApplicationCustomDomain = func(appID, domain string) string { return fmt.Sprintf("/apps/%s/network/custom/%s", appID, domain) }
4242
)

‎rest/rest_config.go

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ func DefaultConfig() *Config {
1010
return &Config{
1111
Logger: slog.Default(),
1212
HTTPClient: &http.Client{Timeout: 30 * time.Second},
13-
URL: ApiURL,
13+
URL: APIURL,
1414
UserAgent: "Square GO",
1515
}
1616
}

0 commit comments

Comments
 (0)