totole/services
1
0
Fork 0
mirror of https://github.com/kevin-DL/services.git synced 2026-01-11 19:04:35 +00:00
Code Issues Packages Projects Releases Wiki Activity

add email validation and parsing endpoints

Browse Source
This commit is contained in:
Asim Aslam
2022-01-26 13:02:14 +00:00
parent fbd509e106
commit ceb6dd4198
5 changed files with 408 additions and 17 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
email/examples.json
View File

@@ -10,5 +10,30 @@
},
"response": {}
}
],
"parse": [
{
"title": "Parse email",
"run_check": false,
"request": {
"address": "Joe Blogs <joe@example.com>"
},
"response": {
"name": "Joe Blogs",
"address": "joe@example.com"
}
}
],
"validate": [
{
"title": "Validate email",
"run_check": false,
"request": {
"address": "joe@example.com"
},
"response": {
"is_valid": true
}
}
]
}

33
email/handler/email.go
View File

@@ -6,6 +6,7 @@ import (
"encoding/json"
"fmt"
"io/ioutil"
"net/mail"
"net/http"
"regexp"
@@ -204,3 +205,35 @@ func (e *Email) sendEmail(ctx context.Context, req *pb.SendRequest) error {
return nil
}
func (e *Email) Parse(ctx context.Context, req *pb.ParseRequest, rsp *pb.ParseResponse) error {
if len(req.Address) == 0 {
return errors.BadRequest("email.validate", "address is blank")
}
a, err := mail.ParseAddress(req.Address)
if err != nil {
return errors.InternalServerError("email.parse", err.Error())
}
rsp.Name = a.Name
rsp.Address = a.Address
return nil
}
func (e *Email) Validate(ctx context.Context, req *pb.ValidateRequest, rsp *pb.ValidateResponse) error {
if len(req.Address) == 0 {
return errors.BadRequest("email.validate", "address is blank")
}
_, err := mail.ParseAddress(req.Address)
if err != nil {
return nil
}
// success
rsp.IsValid = true
return nil
}

310
email/proto/email.pb.go
View File

@@ -1,6 +1,6 @@
// Code generated by protoc-gen-go. DO NOT EDIT.
// versions:
// protoc-gen-go v1.26.0
// protoc-gen-go v1.27.1
// protoc v3.15.6
// source: proto/email.proto
@@ -20,13 +20,13 @@ const (
_ = protoimpl.EnforceVersion(protoimpl.MaxVersion - 20)
)
// Send an email by passing in from, to, subject and a text or html body
// Send an email by passing in from, to, subject, and a text or html body
type SendRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// the name of the sender
// the display name of the sender
From string `protobuf:"bytes,1,opt,name=from,proto3" json:"from,omitempty"`
// the email address of the recipient
To string `protobuf:"bytes,2,opt,name=to,proto3" json:"to,omitempty"`
@@ -152,6 +152,207 @@ func (*SendResponse) Descriptor() ([]byte, []int) {
return file_proto_email_proto_rawDescGZIP(), []int{1}
}
// Parse an RFC5322 address e.g "Joe Blogs <joe@example.com>"
type ParseRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// The address to parse. Can be of the format "Joe Blogs <joe@example.com>" or "joe@example.com"
Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
}
func (x *ParseRequest) Reset() {
*x = ParseRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_proto_email_proto_msgTypes[2]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ParseRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ParseRequest) ProtoMessage() {}
func (x *ParseRequest) ProtoReflect() protoreflect.Message {
mi := &file_proto_email_proto_msgTypes[2]
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 ParseRequest.ProtoReflect.Descriptor instead.
func (*ParseRequest) Descriptor() ([]byte, []int) {
return file_proto_email_proto_rawDescGZIP(), []int{2}
}
func (x *ParseRequest) GetAddress() string {
if x != nil {
return x.Address
}
return ""
}
type ParseResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
// associated name e.g Joe Blogs
Name string `protobuf:"bytes,1,opt,name=name,proto3" json:"name,omitempty"`
// the email address
Address string `protobuf:"bytes,2,opt,name=address,proto3" json:"address,omitempty"`
}
func (x *ParseResponse) Reset() {
*x = ParseResponse{}
if protoimpl.UnsafeEnabled {
mi := &file_proto_email_proto_msgTypes[3]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ParseResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ParseResponse) ProtoMessage() {}
func (x *ParseResponse) ProtoReflect() protoreflect.Message {
mi := &file_proto_email_proto_msgTypes[3]
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 ParseResponse.ProtoReflect.Descriptor instead.
func (*ParseResponse) Descriptor() ([]byte, []int) {
return file_proto_email_proto_rawDescGZIP(), []int{3}
}
func (x *ParseResponse) GetName() string {
if x != nil {
return x.Name
}
return ""
}
func (x *ParseResponse) GetAddress() string {
if x != nil {
return x.Address
}
return ""
}
// Validate an email address format
type ValidateRequest struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
Address string `protobuf:"bytes,1,opt,name=address,proto3" json:"address,omitempty"`
}
func (x *ValidateRequest) Reset() {
*x = ValidateRequest{}
if protoimpl.UnsafeEnabled {
mi := &file_proto_email_proto_msgTypes[4]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ValidateRequest) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ValidateRequest) ProtoMessage() {}
func (x *ValidateRequest) ProtoReflect() protoreflect.Message {
mi := &file_proto_email_proto_msgTypes[4]
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 ValidateRequest.ProtoReflect.Descriptor instead.
func (*ValidateRequest) Descriptor() ([]byte, []int) {
return file_proto_email_proto_rawDescGZIP(), []int{4}
}
func (x *ValidateRequest) GetAddress() string {
if x != nil {
return x.Address
}
return ""
}
type ValidateResponse struct {
state protoimpl.MessageState
sizeCache protoimpl.SizeCache
unknownFields protoimpl.UnknownFields
IsValid bool `protobuf:"varint,1,opt,name=is_valid,json=isValid,proto3" json:"is_valid,omitempty"`
}
func (x *ValidateResponse) Reset() {
*x = ValidateResponse{}
if protoimpl.UnsafeEnabled {
mi := &file_proto_email_proto_msgTypes[5]
ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x))
ms.StoreMessageInfo(mi)
}
}
func (x *ValidateResponse) String() string {
return protoimpl.X.MessageStringOf(x)
}
func (*ValidateResponse) ProtoMessage() {}
func (x *ValidateResponse) ProtoReflect() protoreflect.Message {
mi := &file_proto_email_proto_msgTypes[5]
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 ValidateResponse.ProtoReflect.Descriptor instead.
func (*ValidateResponse) Descriptor() ([]byte, []int) {
return file_proto_email_proto_rawDescGZIP(), []int{5}
}
func (x *ValidateResponse) GetIsValid() bool {
if x != nil {
return x.IsValid
}
return false
}
var File_proto_email_proto protoreflect.FileDescriptor
var file_proto_email_proto_rawDesc = []byte{
@@ -167,13 +368,32 @@ var file_proto_email_proto_rawDesc = []byte{
0x18, 0x05, 0x20, 0x01, 0x28, 0x09, 0x52, 0x08, 0x74, 0x65, 0x78, 0x74, 0x42, 0x6f, 0x64, 0x79,
0x12, 0x1b, 0x0a, 0x09, 0x68, 0x74, 0x6d, 0x6c, 0x5f, 0x62, 0x6f, 0x64, 0x79, 0x18, 0x06, 0x20,
0x01, 0x28, 0x09, 0x52, 0x08, 0x68, 0x74, 0x6d, 0x6c, 0x42, 0x6f, 0x64, 0x79, 0x22, 0x0e, 0x0a,
0x0c, 0x53, 0x65, 0x6e, 0x64, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x32, 0x3a, 0x0a,
0x05, 0x45, 0x6d, 0x61, 0x69, 0x6c, 0x12, 0x31, 0x0a, 0x04, 0x53, 0x65, 0x6e, 0x64, 0x12, 0x12,
0x2e, 0x65, 0x6d, 0x61, 0x69, 0x6c, 0x2e, 0x53, 0x65, 0x6e, 0x64, 0x52, 0x65, 0x71, 0x75, 0x65,
0x73, 0x74, 0x1a, 0x13, 0x2e, 0x65, 0x6d, 0x61, 0x69, 0x6c, 0x2e, 0x53, 0x65, 0x6e, 0x64, 0x52,
0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x00, 0x42, 0x0f, 0x5a, 0x0d, 0x2e, 0x2f, 0x70,
0x72, 0x6f, 0x74, 0x6f, 0x3b, 0x65, 0x6d, 0x61, 0x69, 0x6c, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74,
0x6f, 0x33,
0x0c, 0x53, 0x65, 0x6e, 0x64, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x28, 0x0a,
0x0c, 0x50, 0x61, 0x72, 0x73, 0x65, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x18, 0x0a,
0x07, 0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07,
0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x22, 0x3d, 0x0a, 0x0d, 0x50, 0x61, 0x72, 0x73, 0x65,
0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x12, 0x0a, 0x04, 0x6e, 0x61, 0x6d, 0x65,
0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x04, 0x6e, 0x61, 0x6d, 0x65, 0x12, 0x18, 0x0a, 0x07,
0x61, 0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07, 0x61,
0x64, 0x64, 0x72, 0x65, 0x73, 0x73, 0x22, 0x2b, 0x0a, 0x0f, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61,
0x74, 0x65, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x18, 0x0a, 0x07, 0x61, 0x64, 0x64,
0x72, 0x65, 0x73, 0x73, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x07, 0x61, 0x64, 0x64, 0x72,
0x65, 0x73, 0x73, 0x22, 0x2d, 0x0a, 0x10, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52,
0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x12, 0x19, 0x0a, 0x08, 0x69, 0x73, 0x5f, 0x76, 0x61,
0x6c, 0x69, 0x64, 0x18, 0x01, 0x20, 0x01, 0x28, 0x08, 0x52, 0x07, 0x69, 0x73, 0x56, 0x61, 0x6c,
0x69, 0x64, 0x32, 0xaf, 0x01, 0x0a, 0x05, 0x45, 0x6d, 0x61, 0x69, 0x6c, 0x12, 0x31, 0x0a, 0x04,
0x53, 0x65, 0x6e, 0x64, 0x12, 0x12, 0x2e, 0x65, 0x6d, 0x61, 0x69, 0x6c, 0x2e, 0x53, 0x65, 0x6e,
0x64, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x13, 0x2e, 0x65, 0x6d, 0x61, 0x69, 0x6c,
0x2e, 0x53, 0x65, 0x6e, 0x64, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e, 0x73, 0x65, 0x22, 0x00, 0x12,
0x34, 0x0a, 0x05, 0x50, 0x61, 0x72, 0x73, 0x65, 0x12, 0x13, 0x2e, 0x65, 0x6d, 0x61, 0x69, 0x6c,
0x2e, 0x50, 0x61, 0x72, 0x73, 0x65, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x14, 0x2e,
0x65, 0x6d, 0x61, 0x69, 0x6c, 0x2e, 0x50, 0x61, 0x72, 0x73, 0x65, 0x52, 0x65, 0x73, 0x70, 0x6f,
0x6e, 0x73, 0x65, 0x22, 0x00, 0x12, 0x3d, 0x0a, 0x08, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74,
0x65, 0x12, 0x16, 0x2e, 0x65, 0x6d, 0x61, 0x69, 0x6c, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61,
0x74, 0x65, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x17, 0x2e, 0x65, 0x6d, 0x61, 0x69,
0x6c, 0x2e, 0x56, 0x61, 0x6c, 0x69, 0x64, 0x61, 0x74, 0x65, 0x52, 0x65, 0x73, 0x70, 0x6f, 0x6e,
0x73, 0x65, 0x22, 0x00, 0x42, 0x0f, 0x5a, 0x0d, 0x2e, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x3b,
0x65, 0x6d, 0x61, 0x69, 0x6c, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33,
}
var (
@@ -188,16 +408,24 @@ func file_proto_email_proto_rawDescGZIP() []byte {
return file_proto_email_proto_rawDescData
}
var file_proto_email_proto_msgTypes = make([]protoimpl.MessageInfo, 2)
var file_proto_email_proto_msgTypes = make([]protoimpl.MessageInfo, 6)
var file_proto_email_proto_goTypes = []interface{}{
(*SendRequest)(nil), // 0: email.SendRequest
(*SendResponse)(nil), // 1: email.SendResponse
(*SendRequest)(nil), // 0: email.SendRequest
(*SendResponse)(nil), // 1: email.SendResponse
(*ParseRequest)(nil), // 2: email.ParseRequest
(*ParseResponse)(nil), // 3: email.ParseResponse
(*ValidateRequest)(nil), // 4: email.ValidateRequest
(*ValidateResponse)(nil), // 5: email.ValidateResponse
}
var file_proto_email_proto_depIdxs = []int32{
0, // 0: email.Email.Send:input_type -> email.SendRequest
1, // 1: email.Email.Send:output_type -> email.SendResponse
1, // [1:2] is the sub-list for method output_type
0, // [0:1] is the sub-list for method input_type
2, // 1: email.Email.Parse:input_type -> email.ParseRequest
4, // 2: email.Email.Validate:input_type -> email.ValidateRequest
1, // 3: email.Email.Send:output_type -> email.SendResponse
3, // 4: email.Email.Parse:output_type -> email.ParseResponse
5, // 5: email.Email.Validate:output_type -> email.ValidateResponse
3, // [3:6] is the sub-list for method output_type
0, // [0:3] 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
@@ -233,6 +461,54 @@ func file_proto_email_proto_init() {
return nil
}
}
file_proto_email_proto_msgTypes[2].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*ParseRequest); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
file_proto_email_proto_msgTypes[3].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*ParseResponse); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
file_proto_email_proto_msgTypes[4].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*ValidateRequest); i {
case 0:
return &v.state
case 1:
return &v.sizeCache
case 2:
return &v.unknownFields
default:
return nil
}
}
file_proto_email_proto_msgTypes[5].Exporter = func(v interface{}, i int) interface{} {
switch v := v.(*ValidateResponse); 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{
@@ -240,7 +516,7 @@ func file_proto_email_proto_init() {
GoPackagePath: reflect.TypeOf(x{}).PkgPath(),
RawDescriptor: file_proto_email_proto_rawDesc,
NumEnums: 0,
NumMessages: 2,
NumMessages: 6,
NumExtensions: 0,
NumServices: 1,
},

34
email/proto/email.pb.micro.go
View File

@@ -43,6 +43,8 @@ func NewEmailEndpoints() []*api.Endpoint {
type EmailService interface {
Send(ctx context.Context, in *SendRequest, opts ...client.CallOption) (*SendResponse, error)
Parse(ctx context.Context, in *ParseRequest, opts ...client.CallOption) (*ParseResponse, error)
Validate(ctx context.Context, in *ValidateRequest, opts ...client.CallOption) (*ValidateResponse, error)
}
type emailService struct {
@@ -67,15 +69,39 @@ func (c *emailService) Send(ctx context.Context, in *SendRequest, opts ...client
return out, nil
}
func (c *emailService) Parse(ctx context.Context, in *ParseRequest, opts ...client.CallOption) (*ParseResponse, error) {
req := c.c.NewRequest(c.name, "Email.Parse", in)
out := new(ParseResponse)
err := c.c.Call(ctx, req, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
func (c *emailService) Validate(ctx context.Context, in *ValidateRequest, opts ...client.CallOption) (*ValidateResponse, error) {
req := c.c.NewRequest(c.name, "Email.Validate", in)
out := new(ValidateResponse)
err := c.c.Call(ctx, req, out, opts...)
if err != nil {
return nil, err
}
return out, nil
}
// Server API for Email service
type EmailHandler interface {
Send(context.Context, *SendRequest, *SendResponse) error
Parse(context.Context, *ParseRequest, *ParseResponse) error
Validate(context.Context, *ValidateRequest, *ValidateResponse) error
}
func RegisterEmailHandler(s server.Server, hdlr EmailHandler, opts ...server.HandlerOption) error {
type email interface {
Send(ctx context.Context, in *SendRequest, out *SendResponse) error
Parse(ctx context.Context, in *ParseRequest, out *ParseResponse) error
Validate(ctx context.Context, in *ValidateRequest, out *ValidateResponse) error
}
type Email struct {
email
@@ -91,3 +117,11 @@ type emailHandler struct {
func (h *emailHandler) Send(ctx context.Context, in *SendRequest, out *SendResponse) error {
return h.EmailHandler.Send(ctx, in, out)
}
func (h *emailHandler) Parse(ctx context.Context, in *ParseRequest, out *ParseResponse) error {
return h.EmailHandler.Parse(ctx, in, out)
}
func (h *emailHandler) Validate(ctx context.Context, in *ValidateRequest, out *ValidateResponse) error {
return h.EmailHandler.Validate(ctx, in, out)
}

23
email/proto/email.proto
View File

@@ -6,6 +6,8 @@ option go_package = "./proto;email";
service Email {
rpc Send(SendRequest) returns (SendResponse) {}
rpc Parse(ParseRequest) returns (ParseResponse) {}
rpc Validate(ValidateRequest) returns (ValidateResponse) {}
}
// Send an email by passing in from, to, subject, and a text or html body
@@ -27,3 +29,24 @@ message SendRequest {
message SendResponse {
}
// Parse an RFC5322 address e.g "Joe Blogs <joe@example.com>"
message ParseRequest {
// The address to parse. Can be of the format "Joe Blogs <joe@example.com>" or "joe@example.com"
string address = 1;
}
message ParseResponse {
// associated name e.g Joe Blogs
string name = 1;
// the email address
string address = 2;
}
// Validate an email address format
message ValidateRequest {
string address = 1;
}
message ValidateResponse {
bool is_valid = 1;
}