rustedf.cloud
Menu

Como gerar PDF a partir de HTML em Ruby on Rails

Publicado em 2 min de leitura

No Rails, transformar HTML em PDF costuma significar adicionar uma gem que envolve um binário de renderização, e depois instalar esse binário e mantê-lo funcionando no desenvolvimento, no CI e em produção. Com uma API, é uma requisição HTTP, e a biblioteca padrão do Ruby já a faz. Este guia mostra uma classe pequena e um controller que envia o arquivo, com a API do rustedf.cloud.

Uma classe pequena no Net::HTTP

app/services/rustedf_pdf.rb
require "net/http"
require "json"
class RustedfPdf
class Error < StandardError; end
ENDPOINT = URI("https://api.rustedf.com/v1/render")
def self.render(template_id:, data:, locale: "pt-BR")
request = Net::HTTP::Post.new(
ENDPOINT,
"Authorization" => "Bearer #{Rails.application.credentials.dig(:rustedf, :key)}",
"Content-Type" => "application/json"
)
request.body = { template_id: template_id, locale: locale, data: data }.to_json
response = Net::HTTP.start(ENDPOINT.host, ENDPOINT.port, use_ssl: true, read_timeout: 40) do |http|
http.request(request)
end
return response.body if response.is_a?(Net::HTTPSuccess)
raise Error, error_message(response)
end
def self.error_message(response)
JSON.parse(response.body).dig("error", "message") || "Falha ao gerar (#{response.code})"
rescue JSON::ParserError
"Falha ao gerar (#{response.code})"
end
end

Uma resposta bem-sucedida é o próprio PDF, então response.body é o arquivo. Em uma falha, o corpo é um JSON com um code estável e uma message.

Guarde a chave nas credenciais criptografadas (bin/rails credentials:edit) ou em uma variável de ambiente, nunca em uma view nem no navegador. Defina o tempo limite de leitura acima do limite do seu plano, para que a sua requisição não desista antes do serviço.

Um controller que envia o PDF

app/controllers/faturas_controller.rb
class FaturasController < ApplicationController
def show
fatura = Fatura.find_by!(numero: params[:numero])
pdf = RustedfPdf.render(
template_id: Rails.configuration.x.rustedf_invoice_template,
locale: "pt-BR",
data: {
number: fatura.numero,
customer: { name: fatura.cliente.nome },
total: fatura.total.to_s
}
)
send_data pdf, type: "application/pdf", disposition: "inline",
filename: "fatura-#{fatura.numero}.pdf"
rescue RustedfPdf::Error => error
Rails.logger.error(error.message)
head :bad_gateway
end
end
config/routes.rb
get "faturas/:numero", to: "faturas#show", constraints: { numero: /[\w-]+/ }

Para enviar HTML em vez do id de um template salvo, use html: no lugar de template_id:. Passe tudo o que um usuário digitou por data, e não dentro da string de HTML: os valores em data são escapados, e o próprio HTML é lido como um template. Se você renderiza uma view para uma string antes, lembre-se de que o resultado volta a ser tratado como template.

Tentar de novo quando o serviço está ocupado

Um 429 (limite de requisições) ou um 503 (ocupado) traz um cabeçalho Retry-After. Uma geração que falha não custa crédito, então tentar de novo é seguro: leia response["Retry-After"], use sleep por esse número de segundos e envie a requisição de novo, um número limitado de vezes. Para um trabalho que não precisa responder ao navegador na hora, rode a chamada em um job em segundo plano e tente de novo lá.

Erros que vale tratar

Status code O que fazer
401 unauthorized A chave está ausente, errada ou revogada.
402 insufficient_credits Os créditos acabaram. Nada foi gerado.
422 invalid_template O template ou os dados falharam. Leia a message.
429 rate_limited Espere o Retry-After e tente de novo.
503 busy O serviço está ocupado. Espere o Retry-After e tente de novo.
504 render_timeout O documento levou mais do que o seu plano permite.

Rode POST /v1/validate com o mesmo corpo enquanto monta o template: ele lista tudo o que o serviço não suportou por completo, sem devolver o PDF nem usar crédito.

Leia Gerar um PDF, Autenticação e Erros e limites.

  • Código e integrações

    Gerar PDF no ASP.NET Core: MVC, Razor Pages e minimal APIs

    Transforme uma view Razor em PDF no ASP.NET Core com uma chamada de API: renderizador de views, view pronta para impressão, action MVC e handler do Razor Pages.

    3 min de leitura

  • Código e integrações

    Converter página web em PDF em C# sem navegador headless

    Busque uma página com HttpClient e transforme o HTML em PDF com uma chamada de API em C#. Quais páginas isso atende, quais não e como conferir antes de depender.

    3 min de leitura

  • Código e integrações

    Gerador de relatório PDF em C#: tabela paginada com totais

    Monte um relatório em PDF em C# a partir de uma lista de objetos: tabela com cabeçalho repetido em cada página, total, número de página e contagem de páginas.

    3 min de leitura

← Todos os posts