Manejo eficiente de Webhooks con Ruby on Rails

Published at Sun, Jun 03, 18

• webhooks
• ruby
• rails
• ror

Cuando implementas sistemas de pagos como Paypal o Stripe, la parte más tediosa de implementar son los webhooks. En este post te explicaré de que forma puedes optimizar la implementación de tu webhook de forma limpia y ordenada.

¿Para qué sirven los Webhooks?

Los webhooks son endpoints en tu aplicación por el cuál un servicio como Paypal o Stripe te informarán sobre los eventos que ocurran dentro. Paypal y Stripe los usan para avisar sobre si un cargo fue exitoso o falló por ejemplo. Este mecanismo es necesario ya que los procesos de cargos, creación o cancelación de pagos se hacen de forma asincróna de nuestra aplicación. Es decir, en el momento que creamos un cargo a traves de la API no sabremos hasta en un futuro si el cargo fue exitoso o no.

Implementación estandard

El webhook es un solo endpoint (ruta) que recibe información mediante el método POST de HTTP. En ruby on rails una implementación de Webhook de Stripe podría ser la siguiente:

# controllers/stripe_controller.rb
# Method responsbile for handling stripe webhooks
def webhook
  begin
    event = JSON.parse(request.body.read)
    case event['type']
      when 'invoice.payment_succeeded'
        # handle success invoice event
      when 'invoice.payment_failed'
        # handle failure invoice event
      # More events...
    end
  rescue Exception => ex
    render :json => {:status => 400, :error => "Webhook failed"} and return
  end
  render :json => {:status => 200}
end

Este método webhook hace uso de un switch-case para poder determinar, a través del tipo de evento que se ha recibido, cuál será el bloque de código a ejecutar. Ahora imagina implementar más eventos, este método se volvería muy sucio y difícil de mantener.

Claro que podemos hacer más métodos para colocar la lógica de cada evento e invocar estos métodos dentro del switch-case, sin embargo aún podemos mejorar el método de webhook.

Implementación Limpia

La implementación más limpia que he visto sobre este tema de webhooks es de Cashier de Laravel. El controlador de webhook de Cashier permite manejar los eventos del webhook de forma automática mapeando cada evento a un método. La convención del controlador dice que si quieres manejar el evento invoice.payment_succeeded, entonces crea un método en el controlador cuyo nombre empiece por handle y la forma en camelCase del tipo de evento: handleInvoicePaymentSucceeded.

<?php

namespace App\Http\Controllers;

use Laravel\Cashier\Http\Controllers\WebhookController as CashierController;

class WebhookController extends CashierController
{
    /**
     * Handle a Stripe webhook.
     *
     * @param  array  $payload
     * @return Response
     */
    public function handleInvoicePaymentSucceeded($payload)
    {
        // Handle The Event
    }
}

Refactoring

¿Cómo podríamos conseguir lo mismo con Rails?. Es sencillo gracias a la metaprogramación en Ruby. La implementación refactorizando el método anterior sería más o menos así:

def webhook
  begin
    event = JSON.parse(request.body.read)
    method = "handle_" + event['type'].tr('.', '_')
    self.send method, event
  rescue JSON::ParserError => e
    render json: {:status => 400, :error => "Invalid payload"} and return
  rescue NoMethodError => e
    # missing event handler
  end
  render json: {:status => 200}
end

def handle_invoice_payment_succeeded(event)
  #handle the event
end

def handle_invoice_payment_failed(event)
  #handle the event
end

# and more...

En el método del webhook debemos convertir el tipo de evento al nombre del método que se encargara de manejar ese evento específicamente.

1. Convertimos los '.' por '_' y concatenamos con "handle_".
2. Lo siguiente es pasar el mensaje de invocar el método resultante con el payload obtenido.
3. Posteriormente, si no existe un método implementado para un evento entraría en el rescue NoMethodError => e donde podemos realizar otra acción en su caso.

La implementación de Laravel Cashier para manejar los eventos de Stripe me pareció increible. Por lo tanto de esta forma obtendrás un controlador mantenible y limpio.

ProTip:

Como siguiente paso podrías implementar concerns para agrupar en modulos los eventos que necesites manejar. Así mantienes el controlador del webhook ligero.