From b13647fb75554af9222e7b040e70e414ae6aafc6 Mon Sep 17 00:00:00 2001 From: Asim Aslam Date: Wed, 30 Jun 2021 14:58:37 +0100 Subject: [PATCH] add ask question service --- ask/.gitignore | 2 + ask/Dockerfile | 3 + ask/Makefile | 28 +++++ ask/README.md | 7 ++ ask/generate.go | 3 + ask/handler/ask.go | 47 ++++++++ ask/main.go | 24 ++++ ask/micro.mu | 1 + ask/proto/ask.pb.go | 234 ++++++++++++++++++++++++++++++++++++++ ask/proto/ask.pb.micro.go | 93 +++++++++++++++ ask/proto/ask.proto | 24 ++++ ask/publicapi.json | 5 + go.mod | 1 + go.sum | 2 + 14 files changed, 474 insertions(+) create mode 100644 ask/.gitignore create mode 100644 ask/Dockerfile create mode 100644 ask/Makefile create mode 100644 ask/README.md create mode 100644 ask/generate.go create mode 100644 ask/handler/ask.go create mode 100644 ask/main.go create mode 100644 ask/micro.mu create mode 100644 ask/proto/ask.pb.go create mode 100644 ask/proto/ask.pb.micro.go create mode 100644 ask/proto/ask.proto create mode 100644 ask/publicapi.json diff --git a/ask/.gitignore b/ask/.gitignore new file mode 100644 index 0000000..5daeb4a --- /dev/null +++ b/ask/.gitignore @@ -0,0 +1,2 @@ + +ask diff --git a/ask/Dockerfile b/ask/Dockerfile new file mode 100644 index 0000000..1a201a9 --- /dev/null +++ b/ask/Dockerfile @@ -0,0 +1,3 @@ +FROM alpine +ADD ask /ask +ENTRYPOINT [ "/ask" ] diff --git a/ask/Makefile b/ask/Makefile new file mode 100644 index 0000000..f9ca6aa --- /dev/null +++ b/ask/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/ask.proto + +.PHONY: proto +proto: + protoc --proto_path=. --micro_out=. --go_out=:. proto/ask.proto + +.PHONY: build +build: + go build -o ask *.go + +.PHONY: test +test: + go test -v ./... -cover + +.PHONY: docker +docker: + docker build . -t ask:latest diff --git a/ask/README.md b/ask/README.md new file mode 100644 index 0000000..f340252 --- /dev/null +++ b/ask/README.md @@ -0,0 +1,7 @@ +Instant answers to any question + +# Ask Service + +Ask a question and get an instant answer. + +Powered by [DuckDuckGo](https://duckduckgo.com) diff --git a/ask/generate.go b/ask/generate.go new file mode 100644 index 0000000..7d9db91 --- /dev/null +++ b/ask/generate.go @@ -0,0 +1,3 @@ +package main + +//go:generate make proto diff --git a/ask/handler/ask.go b/ask/handler/ask.go new file mode 100644 index 0000000..79cd4fb --- /dev/null +++ b/ask/handler/ask.go @@ -0,0 +1,47 @@ +package handler + +import ( + "context" + + "github.com/ajanicij/goduckgo/goduckgo" + "github.com/micro/micro/v3/service/errors" + pb "github.com/micro/services/ask/proto" +) + +type Ask struct{} + +func (a *Ask) Question(ctx context.Context, req *pb.QuestionRequest, rsp *pb.QuestionResponse) error { + if len(req.Query) == 0 { + return errors.BadRequest("ask.question", "need a question") + } + + msg, err := goduckgo.Query(req.Query) + if err != nil { + return errors.InternalServerError("ask.question", err.Error()) + } + + if len(msg.Abstract) > 0 { + rsp.Answer = msg.Abstract + } else if len(msg.AbstractText) > 0 { + rsp.Answer = msg.AbstractText + } else if len(msg.RelatedTopics) > 0 { + rsp.Answer = msg.RelatedTopics[0].Text + } else { + rsp.Answer = "Sorry I don't know 😞" + return nil + } + + if len(msg.AbstractURL) > 0 { + rsp.Url = msg.AbstractURL + } else if len(msg.RelatedTopics) > 0 { + rsp.Url = msg.RelatedTopics[0].FirstURL + } + + if len(msg.Image) > 0 { + rsp.Image = "https://duckduckgo.com" + msg.Image + } else if len(msg.RelatedTopics) > 0 { + rsp.Image = "https://duckduckgo.com" + msg.RelatedTopics[0].Icon.URL + } + + return nil +} diff --git a/ask/main.go b/ask/main.go new file mode 100644 index 0000000..c2aa91e --- /dev/null +++ b/ask/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/ask/handler" + pb "github.com/micro/services/ask/proto" +) + +func main() { + // Create service + srv := service.New( + service.Name("ask"), + service.Version("latest"), + ) + + // Register handler + pb.RegisterAskHandler(srv.Server(), new(handler.Ask)) + + // Run service + if err := srv.Run(); err != nil { + logger.Fatal(err) + } +} diff --git a/ask/micro.mu b/ask/micro.mu new file mode 100644 index 0000000..1ad94e9 --- /dev/null +++ b/ask/micro.mu @@ -0,0 +1 @@ +service ask diff --git a/ask/proto/ask.pb.go b/ask/proto/ask.pb.go new file mode 100644 index 0000000..1792b4e --- /dev/null +++ b/ask/proto/ask.pb.go @@ -0,0 +1,234 @@ +// Code generated by protoc-gen-go. DO NOT EDIT. +// versions: +// protoc-gen-go v1.26.0 +// protoc v3.15.6 +// source: proto/ask.proto + +package ask + +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) +) + +// Ask a question and receive an instant answer +type QuestionRequest struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + // the question to ask + Query string `protobuf:"bytes,1,opt,name=query,proto3" json:"query,omitempty"` +} + +func (x *QuestionRequest) Reset() { + *x = QuestionRequest{} + if protoimpl.UnsafeEnabled { + mi := &file_proto_ask_proto_msgTypes[0] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *QuestionRequest) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*QuestionRequest) ProtoMessage() {} + +func (x *QuestionRequest) ProtoReflect() protoreflect.Message { + mi := &file_proto_ask_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 QuestionRequest.ProtoReflect.Descriptor instead. +func (*QuestionRequest) Descriptor() ([]byte, []int) { + return file_proto_ask_proto_rawDescGZIP(), []int{0} +} + +func (x *QuestionRequest) GetQuery() string { + if x != nil { + return x.Query + } + return "" +} + +type QuestionResponse struct { + state protoimpl.MessageState + sizeCache protoimpl.SizeCache + unknownFields protoimpl.UnknownFields + + // the answer to your question + Answer string `protobuf:"bytes,1,opt,name=answer,proto3" json:"answer,omitempty"` + // a related url + Url string `protobuf:"bytes,2,opt,name=url,proto3" json:"url,omitempty"` + // any related image + Image string `protobuf:"bytes,3,opt,name=image,proto3" json:"image,omitempty"` +} + +func (x *QuestionResponse) Reset() { + *x = QuestionResponse{} + if protoimpl.UnsafeEnabled { + mi := &file_proto_ask_proto_msgTypes[1] + ms := protoimpl.X.MessageStateOf(protoimpl.Pointer(x)) + ms.StoreMessageInfo(mi) + } +} + +func (x *QuestionResponse) String() string { + return protoimpl.X.MessageStringOf(x) +} + +func (*QuestionResponse) ProtoMessage() {} + +func (x *QuestionResponse) ProtoReflect() protoreflect.Message { + mi := &file_proto_ask_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 QuestionResponse.ProtoReflect.Descriptor instead. +func (*QuestionResponse) Descriptor() ([]byte, []int) { + return file_proto_ask_proto_rawDescGZIP(), []int{1} +} + +func (x *QuestionResponse) GetAnswer() string { + if x != nil { + return x.Answer + } + return "" +} + +func (x *QuestionResponse) GetUrl() string { + if x != nil { + return x.Url + } + return "" +} + +func (x *QuestionResponse) GetImage() string { + if x != nil { + return x.Image + } + return "" +} + +var File_proto_ask_proto protoreflect.FileDescriptor + +var file_proto_ask_proto_rawDesc = []byte{ + 0x0a, 0x0f, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x2f, 0x61, 0x73, 0x6b, 0x2e, 0x70, 0x72, 0x6f, 0x74, + 0x6f, 0x12, 0x03, 0x61, 0x73, 0x6b, 0x22, 0x27, 0x0a, 0x0f, 0x51, 0x75, 0x65, 0x73, 0x74, 0x69, + 0x6f, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x12, 0x14, 0x0a, 0x05, 0x71, 0x75, 0x65, + 0x72, 0x79, 0x18, 0x01, 0x20, 0x01, 0x28, 0x09, 0x52, 0x05, 0x71, 0x75, 0x65, 0x72, 0x79, 0x22, + 0x52, 0x0a, 0x10, 0x51, 0x75, 0x65, 0x73, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x73, 0x70, 0x6f, + 0x6e, 0x73, 0x65, 0x12, 0x16, 0x0a, 0x06, 0x61, 0x6e, 0x73, 0x77, 0x65, 0x72, 0x18, 0x01, 0x20, + 0x01, 0x28, 0x09, 0x52, 0x06, 0x61, 0x6e, 0x73, 0x77, 0x65, 0x72, 0x12, 0x10, 0x0a, 0x03, 0x75, + 0x72, 0x6c, 0x18, 0x02, 0x20, 0x01, 0x28, 0x09, 0x52, 0x03, 0x75, 0x72, 0x6c, 0x12, 0x14, 0x0a, + 0x05, 0x69, 0x6d, 0x61, 0x67, 0x65, 0x18, 0x03, 0x20, 0x01, 0x28, 0x09, 0x52, 0x05, 0x69, 0x6d, + 0x61, 0x67, 0x65, 0x32, 0x40, 0x0a, 0x03, 0x41, 0x73, 0x6b, 0x12, 0x39, 0x0a, 0x08, 0x51, 0x75, + 0x65, 0x73, 0x74, 0x69, 0x6f, 0x6e, 0x12, 0x14, 0x2e, 0x61, 0x73, 0x6b, 0x2e, 0x51, 0x75, 0x65, + 0x73, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x71, 0x75, 0x65, 0x73, 0x74, 0x1a, 0x15, 0x2e, 0x61, + 0x73, 0x6b, 0x2e, 0x51, 0x75, 0x65, 0x73, 0x74, 0x69, 0x6f, 0x6e, 0x52, 0x65, 0x73, 0x70, 0x6f, + 0x6e, 0x73, 0x65, 0x22, 0x00, 0x42, 0x0d, 0x5a, 0x0b, 0x2e, 0x2f, 0x70, 0x72, 0x6f, 0x74, 0x6f, + 0x3b, 0x61, 0x73, 0x6b, 0x62, 0x06, 0x70, 0x72, 0x6f, 0x74, 0x6f, 0x33, +} + +var ( + file_proto_ask_proto_rawDescOnce sync.Once + file_proto_ask_proto_rawDescData = file_proto_ask_proto_rawDesc +) + +func file_proto_ask_proto_rawDescGZIP() []byte { + file_proto_ask_proto_rawDescOnce.Do(func() { + file_proto_ask_proto_rawDescData = protoimpl.X.CompressGZIP(file_proto_ask_proto_rawDescData) + }) + return file_proto_ask_proto_rawDescData +} + +var file_proto_ask_proto_msgTypes = make([]protoimpl.MessageInfo, 2) +var file_proto_ask_proto_goTypes = []interface{}{ + (*QuestionRequest)(nil), // 0: ask.QuestionRequest + (*QuestionResponse)(nil), // 1: ask.QuestionResponse +} +var file_proto_ask_proto_depIdxs = []int32{ + 0, // 0: ask.Ask.Question:input_type -> ask.QuestionRequest + 1, // 1: ask.Ask.Question:output_type -> ask.QuestionResponse + 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_ask_proto_init() } +func file_proto_ask_proto_init() { + if File_proto_ask_proto != nil { + return + } + if !protoimpl.UnsafeEnabled { + file_proto_ask_proto_msgTypes[0].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*QuestionRequest); i { + case 0: + return &v.state + case 1: + return &v.sizeCache + case 2: + return &v.unknownFields + default: + return nil + } + } + file_proto_ask_proto_msgTypes[1].Exporter = func(v interface{}, i int) interface{} { + switch v := v.(*QuestionResponse); 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_ask_proto_rawDesc, + NumEnums: 0, + NumMessages: 2, + NumExtensions: 0, + NumServices: 1, + }, + GoTypes: file_proto_ask_proto_goTypes, + DependencyIndexes: file_proto_ask_proto_depIdxs, + MessageInfos: file_proto_ask_proto_msgTypes, + }.Build() + File_proto_ask_proto = out.File + file_proto_ask_proto_rawDesc = nil + file_proto_ask_proto_goTypes = nil + file_proto_ask_proto_depIdxs = nil +} diff --git a/ask/proto/ask.pb.micro.go b/ask/proto/ask.pb.micro.go new file mode 100644 index 0000000..acbf711 --- /dev/null +++ b/ask/proto/ask.pb.micro.go @@ -0,0 +1,93 @@ +// Code generated by protoc-gen-micro. DO NOT EDIT. +// source: proto/ask.proto + +package ask + +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 Ask service + +func NewAskEndpoints() []*api.Endpoint { + return []*api.Endpoint{} +} + +// Client API for Ask service + +type AskService interface { + Question(ctx context.Context, in *QuestionRequest, opts ...client.CallOption) (*QuestionResponse, error) +} + +type askService struct { + c client.Client + name string +} + +func NewAskService(name string, c client.Client) AskService { + return &askService{ + c: c, + name: name, + } +} + +func (c *askService) Question(ctx context.Context, in *QuestionRequest, opts ...client.CallOption) (*QuestionResponse, error) { + req := c.c.NewRequest(c.name, "Ask.Question", in) + out := new(QuestionResponse) + err := c.c.Call(ctx, req, out, opts...) + if err != nil { + return nil, err + } + return out, nil +} + +// Server API for Ask service + +type AskHandler interface { + Question(context.Context, *QuestionRequest, *QuestionResponse) error +} + +func RegisterAskHandler(s server.Server, hdlr AskHandler, opts ...server.HandlerOption) error { + type ask interface { + Question(ctx context.Context, in *QuestionRequest, out *QuestionResponse) error + } + type Ask struct { + ask + } + h := &askHandler{hdlr} + return s.Handle(s.NewHandler(&Ask{h}, opts...)) +} + +type askHandler struct { + AskHandler +} + +func (h *askHandler) Question(ctx context.Context, in *QuestionRequest, out *QuestionResponse) error { + return h.AskHandler.Question(ctx, in, out) +} diff --git a/ask/proto/ask.proto b/ask/proto/ask.proto new file mode 100644 index 0000000..aa5e507 --- /dev/null +++ b/ask/proto/ask.proto @@ -0,0 +1,24 @@ +syntax = "proto3"; + +package ask; + +option go_package = "./proto;ask"; + +service Ask { + rpc Question(QuestionRequest) returns (QuestionResponse) {} +} + +// Ask a question and receive an instant answer +message QuestionRequest { + // the question to ask + string query = 1; +} + +message QuestionResponse { + // the answer to your question + string answer = 1; + // a related url + string url = 2; + // any related image + string image = 3; +} diff --git a/ask/publicapi.json b/ask/publicapi.json new file mode 100644 index 0000000..587c111 --- /dev/null +++ b/ask/publicapi.json @@ -0,0 +1,5 @@ +{ + "name": "ask", + "icon": "❓", + "category": "search" +} diff --git a/go.mod b/go.mod index cc61552..9029ff4 100644 --- a/go.mod +++ b/go.mod @@ -7,6 +7,7 @@ require ( github.com/Masterminds/semver/v3 v3.1.1 github.com/PuerkitoBio/goquery v1.6.1 github.com/SlyMarbo/rss v1.0.1 + github.com/ajanicij/goduckgo v0.0.0-20150205231829-61f9a275272f github.com/cdipaolo/goml v0.0.0-20190412180403-e1f51f713598 // indirect github.com/cdipaolo/sentiment v0.0.0-20200617002423-c697f64e7f10 github.com/cpuguy83/go-md2man/v2 v2.0.0 // indirect diff --git a/go.sum b/go.sum index c416410..3a819ba 100644 --- a/go.sum +++ b/go.sum @@ -37,6 +37,8 @@ github.com/Shopify/sarama v1.19.0/go.mod h1:FVkBWblsNy7DGZRfXLU0O9RCGt5g3g3yEuWX github.com/Shopify/toxiproxy v2.1.4+incompatible/go.mod h1:OXgGpZ6Cli1/URJOF1DMxUHB2q5Ap20/P/eIdh4G0pI= github.com/SlyMarbo/rss v1.0.1 h1:fiaIU5UhcXauVOniHOIocWG7uj8Ej6pHNarMGPJilzA= github.com/SlyMarbo/rss v1.0.1/go.mod h1:JNF+T33oj4m5WLCQXpBTCgO+SxRbYVgdiiimHNgzcbA= +github.com/ajanicij/goduckgo v0.0.0-20150205231829-61f9a275272f h1:FkZIeRvGe4AcF/K4UKsuvyTvRYhMCGwjpoIByl6t61I= +github.com/ajanicij/goduckgo v0.0.0-20150205231829-61f9a275272f/go.mod h1:KeRS5OFtXgX0i1YVwrl00Rm70FdNSJlzpvj3p+1qjx8= github.com/ajstarks/svgo v0.0.0-20180226025133-644b8db467af/go.mod h1:K08gAheRH3/J6wwsYMMT4xOr94bZjxIelGM0+d/wbFw= github.com/akamai/AkamaiOPEN-edgegrid-golang v0.9.0/go.mod h1:zpDJeKyp9ScW4NNrbdr+Eyxvry3ilGPewKoXw3XGN1k= github.com/alecthomas/template v0.0.0-20160405071501-a0175ee3bccc/go.mod h1:LOuyumcjzFXgccqObfd/Ljyb9UuFJ6TxHnclSeseNhc=