Update blueprint with standard package layout (#51)

Author: fogfish

.assay-it.json

@@ -1,5 +1,5 @@
 {
   "suites": [
-    "http/suites/petshop.go"
+    "internal/http/suites/petshop.go"
   ]
 }

README.md

@@ -88,18 +88,26 @@ Before Getting started, you have to ensure
 
 The structure resembles the mixture of [Standard package layout](https://medium.com/@benbjohnson/standard-package-layout-7cdbc8391fc1) and [Hexagonal architecture](https://medium.com/@matiasvarela/hexagonal-architecture-in-go-cfd4e436faa3). The proposed structure is better version of Hexagonal architecture that follows Golang best practices:
 
-1. the root package contains core types to describe domain of your application. It contains simple types that has no dependency to technology but their implements core logic and use-cases.
+1. the root is aws cdk application
+    
+2. Sub-packages to isolate dependencies to external technologies so that they act as bridge between your domain and technology adaptation. `internal` holds sub-packages internal to applications. `pkg` are sharable clients
 
-2. Use sub-packages to isolate dependencies to external technologies so that they act as bridge between your domain and technology adaptation.
-
-3. Main packages build lambda functions and ties everything together.
+4. `cmd` contains main packages that build lambda functions and ties everything together.
 
 ```
-github.com/.../the-beautiful-app  
-├─ pet.go                      // the root defines domain types, unit test
-├─ ...                         // "algebra" of your application
+github.com/.../the-beautiful-app
+├─ petshop.go                  // aws cdk main application  
+|
+├─ internal/awspetshop         // IaC, aws cdk application
 |
-├─ storage.go                  // defines capability requires to store core
+├─ internal/core               // the root defines domain types, unit test 
+|  |                           // "algebra" of your application. contains core
+|  |                           // types to describe domain of your application.
+|  |                           // It contains simple types that has no dependency
+|  |                           // to technology but their implements core logic
+|  |                           // and use-cases.
+|  |
+|  └─ storage.go               // defines capability requires to store core
 |                              // objects at the external storage, hex-arch
 |                              // use "port" concept to depict it          
 |
@@ -116,14 +124,10 @@ github.com/.../the-beautiful-app
 |
 ├─ internal/mock               // shared mock
 |
-├─ http                        // public REST API exposed by application.
+├─ internal/http               // public REST API exposed by application.
 |  ├─ petshop.go               // collection of petshop endpoints impl. by app
 |  |                           // endpoints consumer services using ports    
 |  | 
-|  ├─ api                      // public objects used by API
-|  |  └─ pet.go
-|  ├─ curl                     // client library
-|  |  └─ petshop.go
 |  └─ suites                   // testing suites for api endpoint(s)
 |
 ├─ cmd                         // executables of the project
@@ -134,8 +138,8 @@ github.com/.../the-beautiful-app
 |  └─ server                   // run application as standalone server 
 |     └─ main.go
 |
-├─ cloud                       // IaC, aws cdk application
-|  └─ ...                      // orchestrate ops model
+├─ pkg/api                     // public domain objects used by application
+|                              // client library
 |
 └─ .github                     // CI/CD with GitHub Actions
     └─ ...                   
@@ -182,7 +186,7 @@ In few seconds, the application becomes available at
 curl https://xxxxxxxxxx.execute-api.eu-west-1.amazonaws.com/api
 ```
 
-The api is protected by AWS IAM, request has to be signed.
+The write path of api is protected by AWS IAM, request has to be signed.
 Either use example client `cmd/petshop-cli` or curl directly
 
 ```bash

cdk.json

@@ -1,5 +1,5 @@
 {
-  "app": "go mod download && go run cloud/blueprint.go",
+  "app": "go mod download && go run petshop.go",
   "requireApproval": "never",
   "context": {
     "@aws-cdk/aws-apigateway:usagePlanKeyOrderInsensitiveId": true,
@@ -8,4 +8,4 @@
     "@aws-cdk/aws-lambda:recognizeVersionProps": true,
     "@aws-cdk/aws-cloudfront:defaultSecurityPolicyTLSv1.2_2021": true
   }
-}
+}

cloud/blueprint.go

@@ -0,0 +1,17 @@
+package main
+
+import (
+	"github.com/aws/aws-lambda-go/lambda"
+	"github.com/fogfish/blueprint-serverless-golang/internal/services/restapi"
+	httpd "github.com/fogfish/gouldian/v2/server/aws/apigateway"
+)
+
+func main() {
+	api := restapi.NewPetShopAPI()
+
+	lambda.Start(
+		httpd.Serve(
+			api.Create(),
+		),
+	)
+}

cloud/blueprint_test.go

@@ -2,17 +2,16 @@ package main
 
 import (
 	"github.com/aws/aws-lambda-go/lambda"
-	"github.com/fogfish/blueprint-serverless-golang/cmd"
+	"github.com/fogfish/blueprint-serverless-golang/internal/services/restapi"
 	httpd "github.com/fogfish/gouldian/v2/server/aws/apigateway"
 )
 
 func main() {
-	api := cmd.NewPetShopAPI()
+	api := restapi.NewPetShopAPI()
 
 	lambda.Start(
 		httpd.Serve(
 			api.List(),
-			api.Create(),
 			api.Lookup(),
 		),
 	)

cmd/lambda/console/main.go

@@ -0,0 +1,5 @@
+{
+  "id": "B00",
+  "category": "bug",
+  "price": 99.99
+}

cmd/lambda/petshop/main.go

@@ -7,32 +7,34 @@ import (
 	"os"
 
 	"github.com/aws/aws-sdk-go-v2/config"
-	"github.com/fogfish/blueprint-serverless-golang/http/curl"
+	"github.com/fogfish/blueprint-serverless-golang/pkg/api"
 	"github.com/fogfish/gurl/awsapi"
 	"github.com/fogfish/gurl/v2/http"
 )
 
-// go run main.go https://XXXXXXXXXX.execute-api.eu-west-1.amazonaws.com
 func main() {
-	fmt.Println(os.Args)
+	if len(os.Args) == 1 {
+		fmt.Printf("petshop-cli https://XXXXXXXXXX.execute-api.eu-west-1.amazonaws.com [pet.json]\n")
+	}
 
-	cfg, err := config.LoadDefaultConfig(context.Background())
-	if err != nil {
-		panic(err)
+	host := os.Args[1]
+	if len(os.Args) == 3 {
+		create(host, os.Args[2])
+	} else {
+		list(host)
 	}
+}
 
-	curl := curl.NewPetShop(
-		http.New(awsapi.WithSignatureV4(cfg)),
-		os.Args[1],
-	)
+func list(host string) {
+	curl := api.NewPetShop(http.New(), host)
 
 	pets, err := curl.List(context.Background())
 	if err != nil {
 		panic(err)
 	}
 	output(pets)
 
-	if pets.Next != nil {
+	for pets.Next != nil && len(*pets.Next) != 0 {
 		pets, err = curl.Continue(context.Background(), *pets.Next)
 		if err != nil {
 			panic(err)
@@ -49,6 +51,37 @@ func main() {
 	}
 }
 
+func create(host string, file string) {
+	var pet api.Pet
+
+	fd, err := os.Open(file)
+	if err != nil {
+		panic(err)
+	}
+	defer fd.Close()
+
+	if err := json.NewDecoder(fd).Decode(&pet); err != nil {
+		panic(err)
+	}
+
+	cfg, err := config.LoadDefaultConfig(context.Background())
+	if err != nil {
+		panic(err)
+	}
+
+	curl := api.NewPetShop(
+		http.New(awsapi.WithSignatureV4(cfg)),
+		host,
+	)
+
+	if err := curl.Create(context.Background(), &pet); err != nil {
+		panic(err)
+	}
+
+	fmt.Printf("==> pet created\n")
+	output(pet)
+}
+
 func output(x any) {
 	b, _ := json.MarshalIndent(x, "|", "  ")
 	os.Stdout.Write(b)

cmd/petshop-cli/bug.json

@@ -3,12 +3,12 @@ package main
 import (
 	server "net/http"
 
-	"github.com/fogfish/blueprint-serverless-golang/cmd"
+	"github.com/fogfish/blueprint-serverless-golang/internal/services/restapi"
 	"github.com/fogfish/gouldian/v2/server/httpd"
 )
 
 func main() {
-	api := cmd.NewPetShopAPI()
+	api := restapi.NewPetShopAPI()
 
 	server.ListenAndServe(":8080",
 		httpd.Serve(