Microservices

Microservices using nameko framework

---

Installation

• Clone/Download the repository

• Create a .env file and add tokens/secrets for twitter to use the Twitter bot microservices, twilio to use sms messaging microservice & google using sign-in with app password to use the email microservice.(More info on app passwords here). You can use the .env.example as a template guide.

  Credentials Links

  • https://developer.twitter.com/en
  • https://www.twilio.com/
  • https://support.google.com/mail/answer/185833?hl=en (Google App Passwords)

• Update/Replace the email message templates based on your preference. They are located in the mailer/templates directory

• Make sure docker and docker-compose is installed in your system and start a RabbitMQ container.

    docker run -d -p 5672:5672 rabbitmq:3

    Here we are starting the container in detached mode, and mapping port 5672 of the host to port 5672 od the container. We are also specifying that we are using version 3 of rabbitmq

• Create a python virtual environment and install nameko:

    python3.8 -m venv --without-pip venv
    source venv/bin/activate
    curl https://bootstrap.pypa.io/get-pip.py | python

    pip install nameko

• Run the command docker-compose up to run the app.

---

Rebuild and DB Commands

To rebuild the app after making tweaks to the app or adding a microservice Use docker-compose build to rebuild

Run docker-compose exec flask_blog python manage.py db to run db commands for migrations and upgrade

If the above command results in an error run docker-compose down -v to bring down container and volumes and then rebuild and apply migrations

Run the command docker-compose exec db psql --username=putusername --dbname=putname to enter psql and verify db tables were created

---

Endpoints

• Visit port 8000 to access tweet/mailer/sms microservices and specify the target url with the relevant data passed. `

  • /sms -> Send a text message to a phone number of choice with a message you specify
  • /mailer -> Sends an email to an email address of choice with a name & message
  • /tweet -> Post a tweet to the specified account `

• To visit the Flask blog, visit port 5000 and access the routes `

  • auth.delete_profile DELETE /v1/auth/me
  • auth.get_profile GET /v1/auth/me
  • auth.get_user GET /v1/auth/int:id
  • auth.get_users GET /v1/auth/
  • auth.login POST /v1/auth/login
  • auth.register POST /v1/auth/register
  • auth.update_profile PUT /v1/auth/me
  • main.create_blog POST /v1/main/
  • main.delete_blog DELETE /v1/main/int:id
  • main.get_blog GET /v1/main/int:id
  • main.get_blogs GET /v1/main/
  • main.update_blog PUT /v1/main/int:id `

---

Viewing Endpoints

Use Postman (or preferred API platform) to access the routes or run them via the commandline Examples commands using curl to run via the command line:

curl -i -d "{\"receiver_email\": \"test@test.com\", \"receiver_name\": \"test\" ,\"mail_message\": \"Hello this is a test Email\"}" localhost:8000/mailer

curl -i -d "{\"tweet_message\": \"Hello World\"}" localhost:8000/tweet

curl -i -d "{\"receiver_number\": \"+254728104485\", \"sms_message\": \"Test sms\"}" localhost:8000/sms

Sample run commands are in the run.txt file