pyramid_sms package

Submodules

pyramid_sms.dummy module

Dummy SMS service for testing.

class pyramid_sms.dummy.DummySMSService(request)

Bases: object

get_last_message()

Get the latest outgoing message.

Message queue is process global.

Userful for testing.

last_outgoing = None

outgoing_count = 0

send_sms(receiver: str, text_body: str, sender=None, log_failure=True)

pyramid_sms.events module

class pyramid_sms.events.SMSEvent(request: pyramid.request.Request, receiver: str, text_body: str, sender: str, user_dialog: bool)

Bases: object

Base class for SMS events.

All events are fired within the web application process.

class pyramid_sms.events.SMSSent(request: pyramid.request.Request, receiver: str, text_body: str, sender: str, user_dialog: bool)

Bases: pyramid_sms.events.SMSEvent

Outbound SMS sent.

pyramid_sms.interfaces module

exception pyramid_sms.interfaces.SMSConfigurationError

Bases: RuntimeError

Missing INI settings.

pyramid_sms.outgoing module

Outgoing SMS API.

pyramid_sms.outgoing.send_sms(request: pyramid.request.Request, receiver: str, text_body: str, sender: str=None, log_failure: bool=True, async: bool=None, user_dialog: bool=False)

Send outgoing SMS message using the default configured SMS service.

Example:

def test_sms_view(request):
    '''Dummy view to simulate outgoing SMS.'''
    send_sms(request, "+15551231234", "Test message")

Parameters:

• receiver – Receiver’s phone number as international format. You should normalize this number from all user input before passing in. See pyramid_sms.utils for examples.
• text_body – Outbound SMS body. Usually up to 1600 characters.
• sender – Envelope from number. Needs to be configured in the service. If none use default configured “sms.default_from”.
• log_failure – If there is an exception from the SMS backend then log this using Python logging system. Otherwise raise the error as an exception.
• async – Force asynchronous operation through task subsystem. If None respect sms.async settings. If the operation is asynchronous, this function returns instantly and does not block HTTP request due to slow API calls to a third party service.
• user_dialog – This SMS is part of a dialog with a known user. Use this flag to log messages with the user in your conversation dashboard. Set False to two-factor auth tokens and such.

Raises SMSConfigurationError:  

If configuration settings are missing

pyramid_sms.outgoing.send_templated_sms(request: pyramid.request.Request, template: str, context: dict, receiver: str, sender: str=None, log_failure: bool=True, async: bool=None, user_dialog: bool=False)

Send out a SMS that is constructed using a page template.

Same as pyramid_sms.outgoing.send_sms(), but uses templates instead of hardcoded messages.

Parameters:

• request – HTTP request
• template – Template name. Like welcome_sms.txt.jinja.
• context – Dictionary passed to template rendering engine

pyramid_sms.twilio module

class pyramid_sms.twilio.TwilioService(request)

Bases: object

Send SMS using Twilio service.

send_sms(receiver, text_body, sender, log_failure)

Asynchronous call to Twilio.

We execute the actual SMS sending (calling Twilio HTTP API) in the Celery worker process, so that we do not block HTTP response head. This is especially important if we send more than one SMS message per HTTP request.

pyramid_sms.utils module

pyramid_sms.utils.get_sms_backend(request: <InterfaceClass pyramid.interfaces.IRequest>)

Get currently configured SMS backend.

Raise:SMSConfigurationError if nothing is configure.d

pyramid_sms.utils.normalize_international_phone_number(number: str) → str

Clean phone number and make sure it’s + prefixed.

Parameters:number – Hand typed international phone number like +1 (555) 123-1234 Returns:Raw phone number like +15551231234

pyramid_sms.utils.normalize_us_phone_number(number: str) → str

Clean phone number and convert is raw US phone number in international format.

Parameters:number – Hand typed US phone number like (555) 123-1234 Returns:Raw phone number like +15551231234

pyramid_sms.validators module

Module contents

pyramid_sms.includeme(config)