ticketbai 0.1.1

data/lib/ticketbai/documents/issuance.rb

@@ -0,0 +1,55 @@
+module Ticketbai
+  module Documents
+    class Issuance < Document
+      ROOT_NAME = 'T:TicketBai'.freeze
+      XMLNS = {
+        'xmlns:T' => 'urn:ticketbai:emision'
+      }.freeze
+
+      ATTRIBUTES = %i[issuer receiver invoice_header invoice_data breakdown_type invoice_chaining software].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      ###
+      # @param [Ticketbai::Nodes::Isuer] issuer
+      # @param [Ticketbai::Nodes::Receiver] receiver
+      # @param [Ticketbai::Nodes::InvoiceHeader] invoice_header
+      # @param [Ticketbai::Nodes::InvoiceData] invoice_data
+      # @param [Ticketbai::Nodes::BreakdownType] breakdown_type
+      # @param [Ticketbai::Nodes::InvoiceChaining] invoice_chaining
+      # @param [Ticketbai::Nodes::Software] software
+      ###
+      def initialize(**args)
+        super(args)
+      end
+
+      # @return [Nokogiri::XML::Builder]
+      def create
+        builder = Nokogiri::XML::Builder.new(encoding: Encoding::UTF_8.to_s) do |xml|
+          xml.TicketBai(XMLNS) do
+            xml.Cabecera do
+              xml.IDVersionTBAI TBAI_VERSION
+            end
+            xml.Sujetos do
+              @issuer.build_xml(xml)
+              @receiver&.build_xml(xml)
+            end
+            xml.Factura do
+              @invoice_header.build_xml(xml)
+              @invoice_data.build_xml(xml)
+              @breakdown_type.build_xml(xml)
+            end
+            xml.HuellaTBAI do
+              @invoice_chaining&.build_xml(xml)
+              @software.build_xml(xml)
+            end
+          end
+        end
+
+        modify_xml_root_name(builder)
+
+        builder
+      end
+    end
+  end
+end

data/lib/ticketbai/documents/issuance_unsigned.rb

@@ -0,0 +1,58 @@
+module Ticketbai
+  module Documents
+    # This document has the pecualiarity that it does not need to be signed and it must be sent to the API without a root node, so it's not considered
+    # as a valid XML either. The structure of the document is as follows:
+    # <Destinatarios>
+    # ...
+    # ...
+    # </Destinatarios>
+    # <CabeceraFactura>
+    # ...
+    # ...
+    # </CabeceraFactura>
+    # <DatosFactura>
+    #  ...
+    #  ...
+    # </DatosFactura>
+    # <TipoDesglose>
+    # ...
+    # ...
+    # </TipoDesglose>
+    #
+    # The document is created with a temporary root node (TicketBai), and after creating it, it's returned without the root node.
+    class IssuanceUnsigned
+      ###
+      # @param [Ticketbai::Nodes::Receiver] receiver
+      # @param [Ticketbai::Nodes::InvoiceHeader] invoice_header
+      # @param [Ticketbai::Nodes::InvoiceData] invoice_data
+      # @param [Ticketbai::Nodes::BreakdownType] breakdown_type
+      ###
+      def initialize(**args)
+        @receiver = args[:receiver]
+        @invoice_header = args[:invoice_header]
+        @invoice_data = args[:invoice_data]
+        @breakdown_type = args[:breakdown_type]
+      end
+
+      # @return [String]
+      def create
+        builder = Nokogiri::XML::Builder.new(encoding: Encoding::UTF_8.to_s) do |xml|
+          xml.TicketBai do
+            @receiver&.build_xml(xml)
+            @invoice_header.build_xml(xml)
+            @invoice_data.build_xml(xml)
+            @breakdown_type.build_xml(xml)
+          end
+        end
+
+        filter_root_node(builder)
+      end
+
+      private
+
+      def filter_root_node(builder)
+        Nokogiri::XML(builder.to_xml).at('TicketBai').children.to_xml
+      end
+    end
+  end
+end

data/lib/ticketbai/errors.rb

@@ -0,0 +1,27 @@
+module Ticketbai
+  # Generic Ticketbai exception class.
+  class Error < StandardError; end
+
+  # For errors returned by the client library, like HTTP errors
+  class ClientError < Error; end
+
+  # For errors returned by the API
+  class APIError < Error
+    attr_reader :code
+
+    def initialize(message = nil, code = nil)
+      @code = code
+      super(message)
+    end
+  end
+
+  # For errors returned by the TBAIFile validation.
+  class TBAIFileError < Error
+    attr_reader :code
+
+    def initialize(message = nil, code = nil)
+      @code = code
+      super(message)
+    end
+  end
+end

data/lib/ticketbai/nodes/breakdown_type.rb

@@ -0,0 +1,72 @@
+module Ticketbai
+  module Nodes
+    class BreakdownType
+      # Exemption causes (CausaExencion):
+      # E1: Exenta por el articulo 20 de la Norma Foral del IVA
+      # E2: Exenta por el articulo 21 de la Norma Foral del IVA
+      # E3: Exenta por el articulo 22 de la Norma Foral del IVA
+      # E4: Exenta por el articulo 23 y 24 de la Norma Foral del IVA
+      # E5: Exenta por el articulo 25 de la Norma Foral del IVA
+      # E6: Exenta por otra causa
+
+      # Type of non-exempt (TipoNoExenta):
+      # S1: Sin inversion del sujeto pasivo
+      # S2: Con inversion del sujeto pasivo
+      def initialize(args = {})
+        @receiver_country = args[:receiver_country]
+        @invoice_amount = args[:invoice_amount]
+        @invoice_vat = args[:invoice_vat]
+        @invoice_vat_total = args[:invoice_vat_total]
+        @receiver_in_eu = args[:receiver_in_eu]
+        @simplified_invoice = args[:simplified_invoice]
+      end
+
+      # @return [Nokogiri::XML::Builder]
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.TipoDesglose do |xml|
+          if (@receiver_country == 'ES') || (@receiver_country != 'ES' && @simplified_invoice)
+            xml.DesgloseFactura do
+              xml.Sujeta do
+                if (@receiver_country != 'ES') && @simplified_invoice
+                  xml.Exenta do
+                    xml.DetalleExenta do
+                      xml.CausaExencion @receiver_in_eu == true ? 'E6' : 'E2'
+                      xml.BaseImponible @invoice_amount
+                    end
+                  end
+                else
+                  xml.NoExenta do
+                    xml.DetalleNoExenta do
+                      xml.TipoNoExenta 'S1'
+                      xml.DesgloseIVA do
+                        xml.DetalleIVA do
+                          xml.BaseImponible @invoice_amount
+                          xml.TipoImpositivo @invoice_vat
+                          xml.CuotaImpuesto @invoice_vat_total
+                        end
+                      end
+                    end
+                  end
+                end
+              end
+            end
+          else
+            xml.DesgloseTipoOperacion do
+              xml.PrestacionServicios do
+                xml.Sujeta do
+                  xml.Exenta do
+                    xml.DetalleExenta do
+                      xml.CausaExencion @receiver_in_eu == true ? 'E6' : 'E2'
+                      xml.BaseImponible @invoice_amount
+                    end
+                  end
+                end
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/invoice_chaining.rb

@@ -0,0 +1,22 @@
+module Ticketbai
+  module Nodes
+    class InvoiceChaining
+      def initialize(args = {})
+        @prev_invoice_serial = args[:prev_invoice_serial]
+        @prev_invoice_number = args[:prev_invoice_number]
+        @prev_invoice_date = args[:prev_invoice_date]
+        @prev_invoice_signature = args[:prev_invoice_signature]
+      end
+
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.EncadenamientoFacturaAnterior do |xml|
+          xml.SerieFacturaAnterior @prev_invoice_serial if @prev_invoice_serial
+          xml.NumFacturaAnterior @prev_invoice_number
+          xml.FechaExpedicionFacturaAnterior @prev_invoice_date
+          xml.SignatureValueFirmaFacturaAnterior @prev_invoice_signature
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/invoice_data.rb

@@ -0,0 +1,24 @@
+module Ticketbai
+  module Nodes
+    class InvoiceData
+      def initialize(args = {})
+        @invoice_description = args[:invoice_description]
+        @invoice_total = args[:invoice_total]
+        @invoice_vat_key = args[:invoice_vat_key]
+      end
+
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.DatosFactura do |xml|
+          xml.DescripcionFactura @invoice_description
+          xml.ImporteTotalFactura @invoice_total
+          xml.Claves do
+            xml.IDClave do
+              xml.ClaveRegimenIvaOpTrascendencia @invoice_vat_key
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/invoice_header.rb

@@ -0,0 +1,26 @@
+module Ticketbai
+  module Nodes
+    class InvoiceHeader
+      SIMPLIFIED_INVOICE = 'S'.freeze
+
+      def initialize(args = {})
+        @invoice_serial = args[:invoice_serial]
+        @invoice_number = args[:invoice_number]
+        @invoice_date = args[:invoice_date]
+        @invoice_time = args[:invoice_time]
+        @simplified_invoice = args[:simplified_invoice]
+      end
+
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.CabeceraFactura do |xml|
+          xml.SerieFactura @invoice_serial
+          xml.NumFactura @invoice_number
+          xml.FechaExpedicionFactura @invoice_date
+          xml.HoraExpedicionFactura @invoice_time if @invoice_time
+          xml.FacturaSimplificada SIMPLIFIED_INVOICE if @simplified_invoice
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/issuer.rb

@@ -0,0 +1,18 @@
+module Ticketbai
+  module Nodes
+    class Issuer
+      def initialize(args = {})
+        @issuing_company_nif = args[:issuing_company_nif]
+        @issuing_company_name = args[:issuing_company_name]
+      end
+
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.Emisor do |xml|
+          xml.NIF @issuing_company_nif
+          xml.ApellidosNombreRazonSocial @issuing_company_name
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/lroe_header.rb

@@ -0,0 +1,29 @@
+module Ticketbai
+  module Nodes
+    class LroeHeader
+      def initialize(args = {})
+        @year = args[:year]
+        @nif = args[:nif]
+        @company_name = args[:company_name]
+        @operation = args[:operation]
+        @subchapter = args[:subchapter]
+      end
+
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.Cabecera do |xml|
+          xml.Modelo Ticketbai::Api::Request::LROE_MODEL
+          xml.Capitulo Ticketbai::Api::Request::LROE_CHAPTER
+          xml.Subcapitulo @subchapter
+          xml.Operacion @operation
+          xml.Version '1.0'
+          xml.Ejercicio @year
+          xml.ObligadoTributario do
+            xml.NIF @nif
+            xml.ApellidosNombreRazonSocial @company_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/lroe_issued_invoices.rb

@@ -0,0 +1,28 @@
+module Ticketbai
+  module Nodes
+    class LroeIssuedInvoices
+      def initialize(args = {})
+        @issued_invoices = args[:issued_invoices]
+        @operation = args[:operation]
+      end
+
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.FacturasEmitidas do |xml|
+          @issued_invoices.each do |issued_invoice|
+            xml.FacturaEmitida do
+              case @operation
+              when :annulment
+                xml.AnulacionTicketBai Base64.strict_encode64(issued_invoice)
+              when :issuance
+                xml.TicketBai Base64.strict_encode64(issued_invoice)
+              when :issuance_unsigned
+                xml << issued_invoice
+              end
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/receiver.rb

@@ -0,0 +1,36 @@
+module Ticketbai
+  module Nodes
+    class Receiver
+      # ID TYPES
+      # 02: NIF-IVA
+      # 03: Pasaporte
+      # 04: Documento oficial de identificacion expedido por el pais o territorio de residencia
+      # 05: Certificado de residencia
+      # 06: Otro documento probatorio
+
+      def initialize(args = {})
+        @receiver_country = args[:receiver_country]
+        @receiver_nif = args[:receiver_nif]
+        @receiver_name = args[:receiver_name]
+      end
+
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.Destinatarios do |xml|
+          xml.IDDestinatario do
+            if @receiver_country == 'ES'
+              xml.NIF @receiver_nif
+            else
+              xml.IDOtro do
+                xml.CodigoPais @receiver_country
+                xml.IDType '04'
+                xml.ID @receiver_nif
+              end
+            end
+            xml.ApellidosNombreRazonSocial @receiver_name
+          end
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/nodes/software.rb

@@ -0,0 +1,17 @@
+module Ticketbai
+  module Nodes
+    class Software
+      def build_xml(node)
+        node = Nokogiri::XML::Builder.new if node.nil?
+        node.Software do |xml|
+          xml.LicenciaTBAI Ticketbai.config.license_key
+          xml.EntidadDesarrolladora do
+            xml.NIF Ticketbai.config.developer_company_nif
+          end
+          xml.Nombre Ticketbai.config.app_name
+          xml.Version Ticketbai.config.app_version
+        end
+      end
+    end
+  end
+end

data/lib/ticketbai/operation.rb

@@ -0,0 +1,59 @@
+module Ticketbai
+  class Operation
+    attr_accessor :company_cert
+
+    def initialize(args)
+      self.class::ATTRIBUTES.each do |p|
+        instance_variable_set "@#{p}", args[p]
+      end
+
+      @company_cert = Ticketbai.config.certificates[args[:company_cert]]
+    end
+
+    ###
+    # Creates the Ticketbai operation by doing the following:
+    # 1. Build the document
+    # 2. Sign the document
+    # 3. Validate the signed document
+    #
+    # @return [Hash] xml_doc: The signed document. signature_value: The first 100 characters of the signature value
+    ###
+    def create
+      document = build_document
+
+      signed_document = sign_document(document)
+
+      validate_document(signed_document)
+
+      signature_value = read_signature_value(signed_document)[0..99]
+
+      { xml_doc: signed_document, signature_value: signature_value }
+    end
+
+    def build_document
+      raise NotImplementedError, 'Must implement this method'
+    end
+
+    private
+
+    def modify_xml_root_name(builder)
+      builder.doc.root.name = self.class::ROOT_NAME
+    end
+
+    def decoded_cert
+      Base64.decode64(@company_cert[:cert])
+    end
+
+    def sign_document(document)
+      Signer.new({ xml: document.to_xml, certificate: decoded_cert, key: @company_cert[:key] }).sign
+    end
+
+    def validate_document(document)
+      DocumentValidator.new(document: document, validator_type: self.class::OPERATION_NAME).validate
+    end
+
+    def read_signature_value(document)
+      Nokogiri::XML(document).children.last.children.last.children[1].children.first.text
+    end
+  end
+end

data/lib/ticketbai/operations/annulment.rb

@@ -0,0 +1,41 @@
+module Ticketbai
+  module Operations
+    class Annulment < Operation
+      OPERATION_NAME = :annulment
+
+      ATTRIBUTES = %i[issuing_company_nif issuing_company_name invoice_serial invoice_number invoice_date].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      ###
+      # @param [String] issuing_company_nif NIF of the taxpayer's company
+      # @param [String] issuing_company_name Name of the taxpayer's company
+      # @param [String] invoice_serial Invoice's serial number
+      # @param [String] invoice_number Invoice's number
+      # @param [String] invoice_date Invoices emission date (Format: d-m-Y)
+      # @param [String] company_cert The name of the certificate to be used for issuance
+      ###
+      def initialize(**args)
+        super(args)
+      end
+
+      def build_document
+        @issuer = Ticketbai::Nodes::Issuer.new(issuing_company_nif: @issuing_company_nif, issuing_company_name: @issuing_company_name)
+
+        @invoice_header = Ticketbai::Nodes::InvoiceHeader.new(
+          invoice_serial: @invoice_serial,
+          invoice_number: @invoice_number,
+          invoice_date: @invoice_date
+        )
+
+        @software = Ticketbai::Nodes::Software.new
+
+        Ticketbai::Documents::Annulment.new(
+          issuer: @issuer,
+          invoice_header: @invoice_header,
+          software: @software
+        ).create
+      end
+    end
+  end
+end

data/lib/ticketbai/operations/issuance.rb

@@ -0,0 +1,93 @@
+module Ticketbai
+  module Operations
+    class Issuance < Operation
+      DEFAULT_VAT_KEY = '01'.freeze
+      OPERATION_NAME = :issuance
+
+      ATTRIBUTES = %i[company_cert issuing_company_nif issuing_company_name receiver_nif receiver_name receiver_country receiver_in_eu invoice_serial
+                      invoice_number invoice_date invoice_time simplified_invoice invoice_description invoice_total invoice_vat_key
+                      invoice_amount invoice_vat invoice_vat_total prev_invoice_number prev_invoice_signature prev_invoice_date].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      ###
+      # @param [String] issuing_company_nif NIF of the taxpayer's company
+      # @param [String] issuing_company_name Name of the taxpayer's company
+      # @param [String] receiver_nif Spanish NIF or official identification document in case of being another country
+      # @param [String] receiver_name  Name of the receiver
+      # @param [String] receiver_country Country code of the receiver (Ex: ES|DE)
+      # @param [Boolean] receiver_in_eu The receiver residence is in Europe?
+      # @param [String] invoice_serial Invoices serial number
+      # @param [String] invoice_number Invoices number
+      # @param [String] invoice_date Invoices emission date (Format: d-m-Y)
+      # @param [String] invoice_time  Invoices emission time (Format: H:M:S)
+      # @param [Boolean] simplified_invoice is a simplified invoice?
+      # @param [String] invoice_description Invoices description text
+      # @param [String] invoice_total Total invoice amount
+      # @param [String] invoice_vat_key Key of the VAT regime
+      # @param [String] invoice_amount Taxable base of the invoice
+      # @param [Float] invoice_vat Invoice VAT (Ex: 21.0)
+      # @param [String] invoice_vat_total Invoices number
+      # @param [String] prev_invoice_number Number of the last invoice generated
+      # @param [String] prev_invoice_signature Signature of the last invoice generated
+      # @param [String] prev_invoice_date Emission date of the last invoice generated
+      # @param [Symbol] company_cert: The name of the certificate to be used for issuance
+      ###
+      def initialize(**args)
+        args[:receiver_nif]&.strip!
+        args[:receiver_country] = args[:receiver_country]&.upcase || 'ES'
+
+        super(args)
+      end
+
+      def build_document
+        @issuer = Ticketbai::Nodes::Issuer.new(issuing_company_nif: @issuing_company_nif, issuing_company_name: @issuing_company_name)
+
+        if @receiver_nif && @receiver_name
+          @receiver = Ticketbai::Nodes::Receiver.new(receiver_country: @receiver_country, receiver_nif: @receiver_nif, receiver_name: @receiver_name)
+        end
+
+        @invoice_header = Ticketbai::Nodes::InvoiceHeader.new(
+          invoice_serial: @invoice_serial,
+          invoice_number: @invoice_number,
+          invoice_date: @invoice_date,
+          invoice_time: @invoice_time,
+          simplified_invoice: @simplified_invoice
+        )
+        @invoice_data = Ticketbai::Nodes::InvoiceData.new(
+          invoice_description: @invoice_description,
+          invoice_total: @invoice_total,
+          invoice_vat_key: @invoice_vat_key
+        )
+        @breakdown_type = Ticketbai::Nodes::BreakdownType.new(
+          receiver_country: @receiver_country,
+          invoice_amount: @invoice_amount,
+          invoice_vat: @invoice_vat,
+          invoice_vat_total: @invoice_vat_total,
+          receiver_in_eu: @receiver_in_eu,
+          simplified_invoice: @simplified_invoice
+        )
+        if @prev_invoice_number && @prev_invoice_date && @prev_invoice_signature
+          @invoice_chaining = Ticketbai::Nodes::InvoiceChaining.new(
+            prev_invoice_serial: @prev_invoice_serial,
+            prev_invoice_number: @prev_invoice_number,
+            prev_invoice_date: @prev_invoice_date,
+            prev_invoice_signature: @prev_invoice_signature
+          )
+        end
+
+        @software = Ticketbai::Nodes::Software.new
+
+        Ticketbai::Documents::Issuance.new(
+          issuer: @issuer,
+          receiver: @receiver,
+          invoice_header: @invoice_header,
+          invoice_data: @invoice_data,
+          breakdown_type: @breakdown_type,
+          invoice_chaining: @invoice_chaining,
+          software: @software
+        ).create
+      end
+    end
+  end
+end