serverless ruby simple email

Simple application to create Serverless Email service using jets framework of Ruby.

SystangoTechnologies
66
1
Ruby

Serverless Email Service

This is a simple serverless application build over Jets framework of the ruby. The application illustrates how we can create a simple serverless email service using jets framework.

Requirements

  • RVM
  • Ruby(2.5.1)
  • AWS CLI

Setup

Step 1 - Install RVM

Step 2 - Install Ruby

To install ruby(2.5.1) in your machine, run following command

$ rvm install ruby-2.5.1

Step 3 - Install & Configure AWS

$ sudo apt install awscli
$ aws configure

Step 4 - Take clone of the repository

$ git clone https://github.com/SystangoTechnologies/serverless-ruby-simple-email.git
$ cd serverless-ruby-simple-email
$ bundle install

Step 5 - Run Application

To start your the jets server locally, you need to run

$ jets s

It will start your service on http://localhost:8888.

To send email, you can hit the following endpoint as a POST request.

$ curl -X POST \
  http://localhost:8888/send_email \
  -H 'Authorization: {YOUR AUTHORIZATION KEY}' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'cache-control: no-cache'
  -d '{"sender": "[email protected]", "recipients": ["[email protected]", "[email protected]"],"subject": "Test email", "body": "<h1>Hi User!</h1>"}'

The required parameters in the request are:

  • sender [string]: Email address of sender
  • recipients [array]: Array of recipients emails.
  • subject [string]: Subject of Email
  • body [string]: Body of subject(HTML or normal text)

Deployment

To deploy your application to AWS, you need to just run single command

$ jets deploy

Once the application is deployed you will get the API endpoint using which you can access Live API.

Security

Once API gateway is created, you must setup Usage plan along with their API Keys form API gateway console. For this, you can follow the official doc for the same given by AWS.

If you want a custom authorization instead of this, just comment out the before_filter:authorize line in application.rb to make custom authorization work.