gate-keeper

Description

This a very simple program I wrote to automate a common task at work--opening and closing application gates to mimic an application cycle flow. I tried writing this generically, so that some user with a different database schema can find this helpful. Specifying this schema is done in a config.json.

To help you visualize what this program does. see the below timeline:

       aaaaa       bbbbb       ccccc       ddddd       eeeee     
------------------------------------------------------------------------

This represents an application cycle, as you can see, the cycle has periods a through e.

This program will configure the gates for a given year such that you will be virtually teleported.

Lets say, given the database of the above system, and as program inputs I provided: year 2025, at gate c, place me before it

These inputs, will update the start datetime and end datetime of the application gates so that you are placed on the timeline as shown below. (indicated by me)

       aaaaa       bbbbb  me   ccccc       ddddd       eeeee     
------------------------------------------------------------------------

In other words, the open and close dates of the gates are configured so that the current moment is before the opening of gate c.

For the third input, other options are after and inside, which wouls appear as:

inside:

                                me
       aaaaa       bbbbb       ccccc       ddddd       eeeee     
------------------------------------------------------------------------

after

       aaaaa       bbbbb       ccccc   me  ddddd       eeeee     
------------------------------------------------------------------------

---

NOTE: To be clear and specific, this program will update all gates that are part of an application cycle, such that the selected gate is today's date, with a relative offset, which is set based on the program's third parameter.

Getting started

To begin using this program, it rrequires one file for configuration.

This file look like:

config.json

	"Credentials": {
		"User": "USER",
		"Pass": "xxxx",
		"Host": "url",
		"Port": "3306"
	},
	"GateConfig": {
		"Dbname": "dbname",
		"TableName": "table",
		"GateNameKey": "code",
		"GateYearKey": "year",
		"GateOrderKey": "order",
		"GateIsApplicableFlag": "active",
		"StartKey": "start",
		"EndKey": "end"
	}
}

Once you have this file in your working directory and assuming you've already built from source

source .env

and run the binary:

./gate-keeper

Then just choose the selects and press 'Set Gates'.

.

Authors

• Matt Maloney : matttm

Contribute

If you want to contribute, just send me a message.