chore: cleanup files and readme (#37)

Light refactor for zone request/responses
Change log level to debug
Improve readme

Author: jwebster45206

.gitignore

@@ -25,6 +25,7 @@ go.work.sum
 .env
 
 *.json
+!config.docker.json
 
 # test build
 tcg-api

README.md

@@ -1,4 +1,4 @@
-# tcg-api
+# TCG API
 A lightweight REST API for simulating card decks, built with Go. The API features a modular card interface design that separates game-specific mechanics from general deck mechanics, making it extensible for different types of card games.
 
 ## Technical Stack
@@ -23,7 +23,93 @@ A lightweight REST API for simulating card decks, built with Go. The API feature
 - Shuffle 
 - Draw (TODO)
 
-## Resource Design 
+## Getting Started
+
+### Running with Docker
+
+1. Clone the repository:
+   ```bash
+   git clone https://github.com/jwebster45206/tcg-api.git
+   cd tcg-api
+   ```
+
+2. Edit `docker-compose.yml` file, or use project defaults. 
+
+3. Run:
+   ```bash
+   docker compose up --build
+   ```
+
+4. The API will be available at `http://localhost:8080/v1`.
+
+> Sample config is provided in [`config.docker.json`](./config.docker.json).
+
+### Example Usage
+
+#### Health Endpoint
+```bash
+curl --location 'http://localhost:8080/health'
+```
+
+#### List Decks
+````bash
+curl --location 'http://localhost:8080/v1/decks'
+````
+
+#### Create a DeckState
+````bash
+curl --location 'http://localhost:8080/v1/deckstates' \
+--header 'Content-Type: application/json' \
+--data '{
+  "deck_id": "d0000000-0000-0000-0000-000000000001",
+  "player_count": 2
+}'
+````
+
+#### Shuffle Deck
+````bash
+curl --location 'http://localhost:8080/v1/deckstates/11111111-1111-1111-1111-111111111111/actions/sort-zone?include=meta%2Citems' \
+--header 'Content-Type: application/json' \
+--data '{
+    "zone": "draw",
+    "sort": "shuffle"
+}'
+````
+
+#### Order Deck by Definition
+````bash
+curl --location 'http://localhost:8080/v1/deckstates/11111111-1111-1111-1111-111111111111/actions/sort-zone?include=meta%2Citems' \
+--header 'Content-Type: application/json' \
+--data '{
+    "zone": "draw",
+    "sort": "definition"
+}'
+````
+
+#### Add a Zone
+```bash
+curl --location 'http://localhost:8080/v1/deckstates/11111111-1111-1111-1111-111111111111/actions/add-zone' \
+--header 'Content-Type: application/json' \
+--data '{
+  "zone": "foo",
+  "size": 10
+}'
+```
+
+#### Remove a Zone
+Note: Only empty zones may be removed. 
+````bash
+curl --location 'http://localhost:8080/v1/deckstates/11111111-1111-1111-1111-111111111111/actions/remove-zone' \
+--header 'Content-Type: application/json' \
+--data '{
+  "zone": "foo"
+}'
+````
+
+### Draw cards
+TODO
+
+##  Resource Design 
 
 Resources are separated into two main packages, `deckdef` and `deckstate`. 
 
@@ -97,4 +183,12 @@ Performance and modeling notes:
 1. Role-based access control
    - Admin roles for card management
    - Player roles for deck management and simulation
-   - Card details dependent on card facing and user claims
+   - Card details dependent on card facing and user claims
+
+## License
+
+MIT
+
+## Contributing
+
+Pull requests ok. For major changes, please open an issue first.

cmd/tcg-api/main.go

@@ -48,7 +48,9 @@ func main() {
 	}
 
 	// Set up structured logging
-	logger := config.NewLogger(cfg.Logger)
+	loggerConfig := cfg.Logger
+	loggerConfig.Level = config.LogLevelDebug // TODO: Add log level configuration to config
+	logger := config.NewLogger(loggerConfig)
 	config.SetDefaultLogger(logger)
 
 	logger.Info("Starting TCG API",

config.docker.json

@@ -0,0 +1,28 @@
+{
+  "env": "development",
+  "port": "8080",
+  "db": {
+    "host": "mysql",
+    "port": "3306",
+    "user": "tcg_user",
+    "password": "password",
+    "dbname": "tcg"
+  },
+  "db_reader": {
+    "host": "mysql",
+    "port": "3306",
+    "user": "tcg_user",
+    "password": "password",
+    "dbname": "tcg"
+  },
+  "redis": {
+    "host": "redis",
+    "port": "6379",
+    "password": "",
+    "db": 0
+  },
+  "logger": {
+    "level": "info",
+    "format": "json"
+  }
+}

internal/handlers/deckstate_test.go

@@ -571,7 +571,7 @@ func TestDeckStateHandler_SortZoneAction(t *testing.T) {
 		t.Errorf("Expected status %d, got %d", http.StatusOK, w.Code)
 	}
 
-	var response SortZoneResponse
+	var response ZoneResponse
 	if err := json.Unmarshal(w.Body.Bytes(), &response); err != nil {
 		t.Errorf("Failed to unmarshal response: %v", err)
 	}

internal/handlers/shuffle.go

@@ -23,19 +23,6 @@ type SortZoneRequest struct {
 	Sort string `json:"sort"`
 }
 
-// SortZoneResponse represents the response from a sort zone operation
-type SortZoneResponse struct {
-	Zone *deckstate.Zone `json:"zone"`
-	Meta *SortZoneMeta   `json:"meta,omitempty"`
-}
-
-// SortZoneMeta contains metadata about the sort operation
-type SortZoneMeta struct {
-	ZoneLength int     `json:"zoneLength"`
-	Sort       string  `json:"sort"`
-	DurationMS float64 `json:"durationMS"`
-}
-
 // shuffleZone performs a shuffle operation on a zone, returning
 // a measurement of the time taken to perform the shuffle.
 func shuffleZone(zone *deckstate.Zone) (time.Duration, error) {
@@ -202,15 +189,18 @@ func (h *DeckStateHandler) handleSortZone(w http.ResponseWriter, r *http.Request
 		responseZone.Items = nil
 	}
 
-	sortResponse := SortZoneResponse{
-		Zone: &responseZone,
+	sortResponse := ZoneResponse{
+		Success: true,
+		Zone:    &responseZone,
 	}
 
 	if includeMeta {
-		sortResponse.Meta = &SortZoneMeta{
-			ZoneLength: len(zone.Items),
-			Sort:       req.Sort,
+		zoneLength := len(zone.Items)
+		sortResponse.Meta = &ZoneResponseMeta{
+			Operation:  "sort_zone",
 			DurationMS: float64(duration.Microseconds()) / 1000, // Convert to milliseconds
+			ZoneLength: &zoneLength,
+			Sort:       &req.Sort,
 		}
 	}