Endpoint /tickers para ver todos los documentos en cryptongo

Clase 36 de 48 • Curso de MongoDB y Redis 2017

Hector Vasquez

student•

Comparto mi código funcionando, con comentarios explicativos:

import pymongo #Librería para comunicarse con la bd mongodb
from flask import Flask, jsonify, request #Flask es para levantar un servidor web. jsonify para poder retornar un json como respuesta al cliente. request permite capturar peticiones rest

#Función para crear conexión a la bd
def get_db_connection(uri):
	client = pymongo.MongoClient(uri) #Crear una conexión a la bd
	return client.cryptongo #Devolver bd cryptongo

app = Flask(__name__) #Crear un servidor web a partir del nombre del archivo ejecutado
db_connection = get_db_connection('mongodb://localhost:27017/') #Conexión a la bd

#Función para obtener lista de documentos a devolver
def get_documents():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío
	limit = int(request.args.get('limit', 0)) #Obtengo el campo "limit", recibido por get. Si no existe, devuelve 0, omitiendo limit. Fuerzo conversión a entero

	if name: #Si existe "name"
		params.update({'name': name}) #Lo agrego al diccionario de datos

	cursor = db_connection.tickers.find( #Busco tickers
		params, #, según lo que recibí por get
		{'_id': 0, 'ticker_hash': 0} #Campos omitidos
	).limit(limit)

	return list(cursor) #convertir resultados de bd en una lista y devolverlo como respuesta a la petición

#Función para obtener el top20 de documentos
def get_top20():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío
	limit = int(request.args.get('limit', 0)) #Obtengo el campo "limit", recibido por get. Si no existe, devuelve 0, omitiendo limit. Fuerzo conversión a entero

	if name: #Si existe "name"
		params.update({'name', name}) #Lo agrego al diccionario de datos

	params.update({'rank': {'$lte': 20}}) #Agrego condición para el find, inicando que el campo "rank" debe ser menor o igual a 20

	cursor = db_connection.tickers.find( #Busco tickers
		params, #, según lo que recibí por get
		{'_id': 0, 'ticker_hash': 0} #Campos omitidos
	).limit(limit)

	return list(cursor) #convertir resultados de bd en una lista y devolverlo como respuesta a la petición

#Función para eliminar un documento
def remove_currency():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío

	if name: #Si existe "name"
		params.update({'name': name}) #Lo agrego al diccionario de datos
	else:
		return False

	return db_connection.tickers.delete_many( #Borro todos los documentos que coincidan con el dato recibido por get
		params
	).deleted_count #Retorna la cantidad de documentos borrados

@app.route("/") #Defino la ruta raíz para recibir peticiones
def index(): #Cuando alguien pida esta ruta, se ejecutará esta función
	return jsonify( #Retornará una respuesta en formato json
		{
			'name': 'Cryptongo API'
		}
	)

@app.route("/top20", methods=['GET']) #Defino ruta GET para top20
def top20(): #Se ejecutará esta función cuando alguien entre a esa ruta
	return jsonify(get_top20()) #Devuelvo un json con la lista de top20

@app.route("/tickers", methods=['GET', 'DELETE']) #Defino ruta para obtener o eliminar tickers, recibiendo petición por GET o DELETE
def tickers(): #Con la ruta, se ejecuta esta función
	if request.method == "GET": #Si el método consultado por la ruta, es GET
		return jsonify(get_documents()) #Devuelve un json con el resultado de tickers, según parámetros por get (Puede ser sin parámetros)
	elif request.method == "DELETE": #En cambio, si el método consultado es por DELETE
		result = remove_currency() #Se borran los tickers que coincidan con los parámetros recibidos por get (Los parámetros son obligatorios)
		if result > 0:
			return jsonify({ #Retornar un json con la respuesta
				'text': 'Documentos eliminados'
			}), 204 #Flask permite agregar otro parámetro al return, indicando el código de respuesta, en este caso, un "No hay contenido" (común en los borrados de datos)
		else:
			return jsonify({ #Retornar un json con la respuesta
				'error': 'No se encontraron documentos'
			}), 404 #Flask permite agregar otro parámetro al return, indicando el código de respuesta, en este caso, un "No encontrado"```

Ariel Coyant

student•

muchas gracias!

Usuario anónimo

user•

¡Bien!

Cesar David Ramírez Dimaté

student•

Estoy revisando y no tiene sentido colocar el status 204 No Content, ya que la respuesta json que colocamos cuando se ejecute el método DELETE no se visualizaría en el postman. Debe ser 200.

Cesar David Ramírez Dimaté

student•

Este sería el código con el método POST.

from werkzeug.exceptions import BadRequest

from agent import main as agent

@app.route('/tickers', methods=['POST'])
def add_currency():
    try:
        data_request = request.get_json()

        if agent.save_ticker(db_connection, data_request):
            message = 'Documento almacenado exitosamente'
            return jsonify(message=message), 200
        else:
            error = 'El documento ya existe'
            return jsonify(error=error), 400
    except BadRequest:
        error = 'No se envío información en el body'
        return jsonify(error=error), 400

Daniel Sepulveda

student•

no entendí lo de ?limit=10&name=Bitcoin

Diego Forero

Team Platzi•

Son parámetros get que usan para filtrar, esos se reciben en la función get_documents(), te recomiendo que repases la clase donde se creo la función. https://platzi.com/clases/mongodb-redis/concepto/desarrollo-del-proyecto-cryptongo/crear-api-que-consulta-la-base-de-datos-get_docume/material/

Jair Israel Avilés Eusebio

student•

Para confirmar el reto y al anexar el metodo post en la url de tickers ¿tengo que tambien asegurar que reciba un body con los parametros que yo le indique en mi llamado POST para almacenar la moneda o tengo que asegurarme que llame al api de coinmarket para recibir los datos?

Cesar David Ramírez Dimaté

student•

Claramente el reto es que ingreses un json en el body con el método POST y almacene este documento en la BD. Si te fijas, toda la API que creamos no está interactuando con Coin Market Cap. Sólo se utilizó en agent/main.py para llenar la base de datos de información.

Jair Israel Avilés Eusebio

student•

Tengo el siguiente error en el servidor al llamar el metodo /tickers desde la URL ¿sera que tengo que modificar alguna variable para ajustar el valor del tiemout maximo?

FLASK_APP=main.py flask run
 * Serving Flask app "main"
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
127.0.0.1 - - [16/Feb/2018 10:47:29] "GET / HTTP/1.1" 200 -
[2018-02-16 10:48:03,626] ERROR in app: Exception on /tickers [GET]
Traceback (most recent call last):
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1982, in wsgi_app
    response = self.full_dispatch_request()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1614, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1517, in handle_user_exception
    reraise(exc_type, exc_value, tb)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/_compat.py", line 33, in reraise
    raise value
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1612, in full_dispatch_request
    rv = self.dispatch_request()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1598, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/api/main.py", line 63, in tickers
    get_documents()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/api/main.py", line 23, in get_documents
    return list(cursor)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/cursor.py", line 1176, in next
    if len(self.__data) or self._refresh():
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/cursor.py", line 1070, in _refresh
    self.__session = self.__collection.database.client._ensure_session()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/mongo_client.py", line 1391, in _ensure_session
    return self.start_session(causal_consistency=False)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/mongo_client.py", line 1369, in start_session
    server_session = self._get_server_session()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/mongo_client.py", line 1377, in _get_server_session
    return self._topology.get_server_session()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/topology.py", line 416, in get_server_session
    None)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/topology.py", line 199, in _select_servers_loop
    self._error_message(selector))
pymongo.errors.ServerSelectionTimeoutError: localhost:27017: [Errno 61] Connection refused
127.0.0.1 - - [16/Feb/2018 10:48:03] "GET /tickers HTTP/1.1" 500 -

Jair Israel Avilés Eusebio

student•

Naaa olvidenlo, encontre el problema y es que habia parado el servicio de ejecución de mongo y por eso no se podia conectar al base de datos jejeje

import pymongo #Librería para comunicarse con la bd mongodb
from flask import Flask, jsonify, request #Flask es para levantar un servidor web. jsonify para poder retornar un json como respuesta al cliente. request permite capturar peticiones rest

#Función para crear conexión a la bd
def get_db_connection(uri):
	client = pymongo.MongoClient(uri) #Crear una conexión a la bd
	return client.cryptongo #Devolver bd cryptongo

app = Flask(__name__) #Crear un servidor web a partir del nombre del archivo ejecutado
db_connection = get_db_connection('mongodb://localhost:27017/') #Conexión a la bd

#Función para obtener lista de documentos a devolver
def get_documents():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío
	limit = int(request.args.get('limit', 0)) #Obtengo el campo "limit", recibido por get. Si no existe, devuelve 0, omitiendo limit. Fuerzo conversión a entero

	if name: #Si existe "name"
		params.update({'name': name}) #Lo agrego al diccionario de datos

	cursor = db_connection.tickers.find( #Busco tickers
		params, #, según lo que recibí por get
		{'_id': 0, 'ticker_hash': 0} #Campos omitidos
	).limit(limit)

	return list(cursor) #convertir resultados de bd en una lista y devolverlo como respuesta a la petición

#Función para obtener el top20 de documentos
def get_top20():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío
	limit = int(request.args.get('limit', 0)) #Obtengo el campo "limit", recibido por get. Si no existe, devuelve 0, omitiendo limit. Fuerzo conversión a entero

	if name: #Si existe "name"
		params.update({'name', name}) #Lo agrego al diccionario de datos

	params.update({'rank': {'$lte': 20}}) #Agrego condición para el find, inicando que el campo "rank" debe ser menor o igual a 20

	cursor = db_connection.tickers.find( #Busco tickers
		params, #, según lo que recibí por get
		{'_id': 0, 'ticker_hash': 0} #Campos omitidos
	).limit(limit)

	return list(cursor) #convertir resultados de bd en una lista y devolverlo como respuesta a la petición

#Función para eliminar un documento
def remove_currency():
	params = {} #Defino un diccionario de datos
	name = request.args.get('name', '') #Obtengo el campo "name", recibido por get. Si no existe, devuelve vacío

	if name: #Si existe "name"
		params.update({'name': name}) #Lo agrego al diccionario de datos
	else:
		return False

	return db_connection.tickers.delete_many( #Borro todos los documentos que coincidan con el dato recibido por get
		params
	).deleted_count #Retorna la cantidad de documentos borrados

@app.route("/") #Defino la ruta raíz para recibir peticiones
def index(): #Cuando alguien pida esta ruta, se ejecutará esta función
	return jsonify( #Retornará una respuesta en formato json
		{
			'name': 'Cryptongo API'
		}
	)

@app.route("/top20", methods=['GET']) #Defino ruta GET para top20
def top20(): #Se ejecutará esta función cuando alguien entre a esa ruta
	return jsonify(get_top20()) #Devuelvo un json con la lista de top20

@app.route("/tickers", methods=['GET', 'DELETE']) #Defino ruta para obtener o eliminar tickers, recibiendo petición por GET o DELETE
def tickers(): #Con la ruta, se ejecuta esta función
	if request.method == "GET": #Si el método consultado por la ruta, es GET
		return jsonify(get_documents()) #Devuelve un json con el resultado de tickers, según parámetros por get (Puede ser sin parámetros)
	elif request.method == "DELETE": #En cambio, si el método consultado es por DELETE
		result = remove_currency() #Se borran los tickers que coincidan con los parámetros recibidos por get (Los parámetros son obligatorios)
		if result > 0:
			return jsonify({ #Retornar un json con la respuesta
				'text': 'Documentos eliminados'
			}), 204 #Flask permite agregar otro parámetro al return, indicando el código de respuesta, en este caso, un "No hay contenido" (común en los borrados de datos)
		else:
			return jsonify({ #Retornar un json con la respuesta
				'error': 'No se encontraron documentos'
			}), 404 #Flask permite agregar otro parámetro al return, indicando el código de respuesta, en este caso, un "No encontrado"```

from werkzeug.exceptions import BadRequest

from agent import main as agent

@app.route('/tickers', methods=['POST'])
def add_currency():
    try:
        data_request = request.get_json()

        if agent.save_ticker(db_connection, data_request):
            message = 'Documento almacenado exitosamente'
            return jsonify(message=message), 200
        else:
            error = 'El documento ya existe'
            return jsonify(error=error), 400
    except BadRequest:
        error = 'No se envío información en el body'
        return jsonify(error=error), 400

FLASK_APP=main.py flask run
 * Serving Flask app "main"
 * Running on http://127.0.0.1:5000/ (Press CTRL+C to quit)
127.0.0.1 - - [16/Feb/2018 10:47:29] "GET / HTTP/1.1" 200 -
[2018-02-16 10:48:03,626] ERROR in app: Exception on /tickers [GET]
Traceback (most recent call last):
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1982, in wsgi_app
    response = self.full_dispatch_request()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1614, in full_dispatch_request
    rv = self.handle_user_exception(e)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1517, in handle_user_exception
    reraise(exc_type, exc_value, tb)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/_compat.py", line 33, in reraise
    raise value
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1612, in full_dispatch_request
    rv = self.dispatch_request()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/flask/app.py", line 1598, in dispatch_request
    return self.view_functions[rule.endpoint](**req.view_args)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/api/main.py", line 63, in tickers
    get_documents()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/api/main.py", line 23, in get_documents
    return list(cursor)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/cursor.py", line 1176, in next
    if len(self.__data) or self._refresh():
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/cursor.py", line 1070, in _refresh
    self.__session = self.__collection.database.client._ensure_session()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/mongo_client.py", line 1391, in _ensure_session
    return self.start_session(causal_consistency=False)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/mongo_client.py", line 1369, in start_session
    server_session = self._get_server_session()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/mongo_client.py", line 1377, in _get_server_session
    return self._topology.get_server_session()
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/topology.py", line 416, in get_server_session
    None)
  File "/Users/Jair-MAC/Documents/Proyectos/cryptongo/venv/lib/python3.6/site-packages/pymongo/topology.py", line 199, in _select_servers_loop
    self._error_message(selector))
pymongo.errors.ServerSelectionTimeoutError: localhost:27017: [Errno 61] Connection refused
127.0.0.1 - - [16/Feb/2018 10:48:03] "GET /tickers HTTP/1.1" 500 -

Endpoint /tickers para ver todos los documentos en cryptongo

¡Espera pronto la actualización de este curso!

¡Nos estamos renovando!

Introducción al Curso de MongoDB y Redis

Bienvenidos al Curso de MongoDB y Redis

¿Qué es NoSQL?

Implementaciónes de bases de datos no relacionales - NoSQL

Ventajas y desventajas de NoSQL

Diferencias con SQL

Introducción a Cryptongo

MongoDB

Primeros pasos con MongoDB

Instalación de MongoDB en Linux

Instalación de MongoDB en Windows

Instalación de MongoDB en Mac

Modelado de datos en MongoDB relaciones uno a uno y uno a muchos

Modelado de datos tipo árbol

Creando el modelo de datos de Cryptongo

Librerías de MongoDB - PyMongo 1

Librerías de MongoDB - PyMongo 1 instalación de pymongo de acuerdo con el sistema operativo.

Introducción a la Shell de Mongo

Ejecución de código JS en la shell de MongoDB

Operaciones CRUD en MongoDB

Insertar un documento con la consola de Mongo

Insertar multiples documentos con la consola de Mongo

Funciones find y findOne

Operaciones avanzadas con find y findOne en la consola

Modificación de documentos en la consola de MongoDB

Funciones de Mongo updateOne - updateMany

Eliminar documentos en la consola de MongoDB

Indices en MongoDB

Desarrollo del proyecto Cryptongo

Estructura del proyecto Cryptongo

Librerías que usaremos en Cryptongo y cómo instalarlas

Cómo funciona el agente que consulta Coinmarketcap

Creando el agente que consulta en Coinmarketcap

Calcular el hash a partir de la información del ticker en Cryptongo

Guardar la información obtenida por el agente

Crear API que consulta la base de datos get_documents()

Funciones get_top20() y remove_currency()

Creación del Endpoint de Cryptongo

Endpoint /tickers para ver todos los documentos en cryptongo

Publicación de Cryptongo con Docker

Redis

Primeros pasos con Redis

Instalación de Redis en Ubuntu Linux

Instalación de Redis en Windows

Instalación de Redis en Mac

Consola Interactiva de Redis - Redis CLI

Insertar y leer datos en Redis

Eliminar datos en Redis

Full page cache con Redis

SetEx, cómo guardar un registro que tenga una fecha de vencimiento.

FLUSHDB, FLUSHALL, cómo eliminar una BD o todas las BD.

Cierre del curso