cfdi 0.0.9 → 0.1.0

data/lib/comun.rb

@@ -1,5 +1,9 @@
+# Mkay, quiero que mis floats tengan dos decimales a huevo
 class Float
   
+  # Lo que dice la clase
+  # 
+  # @return [String] El string de este float con dos decimales
   def to_s
     sprintf('%.2f', self)
   end
@@ -8,8 +12,15 @@ end
 
 module CFDI
 
+
+  # Un elemento del comprobante con métodos mágicos y especiales
   class ElementoComprobante
     
+
+    # Crear este elemento y settear lo que le pasemos como hash en un tipo de dato adecuado
+    # @param  data [Hash] Los datos para este elemento
+    # 
+    # @return [CFDI::ElementoComprobante] El elemento creado
     def initialize data={}
       #puts self.class
       data.each do |k,v|
@@ -18,11 +29,19 @@ module CFDI
         self.send method, v
       end
     end
-    
+
+
+    # Los elementos para generar la cadena original de este comprobante
+    # 
+    # @return [Array] idem
     def self.data
       @cadenaOriginal
     end
 
+
+    # Un array con los datos de la cadena original para este elemento
+    # 
+    # @return [Array] idem
     def cadena_original
       params = []
       data = {}
@@ -32,7 +51,11 @@ module CFDI
       data.each {|key| params.push instance_variable_get('@'+key.to_s) }
       return params
     end
-    
+
+
+    # Los datos xmleables de este elemento
+    # 
+    # @return [Hash] idem
     def to_h
       h = {}
       self.class.data.each do |v|

data/lib/concepto.rb

@@ -1,11 +1,14 @@
 module CFDI
 
+  # Un concepto del comprobante
   class Concepto < ElementoComprobante
     
+    # @private
     @cadenaOriginal = [:cantidad, :unidad, :noIdentificacion, :descripcion, :valorUnitario, :importe]
-    #@data = @cadenaOriginal
+    # @private
     attr_accessor *@cadenaOriginal
     
+    # @private
     def cadena_original
       return [
         @cantidad.to_i,
@@ -16,17 +19,33 @@ module CFDI
         self.importe
       ]
     end
-    
-    def valorUnitario= vu
-      @valorUnitario = vu.to_f
+
+
+    # Aigna el valor unitario de este concepto
+    # @param  dineros [String, Float, #to_f] Cualquier cosa que responda a #to_f
+    # 
+    # @return [Float] El valor unitario como Float
+    def valorUnitario= dineros
+      @valorUnitario = dineros.to_f
+      @valorUnitario
     end
-    
+
+
+    # El importe de este concepto
+    # 
+    # @return [Float] El valor unitario multiplicado por la cantidad
     def importe
       return @valorUnitario*@cantidad
     end
-    
+
+
+    # Asigna la cantidad de (tipo) de este concepto
+    # @param  qty [Integer, String, #to_i] La cantidad, que ahuevo queremos en int, porque no, no podemos vender 1.5 Kilos de verga...
+    # 
+    # @return [Integer] La cantidad
     def cantidad= qty
       @cantidad = qty.to_i
+      @cantidad
     end
     
   end

data/lib/entidad.rb

@@ -1,10 +1,21 @@
 module CFDI
   
+  # Una persona fiscal
+  # 
+  # @attr rfc [String] El RFC
+  # @attr nombre [String] El nombre o razón social de la entidad
+  # @attr domicilioFiscal [CFDI::Domicilio, Hash] El domicilio de esta entidad
+  # @attr regimenFiscal [String] El régimen fiscal, sólo de un emisor
+  # @attr expedidoEn [CFDI::Domicilio, Hash] El domicilio de la sucursal de emisión
   class Entidad < ElementoComprobante
+    # @private
     @cadenaOriginal = [:rfc, :nombre, :domicilioFiscal, :expedidoEn, :regimenFiscal]
+    # @private
     @data = @cadenaOriginal
+    # @private
     attr_accessor *@cadenaOriginal
     
+    # @private
     def cadena_original
       expedido = @expedidoEn ? @expedidoEn.cadena_original : nil
       return [
@@ -15,19 +26,29 @@ module CFDI
         @regimenFiscal
       ].flatten
     end
-    
+
+
+    # Asigna un domicilioFiscal
+    # @param  domicilio [CFDI::Domicilio, Hash] El domicilio de esta entidad
+    # 
+    # @return [CFDI::Domicilio] idem
     def domicilioFiscal= domicilio
       domicilio = Domicilio.new domicilio unless domicilio.is_a? Domicilio
       @domicilioFiscal = domicilio
+      @domicilioFiscal
     end
     
+    # Designa dónde se expidió el comprobante, sólo para Entidades de tipo "Emisor"
+    # @param  domicilio [CFDI::Domicilio, Hash] El domicilio de expedición de este emisor
+    # 
+    # @return [CFDI::Domicilio] idem
     def expedidoEn= domicilio
       return if !domicilio
       domicilio = Domicilio.new domicilio unless domicilio.is_a? Domicilio
       @expedidoEn = domicilio
     end
     
-    
+    # @private
     def ns
       return ({
         nombre: @nombre,
@@ -36,8 +57,22 @@ module CFDI
     end
     
   end
-  
+
+
+  # Un domicilio
+  # 
+  # @attr [String] calle La calle
+  # @attr [String] noExterior El número exterior
+  # @attr [String] noInterior El número interior
+  # @attr [String] colonia La colonia
+  # @attr [String] localidad La localidad (o ciudad)
+  # @attr [String] referencia La referencia: lotería!.
+  # @attr [String] municipio El municipio
+  # @attr [String] estado El estado
+  # @attr [String] pais El país
+  # @attr [String] codigoPostal El código postal
   class Domicilio < ElementoComprobante
+
     @cadenaOriginal = [:calle, :noExterior, :noInterior, :colonia, :localidad, :referencia, :municipio, :estado, :pais, :codigoPostal]
     attr_accessor *@cadenaOriginal
     

data/lib/key.rb

@@ -2,8 +2,18 @@ module CFDI
   
   require 'openssl'
   
+  # Una llave privada, en formato X509 no PKCS7
+  # 
+  # Para convertirlos, nomás hacemos 
+  #     openssl pkcs8 -inform DER -in nombreGiganteDelSAT.key -passin pass:miFIELCreo >> certX509.pem
   class Key < OpenSSL::PKey::RSA
-   
+
+
+    # Crea una llave privada
+    # @param  file [IO, String] El `path` de esta llave o los bytes de la misma
+    # @param  password=nil [String, nil] El password de esta llave
+    # 
+    # @return [CFDI::Key] La llave privada
     def initialize file, password=nil
       if file.is_a? String
         file = File.read(file)
@@ -12,6 +22,10 @@ module CFDI
     end
     
     # sella una factura
+    # 
+    # @param factura [CFDI::Comprobante] El comprobante a sellar
+    # 
+    # @return [CFDI::comprobante] El comprobante con el `sello`
     def sella factura
       cadena_original = factura.cadena_original
       factura.sello = Base64::encode64(self.sign(OpenSSL::Digest::SHA1.new, cadena_original)).gsub(/\n/, '')

data/lib/xml.rb

@@ -1,5 +1,10 @@
 module CFDI
 
+
+  # Crea un CFDI::Comprobante desde un string XML
+  # @param  data [String, IO] El XML a parsear, según acepte Nokogiri
+  # 
+  # @return [CFDI::Comprobante] El comprobante parseado
   def self.from_xml(data)
     xml = Nokogiri::XML(data);
     xml.remove_namespaces!

data/test/comprobante_spec.rb

@@ -0,0 +1,57 @@
+require_relative '../lib/cfdi.rb'
+
+describe CFDI::Comprobante do
+
+  it "debe de poder instanciar sin datos" do
+    comprobante = CFDI::Comprobante.new
+    defaults = {
+      :version=>"3.2",
+      :fecha=>nil,
+      :tipoDeComprobante=>"ingreso",
+      :formaDePago=>nil,
+      :condicionesDePago=>nil,
+      :subTotal=>0,
+      :TipoCambio=>1,
+      :moneda=>"pesos",
+      :total=>0.0,
+      :metodoDePago=>nil,
+      :lugarExpedicion=>nil,
+      :NumCtaPago=>nil,
+      :emisor=>nil,
+      :receptor=>nil,
+      :conceptos=>[],
+      :serie=>nil,
+      :folio=>nil,
+      :sello=>nil,
+      :noCertificado=>nil,
+      :certificado=>nil,
+      :complemento=>nil,
+      :cancelada=>nil,
+      :impuestos=>[]
+    }
+    comprobante.to_h.should be_eql(defaults)
+  end
+
+  it "debe de poder settear defaults" do
+    opts = CFDI::Comprobante.configure({defaults: {version: '2.0'}})
+    comprobante = CFDI::Comprobante.new
+    comprobante.version.should == '2.0'
+  end
+
+  it "debe de generar un comprobante desde XML" do
+    comprobante = CFDI.from_xml(File.read('./examples/data/cfdi.xml'))
+    returns = {:version=>"3.2", :fecha=>"2013-10-15T01:33:32", :tipoDeComprobante=>"ingreso", :formaDePago=>"PAGO EN UNA SOLA EXHIBICION", :condicionesDePago=>"Sera marcada como pagada en cuanto el receptor haya cubierto el pago.", :subTotal=>11000.0, :TipoCambio=>1, :moneda=>"pesos", :total=>12760.0, :metodoDePago=>"Transferencia Bancaria", :lugarExpedicion=>"Nutopia, Nutopia", :NumCtaPago=>nil, :emisor=>{:rfc=>"XAXX010101000", :nombre=>"Me cago en sus estándares S.A. de C.V.", :domicilioFiscal=>{:calle=>"Calle Feliz", :noExterior=>"42", :noInterior=>"314", :colonia=>"Centro", :localidad=>"No se que sea esto, pero va", :referencia=>"Sin Referencia", :municipio=>"Nutopía", :estado=>"Nutopía", :pais=>"Nutopía", :codigoPostal=>"31415"}, :expedidoEn=>{:calle=>"Calle Feliz", :noExterior=>"42", :noInterior=>nil, :colonia=>"Centro", :localidad=>"No se que sea esto, pero va", :referencia=>"Sin Referencia", :municipio=>"Nutopía", :estado=>"Nutopía", :pais=>"Nutopía", :codigoPostal=>"31415"}, :regimenFiscal=>"Pruebas Fiscales"}, :receptor=>{:rfc=>"XAXX010101000", :nombre=>"El SAT apesta S. de R.L.", :domicilioFiscal=>{:calle=>nil, :noExterior=>nil, :noInterior=>nil, :colonia=>nil, :localidad=>nil, :referencia=>"Sin Referencia", :municipio=>nil, :estado=>"Nutopía", :pais=>"Nutopía", :codigoPostal=>nil}, :expedidoEn=>nil, :regimenFiscal=>nil}, :conceptos=>[{:cantidad=>2, :unidad=>"Kilos", :noIdentificacion=>"KDV", :descripcion=>"Verga", :valorUnitario=>5500.0, :importe=>11000.0}], :serie=>nil, :folio=>"1", :sello=>"igFu7Q9Z98n6xFSLMv7a2y8ZlJCO+pgTX3xDAUt5xSpX3dHOKXkTHBAf4P/oHHDm3xkYkaNBfPEzpVFDrRVjL2rvkR5T9rsFqb4cl6DOo4RrRIpSR9vojLp7mFWiON9H6OFPi2b9PVAnyIx1Skb5iGIAmSQIhVYyt2DSauObY2c=", :noCertificado=>"20001000000200000293", :certificado=>"MIIE2jCCA8KgAwIBAgIUMjAwMDEwMDAwMDAyMDAwMDAyOTMwDQYJKoZIhvcNAQEFBQAwggFcMRowGAYDVQQDDBFBLkMuIDIgZGUgcHJ1ZWJhczEvMC0GA1UECgwmU2VydmljaW8gZGUgQWRtaW5pc3RyYWNpw7NuIFRyaWJ1dGFyaWExODA2BgNVBAsML0FkbWluaXN0cmFjacOzbiBkZSBTZWd1cmlkYWQgZGUgbGEgSW5mb3JtYWNpw7NuMSkwJwYJKoZIhvcNAQkBFhphc2lzbmV0QHBydWViYXMuc2F0LmdvYi5teDEmMCQGA1UECQwdQXYuIEhpZGFsZ28gNzcsIENvbC4gR3VlcnJlcm8xDjAMBgNVBBEMBTA2MzAwMQswCQYDVQQGEwJNWDEZMBcGA1UECAwQRGlzdHJpdG8gRmVkZXJhbDESMBAGA1UEBwwJQ295b2Fjw6FuMTQwMgYJKoZIhvcNAQkCDCVSZXNwb25zYWJsZTogQXJhY2VsaSBHYW5kYXJhIEJhdXRpc3RhMB4XDTEyMTAyNjE5MjI0M1oXDTE2MTAyNjE5MjI0M1owggFTMUkwRwYDVQQDE0BBU09DSUFDSU9OIERFIEFHUklDVUxUT1JFUyBERUwgRElTVFJJVE8gREUgUklFR08gMDA0IERPTiBNQVJUSU4gMWEwXwYDVQQpE1hBU09DSUFDSU9OIERFIEFHUklDVUxUT1JFUyBERUwgRElTVFJJVE8gREUgUklFR08gMDA0IERPTiBNQVJUSU4gQ09BSFVJTEEgWSBOVUVWTyBMRU9OIEFDMUkwRwYDVQQKE0BBU09DSUFDSU9OIERFIEFHUklDVUxUT1JFUyBERUwgRElTVFJJVE8gREUgUklFR08gMDA0IERPTiBNQVJUSU4gMSUwIwYDVQQtExxBQUQ5OTA4MTRCUDcgLyBIRUdUNzYxMDAzNFMyMR4wHAYDVQQFExUgLyBIRUdUNzYxMDAzTURGUk5OMDkxETAPBgNVBAsTCFNlcnZpZG9yMIGfMA0GCSqGSIb3DQEBAQUAA4GNADCBiQKBgQDlrI9loozd+UcW7YHtqJimQjzX9wHIUcc1KZyBBB8/5fZsgZ/smWS4Sd6HnPs9GSTtnTmM4bEgx28N3ulUshaaBEtZo3tsjwkBV/yVQ3SRyMDkqBA2NEjbcum+e/MdCMHiPI1eSGHEpdESt55a0S6N24PW732Xm3ZbGgOp1tht1wIDAQABox0wGzAMBgNVHRMBAf8EAjAAMAsGA1UdDwQEAwIGwDANBgkqhkiG9w0BAQUFAAOCAQEAuoPXe+BBIrmJn+IGeI+m97OlP3RC4Ct3amjGmZICbvhI9BTBLCL/PzQjjWBwU0MG8uK6e/gcB9f+klPiXhQTeI1YKzFtWrzctpNEJYo0KXMgvDiputKphQ324dP0nzkKUfXlRIzScJJCSgRw9ZifKWN0D9qTdkNkjk83ToPgwnldg5lzU62woXo4AKbcuabAYOVoC7owM5bfNuWJe566UzD6i5PFY15jYMzi1+ICriDItCv3S+JdqyrBrX3RloZhdyXqs2Htxfw4b1OcYboPCu4+9qM3OV02wyGKlGQMhfrXNwYyj8huxS1pHghEROM2Zs0paZUOy+6ajM+Xh0LX2w==", :complemento=>nil, :cancelada=>nil, :impuestos=>[{:impuesto=>"IVA"}]}
+    comprobante.to_h.should be_eql(returns)
+  end
+
+  it "no debe de generar atributos vacios" do
+    comprobante = CFDI.from_xml(File.read('./examples/data/cfdi.xml'))
+    #el comprobante de XML no tiene numero de cuenta de pago
+    comprobante.to_xml.should_not =~ /NumCtaPago/
+
+    #si quitamos referencia
+    comprobante.emisor.domicilioFiscal.referencia = nil
+    comprobante.to_xml.should_not =~ /DomicilioFiscal.+referencia/
+  end
+  
+end

data/test/entidar_spec.rb

@@ -0,0 +1,20 @@
+require_relative '../lib/cfdi.rb'
+
+describe CFDI::Entidad do
+
+  it 'debe de crear domicilios desde hashes' do
+    entidad = CFDI::Entidad.new({
+      rfc: 'XAXX010101000',
+      nombre: 'Mira un Salmón S.A. de C.V.',
+      domicilioFiscal: {
+        referencia: 'Sin Referencia',
+        pais: 'México',
+        estado: 'Nutopia'
+      }
+    })
+
+    entidad.domicilioFiscal.should be_a CFDI::Domicilio
+  end
+
+
+end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: cfdi
 version: !ruby/object:Gem::Version
-  version: 0.0.9
+  version: 0.1.0
 platform: ruby
 authors:
 - Roberto Hidalgo
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2013-10-30 00:00:00.000000000 Z
+date: 2013-10-31 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: nokogiri
@@ -24,6 +24,20 @@ dependencies:
     - - '>='
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - '>='
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Comprobantes fiscales digitales por internet
 email:
 - un@rob.mx
@@ -36,6 +50,29 @@ files:
 - LICENSE.txt
 - Rakefile
 - cfdi.gemspec
+- doc/CFDI.html
+- doc/CFDI/Certificado.html
+- doc/CFDI/Complemento.html
+- doc/CFDI/Comprobante.html
+- doc/CFDI/Concepto.html
+- doc/CFDI/Domicilio.html
+- doc/CFDI/ElementoComprobante.html
+- doc/CFDI/Entidad.html
+- doc/CFDI/Key.html
+- doc/Float.html
+- doc/_index.html
+- doc/class_list.html
+- doc/css/common.css
+- doc/css/full_list.css
+- doc/css/style.css
+- doc/file_list.html
+- doc/frames.html
+- doc/index.html
+- doc/js/app.js
+- doc/js/full_list.js
+- doc/js/jquery.js
+- doc/method_list.html
+- doc/top-level-namespace.html
 - examples/crear_factura.rb
 - examples/data/_empty
 - examples/data/cfdi.xml
@@ -50,6 +87,8 @@ files:
 - lib/key.rb
 - lib/xml.rb
 - readme.md
+- test/comprobante_spec.rb
+- test/entidar_spec.rb
 homepage: https://github.com/unRob/cfdi
 licenses:
 - WTFPL
@@ -75,4 +114,7 @@ rubygems_version: 2.0.3
 signing_key: 
 specification_version: 4
 summary: Digitales!! por Internet!!
-test_files: []
+test_files:
+- test/comprobante_spec.rb
+- test/entidar_spec.rb
+has_rdoc: true