sheltertechsf / sheltertech-go Goto Github PK

License: GNU General Public License v3.0

Dockerfile 0.21% Makefile 0.66% Go 98.73% Shell 0.41%

sheltertech-go's Introduction

sheltertech-go

This repository contains the beginnings of a Golang implementation of https://github.com/ShelterTechSF/askdarcel-api/

Integrate with askdarcel-api and askdarcel-web stack

This repository requires running the docker-compose setup inside https://github.com/ShelterTechSF/askdarcel-api/blob/master/docker-compose.yml

The docker-compose in this repository links to the same docker network askdarcel and connects to the database defined at https://github.com/ShelterTechSF/askdarcel-api/blob/master/docker-compose.yml#L4

To start the server in the docker network connected to the existing askdarcel-web and askdarcel-api services

make run

To test, you just need to provide the v2 path param in front of any existing API route for Rails API.

curl -s localhost:8080/api/v2/categories | jq

Implementation

Currently supports

GET /api/categories
GET /api/categories/{id}
GET /api/categories/subcategories/{id}
GET /api/categories/featured

Compare against Rails API

You can make the same API calls against the Rails API on port 3000 and compare

curl -s localhost:3000/categories | jq 
curl -s localhost:3000/categories/150 | jq 
curl -s localhost:3000/categories/subcategories/150 | jq 
curl -s localhost:3000/categories/featured | jq

sheltertech-go's People

Contributors

Watchers

sheltertech-go's Issues

GET /categories/hierarchy

Migrate GET /categories/hierarchy to GO
This endpoint queries the 'categories' table and where top_level=true, a nested query to the 'category-relationships' table finds child categories. The response body is an object with the "categories" prefix, followed by an array of empty slices for categories with no children, and sub-arrays of child objects if they exist, ordered (optionally) by rank.

'Bookmarks' API in Go - Delete Bookmark for User

Acceptance: Delete a current bookmark for a user

Design notes: feature requirements

Notes:

bookmarks are associated with users, folders and services
object model: schema.rb

Add automated CI testing

We can use Github Actions for this like we do with the Rails API repo

Run Postman Suite from CI - Do not fail, meant for coverage

Add API Observability

Complete Categories API Go Implementation

There is a mostly done implementation in the repo currently. We should do these things:

Verify all routes and logic from those different HTTP method have been migrated over. Rout]

Route Definitions
Rails: https://github.com/ShelterTechSF/askdarcel-api/blob/master/config/routes.rb#L7-L13
Go: https://github.com/ShelterTechSF/sheltertech-go/blob/main/cmd/sheltertech-go/main.go#L30-L33

Complete automated tests to cover all those changes

Couple examples here: https://github.com/ShelterTechSF/sheltertech-go/blob/main/cmd/sheltertech-go/integration_test.go

They do require having the DB from the Rails repo running, we may need to chat about that setup.

Add automated deployment for "latest"

In memory DB for test context, including data setup (Ruby app has this)

Use an in memory DB under the test context

PATCH /categories/id

Migrate PATCH /categories/id to GO

Account Preferences: API endpoint

Update Datathon Data Endpoint to return Curated Dataset

Swagger doc or equivalent to ruby’s no matched route feature

Implement Services API Go Implementation

Work on Saved Searches API in Go

Figure out how to model this in the DB and how to create an API for it as well

BugFix getCategories

Add categories:{} to the categories API response so it matches the Ruby API

'Folders' API in Go - Update Folder for User

Acceptance: Route to Update a Folder's name and order for a User

Design notes: feature requirements

Notes:

folders cannot be nested
object model: schema.rb

'Folders' API in Go - Get Folders for User

Acceptance: Route to return all folders (with name and order for the current user)

Design notes: figma

Notes:

auth aware
object model: schema.rb
returned in increasing order number with name
endpoint does not need to list all bookmarks per folder

Single test context instead of one per test case

Add go swagger api doc framework

'Bookmarks' API in Go - Create Bookmark for Service

Acceptance: Create a new bookmark for a given resource

Design notes: feature requirements

Notes:

bookmarks are associated with users, folders and services
Organizations and Services can be bookmarked
object model: schema.rb

Migrate GET /categories/counts

Add the GET /categories/counts to GO

Add Summary Endpoint for Counting Active Services/Resources

Implement Resources API Go Implementation

Add Phase 1 of Datathon Data Endpoint (w/o usage check)

'Folders' API in Go - Delete Folder for User

Acceptance: Route to delete a folder associated with the current user

Design notes: feature requirements

Notes:

folders cannot be nested
object model: schema.rb

Open Question:

do we want to remove all bookmarks in the folder, just move them to be associated with the user (no folder), or give the User the choice between the two?