matiasgarciaisaia/nuntium repository overview

⁠Nuntium

Nuntium is an open source and free platform -developed by InSTEDD⁠- that allows applications to send and receive all type of messages. Examples of messages are sms, emails and twitter direct messages.

Read about some of the new features in the last release⁠.

⁠Let's start with an example

Suppose you have a website that lets users browse and geolocate sms sent by users. Once a message is geolocated you want to send this information to a particular number. Also suppose you have an sms number by which you can receive and send sms. You want your website to focus on the geolocation task and leave the sending and receiving of sms to Nuntium. Here's how you do it:

• You get an account in Nuntium.
• You create an Application in Nuntium that will represent your application. You then select an Interface for it, for example HTTP callback. An Interface is something that lets Nuntium communicate with your application.
• You create a Channel that will communicate with the cellphone company. A Channel is something that lets Nuntium communicate with the world.

Your website gets messages from Nuntium using the configured Interface (in this case via an HTTP callback containing the messages.) Once a message is geolocated your website sends it to Nuntium (it performs an HTTP POST to Nuntium). And that's it!

⁠What are the benefits of using Nuntium?

• Your application deals with a simple protocol (HTTP, might be another one) instead of communicating directly with the cellphone company.
• Nuntium will do its best to deliver messages.
• You have a complete trace of what happened to each message.
• You can specify custom routing logic.
• You can change the routing logic without touching a single line in your application's source code.

This way you don't have to repeat this logic in every application that needs to send and receive messages.

⁠Installing

Installation docs⁠

⁠API

API documentation⁠

⁠Docker development

docker-compose.yml file build a development environment mounting the current folder and running rails in development environment.

Run the following commands to have a stable development environment.

$ docker-compose run --rm --no-deps web bundle install
$ docker-compose run --rm web bash -c 'rake db:setup db:seed'
root@web_1 $ rake db:setup db:seed
$ docker-compose up