ticketbai 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: a1c6cb226a9d92966d7025aa0869b26a9375fc51e7107a14dcec995e82bf632a
+  data.tar.gz: 57dd345f66be10521fe9b862450cb64680b1d6b37819ec112e6830b688ffbeea
+SHA512:
+  metadata.gz: f15970bada7f78a0d74a3b6f8f84f33afa1f39dc5c973db302f7142ec85116080152854cd474c3d41e022de0c10659f5d51327e18de8e83bc4210e9bcc486149
+  data.tar.gz: 214ef909a9e59c490441c6a74179959022ac6d7144ae928d0058619b27be25b03636e24b0dcf555e2d70947a2e828366b786918519e840b647df48233fe44fb0

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,32 @@
+AllCops:
+  NewCops: enable
+  TargetRubyVersion: 2.6.7
+  SuggestExtensions: false
+  Exclude:
+    - spec/**/*.rb
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: single_quotes
+
+Metrics:
+  Enabled: false
+
+Style/Documentation:
+  Enabled: false
+
+Style/FrozenStringLiteralComment:
+  Enabled: false
+
+Layout/LineLength:
+  Max: 155
+
+Style/FormatStringToken:
+  Enabled: false
+
+Style/IfUnlessModifier:
+  Enabled: false

data/CHANGELOG.md

@@ -0,0 +1,13 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+## [0.1.1] - 2022-03-08
+🎉 First release!
+
+[Unreleased]: https://github.com/ecommerce-ventures/ticketbai/compare/v0.1.1...HEAD
+[0.1.1]: https://github.com/ecommerce-ventures/ticketbai/releases/tag/v0.1.1

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in ticketbai.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 franvega
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,107 @@
+# Ticketbai
+
+Ticketbai is a gem that gives you the ability to generate Ticketbai files and upload them to the Regional Treasury (currently only Bizkaia is supported)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ticketbai'
+```
+Then run:
+
+```bash
+bundle install
+```
+
+And then execute:
+
+    $ bundle install
+
+Or install it yourself as:
+
+    $ gem install ticketbai
+
+## Configuration
+
+Encode your certificate to be able to add the resulting string to the secrets file:
+
+```
+certificate = File.read('path/my-certificate.pfx')
+encoded_certificate = Base64.strict_encode64(certificate)
+```
+
+Add the encoded_certificate string, the key and the rest of your ticketbai license params to the secrets file:
+
+```
+ticketbai:
+  license_key: xxxxxxxxxx
+  app_name: xxxxxxxxxx
+  app_version: xxxxxxxxxx
+  developer_company_nif: xxxxxxxxxx
+  certificates:
+    my_certificate_name:
+      cert: encoded_certificate string
+      key: xxxxxxxxxx
+```
+
+## Usage
+The supported TicketBAI operations are: issuance, annulment and issuance unsigned.
+
+#### Issuance operation
+```
+Ticketbai::Operations::Issuance.new(
+  company_cert: 'my_certificate_name',
+  issuing_company_nif: 'B34576372',
+  issuing_company_name: 'FooBar SL',
+  invoice_serial: '2022',
+  invoice_number: '10001',
+  invoice_date: '11-01-2022',
+  invoice_time: '13:05:22',
+  invoice_description: 'La descripción de la factura',
+  invoice_total: 12.21,
+  invoice_vat_key: '01',
+  invoice_amount: 11.0,
+  invoice_vat: 21.0,
+  invoice_vat_total: 2.31,
+  simplified_invoice: true
+).create
+```
+If everything is ok, the response of `Ticketbai::Operations::Issuance.new(params).create` is a Hash with two keys:
+- xml_doc: The signed TicketBAI XML string.
+- signature_value: The first 100 characters of the signature value needed for the chaining of TicketBAI files.
+
+#### Annulment operation
+```
+Ticketbai::Operations::Annulment.new(
+  issuing_company_nif: 'B12345678',
+  issuing_company_name: 'Test SL',
+  invoice_serial: '2022',
+  invoice_number: '000002',
+  invoice_date: '10-11-2022',
+  company_cert: 'my_certificate_name'
+).create
+```  
+
+#### API Upload
+
+Sending the TicketBAI files to the LROE is done by executing the following request to the API:
+```
+Ticketbai::Api::Request.new(
+  issued_invoices: xml_doc,
+  nif: 'B34576372',
+  company_name: 'FooBar SL',
+  certificate_name: 'my_certificate_name',
+  year: '2022',
+  operation: :issuance
+).execute
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ecommerce-ventures/ticketbai.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require 'bundler/gem_tasks'
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+require 'rubocop/rake_task'
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'ticketbai'
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require 'irb'
+IRB.start(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/ticketbai/api/client.rb

@@ -0,0 +1,63 @@
+module Ticketbai
+  module Api
+    class Client
+      KO_RESPONSE = :incorrecto
+      OK_RESPONSE = :correcto
+      PARTIALLY_OK_RESPONSE = :parcialmentecorrecto
+
+      def initialize(url:, headers:, body:, company_cert:)
+        @url = url
+        @headers = headers
+        @body = body
+        @company_cert = company_cert
+      end
+
+      def execute
+        response = connection.post do |req|
+          req.url(@url)
+          req.headers = @headers
+          req.body = @body
+        end
+
+        ResponseParser.new(response).to_h
+      end
+
+      private
+
+      def connection
+        Faraday.new(ssl: ssl) do |builder|
+          builder.request :multipart
+          builder.response :logger, Ticketbai.logger if Ticketbai.debug
+          builder.adapter Faraday.default_adapter
+        end
+      end
+
+      def ssl
+        {
+          client_key: client_key,
+          client_cert: client_cert
+        }
+      end
+
+      def client_key
+        p12.key
+      end
+
+      def client_cert
+        p12.certificate
+      end
+
+      def p12
+        OpenSSL::PKCS12.new(p12_file, p12_password)
+      end
+
+      def p12_file
+        Base64.decode64(@company_cert[:cert])
+      end
+
+      def p12_password
+        @company_cert[:key]
+      end
+    end
+  end
+end

data/lib/ticketbai/api/registry.rb

@@ -0,0 +1,34 @@
+module Ticketbai
+  module Api
+    class Registry
+      def initialize(attributes)
+        @attributes = attributes
+      end
+
+      def number
+        @attributes.at_css('NumFactura')&.children&.last&.text
+      end
+
+      def uploaded
+        @attributes.at_css('CodigoErrorRegistro').nil?
+      end
+
+      def error_code
+        @attributes.at_css('CodigoErrorRegistro')&.children&.last&.text
+      end
+
+      def error_message
+        @attributes.at_css('DescripcionErrorRegistroES')&.children&.last&.text
+      end
+
+      def to_h
+        {
+          number: number,
+          uploaded: uploaded,
+          error_code: error_code,
+          error_message: error_message
+        }
+      end
+    end
+  end
+end

data/lib/ticketbai/api/request.rb

@@ -0,0 +1,125 @@
+require 'faraday'
+require 'json'
+require 'zlib'
+
+module Ticketbai
+  module Api
+    class Request
+      TEST_PRESENTATION_ENDPOINT = 'https://pruesarrerak.bizkaia.eus/N3B4000M/aurkezpena'.freeze
+      LIVE_PRESENTATION_ENDPOINT = 'https://sarrerak.bizkaia.eus/N3B4000M/aurkezpena'.freeze
+      TEST_QUERY_ENDPOINT = 'https://pruesarrerak.bizkaia.eus/N3B4001M/kontsulta'.freeze
+
+      # OPERATIONS
+      # issuance_unsigned: (invoices issued without guarantor software): When a TicketBai file has been rejected due to a poorly generated XML result,
+      #                    taking into account that the TicketBAI file cannot be generated again and that its information must be sent, it must be done by
+      #                    indicating the subchapter Invoices issued no guarantor software
+      # issuance:  New invoices issued that we want to register using the guarantor software
+      # annulment: Cancel invoices that we have previously registered using the guarantor software
+      SUPPORTED_OPERATIONS = [
+        Ticketbai::Operations::Issuance::OPERATION_NAME,
+        Ticketbai::Operations::Annulment::OPERATION_NAME,
+        Ticketbai::Operations::IssuanceUnsigned::OPERATION_NAME
+      ].freeze
+
+      OPERATION_MAPPING = {
+        issuance: 'A00',
+        annulment: 'AN0',
+        modify: 'M00',
+        query: 'C00',
+        issuance_unsigned: 'A00'
+      }.freeze
+
+      LROE_MODEL = '240'.freeze
+      LROE_CHAPTER = '1'.freeze
+
+      ###
+      # @param [Array] issued_invoices TicketBAI XML file(s) string (Max: 1000)
+      # @param [String] company_name Name of the taxpayer's company
+      # @param [String] year Fiscal year
+      # @param [Symbol] certificate_name Taxpayer's certificate name
+      # @param [Symbol] operation Operation name
+      ###
+      def initialize(issued_invoices:, nif:, company_name:, year:, certificate_name:, operation:)
+        raise ArgumentError, "Unsupported operation: #{operation}" unless SUPPORTED_OPERATIONS.include? operation.downcase.to_sym
+
+        @issued_invoices = Array(issued_invoices)
+        @nif = nif
+        @company_name = company_name
+        @year = year
+        @company_cert = Ticketbai.config.certificates[certificate_name.to_sym]
+        @operation = operation.downcase.to_sym
+      end
+
+      def execute
+        client = Client.new(
+          url: presentation_endpoint,
+          headers: headers,
+          body: gzip_body,
+          company_cert: @company_cert
+        )
+
+        client.execute
+      end
+
+      private
+
+      def gzip_body
+        gz = StringIO.new('')
+        z = Zlib::GzipWriter.new(gz)
+        z.write Nokogiri::XML(build_document)
+        z.close
+
+        StringIO.new(gz.string).read
+      end
+
+      def build_document
+        @lroe_header = Ticketbai::Nodes::LroeHeader.new(
+          year: @year,
+          nif: @nif,
+          company_name: @company_name,
+          operation: OPERATION_MAPPING[@operation],
+          subchapter: subchapter
+        )
+
+        @lroe_issued_invoices = Ticketbai::Nodes::LroeIssuedInvoices.new(operation: @operation, issued_invoices: @issued_invoices)
+
+        Ticketbai::Documents::ApiPayload.new(
+          operation: @operation,
+          lroe_issued_invoices: @lroe_issued_invoices,
+          lroe_header: @lroe_header
+        ).create
+      end
+
+      def presentation_endpoint
+        if Ticketbai.live?
+          LIVE_PRESENTATION_ENDPOINT
+        else
+          TEST_PRESENTATION_ENDPOINT
+        end
+      end
+
+      def subchapter
+        @operation == :issuance_unsigned ? '1.2' : '1.1'
+      end
+
+      def headers
+        {
+          'Content-Type' => 'application/octet-stream',
+          'Content-Encoding' => 'gzip',
+          'eus-bizkaia-n3-version' => '1.0',
+          'eus-bizkaia-n3-content-type' => 'application/xml',
+          'eus-bizkaia-n3-data' => lroe_header_data
+        }
+      end
+
+      def lroe_header_data
+        {
+          con: 'LROE',
+          apa: subchapter,
+          inte: { nif: @nif, nrs: @company_name },
+          drs: { mode: LROE_MODEL, ejer: @year }
+        }.to_json
+      end
+    end
+  end
+end

data/lib/ticketbai/api/response_parser.rb

@@ -0,0 +1,36 @@
+module Ticketbai
+  module Api
+    class ResponseParser
+      def initialize(raw_response)
+        @raw_response = raw_response
+      end
+
+      def status
+        @raw_response.headers['eus-bizkaia-n3-tipo-respuesta'].downcase.to_sym
+      end
+
+      def identifier
+        @raw_response.headers['eus-bizkaia-n3-identificativo']
+      end
+
+      def message
+        @raw_response.headers['eus-bizkaia-n3-mensaje-respuesta']&.force_encoding('ISO-8859-1')&.encode('UTF-8')
+      end
+
+      def registries
+        return [] unless @raw_response.body
+
+        Nokogiri::XML(@raw_response.body).css('Registros Registro').map { |attributes| Registry.new(attributes) }
+      end
+
+      def to_h
+        {
+          status: status,
+          identifier: identifier,
+          message: message,
+          registries: registries.map(&:to_h)
+        }
+      end
+    end
+  end
+end

data/lib/ticketbai/checksum_calculator.rb

@@ -0,0 +1,15 @@
+module Ticketbai
+  class ChecksumCalculator
+    attr_accessor :data
+
+    def initialize(data)
+      @data = data
+    end
+
+    def calculate
+      checksum = Digest::CRC8.checksum(@data)
+
+      format('%03d', checksum.to_s)
+    end
+  end
+end

data/lib/ticketbai/document.rb

@@ -0,0 +1,21 @@
+module Ticketbai
+  class Document
+    TBAI_VERSION = '1.2'.freeze
+
+    def initialize(args)
+      self.class::ATTRIBUTES.each do |p|
+        instance_variable_set "@#{p}", args[p]
+      end
+    end
+
+    def create
+      raise NotImplementedError, 'Must implement this method'
+    end
+
+    private
+
+    def modify_xml_root_name(builder)
+      builder.doc.root.name = self.class::ROOT_NAME
+    end
+  end
+end

data/lib/ticketbai/document_validator.rb

@@ -0,0 +1,42 @@
+module Ticketbai
+  class DocumentValidator
+    attr_accessor :document, :validator_type
+
+    SUPPORTED_VALIDATORS = [Operations::Issuance::OPERATION_NAME, Operations::Annulment::OPERATION_NAME].freeze
+
+    ###
+    # @param [String] document The xml document to be validated
+    # @param [String] validator_type The validator name to be used to validate the document (.xsd file)
+    ###
+    def initialize(document:, validator_type:)
+      raise ArgumentError, 'Unsupported validator' unless SUPPORTED_VALIDATORS.include? validator_type.downcase.to_sym
+
+      @document = document
+      @validator_type = validator_type.downcase.to_sym
+    end
+
+    ###
+    # Raises an exception with the validation error(s)
+    ###
+    def validate
+      errors = []
+
+      xsd_validator.validate(Nokogiri::XML(@document)).each do |error|
+        errors << error.message
+      end
+
+      return unless errors.any?
+
+      raise Ticketbai::TBAIFileError.new(
+        errors.uniq.join(','),
+        'TBAIFile'
+      )
+    end
+
+    private
+
+    def xsd_validator
+      Nokogiri::XML::Schema(File.read("#{__dir__}/xsd_validators/#{@validator_type}.xsd"))
+    end
+  end
+end

data/lib/ticketbai/documents/annulment.rb

@@ -0,0 +1,45 @@
+module Ticketbai
+  module Documents
+    class Annulment < Document
+      ROOT_NAME = 'T:AnulaTicketBai'.freeze
+      XMLNS = {
+        'xmlns:T' => 'urn:ticketbai:anulacion'
+      }.freeze
+
+      ATTRIBUTES = %i[issuer invoice_header software].freeze
+
+      attr_accessor(*ATTRIBUTES)
+
+      ###
+      # @param [Ticketbai::Nodes::Isuer] issuer
+      # @param [Ticketbai::Nodes::InvoiceHeader] invoice_header
+      # @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.IDFactura do
+              @issuer.build_xml(xml)
+              @invoice_header.build_xml(xml)
+            end
+            xml.HuellaTBAI do
+              @software.build_xml(xml)
+            end
+          end
+        end
+
+        modify_xml_root_name(builder)
+
+        builder
+      end
+    end
+  end
+end

data/lib/ticketbai/documents/api_payload.rb

@@ -0,0 +1,47 @@
+module Ticketbai
+  module Documents
+    class ApiPayload
+      ROOT_NAME_MAPPING = {
+        issuance: 'lrpjfecsgap:LROEPJ240FacturasEmitidasConSGAltaPeticion',
+        annulment: 'lrpjfecsgap:LROEPJ240FacturasEmitidasConSGAnulacionPeticion',
+        issuance_unsigned: 'lrpjfecsgap:LROEPJ240FacturasEmitidasSinSGAltaModifPeticion'
+      }.freeze
+      SCHEME_MAPPING = {
+        issuance: 'https://www.batuz.eus/fitxategiak/batuz/LROE/esquemas/LROE_PJ_240_1_1_FacturasEmitidas_ConSG_AltaPeticion_V1_0_2.xsd',
+        annulment: 'https://www.batuz.eus/fitxategiak/batuz/LROE/esquemas/LROE_PJ_240_1_1_FacturasEmitidas_ConSG_AnulacionPeticion_V1_0_0.xsd',
+        issuance_unsigned: 'https://www.batuz.eus/fitxategiak/batuz/LROE/esquemas/LROE_PJ_240_1_2_FacturasEmitidas_SinSG_AltaModifPeticion_V1_0_1.xsd'
+      }.freeze
+
+      ###
+      # @param [Ticketbai::Nodes::LroeHeader] lroe_header
+      # @param [Ticketbai::Nodes::LroeIssuedInvoices] lroe_issued_invoices
+      # @param [Symbol] operation
+      ###
+      def initialize(**args)
+        @lroe_header = args[:lroe_header]
+        @lroe_issued_invoices = args[:lroe_issued_invoices]
+        @operation = args[:operation]
+      end
+
+      # @return [Nokogiri::XML::Builder]
+      def create
+        builder = Nokogiri::XML::Builder.new(encoding: 'utf-8') do |xml|
+          xml.ROOT_NAME('xmlns:lrpjfecsgap' => SCHEME_MAPPING[@operation]) do
+            @lroe_header.build_xml(xml)
+            @lroe_issued_invoices.build_xml(xml)
+          end
+        end
+
+        modify_xml_root_name(builder)
+
+        builder.to_xml
+      end
+
+      private
+
+      def modify_xml_root_name(builder)
+        builder.doc.root.name = ROOT_NAME_MAPPING[@operation]
+      end
+    end
+  end
+end