Initial middleware implementation

Author: Juan Pablo Santos

.coveragerc

@@ -0,0 +1,10 @@
+# Coverage configuration file
+
+[run]
+source = .
+
+omit = 
+  twilio_sample_project/settings/*
+  twilio_sample_project/wsgi.py
+  */migrations/*
+  */tests.py

.env_example

@@ -0,0 +1,11 @@
+# Environment variables for server-notifications-django
+
+# Django settings to use in this environment
+export DJANGO_SETTINGS_MODULE=twilio_sample_project.settings.local
+
+# Twilio API credentials
+export TWILIO_ACCOUNT_SID=ACXXXXXXXXXXXXXXXXX
+export TWILIO_AUTH_TOKEN=YYYYYYYYYYYYYYYYYY
+
+# Twilio sending number
+export TWILIO_NUMBER=+1555555505

.gitignore

@@ -0,0 +1,66 @@
+# Environment variables
+.env
+
+# virtualenv
+venv
+
+# Staticfiles
+twilio_sample_project/staticfiles
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/

.travis.yml

@@ -0,0 +1,13 @@
+language: python
+python:
+  - '2.7'
+  - '3.3'
+  - '3.4'
+install:
+  - pip install -r requirements.txt
+  - pip install coveralls
+script: coverage run manage.py test --settings=twilio_sample_project.settings.test
+env:
+  - TWILIO_ACCOUNT_SID=ACXXXXXXXXXXXXXXXXX TWILIO_AUTH_TOKEN=YYYYYYYYYYYYYYYYYY
+after_success:
+  - coveralls

LICENSE

@@ -0,0 +1,22 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Twilio Inc.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

README.md

@@ -0,0 +1,66 @@
+# Server Notifications
+
+[![Build Status](https://travis-ci.org/TwilioDevEd/server-notifications-django.svg?branch=master)](https://travis-ci.org/TwilioDevEd/server-notifications-django)
+[![Coverage Status](https://coveralls.io/repos/TwilioDevEd/server-notifications-django/badge.svg?branch=master&service=github)](https://coveralls.io/github/TwilioDevEd/server-notifications-django?branch=master)
+
+*Include 2-3 sentences here describing this sample app and what it does.*
+
+## Quickstart
+
+This project is built using the [Django](https://www.djangoproject.com/) web framework. It runs on Python 2.7+ and Python 3.4+.
+
+To run the app locally, first clone this repository and `cd` into its directory. Then:
+
+1. Create a new virtual environment:
+    - If using vanilla [virtualenv](https://virtualenv.pypa.io/en/latest/):
+
+        ```
+        virtualenv venv
+        source venv/bin/activate
+        ```
+
+    - If using [virtualenvwrapper](https://virtualenvwrapper.readthedocs.org/en/latest/):
+
+        ```
+        mkvirtualenv server-notifications-django
+        ```
+
+1. Install the requirements:
+
+    ```
+    pip install -r requirements.txt
+    ```
+
+1. Start a local PostgreSQL database and create a database called `server_notifications_django`:
+    - If on a Mac, we recommend [Postgres.app](http://postgresapp.com/). After install, open psql and run `CREATE DATABASE server_notifications_django;`
+    - If Postgres is already installed locally, you can just run `createdb server_notifications_django` from a terminal
+
+1. Run the migrations with:
+
+    ```
+    python manage.py migrate
+    ```
+
+1. Optionally create a superuser so you can access the Django admin:
+
+    ```
+    python manage.py createsuperuser
+    ```
+
+1. Copy the `.env_example` file to `.env`, and edit it to include your Twilio API credentials (found at https://www.twilio.com/user/account/voice)
+1. Run `source .env` to apply the environment variables (or even better, use [autoenv](https://github.com/kennethreitz/autoenv))
+1. Start the development server
+
+    ```
+    python manage.py runserver
+    ```
+
+## Run the tests
+
+You can run the tests locally through [coverage](http://coverage.readthedocs.org/):
+
+```
+$ coverage run manage.py test --settings=twilio_sample_project.settings.test
+```
+
+You can then view the results with `coverage report` or build an HTML report with `coverage html`.

manage.py

@@ -0,0 +1,12 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault(
+        "DJANGO_SETTINGS_MODULE",
+        "twilio_sample_project.settings.local")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

requirements.txt

@@ -0,0 +1,13 @@
+# Requirements for server-notifications-django
+
+# Django (1.8 is a long-term support release)
+Django==1.8
+twilio
+
+# Production dependencies
+gunicorn
+
+# Test dependencies
+coverage
+mock
+six

twilio_notifications/middleware.py

@@ -0,0 +1,57 @@
+from twilio.rest import TwilioRestClient
+from django.core.exceptions import MiddlewareNotUsed
+import os
+import logging
+
+logger = logging.getLogger(__name__)
+
+MESSAGE = """[This is a test] ALERT!
+It appears the server is having issues.
+Exception: %s.
+Go to: http://newrelic.com for more details."""
+
+NOT_CONFIGURED_MESSAGE = """Cannot initialize Twilio notification
+middleware. Required enviroment variables TWILIO_ACCOUNT_SID, or
+TWILIO_AUTH_TOKEN or TWILIO_NUMBER missing"""
+
+
+class TwilioNotificationsMiddleware(object):
+
+    def __init__(self):
+        (twilio_number, twilio_client) = self._twilio_config()
+
+        self.twilio_number = twilio_number
+        self.twilio_client = twilio_client
+        self.administrators = self._administrators()
+
+    def _twilio_config(self):
+        twilio_account_sid = os.environ.get('TWILIO_ACCOUNT_SID')
+        twilio_auth_token = os.environ.get('TWILIO_AUTH_TOKEN')
+        twilio_number = os.environ.get('TWILIO_NUMBER')
+
+        if not all([twilio_account_sid,
+                    twilio_auth_token,
+                    self.twilio_number]):
+
+            logger.error(NOT_CONFIGURED_MESSAGE)
+            raise MiddlewareNotUsed
+
+        return (twilio_number,
+                TwilioRestClient(twilio_account_sid, twilio_auth_token))
+
+    def _send_message(self, body, to):
+        self.twilio_client.messages.create(body=body, to=to,
+                                           from_=self.twilio_number)
+
+    def _administrators(self):
+        # Read administrators
+        pass
+
+    def process_exception(self, request, exception):
+        exception_message = str(exception)
+        message_to_send = MESSAGE % exception_message
+
+        for admin in self.administrators:
+            self._send_message(message_to_send, admin.phone_number)
+
+        return None

twilio_sample_project/__init__.py

@@ -0,0 +1,100 @@
+"""
+Common Django settings for the project.
+
+See the local, test, and production settings modules for the values used
+in each environment.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.8/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.8/ref/settings/
+"""
+import os
+
+BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = False
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = 'not-so-secret'
+
+ALLOWED_HOSTS = []
+
+# Application definition
+
+DJANGO_APPS = (
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'django.contrib.humanize'
+)
+
+THIRD_PARTY_APPS = ()
+
+LOCAL_APPS = ()
+
+INSTALLED_APPS = DJANGO_APPS + THIRD_PARTY_APPS + LOCAL_APPS
+
+MIDDLEWARE_CLASSES = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+    'django.middleware.security.SecurityMiddleware',
+)
+
+ROOT_URLCONF = 'twilio_sample_project.urls'
+
+TEMPLATES = [
+    {
+        'BACKEND': 'django.template.backends.django.DjangoTemplates',
+        'DIRS': ['templates/'],
+        'APP_DIRS': True,
+        'OPTIONS': {
+            'context_processors': [
+                'django.template.context_processors.debug',
+                'django.template.context_processors.request',
+                'django.contrib.auth.context_processors.auth',
+                'django.contrib.messages.context_processors.messages',
+            ],
+        },
+    },
+]
+
+WSGI_APPLICATION = 'twilio_sample_project.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.8/ref/settings/#databases
+
+DATABASES = {}
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.8/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.8/howto/static-files/
+
+STATIC_ROOT = BASE_DIR + '/staticfiles'
+
+STATIC_URL = '/static/'
+

twilio_sample_project/settings/__init__.py

@@ -0,0 +1,10 @@
+'''
+Local settings
+
+- Run in Debug mode
+'''
+
+from .common import *  # noqa
+
+# Use DEBUG for local development
+DEBUG = True