facturacr 1.0.6 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 5f79a7e9d0f44bbdc3655d3ec903cba6bc87c8a7
-  data.tar.gz: e9c3a32ada42c6adea6145681dbdf0141a4688af
+SHA256:
+  metadata.gz: 5a8fe4de4d95d4c43eadb53200c1ce6b847554a1970fb9cb803ffdd9b3a5ea93
+  data.tar.gz: a4ba9d8357de2b21305f5c32577e25433d0c477c4996cfdfdc8b42e1f5665935
 SHA512:
-  metadata.gz: b6da6d3d09e8c9e73b647115371e8efae27d652a789a020eb5ceaa19d9eb9e3073fa73442ad27d9e5c6c3167bf235f771e0e816cee8ed4bc875b97fda739fb9c
-  data.tar.gz: cad88e6a82f1af07418c41c777eb2310115bc6a7baf2767f8587647e811533b4e6cc87d54e85684d0193cf258533c663f1ef334014bf3f49b37c8c74743757e8
+  metadata.gz: c339e27c622a15a04f9d55924b40bd78529fc31c284517e6dfa6b42473f1fa99993b8667e1a3b3960872c65cef8f674951a5f820564ed3754e159013ac2d0bd6
+  data.tar.gz: 3640e8f8d11d531ad16e801820c9eeb1c3671988338d5cc029548839338ade8ca4b99e467864647940a2851441d1c1a8ade3711d19b92b1bbff9011cc154f4a3

data/facturacr.gemspec

@@ -18,10 +18,10 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib"]
 
   spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "minitest", '~> 5.11'
   spec.add_development_dependency "minitest-colorize", '~> 0.0'
-  
+
   spec.add_dependency 'rest-client', '~> 2.0'
   spec.add_dependency 'nokogiri', '~> 1.8'
   spec.add_dependency 'colorize', '~> 0.8'

data/lib/facturacr.rb

@@ -1,25 +1,31 @@
 require 'awesome_print'
-require 'facturacr'
-require 'facturacr/configuration'
-require 'facturacr/document'
-require 'facturacr/invoice'
-require 'facturacr/credit_note'
-require 'facturacr/debit_note'
-require 'facturacr/ticket'
-require 'facturacr/signed_document'
-require 'facturacr/xml_document'
-require 'facturacr/api'
-require 'facturacr/builder'
-require 'facturacr/version'
-require 'facturacr/data_provider'
-require 'facturacr/signer/signer'
-require 'facturacr/reception_message'
+
+#require 'facturacr'
+require_relative 'facturacr/configuration'
+require_relative 'facturacr/element'
+require_relative 'facturacr/invoice'
+require_relative 'facturacr/credit_note'
+require_relative 'facturacr/export_invoice'
+require_relative 'facturacr/purchase_invoice'
+require_relative 'facturacr/debit_note'
+require_relative 'facturacr/ticket'
+require_relative 'facturacr/document'
+require_relative 'facturacr/signed_document'
+require_relative 'facturacr/xml_document'
+require_relative 'facturacr/api'
+require_relative 'facturacr/builder'
+require_relative 'facturacr/version'
+require_relative 'facturacr/data_provider'
+require_relative 'facturacr/signer/signer'
+require_relative 'facturacr/reception_message'
+require_relative 'facturacr/error'
+require_relative 'facturacr/data'
 
 module FE
   class << self
     attr_accessor :configuration
   end
-  
+
   def self.configure
     if self.configuration.nil?
       self.configuration ||= Configuration.new
@@ -27,13 +33,13 @@ module FE
     yield(configuration)
     configuration.read_config_file if configuration.file?
   end
-  
+
   def self.root
     File.dirname __dir__
   end
-  
+
   def self.bin
     File.join root, 'bin'
   end
-  
+
 end

data/lib/facturacr/api.rb

@@ -32,17 +32,17 @@ module FE
       @token
     rescue => e
       puts "AUTH ERROR: #{e.message}".red
-      raise e
+      raise FE::Error.new("authentication error: #{e.message}",class: self.class)
     end
     
     def logout
       url = @authentication_endpoint
       if @authentication_endpoint.end_with?('token')
-        url.gsub!("token","logout")
+        url = url.gsub("token","logout")
       else
         url += "/logout"
       end
-      response = RestClient.post url, logout_data
+      RestClient.post url, logout_data
     rescue => e
       puts "LOGOUT ERROR: #{e.message}".red
     end
@@ -57,7 +57,8 @@ module FE
         return true 
       end
     rescue => e
-      @errors[:request] = {message: e.message, response: e.response}
+      @errors[:request] = {message: e.message}
+      @errors[:response] = e.response if e.respond_to?(:response) 
       return false      
     end
     

data/lib/facturacr/builder.rb

@@ -134,7 +134,7 @@ module FE
       else
         summary = args[:summary]
       end
-      FE::Invoice.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation]
+      FE::Invoice.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation], version: args[:version], economic_activity: args[:economic_activity]
     end
     
     def ticket(args = {})
@@ -165,7 +165,7 @@ module FE
       else
         summary = args[:summary]
       end
-      FE::Ticket.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation]
+      FE::Ticket.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation], version: args[:version], economic_activity: args[:economic_activity]
     end
     
     
@@ -207,7 +207,7 @@ module FE
         references = args[:references]
       end
       
-      FE::CreditNote.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation], references: references
+      FE::CreditNote.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation], references: references, version: args[:version], economic_activity: args[:economic_activity]
     end
     
     def debit_note(args = {})
@@ -248,7 +248,7 @@ module FE
         references = args[:references]
       end
       
-      FE::DebitNote.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation], references: references
+      FE::DebitNote.new date: args[:date], issuer: issuer, receiver: receiver, number: args[:number], items: items, condition: args[:condition], credit_term: args[:credit_term], summary: summary, security_code: args[:security_code], document_situation: args[:document_situation], references: references, version: args[:version], economic_activity: args[:economic_activity]
     end
     
     def reception_message(args={})

data/lib/facturacr/configuration.rb

@@ -2,7 +2,7 @@ require 'yaml'
 require 'erb'
 module FE
   class Configuration
-    
+
     attr_accessor :api_username
     attr_accessor :api_password
     attr_accessor :key_path
@@ -13,8 +13,9 @@ module FE
     attr_accessor :environment
     attr_accessor :file_path
     attr_accessor :mode
-    
-    
+    attr_accessor :version
+
+
     def initialize
       @environment = "development"
       @mode = :manual
@@ -26,9 +27,9 @@ module FE
       @documents_endpoint = "https://api.comprobanteselectronicos.go.cr/recepcion-sandbox/v1"
       @authentication_endpoint = "https://idp.comprobanteselectronicos.go.cr/auth/realms/rut-stag/protocol/openid-connect"
     end
-    
+
     def read_config_file
-      if file? && @file_path && File.exists?(@file_path)
+      if file? && @file_path && File.exist?(@file_path)
         template = ERB.new(File.read(@file_path))
         result = YAML.load(template.result(binding))
         result[@environment].each do |k,v|
@@ -38,14 +39,22 @@ module FE
         end
       end
     end
-    
+
     def manual?
       @mode.to_sym.eql?(:manual)
     end
-    
+
     def file?
       @mode.to_sym.eql?(:file)
     end
-    
+
+    def version_42?
+      version.eql?('4.2')
+    end
+
+    def version_43?
+      version.eql?('4.3')
+    end
+
   end
-end
+end

data/lib/facturacr/credit_note.rb

@@ -1,34 +1,45 @@
 require 'facturacr/document/regulation'
 module FE
- 
+
   class CreditNote < Document
-    
+    NAMESPACES ={
+      "4.2" => {
+      "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"#,
+      },
+      "4.3" => {
+        "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+        "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+        "xmlns"=>"https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/notaCreditoElectronica"#,
+      }
+    }
+    DOCUMENT_TYPE = "03"
     def initialize(args={})
+      @version = args[:version]
+      @economic_activity = args[:economic_activity]
       @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"
+      @payment_type = args[:payment_type] || ["01"]
+      @document_type = DOCUMENT_TYPE
       @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"#,
-      }
+      @other_charges = args[:other_charges]
+      @namespaces = NAMESPACES[@version]
       @others = args[:others] || []
     end
-    
+
     def document_tag
       "NotaCreditoElectronica"
     end
-    
-  end 
-end
+
+  end
+end

data/lib/facturacr/data.rb

@@ -0,0 +1,41 @@
+require 'json'
+require 'rest-client'
+require 'active_support/core_ext/hash/indifferent_access'
+
+module FE
+  class Data
+    
+    ENDPOINT = "https://api.hacienda.go.cr"
+    
+    def self.contributor(id_number)
+      response = RestClient.get "#{ENDPOINT}/fe/ae?identificacion=#{id_number}"
+      return JSON.parse(response.body).with_indifferent_access
+    rescue => e
+      puts "FE::Data.contributor(#{id_number}) #{e.message}"
+      return nil
+    end
+    
+    def self.exchange_rate(currency = "USD")
+      if currency.eql?("USD")
+        path = "tc/dolar"
+      elsif currency.eql?("EUR")
+        path = "tc/euro"
+      else
+        raise "#{currency} is not a valid argument"
+      end
+      response = RestClient.get "#{ENDPOINT}/indicadores/#{path}"
+      return JSON.parse(response.body).with_indifferent_access
+    rescue => e
+      puts "FE::Data.exchange_rate(#{currency}) #{e.message}"
+      return nil
+    end
+    
+    def self.exonerations(id_number)
+      response = RestClient.get "#{ENDPOINT}/fe/ex?identificacion=#{id_number}"
+      return JSON.parse(response.body).with_indifferent_access
+    rescue => e
+      puts "FE::Data.exonerations(#{id_number}) #{e.message}"
+      return nil
+    end
+  end
+end

data/lib/facturacr/data_provider.rb

@@ -8,7 +8,7 @@ module FE
     def initialize(source, data)
       source = source.to_s.to_sym
       raise ArgumentError, "source (#{source}) is not valid" if !SOURCES.include?(source)
-      raise ArgumentError, "#{data} does not exist" if source.eql?(:file) && !File.exists?(data)
+      raise ArgumentError, "#{data} does not exist" if source.eql?(:file) && !File.exist?(data)
       
       if source.eql?(:string)
         @contents = data

data/lib/facturacr/debit_note.rb

@@ -1,34 +1,46 @@
 require 'facturacr/document/regulation'
 module FE
- 
+
   class DebitNote < Document
-    
+
+    NAMESPACES ={
+      "4.2" => {
+      "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"
+      },
+      "4.3" => {
+        "xmlns:xsi"=>"http://www.w3.org/2001/XMLSchema-instance",
+        "xmlns:xsd"=>"http://www.w3.org/2001/XMLSchema",
+        "xmlns"=>"https://cdn.comprobanteselectronicos.go.cr/xml-schemas/v4.3/notaDebitoElectronica"#,
+      }
+    }
+    DOCUMENT_TYPE = "02"
     def initialize(args={})
+      @version = args[:version]
+      @economic_activity = args[:economic_activity]
       @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"
+      @payment_type = args[:payment_type] || ["01"]
+      @document_type = DOCUMENT_TYPE
       @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"
-      }
+      @other_charges = args[:other_charges]
+      @namespaces = NAMESPACES[@version]
       @others = args[:others] || []
     end
-    
+
     def document_tag
       "NotaDebitoElectronica"
     end
-    
-  end 
-end
+
+  end
+end

data/lib/facturacr/document.rb

@@ -1,16 +1,19 @@
 require 'active_model'
 
-module FE  
+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", 
+      "01"=>"Contado",
+      "02"=>"Crédito",
+      "03"=>"Consignación",
+      "04"=>"Apartado",
+      "05"=>"Arrendamiento con Opción de Compra",
       "06"=>"Arrendamiento en Función Financiera",
+      "07"=>"Cobro a favor de un tercero",
+      "08"=>"Servicios prestados al Estado a crédito ",
+      "09"=>"Pago del servicios prestado al Estado ",
       "99"=>"Otros"
     }.freeze
     PAYMENT_TYPES = {
@@ -29,47 +32,50 @@ module FE
       "05"=> "Nota de despacho",
       "06"=> "Contrato",
       "07"=> "Procedimiento",
-      "08"=> "Comprobante Emitido en Contingencia",
-      "99"=> "Otros"
-      
+      "08"=> "Factura Electrónica de compra",
+      "09"=> "Factura Electronica de exportación"
     }.freeze
     DOCUMENT_SITUATION = {
       "1" => "Normal",
       "2" => "Contingencia",
       "3" => "Sin Internet"
     }.freeze
-  
-    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, 
-                  :headquarters, :terminal, :others, :key
-    
+
+    attr_writer :headquarters, :terminal, :key
+    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,
+                  :headquarters, :terminal, :others, :key, :economic_activity, :other_charges, :version
+    validates :version, presence: true
+    validates :economic_activity, presence: true, if: ->{ version.eql?("4.3") }
     validates :date, presence: true
     validates :number, presence: true
     validates :issuer, presence: true
+    validates :receiver, presence: true, if: -> {document_type.eql?("01") || document_type.eql?("08")}
     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 :credit_term, presence: true, if: ->{ condition.eql?("02") }
     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 :regulation, presence: true, if: ->{ version.eql?("4.2") }
     validates :security_code, presence: true, length: {is: 8}
     validates :references, presence: true, if: -> {document_type.eql?("02") || document_type.eql?("03")}
-    
-    
+    validates :items, presence:true
+    validate :payment_types_ok?
+    validate :other_charges_ok?, if: -> {@other_charges.present?}
+
     def initialize
-      raise "Subclasses must implement this method"
+      raise FE::Error "Subclasses must implement this method"
     end
-    
+
     def document_name
-      raise "Subclasses must implement this method"
+      raise FE::Error "Subclasses must implement this method"
     end
-    
+
     def key
       @key ||= begin
-        raise "Documento inválido: #{errors.messages}" unless valid?  
+        raise "Documento inválido: #{errors.messages}" unless valid?
         country = "506"
         day = "%02d" % @date.day
         month = "%02d" % @date.month
@@ -81,69 +87,92 @@ module FE
 
         result = "#{country}#{day}#{month}#{year}#{id_number}#{sequence}#{type}#{security_code}"
         raise "The key is invalid: #{result}" unless result.length.eql?(50)
-      
+
         result
       end
     end
-    
+
     def headquarters
       @headquarters ||= "001"
     end
-  
+
     def terminal
       @terminal ||= "00001"
-    end 
-    
+    end
+
     def sequence
       cons = ("%010d" % @number)
       "#{headquarters}#{terminal}#{@document_type}#{cons}"
     end
-  
+
+    def version_42?
+      @version.eql?("4.2")
+    end
+
+    def version_43?
+      @version.eql?("4.3")
+    end
+
     def build_xml
-      raise "Documento inválido: #{errors.messages}" unless valid?
+      raise FE::Error.new "Documento inválido #{errors.messages}", class: self.class, messages: errors.messages unless valid?
       builder  = Nokogiri::XML::Builder.new(encoding: 'UTF-8')
-      
+
       builder.send(document_tag, @namespaces) do |xml|
         xml.Clave key
+        xml.CodigoActividad @economic_activity if version_43?
         xml.NumeroConsecutivo sequence
         xml.FechaEmision @date.xmlschema
-        issuer.build_xml(xml)
-        receiver.build_xml(xml) if receiver.present?
+        issuer.build_xml(xml, self)
+        receiver.build_xml(xml,self) if receiver.present?
         xml.CondicionVenta @condition
         xml.PlazoCredito @credit_term if @credit_term.present? && @condition.eql?("02")
-        xml.MedioPago @payment_type
+
+        @payment_type.each do |pt|
+          @summary.with_credit_card = true if pt.eql?("02")
+          xml.MedioPago pt
+        end
+
+
         xml.DetalleServicio do |x|
           @items.each do |item|
-            item.build_xml(x)
+            item.build_xml(x, self)
           end
         end
-        
-        summary.build_xml(xml)
-        
+
+        if other_charges.present?
+          @other_charges.each do |other_charge|
+            other_charge.build_xml(xml, self)
+          end
+        end
+
+        #other_charges.build_xml(xml,self) if other_charges.present? && version_43? # see this
+
+        summary.build_xml(xml, self)
+
         if references.present?
           references.each do |r|
-            r.build_xml(xml)
+            r.build_xml(xml, self)
           end
         end
-        
-        regulation.build_xml(xml)
-        
+
+        regulation.build_xml(xml,self)  if version_42?
+
         if others.any?
           xml.Otros do |x|
             @others.each do |o|
-              o.build_xml(x)
+              o.build_xml(x, self)
             end
           end
         end
       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
@@ -158,27 +187,49 @@ module FE
           numeroIdentificacion: @receiver.identification_document.id_number
         }
       end
-      
+
       payload
     end
-    
+
+    private
+
+    def other_charges_ok?
+      if @other_charges.is_a?(Array)
+        errors.add :other_charges, "invalid other_charges: the length can't be greater than 15" if @other_charges.length > 15
+        errors.add :other_charges, "invalid other_charges: not included" unless @other_charges.all? {|i| FE::Document::OtherCharges::OTHER_DOCUMENT_TYPES.include?(i.document_type)}
+      else
+        errors.add :other_charges, "invalid other_charges: not array"
+      end
+    end
+
+    def payment_types_ok?
+      errors.add :payment_type, "missing payment type" if @payment_type.nil?
+      if @payment_type.is_a?(Array)
+        errors.add :payment_type, "invalid payment types: not included" unless @payment_type.all? {|i| PAYMENT_TYPES.include?(i)}
+      else
+        errors.add :payment_type, "invalid payment type: not array"
+      end
+
+    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'
-require 'facturacr/document/other_text'
+require_relative 'document/code'
+require_relative 'document/exoneration'
+require_relative 'document/fax'
+require_relative 'document/identification_document'
+require_relative 'document/issuer'
+require_relative 'document/item'
+require_relative 'document/location'
+require_relative 'document/phone_type'
+require_relative 'document/phone'
+require_relative 'document/fax'
+require_relative 'document/receiver'
+require_relative 'document/reference'
+require_relative 'document/regulation'
+require_relative 'document/summary'
+require_relative 'document/tax'
+require_relative 'document/other_text'
+require_relative 'document/other_content'
+require_relative 'document/other_charges'