cfdi40 0.0.1.alfa → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c30e39f4584ad4ec24f70ae950700568d72b0941adb3535ece9132f0ff7f3d19
-  data.tar.gz: 9dc2cf08802bee96c4a2cfa362101be5ac6926bf67f613f1d2293b6480c6316c
+  metadata.gz: 000e715fcb57e869f47058bb05bc2cadc558f188db6da41e1c0d0240873d910b
+  data.tar.gz: 2ab314d7b2477308a4cc073f8ebe35a31098b8ac5ecb23aa0dd4d43babc95ae8
 SHA512:
-  metadata.gz: '070922f0002e8948bec5ce379e198b61a442bcc54ba47ac45f9f46f2bd58bbae9bcdb4b54b5527bc2996a32c793d8f7ea75235bc2b96925f0cdb4d0ef3c4783a'
-  data.tar.gz: 552352ed70288e9307c6eb065fe57d0d45f84be27085ceb4698fd19a16ec3f0042ced1f57d7acdb467c254ff504a5bb60522402874e736da1e2f2d6b7cf30271
+  metadata.gz: fccd3b919ade4540d90a2b9ff81778e68cd900f121c7e92d4e4bb192585d5bb0d921a1a148bca0df23a5f26ab7da0dc5de165d7f068352701a93f2936d65792e
+  data.tar.gz: ae39a825b18d9f3cbbbd8403b6afb4a920bc4abd61479777d35d774bf5fe44426dd1b472856f966f95b10b50b04ee28773c121431f6d3c4990127bacb02fd09a

data/Gemfile.lock

@@ -2,7 +2,7 @@ PATH
   remote: .
   specs:
     cfdi40 (0.0.1.alfa)
-      nokogiri (~> 1.13, >= 1.13.9)
+      nokogiri (>= 1.10.10)
 
 GEM
   remote: https://rubygems.org/

data/README.md

@@ -1,14 +1,19 @@
 # Cfdi40
 
-Tool for read, create, edit, validate and sign CFDIs version 4.0
+Tool for read, create, validate and sign CFDIs version 4.0
 
 CFDI (Comprobante Fiscal Digital por Internet) are XML documents
 regulated by mexican goverment for tax purpouses.
 
-## Future features
+Please see `README_es-MX.md`
+
+TODO: Document, document, document
+
+## Features
 
-* Create and sign a valid XML of an invoice for general public
-  (público en general) with minimum data
+* XML generation and sign.
+
+## Future features
 
 ## Installation
 
@@ -48,7 +53,7 @@ Bug reports and pull requests are welcome on GitHub at
 https://github.com/[USERNAME]/cfdi40. This project is intended to be a
 safe, welcoming space for collaboration, and contributors are expected
 to adhere to the [code of
-conduct](https://github.com/[USERNAME]/cfdi40/blob/master/CODE_OF_CONDUCT.md).
+conduct](https://github.com/israelbz/cfdi40/blob/master/CODE_OF_CONDUCT.md).
 
 ## License
 

data/README_es-MX.md

@@ -0,0 +1,62 @@
+# Cfdi40
+
+Herramienta para crear, leer, validar y firmam CFDis en
+versión 4.0.
+
+El CFDi (Comprobante Fiscal Digital por internet) es un
+documento en formato XML usado en México.
+
+Esta herramienta tiene la intención de simplificar la
+generación de los archivos XML, para ello, se pretende
+que esta herramienta:
+
+* Ofrezca una interfaz simple para colocar la
+  información esencial para la elaboración del CFDi.
+* Realice los cálculos complementarios como impuestos,
+  totales, etcétera.
+* Valide el CFDi contra los CSD
+* Selle el CFDi.
+
+# Uso
+
+## Ejemplo básico
+
+    # Inicia un cfdi
+    cfdi = Cfdi40.new
+
+    # Datos del emisor
+    cfdi.lugar_expedicion = '06000'
+    cfdi.emisor.regimen_fiscal = '612'
+
+    # Datos del receptor
+    cfdi.receptor.nombre = 'JUAN PUEBLO BUENO'
+    cfdi.receptor.rfc = 'XAXX010101000'
+    cfdi.receptor.domicilio_fiscal = '06000'
+    cfdi.receptor.regimen_fiscal = '616'
+    cfdi.receptor.uso_cfdi = 'G03'
+
+    # Agrega un concepto en pesos,
+    # precio final al cliente (neto)
+    # causa IVA con tasa de 16% (default)
+    cfdi.add_concepto(
+      clave_prod_serv: '81111500',
+      clave_unidad: "E48",
+      descripcion: 'Prueba de concepto',
+      precio_neto: 40
+    )
+
+    # Archivos CSD
+    cfdi.cert_path = '/path_to/certificado.cer'
+    cfdi.key_path = '/path_to/llave_privada.key'
+    cfdi.key_pass = 'contraseña'
+
+    # Genera CFDI firmado
+    xml_string = cfdi.to_xml
+
+
+# ¿Que sigue?
+
+* Complemento de pagos
+* Retenciones
+* IEPS
+* Complemento para colegiaturas

data/cfdi40.gemspec

@@ -14,7 +14,7 @@ Gem::Specification.new do |spec|
                      "regulated by Mexican Government"
   spec.homepage = "https://github.com/israelbz/cfdi40"
   spec.license = "MIT"
-  spec.required_ruby_version = ">= 2.6.0"
+  spec.required_ruby_version = ">= 2.3.3"
 
   spec.metadata["allowed_push_host"] = "https://rubygems.org"
 
@@ -34,7 +34,7 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   # Uncomment to register a new dependency of your gem
-  spec.add_dependency "nokogiri", "~> 1.13", ">= 1.13.9"
+  spec.add_dependency "nokogiri", ">= 1.10.10"
 
   # For more information and examples about making a new gem, check out our
   # guide at: https://bundler.io/guides/creating_gem.html

data/lib/cfdi40/comprobante.rb

@@ -1,30 +1,225 @@
 # frozen_string_literal: true
 
 # Create and Read XML documents
-class Comprobante
-  attr_reader :docxml
+module Cfdi40
+  class Comprobante < Node
+    define_namespace "xsi", "http://www.w3.org/2001/XMLSchema-instance"
+    define_namespace "cfdi", "http://www.sat.gob.mx/cfd/4"
+    define_attribute :schema_location,
+                     xml_attribute: 'xsi:schemaLocation',
+                     readonly: true,
+                     default: "http://www.sat.gob.mx/cfd/4 " \
+                              "http://www.sat.gob.mx/sitio_internet/cfd/4/cfdv40.xsd"
+    define_attribute :version, xml_attribute: 'Version', readonly: true, default: '4.0'
+    define_attribute :serie, xml_attribute: 'Serie'
+    define_attribute :folio, xml_attribute: 'Folio'
+    define_attribute :fecha, xml_attribute: 'Fecha'
+    define_attribute :sello, xml_attribute: 'Sello', readonly: true
+    define_attribute :forma_pago, xml_attribute: 'FormaPago'
+    define_attribute :no_certificado, xml_attribute: 'NoCertificado'
+    define_attribute :certificado, xml_attribute: 'Certificado'
+    define_attribute :condiciones_de_pago, xml_attribute: 'CondicionesDePago'
+    define_attribute :subtotal, xml_attribute: 'SubTotal', format: :t_Importe
+    define_attribute :descuento, xml_attribute: 'Descuento', format: :t_Importe
+    define_attribute :moneda, xml_attribute: 'Moneda', default: 'MXN'
+    define_attribute :tipo_cambio, xml_attribute: 'TipoCambio'
+    define_attribute :total, xml_attribute: 'Total', format: :t_Importe
+    define_attribute :tipo_de_comprobante, xml_attribute: 'TipoDeComprobante', default: 'I'
+    define_attribute :exportacion, xml_attribute: 'Exportacion', default: '01'
+    define_attribute :metodo_pago, xml_attribute: 'MetodoPago'
+    define_attribute :lugar_expedicion, xml_attribute: 'LugarExpedicion'
+    define_attribute :confirmacion, xml_attribute: 'Confirmacion'
 
-  def initialize
-    new_docxml
-  end
+    attr_reader :emisor, :receptor, :x509_cert, :conceptos, :private_key
+    attr_reader :errors
+    attr_writer :key_der, :key_pass
 
-  def to_s
-    docxml.to_xml
-  end
+    def initialize
+      super
+      @errors = []
+      @conceptos = Conceptos.new
+      @emisor = Emisor.new
+      @receptor = Receptor.new
+      @sat_csd = SatCsd.new
+      @fecha ||= Time.now.strftime("%Y-%m-%dT%H:%M:%S")
+      @children_nodes = [@emisor, @receptor, @conceptos]
+      set_defaults
+    end
+
+    # Accept a path to read the certificate.
+    # Certificate is a X509 file. SAT generates those files in
+    # DER format.
+    def cert_path=(path)
+      self.cert_der = File.read(path)
+    end
+
+    def cert_der=(cert_data)
+      @sat_csd ||= SatCsd.new
+      @sat_csd.cert_der = cert_data
+      emisor.rfc = @sat_csd.rfc
+      emisor.nombre = @sat_csd.name
+      @no_certificado = @sat_csd.no_certificado
+      @certificado = @sat_csd.cert64
+      true
+    end
+
+    def key_path=(path)
+      @key_der = File.read(path)
+    end
+
+    def sign
+      @sat_csd ||= SatCsd.new
+      load_private_key if @sat_csd.private_key.nil?
+      return unless @sat_csd.private_key
+
+      raise Error, 'Key and certificate not match' unless @sat_csd.valid_pair?
+
+      digest = @sat_csd.private_key.sign(OpenSSL::Digest.new('SHA256'), original_content)
+      @sello = Base64.strict_encode64 digest
+      @docxml = nil
+    end
+
+    # clave_prod_serv
+    # no_identificacion
+    # cantidad
+    # clave_unidad
+    # unidad
+    # descripcion
+    # valor_unitario
+    # importe
+    # descuento
+    # objeto_imp
+    def add_concepto(attributes = {})
+      concepto = Concepto.new
+      attributes.each do |key, value|
+        method_name = "#{key}=".to_sym
+        if concepto.respond_to?(method_name)
+          concepto.public_send(method_name, value)
+        else
+          raise Error, ":#{key} no se puede asignar al concepto"
+        end
+      end
+      concepto.calculate!
+      @conceptos.children_nodes << concepto
+      calculate!
+      concepto
+    end
+
+    def to_s
+      to_xml
+    end
+
+    def to_xml
+      sign
+      docxml.to_xml
+    end
+
+    def valid?
+      schema_validator = SchemaValidator.new(to_s)
+      return true if schema_validator.valid?
+
+      @errors = schema_validator.errors
+      @errors.empty?
+    end
+
+    def cadena_original
+      original_content
+    end
+
+    def original_content
+      xslt = Nokogiri::XSLT(File.open('lib/xslt/cadenaoriginal_local.xslt'))
+      transformed = xslt.transform(docxml)
+      # The ampersand (&) char must be used in original content
+      # even though the documentation indicates otherwise
+      transformed.children.to_s.gsub('&amp;', '&').strip
+    end
+
+    private
+
+    def docxml
+      return @docxml if defined?(@docxml) && !@docxml.nil?
+
+      @docxml = Nokogiri::XML::Document.new("1.0")
+      @docxml.encoding = "utf-8"
+      add_root_node
+      @docxml
+    end
+
+    def add_root_node
+      self.xml_document = @docxml
+      self.xml_parent = @docxml
+      create_xml_node
+    end
+
+    def calculate!
+      @subtotal = @conceptos.children_nodes.map(&:importe).sum
+      @total = @conceptos.children_nodes.map(&:importe_neto).sum
+      summarize_traslados
+    end
+
+    def summarize_traslados
+      impuestos.total_impuestos_trasladados = 0
+      traslados.children_nodes = []
+      traslados_summary.each do |key, value|
+        #TODO: Sumar los impuestos y agregarlos a los nodos globales de traslados
+        traslado = Traslado.new
+        traslado.impuesto, traslado.tasa_o_cuota, traslado.tipo_factor = key
+        traslado.base = value[:base]
+        traslado.importe = value[:importe]
+        traslados.children_nodes << traslado
+        impuestos.total_impuestos_trasladados += value[:importe]
+      end
+    end
+
+    def concepto_nodes
+      @conceptos.children_nodes
+    end
+
+    # Returns a hash with a summary.
+    # The key is an Array ['impuesto, 'tasa_o_cuota', 'TipoFactor] and the value is
+    # another hash the sum of 'Importe' and  'Base'
+    def traslados_summary
+      summary = {}
+      concepto_nodes.map(&:traslado_nodes).flatten.each do |traslado|
+        key = [traslado.impuesto, traslado.tasa_o_cuota, traslado.tipo_factor]
+        summary[key] ||= { base: 0, importe: 0 }
+        summary[key][:base] += traslado.base
+        summary[key][:importe] += traslado.importe
+      end
+      summary
+    end
+
+    # TODO: Este método tiene que ser 'impuestos'
+    #       si nos atenemos a que los que acaban con _node buscan en los hijos
+    #       y los que no terminan con _node crean el nodo
+    def impuestos
+      return @impuestos if defined?(@impuestos)
+
+      @impuestos = Impuestos.new
+      @children_nodes << @impuestos
+      @impuestos
+    end
+
+    def impuestos_node
+      children_nodes.select { |n| n.is_a?(Impuestos)}.first
+    end
+
+    def traslados
+      return nil if impuestos_node.nil?
 
-  private
+      impuestos_node.traslados
+    end
 
-  def new_docxml
-    @docxml = Nokogiri::XML::Document.new("1.0")
-    @docxml.encoding = "utf-8"
-    root = @docxml.create_element "cfdi:Comprobante"
-    root.add_namespace "xsi", "http://www.w3.org/2001/XMLSchema-instance"
-    root.add_namespace "cfdi", "http://www.sat.gob.mx/cfd/4"
-    root["xsi:schemaLocation"] = "http://www.sat.gob.mx/cfd/3 " \
-                                 "http://www.sat.gob.mx/sitio_internet/cfd/4/cfdv40.xsd"
-    root["Version"] = "4.0"
+    # Eliminar
+    def traslado_iva_node
+      impuestos_node.traslado_iva
+    end
 
-    @docxml.add_child root
-    @docxml
+    def load_private_key
+      return unless defined?(@key_der) && defined?(@key_pass)
+      
+      @sat_csd ||= SatCsd.new
+      @sat_csd.set_crypted_private_key(@key_der, @key_pass)
+    end
   end
 end

data/lib/cfdi40/concepto.rb

@@ -0,0 +1,126 @@
+# Represents node 'concepto'
+#
+# * Attribute +Importe+ represente gross amount. Gross amount id before taxes and the result of multiply
+#   +ValorUnitario+ by +Cantidad+
+#   
+module Cfdi40
+  class Concepto < Node
+    define_attribute :clave_prod_serv, xml_attribute: 'ClaveProdServ'
+    define_attribute :no_identificacion,xml_attribute: 'NoIdentificacion'
+    define_attribute :cantidad, xml_attribute: 'Cantidad', default: 1
+    define_attribute :clave_unidad, xml_attribute: 'ClaveUnidad'
+    define_attribute :unidad, xml_attribute: 'Unidad'
+    define_attribute :descripcion, xml_attribute: 'Descripcion'
+    define_attribute :valor_unitario, xml_attribute: 'ValorUnitario', format: :t_Importe
+    define_attribute :importe, xml_attribute: 'Importe', format: :t_Importe
+    define_attribute :descuento, xml_attribute: 'Descuento', format: :t_Importe
+    define_attribute :objeto_impuestos, xml_attribute: 'ObjetoImp', default: '01'
+
+    attr_accessor :tasa_iva, :tasa_ieps, :precio_neto, :precio_bruto
+    attr_reader :iva, :ieps, :base_iva, :importe_neto, :importe_bruto
+
+    def initialize
+      @tasa_iva = 0.16
+      @tasa_ieps = 0
+      super
+    end
+
+    # Calculate taxes, amounts from gross price
+    # or net price
+    def calculate!
+      set_defaults
+      assign_objeto_imp
+      if defined?(@precio_neto) && !@precio_neto.nil?
+        calculate_from_net_price
+      elsif defined?(@precio_bruto) && !@precio_bruto.nil?
+        calculate_from_gross_price
+      elsif !self.valor_unitario.nil?
+        @precio_bruto = valor_unitario
+        calculate_from_gross_price
+      end
+      add_info_to_traslado_iva
+      # TODO: add_info_to_traslado_ieps if @ieps > 0
+      true
+    end
+
+    def objeto_impuestos?
+      objeto_impuestos == '02'
+    end
+
+    def traslado_nodes
+      return [] if impuestos_node.nil?
+
+      impuestos_node.traslado_nodes
+    end
+
+    private
+
+    def calculate_from_net_price
+      set_defaults
+      @importe_neto = precio_neto * cantidad
+      breakdown_taxes
+      update_xml_attributes
+    end
+
+    def breakdown_taxes
+      @base_iva = @importe_neto / (1 + tasa_iva)
+      @iva = @importe_neto - @base_iva
+      @base_ieps = @base_iva / (1 + tasa_ieps)
+      @ieps = @base_iva - @base_ieps 
+      @importe_bruto = @base_ieps
+      @precio_bruto = @importe_bruto / @cantidad
+    end
+
+    def calculate_from_gross_price
+      @importe_bruto = @precio_bruto * cantidad
+      add_taxes
+      update_xml_attributes
+    end
+
+    def add_taxes
+      @base_ieps = @importe_bruto
+      @ieps = @base_ieps * tasa_ieps
+      @base_iva = @base_ieps + @ieps
+      @iva = @base_iva * tasa_iva
+      @importe_neto = @base_iva + @iva
+      @precio_neto = @importe_neto / cantidad
+    end
+
+    def update_xml_attributes
+      self.importe = @importe_bruto
+      self.valor_unitario = @precio_bruto
+    end
+
+    def add_info_to_traslado_iva
+      return unless @iva > 0
+
+      traslado_iva_node.importe = @iva
+      traslado_iva_node.base = @base_iva
+      traslado_iva_node.tasa_o_cuota = @tasa_iva
+    end
+
+    def assign_objeto_imp
+      return if objeto_impuestos == '03'
+
+      self.objeto_impuestos = (@tasa_iva > 0 || @tasa_ieps > 0 ? '02' : '01')
+    end
+
+    def impuestos_node
+      return @impuestos_node if defined?(@impuestos_node)
+      return nil unless objeto_impuestos?
+
+      @impuestos_node = children_nodes.select { |child| child.is_a?(Impuestos) }.first
+      return if @impuestos_node
+
+      @impuestos_node = Impuestos.new
+      self.children_nodes << @impuestos_node
+      @impuestos_node
+    end
+
+    def traslado_iva_node
+      return nil unless impuestos_node.is_a?(Impuestos)
+
+      impuestos_node.traslado_iva
+    end
+  end
+end

data/lib/cfdi40/conceptos.rb

@@ -0,0 +1,4 @@
+module Cfdi40
+  class Conceptos < Node
+  end
+end

data/lib/cfdi40/emisor.rb

@@ -0,0 +1,7 @@
+module Cfdi40
+  class Emisor < Node
+    define_attribute :rfc, xml_attribute: 'Rfc'
+    define_attribute :nombre, xml_attribute: 'Nombre'
+    define_attribute :regimen_fiscal, xml_attribute: 'RegimenFiscal'
+  end
+end

data/lib/cfdi40/impuestos.rb

@@ -0,0 +1,28 @@
+module Cfdi40
+  class Impuestos < Node
+    define_attribute :total_impuestos_retenidos, xml_attribute: 'TotalImpuestosRetenidos', format: :t_Importe
+    define_attribute :total_impuestos_trasladados, xml_attribute: 'TotalImpuestosTrasladados', format: :t_Importe
+
+    def traslados
+      return @traslados if defined?(@traslados)
+
+      @traslados = Traslados.new
+      self.children_nodes << @traslados
+      @traslados
+    end
+
+    def traslados_node
+      children_nodes.select { |n| n.is_a?(Traslados)}.first
+    end
+
+    def traslado_nodes
+      return [] if traslados_node.nil?
+
+      traslados_node.traslado_nodes
+    end
+
+    def traslado_iva
+      traslados.traslado_iva
+    end
+  end
+end

data/lib/cfdi40/node.rb

@@ -0,0 +1,122 @@
+module Cfdi40
+  class Node
+    # Nokigir XML Document for the xml_node
+    attr_accessor :xml_document, :xml_parent, :children_nodes
+
+    def initialize
+      self.class.verify_class_variables
+      @children_nodes = []
+    end
+
+    # Use class variables to define attributes used to create nodes
+    # Class variables are the same for children classes, so are organized by
+    # the name of the class.
+    def self.verify_class_variables
+      @@attributes ||= {}
+      @@attributes[name] ||= {}
+      @@namespaces ||= {}
+      @@namespaces[name] ||= {}
+      @@default_values ||= {}
+      @@default_values[name] ||= {}
+      @@formats ||= {}
+      @@formats[name] ||= {}
+    end
+
+    def self.define_attribute(accessor, xml_attribute:, default: nil, format: nil, readonly: false)
+      verify_class_variables
+      if readonly
+        attr_reader accessor.to_sym
+      else
+        attr_accessor accessor.to_sym
+      end
+      @@attributes[name][accessor.to_sym] = xml_attribute
+      if default
+        @@default_values[name][accessor.to_sym] = default
+      end
+      if format
+        @@formats[name][accessor.to_sym] = format
+      end
+    end
+
+    def self.define_namespace(namespace, value)
+      verify_class_variables
+      @@namespaces[name][namespace] = value
+    end
+
+    def self.namespaces
+      @@namespaces[name]
+    end
+
+    def self.attributes
+      @@attributes[name]
+    end
+
+    def self.default_values
+      @@default_values[name]
+    end
+
+    def self.formats
+      @@formats[name]
+    end
+
+    def set_defaults
+      return if self.class.default_values.nil?
+
+      self.class.default_values.each do |accessor, value|
+        next unless attibute_is_null?(accessor)
+
+        instance_variable_set "@#{accessor}".to_sym, value
+      end
+    end
+
+    def attibute_is_null?(accessor)
+      return true unless instance_variable_defined?("@#{accessor}".to_sym)
+
+      instance_variable_get("@#{accessor}".to_sym).nil?
+    end
+
+    def create_xml_node
+      set_defaults
+      if self.respond_to?(:before_add, true)
+        self.before_add
+      end
+      xml_node = xml_document.create_element("cfdi:#{self.class.name.split('::').last}")
+      add_namespaces_to(xml_node)
+      add_attributes_to(xml_node)
+      add_children_to(xml_node)
+      xml_parent.add_child xml_node
+    end
+
+    def add_namespaces_to(xml_node)
+      self.class.namespaces.each do |namespace, value|
+        xml_node.add_namespace namespace, value
+      end
+    end
+
+    def add_attributes_to(node)
+      self.class.attributes.each do |object_accessor, xml_attribute|
+        next unless respond_to?(object_accessor)
+        next if public_send(object_accessor).nil?
+
+        node[xml_attribute] = formated_value(object_accessor)
+      end
+    end
+
+    def add_children_to(xml_node)
+      children_nodes.each do |node|
+        node.xml_document = xml_document
+        node.xml_parent = xml_node
+        node.create_xml_node
+      end
+    end
+
+    def formated_value(accessor)
+      case self.class.formats[accessor]
+      when :t_Importe
+        sprintf("%0.6f", public_send(accessor).to_f)
+      else
+        public_send(accessor)
+      end
+    end
+  end
+end

data/lib/cfdi40/receptor.rb

@@ -0,0 +1,11 @@
+module Cfdi40
+  class Receptor < Node
+    define_attribute :rfc, xml_attribute: 'Rfc'
+    define_attribute :nombre, xml_attribute: 'Nombre'
+    define_attribute :domicilio_fiscal, xml_attribute: 'DomicilioFiscalReceptor'
+    define_attribute :residencia_fiscal, xml_attribute: 'ResidenciaFiscal'
+    define_attribute :num_reg_id_trib, xml_attribute: 'NumRegIdTrib' 
+    define_attribute :regimen_fiscal, xml_attribute: 'RegimenFiscalReceptor'
+    define_attribute :uso_cfdi, xml_attribute: 'UsoCFDI'
+  end
+end