This document summarizes asynchronous SMS messaging using Ruby. It discusses SMS concepts like SMSC and SMPP protocol. It provides examples of receiving and sending SMS using Kannel gateway and configuring it using Kannel.conf. It also discusses using message brokers like ActiveMQ for asynchronous communication and STOMP protocol for language-agnostic clients. The document gives code snippets for Ruby clients to publish, subscribe and receive messages.

1. ASYNCHRONOUS
SMS MESSAGING
WITH RUBY
-Vaggelis Typaldos @vtypal

2. OVERVIEW

3. SMS
Short Message Service
What is?
Why use it?

4. SMS PROS
Sms is easy
Sms is available to everybody
Sms is a high revenue communication channel

5. SMS CONS
Sms is short (plain text of 160 chars max.)
Send sms is not cost free
Sms black hours
Legal conditions

6. SMSC
Short Message Service Center
Send and receive SMS & DLRs
Check msisdn to HLR database
Assign a short code (4-digit) number to our bind
Set throughput (sms rate)
SMSC talks to (ESME) clients via SMPP protocol

7. SMPP PROTOCOL (V_3.4)
Short Message Peerto PeerProtocol
Peer to peer over tcp protocol between ESME (external short
messaging entities) clients and SMSC for sending/receiving SMS
messages.
Each tcp packet is called PDU (Protocol Data Unit)
bind_sm/bind_sm_resp
enquire_link/enquire_link_resp
submit_sm/submit_sm_resp
deliver_sm/deliver_sm_resp

8. TYPICALSMPP REQUEST - RESPONSE

9. KANNEL SMS GATEWAY
PROS
Open source
Fast and Light
Single configuration file
Local store for sms
Split long text messages in more parts
Rich API

10. KANNEL.CONF (BEARERBOX)
group = core
admin-port = 13000
smsbox-port = 13001
admin-password = bar
store-location = "/app/gateway-1.5.0/logs/kannel.store"
# SMSC SMPP
group = smsc
smsc = smpp
smsc-id = "smsc"
host = 10.10.10.10
port = 9000
system-type = ESME
smsc-username = "2222"
smsc-password = "2222pass"
transceiver-mode = true
source-addr-ton = 0
source-addr-npi = 1
interface-version = 34
dest-addr-ton = 1
dest-addr-npi = 5
max-pending-submits = 50
throughput = 50
#no-dlr=true

11. KANNEL.CONF (SMSBOX)
group = smsbox
bearerbox-host = localhost
sendsms-port = 13006
mo-recode = true
http-request-retry = 3
# SEND-SMS USERS
group = sendsms-user
username = tester
password = foobar
# SERVICES
group = sms-service
#max-messages = 10
get-url = http://appserver:8000/myapp/mo?from=%p&to=%P&text=%a&kcod=%c
&kchar=%C&smsc=%i&time=%t
accepted-smsc = smsc

12. RECEIVING MO
Mobile Originated
Retrieve the parameters defined in get-url(or post-url) of kannel.conf
http://appserver:8000/myapp/mo?
from=%p&to=%P&text=%a&kcod=%c&kchar=%C&smsc=%i&time=%t

13. class MyApp
def mo
if request.get?
@params=request.params
return %|
============ MO received at #{ @params['time'] } ============
From: #{ @params['from'] }
To; #{ @params['to'] }
Smsc: #{ @params['smsc'] }
Message: #{ @params['text'] }
==================================
|
end
end
end

14. SENDING MT
Mobile Terminated
GET request to the sendsms port of smsbox defined in kannel.conf
Try it using your browser (will work)
In your ruby code you must url encode the text
http://smsgateway:13006/cgi-bin/sendsms?to=30306941234567&from=1234&username=t
ester&password=foobar
&text=Athens Ruby Meetup (Athens.rb) is a group of (not just) geeks who love R
uby (among other things)
and meet regularly in Athens in order to discuss and present on all things Rub
y.... and have beers,ouzo,
tsipouro as well as other alcoholic (and sometimes non-alcoholic) beverages.
&smsc=smsc&coding=0&charset=UTF-8&alt-dcs=0

15. URI.ENCODE_WWW_FORM_COMPONENT(TEXT)
Athens+Ruby+Meetup+%28Athens.rb%29+is+a+group+of+%28not+just%29+geeks+
who+love+Ruby+%28among+other+things%29%0Aand+
meet+regularly+in+Athens+in+order+to+discuss+
and+present+on+all+things+Ruby...+and+have+
beers%2Couzo%2C%0Atsipouro+as+well+as+other+
alcoholic+%28and+sometimes+non-alcoholic%29+beverages.

16. MT example
require 'uri'
require 'net/http'
uri = URI.parse('http://smsgateway:13006/cgi-bin/sendsms'),
params = { :to => "306941234567", :from => "1234",
:username=>"tester", :password=>"foobar",
:text=>"Athens Ruby Meetup (Athens.rb) is a group of
(not just) geeks who love Ruby (among other things) and
meet regularly in Athens in order to discuss and present
on all things Ruby.... and have beers,ouzo,
tsipouro as well as other alcoholic (and sometimes
non-alcoholic) beverages.", etc }
# Add params to URI
uri.query = URI.encode_www_form( params )
puts Net::HTTP.get(uri)

17. REQUESTING DELIVERY REPORTS
dlr-url (url-encoded)
dlr-mask
http://smsgateway:13006/cgi-bin/sendsms?to=30306941234567&from=1234&username=t
ester&password=foobar
&text=Athens Ruby Meetup (Athens.rb) is a group of (not just) geeks who love R
uby (among other things)
and meet regularly in Athens in order to discuss and present on all things Rub
y.... and have beers,ouzo,
tsipouro as well as other alcoholic (and sometimes non-alcoholic) beverages.
&smsc=smsc&coding=0&charset=UTF-8&alt-dcs=0&
dlr-url=http://smsgateway:8000/myapp/dlr?msgId=22186231&type=%d&dlr-mask=3
http://smsgateway:13006/cgi-bin/sendsms?to=30306941234567&from=1234&username=t
ester&password=foobar
&text=Athens+Ruby+Meetup+%28Athens.rb%29+is+a+group+of+%28not+just%29+geeks+
who+love+Ruby+%28among+other+things%29%0Aand+
meet+regularly+in+Athens+in+order+to+discuss+
and+present+on+all+things+Ruby...+and+have+
beers%2Couzo%2C%0Atsipouro+as+well+as+other+
alcoholic+%28and+sometimes+non-alcoholic%29+beverages.
&smsc=smsc&coding=0&charset=UTF-8&alt-dcs=0&
dlr-url=http%3A%2F%2Fsmsgateway%3A8000%2Fmyapp%2Fdlr%3FmsgId%3D22186231%26type
%3D%25&dlr-mask=3

18. MT with DLR example
require 'uri'
require 'net/http'
uri = URI.parse('http://smsgateway:13006/cgi-bin/sendsms'),
params = { :to => "306941234567", :from => "1234",
:username=>"tester", :password=>"foobar",
:text=>"Athens Ruby Meetup (Athens.rb) is a group of
(not just) geeks who love Ruby (among other things) and
meet regularly in Athens in order to discuss and present
on all things Ruby.... and have beers,ouzo,
tsipouro as well as other alcoholic (and sometimes
non-alcoholic) beverages.", etc..,
:dlr-url => "http://smsgateway:8000/myapp/dlr?msgId=22186231&type=%d",
:dlr-mask =>3 }
# Add params to URI
uri.query = URI.encode_www_form( params )
puts Net::HTTP.get(uri)

19. RECEIVING DLR
class MyApp
...
def dlr
if request.get?
@params=request.params
return %|
============ DLR received ============
Message Id:: #{ @params['msgId'] }
Delivery type: #{ @params['type'] }
==================================
|
end
end
end

20. MESSAGE BROKER
provides clients with connectivity, and message storage/delivery
functions
Queue: Destination that contains messages sent from a producer
that await delivery to one consumer
Destination: queues or topics
CLIENT TYPES
Producers (create messages and send or publish them to the broker
for delivery to a specified destination)
Consumers (retrieve messages from a destination)

21. MESSAGE BROKER PROS
Clustering
Failover
Persistence

22. STOMP
StreamingText OrientedMessagingProtocol (STOMP)
In activemq.xml configuration file replace the default wire protocol
used by native Java Message Broker clients with stomp transport
connector that supports clients written in languages such as Ruby,
Perl, Python, and PHP.
transportConnector name="openwire" uri="tcp://localhos
t:61616"
transportConnector name="stomp" uri="stomp://localhost
:61616"

23. PRODUCER-PUBLISHER
#Create the queue (if does not exist)
# and populate the queue with messages
require 'stomp'
client = Stomp::Client.open "stomp://localhost:61616"
1.upto(50) do
client.publish("/queue/rbq", Time.now.strftime("%H-%M-%s"), { :persistent =
> true })
# client.publish("/topic/chat", "Hello Rubystes!", { :persistent => true })
sleep 2
end
client.close

24. CONSUMER-SUBSCRIBER
require 'stomp'
client = Stomp::Client.open "stomp://localhost:61616"
client.subscribe "/queue/rbq" do |message|
puts "received: #{message.body} on #{message.headers['destination']}"
end
client.join
client.close

25. ACTIMEMQ ADMIN UI

26. THE END
BYVTYPAL