diff --git a/postcode/.gitignore b/postcode/.gitignore new file mode 100644 index 0000000..65ef280 --- /dev/null +++ b/postcode/.gitignore @@ -0,0 +1,2 @@ + +postcode diff --git a/postcode/Dockerfile b/postcode/Dockerfile new file mode 100644 index 0000000..5836022 --- /dev/null +++ b/postcode/Dockerfile @@ -0,0 +1,3 @@ +FROM alpine +ADD postcode /postcode +ENTRYPOINT [ "/postcode" ] diff --git a/postcode/Makefile b/postcode/Makefile new file mode 100644 index 0000000..a20a34b --- /dev/null +++ b/postcode/Makefile @@ -0,0 +1,28 @@ + +GOPATH:=$(shell go env GOPATH) +.PHONY: init +init: + go get -u github.com/golang/protobuf/proto + go get -u github.com/golang/protobuf/protoc-gen-go + go get github.com/micro/micro/v3/cmd/protoc-gen-micro + go get github.com/micro/micro/v3/cmd/protoc-gen-openapi + +.PHONY: api +api: + protoc --openapi_out=. --proto_path=. proto/postcode.proto + +.PHONY: proto +proto: + protoc --proto_path=. --micro_out=. --go_out=:. proto/postcode.proto + +.PHONY: build +build: + go build -o postcode *.go + +.PHONY: test +test: + go test -v ./... -cover + +.PHONY: docker +docker: + docker build . -t postcode:latest diff --git a/postcode/README.md b/postcode/README.md new file mode 100644 index 0000000..d5e1039 --- /dev/null +++ b/postcode/README.md @@ -0,0 +1,5 @@ +Instant and fast postcode lookup + +# Postcode Service + +Lookup postcodes for their related country, region and additional information. diff --git a/postcode/generate.go b/postcode/generate.go new file mode 100644 index 0000000..7d9db91 --- /dev/null +++ b/postcode/generate.go @@ -0,0 +1,3 @@ +package main + +//go:generate make proto diff --git a/postcode/handler/postcode.go b/postcode/handler/postcode.go new file mode 100644 index 0000000..5e745aa --- /dev/null +++ b/postcode/handler/postcode.go @@ -0,0 +1,54 @@ +package handler + +import ( + "context" + "encoding/json" + "io/ioutil" + "net/http" + + "github.com/micro/micro/v3/service/errors" + "github.com/micro/micro/v3/service/logger" + pb "github.com/micro/services/postcode/proto" +) + +var ( + PostcodeAPI = "https://api.postcodes.io/postcodes/" +) + +type Postcode struct{} + +func (e *Postcode) Lookup(ctx context.Context, req *pb.LookupRequest, rsp *pb.LookupResponse) error { + if len(req.Postcode) == 0 { + return errors.BadRequest("postcode.lookup", "missing postcode") + } + + resp, err := http.Get(PostcodeAPI + req.Postcode) + if err != nil { + logger.Errorf("Failed to http call %v: %v", PostcodeAPI+req.Postcode, err.Error()) + return errors.BadRequest("postcode.lookup", "failed to lookup postcode") + } + defer resp.Body.Close() + + b, _ := ioutil.ReadAll(resp.Body) + + if resp.StatusCode != 200 { + logger.Errorf("Failed to http call (%v) %v: %v", resp.StatusCode, PostcodeAPI+req.Postcode, string(b)) + return errors.BadRequest("postcode.lookup", "failed to lookup postcode") + } + + var response map[string]interface{} + if err := json.Unmarshal(b, &response); err != nil { + logger.Error("Failed to unmarshal %v: %v", PostcodeAPI+req.Postcode, err.Error()) + return errors.BadRequest("postcode.lookup", "failed to lookup postcode") + } + result := response["result"].(map[string]interface{}) + + rsp.Postcode = result["postcode"].(string) + rsp.Country = result["country"].(string) + rsp.Region = result["region"].(string) + rsp.Latitude = result["latitude"].(float64) + rsp.Longitude = result["longitude"].(float64) + rsp.District = result["admin_district"].(string) + rsp.Ward = result["admin_ward"].(string) + return nil +} diff --git a/postcode/main.go b/postcode/main.go new file mode 100644 index 0000000..db07cc4 --- /dev/null +++ b/postcode/main.go @@ -0,0 +1,24 @@ +package main + +import ( + "github.com/micro/micro/v3/service" + "github.com/micro/micro/v3/service/logger" + "github.com/micro/services/postcode/handler" + pb "github.com/micro/services/postcode/proto" +) + +func main() { + // Create service + srv := service.New( + service.Name("postcode"), + service.Version("latest"), + ) + + // Register handler + pb.RegisterPostcodeHandler(srv.Server(), new(handler.Postcode)) + + // Run service + if err := srv.Run(); err != nil { + logger.Fatal(err) + } +} diff --git a/postcode/micro.mu b/postcode/micro.mu new file mode 100644 index 0000000..e3529aa --- /dev/null +++ b/postcode/micro.mu @@ -0,0 +1 @@ +service postcode diff --git a/postcode/proto/postcode.pb.go b/postcode/proto/postcode.pb.go new file mode 100644 index 0000000..01e61c2 --- /dev/null +++ b/postcode/proto/postcode.pb.go @@ -0,0 +1,271 @@ +// Code generated by protoc-gen-go. DO NOT EDIT. +// versions: +// protoc-gen-go v1.26.0 +// protoc v3.15.6 +// source: proto/postcode.proto + +package postcode + +import ( + protoreflect "google.golang.org/protobuf/reflect/protoreflect" + protoimpl "google.golang.org/protobuf/runtime/protoimpl" + reflect "reflect" + sync "sync" +) + +const ( + // Verify that this generated code is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(20 - protoimpl.MinVersion) + // Verify that runtime/protoimpl is sufficiently up-to-date. + _ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20) +) + +// Lookup a postcode to retrieve the related region, county, etc +type LookupRequest struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Postcode string `protobuf:"bytes,1,opt,name=postcode,proto3" json:"postcode,omitempty"` +} + +func (x *LookupRequest) Reset() { + *x = LookupRequest{} + if protoimpl.UnsafeEnabled { + mi := &file_proto_postcode_proto_msgTypes[0] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *LookupRequest) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*LookupRequest) ProtoMessage() {} + +func (x *LookupRequest) ProtoReflect() protoreflect.Message { + mi := &file_proto_postcode_proto_msgTypes[0] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use LookupRequest.ProtoReflect.Descriptor instead. +func (*LookupRequest) Descriptor() ([]byte, []int) { + return file_proto_postcode_proto_rawDescGZIP(), []int{0} +} + +func (x *LookupRequest) GetPostcode() string { + if x != nil { + return x.Postcode + } + return "" +} + +type LookupResponse struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + Postcode string `protobuf:"bytes,1,opt,name=postcode,proto3" json:"postcode,omitempty"` + Country string `protobuf:"bytes,2,opt,name=country,proto3" json:"country,omitempty"` + Region string `protobuf:"bytes,3,opt,name=region,proto3" json:"region,omitempty"` + District string `protobuf:"bytes,4,opt,name=district,proto3" json:"district,omitempty"` + Ward string `protobuf:"bytes,5,opt,name=ward,proto3" json:"ward,omitempty"` + Latitude float64 `protobuf:"fixed64,6,opt,name=latitude,proto3" json:"latitude,omitempty"` + Longitude float64 `protobuf:"fixed64,7,opt,name=longitude,proto3" json:"longitude,omitempty"` +} + +func (x *LookupResponse) Reset() { + *x = LookupResponse{} + if protoimpl.UnsafeEnabled { + mi := &file_proto_postcode_proto_msgTypes[1] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *LookupResponse) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*LookupResponse) ProtoMessage() {} + +func (x *LookupResponse) ProtoReflect() protoreflect.Message { + mi := &file_proto_postcode_proto_msgTypes[1] + if protoimpl.UnsafeEnabled && x != nil { + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + if ms.LoadMessageInfo() == nil { + ms.StoreMessageInfo(mi) + } + return ms + } + return mi.MessageOf(x) +} + +// Deprecated: Use LookupResponse.ProtoReflect.Descriptor instead. +func (*LookupResponse) Descriptor() ([]byte, []int) { + return file_proto_postcode_proto_rawDescGZIP(), []int{1} +} + +func (x *LookupResponse) GetPostcode() string { + if x != nil { + return x.Postcode + } + return "" +} + +func (x *LookupResponse) GetCountry() string { + if x != nil { + return x.Country + } + return "" +} + +func (x *LookupResponse) GetRegion() string { + if x != nil { + return x.Region + } + return "" +} + +func (x *LookupResponse) GetDistrict() string { + if x != nil { + return x.District + } + return "" +} + +func (x *LookupResponse) GetWard() string { + if x != nil { + return x.Ward + } + return "" +} + +func (x *LookupResponse) GetLatitude() float64 { + if x != nil { + return x.Latitude + } + return 0 +} + +func (x *LookupResponse) GetLongitude() float64 { + if x != nil { + return x.Longitude + } + return 0 +} + +var File_proto_postcode_proto protoreflect.FileDescriptor + +var file_proto_postcode_proto_rawDesc = []byte{ + 0x0a, 0x14, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, + 0x2e, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x12, 0x08, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, + 0x22, 0x2b, 0x0a, 0x0d, 0x4c, 0x6f, 0x6f, 0x6b, 0x75, 0x70, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, + 0x74, 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x08, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, 0x22, 0xc8, 0x01, + 0x0a, 0x0e, 0x4c, 0x6f, 0x6f, 0x6b, 0x75, 0x70, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, + 0x12, 0x1a, 0x0a, 0x08, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, 0x18, 0x01, 0x20, 0x01, + 0x28, 0x09, 0x52, 0x08, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, 0x12, 0x18, 0x0a, 0x07, + 0x63, 0x6f, 0x75, 0x6e, 0x74, 0x72, 0x79, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07, 0x63, + 0x6f, 0x75, 0x6e, 0x74, 0x72, 0x79, 0x12, 0x16, 0x0a, 0x06, 0x72, 0x65, 0x67, 0x69, 0x6f, 0x6e, + 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x06, 0x72, 0x65, 0x67, 0x69, 0x6f, 0x6e, 0x12, 0x1a, + 0x0a, 0x08, 0x64, 0x69, 0x73, 0x74, 0x72, 0x69, 0x63, 0x74, 0x18, 0x04, 0x20, 0x01, 0x28, 0x09, + 0x52, 0x08, 0x64, 0x69, 0x73, 0x74, 0x72, 0x69, 0x63, 0x74, 0x12, 0x12, 0x0a, 0x04, 0x77, 0x61, + 0x72, 0x64, 0x18, 0x05, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x77, 0x61, 0x72, 0x64, 0x12, 0x1a, + 0x0a, 0x08, 0x6c, 0x61, 0x74, 0x69, 0x74, 0x75, 0x64, 0x65, 0x18, 0x06, 0x20, 0x01, 0x28, 0x01, + 0x52, 0x08, 0x6c, 0x61, 0x74, 0x69, 0x74, 0x75, 0x64, 0x65, 0x12, 0x1c, 0x0a, 0x09, 0x6c, 0x6f, + 0x6e, 0x67, 0x69, 0x74, 0x75, 0x64, 0x65, 0x18, 0x07, 0x20, 0x01, 0x28, 0x01, 0x52, 0x09, 0x6c, + 0x6f, 0x6e, 0x67, 0x69, 0x74, 0x75, 0x64, 0x65, 0x32, 0x49, 0x0a, 0x08, 0x50, 0x6f, 0x73, 0x74, + 0x63, 0x6f, 0x64, 0x65, 0x12, 0x3d, 0x0a, 0x06, 0x4c, 0x6f, 0x6f, 0x6b, 0x75, 0x70, 0x12, 0x17, + 0x2e, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, 0x2e, 0x4c, 0x6f, 0x6f, 0x6b, 0x75, 0x70, + 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x18, 0x2e, 0x70, 0x6f, 0x73, 0x74, 0x63, 0x6f, + 0x64, 0x65, 0x2e, 0x4c, 0x6f, 0x6f, 0x6b, 0x75, 0x70, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, + 0x65, 0x22, 0x00, 0x42, 0x12, 0x5a, 0x10, 0x2e, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x3b, 0x70, + 0x6f, 0x73, 0x74, 0x63, 0x6f, 0x64, 0x65, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, +} + +var ( + file_proto_postcode_proto_rawDescOnce sync.Once + file_proto_postcode_proto_rawDescData = file_proto_postcode_proto_rawDesc +) + +func file_proto_postcode_proto_rawDescGZIP() []byte { + file_proto_postcode_proto_rawDescOnce.Do(func() { + file_proto_postcode_proto_rawDescData = protoimpl.X.CompressGZIP(file_proto_postcode_proto_rawDescData) + }) + return file_proto_postcode_proto_rawDescData +} + +var file_proto_postcode_proto_msgTypes = make([]protoimpl.MessageInfo, 2) +var file_proto_postcode_proto_goTypes = []interface{}{ + (*LookupRequest)(nil), // 0: postcode.LookupRequest + (*LookupResponse)(nil), // 1: postcode.LookupResponse +} +var file_proto_postcode_proto_depIdxs = []int32{ + 0, // 0: postcode.Postcode.Lookup:input_type -> postcode.LookupRequest + 1, // 1: postcode.Postcode.Lookup:output_type -> postcode.LookupResponse + 1, // [1:2] is the sub-list for method output_type + 0, // [0:1] is the sub-list for method input_type + 0, // [0:0] is the sub-list for extension type_name + 0, // [0:0] is the sub-list for extension extendee + 0, // [0:0] is the sub-list for field type_name +} + +func init() { file_proto_postcode_proto_init() } +func file_proto_postcode_proto_init() { + if File_proto_postcode_proto != nil { + return + } + if !protoimpl.UnsafeEnabled { + file_proto_postcode_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*LookupRequest); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_proto_postcode_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*LookupResponse); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + } + type x struct{} + out := protoimpl.TypeBuilder{ + File: protoimpl.DescBuilder{ + GoPackagePath: reflect.TypeOf(x{}).PkgPath(), + RawDescriptor: file_proto_postcode_proto_rawDesc, + NumEnums: 0, + NumMessages: 2, + NumExtensions: 0, + NumServices: 1, + }, + GoTypes: file_proto_postcode_proto_goTypes, + DependencyIndexes: file_proto_postcode_proto_depIdxs, + MessageInfos: file_proto_postcode_proto_msgTypes, + }.Build() + File_proto_postcode_proto = out.File + file_proto_postcode_proto_rawDesc = nil + file_proto_postcode_proto_goTypes = nil + file_proto_postcode_proto_depIdxs = nil +} diff --git a/postcode/proto/postcode.pb.micro.go b/postcode/proto/postcode.pb.micro.go new file mode 100644 index 0000000..85dde34 --- /dev/null +++ b/postcode/proto/postcode.pb.micro.go @@ -0,0 +1,93 @@ +// Code generated by protoc-gen-micro. DO NOT EDIT. +// source: proto/postcode.proto + +package postcode + +import ( + fmt "fmt" + proto "github.com/golang/protobuf/proto" + math "math" +) + +import ( + context "context" + api "github.com/micro/micro/v3/service/api" + client "github.com/micro/micro/v3/service/client" + server "github.com/micro/micro/v3/service/server" +) + +// Reference imports to suppress errors if they are not otherwise used. +var _ = proto.Marshal +var _ = fmt.Errorf +var _ = math.Inf + +// This is a compile-time assertion to ensure that this generated file +// is compatible with the proto package it is being compiled against. +// A compilation error at this line likely means your copy of the +// proto package needs to be updated. +const _ = proto.ProtoPackageIsVersion3 // please upgrade the proto package + +// Reference imports to suppress errors if they are not otherwise used. +var _ api.Endpoint +var _ context.Context +var _ client.Option +var _ server.Option + +// Api Endpoints for Postcode service + +func NewPostcodeEndpoints() []*api.Endpoint { + return []*api.Endpoint{} +} + +// Client API for Postcode service + +type PostcodeService interface { + Lookup(ctx context.Context, in *LookupRequest, opts ...client.CallOption) (*LookupResponse, error) +} + +type postcodeService struct { + c client.Client + name string +} + +func NewPostcodeService(name string, c client.Client) PostcodeService { + return &postcodeService{ + c: c, + name: name, + } +} + +func (c *postcodeService) Lookup(ctx context.Context, in *LookupRequest, opts ...client.CallOption) (*LookupResponse, error) { + req := c.c.NewRequest(c.name, "Postcode.Lookup", in) + out := new(LookupResponse) + err := c.c.Call(ctx, req, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +// Server API for Postcode service + +type PostcodeHandler interface { + Lookup(context.Context, *LookupRequest, *LookupResponse) error +} + +func RegisterPostcodeHandler(s server.Server, hdlr PostcodeHandler, opts ...server.HandlerOption) error { + type postcode interface { + Lookup(ctx context.Context, in *LookupRequest, out *LookupResponse) error + } + type Postcode struct { + postcode + } + h := &postcodeHandler{hdlr} + return s.Handle(s.NewHandler(&Postcode{h}, opts...)) +} + +type postcodeHandler struct { + PostcodeHandler +} + +func (h *postcodeHandler) Lookup(ctx context.Context, in *LookupRequest, out *LookupResponse) error { + return h.PostcodeHandler.Lookup(ctx, in, out) +} diff --git a/postcode/proto/postcode.proto b/postcode/proto/postcode.proto new file mode 100644 index 0000000..a0df3cf --- /dev/null +++ b/postcode/proto/postcode.proto @@ -0,0 +1,24 @@ +syntax = "proto3"; + +package postcode; + +option go_package = "./proto;postcode"; + +service Postcode { + rpc Lookup(LookupRequest) returns (LookupResponse) {} +} + +// Lookup a postcode to retrieve the related region, county, etc +message LookupRequest { + string postcode = 1; +} + +message LookupResponse { + string postcode = 1; + string country = 2; + string region = 3; + string district = 4; + string ward = 5; + double latitude = 6; + double longitude = 7; +} diff --git a/postcode/publicapi.json b/postcode/publicapi.json new file mode 100644 index 0000000..b3b8baa --- /dev/null +++ b/postcode/publicapi.json @@ -0,0 +1,5 @@ +{ + "name": "postcode", + "icon": "📮", + "category": "logistics" +}