Procesador de Pagos con Principios SOLID y Stripe

Clase 3 de 27 • Curso de Patrones de Diseño y SOLID en Python

Resumen

Construir un procesador de pagos es un desafío común en la industria del desarrollo de software, y en este curso lo haremos aplicando los principios SOLID y patrones de diseño. El código inicial será básico y lo iremos refactorizando para ajustarlo a buenas prácticas a medida que avanzamos.

¿Cómo funciona el código inicial?

El código comienza con una clase simple que tiene un único método llamado processTransaction. Este método recibe dos parámetros: customerData y paymentData. Dentro de este método, se llevan a cabo tres validaciones básicas:

Verificación de que el cliente tiene nombre.
Verificación de que tiene información de contacto.
Comprobación de que tiene una fuente de pago válida.

¿Cómo se realiza el procesamiento del pago?

El procesamiento del pago se gestiona a través de la integración con Stripe. Utilizamos la clave API de Stripe, que se almacena en las variables de entorno, y creamos un cargo basado en la cantidad y los datos proporcionados. El método maneja cualquier error con un bloque try-except, enviando una notificación si el pago falla.

¿Cómo se notifican los resultados?

El código incluye mecanismos para notificar al cliente por correo electrónico o mensaje de texto. Sin embargo, dado que no hay un servidor SMTP configurado, se usan ejemplos comentados para ilustrar cómo sería el envío de correos. En el caso de mensajes de texto, se utiliza un mock que simula una pasarela de envío de SMS.

¿Cómo se registra la información de la transacción?

Finalmente, el método guarda los detalles de la transacción en un archivo transactions.log. Este archivo contiene información como el nombre del cliente, el monto cobrado y el estado final del pago. Estos registros son útiles para futuras consultas y auditorías.

¿Qué modificaciones se pueden hacer al procesador?

El código es flexible, y podemos modificar la información del cliente y del pago para probar diferentes escenarios. Por ejemplo, podemos cambiar el nombre del cliente, la cantidad a cobrar y el método de pago, incluyendo el uso de tokens de tarjetas en lugar de números de tarjeta. Stripe proporciona varios tokens y números de prueba que pueden ser utilizados para simular transacciones en diferentes condiciones.

¿Qué papel juegan las variables de entorno?

Una parte esencial del código es la configuración de las variables de entorno, que se manejan mediante el módulo .env de Python. Este módulo carga la clave API de Stripe desde el archivo .env, lo que asegura que la clave esté protegida y accesible solo durante la ejecución del programa.

Jhon Jairo Bautista Beltrán

student•

¡Alert!

Creen el entorno virtual python3 -m venv .venv, es importante para que sea más eficiente si trabajamos en windows tener WSL2 Instalado.
Instalar las dependencias pip install stripe pip install python-dotenv que pide el archivo initial_code.py
Descargar el archivo initial_code.py que se tiene en la sección de recursos o archivos de clases

Ronaldo Jiménez

student•

Crear el archivo .env con la variable de entorno STRIPE_API_KEY="tu-api-key-de-prueba"

Dicha api-key se obtiene al registrarse en: https://dashboard.stripe.com/test/apikeys

Nicolás Moreno

student•

Al hacer un curso es muy molesto copiar y pegar código sin contexto. ¿Qué es stripe? ¿Por qué lo usamos? ¿Para qué lo usamos? ¿Cómo funciona?

Pablo Ortiz

student•

Hola Nicolas, tengo el error import stripe

ModuleNotFoundError: No module named 'stripe'

Sabes como solucionarlo

Claudio Piña

student•

Pablo, no lo he hecho pero asumo que tienes que instalarlo antes, con "pip install stripe" imagino. Antes intenta crear un ambiente virtual

Bryan Castano

student•

Heyy Chicos... tal vez el Proffe fue muy rapido y omitio algunas cossas que por lo cual del curso El considera por defecto ya conocidos.\n esto es por hacwrse antes :\n

Descarga el formato comprimido .zip y extraeelor en algun lugar de tu /home directory.
Ir al directorio donde se descomprimio el archivo.: cd ~/Documents/path_to_Code \n
Crear un Ambiente Virtual : Python -m venv "VirtualEnv_Name" .
Activar el Ambiente Virtual : sources myEnv/bin/activate .
Instalar Stripe and dotEnv : pip install stripe \npip install python-dotenv \n.
Crear Cuenta en <u>Stripe : </u><u>https://docs.stripe.com/api/secret_management</u>

Julio Sarango

student•

Si desean trabajar con uv, y se descargan todo el código, estos son los pasos para instalar todas las dependencias:

```
# Instalación de uv
curl -LsSf https://astral.sh/uv/install.sh | sh

# Creación del ambiente virtual
uv venv

# Activación del ambiente virtual
source .venv/bin/activate

# Instalación de dependencias
uv pip install -r pyproject.toml --extra dev
```

Juan Marcelo Panasiti

student•

Veo que en el código haces imports dentro de la función. Es correcto hacer esto? o más adelante se refactorizará?

Julio Sarango

student•

Justamente lo que ha dicho el profesor es que el código inicial viola intencionalmente todos los principios y a lo largo del curso se refactorizará con los principios SOLID

Mariano Gobea Alcoba

student•

Buenas a todos/as!

Les dejo mi repo a todos y todas donde podrán encontrar como plus a lo que vimos con el instructor:

Una implementación completa para utilizar un gmail y enviar el email de verdad
Una implementación completa de twilio para enviar SMS de verdad frente a cada pago

Espero les sea de utilidad. Se agredece feedback.

Link: https://github.com/Mgobeaalcoba/design_patterns_in_python

Mariano Gobea Alcoba

student•

El link quedó roto. Va de nuevo aquí: https://github.com/Mgobeaalcoba/design_patterns_in_python

Jonnathan Mackey Martínez Robledo

student•

Dejo por aquí mi aporte.

Cuando ya tenga el proyecto y la cuenta de stripe creada (No necesitan agregar datos como empresa, simplemente se van luego de confirmar la cuenta al correo al dashboard) para obtener la clave secreta se van a: - Sección Desarrolladores (sección izquierda) - API Keys - La que usaran será la clave secreta (uso de backend)

Luego de tener la clave secreta dentro de la raíz del proyecto en vs code crean un archivo .env, allí crean la variable de entorno:

STRIPE_API_KEY=

Allí ponen la clave secreta y guardan.

Jéimar de Jesús Arias Vélez

student•

Otro tema:

El profesor dice que hay un paso a paso de como crear la cuenta en stripe pero no lo vi por ningun lado. Solo proveen el enlace a la documentación del API y ahí está el getting start. No se si tengan una cuenta solo para el uso del curso, así no tendríamos que crear cuentas personales.

German Prieto

student•

Los pasos para stripe:

Crea la cuenta en USA
Verifica la cuenta en el correo
No es necesario ingresar datos de pagos y empresa, ya que por default la cuenta tiene un ambiente de test que sirve para ejecutar la app
En la parte inferior (como un footer) del dashboard en stripe tenemos el Developer Workbench.
Abres el Developer Workbench y haces click en "Manage API keys"
Para este ejemplo utilizas el "Secret Key" en el archivo .env

Jéimar de Jesús Arias Vélez

student•

Al crear la cuenta en stripe:

1) no está Colombia en la lista de paises. Seleccioné USA

2) Está pidiendo mucha información como si uno fuera una empresa. Eso no me gustó.

3) La verdad no se como empezar a usar la cuenta sin tener que proveer toda esa información?

Jhon Ferney Soto Balanta

student•

No es necesario agregar datos de empresa, te registrar y listo, ya con eso teja usar la apikey de pruebas, los demás datos son para usar una apikey de producción, no son necesarios en este caso.

Claudio Piña

student•

podrían dejar en la sección de recursos, solo el codigo inicial, para hacer mas rapida la carga del codigo, lo otro o lo suben por cada clase o lo dejan para el final, pero me costó encontrar el codigo inicial, a pesar del nombre :D

Cesar Augusto Mora Castilo

student•

El código base esta en la clase 2.

Se descarga, se descomprime, se entra al directorio y luego de instalar uv, (https://github.com/astral-sh/uv) se usa el comando:

$ uv sync

Este crea todo el entorno para el proyecto de forma automática.

Solo queda crear la cuenta en stripe para obtener la API KEY de pruebas.

Se crea el archivo .env (no olvidar el punto, es un archivo oculto), con la variable STRIPE_API_KEY.

Y ya se puede ejecutar el código base desde vs code o desde la terminal.

Oscar Puentes

student•

Personas que hasta ahora estan aprendiendo, les recomiendo ver algun tutorial sobre stripe, si no quedaran super perdidas así como me pasó a mi. investiguen sonbre dotenv y os

adjunto mi codigo con una pequeña modificación puesto que el metodo Stripe.charge ya es considerado obsoleto

import os
from dotenv import load_dotenv
import stripe
from stripe import StripeError
from email.mime.text import MIMEText

load_dotenv()
STRIPE_SECRET_KEY = os.getenv('STRIPE_SECRET_KEY')
stripe.api_key = STRIPE_SECRET_KEY

class PaymentProcessor:
    def process_transaction(self,costumer_data,payment_data):
        if not costumer_data.get('name'):
            print(f"Ivalid Costumer data: missing name ")
            return
        if not costumer_data.get('contact_info'):
            print(f"Ivalid Costummer data: missing contac info")
        
        if not payment_data.get('source'):
            print(f"Ivalid payment data: missing Source")
        
        print("Validacion exitosa todos los datos son correctos")
    
        payment_intent = None
        try:
            payment_intent = stripe.PaymentIntent.create(
                amount=payment_data['amount'],
                currency='usd',
                payment_method=payment_data['source'],
                confirm=True,
                description=f"Pago de {costumer_data['name']}",
                automatic_payment_methods={
                    'enabled':True,
                    "allow_redirects": 'never'
                }
            )
            print("💰 Pago exitoso con PaymentIntent!")
            print("🧾 ID del pago:", payment_intent.id)
            print("📦 Estado:", payment_intent.status)

        except StripeError as e:
            print('Payment failed',e)

        if "email" in costumer_data["contact_info"]:
            # import smtplib

            msg = MIMEText("Thank you for your payment.")
            msg["Subject"] = "Payment Confirmation"
            msg["From"] = "no-reply@example.com"
            msg["To"] = costumer_data["contact_info"]["email"]

            # server = smtplib.SMTP("localhost")
            # server.send_message(msg)
            # server.quit()
            print("Email sent to", costumer_data["contact_info"]["email"])

        elif "phone" in costumer_data["contact_info"]:
            phone_number = costumer_data["contact_info"]["phone"]
            sms_gateway = "the custom SMS Gateway"
            print(
                f"send the sms using {sms_gateway}: SMS sent to {phone_number}: Thank you for your payment."
            )

        else:
            print("No valid contact information for notification")
            return

        with open("transactions.log", "a") as log_file:
            log_file.write(
                f"{costumer_data['name']} paid {payment_data['amount']}\n"
            )
            if payment_intent:
                log_file.write(f"Payment status: {payment_intent.status}\n")
            else:
                log_file.write("Payment status: failed\n")



if __name__ == '__main__':
    processor = PaymentProcessor()

    customer_data_with_email = {
        "name": "John Doe",
        "contact_info": {"email": "e@mail.com"},
    }
    customer_data_with_phone = {
        "name": "Platzi Python",
        "contact_info": {"phone": "1234567890"},
    }

    payment_data = {"amount": 500, "source": "pm_card_mastercard", "cvv": 123}


    processor.process_transaction(customer_data_with_email, payment_data)

    processor.process_transaction(customer_data_with_phone, payment_data)

edgardo ponce

student•

trate de seguir todas las clases en este repo, se me hizo muy dificil... dividi en branchs y fui dejando teoria en los readme, en cada iteracion al menos fui probando que funcione. https://github.com/guduchango/python-design-patterns-and-solid-principle

Mario Anthonny

student•

el verdadero aprendizaje siempre es de parte de otros estudiantes, gracias

Matías Alejandro Abarca Morales

student•

Para los que quieran usar venv, pip y WSL: Yo después de activar en entorno instale los siguientes paquetes:

pip3 install requests==2.32.2 stripe==10.12.0 dotenv pydantic==2.9.2

Luego cree el archiv .env con la APIKEY que tome desde: https://dashboard.stripe.com/test/apikeys

Corrí el programa desde la raíz con: python3 src/solid_principles/initial_code.py

Y me funciono correcto!

Jéimar de Jesús Arias Vélez

student•

En la creación de la cuenta en stripe, Colombia no está en la lista de paises disponibles. Seleccioné USA como para poder seguir, pero luego pide un número telefónico de USA.

Como lo manejaron?

Jhon Ferney Soto Balanta

student•

No es necesario agregar datos de empresa, te registrar y listo, ya con eso teja usar la apikey de pruebas, los demás datos son para usar una apikey de producción, no son necesarios en este caso.

Jhonatan Estiven Becerra Pedrozo

student•

Que theme de vs usa profe?

Eduardo José Álvarez

Team Platzi•

El tema que utilizo en VSCode se llama Maroon Theme!

https://marketplace.visualstudio.com/items?itemName=KainNhantumbo.maron-themes

Juan Camilo Suarez

student•

¡Hola!

Para que no te pierdas en esta clase, te dejo un tutorial de cómo correr el proyecto:

1. Descarga el .zip de los recursos de clase y crea una carpeta en donde instanciar el proyecto.

2. Crea tu entorno virtual, en mi caso mi S.O es wsl2, es decir un Linux dentro de Windows y yo lo creo con estos comandos, asegúrate de tener los comandos para tu S.O:


python3 -m venv env

\# activa tu entorno con el siguiente comando:

source env/bin/activate

3. Descarga las librerías:


pip install stripe python-dotenv

4. Crea tu cuenta en Stripe: dirígete al siguiente link y crea una cuenta. Yo vivo en Colombia pero le puse México.

5. Obtén tu API key: dirígete al siguiente link para obtener tu API key. Debes elegir tu llave secreta y copiarla.

6. En la raíz de tu directorio/carpeta, crea un archivo y ponle de nombre .env. Allí debes pegar la API key secreta que copiaste del paso anterior.

7. Ejecuta el proyecto :D

Diego Castro

student•

El error "ModuleNotFoundError: No module named 'stripe.error'" indica que la biblioteca de Stripe no está instalada o no se encuentra en el entorno Python en el que estás trabajando. Para resolverlo, asegúrate de seguir estos pasos:

Verifica que tengas instalada la biblioteca Stripe. Puedes hacerlo ejecutando el siguiente comando en tu terminal:
```
pip install stripe
```
Si ya está instalada y aún tienes problemas, asegúrate de que estás ejecutando tu código en el entorno Python correcto. A veces, se puede tener múltiples entornos y la biblioteca podría no estar instalada en el que estás usando.
Revisa si hay algún error en la ruta de importación. El código debería ser así:
```
from stripe.error import StripeError
```

Después de realizar estos pasos, intenta ejecutar nuevamente tu código.

David Agudelo

student•

Recomendaciones:

Descarguen el zip y descomprimanlo en WSL2
2. creen un entorno virtual: python3 -m venv venv 3. Activen el Venv : source venv/bin/activate 4. instalen Stripe y DotEnv: pip install stripe pip install python-dotenv 5. creen cuenta en stripe y obtengan sus credenciales: https://dashboard.stripe.com/login 6. copien los tokens
7. crea un archivo con nombre ".env" : allí pegarás tus tokens del paso 6

Daniel Buitrago

student•

En vez de tener un archivo transactions.log, deberíamos utilizar la librería logger por practicidad.

Bryan Garcia

student•

IMPORTANTE: Stripe ha deprecado el modelo Charge de su API y actualmente no recomienda usarlo. A mi me generó un par de errores y si les sucede eso, les recomiendo utilizar el más actual llamado PaymentIntent https://docs.stripe.com/api/payment_intents/create?lang=python

Solo tienes que sustituir esto la línea 27 del archivo ./src/solid_principles/initial_code.py

charge = stripe.PaymentIntent.create(
                amount=payment_data["amount"],
                currency="usd",
                automatic_payment_methods={"enabled": True},
                description="Charge for " + customer_data["name"],
            )