From 34592a45efd9ceb0579c8eae1ba752da7f625950 Mon Sep 17 00:00:00 2001 From: nsfisis Date: Sat, 17 Aug 2024 19:35:47 +0900 Subject: refactor(backend): move fortee package --- backend/auth/auth.go | 4 +- backend/auth/fortee/fortee.go | 46 ------ backend/auth/fortee/generated.go | 292 ----------------------------------- backend/fortee/fortee.go | 46 ++++++ backend/fortee/generated.go | 292 +++++++++++++++++++++++++++++++++++ backend/gen/oapi-codegen.fortee.yaml | 2 +- 6 files changed, 341 insertions(+), 341 deletions(-) delete mode 100644 backend/auth/fortee/fortee.go delete mode 100644 backend/auth/fortee/generated.go create mode 100644 backend/fortee/fortee.go create mode 100644 backend/fortee/generated.go (limited to 'backend') diff --git a/backend/auth/auth.go b/backend/auth/auth.go index 0e55d8d..10906f5 100644 --- a/backend/auth/auth.go +++ b/backend/auth/auth.go @@ -8,8 +8,8 @@ import ( "github.com/jackc/pgx/v5" "golang.org/x/crypto/bcrypt" - "github.com/nsfisis/iosdc-japan-2024-albatross/backend/auth/fortee" "github.com/nsfisis/iosdc-japan-2024-albatross/backend/db" + "github.com/nsfisis/iosdc-japan-2024-albatross/backend/fortee" ) var ( @@ -119,7 +119,7 @@ func verifyForteeAccount(ctx context.Context, username string, password string) ctx, cancel := context.WithTimeout(ctx, forteeAPITimeout) defer cancel() - canonicalizedUsername, err := fortee.LoginFortee(ctx, username, password) + canonicalizedUsername, err := fortee.Login(ctx, username, password) if errors.Is(err, context.DeadlineExceeded) { return "", ErrForteeLoginTimeout } diff --git a/backend/auth/fortee/fortee.go b/backend/auth/fortee/fortee.go deleted file mode 100644 index 25ca9c5..0000000 --- a/backend/auth/fortee/fortee.go +++ /dev/null @@ -1,46 +0,0 @@ -package fortee - -import ( - "context" - "errors" - "net/http" -) - -const ( - apiEndpoint = "https://fortee.jp" -) - -var ( - ErrLoginFailed = errors.New("fortee login failed") -) - -func LoginFortee(ctx context.Context, username string, password string) (string, error) { - client, err := NewClientWithResponses(apiEndpoint, WithRequestEditorFn(addAcceptHeader)) - if err != nil { - return "", err - } - res, err := client.PostLoginWithFormdataBodyWithResponse(ctx, PostLoginFormdataRequestBody{ - Username: username, - Password: password, - }) - if err != nil { - return "", err - } - if res.StatusCode() != http.StatusOK { - return "", ErrLoginFailed - } - resOk := res.JSON200 - if !resOk.LoggedIn { - return "", ErrLoginFailed - } - if resOk.User == nil { - return "", ErrLoginFailed - } - return resOk.User.Username, nil -} - -// fortee API denies requests without Accept header. -func addAcceptHeader(_ context.Context, req *http.Request) error { - req.Header.Set("Accept", "application/json") - return nil -} diff --git a/backend/auth/fortee/generated.go b/backend/auth/fortee/generated.go deleted file mode 100644 index 53529f9..0000000 --- a/backend/auth/fortee/generated.go +++ /dev/null @@ -1,292 +0,0 @@ -// Package fortee provides primitives to interact with the openapi HTTP API. -// -// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT. -package fortee - -import ( - "context" - "encoding/json" - "fmt" - "io" - "net/http" - "net/url" - "strings" - - "github.com/oapi-codegen/runtime" -) - -// PostLoginFormdataBody defines parameters for PostLogin. -type PostLoginFormdataBody struct { - Password string `form:"password" json:"password"` - Username string `form:"username" json:"username"` -} - -// PostLoginFormdataRequestBody defines body for PostLogin for application/x-www-form-urlencoded ContentType. -type PostLoginFormdataRequestBody PostLoginFormdataBody - -// RequestEditorFn is the function signature for the RequestEditor callback function -type RequestEditorFn func(ctx context.Context, req *http.Request) error - -// Doer performs HTTP requests. -// -// The standard http.Client implements this interface. -type HttpRequestDoer interface { - Do(req *http.Request) (*http.Response, error) -} - -// Client which conforms to the OpenAPI3 specification for this service. -type Client struct { - // The endpoint of the server conforming to this interface, with scheme, - // https://api.deepmap.com for example. This can contain a path relative - // to the server, such as https://api.deepmap.com/dev-test, and all the - // paths in the swagger spec will be appended to the server. - Server string - - // Doer for performing requests, typically a *http.Client with any - // customized settings, such as certificate chains. - Client HttpRequestDoer - - // A list of callbacks for modifying requests which are generated before sending over - // the network. - RequestEditors []RequestEditorFn -} - -// ClientOption allows setting custom parameters during construction -type ClientOption func(*Client) error - -// Creates a new Client, with reasonable defaults -func NewClient(server string, opts ...ClientOption) (*Client, error) { - // create a client with sane default values - client := Client{ - Server: server, - } - // mutate client and add all optional params - for _, o := range opts { - if err := o(&client); err != nil { - return nil, err - } - } - // ensure the server URL always has a trailing slash - if !strings.HasSuffix(client.Server, "/") { - client.Server += "/" - } - // create httpClient, if not already present - if client.Client == nil { - client.Client = &http.Client{} - } - return &client, nil -} - -// WithHTTPClient allows overriding the default Doer, which is -// automatically created using http.Client. This is useful for tests. -func WithHTTPClient(doer HttpRequestDoer) ClientOption { - return func(c *Client) error { - c.Client = doer - return nil - } -} - -// WithRequestEditorFn allows setting up a callback function, which will be -// called right before sending the request. This can be used to mutate the request. -func WithRequestEditorFn(fn RequestEditorFn) ClientOption { - return func(c *Client) error { - c.RequestEditors = append(c.RequestEditors, fn) - return nil - } -} - -// The interface specification for the client above. -type ClientInterface interface { - // PostLoginWithBody request with any body - PostLoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) - - PostLoginWithFormdataBody(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) -} - -func (c *Client) PostLoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) { - req, err := NewPostLoginRequestWithBody(c.Server, contentType, body) - if err != nil { - return nil, err - } - req = req.WithContext(ctx) - if err := c.applyEditors(ctx, req, reqEditors); err != nil { - return nil, err - } - return c.Client.Do(req) -} - -func (c *Client) PostLoginWithFormdataBody(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) { - req, err := NewPostLoginRequestWithFormdataBody(c.Server, body) - if err != nil { - return nil, err - } - req = req.WithContext(ctx) - if err := c.applyEditors(ctx, req, reqEditors); err != nil { - return nil, err - } - return c.Client.Do(req) -} - -// NewPostLoginRequestWithFormdataBody calls the generic PostLogin builder with application/x-www-form-urlencoded body -func NewPostLoginRequestWithFormdataBody(server string, body PostLoginFormdataRequestBody) (*http.Request, error) { - var bodyReader io.Reader - bodyStr, err := runtime.MarshalForm(body, nil) - if err != nil { - return nil, err - } - bodyReader = strings.NewReader(bodyStr.Encode()) - return NewPostLoginRequestWithBody(server, "application/x-www-form-urlencoded", bodyReader) -} - -// NewPostLoginRequestWithBody generates requests for PostLogin with any type of body -func NewPostLoginRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error) { - var err error - - serverURL, err := url.Parse(server) - if err != nil { - return nil, err - } - - operationPath := fmt.Sprintf("/api/user/login") - if operationPath[0] == '/' { - operationPath = "." + operationPath - } - - queryURL, err := serverURL.Parse(operationPath) - if err != nil { - return nil, err - } - - req, err := http.NewRequest("POST", queryURL.String(), body) - if err != nil { - return nil, err - } - - req.Header.Add("Content-Type", contentType) - - return req, nil -} - -func (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error { - for _, r := range c.RequestEditors { - if err := r(ctx, req); err != nil { - return err - } - } - for _, r := range additionalEditors { - if err := r(ctx, req); err != nil { - return err - } - } - return nil -} - -// ClientWithResponses builds on ClientInterface to offer response payloads -type ClientWithResponses struct { - ClientInterface -} - -// NewClientWithResponses creates a new ClientWithResponses, which wraps -// Client with return type handling -func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { - client, err := NewClient(server, opts...) - if err != nil { - return nil, err - } - return &ClientWithResponses{client}, nil -} - -// WithBaseURL overrides the baseURL. -func WithBaseURL(baseURL string) ClientOption { - return func(c *Client) error { - newBaseURL, err := url.Parse(baseURL) - if err != nil { - return err - } - c.Server = newBaseURL.String() - return nil - } -} - -// ClientWithResponsesInterface is the interface specification for the client with responses above. -type ClientWithResponsesInterface interface { - // PostLoginWithBodyWithResponse request with any body - PostLoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) - - PostLoginWithFormdataBodyWithResponse(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) -} - -type PostLoginResponse struct { - Body []byte - HTTPResponse *http.Response - JSON200 *struct { - LoggedIn bool `json:"loggedIn"` - User *struct { - Username string `json:"username"` - } `json:"user,omitempty"` - } -} - -// Status returns HTTPResponse.Status -func (r PostLoginResponse) Status() string { - if r.HTTPResponse != nil { - return r.HTTPResponse.Status - } - return http.StatusText(0) -} - -// StatusCode returns HTTPResponse.StatusCode -func (r PostLoginResponse) StatusCode() int { - if r.HTTPResponse != nil { - return r.HTTPResponse.StatusCode - } - return 0 -} - -// PostLoginWithBodyWithResponse request with arbitrary body returning *PostLoginResponse -func (c *ClientWithResponses) PostLoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) { - rsp, err := c.PostLoginWithBody(ctx, contentType, body, reqEditors...) - if err != nil { - return nil, err - } - return ParsePostLoginResponse(rsp) -} - -func (c *ClientWithResponses) PostLoginWithFormdataBodyWithResponse(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) { - rsp, err := c.PostLoginWithFormdataBody(ctx, body, reqEditors...) - if err != nil { - return nil, err - } - return ParsePostLoginResponse(rsp) -} - -// ParsePostLoginResponse parses an HTTP response from a PostLoginWithResponse call -func ParsePostLoginResponse(rsp *http.Response) (*PostLoginResponse, error) { - bodyBytes, err := io.ReadAll(rsp.Body) - defer func() { _ = rsp.Body.Close() }() - if err != nil { - return nil, err - } - - response := &PostLoginResponse{ - Body: bodyBytes, - HTTPResponse: rsp, - } - - switch { - case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: - var dest struct { - LoggedIn bool `json:"loggedIn"` - User *struct { - Username string `json:"username"` - } `json:"user,omitempty"` - } - if err := json.Unmarshal(bodyBytes, &dest); err != nil { - return nil, err - } - response.JSON200 = &dest - - } - - return response, nil -} diff --git a/backend/fortee/fortee.go b/backend/fortee/fortee.go new file mode 100644 index 0000000..5ec7963 --- /dev/null +++ b/backend/fortee/fortee.go @@ -0,0 +1,46 @@ +package fortee + +import ( + "context" + "errors" + "net/http" +) + +const ( + apiEndpoint = "https://fortee.jp" +) + +var ( + ErrLoginFailed = errors.New("fortee login failed") +) + +func Login(ctx context.Context, username string, password string) (string, error) { + client, err := NewClientWithResponses(apiEndpoint, WithRequestEditorFn(addAcceptHeader)) + if err != nil { + return "", err + } + res, err := client.PostLoginWithFormdataBodyWithResponse(ctx, PostLoginFormdataRequestBody{ + Username: username, + Password: password, + }) + if err != nil { + return "", err + } + if res.StatusCode() != http.StatusOK { + return "", ErrLoginFailed + } + resOk := res.JSON200 + if !resOk.LoggedIn { + return "", ErrLoginFailed + } + if resOk.User == nil { + return "", ErrLoginFailed + } + return resOk.User.Username, nil +} + +// fortee API denies requests without Accept header. +func addAcceptHeader(_ context.Context, req *http.Request) error { + req.Header.Set("Accept", "application/json") + return nil +} diff --git a/backend/fortee/generated.go b/backend/fortee/generated.go new file mode 100644 index 0000000..53529f9 --- /dev/null +++ b/backend/fortee/generated.go @@ -0,0 +1,292 @@ +// Package fortee provides primitives to interact with the openapi HTTP API. +// +// Code generated by github.com/oapi-codegen/oapi-codegen/v2 version v2.3.0 DO NOT EDIT. +package fortee + +import ( + "context" + "encoding/json" + "fmt" + "io" + "net/http" + "net/url" + "strings" + + "github.com/oapi-codegen/runtime" +) + +// PostLoginFormdataBody defines parameters for PostLogin. +type PostLoginFormdataBody struct { + Password string `form:"password" json:"password"` + Username string `form:"username" json:"username"` +} + +// PostLoginFormdataRequestBody defines body for PostLogin for application/x-www-form-urlencoded ContentType. +type PostLoginFormdataRequestBody PostLoginFormdataBody + +// RequestEditorFn is the function signature for the RequestEditor callback function +type RequestEditorFn func(ctx context.Context, req *http.Request) error + +// Doer performs HTTP requests. +// +// The standard http.Client implements this interface. +type HttpRequestDoer interface { + Do(req *http.Request) (*http.Response, error) +} + +// Client which conforms to the OpenAPI3 specification for this service. +type Client struct { + // The endpoint of the server conforming to this interface, with scheme, + // https://api.deepmap.com for example. This can contain a path relative + // to the server, such as https://api.deepmap.com/dev-test, and all the + // paths in the swagger spec will be appended to the server. + Server string + + // Doer for performing requests, typically a *http.Client with any + // customized settings, such as certificate chains. + Client HttpRequestDoer + + // A list of callbacks for modifying requests which are generated before sending over + // the network. + RequestEditors []RequestEditorFn +} + +// ClientOption allows setting custom parameters during construction +type ClientOption func(*Client) error + +// Creates a new Client, with reasonable defaults +func NewClient(server string, opts ...ClientOption) (*Client, error) { + // create a client with sane default values + client := Client{ + Server: server, + } + // mutate client and add all optional params + for _, o := range opts { + if err := o(&client); err != nil { + return nil, err + } + } + // ensure the server URL always has a trailing slash + if !strings.HasSuffix(client.Server, "/") { + client.Server += "/" + } + // create httpClient, if not already present + if client.Client == nil { + client.Client = &http.Client{} + } + return &client, nil +} + +// WithHTTPClient allows overriding the default Doer, which is +// automatically created using http.Client. This is useful for tests. +func WithHTTPClient(doer HttpRequestDoer) ClientOption { + return func(c *Client) error { + c.Client = doer + return nil + } +} + +// WithRequestEditorFn allows setting up a callback function, which will be +// called right before sending the request. This can be used to mutate the request. +func WithRequestEditorFn(fn RequestEditorFn) ClientOption { + return func(c *Client) error { + c.RequestEditors = append(c.RequestEditors, fn) + return nil + } +} + +// The interface specification for the client above. +type ClientInterface interface { + // PostLoginWithBody request with any body + PostLoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) + + PostLoginWithFormdataBody(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) +} + +func (c *Client) PostLoginWithBody(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*http.Response, error) { + req, err := NewPostLoginRequestWithBody(c.Server, contentType, body) + if err != nil { + return nil, err + } + req = req.WithContext(ctx) + if err := c.applyEditors(ctx, req, reqEditors); err != nil { + return nil, err + } + return c.Client.Do(req) +} + +func (c *Client) PostLoginWithFormdataBody(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*http.Response, error) { + req, err := NewPostLoginRequestWithFormdataBody(c.Server, body) + if err != nil { + return nil, err + } + req = req.WithContext(ctx) + if err := c.applyEditors(ctx, req, reqEditors); err != nil { + return nil, err + } + return c.Client.Do(req) +} + +// NewPostLoginRequestWithFormdataBody calls the generic PostLogin builder with application/x-www-form-urlencoded body +func NewPostLoginRequestWithFormdataBody(server string, body PostLoginFormdataRequestBody) (*http.Request, error) { + var bodyReader io.Reader + bodyStr, err := runtime.MarshalForm(body, nil) + if err != nil { + return nil, err + } + bodyReader = strings.NewReader(bodyStr.Encode()) + return NewPostLoginRequestWithBody(server, "application/x-www-form-urlencoded", bodyReader) +} + +// NewPostLoginRequestWithBody generates requests for PostLogin with any type of body +func NewPostLoginRequestWithBody(server string, contentType string, body io.Reader) (*http.Request, error) { + var err error + + serverURL, err := url.Parse(server) + if err != nil { + return nil, err + } + + operationPath := fmt.Sprintf("/api/user/login") + if operationPath[0] == '/' { + operationPath = "." + operationPath + } + + queryURL, err := serverURL.Parse(operationPath) + if err != nil { + return nil, err + } + + req, err := http.NewRequest("POST", queryURL.String(), body) + if err != nil { + return nil, err + } + + req.Header.Add("Content-Type", contentType) + + return req, nil +} + +func (c *Client) applyEditors(ctx context.Context, req *http.Request, additionalEditors []RequestEditorFn) error { + for _, r := range c.RequestEditors { + if err := r(ctx, req); err != nil { + return err + } + } + for _, r := range additionalEditors { + if err := r(ctx, req); err != nil { + return err + } + } + return nil +} + +// ClientWithResponses builds on ClientInterface to offer response payloads +type ClientWithResponses struct { + ClientInterface +} + +// NewClientWithResponses creates a new ClientWithResponses, which wraps +// Client with return type handling +func NewClientWithResponses(server string, opts ...ClientOption) (*ClientWithResponses, error) { + client, err := NewClient(server, opts...) + if err != nil { + return nil, err + } + return &ClientWithResponses{client}, nil +} + +// WithBaseURL overrides the baseURL. +func WithBaseURL(baseURL string) ClientOption { + return func(c *Client) error { + newBaseURL, err := url.Parse(baseURL) + if err != nil { + return err + } + c.Server = newBaseURL.String() + return nil + } +} + +// ClientWithResponsesInterface is the interface specification for the client with responses above. +type ClientWithResponsesInterface interface { + // PostLoginWithBodyWithResponse request with any body + PostLoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) + + PostLoginWithFormdataBodyWithResponse(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) +} + +type PostLoginResponse struct { + Body []byte + HTTPResponse *http.Response + JSON200 *struct { + LoggedIn bool `json:"loggedIn"` + User *struct { + Username string `json:"username"` + } `json:"user,omitempty"` + } +} + +// Status returns HTTPResponse.Status +func (r PostLoginResponse) Status() string { + if r.HTTPResponse != nil { + return r.HTTPResponse.Status + } + return http.StatusText(0) +} + +// StatusCode returns HTTPResponse.StatusCode +func (r PostLoginResponse) StatusCode() int { + if r.HTTPResponse != nil { + return r.HTTPResponse.StatusCode + } + return 0 +} + +// PostLoginWithBodyWithResponse request with arbitrary body returning *PostLoginResponse +func (c *ClientWithResponses) PostLoginWithBodyWithResponse(ctx context.Context, contentType string, body io.Reader, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) { + rsp, err := c.PostLoginWithBody(ctx, contentType, body, reqEditors...) + if err != nil { + return nil, err + } + return ParsePostLoginResponse(rsp) +} + +func (c *ClientWithResponses) PostLoginWithFormdataBodyWithResponse(ctx context.Context, body PostLoginFormdataRequestBody, reqEditors ...RequestEditorFn) (*PostLoginResponse, error) { + rsp, err := c.PostLoginWithFormdataBody(ctx, body, reqEditors...) + if err != nil { + return nil, err + } + return ParsePostLoginResponse(rsp) +} + +// ParsePostLoginResponse parses an HTTP response from a PostLoginWithResponse call +func ParsePostLoginResponse(rsp *http.Response) (*PostLoginResponse, error) { + bodyBytes, err := io.ReadAll(rsp.Body) + defer func() { _ = rsp.Body.Close() }() + if err != nil { + return nil, err + } + + response := &PostLoginResponse{ + Body: bodyBytes, + HTTPResponse: rsp, + } + + switch { + case strings.Contains(rsp.Header.Get("Content-Type"), "json") && rsp.StatusCode == 200: + var dest struct { + LoggedIn bool `json:"loggedIn"` + User *struct { + Username string `json:"username"` + } `json:"user,omitempty"` + } + if err := json.Unmarshal(bodyBytes, &dest); err != nil { + return nil, err + } + response.JSON200 = &dest + + } + + return response, nil +} diff --git a/backend/gen/oapi-codegen.fortee.yaml b/backend/gen/oapi-codegen.fortee.yaml index 3bd5819..1799757 100644 --- a/backend/gen/oapi-codegen.fortee.yaml +++ b/backend/gen/oapi-codegen.fortee.yaml @@ -2,7 +2,7 @@ package: fortee generate: models: true client: true -output: ../auth/fortee/generated.go +output: ../fortee/generated.go output-options: skip-prune: true nullable-type: true -- cgit v1.2.3-70-g09d2