facturacr 0.1.2

data/lib/facturacr/configuration.rb

@@ -0,0 +1,51 @@
+require 'yaml'
+require 'erb'
+module FE
+  class Configuration
+    
+    attr_accessor :api_username
+    attr_accessor :api_password
+    attr_accessor :key_path
+    attr_accessor :key_password
+    attr_accessor :documents_endpoint
+    attr_accessor :authentication_endpoint
+    attr_accessor :api_client_id
+    attr_accessor :environment
+    attr_accessor :file_path
+    attr_accessor :mode
+    
+    
+    def initialize
+      @environment = "development"
+      @mode = :manual
+      @api_username = "changeme"
+      @api_password = "changeme"
+      @key_path = "resources/test.p12"
+      @key_password = "test123"
+      @api_client_id = 'api-stag'
+      @documents_endpoint = "https://api.comprobanteselectronicos.go.cr/recepcion-sandbox/v1"
+      @authentication_endpoint = "https://idp.comprobanteselectronicos.go.cr/auth/realms/rut-stag/protocol/openid-connect/token"
+    end
+    
+    def read_config_file
+      if file? && @file_path && File.exists?(@file_path)
+        template = ERB.new(File.read(@file_path))
+        result = YAML.load(template.result(binding))
+        result[@environment].each do |k,v|
+          if respond_to?(k)
+            self.send("#{k}=",v)
+          end
+        end
+      end
+    end
+    
+    def manual?
+      @mode.to_sym.eql?(:manual)
+    end
+    
+    def file?
+      @mode.to_sym.eql?(:file)
+    end
+    
+  end
+end

data/lib/facturacr/credit_note.rb

@@ -0,0 +1,33 @@
+require 'facturacr/document/regulation'
+module FE
+ 
+  class CreditNote < Document
+    
+    def initialize(args={})
+      @date = args[:date]
+      @issuer = args[:issuer]
+      @receiver = args[:receiver]
+      @items = args[:items]
+      @number = args[:number]
+      @condition = args[:condition]
+      @payment_type = args[:payment_type] || "01"
+      @document_type = "03"
+      @credit_term = args[:credit_term]
+      @summary = args[:summary]
+      @regulation = args[:regulation] ||= FE::Document::Regulation.new
+      @security_code = args[:security_code]
+      @document_situation = args[:document_situation]
+      @references = args[:references]
+      @namespaces = {
+        "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", 
+        "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+        "xmlns"=>"https://tribunet.hacienda.go.cr/docs/esquemas/2017/v4.2/notaCreditoElectronica"#,
+      }
+    end
+    
+    def document_tag
+      "NotaCreditoElectronica"
+    end
+    
+  end 
+end

data/lib/facturacr/debit_note.rb

@@ -0,0 +1,33 @@
+require 'facturacr/document/regulation'
+module FE
+ 
+  class DebitNote < Document
+    
+    def initialize(args={})
+      @date = args[:date]
+      @issuer = args[:issuer]
+      @receiver = args[:receiver]
+      @items = args[:items]
+      @number = args[:number]
+      @condition = args[:condition]
+      @payment_type = args[:payment_type] || "01"
+      @document_type = "02"
+      @credit_term = args[:credit_term]
+      @summary = args[:summary]
+      @regulation = args[:regulation] ||= FE::Document::Regulation.new
+      @security_code = args[:security_code]
+      @document_situation = args[:document_situation]
+      @references = args[:references]
+      @namespaces = {
+        "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance", 
+        "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+        "xmlns"=>"https://tribunet.hacienda.go.cr/docs/esquemas/2017/v4.2/notaDebitoElectronica"
+      }
+    end
+    
+    def document_tag
+      "NotaDebitoElectronica"
+    end
+    
+  end 
+end

data/lib/facturacr/document.rb

@@ -0,0 +1,171 @@
+require 'active_model'
+
+module FE  
+  class Document
+    include ActiveModel::Validations
+    
+    CONDITIONS = {
+      "01"=>"Contado", 
+      "02"=>"Crédito", 
+      "03"=>"Consignación", 
+      "04"=>"Apartado", 
+      "05"=>"Arrendamiento con Opción de Compra", 
+      "06"=>"Arrendamiento en Función Financiera",
+      "99"=>"Otros"
+    }
+    PAYMENT_TYPES = {
+      "01"=>"Efectivo",
+      "02"=>"Tarjeta",
+      "03"=>"Cheque",
+      "04"=>"Transferencia",
+      "05"=>"Recaudado por Terceros",
+      "99"=>"Otros"
+    }
+    DOCUMENT_TYPES = {
+      "01"=> "Factura Electronica",
+      "02"=> "Nota de débito",
+      "03"=> "Nota de crédito",
+      "04"=> "Tiquete Electrónico",
+      "05"=> "Nota de despacho",
+      "06"=> "Contrato",
+      "07"=> "Procedimiento",
+      "08"=> "Comprobante Emitido en Contingencia",
+      "99"=> "Otros"
+      
+    }
+    DOCUMENT_SITUATION = {
+      "1" => "Normal",
+      "2" => "Contingencia",
+      "3" => "Sin Internet"
+    }
+  
+    attr_accessor :serial, :date, :issuer, :receiver, :condition, :credit_term, 
+                  :payment_type, :service_type, :reference_information, 
+                  :regulation, :number, :document_type, :security_code, 
+                  :items, :references, :namespaces, :summary, :document_situation
+    
+    validates :date, presence: true
+    validates :number, presence: true
+    validates :issuer, presence: true
+    validates :condition, presence: true, inclusion: CONDITIONS.keys
+    validates :credit_term, presence: true, if: ->{condition.eql?("02")}
+    validates :payment_type, presence: true, inclusion: PAYMENT_TYPES.keys
+    validates :document_type, presence: true, inclusion: DOCUMENT_TYPES.keys
+    validates :document_situation, presence: true, inclusion: DOCUMENT_SITUATION.keys
+    validates :summary, presence: true
+    validates :regulation, presence: true
+    validates :security_code, presence: true, length: {is: 8}
+    validates :references, presence: true, if: -> {document_type.eql?("02") || document_type.eql?("03")}
+    
+    
+    def initialize
+      raise "Subclasses must implement this method"
+    end
+    
+    def document_name
+      raise "Subclasses must implement this method"
+    end
+    
+    def key
+      raise "Documento inválido: #{errors.messages}" unless valid?  
+      country = "506"
+      day = "%02d" % @date.day
+      month = "%02d" % @date.month
+      year = "%02d" % (@date.year - 2000)
+      id_number = @issuer.identification_document.id_number
+
+      type = @document_situation
+      security_code = @security_code
+
+      result = "#{country}#{day}#{month}#{year}#{id_number}#{sequence}#{type}#{security_code}"
+      raise "The key is invalid: #{result}" unless result.length.eql?(50)
+      
+      result
+    end
+    
+    def headquarters
+      @headquarters ||= "001"
+    end
+  
+    def terminal
+      @terminal ||= "00001"
+    end 
+    
+    def sequence
+      cons = ("%010d" % @number)
+      "#{headquarters}#{terminal}#{@document_type}#{cons}"
+    end
+  
+    def build_xml
+      raise "Documento inválido: #{errors.messages}" unless valid?
+      builder  = Nokogiri::XML::Builder.new
+      
+      builder.send(document_tag, @namespaces) do |xml|
+        xml.Clave key
+        xml.NumeroConsecutivo sequence
+        xml.FechaEmision @date.xmlschema
+        issuer.build_xml(xml)
+        receiver.build_xml(xml) if receiver.present?
+        xml.CondicionVenta @condition
+        xml.PlazoCredito @credit_term if @credit_term.present? && @condition.eql?("02")
+        xml.MedioPago @payment_type
+        xml.DetalleServicio do |x|
+          @items.each do |item|
+            item.build_xml(x)
+          end
+        end
+        
+        summary.build_xml(xml)
+        
+        if references.present?
+          references.each do |r|
+            r.build_xml(xml)
+          end
+        end
+        
+        regulation.build_xml(xml)
+      end
+      
+      builder
+    end
+    
+    def generate
+      build_xml.to_xml(:save_with => Nokogiri::XML::Node::SaveOptions::AS_XML)
+    end
+    
+    def api_payload
+      payload = {}
+      payload[:clave] = key
+      payload[:fecha] = @date.xmlschema
+      payload[:emisor] = {
+        tipoIdentificacion: @issuer.identification_document.document_type,
+        numeroIdentificacion: @issuer.identification_document.id_number
+      }
+      if @receiver.identification_document.present?
+        payload[:receptor] = {
+          tipoIdentificacion: @receiver.identification_document.document_type,
+          numeroIdentificacion: @receiver.identification_document.id_number
+        }
+      end
+      payload
+    end
+    
+  end
+  
+  
+end
+
+require 'facturacr/document/code'
+require 'facturacr/document/exoneration'
+require 'facturacr/document/fax'
+require 'facturacr/document/identification_document'
+require 'facturacr/document/issuer'
+require 'facturacr/document/item'
+require 'facturacr/document/location'
+require 'facturacr/document/phone_type'
+require 'facturacr/document/phone'
+require 'facturacr/document/receiver'
+require 'facturacr/document/reference'
+require 'facturacr/document/regulation'
+require 'facturacr/document/summary'
+require 'facturacr/document/tax'

data/lib/facturacr/document/code.rb

@@ -0,0 +1,4 @@
+module FE
+  
+end
+  

data/lib/facturacr/document/exoneration.rb

@@ -0,0 +1,49 @@
+module FE
+  class Document
+    class Exoneration
+      include ActiveModel::Validations
+      
+      
+      DOCUMENT_TYPES = {
+        "01" => "Compras Autorizadas",
+        "02" => "Ventas exentas a diplomáticos",
+        "03" => "Orden de Compra (Instituciones Públicas y otros organismos)",
+        "04" => "Exenciones Dirección General de Hacienda",
+        "05" => "Zonas Francas",
+        "99" => "Otros"
+      }
+      attr_accessor :document_type, :document_number, :institution, :date, :total_tax, :percentage
+      
+      validates :document_type, presence: true, inclusion: DOCUMENT_TYPES.keys
+      validates :document_number, presence: true
+      validates :institution, presence: true
+      validates :date, presence: true
+      validates :total_tax,presence: true
+      validates :percentage, presence: true
+      
+      def initialize(args={})
+        @document_type = args[:document_type]
+        @document_number = args[:document_number]
+        @institution = args[:institution]
+        @date = args[:date].xmlschema
+        @total_tax = args[:total_tax]
+        @percentage = args[:percentage]
+      end
+      
+      def build_xml(node)
+        raise "Invalid Record: #{errors.messages}" unless valid?
+        node = Nokogiri::XML::Builder.new if node.nil?
+        
+        node.Exoneracion do |xml|
+          xml.TipoDocument @document_type
+          xml.NumeroDocumento @document_number
+          xml.NombreInstitucion @institution
+          xml.FechaEmision @date
+          xml.MontoImpuesto @total_tax
+          xml.PorcentajeCompra @percentage
+        end
+      end
+      
+    end
+  end
+end

data/lib/facturacr/document/fax.rb

@@ -0,0 +1,24 @@
+require "facturacr/document"
+require 'facturacr/document/phone_type'
+require 'active_model'
+require 'nokogiri'
+
+module FE
+  class Document
+    class Fax < PhoneType
+      include ActiveModel::Validations
+      
+      attr_accessor :country_code, :number
+      
+      validates :country_code, presence: true, length: { maximum: 3 }
+      validates :number, presence: true, length: {maximum: 20}
+      
+      
+      def initialize(args={})
+        super('Fax', args[:country_code], args[:number])
+      end
+      
+    end
+    
+  end
+end

data/lib/facturacr/document/identification_document.rb

@@ -0,0 +1,41 @@
+require "facturacr/document"
+require 'active_model'
+require 'nokogiri'
+
+module FE
+  class Document
+    
+      
+      class IdentificationDocument
+        include ActiveModel::Validations
+        
+        TYPES = {'01'=>'Cédula Fisica', '02'=>'Cédula Jurídica', '03'=>'DIMEX', '04'=>'NITE'}
+        
+        attr_accessor :document_type, :id_number, :raw_id_number
+        
+        validates :document_type, presence: true, inclusion: TYPES.keys
+        validates :id_number, presence: true, length: {is: 12}
+        
+        def initialize(args={})
+          
+          @document_type = args[:type]
+          @raw_id_number = args[:number]
+          @id_number = "%012d" % args[:number]
+          
+        end
+        
+        def build_xml(node)
+          raise "Invalid Record: #{errors.messages}" unless valid?
+          node = Nokogiri::XML::Builder.new if node.nil?         
+          node.Identificacion do |x|
+            x.Tipo document_type
+            x.Numero raw_id_number
+          end
+        end      
+        def to_xml(builder)
+          build_xml(builder).to_xml
+        end
+      end
+    
+  end
+end

data/lib/facturacr/document/issuer.rb

@@ -0,0 +1,56 @@
+require "facturacr/document"
+require 'active_model'
+require 'nokogiri'
+
+module FE
+  class Document
+    
+      
+      class Issuer
+        include ActiveModel::Validations
+        
+        attr_accessor :name, :identification_document, :comercial_name, :location, :phone, :fax, :email
+        
+        validates :name, presence: true, length: { maximum: 80 }
+        validates :identification_document, presence: true
+        validates :comercial_name, length: {maximum: 80}
+        validates :location, presence: true
+        validates :email, presence: true, format: {with: /\s*\w+([-+.']\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*\s*/}
+        
+        def initialize(args={})
+          @name = args[:name]
+          @identification_document = args[:identification_document]
+          @comercial_name = args[:comercial_name]
+          @location = args[:location]
+          @phone = args[:phone]
+          @fax = args[:fax]
+          @email = args[:email]          
+        end
+        
+        def build_xml(node)  
+          raise "IdentificationDocument is invalid" if @identification_document.nil? || !@identification_document.is_a?(IdentificationDocument)
+          raise "Location is invalid" if @location.nil? || !@location.is_a?(Location)
+          raise "Phone is invalid" if !@phone.nil? && !@phone.is_a?(Phone)
+          raise "Fax is invalid" if !@fax.nil? && !@fax.is_a?(Fax)
+          
+          raise "Issuer is invalid: #{errors.messages}" unless valid?
+           
+          node = Nokogiri::XML::Builder.new if node.nil?
+          node.Emisor do |xml|
+            xml.Nombre @name
+            identification_document.build_xml(xml)
+            xml.NombreComercial @comercial_name if @comercial_name
+            location.build_xml(xml)
+            phone.build_xml(xml) if phone.present?
+            fax.build_xml(xml) if fax.present?
+            xml.CorreoElectronico @email
+          end          
+        end
+        
+        def to_xml(builder)
+          build_xml(builder).to_xml
+        end
+      end
+    
+  end
+end