{"id":21952013,"url":"https://github.com/systangotechnologies/serverless-ruby-simple-email","last_synced_at":"2025-04-23T04:04:43.829Z","repository":{"id":38295519,"uuid":"186603818","full_name":"SystangoTechnologies/serverless-ruby-simple-email","owner":"SystangoTechnologies","description":"Simple application to create Serverless Email service using jets framework of Ruby.","archived":false,"fork":false,"pushed_at":"2023-01-20T06:55:02.000Z","size":39,"stargazers_count":66,"open_issues_count":13,"forks_count":1,"subscribers_count":5,"default_branch":"master","last_synced_at":"2025-04-23T04:04:38.355Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Ruby","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SystangoTechnologies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-05-14T10:57:20.000Z","updated_at":"2020-01-08T09:07:53.000Z","dependencies_parsed_at":"2023-01-28T20:00:44.362Z","dependency_job_id":null,"html_url":"https://github.com/SystangoTechnologies/serverless-ruby-simple-email","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SystangoTechnologies%2Fserverless-ruby-simple-email","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SystangoTechnologies%2Fserverless-ruby-simple-email/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SystangoTechnologies%2Fserverless-ruby-simple-email/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SystangoTechnologies%2Fserverless-ruby-simple-email/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SystangoTechnologies","download_url":"https://codeload.github.com/SystangoTechnologies/serverless-ruby-simple-email/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":250366727,"owners_count":21418771,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-29T06:19:08.774Z","updated_at":"2025-04-23T04:04:43.810Z","avatar_url":"https://github.com/SystangoTechnologies.png","language":"Ruby","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Serverless Email Service\nThis 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.\n## Requirements\n* RVM\n* Ruby(2.5.1)\n* AWS CLI\n\n## Setup\n\n### Step 1 - Install RVM\n* Follow the steps given here: https://rvm.io/rvm/install, to install RVM in your machines\n\n### Step 2 - Install Ruby\nTo install ruby(2.5.1) in your machine, run following command\n```sh\n$ rvm install ruby-2.5.1\n```\n### Step 3 - Install \u0026 Configure AWS\n```sh\n$ sudo apt install awscli\n$ aws configure\n```\n### Step 4 - Take clone of the repository\n\n```ruby_on_rails\n$ git clone https://github.com/SystangoTechnologies/serverless-ruby-simple-email.git\n$ cd serverless-ruby-simple-email\n$ bundle install\n```\n### Step 5 - Run Application\n\nTo start your the jets server locally, you need to run\n\n```ruby_on_rails\n$ jets s\n```\nIt will start your service on http://localhost:8888.\n\nTo send email, you can hit the following endpoint as a POST request.\n\n```ruby_on_rails\n$ curl -X POST \\\n  http://localhost:8888/send_email \\\n  -H 'Authorization: {YOUR AUTHORIZATION KEY}' \\\n  -H 'Content-Type: application/x-www-form-urlencoded' \\\n  -H 'cache-control: no-cache'\n  -d '{\"sender\": \"sender@domain.com\", \"recipients\": [\"recipient1@domain.com\", \"recipient2@domain.com\"],\"subject\": \"Test email\", \"body\": \"\u003ch1\u003eHi User!\u003c/h1\u003e\"}'\n```\nThe required parameters in the request are:\n* **sender** [string]: Email address of sender\n* **recipients** [array]: Array of recipients emails.\n* **subject** [string]: Subject of Email\n* **body** [string]: Body of subject(HTML or normal text)\n\n## Deployment\nTo deploy your application to AWS, you need to just run single command\n\n```ruby_on_rails\n$ jets deploy\n```\n\nOnce the application is deployed you will get the API endpoint using which you can access Live API.\n\n## Security\n\nOnce 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](https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-setup-api-key-with-console.html) for the same given by AWS.\n\nIf you want a custom authorization instead of this, just comment out the **before_filter:authorize** line in application.rb to make custom authorization work.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystangotechnologies%2Fserverless-ruby-simple-email","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsystangotechnologies%2Fserverless-ruby-simple-email","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsystangotechnologies%2Fserverless-ruby-simple-email/lists"}