-
Notifications
You must be signed in to change notification settings - Fork 0
/
main.go
194 lines (156 loc) · 7.13 KB
/
main.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
// Ortelius v11 Group Microservice that handles creating and retrieving Groups
package main
import (
"context"
"encoding/json"
_ "github.com/ortelius/scec-group/docs"
driver "github.com/arangodb/go-driver/v2/arangodb"
"github.com/arangodb/go-driver/v2/arangodb/shared"
"github.com/gofiber/fiber/v2"
"github.com/gofiber/fiber/v2/middleware/cors"
"github.com/gofiber/swagger"
"github.com/ortelius/scec-commons/database"
"github.com/ortelius/scec-commons/model"
)
var logger = database.InitLogger()
var dbconn = database.InitializeDatabase()
// GetGroups godoc
// @Summary Get a List of Groups
// @Description Get a list of groups for the user.
// @Tags group
// @Accept */*
// @Produce json
// @Success 200
// @Router /msapi/group [get]
func GetGroups(c *fiber.Ctx) error {
var cursor driver.Cursor // db cursor for rows
var err error // for error handling
var ctx = context.Background() // use default database context
// query all the groups in the collection
aql := `FOR group in evidence
FILTER (group.objtype == 'Group')
RETURN group`
// execute the query with no parameters
if cursor, err = dbconn.Database.Query(ctx, aql, nil); err != nil {
logger.Sugar().Errorf("Failed to run query: %v", err) // log error
}
defer cursor.Close() // close the cursor when returning from this function
var groups []*model.Group // define a list of groups to be returned
for cursor.HasMore() { // loop thru all of the documents
group := model.NewGroup() // fetched group
var meta driver.DocumentMeta // data about the fetch
// fetch a document from the cursor
if meta, err = cursor.ReadDocument(ctx, group); err != nil {
logger.Sugar().Errorf("Failed to read document: %v", err)
}
groups = append(groups, group) // add the group to the list
logger.Sugar().Infof("Got doc with key '%s' from query\n", meta.Key) // log the key
}
return c.JSON(groups) // return the list of groups in JSON format
}
// GetGroup godoc
// @Summary Get a Group
// @Description Get a group based on the _key or name.
// @Tags group
// @Accept */*
// @Produce json
// @Success 200
// @Router /msapi/group/:key [get]
func GetGroup(c *fiber.Ctx) error {
var cursor driver.Cursor // db cursor for rows
var err error // for error handling
var ctx = context.Background() // use default database context
key := c.Params("key") // key from URL
parameters := map[string]interface{}{ // parameters
"key": key,
}
// query the groups that match the key or name
aql := `FOR group in evidence
FILTER (group.name == @key or group._key == @key)
RETURN group`
// run the query with patameters
if cursor, err = dbconn.Database.Query(ctx, aql, &driver.QueryOptions{BindVars: parameters}); err != nil {
logger.Sugar().Errorf("Failed to run query: %v", err)
}
defer cursor.Close() // close the cursor when returning from this function
group := model.NewGroup() // define a group to be returned
if cursor.HasMore() { // group found
var meta driver.DocumentMeta // data about the fetch
if meta, err = cursor.ReadDocument(ctx, group); err != nil { // fetch the document into the object
logger.Sugar().Errorf("Failed to read document: %v", err)
}
logger.Sugar().Infof("Got doc with key '%s' from query\n", meta.Key)
} else { // not found so get from NFT Storage
if jsonStr, exists := database.MakeJSON(key); exists {
if err := json.Unmarshal([]byte(jsonStr), group); err != nil { // convert the JSON string from LTF into the object
logger.Sugar().Errorf("Failed to unmarshal from LTS: %v", err)
}
}
}
return c.JSON(group) // return the group in JSON format
}
// NewGroup godoc
// @Summary Create a Group
// @Description Create a new Group and persist it
// @Tags group
// @Accept application/json
// @Produce json
// @Success 200
// @Router /msapi/group [post]
func NewGroup(c *fiber.Ctx) error {
var err error // for error handling
var meta driver.DocumentMeta // data about the document
var ctx = context.Background() // use default database context
group := new(model.Group) // define a group to be returned
if err = c.BodyParser(group); err != nil { // parse the JSON into the group object
return c.Status(503).Send([]byte(err.Error()))
}
cid, dbStr := database.MakeNFT(group) // normalize the object into NFTs and JSON string for db persistence
logger.Sugar().Infof("%s=%s\n", cid, dbStr) // log the new nft
var resp driver.CollectionDocumentCreateResponse
// add the group to the database. Ignore if it already exists since it will be identical
if resp, err = dbconn.Collections["groups"].CreateDocument(ctx, group); err != nil && !shared.IsConflict(err) {
logger.Sugar().Errorf("Failed to create document: %v", err)
}
meta = resp.DocumentMeta
logger.Sugar().Infof("Created document in collection '%s' in db '%s' key='%s'\n", dbconn.Collections["groups"].Name(), dbconn.Database.Name(), meta.Key)
return c.JSON(group) // return the group object in JSON format. This includes the new _key
}
// setupRoutes defines maps the routes to the functions
func setupRoutes(app *fiber.App) {
app.Get("/swagger/*", swagger.HandlerDefault) // handle displaying the swagger
app.Get("/msapi/group", GetGroup) // list of groups
app.Get("/msapi/group/:key", GetGroup) // single group based on name or key
app.Post("/msapi/group", NewGroup) // save a single group
}
// @title Ortelius v11 Group Microservice
// @version 11.0.0
// @description RestAPI for the Group Object
// @description 
// @description 
// @description
// @description 
// @description [](https://github.com/ortelius/scec-group/actions?query=workflow%3AMegaLinter+branch%3Amain)
// @description 
// @description [](https://api.securityscorecards.dev/projects/github.com/ortelius/scec-group)
// @description
// @description 
// @termsOfService http://swagger.io/terms/
// @contact.name Ortelius Google Group
// @contact.email [email protected]
// @license.name Apache 2.0
// @license.url http://www.apache.org/licenses/LICENSE-2.0.html
// @host localhost:3000
// @BasePath /msapi/group
func main() {
port := ":" + database.GetEnvDefault("MS_PORT", "8080") // database port
app := fiber.New() // create a new fiber application
app.Use(cors.New(cors.Config{
AllowHeaders: "Origin, Content-Type, Accept",
AllowOrigins: "*",
}))
setupRoutes(app) // define the routes for this microservice
if err := app.Listen(port); err != nil { // start listening for incoming connections
logger.Sugar().Fatalf("Failed get the microservice running: %v", err)
}
}