Initial commit.
This commit is contained in:
commit
92d0e113cf
65
.github/workflows/go.yml
vendored
Normal file
65
.github/workflows/go.yml
vendored
Normal file
@ -0,0 +1,65 @@
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- master
|
||||
pull_request:
|
||||
branches:
|
||||
- master
|
||||
|
||||
name: go
|
||||
jobs:
|
||||
lint:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- name: Install Go
|
||||
uses: actions/setup-go@v2
|
||||
with:
|
||||
go-version: 1.15.x
|
||||
- name: Checkout code
|
||||
uses: actions/checkout@v2
|
||||
- name: Run linters
|
||||
uses: golangci/golangci-lint-action@v2
|
||||
with:
|
||||
version: v1.29
|
||||
# test:
|
||||
# strategy:
|
||||
# matrix:
|
||||
# go-version: [1.15.x]
|
||||
# platform: [ubuntu-latest, macos-latest]
|
||||
# runs-on: ${{ matrix.platform }}
|
||||
# steps:
|
||||
# - name: Install Go
|
||||
# if: success()
|
||||
# uses: actions/setup-go@v2
|
||||
# with:
|
||||
# go-version: ${{ matrix.go-version }}
|
||||
# - name: Checkout code
|
||||
# uses: actions/checkout@v2
|
||||
# - name: Run tests
|
||||
# run: go test -v -covermode=count
|
||||
#
|
||||
# coverage:
|
||||
# runs-on: ubuntu-latest
|
||||
# steps:
|
||||
# - name: Install Go
|
||||
# if: success()
|
||||
# uses: actions/setup-go@v2
|
||||
# with:
|
||||
# go-version: 1.15.x
|
||||
# - name: Checkout code
|
||||
# uses: actions/checkout@v2
|
||||
# - name: Calc coverage
|
||||
# run: |
|
||||
# go test -v -covermode=count -coverprofile=coverage.out
|
||||
# - name: Codecov
|
||||
# uses: codecov/codecov-action@v1
|
||||
# with:
|
||||
# token: ${{ secrets.CODECOV_TOKEN }} # not required for public repos
|
||||
# file: ./coverage.out
|
||||
# - name: Convert coverage.out to coverage.lcov
|
||||
# uses: jandelgado/gcov2lcov-action@v1.0.6
|
||||
# - name: Coveralls
|
||||
# uses: coverallsapp/github-action@v1.1.2
|
||||
# with:
|
||||
# github-token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# path-to-lcov: coverage.lcov
|
108
.gitignore
vendored
Normal file
108
.gitignore
vendored
Normal file
@ -0,0 +1,108 @@
|
||||
# Created by .ignore support plugin (hsz.mobi)
|
||||
### JetBrains template
|
||||
# Covers JetBrains IDEs: IntelliJ, RubyMine, PhpStorm, AppCode, PyCharm, CLion, Android Studio and WebStorm
|
||||
# Reference: https://intellij-support.jetbrains.com/hc/en-us/articles/206544839
|
||||
|
||||
# User-specific stuff
|
||||
.idea/
|
||||
|
||||
# Gradle and Maven with auto-import
|
||||
# When using Gradle or Maven with auto-import, you should exclude module files,
|
||||
# since they will be recreated, and may cause churn. Uncomment if using
|
||||
# auto-import.
|
||||
# .idea/modules.xml
|
||||
# .idea/*.iml
|
||||
# .idea/modules
|
||||
# *.iml
|
||||
# *.ipr
|
||||
|
||||
# CMake
|
||||
cmake-build-*/
|
||||
|
||||
# Mongo Explorer plugin
|
||||
.idea/**/mongoSettings.xml
|
||||
|
||||
# File-based project format
|
||||
*.iws
|
||||
|
||||
# IntelliJ
|
||||
out/
|
||||
|
||||
# mpeltonen/sbt-idea plugin
|
||||
.idea_modules/
|
||||
|
||||
# JIRA plugin
|
||||
atlassian-ide-plugin.xml
|
||||
|
||||
# Crashlytics plugin (for Android Studio and IntelliJ)
|
||||
com_crashlytics_export_strings.xml
|
||||
crashlytics.properties
|
||||
crashlytics-build.properties
|
||||
fabric.properties
|
||||
|
||||
### Go template
|
||||
# Binaries for programs and plugins
|
||||
*.exe
|
||||
*.exe~
|
||||
*.dll
|
||||
*.so
|
||||
*.dylib
|
||||
|
||||
# Test binary, built with `go test -c`
|
||||
*.test
|
||||
|
||||
# Output of the go coverage tool, specifically when used with LiteIDE
|
||||
*.out
|
||||
|
||||
# Dependency directories (remove the comment below to include it)
|
||||
vendor/
|
||||
|
||||
### macOS template
|
||||
# General
|
||||
.DS_Store
|
||||
.AppleDouble
|
||||
.LSOverride
|
||||
|
||||
# Icon must end with two \r
|
||||
Icon
|
||||
|
||||
# Thumbnails
|
||||
._*
|
||||
|
||||
# Files that might appear in the root of a volume
|
||||
.DocumentRevisions-V100
|
||||
.fseventsd
|
||||
.Spotlight-V100
|
||||
.TemporaryItems
|
||||
.Trashes
|
||||
.VolumeIcon.icns
|
||||
.com.apple.timemachine.donotpresent
|
||||
|
||||
# Directories potentially created on remote AFP share
|
||||
.AppleDB
|
||||
.AppleDesktop
|
||||
Network Trash Folder
|
||||
Temporary Items
|
||||
.apdisk
|
||||
|
||||
### Linux template
|
||||
*~
|
||||
|
||||
# temporary files which can be created if a process still has a handle open of a deleted file
|
||||
.fuse_hidden*
|
||||
|
||||
# KDE directory preferences
|
||||
.directory
|
||||
|
||||
# Linux trash folder which might appear on any partition or disk
|
||||
.Trash-*
|
||||
|
||||
# .nfs files are created when an open file is removed but is still being accessed
|
||||
.nfs*
|
||||
|
||||
*.bak
|
||||
*.log
|
||||
.env
|
||||
.cache/
|
||||
coverage.*
|
||||
*_gen.go
|
201
LICENSE
Normal file
201
LICENSE
Normal file
@ -0,0 +1,201 @@
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright 2020 Alex <alex@webz.asia>
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
260
common.go
Normal file
260
common.go
Normal file
@ -0,0 +1,260 @@
|
||||
/*
|
||||
* Copyright (c) 2020 Alex <alex@webz.asia>
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* @author Alex <alex@webz.asia>
|
||||
* @copyright Copyright (c) 2020 Alex <alex@webz.asia>
|
||||
* @since 29.12.2020
|
||||
*
|
||||
*/
|
||||
|
||||
package dtoLib
|
||||
|
||||
import (
|
||||
"errors"
|
||||
"fmt"
|
||||
"net/http"
|
||||
"net/url"
|
||||
|
||||
"github.com/go-convert/fields"
|
||||
)
|
||||
|
||||
type PaginationContainer struct {
|
||||
Pagination Pagination `json:"pagination"`
|
||||
}
|
||||
|
||||
type Pagination struct {
|
||||
Page int `json:"page"`
|
||||
PerPage int `json:"per_page"`
|
||||
Total int `json:"total"`
|
||||
}
|
||||
|
||||
type ApiResponse struct {
|
||||
Code int32 `json:"code"`
|
||||
Type string `json:"type"`
|
||||
Message string `json:"message"`
|
||||
Data interface{} `json:"data"`
|
||||
*PaginationContainer
|
||||
}
|
||||
|
||||
type ApiErrorResponse struct {
|
||||
Code int32 `json:"code"`
|
||||
Type string `json:"type"`
|
||||
Message string `json:"message"`
|
||||
Errors []error `json:"errors"`
|
||||
Data interface{} `json:"data"`
|
||||
}
|
||||
|
||||
type SearchParams url.Values
|
||||
|
||||
// AllApiResponses returns full map of map ApiResponse structure
|
||||
func AllApiResponses() map[string]map[string]ApiResponse {
|
||||
return responseMap
|
||||
}
|
||||
|
||||
// AddNewApiResponse adds new api response by name, returns error if already exists
|
||||
func AddNewApiResponse(name string, response map[string]ApiResponse) error {
|
||||
if _, ok := responseMap[name]; ok {
|
||||
return errors.New("this name already exists")
|
||||
}
|
||||
responseMap[name] = response
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// AllApiErrorResponses returns full map of map ApiErrorResponse structure
|
||||
func AllApiErrorResponses() map[string]map[string]ApiErrorResponse {
|
||||
return errorResponseMap
|
||||
}
|
||||
|
||||
// AddNewApiErrorResponse adds new error api response by name, returns error if already exists
|
||||
func AddNewApiErrorResponse(name string, response map[string]ApiErrorResponse) error {
|
||||
if _, ok := errorResponseMap[name]; ok {
|
||||
return errors.New("this name already exists")
|
||||
}
|
||||
errorResponseMap[name] = response
|
||||
|
||||
return nil
|
||||
}
|
||||
|
||||
// NotCreated returns http response code and error response object
|
||||
func NotCreated(name string, errors []error) (int, ApiErrorResponse) {
|
||||
response, ok := errorResponseMap[name][StatusNotCreated]
|
||||
if ok {
|
||||
response.Errors = errors
|
||||
if len(errors) == 1 {
|
||||
response.Data = errors[0].Error()
|
||||
}
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailedError(name, errors)
|
||||
}
|
||||
|
||||
return http.StatusNotAcceptable, response
|
||||
}
|
||||
|
||||
// Created returns http response code and regular response object
|
||||
func Created(name string, data interface{}) (int, ApiResponse) {
|
||||
response, ok := responseMap[name][StatusCreated]
|
||||
if ok {
|
||||
response.Data = data
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailed(name)
|
||||
}
|
||||
|
||||
return http.StatusCreated, response
|
||||
}
|
||||
|
||||
// NotUpdated returns http response code and error response object
|
||||
func NotUpdated(name string, errors []error) (int, ApiErrorResponse) {
|
||||
response, ok := errorResponseMap[name][StatusNotUpdated]
|
||||
if ok {
|
||||
response.Errors = errors
|
||||
if len(errors) == 1 {
|
||||
response.Data = errors[0].Error()
|
||||
}
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailedError(name, errors)
|
||||
}
|
||||
|
||||
return http.StatusNotAcceptable, response
|
||||
}
|
||||
|
||||
// Updated returns http response code and regular response object
|
||||
func Updated(name string, data interface{}) (int, ApiResponse) {
|
||||
response, ok := responseMap[name][StatusUpdated]
|
||||
if ok {
|
||||
response.Data = data
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailed(name)
|
||||
}
|
||||
|
||||
return http.StatusAccepted, response
|
||||
}
|
||||
|
||||
// NotDeleted returns http response code and error response object
|
||||
func NotDeleted(name string, errors []error) (int, ApiErrorResponse) {
|
||||
response, ok := errorResponseMap[name][StatusNotDeleted]
|
||||
if ok {
|
||||
response.Errors = errors
|
||||
if len(errors) == 1 {
|
||||
response.Data = errors[0].Error()
|
||||
}
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailedError(name, errors)
|
||||
}
|
||||
|
||||
return http.StatusNotFound, response
|
||||
}
|
||||
|
||||
// Deleted returns http response code and regular response object
|
||||
func Deleted(name string, data interface{}) (int, ApiResponse) {
|
||||
response, ok := responseMap[name][StatusDeleted]
|
||||
if ok {
|
||||
response.Data = data
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailed(name)
|
||||
}
|
||||
|
||||
return http.StatusOK, response
|
||||
}
|
||||
|
||||
// NotFound returns http response code and error response object
|
||||
func NotFound(name string, errors []error) (int, ApiErrorResponse) {
|
||||
response, ok := errorResponseMap[name][StatusNotFound]
|
||||
if ok {
|
||||
response.Errors = errors
|
||||
if len(errors) == 1 {
|
||||
response.Data = errors[0].Error()
|
||||
}
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailedError(name, errors)
|
||||
}
|
||||
|
||||
return http.StatusNotFound, response
|
||||
}
|
||||
|
||||
// Found returns http response code and regular response object(found data and pagination)
|
||||
func Found(name string, data interface{}, pagination interface{}) (int, ApiResponse) {
|
||||
response, ok := responseMap[name][StatusFound]
|
||||
if ok {
|
||||
response.Data = data
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailed(name)
|
||||
}
|
||||
|
||||
if nil != pagination {
|
||||
dtoPagination := &Pagination{}
|
||||
fields.Сonvert(pagination, "pagination", dtoPagination)
|
||||
response.PaginationContainer = &PaginationContainer{Pagination: *dtoPagination}
|
||||
}
|
||||
|
||||
return http.StatusOK, response
|
||||
}
|
||||
|
||||
// Ok returns http response code and regular response object
|
||||
func Ok(name string, data interface{}) (int, ApiResponse) {
|
||||
response, ok := responseMap[name][StatusOk]
|
||||
if ok {
|
||||
response.Data = data
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailed(name)
|
||||
}
|
||||
|
||||
return http.StatusOK, response
|
||||
}
|
||||
|
||||
// Failed returns http response code and error response object
|
||||
func Failed(name string, errors []error) (int, ApiErrorResponse) {
|
||||
response, ok := errorResponseMap[name][StatusFailed]
|
||||
if ok {
|
||||
response.Errors = errors
|
||||
if len(errors) == 1 {
|
||||
response.Data = errors[0].Error()
|
||||
}
|
||||
} else {
|
||||
// fallback to other response, have to support it by default
|
||||
return FallbackToFailedError(name, errors)
|
||||
}
|
||||
|
||||
return http.StatusInternalServerError, response
|
||||
}
|
||||
|
||||
// FallbackToFailedError returns http response code and error response object as a fallback to predefined failed error response
|
||||
func FallbackToFailedError(name string, errs []error) (int, ApiErrorResponse) {
|
||||
errs = append(errs, fmt.Errorf("fallback to failed - no proper response for '%s' type", name))
|
||||
response := errorResponseMap[TypeSystem][StatusFailed]
|
||||
response.Errors = errs
|
||||
if len(errs) == 1 {
|
||||
response.Data = errs[0].Error()
|
||||
}
|
||||
|
||||
return http.StatusInternalServerError, response
|
||||
}
|
||||
|
||||
// FallbackToFailed returns http response code and regular response object as a fallback to predefined failed response
|
||||
func FallbackToFailed(name string) (int, ApiResponse) {
|
||||
response := responseMap[TypeSystem][StatusFailed]
|
||||
response.Data = fmt.Errorf("fallback to failed - no proper response for '%s' type", name).(interface{})
|
||||
|
||||
return http.StatusInternalServerError, response
|
||||
}
|
42
consts.go
Normal file
42
consts.go
Normal file
@ -0,0 +1,42 @@
|
||||
/*
|
||||
* Copyright (c) 2020 Alex <alex@webz.asia>
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* @author Alex <alex@webz.asia>
|
||||
* @copyright Copyright (c) 2020 Alex <alex@webz.asia>
|
||||
* @since 29.12.2020
|
||||
*
|
||||
*/
|
||||
|
||||
package dtoLib
|
||||
|
||||
const (
|
||||
StatusNotCreated = "notCreated"
|
||||
StatusCreated = "created"
|
||||
StatusNotUpdated = "notUpdated"
|
||||
StatusUpdated = "updated"
|
||||
StatusNotDeleted = "notDeleted"
|
||||
StatusDeleted = "deleted"
|
||||
StatusNotFound = "notFound"
|
||||
StatusFound = "found"
|
||||
StatusOk = "ok"
|
||||
StatusFailed = "failed"
|
||||
|
||||
TypeHealthcheck = "healthcheck"
|
||||
TypeSystem = "system"
|
||||
|
||||
HealthcheckCodeFound = 9999200
|
||||
HealthcheckCodeFailed = 9999502
|
||||
SystemCodeFailed = 99999502
|
||||
)
|
5
go.mod
Normal file
5
go.mod
Normal file
@ -0,0 +1,5 @@
|
||||
module github.com/echo-go/dto-lib
|
||||
|
||||
go 1.15
|
||||
|
||||
require github.com/go-convert/fields v0.0.0-20200219202448-dea7cb49b0d6
|
15
go.sum
Normal file
15
go.sum
Normal file
@ -0,0 +1,15 @@
|
||||
github.com/davecgh/go-spew v1.1.0 h1:ZDRjVQ15GmhC3fiQ8ni8+OwkZQO4DARzQgrnXU1Liz8=
|
||||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38=
|
||||
github.com/go-convert/fields v0.0.0-20200219202448-dea7cb49b0d6 h1:1Haov2igtdYaVRtDheYJeRgxmcLz2Fk7MWQzp7HEKXo=
|
||||
github.com/go-convert/fields v0.0.0-20200219202448-dea7cb49b0d6/go.mod h1:CQRn614Ycycgzq+d4x/DJWDS+w0qNiMqks37Ehmjv5E=
|
||||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM=
|
||||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4=
|
||||
github.com/satori/go.uuid v1.2.0 h1:0uYX9dsZ2yD7q2RtLRtPSdGDWzjeM3TbMJP9utgA0ww=
|
||||
github.com/satori/go.uuid v1.2.0/go.mod h1:dA0hQrYB0VpLJoorglMZABFdXlWrHn1NEOzdhQKdks0=
|
||||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME=
|
||||
github.com/stretchr/testify v1.4.0 h1:2E4SXV/wtOkTonXsotYi4li6zVWxYlZuYNCXe9XRJyk=
|
||||
github.com/stretchr/testify v1.4.0/go.mod h1:j7eGeouHqKxXV5pUuKE4zz7dFj8WfuZ+81PSLYec5m4=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405 h1:yhCVgyC4o1eVCa2tZl7eS0r+SDo693bJlVdllGtEeKM=
|
||||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0=
|
||||
gopkg.in/yaml.v2 v2.2.2 h1:ZCJp+EgiOT7lHqUV2J862kp8Qj64Jo6az82+3Td9dZw=
|
||||
gopkg.in/yaml.v2 v2.2.2/go.mod h1:hI93XBmqTisBFMUTm0b8Fm+jr3Dg1NNxqwp+5A1VGuI=
|
56
init.go
Normal file
56
init.go
Normal file
@ -0,0 +1,56 @@
|
||||
/*
|
||||
* Copyright (c) 2020 Alex <alex@webz.asia>
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*
|
||||
* @author Alex <alex@webz.asia>
|
||||
* @copyright Copyright (c) 2020 Alex <alex@webz.asia>
|
||||
* @since 29.12.2020
|
||||
*
|
||||
*/
|
||||
|
||||
package dtoLib
|
||||
|
||||
var responseMap = map[string]map[string]ApiResponse{
|
||||
TypeHealthcheck: {
|
||||
StatusFound: ApiResponse{
|
||||
Code: HealthcheckCodeFound,
|
||||
Type: TypeHealthcheck,
|
||||
Message: "Healthcheck(s) found",
|
||||
},
|
||||
},
|
||||
TypeSystem: {
|
||||
StatusFailed: ApiResponse{
|
||||
Code: SystemCodeFailed,
|
||||
Type: TypeSystem,
|
||||
Message: "System failed",
|
||||
},
|
||||
},
|
||||
}
|
||||
|
||||
var errorResponseMap = map[string]map[string]ApiErrorResponse{
|
||||
TypeHealthcheck: {
|
||||
StatusFailed: ApiErrorResponse{
|
||||
Code: HealthcheckCodeFailed,
|
||||
Type: TypeHealthcheck,
|
||||
Message: "Healthcheck(s) failed",
|
||||
},
|
||||
},
|
||||
TypeSystem: {
|
||||
StatusFailed: ApiErrorResponse{
|
||||
Code: SystemCodeFailed,
|
||||
Type: TypeSystem,
|
||||
Message: "System failed",
|
||||
},
|
||||
},
|
||||
}
|
Loading…
Reference in New Issue
Block a user