sunat_invoice 0.0.1 → 0.0.3

data/lib/sunat_invoice/response_parser.rb

@@ -0,0 +1,64 @@
+# frozen_string_literal: false
+
+module SunatInvoice
+  class InvalidResponseParser < StandardError; end
+
+  class ResponseParser
+    attr_reader :cdr, :status_code, :document_number, :message, :ticket
+
+    STATUS_CODES = {
+      0 => 'process success',
+      99 => 'in process',
+      98 => 'process with errors'
+    }.freeze
+
+    ALLOWED_PARSERS = %w[invoice summary status].freeze
+    VALID_PROCESS = %w[0 99].freeze
+
+    def initialize(body, parser_type)
+      # body: SOAP body as a Hash. Typically Savon Response body.
+      # parser_type: kind of parser to use.
+      raise InvalidResponseParser unless ALLOWED_PARSERS.include?(parser_type)
+      send("parse_#{parser_type}", body)
+    end
+
+    private
+
+    def parse_invoice(body)
+      encrypted_zip = body[:send_bill_response][:application_response]
+      decrypt_zip(encrypted_zip)
+    end
+
+    def parse_xml(cdr_xml)
+      @cdr = Nokogiri::XML(cdr_xml)
+      response_node = @cdr.at('//cac:DocumentResponse/cac:Response')
+      @status_code = response_node.at('//cbc:ResponseCode').content
+      @document_number = response_node.at('//cbc:ReferenceID').content
+      @message = response_node.at('//cbc:Description').content
+    end
+
+    def parse_summary(body)
+      @ticket = body[:send_summary_response][:ticket]
+    end
+
+    def parse_status(body)
+      status_hash = body[:get_status_response][:status]
+      @status_code = status_hash[:status_code]
+      if VALID_PROCESS.include?(status_code)
+        encrypted_zip = status_hash[:content]
+        decrypt_zip(encrypted_zip)
+      else
+        @message = status_hash[:content]
+      end
+    end
+
+    def decrypt_zip(encrypted_zip)
+      decoded = Base64.decode64(encrypted_zip)
+      Zip::InputStream.open(StringIO.new(decoded)) do |io|
+        while (entry = io.get_next_entry)
+          parse_xml(io.read) if entry.name.include?('.xml')
+        end
+      end
+    end
+  end
+end

data/lib/sunat_invoice/signature.rb

@@ -18,24 +18,34 @@ module SunatInvoice
     def signer_data(xml)
       xml['cac'].Signature do
         xml['cbc'].ID provider.signature_id
-        xml['cac'].SignatoryParty do
-          xml['cac'].PartyIdentification do
-            xml['cbc'].ID provider.ruc
-          end
-          xml['cac'].PartyName do
-            xml['cbc'].Name provider.name
-          end
+        build_signatory_party(xml)
+        build_digital_attachment(xml)
+      end
+    end
+
+    def build_signatory_party(xml)
+      xml['cac'].SignatoryParty do
+        xml['cac'].PartyIdentification do
+          xml['cbc'].ID provider.ruc
         end
-        xml['cac'].DigitalSignatureAttachment do
-          xml['cac'].ExternalReference do
-            xml['cbc'].URI "##{provider.signature_location_id}"
-          end
+        xml['cac'].PartyName do
+          xml['cbc'].Name provider.name
+        end
+      end
+    end
+
+    def build_digital_attachment(xml)
+      xml['cac'].DigitalSignatureAttachment do
+        xml['cac'].ExternalReference do
+          xml['cbc'].URI "##{provider.signature_location_id}"
         end
       end
     end
 
     def sign(invoice_xml)
-      Xmldsig::SignedDocument.new(invoice_xml, id_attr: provider.signature_location_id).sign(private_key)
+      options = { id_attr: provider.signature_location_id }
+      doc = Xmldsig::SignedDocument.new(invoice_xml, options)
+      doc.sign(private_key)
     end
 
     def signature_ext(xml)
@@ -52,15 +62,19 @@ module SunatInvoice
         xml['ds'].CanonicalizationMethod Algorithm: C14N_ALGORITHM
         xml['ds'].SignatureMethod Algorithm: SIGNATURE_ALGORITHM
         xml['ds'].Reference URI: '' do
-          xml['ds'].Transforms do
-            xml['ds'].Transform Algorithm: TRANSFORMATION_ALGORITHM
-          end
+          build_transforms(xml)
           xml['ds'].DigestMethod Algorithm: DIGEST_ALGORITHM
           xml['ds'].DigestValue
         end
       end
     end
 
+    def build_transforms(xml)
+      xml['ds'].Transforms do
+        xml['ds'].Transform Algorithm: TRANSFORMATION_ALGORITHM
+      end
+    end
+
     def signature_value(xml)
       xml['ds'].SignatureValue
       xml['ds'].KeyInfo do

data/lib/sunat_invoice/summary_line.rb

@@ -0,0 +1,75 @@
+# frozen_string_literal: true
+
+require_relative 'line'
+
+module SunatInvoice
+  class SummaryLine < Line
+    attr_accessor :document_type, :document_serial, :start_document_number,
+                  :end_document_number, :total_amount, :taxable, :non_taxable,
+                  :exempt, :other_charge, :charge_type
+
+    CHARGES = {
+      discount: false,
+      charge: true
+    }.freeze
+
+    def initialize(*args)
+      super(*args)
+      @taxable ||= 0.01
+      @non_taxable ||= 0.01
+      @exempt ||= 0.01
+      @other_charge ||= 0.01
+    end
+
+    def xml(xml, index, currency)
+      xml['sac'].SummaryDocumentsLine do
+        xml['cbc'].LineID(index + 1)
+        build_documents_info(xml)
+        amount_xml(xml['sac'], 'TotalAmount', total_amount, currency)
+        build_payments(xml, currency)
+        build_other_charge(xml, currency)
+        build_taxes_xml(xml, currency)
+      end
+    end
+
+    private
+
+    def payments
+      [{ amount: taxable, code: '01' },
+       { amount: exempt, code: '02' },
+       { amount: non_taxable, code: '03' }]
+    end
+
+    def build_documents_info(xml)
+      xml['cbc'].DocumentTypeCode document_type
+      xml['sac'].DocumentSerialID document_serial
+      xml['sac'].StartDocumentNumberID start_document_number
+      xml['sac'].EndDocumentNumberID end_document_number
+    end
+
+    def calculate_total_amount
+      return if total_amount
+      # TODO: sum(billing payments) + allowance charge + sum(taxes)
+    end
+
+    def build_payments(xml, currency)
+      payments.each do |payment|
+        xml['sac'].BillingPayment do
+          amount_xml(xml['cbc'], 'PaidAmount', payment[:amount], currency)
+          xml['cbc'].InstructionID payment[:code]
+        end
+      end
+    end
+
+    def build_other_charge(xml, currency)
+      xml['cac'].AllowanceCharge do
+        xml['cbc'].ChargeIndicator CHARGES.values.last
+        amount_xml(xml['cbc'], 'Amount', other_charge, currency)
+      end
+    end
+
+    def resolve_charge_type
+      charge_type ? CHARGES[charge_type] : CHARGES.values.first
+    end
+  end
+end

data/lib/sunat_invoice/tax.rb

@@ -41,7 +41,7 @@ module SunatInvoice
 
     def tax_category(xml)
       xml['cac'].TaxCategory do
-        xml['cbc'].TaxExemptionReasonCode(tax_exemption_reason) if tax_exemption_reason
+        tax_exemption(xml)
         xml['cbc'].TierRange(tier_range) if tier_range
         tax_scheme(xml)
       end
@@ -58,5 +58,10 @@ module SunatInvoice
     def tax_data(attribute)
       TAXES[tax_type][attribute]
     end
+
+    def tax_exemption(xml)
+      return unless tax_exemption_reason
+      xml['cbc'].TaxExemptionReasonCode(tax_exemption_reason)
+    end
   end
 end

data/lib/sunat_invoice/trade_calculations.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: false
+
+require_relative 'catalogs'
+
+module SunatInvoice
+  module TradeCalculations
+    def prepare_totals
+      calculate_taxes_totals
+      calculate_sale_totals
+      calculate_total
+    end
+
+    def calculate_total
+      # calculate invoice total
+      @total = 0
+      @total += @taxes_totals.values.sum
+      @total += @sale_totals.reject { |k, _v| k == '1004' }.values.sum
+      @total -= discount if discount
+    end
+
+    def calculate_sale_totals
+      @sale_totals = {}
+      # get bi totals according kind of sale (gravado, inafecto, exonerado ..)
+      lines&.each do |item|
+        # TODO: I think in most cases only be one tax for item, but should
+        #       handle more cases
+        total_code = get_total_code(item.taxes.first)
+        if total_code
+          @sale_totals[total_code] = 0 unless @sale_totals[total_code]
+          @sale_totals[total_code] += item.bi_value
+        end
+      end
+    end
+
+    def calculate_taxes_totals
+      # concat item's sale_taxes
+      @taxes_totals = {}
+      taxes = lines&.map(&:sale_taxes)&.flatten
+      taxes&.each do |tax|
+        @taxes_totals[tax.keys.first] ||= 0
+        @taxes_totals[tax.keys.first] += tax.values.sum
+      end
+    end
+
+    def get_total_code(tax)
+      return unless tax
+      case tax.tax_type
+      # TODO: :isc
+      when :igv
+        get_total_igv_code(tax.tax_exemption_reason)
+      end
+    end
+
+    def get_total_igv_code(exemption_reason)
+      if Catalogs::CATALOG_07.first == exemption_reason
+        Catalogs::CATALOG_14.first
+      elsif Catalogs::CATALOG_07[1..6].include?(exemption_reason)
+        Catalogs::CATALOG_14[3]
+      elsif Catalogs::CATALOG_07[7] == exemption_reason
+        Catalogs::CATALOG_14[2]
+      elsif Catalogs::CATALOG_07[8] == exemption_reason
+        Catalogs::CATALOG_14[1]
+      elsif Catalogs::CATALOG_07[9..14].include?(exemption_reason)
+        Catalogs::CATALOG_14[3]
+      end
+    end
+  end
+end

data/lib/sunat_invoice/trade_document.rb

@@ -0,0 +1,85 @@
+# frozen_string_literal: false
+
+require_relative 'tax'
+require_relative 'trade_calculations'
+
+module SunatInvoice
+  class TradeDocument < XmlDocument
+    include TradeCalculations
+
+    attr_accessor :customer, :document_number, :document_type, :discount
+
+    INVOICE_TYPES = %w[01 03].freeze
+
+    def operation
+      :send_bill
+    end
+
+    def document_name
+      "#{@provider.ruc}-#{document_type}-#{document_number}"
+    end
+
+    private
+
+    def invoice?
+      INVOICE_TYPES.include?(document_type)
+    end
+
+    def build_document_data(xml)
+      build_number(xml)
+      xml['cbc'].IssueDate formatted_date(date)
+      xml['cbc'].InvoiceTypeCode document_type if invoice?
+      xml['cbc'].DocumentCurrencyCode currency
+    end
+
+    def build_ext(xml)
+      super(xml) do |xml_|
+        build_sale_totals(xml_)
+      end
+    end
+
+    def build_sale_totals(xml)
+      prepare_totals
+      ubl_ext(xml) do
+        xml['sac'].AdditionalInformation do
+          @sale_totals&.each do |code, amount|
+            build_monetary_total(xml, code, amount)
+          end
+          build_monetary_total(xml, '2005', discount) if discount
+        end
+      end
+    end
+
+    def build_monetary_total(xml, code, amount)
+      xml['sac'].AdditionalMonetaryTotal do
+        xml['cbc'].ID code
+        amount_xml(xml['cbc'], 'PayableAmount', amount, @currency)
+      end
+    end
+
+    def build_common_content(xml)
+      @signature.signer_data(xml)
+      @provider.info(xml)
+      @customer.info(xml)
+      build_taxes_totals(xml)
+      build_total(xml)
+      build_lines_xml(xml)
+    end
+
+    def build_taxes_totals(xml)
+      @taxes_totals.each do |key, value|
+        SunatInvoice::Tax.new(tax_type: key, amount: value).xml(xml, @currency)
+      end
+    end
+
+    def total_tag
+      'LegalMonetaryTotal'
+    end
+
+    def build_total(xml)
+      xml['cac'].send(total_tag) do
+        amount_xml(xml['cbc'], 'PayableAmount', @total, @currency)
+      end
+    end
+  end
+end

data/lib/sunat_invoice/utils.rb

@@ -4,18 +4,57 @@ module SunatInvoice
   module Utils
     @namespace_path = 'urn:oasis:names:specification:ubl:schema:xsd'
     @sunat_namespace_path = 'urn:sunat:names:specification:ubl:peru:schema:xsd'
+    @un_namespace_path = 'urn:un:unece:uncefact:data:specification'
 
-    UBL_NAMESPACES = {
-      'xmlns' => "#{@namespace_path}:Invoice-2",
-      'xmlns:cac' => "#{@namespace_path}:CommonAggregateComponents-2",
-      'xmlns:cbc' => "#{@namespace_path}:CommonBasicComponents-2",
+    COMMON_NAMESPACES = {
+      cac: "#{@namespace_path}:CommonAggregateComponents-2",
+      cbc: "#{@namespace_path}:CommonBasicComponents-2",
+      ds: 'http://www.w3.org/2000/09/xmldsig#',
+      ext: "#{@namespace_path}:CommonExtensionComponents-2",
+      sac: "#{@sunat_namespace_path}:SunatAggregateComponents-1",
+      xsi: 'http://www.w3.org/2001/XMLSchema-instance'
+    }.freeze
+
+    TRADE_NAMESPACES = {
+      'xmlns:cac' => COMMON_NAMESPACES[:cac],
+      'xmlns:cbc' => COMMON_NAMESPACES[:cbc],
       'xmlns:ccts' => 'urn:un:unece:uncefact:documentation:2',
-      'xmlns:ds' => 'http://www.w3.org/2000/09/xmldsig#',
-      'xmlns:ext' => "#{@namespace_path}:CommonExtensionComponents-2",
+      'xmlns:ds' => COMMON_NAMESPACES[:ds],
+      'xmlns:ext' => COMMON_NAMESPACES[:ext],
       'xmlns:qdt' => "#{@namespace_path}:QualifiedDatatypes-2",
-      'xmlns:sac' => "#{@sunat_namespace_path}:SunatAggregateComponents-1",
-      'xmlns:udt' => 'urn:un:unece:uncefact:data:specification:UnqualifiedDataTypesSchemaModule:2',
-      'xmlns:xsi' => 'http://www.w3.org/2001/XMLSchema-instance'
+      'xmlns:sac' => COMMON_NAMESPACES[:sac],
+      'xmlns:udt' => "#{@un_namespace_path}:UnqualifiedDataTypesSchemaModule:2",
+      'xmlns:xsi' => COMMON_NAMESPACES[:xsi]
+    }.freeze
+
+    INVOICE_NAMESPACES = {
+      'xmlns' => "#{@namespace_path}:Invoice-2"
+    }.freeze
+
+    CREDIT_NOTE_NAMESPACES = {
+      'xmlns' => "#{@namespace_path}:CreditNote-2"
+    }.freeze
+
+    DEBIT_NOTE_NAMESPACES = {
+      'xmlns' => "#{@namespace_path}:DebitNote-2"
+    }.freeze
+
+    SUMMARY_NAMESPACES = {
+      'xmlns:cac' => COMMON_NAMESPACES[:cac],
+      'xmlns:cbc' => COMMON_NAMESPACES[:cbc],
+      'xmlns:ds' => COMMON_NAMESPACES[:ds],
+      'xmlns:ext' => COMMON_NAMESPACES[:ext],
+      'xmlns:sac' => COMMON_NAMESPACES[:sac],
+      'xmlns:xsi' => COMMON_NAMESPACES[:xsi]
+    }.freeze
+
+    DAILY_SUMMARY_NAMESPACES = {
+      'xmlns' => "#{@sunat_namespace_path}:SummaryDocuments-1",
+      'xsi:schemaLocation' => 'urn:sunat:names:specification:ubl:peru:schema:xsd:InvoiceSummary-1 D:\UBL_SUNAT\SUNAT_xml_20110112\20110112\xsd\maindoc\UBLPE-InvoiceSummary-1.0.xsd'
+    }.freeze
+
+    VOIDED_NAMESPACES = {
+      'xmlns' => "#{@sunat_namespace_path}:VoidedDocuments-1"
     }.freeze
 
     def ubl_ext(xml, &block)

data/lib/sunat_invoice/voided.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: false
+
+require_relative 'daily_summary'
+
+module SunatInvoice
+  class Voided < DailySummary
+    private
+
+    def namespaces
+      VOIDED_NAMESPACES.merge(SUMMARY_NAMESPACES)
+    end
+
+    def root_name
+      'VoidedDocuments'
+    end
+
+    def document_number
+      formatted = date.strftime('%Y%m%d') #  YYYYMMDD
+      "RA-#{formatted}-1"
+    end
+  end
+end

data/lib/sunat_invoice/voided_line.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+require_relative 'line'
+
+module SunatInvoice
+  class VoidedLine < Line
+    attr_accessor :document_type, :document_serial, :document_number,
+                  :description
+
+    def xml(xml, index, _currency)
+      xml['sac'].VoidedDocumentsLine do
+        xml['cbc'].LineID(index + 1)
+        xml['cbc'].DocumentTypeCode document_type
+        xml['sac'].DocumentSerialID document_serial
+        xml['sac'].DocumentNumberID document_number
+        xml['sac'].VoidReasonDescription description
+      end
+    end
+  end
+end

data/lib/sunat_invoice/xml_document.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: false
+
+require_relative 'model'
+require_relative 'utils'
+
+module SunatInvoice
+  class XmlDocument < Model
+    include Utils
+
+    attr_accessor :date, :provider, :signature, :currency, :lines
+
+    UBL_VERSION = '2.0'.freeze
+    CUSTOMIZATION = '1.0'.freeze
+
+    def initialize(*args)
+      super(*args)
+      @date ||= Date.today
+    end
+
+    def build_xml(&block)
+      Nokogiri::XML::Builder.new do |xml|
+        xml.send(root_name, namespaces) do
+          build_ext(xml)
+          xml['cbc'].UBLVersionID UBL_VERSION
+          xml['cbc'].CustomizationID CUSTOMIZATION
+          yield(xml) if block
+        end
+      end
+    end
+
+    def build_ext(xml, &block)
+      xml['ext'].UBLExtensions do
+        yield(xml) if block
+        @signature.signature_ext(xml)
+      end
+    end
+
+    def build_number(xml)
+      xml['cbc'].ID document_number
+    end
+
+    def formatted_date(date)
+      date.strftime('%Y-%m-%d')
+    end
+
+    def build_lines_xml(xml)
+      lines&.each_with_index do |line, index|
+        line.xml(xml, index, currency)
+      end
+    end
+  end
+end

data/lib/sunat_invoice.rb

@@ -1,13 +1,27 @@
 # frozen_string_literal: true
 
+# documents
+require 'sunat_invoice/xml_document'
 require 'sunat_invoice/invoice'
 require 'sunat_invoice/provider'
 require 'sunat_invoice/customer'
 require 'sunat_invoice/item'
 require 'sunat_invoice/tax'
+require 'sunat_invoice/daily_summary'
+require 'sunat_invoice/summary_line'
+require 'sunat_invoice/voided'
+require 'sunat_invoice/voided_line'
+require 'sunat_invoice/credit_note'
+require 'sunat_invoice/credit_note_line'
+require 'sunat_invoice/debit_note'
+require 'sunat_invoice/debit_note_line'
+
+# clients
 require 'sunat_invoice/configuration'
+require 'sunat_invoice/response_parser'
 require 'sunat_invoice/client'
 require 'sunat_invoice/clients/invoice_client'
+require 'sunat_invoice/clients/consult_client'
 
 module SunatInvoice
   class << self

data/sunat_invoice.gemspec

@@ -2,9 +2,9 @@
 
 Gem::Specification.new do |s|
   s.name = 'sunat_invoice'
-  s.version = '0.0.1'
-  s.summary = 'SOAP client to use SUNAT Electronic Invoice API'
-  s.description = s.summary
+  s.version = '0.0.3'
+  s.summary = 'Ruby gem to use SUNAT Electronic Billing from your app'
+  s.description = 'Generate and send Electronic Invoices to SUNAT'
   s.authors = ['César Carruitero']
   s.email = ['cesar@mozilla.pe']
   s.homepage = 'https://github.com/ccarruitero/sunat_invoice'
@@ -12,9 +12,9 @@ Gem::Specification.new do |s|
 
   s.files = `git ls-files`.split("\n")
 
-  s.add_dependency 'savon', '~> 2.11.2'
   s.add_dependency 'nokogiri', '~> 1.8'
-  s.add_dependency 'rubyzip', '~> 1.2.1'
+  s.add_dependency 'rubyzip', '~> 1.2'
+  s.add_dependency 'savon', '~> 2.11'
   s.add_dependency 'xmldsig', '~> 0.6.5'
 
   s.add_development_dependency 'cutest', '~> 1.2'

data/test/credit_note_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: false
+
+require_relative 'helper'
+
+setup do
+  provider = FactoryBot.build(:provider)
+  signature = FactoryBot.build(:signature, provider: provider)
+  note = FactoryBot.build(:credit_note, provider: provider,
+                                        signature: signature)
+  @parsed_xml = Nokogiri::XML(note.xml, &:noblanks)
+end
+
+test 'start with CreditNote tag' do
+  assert_equal @parsed_xml.root.name, 'CreditNote'
+end

data/test/daily_summary_test.rb

@@ -0,0 +1,35 @@
+# frozen_string_literal: false
+
+require_relative 'helper'
+
+setup do
+  provider = FactoryBot.build(:provider)
+  signature = FactoryBot.build(:signature, provider: provider)
+  ref_date = Date.today - 1
+  @line = FactoryBot.build(:summary_line)
+  summary = SunatInvoice::DailySummary.new(provider: provider,
+                                           signature: signature,
+                                           reference_date: ref_date,
+                                           currency: 'PEN',
+                                           lines: [@line])
+  @parsed_xml = Nokogiri::XML(summary.xml, &:noblanks)
+end
+
+test 'start with SummaryDocuments tag' do
+  assert_equal @parsed_xml.root.name, 'SummaryDocuments'
+end
+
+test 'line total amount has correct content' do
+  total = @parsed_xml.at('//sac:SummaryDocumentsLine/sac:TotalAmount').content
+  assert_equal total, @line.total_amount.to_s
+end
+
+test 'ChargeIndicator must not be empty when not charge_type' do
+  assert @line.charge_type.nil?
+  assert !@parsed_xml.at('//cbc:ChargeIndicator').content.empty?
+end
+
+test 'AllowanceCharge Amount is 0' do
+  amount = @parsed_xml.at('//cac:AllowanceCharge/cbc:Amount').content
+  assert_equal amount, '0.01'
+end

data/test/debit_note_test.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: false
+
+require_relative 'helper'
+
+setup do
+  provider = FactoryBot.build(:provider)
+  signature = FactoryBot.build(:signature, provider: provider)
+  note = FactoryBot.build(:debit_note, provider: provider,
+                                       signature: signature)
+  @parsed_xml = Nokogiri::XML(note.xml, &:noblanks)
+end
+
+test 'start with DebitNote tag' do
+  assert_equal @parsed_xml.root.name, 'DebitNote'
+end