cfdi_processor 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d34c400420a533b160065f7a9d86ab6e5bcdccf17df4eb50471b1b662e145b27
+  data.tar.gz: a70f5fb37aa9c54143c5a47b0aa1c12d00ed46fdd510a8b527b0b0109e0e7832
+SHA512:
+  metadata.gz: 8ae268c20f3050453d38737e779ef4fac26535748b9cb98e452341a90bd96a8c7711ad723a51bf65ebe8b1682802e44fbc4df18ee053c4fcc507444a78fc50b7
+  data.tar.gz: 22dae7b928933148665bb5b6fc22fad9aac1c6833980632a5e39011594421291b0634fc3caa089ae0214c2b3bb1790e166caf7ae5289da205ef35f1e0bdca118

data/.coveralls.yml

@@ -0,0 +1 @@
+service_name: travis-ci

data/.gitignore

@@ -0,0 +1,12 @@
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status
+.DS_Store

data/.rspec

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

data/.travis.yml

@@ -0,0 +1,6 @@
+sudo: false
+language: ruby
+cache: bundler
+rvm:
+  - 2.6.5
+before_install: gem install bundler -v 1.17.3

data/Gemfile

@@ -0,0 +1,10 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+group :development, :test do
+  gem 'coveralls', require: false
+end
+
+# Specify your gem's dependencies in cfdi_processor.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    cfdi_processor (1.0.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activesupport (6.0.3.1)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2, >= 2.2.2)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.6)
+    coveralls (0.8.23)
+      json (>= 1.8, < 3)
+      simplecov (~> 0.16.1)
+      term-ansicolor (~> 1.3)
+      thor (>= 0.19.4, < 2.0)
+      tins (~> 1.6)
+    diff-lcs (1.3)
+    docile (1.3.2)
+    i18n (1.8.3)
+      concurrent-ruby (~> 1.0)
+    json (2.3.0)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.1)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    pry (0.13.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    rake (13.0.1)
+    rspec (3.9.0)
+      rspec-core (~> 3.9.0)
+      rspec-expectations (~> 3.9.0)
+      rspec-mocks (~> 3.9.0)
+    rspec-core (3.9.2)
+      rspec-support (~> 3.9.3)
+    rspec-expectations (3.9.2)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-mocks (3.9.1)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.9.0)
+    rspec-support (3.9.3)
+    shoulda-matchers (4.3.0)
+      activesupport (>= 4.2.0)
+    simplecov (0.16.1)
+      docile (~> 1.1)
+      json (>= 1.8, < 3)
+      simplecov-html (~> 0.10.0)
+    simplecov-html (0.10.2)
+    sync (0.5.0)
+    term-ansicolor (1.7.1)
+      tins (~> 1.0)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tins (1.25.0)
+      sync
+    tzinfo (1.2.7)
+      thread_safe (~> 0.1)
+    zeitwerk (2.3.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 2.1.4)
+  cfdi_processor!
+  coveralls
+  i18n (~> 1.8, >= 1.8.3)
+  nokogiri (~> 1.6, >= 1.6.8)
+  pry (~> 0.13.0)
+  rake (>= 12.3.3)
+  rspec (~> 3.0)
+  shoulda-matchers (~> 4.3)
+
+BUNDLED WITH
+   2.1.4

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2020 TODO: Write your name
+
+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,72 @@
+# CfdiProcessor
+
+Extracts the information from the CFDI (Mexico) and converts it into a hash.
+
+[![Build Status](https://travis-ci.com/armando1339/cfdi_processor.svg?branch=master)](https://travis-ci.com/armando1339/cfdi_processor) [![Coverage Status](https://coveralls.io/repos/github/armando1339/cfdi_processor/badge.svg?branch=master)](https://coveralls.io/github/armando1339/cfdi_processor?branch=master)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'cfdi_processor'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install cfdi_processor
+
+## Usage
+
+### Extract CFDI Data
+
+Create an instance of `CfdiProcessor::StampedExtractor` and pass to it a xml string.
+
+```ruby
+xml_data = CfdiProcessor::StampedExtractor.new(xml_string)
+```
+
+To access to the data extracted.
+
+```ruby
+
+# => Execute the instance methods
+xml_data.receipt
+xml_data.issuer
+xml_data.receiver
+xml_data.concepts
+xml_data.taxes
+
+```
+
+To access to the XML string and Nokogiri document.
+
+```ruby
+
+# =>
+xml_data.xml
+
+# =>
+xml_data.nokogiri_xml
+
+```
+
+## Contributing
+
+Bug report or pull request are welcome. Make a pull request:
+
+- Clone the repo
+- Create a new feature branch
+- Commit your changes
+- Push the new branch
+- Create new pull-request
+
+Please write tests if necessary.
+
+## 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,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "cfdi_processor"
+
+# 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/cfdi_processor.gemspec

@@ -0,0 +1,46 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "cfdi_processor/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "cfdi_processor"
+  spec.version       = CfdiProcessor::VERSION
+  spec.authors       = ["Armando Alejandre"]
+  spec.email         = ["armando1339@gmail.com"]
+
+  spec.summary       = %q{Extracts the information from the cfdi and converts it into a hash}
+  spec.description   = %q{Extracts the information from the cfdi and converts it into a hash}
+  spec.homepage      = "https://buhocontable.com/"
+  spec.license       = "MIT"
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata["allowed_push_host"] = "https://rubygems.org/"
+
+    spec.metadata["homepage_uri"] = spec.homepage
+    spec.metadata["source_code_uri"] = "https://github.com/armando1339/cfdi_processor"
+    # spec.metadata["changelog_uri"] = "TODO: Put your gem's CHANGELOG.md URL here."
+  else
+    raise "RubyGems 2.0 or newer is required to protect against " \
+      "public gem pushes."
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files         = Dir.chdir(File.expand_path('..', __FILE__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  end
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "nokogiri", "~> 1.6", ">= 1.6.8"
+  spec.add_development_dependency "i18n", "~> 1.8", ">= 1.8.3"
+  spec.add_development_dependency "bundler", "~> 2.1.4"
+  spec.add_development_dependency "rake", ">= 12.3.3"
+  spec.add_development_dependency "rspec", "~> 3.0"
+  spec.add_development_dependency "shoulda-matchers", "~> 4.3"
+  spec.add_development_dependency "pry", "~> 0.13.0"
+end

data/lib/cfdi_processor.rb

@@ -0,0 +1,4 @@
+require "cfdi_processor/version"
+require "cfdi_processor/i18n"
+require "cfdi_processor/data_extractor_base"
+require "cfdi_processor/stamped_extractor"

data/lib/cfdi_processor/data_extractor_base.rb

@@ -0,0 +1,63 @@
+require "nokogiri"
+
+module CfdiProcessor
+  class DataExtractorBase
+    attr_accessor :xml, :nokogiri_xml
+
+    def initialize(xml)
+      @xml = xml
+      @nokogiri_xml = ::Nokogiri::XML(xml)
+      @nokogiri_xml.remove_namespaces!
+
+      # => Hook methods:
+      #
+      # * Execute data extraction
+      # * Translate data extracted
+      #
+      extract_data_from_xml
+      translate_data
+    end
+
+    def extract_data_from_xml
+      raise 'Undefined abstract method: #extract_data_from_xml'
+    end
+
+    def translate_data
+      raise 'Undefined abstract method: #translate_data'
+    end
+
+    # => Search for the _translate_ pattern at the beginning of the method,
+    # if it is found, look for the translation based on the end of the
+    # method name and the argument that is passed to it.
+    #
+    def method_missing(name, *args, &block)
+      if name.to_s.start_with?('_translate_')
+        resource_name = name.to_s.sub('_translate_', '')
+
+        instance_variable_get("@#{resource_name}").inject({}) do |translated, (key,value)|
+          if value.kind_of?(Array)
+            next if value.empty?
+            items = value.each do |item|
+              item.transform_keys!{ |k| I18n.t("#{args.first}.#{key}.#{k}") }
+            end
+
+            translated.merge!(I18n.t("#{args.first}.#{resource_name}.#{key}") => items)
+          else
+            translated.merge!(I18n.t("#{args.first}.#{resource_name}.#{key}") => value)
+          end
+
+          instance_variable_set("@#{resource_name}", translated)         
+        end
+      else 
+        super
+      end
+    end
+  end
+end
+
+
+
+
+
+
+

data/lib/cfdi_processor/i18n.rb

@@ -0,0 +1,9 @@
+begin
+  require "i18n"
+rescue LoadError => e
+  puts "The i18n gem is not available. Please add it to your Gemfile and run bundle install"
+  raise e
+end
+
+I18n.load_path << File.expand_path("locale/en.yml", __dir__)
+I18n.locale = :en

data/lib/cfdi_processor/locale/en.yml

@@ -0,0 +1,96 @@
+en:
+  cfdi:
+    receipt:
+      Version: version
+      Serie: serie
+      Folio: folio_ui
+      Fecha: date_issued
+      Sello: stamp
+      FormaPago: payment_form
+      NoCertificado: certificate_number
+      Certificado: certificate
+      CondicionesDePago: payment_conditions
+      SubTotal: subtotal
+      Descuento: discount
+      Moneda: currency
+      TipoCambio: exchange_rate
+      Total: total
+      TipoDeComprobante: invoice_type
+      MetodoPago: payment_method
+      LugarExpedicion: expedition_place
+      Confirmacion: confirmation
+    issuer:
+      Rfc: rfc
+      Nombre: legal_name
+      RegimenFiscal: fiscal_regime
+    receiver:
+      Rfc: rfc
+      Nombre: legal_name
+      ResidenciaFiscal: tax_residency
+      NumRegIdTrib: tax_identity_registration_number
+      UsoCFDI: cfdi_use
+    concepts:
+      ClaveProdServ: sat_product_id
+      NoIdentificacion: identification_number
+      Cantidad: quantity
+      ClaveUnidad: unit
+      Unidad: unit_measure
+      Descripcion: description
+      ValorUnitario: unit_value
+      Importe: price
+      Descuento: discount
+      Traslados: transferred
+      Retenidos: detained
+    taxes:
+      TotalImpuestosTrasladados: total_taxes_transferred
+      TotalImpuestosRetenidos: total_taxes_detained
+      Traslados: transferred
+      Retenidos: detained
+    Traslados:
+      Base: base
+      Impuesto: tax
+      TipoFactor: factor_type
+      TasaOCuota: rate_or_fee
+      Importe: import
+    Retenidos:
+      Base: base
+      Impuesto: tax
+      TipoFactor: factor_type
+      TasaOCuota: rate_or_fee
+      Importe: import
+
+    # cfdi_related:
+    #   TipoRelacion: relationship_type
+    # related:
+    #   UUID: uuid
+    
+    # tax_transferred:
+      
+    # tax_detained:
+    #   Base: base
+    #   Impuesto: tax
+    #   TipoFactor: factor_type
+    #   TasaOCuota: rate_or_fee
+    #   Importe: import
+    # customs_information: # InformacionAduanera
+    #   NumeroPedimento: requirement_number
+    # property_account: # CuentaPredial
+    #   Numero: number
+    # part: # Parte
+    #   ClaveProdServ: prod_or_svc_key
+    #   NoIdentificacion: identification_number
+    #   Cantidad: quantity
+    #   Unidad: unit_measure
+    #   Descripcion: description
+    #   ValorUnitario: unit_value
+    #   Importe: amount
+    
+    # detained:
+      
+    # transferred:
+      
+    # cancellation:
+    #   Fecha: date
+    #   RfcEmisor: rfc
+    # uuid:
+    #   UUID: folio_fiscal

data/lib/cfdi_processor/stamped_extractor.rb

@@ -0,0 +1,55 @@
+module CfdiProcessor
+  class StampedExtractor < CfdiProcessor::DataExtractorBase
+    attr_accessor :receipt, :issuer, :receiver, :concepts, :taxes
+
+    def extract_data_from_xml
+      receipt_data_from_xml
+      issuer_data_from_xml
+      receiver_data_from_xml
+      concepts_data_from_xml
+      taxes_data_from_xml
+
+      self
+    end
+
+    def translate_data
+      _translate_receipt(:cfdi)
+      _translate_issuer(:cfdi)
+      _translate_receiver(:cfdi)
+      _translate_concepts(:cfdi)
+      _translate_taxes(:cfdi)
+
+      self
+    end
+
+    private
+
+    def receipt_data_from_xml
+      @receipt = nokogiri_xml.at('Comprobante').to_h
+    end
+
+    def issuer_data_from_xml
+      @issuer = nokogiri_xml.at('Emisor').to_h
+    end
+
+    def receiver_data_from_xml
+      @receiver = nokogiri_xml.at('Receptor').to_h
+    end
+
+    def concepts_data_from_xml
+      nokogiri_xml.at('Conceptos').element_children.map do |e|
+        @concepts = e.to_h
+        concepts["Traslados"]   = (e.at('Impuestos').css("Traslado").map{|e| e.to_h})
+        concepts["Retenciones"] = (e.at('Impuestos').css("Retencion").map{|e| e.to_h})
+      end 
+    end
+
+    def taxes_data_from_xml
+      nokogiri_xml.css('Comprobante Impuestos').last.element_children.map do |e|
+        @taxes = nokogiri_xml.css('Comprobante Impuestos').last.to_h
+        taxes["Traslados"]   = (e.css("Traslado").map{|e| e.to_h})
+        taxes["Retenciones"] = (e.css("Retencion").map{|e| e.to_h})
+      end
+    end
+  end
+end

data/lib/cfdi_processor/version.rb

@@ -0,0 +1,3 @@
+module CfdiProcessor
+  VERSION = "1.0.0"
+end

metadata

@@ -0,0 +1,174 @@
+--- !ruby/object:Gem::Specification
+name: cfdi_processor
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Armando Alejandre
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2020-06-15 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: nokogiri
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.6.8
+- !ruby/object:Gem::Dependency
+  name: i18n
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.8'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.8.3
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.1.4
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 12.3.3
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: shoulda-matchers
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.3'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.13.0
+description: Extracts the information from the cfdi and converts it into a hash
+email:
+- armando1339@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".coveralls.yml"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- cfdi_processor.gemspec
+- lib/cfdi_processor.rb
+- lib/cfdi_processor/data_extractor_base.rb
+- lib/cfdi_processor/i18n.rb
+- lib/cfdi_processor/locale/en.yml
+- lib/cfdi_processor/stamped_extractor.rb
+- lib/cfdi_processor/version.rb
+homepage: https://buhocontable.com/
+licenses:
+- MIT
+metadata:
+  allowed_push_host: https://rubygems.org/
+  homepage_uri: https://buhocontable.com/
+  source_code_uri: https://github.com/armando1339/cfdi_processor
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.6
+signing_key: 
+specification_version: 4
+summary: Extracts the information from the cfdi and converts it into a hash
+test_files: []