Merge pull request #21 from GreenSpaceNASA/stream

Stream
garajonai · Nov 1, 2023 · 1c78194 · 1c78194
2 parents 48635e1 + 4380270
commit 1c78194
Show file tree

Hide file tree

Showing 5 changed files with 59 additions and 25 deletions.
diff --git a/Makefile b/Makefile
@@ -38,6 +38,23 @@ PROTOC_GRPC_GATEWAY_OPTS=${PROTO_OPTION} \
 	--plugin=protoc-gen-grpc-gateway=${BIN_DIR}/protoc-gen-grpc-gateway \
 	--grpc-gateway_out=logtostderr=true:${GEN_GO_DIR}
 
+.PHONY: help
+help:
+	@echo "Usage: make <target>"
+	@echo ""
+	@echo "Targets:"
+	@echo "  vendor        - Update vendor"
+	@echo "  plugin        - Build protoc plugins"
+	@echo "  proto         - Generate proto"
+	@echo "  proto/go      - Generate go client from proto"
+	@echo "  clean/go      - Clean go client"
+	@echo "  release/go    - Publish go client"
+	@echo "  docs          - Generate docs"
+	@echo "  lint          - Lint proto"
+	@echo "  fmt           - Format proto"
+	@echo "  changelog     - Generate changelog"
+	@echo "  help          - Show this help message"
+
 .PHONY: vendor
 vendor: go.sum .gitmodules
 	@echo "Updating vendor..."

diff --git a/docs/README.md b/docs/README.md
@@ -16,7 +16,7 @@
 
     - [Condition](#platform-api-v1-Condition)
 
-    - [BFF](#platform-api-v1-BFF)
+    - [Bff](#platform-api-v1-Bff)
     - [Internal](#platform-api-v1-Internal)
 
 - [Scalar Value Types](#scalar-value-types)
@@ -39,7 +39,7 @@ Animals
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | name | [string](#string) |  |  |
-| inDanger | [bool](#bool) |  |  |
+| in_danger | [bool](#bool) |  |  |
 | description | [string](#string) |  |  |
 
 
@@ -166,7 +166,7 @@ BFF
 | Field | Type | Label | Description |
 | ----- | ---- | ----- | ----------- |
 | location | [Location](#platform-api-v1-Location) |  |  |
-| nearestAquaticLocation | [AreaResponse](#platform-api-v1-AreaResponse) |  |  |
+| nearest_aquatic_location | [AreaResponse](#platform-api-v1-AreaResponse) |  |  |
 | animals | [Animal](#platform-api-v1-Animal) | repeated |  |
 
 
@@ -197,9 +197,9 @@ Area
 
 
 
-<a name="platform-api-v1-BFF"></a>
+<a name="platform-api-v1-Bff"></a>
 
-### BFF
+### Bff
 BFF service
 
 | Method Name | Request Type | Response Type | Description |

diff --git a/go.mod b/go.mod
@@ -11,10 +11,22 @@ require (
 )
 
 require (
+	cloud.google.com/go/compute v1.23.1 // indirect
+	cloud.google.com/go/compute/metadata v0.2.3 // indirect
+	github.com/golang/groupcache v0.0.0-20210331224755-41bb18bfe9da // indirect
 	github.com/golang/protobuf v1.5.3 // indirect
+	github.com/google/s2a-go v0.1.7 // indirect
+	github.com/google/uuid v1.4.0 // indirect
+	github.com/googleapis/enterprise-certificate-proxy v0.3.2 // indirect
+	github.com/googleapis/gax-go/v2 v2.12.0 // indirect
+	go.opencensus.io v0.24.0 // indirect
+	golang.org/x/crypto v0.14.0 // indirect
 	golang.org/x/net v0.17.0 // indirect
+	golang.org/x/oauth2 v0.13.0 // indirect
 	golang.org/x/sys v0.13.0 // indirect
 	golang.org/x/text v0.13.0 // indirect
-	google.golang.org/genproto v0.0.0-20231012201019-e917dd12ba7a // indirect
-	google.golang.org/genproto/googleapis/rpc v0.0.0-20231012201019-e917dd12ba7a // indirect
+	google.golang.org/api v0.149.0 // indirect
+	google.golang.org/appengine v1.6.7 // indirect
+	google.golang.org/genproto v0.0.0-20231016165738-49dd2c1f3d0b // indirect
+	google.golang.org/genproto/googleapis/rpc v0.0.0-20231016165738-49dd2c1f3d0b // indirect
 )
diff --git a/go.sum b/go.sum
@@ -1,6 +1,9 @@
 cloud.google.com/go v0.26.0/go.mod h1:aQUYkXzVsufM+DwF1aE+0xfcU+56JwCaLick0ClmMTw=
+cloud.google.com/go v0.110.8 h1:tyNdfIxjzaWctIiLYOTalaLKZ17SI44SKFW26QbOhME=
 cloud.google.com/go/compute v1.23.0 h1:tP41Zoavr8ptEqaW6j+LQOnyBBhO7OkOMAGrgLopTwY=
 cloud.google.com/go/compute v1.23.0/go.mod h1:4tCnrn48xsqlwSAiLf1HXMQk8CONslYbdiEZc9FEIbM=
+cloud.google.com/go/compute v1.23.1 h1:V97tBoDaZHb6leicZ1G6DLK2BAaZLJ/7+9BB/En3hR0=
+cloud.google.com/go/compute v1.23.1/go.mod h1:CqB3xpmPKKt3OJpW2ndFIXnA9A4xAy/F3Xp1ixncW78=
 cloud.google.com/go/compute/metadata v0.2.3 h1:mg4jlk7mCAj6xXp9UJ4fjI9VUI5rubuGBW5aJ7UnBMY=
 cloud.google.com/go/compute/metadata v0.2.3/go.mod h1:VAV5nSsACxMJvgaAuX6Pk2AawlZn8kiOGuCv6gTkwuA=
 github.com/BurntSushi/toml v0.3.1/go.mod h1:xHWCNGjB5oqiDr8zfno3MHue2Ht5sIBksp03qcyfWMU=
@@ -49,8 +52,12 @@ github.com/google/s2a-go v0.1.7/go.mod h1:50CgR4k1jNlWBu4UfS4AcfhVe1r6pdZPygJ3R8
 github.com/google/uuid v1.1.2/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/google/uuid v1.3.1 h1:KjJaJ9iWZ3jOFZIf1Lqf4laDRCasjl0BCmnEGxkdLb4=
 github.com/google/uuid v1.3.1/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
+github.com/google/uuid v1.4.0 h1:MtMxsa51/r9yyhkyLsVeVt0B+BGQZzpQiTQ4eHZ8bc4=
+github.com/google/uuid v1.4.0/go.mod h1:TIyPZe4MgqvfeYDBFedMoGGpEw/LqOeaOT+nhxU+yHo=
 github.com/googleapis/enterprise-certificate-proxy v0.3.1 h1:SBWmZhjUDRorQxrN0nwzf+AHBxnbFjViHQS4P0yVpmQ=
 github.com/googleapis/enterprise-certificate-proxy v0.3.1/go.mod h1:VLSiSSBs/ksPL8kq3OBOQ6WRI2QnaFynd1DCjZ62+V0=
+github.com/googleapis/enterprise-certificate-proxy v0.3.2 h1:Vie5ybvEvT75RniqhfFxPRy3Bf7vr3h0cechB90XaQs=
+github.com/googleapis/enterprise-certificate-proxy v0.3.2/go.mod h1:VLSiSSBs/ksPL8kq3OBOQ6WRI2QnaFynd1DCjZ62+V0=
 github.com/googleapis/gax-go/v2 v2.12.0 h1:A+gCJKdRfqXkr+BIRGtZLibNXf0m1f9E4HG56etFpas=
 github.com/googleapis/gax-go/v2 v2.12.0/go.mod h1:y+aIqrI5eb1YGMVJfuV3185Ts/D7qKpsEkdD5+I6QGU=
 github.com/grpc-ecosystem/grpc-gateway/v2 v2.18.0 h1:RtRsiaGvWxcwd8y3BiRZxsylPT8hLWZ5SPcfI+3IDNk=
@@ -124,6 +131,8 @@ golang.org/x/xerrors v0.0.0-20191204190536-9bdfabe68543/go.mod h1:I/5z698sn9Ka8T
 golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0=
 google.golang.org/api v0.148.0 h1:HBq4TZlN4/1pNcu0geJZ/Q50vIwIXT532UIMYoo0vOs=
 google.golang.org/api v0.148.0/go.mod h1:8/TBgwaKjfqTdacOJrOv2+2Q6fBDU1uHKK06oGSkxzU=
+google.golang.org/api v0.149.0 h1:b2CqT6kG+zqJIVKRQ3ELJVLN1PwHZ6DJ3dW8yl82rgY=
+google.golang.org/api v0.149.0/go.mod h1:Mwn1B7JTXrzXtnvmzQE2BD6bYZQ8DShKZDZbeN9I7qI=
 google.golang.org/appengine v1.1.0/go.mod h1:EbEs0AVv82hx2wNQdGPgUI5lhzA/G0D9YwlJXL52JkM=
 google.golang.org/appengine v1.4.0/go.mod h1:xpcJRLb0r/rnEns0DIKYYv+WjYCduHsrkT7/EB5XEv4=
 google.golang.org/appengine v1.6.7 h1:FZR1q0exgwxzPzp/aF+VccGrSfxfPpkBqjIIEq3ru6c=
@@ -133,10 +142,14 @@ google.golang.org/genproto v0.0.0-20190819201941-24fa4b261c55/go.mod h1:DMBHOl98
 google.golang.org/genproto v0.0.0-20200526211855-cb27e3aa2013/go.mod h1:NbSheEEYHJ7i3ixzK3sjbqSGDJWnxyFXZblF3eUsNvo=
 google.golang.org/genproto v0.0.0-20231012201019-e917dd12ba7a h1:fwgW9j3vHirt4ObdHoYNwuO24BEZjSzbh+zPaNWoiY8=
 google.golang.org/genproto v0.0.0-20231012201019-e917dd12ba7a/go.mod h1:EMfReVxb80Dq1hhioy0sOsY9jCE46YDgHlJ7fWVUWRE=
+google.golang.org/genproto v0.0.0-20231016165738-49dd2c1f3d0b h1:+YaDE2r2OG8t/z5qmsh7Y+XXwCbvadxxZ0YY6mTdrVA=
+google.golang.org/genproto v0.0.0-20231016165738-49dd2c1f3d0b/go.mod h1:CgAqfJo+Xmu0GwA0411Ht3OU3OntXwsGmrmjI8ioGXI=
 google.golang.org/genproto/googleapis/api v0.0.0-20231016165738-49dd2c1f3d0b h1:CIC2YMXmIhYw6evmhPxBKJ4fmLbOFtXQN/GV3XOZR8k=
 google.golang.org/genproto/googleapis/api v0.0.0-20231016165738-49dd2c1f3d0b/go.mod h1:IBQ646DjkDkvUIsVq/cc03FUFQ9wbZu7yE396YcL870=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20231012201019-e917dd12ba7a h1:a2MQQVoTo96JC9PMGtGBymLp7+/RzpFc2yX/9WfFg1c=
 google.golang.org/genproto/googleapis/rpc v0.0.0-20231012201019-e917dd12ba7a/go.mod h1:4cYg8o5yUbm77w8ZX00LhMVNl/YVBFJRYWDc0uYWMs0=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20231016165738-49dd2c1f3d0b h1:ZlWIi1wSK56/8hn4QcBp/j9M7Gt3U/3hZw3mC7vDICo=
+google.golang.org/genproto/googleapis/rpc v0.0.0-20231016165738-49dd2c1f3d0b/go.mod h1:swOH3j0KzcDDgGUWr+SNpyTen5YrXjS3eyPzFYKc6lc=
 google.golang.org/grpc v1.19.0/go.mod h1:mqu4LbDTu4XGKhr4mRzUsmM4RtVoemTSY81AxZiDr8c=
 google.golang.org/grpc v1.23.0/go.mod h1:Y5yQAOtifL1yxbo5wqy6BxZv8vAUGQwXBOALyacEbxg=
 google.golang.org/grpc v1.25.1/go.mod h1:c3i+UQWmh7LiEpx4sFZnkU36qjEYZ0imhYfXVyQciAY=

diff --git a/proto/api/v1/mobile.proto b/proto/api/v1/mobile.proto
@@ -10,8 +10,8 @@ import "google/protobuf/empty.proto";
 
 // Internal service
 service Internal {
-    rpc GetAnimals(AnimalsRequest) returns (AnimalsResponse) {};
-    rpc GetArea(AreaRequest) returns (AreaResponse) {};
+    rpc GetAnimals(AnimalsRequest) returns (stream Animal) {};
+    rpc GetCoast(CoastRequest) returns (CoastResponse) {};
     rpc GetLocation(LocationRequest) returns (LocationResponse) {};
 }
 
@@ -25,7 +25,7 @@ service Bff {
 }
 
 // Location
-message Location {
+message LocationResponse {
     int32 longitude = 1;
     int32 latitude = 2;
     string name = 3;
@@ -35,11 +35,7 @@ message LocationRequest {
     string ip = 1;
 }
 
-message LocationResponse {
-    Location location = 1;
-}
-
-// Area
+// Coast
 enum Condition {
     GOOD = 0;
     MODERATE = 1;
@@ -50,11 +46,11 @@ enum Condition {
     PROTECTED = 6;
 }
 
-message AreaRequest {
-    Location location = 1;
+message CoastRequest {
+    LocationResponse location = 1;
 }
 
-message AreaResponse {
+message CoastResponse {
     string name = 1;
     Condition condition = 2;
     float temperature = 3;
@@ -69,16 +65,12 @@ message Animal {
 }
 
 message AnimalsRequest {
-    Location location = 1;
-}
-
-message AnimalsResponse {
-    repeated Animal animals = 1;
+    LocationResponse location = 1;
 }
 
 // BFF
 message V1Response {
-    Location location = 1;
-    AreaResponse nearest_aquatic_location = 2;
+    LocationResponse location = 1;
+    CoastResponse nearest_aquatic_location = 2;
     repeated Animal animals = 3;
 }