-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Signed-off-by: Utkarsh Kumar Sharma <[email protected]>
- Loading branch information
1 parent
adc018f
commit ecd3e62
Showing
1 changed file
with
173 additions
and
173 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,173 +1,173 @@ | ||
| // Ortelius v11 Domain Microservice that handles creating and retrieving Domains | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| _ "cli/docs" | ||
|
|
||
| "github.com/arangodb/go-driver" | ||
| "github.com/gofiber/fiber/v2" | ||
| "github.com/gofiber/swagger" | ||
| "github.com/ortelius/scec-commons/database" | ||
| "github.com/ortelius/scec-commons/model" | ||
| ) | ||
|
|
||
| var logger = database.InitLogger() | ||
| var dbconn = database.InitializeDB() | ||
|
|
||
| // GetDomains godoc | ||
| // @Summary Get a List of Domains | ||
| // @Description Get a list of domains for the user. | ||
| // @Tags domain | ||
| // @Accept */* | ||
| // @Produce json | ||
| // @Success 200 | ||
| // @Router /msapi/domain [get] | ||
| func GetDomains(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 domains in the collection | ||
| aql := `FOR domain in evidence | ||
| RETURN domain` | ||
|
|
||
| // 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 domains []model.Domain // define a list of domains to be returned | ||
|
|
||
| for cursor.HasMore() { // loop thru all of the documents | ||
|
|
||
| var domain model.Domain // fetched domain | ||
| var meta driver.DocumentMeta // data about the fetch | ||
|
|
||
| // fetch a document from the cursor | ||
| if meta, err = cursor.ReadDocument(ctx, &domain); err != nil { | ||
| logger.Sugar().Errorf("Failed to read document: %v", err) | ||
| } | ||
| domains = append(domains, domain) // add the domain to the list | ||
| logger.Sugar().Infof("Got doc with key '%s' from query\n", meta.Key) // log the key | ||
| } | ||
|
|
||
| return c.JSON(domains) // return the list of domains in JSON format | ||
| } | ||
|
|
||
| // GetDomain godoc | ||
| // @Summary Get a Domain | ||
| // @Description Get a domain based on the _key or name. | ||
| // @Tags domain | ||
| // @Accept */* | ||
| // @Produce json | ||
| // @Success 200 | ||
| // @Router /msapi/domain/:key [get] | ||
| func GetDomain(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 domains that match the key or name | ||
| aql := `FOR domain in books | ||
| FILTER (domain.name == @key or domain._key == @key) | ||
| RETURN domain` | ||
|
|
||
| // run the query with patameters | ||
| if cursor, err = dbconn.Database.Query(ctx, aql, parameters); err != nil { | ||
| logger.Sugar().Errorf("Failed to run query: %v", err) | ||
| } | ||
|
|
||
| defer cursor.Close() // close the cursor when returning from this function | ||
|
|
||
| var domain model.Domain // define a domain to be returned | ||
|
|
||
| if cursor.HasMore() { // domain found | ||
| var meta driver.DocumentMeta // data about the fetch | ||
|
|
||
| if meta, err = cursor.ReadDocument(ctx, &domain); err != nil { | ||
| 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 | ||
| key, cid2json := database.FetchFromLTS(key) // Use the CID to get the JSON from nft.storage | ||
| domain.Key = key // set the key for unmarshaling | ||
| domain.UnmarshalNFT(cid2json) // convert the JSON to the domain object | ||
| } | ||
|
|
||
| return c.JSON(domain) // return the domain in JSON format | ||
| } | ||
|
|
||
| // NewDomain godoc | ||
| // @Summary Create a Domain | ||
| // @Description Create a new Domain and persist it | ||
| // @Tags domain | ||
| // @Accept application/json | ||
| // @Produce json | ||
| // @Success 200 | ||
| // @Router /msapi/domain [post] | ||
| func NewDomain(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 | ||
| domain := new(model.Domain) // define a domain to be returned | ||
|
|
||
| if err = c.BodyParser(domain); err != nil { // parse the JSON into the domain object | ||
| return c.Status(503).Send([]byte(err.Error())) | ||
| } | ||
|
|
||
| cid2json := make(map[string]string, 0) // create a map for normalizing the domain object into CIDs + JSON strings | ||
| nft := domain.MarshalNFT(cid2json) // convert the domain object into a JSON for nft.storage | ||
|
|
||
| logger.Sugar().Infof("%+v\n", nft) // log the new nft | ||
|
|
||
| // add the domain to the database. Ignore if it already exists since it will be identical | ||
| if meta, err = dbconn.Collection.CreateDocument(ctx, domain); err != nil && !driver.IsConflict(err) { | ||
| logger.Sugar().Errorf("Failed to create document: %v", err) | ||
| } | ||
| logger.Sugar().Infof("Created document in collection '%s' in db '%s' key='%s'\n", dbconn.Collection.Name(), dbconn.Database.Name(), meta.Key) | ||
|
|
||
| database.PersistOnLTS(cid2json) // save the nft JSON version of the domain object to ntf.storage | ||
|
|
||
| return c.JSON(domain) // return the domain 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/domain", GetDomains) // list of domains | ||
| app.Get("/msapi/domain/:key", GetDomain) // single domain based on name or key | ||
| app.Post("/msapi/domain", NewDomain) // save a single domain | ||
| } | ||
|
|
||
| // @title Ortelius v11 Domain Microservice | ||
| // @version 11.0.0 | ||
| // @description RestAPI for the Domain Object | ||
| // @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/domain | ||
| func main() { | ||
| port := ":" + database.GetEnvDefault("MS_POST", "8080") | ||
| app := fiber.New() // create a new fiber application | ||
| 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) | ||
| } | ||
| } | ||
| // Ortelius v11 Domain Microservice that handles creating and retrieving Domains | ||
| package main | ||
|
|
||
| import ( | ||
| "context" | ||
|
|
||
| _ "cli/docs" | ||
|
|
||
| "github.com/arangodb/go-driver" | ||
| "github.com/gofiber/fiber/v2" | ||
| "github.com/gofiber/swagger" | ||
| "github.com/ortelius/scec-commons/database" | ||
| "github.com/ortelius/scec-commons/model" | ||
| ) | ||
|
|
||
| var logger = database.InitLogger() | ||
| var dbconn = database.InitializeDB() | ||
|
|
||
| // GetDomains godoc | ||
| // @Summary Get a List of Domains | ||
| // @Description Get a list of domains for the user. | ||
| // @Tags domain | ||
| // @Accept */* | ||
| // @Produce json | ||
| // @Success 200 | ||
| // @Router /msapi/domain [get] | ||
| func GetDomains(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 domains in the collection | ||
| aql := `FOR domain in evidence | ||
| RETURN domain` | ||
|
|
||
| // 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 domains []model.Domain // define a list of domains to be returned | ||
|
|
||
| for cursor.HasMore() { // loop thru all of the documents | ||
|
|
||
| var domain model.Domain // fetched domain | ||
| var meta driver.DocumentMeta // data about the fetch | ||
|
|
||
| // fetch a document from the cursor | ||
| if meta, err = cursor.ReadDocument(ctx, &domain); err != nil { | ||
| logger.Sugar().Errorf("Failed to read document: %v", err) | ||
| } | ||
| domains = append(domains, domain) // add the domain to the list | ||
| logger.Sugar().Infof("Got doc with key '%s' from query\n", meta.Key) // log the key | ||
| } | ||
|
|
||
| return c.JSON(domains) // return the list of domains in JSON format | ||
| } | ||
|
|
||
| // GetDomain godoc | ||
| // @Summary Get a Domain | ||
| // @Description Get a domain based on the _key or name. | ||
| // @Tags domain | ||
| // @Accept */* | ||
| // @Produce json | ||
| // @Success 200 | ||
| // @Router /msapi/domain/:key [get] | ||
| func GetDomain(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 domains that match the key or name | ||
| aql := `FOR domain in books | ||
| FILTER (domain.name == @key or domain._key == @key) | ||
| RETURN domain` | ||
|
|
||
| // run the query with patameters | ||
| if cursor, err = dbconn.Database.Query(ctx, aql, parameters); err != nil { | ||
| logger.Sugar().Errorf("Failed to run query: %v", err) | ||
| } | ||
|
|
||
| defer cursor.Close() // close the cursor when returning from this function | ||
|
|
||
| var domain model.Domain // define a domain to be returned | ||
|
|
||
| if cursor.HasMore() { // domain found | ||
| var meta driver.DocumentMeta // data about the fetch | ||
|
|
||
| if meta, err = cursor.ReadDocument(ctx, &domain); err != nil { | ||
| 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 | ||
| key, cid2json := database.FetchFromLTS(key) // Use the CID to get the JSON from nft.storage | ||
| domain.Key = key // set the key for unmarshaling | ||
| domain.UnmarshalNFT(cid2json) // convert the JSON to the domain object | ||
| } | ||
|
|
||
| return c.JSON(domain) // return the domain in JSON format | ||
| } | ||
|
|
||
| // NewDomain godoc | ||
| // @Summary Create a Domain | ||
| // @Description Create a new Domain and persist it | ||
| // @Tags domain | ||
| // @Accept application/json | ||
| // @Produce json | ||
| // @Success 200 | ||
| // @Router /msapi/domain [post] | ||
| func NewDomain(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 | ||
| domain := new(model.Domain) // define a domain to be returned | ||
|
|
||
| if err = c.BodyParser(domain); err != nil { // parse the JSON into the domain object | ||
| return c.Status(503).Send([]byte(err.Error())) | ||
| } | ||
|
|
||
| cid2json := make(map[string]string, 0) // create a map for normalizing the domain object into CIDs + JSON strings | ||
| nft := domain.MarshalNFT(cid2json) // convert the domain object into a JSON for nft.storage | ||
|
|
||
| logger.Sugar().Infof("%+v\n", nft) // log the new nft | ||
|
|
||
| // add the domain to the database. Ignore if it already exists since it will be identical | ||
| if meta, err = dbconn.Collection.CreateDocument(ctx, domain); err != nil && !driver.IsConflict(err) { | ||
| logger.Sugar().Errorf("Failed to create document: %v", err) | ||
| } | ||
| logger.Sugar().Infof("Created document in collection '%s' in db '%s' key='%s'\n", dbconn.Collection.Name(), dbconn.Database.Name(), meta.Key) | ||
|
|
||
| database.PersistOnLTS(cid2json) // save the nft JSON version of the domain object to ntf.storage | ||
|
|
||
| return c.JSON(domain) // return the domain 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/domain", GetDomains) // list of domains | ||
| app.Get("/msapi/domain/:key", GetDomain) // single domain based on name or key | ||
| app.Post("/msapi/domain", NewDomain) // save a single domain | ||
| } | ||
|
|
||
| // @title Ortelius v11 Domain Microservice | ||
| // @version 11.0.0 | ||
| // @description RestAPI for the Domain Object | ||
| // @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/domain | ||
| func main() { | ||
| port := ":" + database.GetEnvDefault("MS_POST", "8080") | ||
| app := fiber.New() // create a new fiber application | ||
| 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) | ||
| } | ||
| } |