Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/iainporter/sms-service

service for sending SMS Messages (Quarkus, Kotlin, postgres, kafka, debezium, docker)
https://github.com/iainporter/sms-service

debezium docker kafka kotlin quarkus

Last synced: 3 months ago
JSON representation

service for sending SMS Messages (Quarkus, Kotlin, postgres, kafka, debezium, docker)

Host: GitHub
URL: https://github.com/iainporter/sms-service
Owner: iainporter
License: apache-2.0
Created: 2020-06-26T19:53:49.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-11-16T01:28:40.000Z (about 2 years ago)
Last Synced: 2024-10-01T05:23:07.909Z (4 months ago)
Topics: debezium, docker, kafka, kotlin, quarkus
Language: HTML
Homepage:
Size: 543 KB
Stars: 29
Watchers: 4
Forks: 16
Open Issues: 4
Metadata Files:
- Readme: README.md
- License: LICENSE.txt

Awesome Lists containing this project

README

## SMS Service

See accompanying blog posts

* [Part One - Building a microservice from the ground up with quarkus kotlin and debezium]( https://medium.com/@changeant/building-a-microservice-from-the-ground-up-with-quarkus-kotlin-and-debezium-83ae5c8a8bbc)
* [Part Two - Implementing the transactional outbox pattern with debezium in quarkus](https://medium.com/@changeant/implementing-the-transactional-outbox-pattern-with-debezium-in-quarkus-f2680306951)
* [Part Three - Building a resilient microservice with quarkus and wiremock](https://levelup.gitconnected.com/building-a-resilient-microservice-with-quarkus-and-wiremock-de59b2a4fac7)
* [Part Four - Securing a microservice in quarkus with openid-connect](https://levelup.gitconnected.com/securing-a-microservice-in-quarkus-with-openid-connect-505204d1c9a9)
* [Part Five - Running a microservice in quarkus on graalvm](https://medium.com/@changeant/running-a-microservice-in-quarkus-on-graalvm-52d6b42a5840)

Additional related posts

* [Containerizing your microservice in quarkus with jib](https://medium.com/@changeant/containerizing-your-microservice-in-quarkus-with-jib-fae0f62bd57e)
* [Building a CI pipeline for a microservice in quarkus with circleci](https://levelup.gitconnected.com/building-a-ci-pipeline-for-a-microservice-in-quarkus-with-circleci-11e9b679423f)
* [Securing micro services in quarkus with Amazon Cognito](https://medium.com/@changeant/securing-micro-services-in-quarkus-with-aws-cognito-387990c04100)

A production quality micro service for sending SMS messages that demonstrates the use of several technologies including:

* Quarkus
* GraalVM
* Kotlin
* Postgres (Persistence)
* Panache (JPA)
* Flyway (Database migration)
* Kafka (Messaging)
* Debezium, Kafka Connect (Transactional Outbox pattern)
* Okta (OIDC)
* Open API
* Docker
* Test Containers
* Wiremock

The service accepts SMS messages and routes them to configured providers

The service has support for Twilio and ClickSend

New providers can easily be plugged in by implementing com.porterhead.sms.provider.SmsProvider

You can build the service, but it won't accept messages unless there is at least one provider configured

## The architecture

![Arch diagram](https://github.com/iainporter/sms-service/blob/master/images/sms_service.png?raw=true)

# Configuring the Service
To configure the service, sign up to Twilio and/or ClickSend and add the appropriate properties
to a config/application.properties file.

Create a client in your OIDC domain and add the client-id to the config

An example for Okta would be

```
quarkus.oidc.auth-server-url=>
quarkus.oidc.client-id=
```

See application.properties.sample

Ensure the config directory is mounted by checking the path in the docker-compose.yml file

i.e.
```
volumes:
- ../config/application.properties:/deployments/config/application.properties
```

Build the service

```
mvn install
```

docker-compose to bring the service up

```
cd sms-service
docker-compose up
```

Install the Sms connector
```
curl 'localhost:8083/connectors/' -i -X POST -H "Accept:application/json" \
-H "Content-Type:application/json" \
-d '{"name": "sms-connector", "config": {"connector.class": "io.debezium.connector.postgresql.PostgresConnector", "database.hostname": "postgres-db", "database.port": "5432", "database.user": "postgres", "database.password": "postgres", "database.dbname" : "sms", "database.server.name": "smsdb1", "table.whitelist": "public.outboxevent", "transforms" : "outbox","transforms.outbox.type" : "io.debezium.transforms.outbox.EventRouter", "transforms.OutboxEventRouter.event.key": "aggregate_id", "transforms.outbox.table.fields.additional.placement": "type:header:eventType"}}'
```

To send a message
```
curl 'http://localhost:8080/v1/sms' -i -X POST \
-H 'Content-Type: application/json' \
-H 'authorization: Bearer '
-d '{"text":"Foo Bar!", "fromNumber": "+1234567890", "toNumber": "+1234567891"}'
```

From the response you can check the status by using the location header in the response

i.e.
```
HTTP/1.1 202 Accepted
Content-Length: 0
Location: http://localhost:8080/v1/sms/b3a20fac-2d00-49d2-b3ef-b3a3e5ac02ca
```
```
curl 'http://localhost:8080/v1/sms/b3a20fac-2d00-49d2-b3ef-b3a3e5ac02ca' -i -X GET \
-H 'Content-Type: application/json' \
-H 'authorization: Bearer '
```

you should see a response similar to this

```
{
"createdAt":"2020-07-16T16:43:59.43561Z",
"fromNumber":"+1234567890",
"id":"b3a20fac-2d00-49d2-b3ef-b3a3e5ac02ca",
"status":"DELIVERED",
"text":"Foo Bar!",
"provider": "Twilio",
"principal": "backend-service",
"toNumber":"+1234567891",
"updatedAt":"2020-07-16T16:44:00.432926Z"
}
```

# Running as a native executable on GraalVM

To build the native image you must have the native-image tool for GraalVM installed.

To build it

```
mvn clean install -Pnative
```