melhorias diversas

Author: staticdev

Dockerfile

@@ -1,4 +1,4 @@
-FROM python:2.7.14-slim
+FROM python:2.7.15-slim
 
 # set the working directory to /app
 WORKDIR /app
@@ -25,4 +25,4 @@ RUN cd ugc_norm && sh configure.sh
 EXPOSE 5000
 
 # run app.py when the container launches
-CMD ["gunicorn", "app:APP", "-b", ":5000"]
+CMD ["gunicorn", "__init__:create_app()", "-b", ":5000"]

README.md

@@ -0,0 +1,85 @@
+ugcnormal-microservice
+======================
+
+Microsserviço REST para normalização pt\_BR usando o
+[UGCNormal](https://github.com/avanco/UGCNormal). Ideal para aplicações
+que precisam de normalização online como chatbots.
+
+Webservice baseado no ugcnormal\_interface
+[](https://github.com/thiagootuler/ugcnormal_interface).
+
+Requisitos
+----------
+
+-   Instalar Docker-CE 18.03.1+
+-   900 Mb de espaço em disco para imagem
+
+Execução
+--------
+
+Rodar os comandos:
+
+``` {.sourceCode .sh}
+# gerar a imagem
+sudo docker build -t staticdev/ugcnormal:0.1.1 .
+# verificar se gerou
+sudo docker images
+# instanciar imagem
+sudo docker run --name ugcnormal -d -p 5000:5000 --env "UGCNORMAL=./ugc_norm/speller" staticdev/ugcnormal:0.1.1
+# conferir processo rodando
+sudo docker ps -a
+
+# para parar o container olhe o nome dele no docker ps -a e execute
+sudo docker stop ugcnormal
+# para remover um container (precisa parar primeiro)
+sudo docker rm ugcnormal
+```
+
+Exemplos de uso
+---------------
+
+Basta fazer um POST da mensagem a ser normalizada na url /reply passando
+a mensagem no campo "message" e o método no campo "method".
+
+Métodos disponíveis:
+
+-   token: tokenizer
+-   spell: speller
+-   acronym: acronyms searcher
+-   textese: untextese
+-   proper\_noun: proper noun normalizer
+
+A mensagem normalizada é retornada no campo "reply". O status da
+requisição no campo "status", tendo com valor padrão para sucesso "ok".
+
+Exemplo curl:
+
+``` {.sourceCode .sh}
+curl -X POST \
+  http://localhost:5000/reply \
+  -H 'content-type: application/json; charset=utf-8' \
+  -d '{
+    "message": "oi td bm?",
+    "method": "spell"
+}'
+```
+
+Exemplo python3 nativo (http.client):
+
+``` {.sourceCode .python}
+import http.client
+
+conn = http.client.HTTPConnection("localhost:5000")
+
+payload = "{\"message\": \"oi td bm?\", \"method\": \"spell\"}"
+
+headers = {
+    'content-type': "application/json; charset=utf-8"
+}
+
+conn.request("POST", "/reply", payload, headers)
+res = conn.getresponse()
+data = res.read()
+
+print(data.decode("utf-8"))
+```

README.rst

@@ -0,0 +1,52 @@
+#!/usr/bin/python
+# -*- coding: utf-8 -*-
+from flask import Flask, request, jsonify
+from normalizer import Normalizer
+
+def create_app(test_config=None):
+    app = Flask(__name__)
+    app.config['JSON_AS_ASCII'] = False # retrieve UTF-8 messages
+
+    norm = Normalizer()
+
+    @app.route('/reply', methods=['POST'])
+    def reply():
+        params = request.json
+        if not params:
+            return jsonify({
+                "status": "error",
+                "error": "Request must be of the application/json type!",
+            })
+
+        message = params.get("message")
+        method = params.get("method")
+
+        # Make sure the required params are present.
+        if message is None or method is None:
+            return jsonify({
+                "status": "error",
+                "error": "message and method are required keys"
+            })
+
+        methods = {'token':norm.tokenizer,
+                'spell':norm.speller,
+                'acronym':norm.acronym_searcher,
+                'textese':norm.untextese,
+                'proper_noun':norm.proper_noun_normalizer
+                }
+
+        try:
+            reply = methods[method](message)
+        except KeyError:
+            return jsonify({
+                "status": "error",
+                "error": "method not valid, try one of the following: token, spell, acronym, textese or proper_noun"
+            })
+
+        # Send the response.
+        return jsonify({
+            "status": "ok",
+            "reply": reply
+        })
+
+    return app

__init__.py

@@ -1,7 +1,7 @@
 numpy
 scipy
-Flask==0.12.2
-gunicorn==19.7.1
+Flask==1.0.2
+gunicorn==19.9.0
 multiprocessing
 nltk
 sklearn