boleto_bancario 0.0.2 → 1.0.0

data/lib/boleto_bancario/core/nubank.rb

@@ -0,0 +1,156 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Core
+    # Implementação de emissão de boleto bancário pelo Nubank.
+    #
+    # === Documentação Implementada
+    #
+    # A documentação na qual essa implementação foi baseada está localizada na pasta
+    # 'documentacoes_dos_boletos/nubank' dentro dessa biblioteca.
+    #
+    # === Contrato das classes de emissão de boletos
+    #
+    # Para ver o "<b>contrato</b>" da Emissão de Boletos veja a classe BoletoBancario::Core::Boleto.
+    #
+    # === Carteiras suportadas
+    #
+    # O Nubank trabalha com carteira única de cobrança registrada.
+    #
+    #      ___________________________________________________________________________
+    #     | Carteira | Descrição                           | Testada/Homologada     |
+    #     |    1     | Cobrança Registrada                 | Esperando Contribuição |
+    #     ----------------------------------------------------------------------------
+    #
+    class Nubank < Boleto
+      # Tamanho máximo de uma conta corrente no Nubank.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_conta_corrente
+        10
+      end
+
+      # Tamanho máximo de uma agência no Nubank.
+      # Nubank utiliza agência fixa 0001.
+      #
+      # @return [Integer] 4
+      #
+      def self.tamanho_maximo_agencia
+        4
+      end
+
+      # Tamanho máximo do número do documento.
+      #
+      # @return [Integer] 11
+      #
+      def self.tamanho_maximo_numero_documento
+        11
+      end
+
+      # Tamanho máximo do código do cedente.
+      #
+      # @return [Integer] 10
+      #
+      def self.tamanho_maximo_codigo_cedente
+        10
+      end
+
+      # Carteiras suportadas pelo Nubank.
+      #
+      # @return [Array]
+      #
+      def self.carteiras_suportadas
+        %w[1]
+      end
+
+      validates :agencia, :conta_corrente, presence: true
+      validates :numero_documento, length: { maximum: tamanho_maximo_numero_documento }, if: :deve_validar_numero_documento?
+      validates :conta_corrente, length: { maximum: tamanho_maximo_conta_corrente }, if: :deve_validar_conta_corrente?
+      validates :agencia, length: { maximum: tamanho_maximo_agencia }, if: :deve_validar_agencia?
+      validates :carteira, inclusion: { in: ->(object) { object.class.carteiras_suportadas } }, if: :deve_validar_carteira?
+
+      # @return [String] Número do documento com 11 dígitos.
+      #
+      def numero_documento
+        @numero_documento.to_s.rjust(11, '0') if @numero_documento.present?
+      end
+
+      # @return [String] Agência com 4 dígitos.
+      #
+      def agencia
+        @agencia.to_s.rjust(4, '0') if @agencia.present?
+      end
+
+      # @return [String] Conta corrente com 10 dígitos.
+      #
+      def conta_corrente
+        @conta_corrente.to_s.rjust(10, '0') if @conta_corrente.present?
+      end
+
+      # @return [String] Código do cedente com 10 dígitos.
+      #
+      def codigo_cedente
+        @codigo_cedente.to_s.rjust(10, '0') if @codigo_cedente.present?
+      end
+
+      # Código do Banco Nubank.
+      #
+      # @return [String] '260'
+      #
+      def codigo_banco
+        '260'
+      end
+
+      # Dígito do código do banco.
+      #
+      # @return [String] '0'
+      #
+      def digito_codigo_banco
+        '0'
+      end
+
+      # Dígito verificador da conta corrente.
+      #
+      # @return [String]
+      #
+      def digito_conta_corrente
+        Modulo10.new(conta_corrente.to_s)
+      end
+
+      # Agência e código do cedente formatados.
+      #
+      # @return [String]
+      #
+      def agencia_codigo_cedente
+        "#{agencia} / #{conta_corrente}-#{digito_conta_corrente}"
+      end
+
+      # Nosso Número formatado.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        "#{carteira}/#{numero_documento}-#{digito_nosso_numero}"
+      end
+
+      # Dígito verificador do nosso número.
+      #
+      # @return [String]
+      #
+      def digito_nosso_numero
+        Modulo10.new("#{carteira}#{numero_documento}")
+      end
+
+      # Segunda parte do código de barras (campo livre).
+      # 25 posições específicas do Nubank.
+      #
+      # @return [String]
+      #
+      def codigo_de_barras_do_banco
+        codigo = "#{carteira.to_s.rjust(1, '0')}#{numero_documento}#{agencia}#{conta_corrente.to_s[0, 9]}"
+        "#{codigo.ljust(25, '0')}"
+      end
+    end
+  end
+end

data/lib/boleto_bancario/locales/pt-BR.yml

@@ -0,0 +1,55 @@
+pt-BR:
+  boleto_bancario:
+    labels:
+      cedente: "Cedente"
+      sacado: "Sacado"
+      nosso_numero: "Nosso Número"
+      numero_documento: "Número do Documento"
+      data_vencimento: "Data de Vencimento"
+      valor_documento: "Valor do Documento"
+      agencia_cedente: "Agência/Código Cedente"
+      especie: "Espécie"
+      especie_documento: "Espécie Doc."
+      aceite: "Aceite"
+      data_documento: "Data do Documento"
+      carteira: "Carteira"
+      instrucoes: "Instruções"
+      local_pagamento: "Local de Pagamento"
+      linha_digitavel: "Linha Digitável"
+      codigo_banco: "Código do Banco"
+      documento_cedente: "CPF/CNPJ Cedente"
+      documento_sacado: "CPF/CNPJ Sacado"
+      endereco_cedente: "Endereço Cedente"
+      endereco_sacado: "Endereço Sacado"
+      conta_corrente: "Conta Corrente"
+      agencia: "Agência"
+      codigo_cedente: "Código do Cedente"
+
+    errors:
+      messages:
+        carteira_invalida: "carteira inválida"
+        agencia_invalida: "agência inválida"
+        conta_corrente_invalida: "conta corrente inválida"
+        valor_documento_invalido: "valor do documento inválido"
+        numero_documento_invalido: "número do documento inválido"
+        codigo_cedente_invalido: "código do cedente inválido"
+        documento_invalido: "documento inválido (CPF/CNPJ)"
+        data_vencimento_invalida: "data de vencimento inválida"
+
+    banks:
+      banco_brasil: "Banco do Brasil"
+      bradesco: "Bradesco"
+      itau: "Itaú"
+      santander: "Santander"
+      caixa: "Caixa Econômica Federal"
+      banrisul: "Banrisul"
+      sicoob: "Sicoob"
+      sicredi: "Sicredi"
+      nubank: "Nubank"
+      inter: "Banco Inter"
+      c6_bank: "C6 Bank"
+
+    defaults:
+      local_pagamento: "PAGÁVEL EM QUALQUER BANCO ATÉ O VENCIMENTO"
+      especie_documento: "DM"
+      especie: "R$"

data/lib/boleto_bancario/renderers/base.rb

@@ -0,0 +1,154 @@
+# frozen_string_literal: true
+
+require 'erb'
+
+module BoletoBancario
+  module Renderers
+    # Classe base para renderizadores de boletos.
+    #
+    # Esta classe fornece a interface comum para todos os renderizadores
+    # (PDF, HTML, PNG).
+    #
+    # @abstract Subclasses devem implementar o método #render
+    #
+    class Base
+      attr_reader :boleto
+
+      class << self
+        # Caminho customizado para templates ERB.
+        # Se não definido, usa o caminho padrão dos templates bundled.
+        #
+        # @return [String, nil]
+        #
+        attr_accessor :template_path
+      end
+
+      # Inicializa o renderizador com um boleto.
+      #
+      # @param [BoletoBancario::Core::Boleto] boleto O boleto a ser renderizado
+      # @raise [ArgumentError] Se o boleto não for válido
+      #
+      def initialize(boleto)
+        raise ArgumentError, 'Boleto deve ser válido' unless boleto.valid?
+
+        @boleto = boleto
+      end
+
+      # Renderiza o boleto.
+      #
+      # @abstract Subclasses devem implementar este método
+      # @raise [NotImplementedError]
+      #
+      def render
+        raise NotImplementedError, "#{self.class} deve implementar #render"
+      end
+
+      # Retorna o partial path para integração com Rails.
+      #
+      # @return [String]
+      #
+      def to_partial_path
+        boleto.to_partial_path
+      end
+
+      protected
+
+      # Retorna o caminho para os templates.
+      # Usa o template_path da classe se definido, caso contrário usa o padrão.
+      #
+      # @return [String]
+      #
+      def template_path
+        self.class.template_path || default_template_path
+      end
+
+      # Retorna o caminho padrão para os templates bundled.
+      #
+      # @return [String]
+      #
+      def default_template_path
+        File.expand_path('../templates', __dir__)
+      end
+
+      # Renderiza um template ERB.
+      #
+      # @param [String] template_name Nome do arquivo de template (ex: 'boleto.html.erb')
+      # @return [String] Conteúdo renderizado
+      #
+      def render_template(template_name)
+        template_file = File.join(template_path, template_name)
+        template_content = File.read(template_file)
+        erb = ERB.new(template_content, trim_mode: '-')
+        erb.result(binding)
+      end
+
+      # Renderiza um partial ERB.
+      #
+      # @param [String] partial_name Nome do partial (sem underscore, ex: 'header')
+      # @return [String] Conteúdo renderizado
+      #
+      def render_partial(partial_name)
+        render_template("_#{partial_name}.html.erb")
+      end
+
+      # Retorna as variáveis locais disponíveis nos templates.
+      #
+      # @return [Hash]
+      #
+      def locals
+        {
+          boleto: boleto,
+          renderer: self
+        }
+      end
+
+      # Retorna o código de barras do boleto.
+      #
+      # @return [String]
+      #
+      def codigo_de_barras
+        boleto.codigo_de_barras
+      end
+
+      # Retorna a linha digitável do boleto.
+      #
+      # @return [String]
+      #
+      def linha_digitavel
+        boleto.linha_digitavel
+      end
+
+      # Retorna o nosso número formatado.
+      #
+      # @return [String]
+      #
+      def nosso_numero
+        boleto.nosso_numero
+      end
+
+      # Retorna o valor formatado.
+      #
+      # @return [String]
+      #
+      def valor_formatado
+        format('%.2f', boleto.valor_documento).tr('.', ',')
+      end
+
+      # Retorna a data de vencimento formatada.
+      #
+      # @return [String]
+      #
+      def data_vencimento_formatada
+        boleto.data_vencimento.strftime('%d/%m/%Y')
+      end
+
+      # Retorna a data do documento formatada.
+      #
+      # @return [String]
+      #
+      def data_documento_formatada
+        boleto.data_documento&.strftime('%d/%m/%Y')
+      end
+    end
+  end
+end

data/lib/boleto_bancario/renderers/html_renderer.rb

@@ -0,0 +1,92 @@
+# frozen_string_literal: true
+
+module BoletoBancario
+  module Renderers
+    # Renderizador de boletos em formato HTML usando templates ERB.
+    #
+    # @example Gerando HTML com template padrão
+    #
+    #    boleto = BoletoBancario::Itau.new(...)
+    #    html_content = BoletoBancario::Renderers::HtmlRenderer.new(boleto).render
+    #
+    # @example Customizando o caminho dos templates
+    #
+    #    class MyHtmlRenderer < BoletoBancario::Renderers::HtmlRenderer
+    #      self.template_path = 'path/to/my/templates'
+    #    end
+    #
+    #    renderer = MyHtmlRenderer.new(boleto)
+    #    html = renderer.render
+    #
+    class HtmlRenderer < Base
+      # Renderiza o boleto em HTML usando template ERB.
+      #
+      # @return [String] O conteúdo HTML do boleto
+      #
+      def render
+        render_template('boleto.html.erb')
+      end
+
+      # Retorna os estilos CSS para o boleto.
+      # Pode ser sobrescrito em subclasses para customização.
+      #
+      # @return [String]
+      #
+      def css_styles
+        css_file = File.join(template_path, 'boleto_styles.css')
+        if File.exist?(css_file)
+          File.read(css_file)
+        else
+          default_css_styles
+        end
+      end
+
+      # Retorna a lista de instruções não vazias.
+      #
+      # @return [Array<String>]
+      #
+      def instructions
+        [
+          boleto.instrucoes1,
+          boleto.instrucoes2,
+          boleto.instrucoes3,
+          boleto.instrucoes4,
+          boleto.instrucoes5,
+          boleto.instrucoes6
+        ].compact.reject(&:empty?)
+      end
+
+      # Retorna o nome do banco formatado.
+      #
+      # @return [String]
+      #
+      def bank_name
+        boleto.class.name.split('::').last
+      end
+
+      private
+
+      def default_css_styles
+        <<~CSS
+          * { margin: 0; padding: 0; box-sizing: border-box; }
+          body { font-family: Arial, sans-serif; font-size: 12px; }
+          .boleto { max-width: 800px; margin: 20px auto; border: 1px solid #000; padding: 15px; }
+          .header { display: flex; justify-content: space-between; border-bottom: 2px solid #000; padding-bottom: 10px; margin-bottom: 10px; }
+          .bank-name { font-size: 18px; font-weight: bold; }
+          .bank-code { font-size: 16px; font-weight: bold; }
+          .linha-digitavel { text-align: center; font-size: 14px; font-weight: bold; margin: 15px 0; letter-spacing: 1px; }
+          .info-row { display: flex; border-bottom: 1px solid #ccc; }
+          .info-cell { flex: 1; padding: 5px; border-right: 1px solid #ccc; }
+          .info-cell:last-child { border-right: none; }
+          .info-cell label { font-size: 10px; color: #666; display: block; }
+          .info-cell span { font-weight: bold; }
+          .instructions { margin: 15px 0; padding: 10px; background: #f9f9f9; }
+          .instructions h4 { margin-bottom: 5px; }
+          .instructions ul { margin-left: 20px; }
+          .barcode { text-align: center; margin: 20px 0; font-family: 'Libre Barcode 128', monospace; font-size: 48px; }
+          .barcode-text { font-size: 10px; margin-top: 5px; }
+        CSS
+      end
+    end
+  end
+end

data/lib/boleto_bancario/renderers/pdf_renderer.rb

@@ -0,0 +1,130 @@
+# frozen_string_literal: true
+
+require 'prawn'
+require 'prawn/table'
+require 'barby'
+require 'barby/barcode/code_25_interleaved'
+require 'barby/outputter/prawn_outputter'
+
+module BoletoBancario
+  module Renderers
+    # Renderizador de boletos em formato PDF usando Prawn.
+    #
+    # @example Gerando um PDF
+    #
+    #    boleto = BoletoBancario::Itau.new(...)
+    #    pdf_content = BoletoBancario::Renderers::PdfRenderer.new(boleto).render
+    #    File.write('boleto.pdf', pdf_content)
+    #
+    class PdfRenderer < Base
+      # Configurações padrão do documento PDF.
+      DEFAULT_OPTIONS = {
+        page_size: 'A4',
+        margin: [20, 20, 20, 20]
+      }.freeze
+
+      # Renderiza o boleto em PDF.
+      #
+      # @return [String] O conteúdo binário do PDF
+      #
+      def render
+        Prawn::Document.new(**DEFAULT_OPTIONS) do |pdf|
+          render_header(pdf)
+          render_bank_info(pdf)
+          pdf.move_down 10
+          render_recipient_info(pdf)
+          pdf.move_down 10
+          render_payment_info(pdf)
+          pdf.move_down 10
+          render_barcode(pdf)
+          pdf.move_down 20
+          render_instructions(pdf)
+          pdf.move_down 30
+          render_tear_line(pdf)
+          pdf.move_down 10
+          render_stub(pdf)
+        end.render
+      end
+
+      private
+
+      def render_header(pdf)
+        pdf.text boleto.class.name.demodulize, size: 14, style: :bold
+        pdf.text "Código do Banco: #{boleto.codigo_banco_formatado}", size: 10
+      end
+
+      def render_bank_info(pdf)
+        pdf.move_down 10
+        pdf.text linha_digitavel, size: 12, style: :bold, align: :center
+      end
+
+      def render_recipient_info(pdf)
+        data = [
+          ['Cedente', boleto.cedente],
+          ['CPF/CNPJ', boleto.documento_cedente],
+          ['Endereço', boleto.endereco_cedente],
+          ['Agência/Código Cedente', boleto.agencia_codigo_cedente]
+        ]
+
+        pdf.table(data, width: pdf.bounds.width) do |t|
+          t.cells.borders = [:bottom]
+          t.cells.padding = [2, 5]
+          t.column(0).font_style = :bold
+          t.column(0).width = 150
+        end
+      end
+
+      def render_payment_info(pdf)
+        data = [
+          ['Data Vencimento', data_vencimento_formatada, 'Valor', "R$ #{valor_formatado}"],
+          ['Nosso Número', nosso_numero, 'Nº Documento', boleto.numero_documento],
+          ['Carteira', boleto.carteira_formatada, 'Espécie', boleto.especie_documento],
+          ['Sacado', boleto.sacado, 'CPF/CNPJ', boleto.documento_sacado]
+        ]
+
+        pdf.table(data, width: pdf.bounds.width) do |t|
+          t.cells.borders = [:bottom]
+          t.cells.padding = [2, 5]
+          t.columns([0, 2]).font_style = :bold
+          t.columns([0, 2]).width = 100
+        end
+      end
+
+      def render_barcode(pdf)
+        barcode = Barby::Code25Interleaved.new(codigo_de_barras)
+        outputter = Barby::PrawnOutputter.new(barcode)
+        outputter.annotate_pdf(pdf, height: 40, x: 0)
+      end
+
+      def render_instructions(pdf)
+        pdf.text 'Instruções:', style: :bold
+        [
+          boleto.instrucoes1,
+          boleto.instrucoes2,
+          boleto.instrucoes3,
+          boleto.instrucoes4,
+          boleto.instrucoes5,
+          boleto.instrucoes6
+        ].compact.each do |instrucao|
+          pdf.text "• #{instrucao}", size: 9
+        end
+      end
+
+      def render_tear_line(pdf)
+        pdf.stroke_horizontal_rule
+        pdf.text 'Corte aqui', size: 8, align: :center
+        pdf.stroke_horizontal_rule
+      end
+
+      def render_stub(pdf)
+        pdf.text 'RECIBO DO SACADO', size: 10, style: :bold
+        pdf.move_down 5
+        pdf.text "Cedente: #{boleto.cedente}", size: 9
+        pdf.text "Sacado: #{boleto.sacado}", size: 9
+        pdf.text "Valor: R$ #{valor_formatado}", size: 9
+        pdf.text "Vencimento: #{data_vencimento_formatada}", size: 9
+        pdf.text "Nosso Número: #{nosso_numero}", size: 9
+      end
+    end
+  end
+end

data/lib/boleto_bancario/renderers/png_renderer.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+require 'barby'
+require 'barby/barcode/code_25_interleaved'
+require 'barby/outputter/png_outputter'
+
+module BoletoBancario
+  module Renderers
+    # Renderizador de código de barras em formato PNG.
+    #
+    # Este renderizador gera apenas a imagem do código de barras,
+    # não o boleto completo.
+    #
+    # @example Gerando um PNG do código de barras
+    #
+    #    boleto = BoletoBancario::Itau.new(...)
+    #    png_content = BoletoBancario::Renderers::PngRenderer.new(boleto).render
+    #    File.binwrite('barcode.png', png_content)
+    #
+    class PngRenderer < Base
+      # Configurações padrão para o PNG.
+      DEFAULT_OPTIONS = {
+        height: 50,
+        xdim: 2,
+        margin: 10
+      }.freeze
+
+      attr_reader :options
+
+      # Inicializa o renderizador com opções.
+      #
+      # @param [BoletoBancario::Core::Boleto] boleto O boleto
+      # @param [Hash] options Opções para o PNG
+      # @option options [Integer] :height Altura da barra (padrão: 50)
+      # @option options [Integer] :xdim Largura de cada módulo (padrão: 2)
+      # @option options [Integer] :margin Margem ao redor (padrão: 10)
+      #
+      def initialize(boleto, options = {})
+        super(boleto)
+        @options = DEFAULT_OPTIONS.merge(options)
+      end
+
+      # Renderiza o código de barras em PNG.
+      #
+      # @return [String] O conteúdo binário do PNG
+      #
+      def render
+        barcode = Barby::Code25Interleaved.new(codigo_de_barras)
+        outputter = Barby::PngOutputter.new(barcode)
+        outputter.height = options[:height]
+        outputter.xdim = options[:xdim]
+        outputter.margin = options[:margin]
+        outputter.to_png
+      end
+
+      # Renderiza e salva o código de barras em um arquivo.
+      #
+      # @param [String] filepath Caminho do arquivo
+      # @return [Integer] Número de bytes escritos
+      #
+      def render_to_file(filepath)
+        File.binwrite(filepath, render)
+      end
+    end
+  end
+end

data/lib/boleto_bancario/templates/_barcode.html.erb

@@ -0,0 +1,3 @@
+<div class="barcode">
+  <div class="barcode-text"><%= codigo_de_barras %></div>
+</div>

data/lib/boleto_bancario/templates/_cedente.html.erb

@@ -0,0 +1,14 @@
+<div class="info-row">
+  <div class="info-cell flex-2">
+    <label>Cedente</label>
+    <span><%= boleto.cedente %></span>
+  </div>
+  <div class="info-cell">
+    <label>CPF/CNPJ</label>
+    <span><%= boleto.documento_cedente %></span>
+  </div>
+  <div class="info-cell">
+    <label>Agencia/Codigo Cedente</label>
+    <span><%= boleto.agencia_codigo_cedente %></span>
+  </div>
+</div>

data/lib/boleto_bancario/templates/_header.html.erb

@@ -0,0 +1,4 @@
+<div class="header">
+  <div class="bank-name"><%= bank_name %></div>
+  <div class="bank-code"><%= boleto.codigo_banco_formatado %></div>
+</div>

data/lib/boleto_bancario/templates/_instructions.html.erb

@@ -0,0 +1,10 @@
+<%- if instructions.any? -%>
+<div class="instructions">
+  <h4>Instrucoes</h4>
+  <ul>
+    <%- instructions.each do |instruction| -%>
+    <li><%= instruction %></li>
+    <%- end -%>
+  </ul>
+</div>
+<%- end -%>