feature(init): init commit

Author: Fuyuan.Chu

.gitignore

@@ -0,0 +1,6 @@
+.idea
+*.csv
+*.db
+notice.sh
+var
+env

README.md

@@ -0,0 +1,57 @@
+# Quick Start
+
+``mailprovider.py`` 根据 [open-falcon](http://open-falcon.org/) 组件 ``sender`` 预定义好的规范实现的一个简单的[邮件报警接口](https://book.open-falcon.org/zh/quick_install/judge_components.html).
+
+部署同样遵循 ``open-falcon`` 各个组件的打包部署方式, 组织结构如下:
+
+```
+mailprovider
+`+- env
+ +- var
+ +- control
+ +- mailprovider.py
+ +- gunicorn.conf
+ +- wsgi.py
+ +- requirements.txt
+ +- install.sh
+```
+
+# 安装 & 启动
+
+1. 执行安装脚本进行环境的初始化. 该脚本会在同级目录下创建一个 python 虚拟环境,并安装所需依赖.
+
+    > sh install.sh
+
+2. 执行控制脚本启动程序.
+
+    > sh control start
+
+# 使用
+
+* ``open-falcon`` 的 ``sender`` 中配置
+
+    > "mail": "http://ip_address:9988/mail"
+
+* 脚本或人工调用
+
+   > url=http://ip_address:9988/mail
+
+   > curl -X POST $url -d "content=xxx&tos=[email protected]&subject=xxx"
+
+# 附加功能
+
+为帮助记录每天运维发布系统的频次,并定时自动邮件通知相关同事,增加了一些额外的接口. 对这类接口使用 HTTP Basic Authentication 做访问认证.
+
+``POST /db/deployInfo``
+
+参数 ``date`` ``time``  ``target_host``  ``project``  ``app_name``  ``deploy_host``  ``user``
+
+该接口会保存发布记录到 sqlite 数据库中,并且带有是否已发送通知的标记.
+
+``POST /db/notice``
+
+参数 ``tos``
+
+该接口会将库中所有未发送过通知的记录通过 ``/mail`` 接口发送出去,且标记为已发送.
+
+PS 该脚本中还有一个  /deployInfo 接口为 /db/deployInfo 的原型,使用 csv 文件作为本地数据存储格式.并通过外部脚本实现发送通知功能.

control

@@ -0,0 +1,112 @@
+#!/bin/bash
+
+WORKSPACE=$(cd $(dirname $0)/; pwd)
+cd $WORKSPACE
+
+mkdir -p var
+
+module=mail-provider
+app=falcon-$module
+pidfile=var/app.pid
+logfile=var/app.log
+
+function check_pid() {
+    if [ -f $pidfile ];then
+        pid=`cat $pidfile`
+        if [ -n $pid ]; then
+            running=`ps -p $pid|grep -v "PID TTY" |wc -l`
+            return $running
+        fi
+    fi
+    return 0
+}
+
+function start() {
+    source env/bin/activate
+    hash gunicorn 2>&- || { echo >&2 "I require gunicorn but it's not installed.  Aborting."; exit 1; }
+
+    check_pid
+    running=$?
+    if [ $running -gt 0 ];then
+        echo -n "$app now is running already, pid="
+        cat $pidfile
+        return 1
+    fi
+
+    gunicorn -c gunicorn.conf mailprovider:app -D -t 6000 --pid $pidfile --error-logfile var/error.log --log-level info \
+    --enable-stdio-inheritance --log-file=$logfile --access-logfile var/access.log &> $logfile
+    sleep 1
+    echo -n "$app started..., pid="
+    cat $pidfile
+}
+
+function stop() {
+    pid=`cat $pidfile`
+    kill $pid
+    echo "$app quit..."
+}
+
+function kill9() {
+    pid=`cat $pidfile`
+    kill -9 $pid
+    echo "$app stoped..."
+}
+
+function restart() {
+    stop
+    sleep 2
+    start
+}
+
+function status() {
+    check_pid
+    running=$?
+    if [ $running -gt 0 ];then
+        echo -n "$app now is running, pid="
+        cat $pidfile
+    else
+        echo "$app is stoped"
+    fi
+}
+
+function tailf() {
+    tail -f var/*.log
+}
+
+function show_version() {
+    cat gitversion
+}
+
+function pack() {
+    git log -1 --pretty=%h > gitversion
+    file_list="README.md control frame gunicorn.conf metrics pip_requirements.txt scripts web wsgi.py"
+    find -name "*.pyc" | xargs rm -rf
+    gitversion=`cat gitversion`
+    tar -zcf $app-$gitversion.tar.gz  gitversion $file_list
+}
+
+function help() {
+    echo "$0 start|stop|restart|status|tail|kill9|version|pack"
+}
+
+if [ "$1" == "" ]; then
+    help
+elif [ "$1" == "stop" ];then
+    stop
+elif [ "$1" == "kill9" ];then
+    kill9
+elif [ "$1" == "start" ];then
+    start
+elif [ "$1" == "restart" ];then
+    restart
+elif [ "$1" == "status" ];then
+    status
+elif [ "$1" == "tail" ];then
+    tailf
+elif [ "$1" == "pack" ];then
+    pack
+elif [ "$1" == "version" ];then
+    show_version
+else
+    help
+fi

gunicorn.conf

@@ -0,0 +1,6 @@
+workers = 4
+bind = '0.0.0.0:9988'
+proc_name = 'mailprovider'
+pidfile = 'var/app.pid'
+limit_request_field_size = 0
+limit_request_line = 0

install.sh

@@ -0,0 +1,17 @@
+#!/usr/bin/env bash
+#########################################################################
+# File Name: install.sh
+# Author: Chufuyuan
+# Mail: [email protected]
+# Created Time: Tue Dec 20 23:50:23 2016
+#########################################################################
+
+WS=$(cd $(dirname $0);pwd)
+
+pip install virtualenv
+
+cd $WS
+virtualenv env
+
+. env/bin/activate
+pip install -r requirements.txt