krowki

command module

v0.0.0-...-508bb99 Latest Latest Go to latest Published: Oct 27, 2019 License: MIT Imports: 2 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/deeper-x/krowki

Links

Open Source Insights

README ¶

GSW - krowki Shipreporting Webservice

Note: calls marked w/ [*MP] are marked for porting. Those w/ [*OK] are completed, deployed and available for production. Calls w/ [*SB] are in stand-by, candidated to be rejected.

Version: v0.2.10

REST services:

Real time data:

A2 - Currently at roadstead:
A3 - Currently at mooring
A4 - Ships arrived today
A5 - Ships departed today
A6 - Today's arrivals previsions
A7 - Shipped goods for active trips
A8 . Traffic list for active trips
A9 - Today's shifting previsions
A10 - Today's departure previsions
A11 - Today's shiftings

Register data (with dynamic range):

C1 - Arrivals
C2 - Moored
C3 - At roadstead
C4 - Departures
C5 - Shiftings
C7 - Shipped goods
C8 - Traffic list

Meteo data:

E2 - Active stations

A - LIVE DATA SERVICES:

A1. Active trips: [*SB]

Request:

http://<REMOTE_IP>:8000/activeTripsNow?id_portinformer=<id_portinformer>

A2. At roadstead: [*OK]

Description: trips currently in state of anchoring

Request:

Request:
http://<REMOTE_IP>:8000/anchored/<id_portinformer>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, anchoringTime, currentActivity, anchoragePoint, shipType, iso3, grossTonnage, length, width, agency, shippedGoods, tsPlannedMooring, tsReadiness]

res := map[string]string{
    "id_trip":          idControlUnitDataStr.String,
    "ship":             shipName.String,
    "ship_type":        shipType.String,
    "anchoring_time":   anchoringTime.String,
    "current_activity": currentActivity.String,
    "anchorage_point":  anchoragePoint.String,
    "iso3":             iso3.String,
    "gross_tonnage":    grossTonnage.String,
    "length":           length.String,
    "width":            width.String,
    "agency":           agency.String,
    "shipped_goods":    shipped_goods.String,
    "ts_planned_mooring": tsPlannedMooring.String,
    "ts_readiness":       tsReadiness.String,
    }

A3. Moored: [*OK]

Description: trips currently in state of mooring

Request:

http://<REMOTE_IP>:8000/moored/<id_portinformer>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, shipType, mooringTime, currentActivity, quay, shippedGoods, country, grossTonnage, length, width,  agency]

res := map[string]string{
    "id_trip":          idControlUnitDataStr.String,
    "ship":             shipName.String,
    "mooring_time":     mooringTime.String,
    "current_activity": currentActivity.String,
    "quay":             quay.String,
    "shipped_goods":    shippedGoods.String,
    "iso3":             iso3.String,
    "gross_tonnage":    grossTonnage.String,
    "ships_length":     length.String,
    "ships_width":      width.String,
    "ship_type":        shipType.String,
    "agency":           agency.String,
    "ts_etd":           tsETD.String,
}

A4. Arrivals: [*OK]

Description: trips with sighting date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/arrivalsToday/<id_portinformer>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [ship, tsArrivalPrevision, shipType, country, width, length, grossTonnage, netTonnage, draftAft, draftFwd, agency, LPC, destinationQuayBerth, destinationRoadstead, cargoOnBoard]

res := map[string]string{
    "id_trip":                idTrip.String,
    "ship_name":              shipName.String,
    "ship_type":              shipType.String,
    "ts_sighting":            tsSighting.String,
    "ship_flag":              shipFlag.String,
    "ship_width":             shipWidth.String,
    "ship_length":            shipLength.String,
    "gross_tonnage":          grossTonnage.String,
    "net_tonnage":            netTonnage.String,
    "draft_aft":              draftAft.String,
    "draft_fwd":              draftFwd.String,
    "agency":                 agency.String,
    "last_port_of_call":      lastPortOfCall.String,
    "port_destination":       portDestination.String,
    "destination_quay_berth": destinationQuayBerth.String,
    "destination_roadstead":  destinationRoadstead.String,
    }

A5. Departures: [*OK]

Description: trips with out of sight date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/departuresToday/<id_portinformer>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, shipType, tsOutOfSight, shipFlag, shipWidth, shipLength, grossTonnage, netTonnage, draftAft, draftFwd, agency, LPC, portDestination]


res := map[string]string{
    "id_trip":           idTrip.String,
    "ship_name":         shipName.String,
    "ship_type":         shipType.String,
    "ts_out_of_sight":   tsOutOfSight.String,
    "ship_flag":         shipFlag.String,
    "ship_width":        shipWidth.String,
    "ship_length":       shipLength.String,
    "gross_tonnage":     grossTonnage.String,
    "net_tonnage":       netTonnage.String,
    "draft_aft":         draftAft.String,
    "draft_fwd":         draftFwd.String,
    "agency":            agency.String,
    "last_port_of_call": lastPortOfCall.String,
    "port_destination":  portDestination.String,
    }

A6. Arrival previsions: [*OK]

Description: trips with out_of_sight date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/arrivalPrevisions/<id_portinformer>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [ship, tsArrivalPrevision, shipType, shipFlag, shipWidth, shipLength, grossTonnage, netTonnage, draftAft, draftFwd, agency, LPC, destinationQuayBerth, destinationRoadstead, cargoOnBoard]

res := map[string]string{
    "id_trip":                idControlUnitDataStr.String,
    "ship":                   shipName.String,
    "ts_arrival_prevision":   tsArrivalPrevision.String,
    "ship_type":              shipType.String,
    "ship_flag":              shipFlag.String,
    "ship_width":             shipWidth.String,
    "ship_length":            shipLength.String,
    "gross_tonnage":          grossTonnage.String,
    "net_tonnage":            netTonnage.String,
    "draft_aft":              draftAft.String,
    "draft_fwd":              draftFwd.String,
    "agency":                 agency.String,
    "last_port_of_call":      lastPortOfCall.String,
    "destination_quay_berth": destinationQuayBerth.String,
    "destination_roadstead":  destinationRoadstead.String,
    "cargo_on_board":         cargoOnBoard.String,
    }

A7. Shipped goods: [*OK]

Description: shipped goods in trips with sighting date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/shippedGoodsToday/<id_portinformer>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, quantity, unit, goodsCategory, shipType, shipFlag, shipWidth, shipLength, grossTonnage, netTonnage, groupCategory, macroCategory]

res := map[string]string{
    "id_trip":        idTrip.String,
    "ship_name":      shipName.String,
    "quantity":       quantity.String,
    "unit":           unit.String,
    "goods_category": goodsCategory.String,
    "ship_type":      shipType.String,
    "ship_flag":      shipFlag.String,
    "ship_width":     shipWidth.String,
    "shipLength":     shipLength.String,
    "grossTonnage":   grossTonnage.String,
    "netTonnage":     netTonnage.String,
    "groupCategory":  groupCategory.String,
    "macroCategory":  macroCategory.String,
    }

A8. RO/RO + RO/PAX: [*OK]

Description: RO/RO RO/PAX operations in trips with with sighting date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/trafficListToday/<id_portinformer>

Response:

## Content-Type: application/json; charset=UTF-8

## data := [idTrip, shipName, numContainer, numPassengers, numCamion, numFurgoni, numRimorchi, numAuto, numMoto, numCamper, tons, numBus, numMinibus, trafficListMvntType, trafficListCategories, quay]


res := map[string]string{
    "id_trip":        idTrip.String,
    "ship_name":      shipName.String,
    "num_container":  numContainer.String,
    "num_passengers": numPassengers.String,
    "num_camion":     numCamion.String,
    "num_furgoni":    numFurgoni.String,
    "num_rimorchi":   numRimorchi.String,
    "num_auto":       numAuto.String,
    "num_moto":       numMoto.String,
    "num_camper":     numCamper.String,
    "tons":           tons.String,
    "num_bus":        numBus.String,
    "num_minibus":    numMinibus.String,
    "mvnt_type":      mvntType.String,
    "description":    description.String,
    "quay":           quay.String,
    }

A9. Shifting previsions: [*OK]

Description: trips with shifting prevision date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/shiftingPrevisions/<id_portinformer>

Response:

## Content-Type: application/json; charset=UTF-8

## data := [ship, ts_shifting_prevision, ship_type, ship_flag, ship_width, ship_length, gross_tonnage,net_tonnage, draft_aft, draft_fwd, agency, starting_quay_berth, starting_roadstead, stop_quay_berth, stop_roadstead, cargo_on_board]


res := map[string]string{
    "ship":                 ship.String,
    "tsDeparturePrevision": tsShiftingPrevision.String,
    "shipType":             shipType.String,
    "shipFlag":             shipFlag.String,
    "shipWidth":            shipWidth.String,
    "shipLength":           shipLength.String,
    "grossTonnage":         grossTonnage.String,
    "netTonnage":           netTonnage.String,
    "draftAft":             draftAft.String,
    "draftFwd":             draftFwd.String,
    "agency":               agency.String,
    "destinationPort":      destinationPort.String,
    "startingQuayBerth":    startingQuayBerth.String,
    "startingRoadstead":    stopRoadstead.String,
    "stopQuayBerth":        stopQuayBerth.String,
    "stopRoadstead":        stopRoadstead.String,
    "cargoOnBoard":         cargoOnBoard.String,
    }

A10. Departure previsions: [*OK]

Description: trips with departure prevision's date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/departurePrevisions/<id_portinformer>

Response:

## Content-Type: application/json; charset=UTF-8

## data := [ship, ts_departure_prevision, ship_type, ship_flag, ship_width, ship_length, gross_tonnage, net_tonnage, draft_aft, draft_fwd, agency, destination_port, starting_quay_berth, starting_roadstead, cargo_on_board]

res := map[string]string{
    "ship":                   ship.String,
    "ts_departure_prevision": tsDeparturePrevision.String,
    "ship_type":              shipType.String,
    "ship_flag":              shipFlag.String,
    "ship_width":             shipWidth.String,
    "ship_length":            shipLength.String,
    "gross_tonnage":          grossTonnage.String,
    "net_tonnage":            netTonnage.String,
    "draft_aft":              draftAft.String,
    "draft_fwd":              draftFwd.String,
    "agency":                 agency.String,
    "destination_port":       destinationPort.String,
    "starting_quay_berth":    startingQuayBerth.String,
    "starting_roadstead":     startingRoadstead.String,
    "cargo_on_board":         cargoOnBoard.String,
    }

A11. Shiftings: [OK]

Description: trips' where starting shifting's date == ${TODAY}

Request:

http://<REMOTE_IP>:8000/shiftingsToday/<ID_PORTINFORMER>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, tsSighting, imo, ship, shipType, iso3, fromQuay, toQuay, fromAnch, toAnch]

res := map[string]string{
	"id_trip":     idTrip.String,
	"ts_sighting": tsSighting.String,
	"imo":         imo.String,
	"ship":        ship.String,
	"ship_type":   shipType.String,
	"iso3":        iso3.String,
	"from_quay":   fromQuay.String,
	"to_quay":     toQuay.String,
	"from_anch":   fromAnch.String,
	"to_anch":     toAnch.String,
}

B - ARCHIVE DATA SERVICES:

B1. Trips archive [global recap, one row per trip]: [*MP]

Request:

http://<REMOTE_IP>:8000/tripsArchive?id_portinformer=<ID_PORTINFORMER>

B2. Trips archive [global recap, one row per commercial operation]: [*SB]

Request:

http://<REMOTE_IP>:8000/tripsArchiveMultiRows?id_portinformer=<ID_PORTINFORMER>

B3. Trip data archive [shipreport core]: [*SB]

Request:

http://<REMOTE_IP>:8000/shipReportList?id_portinformer=<ID_PORTINFORMER>

B4. Trip data archive detailed [shipreport]: [*SB]

Request:

http://<REMOTE_IP>:8000/shipReportDetails?id_portinformer=<ID_PORTINFORMER>

B5. Arrivals archive: [*MP]

Request:

http://<REMOTE_IP>:8000/arrivalsArchive?id_portinformer=<id_portinformer>

B6. Departures archive: [*MP]

Request:

http://<REMOTE_IP>:8000/departuresArchive?id_portinformer=<id_portinformer>

B7. Shipped goods archive: [*MP]

Request:

http://<REMOTE_IP>:8000/shippedGoodsArchive?id_portinformer=<id_portinformer>

B8. Traffic list archive: [*MP]

Request:

http://<REMOTE_IP>:8000/trafficListArchive?id_portinformer=<id_portinformer>

C - DAILY REGISTER SERVICES:

These calls get the last trip activity in range, according with criteria

C1. Arrivals: [*OK]

Description: trips with sighting's date in range

Request:

http://<REMOTE_IP>:8000/arrivalsRegister/<ID_PORTINFORMER>/<TIMESTAMP_START>/<TIMESTAMP_STOP>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [ship, tsArrivalPrevision, shipType, country, width, length, grossTonnage, netTonnage, draftAft, draftFwd, agency, LPC, destinationQuayBerth, destinationRoadstead, cargoOnBoard]

res := map[string]string{
    "id_trip":                idTrip.String,
    "ship_name":              shipName.String,
    "ship_type":              shipType.String,
    "ts_sighting":            tsSighting.String,
    "ship_flag":              shipFlag.String,
    "ship_width":             shipWidth.String,
    "ship_length":            shipLength.String,
    "gross_tonnage":          grossTonnage.String,
    "net_tonnage":            netTonnage.String,
    "draft_aft":              draftAft.String,
    "draft_fwd":              draftFwd.String,
    "agency":                 agency.String,
    "last_port_of_call":      lastPortOfCall.String,
    "port_destination":       portDestination.String,
    "destination_quay_berth": destinationQuayBerth.String,
    "destination_roadstead":  destinationRoadstead.String,
    }

C2. Moored: [*OK]

Description: trips with the last activity as mooring in range (whatever form has been used)

Request:

http://<REMOTE_IP>:8000/mooredRegister/<ID_PORTINFORMER>/<TIMESTAMP_START>/<TIMESTAMP_STOP>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, shipType, tsMooring, shipFlag, shipWidth, shipLength, grossTonnage, netTonnage, agency]

res := map[string]string{
    "id_trip":       idTrip.String,
    "ship_name":     shipName.String,
    "ship_type":     shipType.String,
    "ts_mooring":    tsMooring.String,
    "ship_flag":     shipFlag.String,
    "ship_width":    shipWidth.String,
    "ship_length":   shipLength.String,
    "gross_tonnage": grossTonnage.String,
    "net_tonnage":   netTonnage.String,
    "agency":        agency.String,
    }

C3. Roadstead: [*OK]

Description: trips with the last activity as anchoring in range (whatever form has been used)

Request:

http://<REMOTE_IP>:8000/roadsteadRegister/<ID_PORTINFORMER>/<TIMESTAMP_START>/<TIMESTAMP_STOP>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, shipType, tsAnchoring, shipFlag, shipWidth, shipLength, grossTonnage, netTonnage, agency]

res := map[string]string{
    "id_trip":       idTrip.String,
    "ship_name":     shipName.String,
    "ship_type":     shipType.String,
    "ts_anchoring":  tsAnchoring.String,
    "ship_flag":     shipFlag.String,
    "ship_width":    shipWidth.String,
    "ship_length":   shipLength.String,
    "gross_tonnage": grossTonnage.String,
    "net_tonnage":   netTonnage.String,
    "agency":        agency.String,
    }

C4. Departures: [*OK]

Description: trips with out of sight in range (whatever form has been used)

Request:

http://<REMOTE_IP>:8000/departuresRegister/<ID_PORTINFORMER>/<TIMESTAMP_START>/<TIMESTAMP_STOP>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, shipType, tsOutOfSight, shipFlag, shipWidth, shipLength, grossTonnage, netTonnage, draftAft, draftFwd, agency, LPC, portDestination]


res := map[string]string{
    "id_trip":           idTrip.String,
    "ship_name":         shipName.String,
    "ship_type":         shipType.String,
    "ts_out_of_sight":   tsOutOfSight.String,
    "ship_flag":         shipFlag.String,
    "ship_width":        shipWidth.String,
    "ship_length":       shipLength.String,
    "gross_tonnage":     grossTonnage.String,
    "net_tonnage":       netTonnage.String,
    "draft_aft":         draftAft.String,
    "draft_fwd":         draftFwd.String,
    "agency":            agency.String,
    "last_port_of_call": lastPortOfCall.String,
    "port_destination":  portDestination.String,
    }

C5. Shiftings: [OK]

Description: trips' starting shifting in passed range

Request:

http://<REMOTE_IP>:8000/shiftingsRegister/<ID_PORTINFORMER>/<TIMESTAMP_START>/<TIMESTAMP_STOP>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, tsSighting, imo, ship, shipType, iso3, fromQuay, toQuay, fromAnch, toAnch]

res := map[string]string{
	"id_trip":     idTrip.String,
	"ts_sighting": tsSighting.String,
	"imo":         imo.String,
	"ship":        ship.String,
	"ship_type":   shipType.String,
	"iso3":        iso3.String,
	"from_quay":   fromQuay.String,
	"to_quay":     toQuay.String,
	"from_anch":   fromAnch.String,
	"to_anch":     toAnch.String,
}

C6. Arrival previsions: [*MP]

Request:

http://<REMOTE_IP>:8000/registerPlannedArrivals?id_portinformer=<ID_PORTINFORMER>

C7. Shipped goods: [*MP]

Description: commercial operations trips with sighting date in range (whatever form has been used)

Request:

http://<REMOTE_IP>:8000/shippedGoodsRegister/<id_portinformer>/<TIMESTAMP_START>/<TIMESTAMP_STOP>

Response:

# Content-Type: application/json; charset=UTF-8

# data := [idTrip, shipName, quantity, unit, goodsCategory, shipType, shipFlag, shipWidth, shipLength, grossTonnage, netTonnage, groupCategory, macroCategory]

res := map[string]string{
    "id_trip":        idTrip.String,
    "ship_name":      shipName.String,
    "quantity":       quantity.String,
    "unit":           unit.String,
    "goods_category": goodsCategory.String,
    "ship_type":      shipType.String,
    "ship_flag":      shipFlag.String,
    "ship_width":     shipWidth.String,
    "ship_length":    shipLength.String,
    "gross_tonnage":  grossTonnage.String,
    "net_tonnage":    netTonnage.String,
    "group_category": groupCategory.String,
    "macro_category": macroCategory.String,
}

C8. RO/RO + RO/PAX: [*MP]

Description: RO/RO + RO/PAX operations trips with sighting date in range (whatever form has been used)

Request:

http://<REMOTE_IP>:8000/trafficListRegister/<id_portinformer>/<TIMESTAMP_START>/<TIMESTAMP_STOP>

Response:

## Content-Type: application/json; charset=UTF-8

## data := [idTrip, shipName, tsSighting, numContainer, numPassengers, numCamion, numFurgoni, numRimorchi, numAuto, numMoto, numCamper, tons, numBus, numMinibus, trafficListMvntType, trafficListCategories, quay]


res := map[string]string{
    "id_trip":        idTrip.String,
    "ship_name":      shipName.String,
    "ts_sighting":    tsSighting.String,
    "num_container":  numContainer.String,
    "num_passengers": numPassengers.String,
    "num_camion":     numCamion.String,
    "num_furgoni":    numFurgoni.String,
    "num_rimorchi":   numRimorchi.String,
    "num_auto":       numAuto.String,
    "num_moto":       numMoto.String,
    "num_camper":     numCamper.String,
    "tons":           tons.String,
    "num_bus":        numBus.String,
    "num_minibus":    numMinibus.String,
    "mvnt_type":      mvntType.String,
    "description":    description.String,
    "quay":           quay.String,
    }

D - BUSINESS INTELLIGENCE SERVICES:

D1. Shiftings/maneuverings [per quay/berth]: [*MP]

Request:

http://<REMOTE_IP>:8000/tripsManeuverings?id_portinformer=<ID_PORTINFORMER>

D2. Shipped goods recap: [*MP]

Request:

http://<REMOTE_IP>:8000/shippedGoodsRecap?id_portinformer=<ID_PORTINFORMER>

D3. RO/RO + RO/PAX recap: [*MP]

Request:

http://<REMOTE_IP>:8000/trafficListRecap?id_portinformer=<ID_PORTINFORMER>

E - METEO DATA

E1. Meteo data archive: [*MP]

Request:

http://<REMOTE_IP>:8000/meteoArchive?id_portinformer=<ID_PORTINFORMER>

E2. Active meteo stations: [OK]

Request:

http://<REMOTE_IP>:8000/weatherActiveStations

Response:

## Content-Type: application/json; charset=UTF-8

## data := [idPortinformer, portinformerCode, tsFirstCreated, isActive]

res := map[string]string{
    "id_portinformer":   idPortinformer.String,
    "portinformer_code": portinformerCode.String,
    "ts_first_created":  tsFirstCreated.String,
    "is_active":         isActive.String,
}

Install Go and (first) run

ref. https://golang.org/doc/install?download=go1.12.10.linux-386.tar.gz

$ go version
go version go1.12.10 linux/amd64

$ export PATH=${PATH}:/usr/local/go/bin/ ## FIX w/ your installation path

## Pass vars at runtime or add to .bash_profile
$ export GOPATH=${HOME}/go
$ export GOBIN=${GOPATH}/bin
$ export PATH=${PATH}:${GOBIN}

## Get krowki and deploy
$ go get github.com/deeper-x/krowki

$ cd ${GOPATH}/src/github.com/deeper-x/krowki
$ cat > .env <<HEREDOC
DB_DSN="postgres://<user>:<passwd>@127.0.0.1/<db>"
HEREDOC

$ go get -d ./...
$ go install src/krowki.go
$ krowki ## RUN FOR TEST
Now listening on: http://localhost:8000
Application started. Press CTRL+C to shut down.

## Close test instance
$ <CTRL+C>

Integration Test (httpexpect)

$ go test -v ./...
=== RUN   TestMain
--- PASS: TestMain (0.44s)
PASS
ok  	github.com/deeper-x/krowki/src	(cached)

Systemd configuration

## Service install instructions:
## This is a service file template you can start from
$ sudo cat > /usr/lib/systemd/system/krowki.service <<HEREDOC

[Unit]
Description=Shipreporting service middleware
Documentation=https://github.com/deeper-x/krowki
After=network.target

[Service]
Type=simple
User=<YOUR_USER>
Environment=GOPATH=/home/<YOUR_USER>/go
WorkingDirectory=<YOUR_GOPATH>/bin/
ExecStart=<YOUR_GOBIN>/krowki
Restart=on-failure

[Install]
WantedBy=multi-user.target

HEREDOC

Documentation ¶

There is no documentation for this package.

Source Files ¶

View all Source files

main.go

Directories ¶

Path	Synopsis
conf
ldb
web

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL