facturacr 0.1.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 442248d98ebb602ee4d8f647bf9a24939b07e87a
+  data.tar.gz: d6786825ba580d22c565b0714a744fadf34f5347
+SHA512:
+  metadata.gz: 68d71ab7ae6715f6e61fbc92e09ca4da4d062e2ef9bc1c215ebea38c6bf4f865f9214a2344e48463f6ec3b3bda71fd1855de64b6b58e4a994fa7b65a0daf90df
+  data.tar.gz: cc15f59583e0d342fd11148a948e48137abf52ae27a2886e7e151d2add273d69628f97754142ea6c9d0f70a3d406686eaa1f7e81093b2ae3c9df8a2b9a0be72c

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.1
+before_install: gem install bundler -v 1.10.5

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in facturacr.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,7 @@
+Copyright (c) 2018 Josef Sauter
+
+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,181 @@
+# FE
+
+Esta librería implementa los procesos de facturación electrónica del Ministerio de Hacienda de Costa Rica en Ruby. Puede ser utilizada como punto de partida para realizar la integración necesaria con el Ministerio de Hacienda.
+
+Actualmente cuenta con las siguientes características:
+
+- Generación de XML
+- Firmado de XML (utilizando JAVA)
+- Comunicación con el API del ministerio de hacienda
+- Línea de comando para realizar los procesos
+
+## Instalación
+
+Agregue la siguiente línea en el Gemfile
+
+```ruby
+gem 'facturacr'
+```
+
+Execute el comando
+
+    $ bundle
+
+O instale el gem
+
+    $ gem install facturacr
+
+## Utilziación
+
+Para generar documentos:
+
+```ruby
+	require 'facturacr'
+
+	id_document = FE::Document::IdentificationDocument.new type: "01", number: "112345678"
+	phone = FE::Document::Phone.new country_code: "506", "22222222" 
+	location = FE::Document::Location.new province: "1",county: "01", district: "01", others: "Otras señas"
+	issuer = FE::Document::Issuer.new name: "EMISON EJEMPLO", identification_document: id_document, location: location, phone: phone, email: "emisor@ejemplo.com"
+
+	reciever_id_document = FE::Document::IdentificationDocument.new type: "02", number: "3102123456"
+	receiver = FE::Document::Receiver.new name: "RECEPTOR EJEMPLO", identification_document: id_document
+
+	items = []
+	items << FE::Document::Item.new(code: "001", line_number: 1, quantity: 1, unit: "Sp", description: "Desarrollo de Software y Mantenimiento", unit_price: 300, subtotal: 300, net_total: 300, total: 300)
+	taxes = [FE::Document::Tax.new(code: "01", rate: 13, total: (100 * 0.13))]
+	items << FE::Document::Item.new(code: "002", line_number: 2, quantity: 2, unit: "Unid", description: "Impresora de POS", unit_price: 50, total: 100, taxes: taxes, net_total: 113, subtotal: 100)
+	summary = FE::Document::Summary.new currency: "USD", exchange_rate: 575, services_exent_total: 300, goods_taxable_total: 100, exent_total: 300, taxable_total: 100, subtotal: 400, gross_total: 400, tax_total: 13, net_total: 413
+
+
+	invoice = FE::Invoice.new date: date, issuer: issuer, receiver: receiver, number: number, items: items, condition: condition, credit_term: credit_term, summary: summary, security_code: "12345678", document_situation: "1"
+
+	# Para generar el XML como string
+	xml = invoice.generate
+	
+	# Escribir el archivo
+	File.open("/path/to/file.xml","w"){|f| f.write(xml)}
+```
+
+Para configurar el API / Firmador:
+```ruby
+
+	FE.configure do |config|
+		config.api_username "su_usuario_api_atv"
+		config.api_password = "su_password_api_atv"
+		config.key_path = "tmp/llave_criptografica.p12"
+		config.key_password = "99999999999999"
+		# api hacienda: valores default
+		config.api_client_id = 'api-stag'
+		config.documents_endpoint = "https://api.comprobanteselectronicos.go.cr/recepcion-sandbox/v1"
+		config.authentication_endpoint = "https://idp.comprobanteselectronicos.go.cr/auth/realms/rut-stag/protocol/openid-connect/token"s
+	end
+```
+
+Para firmar documentos. (Debe tener java instalado)
+```ruby
+
+	signer = FE::JavaSigner.new FE.configuration.key_path, FE.configuration.key_password, "/path/to/unsigned.xml", "/path/to/signed.xml"
+	signer.sign
+```
+
+
+Para enviar documentos al API
+```ruby
+	
+	api = FE::API.new
+	# document is FE::Document
+	signed_document = FE::SignedDocument.new(document,path)
+	api = FE::Api.new
+	if api.send_document(signed_document.payload)
+		puts "Document sent!"
+	else
+		puts "Error: #{api.errors}"
+	end
+```
+
+Para chequear el estatus del documento
+```ruby
+
+	api = FE::API.new	
+	FE::Utils.configure(options[:config_file])
+	api = FE::Api.new
+	document_status = api.get_document_status(key)
+	puts document_status.to_h
+	#=> {key: "50601011600310112345600100010100000000011999999999", date: "2016-01-01T00:00:00-0600", status: "aceptado", datails: ""}
+```
+
+## Lína de comando
+
+Para utilziar la línea de comando y generar documentos de prueba, debe generar los archivos de configuración en un directorio temporal. Navegue al directorio donde desee ejectuar el proceso:
+
+	$ facturacr setup /path/to/directory	
+
+Modifique los archivos config.yml y data.yml para utilziar la línea de comando
+
+Para generar documentos:
+
+	$ facturacr generate help
+	
+	Commands:
+	  facturacr generate credit_note     # generates an XML credit note
+	  facturacr generate debit_note      # generates an XML debit note
+	  facturacr generate help [COMMAND]  # Describe subcommands or one specific subcommand
+	  facturacr generate invoice         # generates an XML invoice
+
+Por ejemplo, para generar una factura
+
+	
+	$ facturacr generate invoice --number 112
+	
+	Details:
+	ISSUER: Cédula Jurídica 3102123456 - EMISOR EJEMPLO
+	RECEIVER: Cédula Fisica 111900158 - RECEPTOR EJEMPLO
+	KEY: 50601041800310212345600100001010000000112199999999	
+
+Adicionalmente se pueden especificar las opciones para firma y enviar a hacienda
+
+	$ facturacr generate invoice --number 112 --sign --send
+	
+	Details:
+	ISSUER: Cédula Jurídica 3102123456 - EMISOR EJEMPLO
+	RECEIVER: Cédula Fisica 111900158 - RECEPTOR EJEMPLO
+	KEY: 50601041800310212345600100001010000000112199999999
+	
+	=> SIGN ...............
+	=> SEND TO API .................
+	Document Sent
+	KEY: 50601041800310212345600100001010000000112199999999
+	Wait 5 seconds before check...
+	{
+	        :key => "50601041800310212345600100001010000000112199999999",
+	       :date => "2018-04-01T01:00:30-06:00",
+	     :status => "aceptado",
+	    :details => "Este comprobante fue procesado en el ambiente de pruebas, por lo cual no tiene validez para fines tributarios."
+	}	
+
+
+Para firmar documentos
+
+	$ facturacr sign_document /path/to/unsigned.xml /path/to/signed.xml
+
+Para enviar documentos
+
+	$ facturacr send_document /path/to/signed.xml		
+
+## To Do
+
+- Mejorar y extender la generación de XML
+- Implemntar un mapeo más sencillo para generación de XML
+- Implementar Aceptación y Rechazo
+- Finalizar el firmador en ruby
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake test` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`. To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/apokalipto/facturacr.
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

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

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/config/config.yml

@@ -0,0 +1,10 @@
+development:
+  api_username: su_usuario_api_atv
+  api_password: su_password_api_atv
+  key_path: tmp/llave_criptografica.p12
+  key_password: "99999999999999"
+  
+  # api hacienda: valores default
+  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"

data/exe/facturacr

@@ -0,0 +1,3 @@
+#!/usr/bin/env ruby
+require 'facturacr/cli'
+FE::CLI.start(ARGV)

data/facturacr.gemspec

@@ -0,0 +1,31 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'facturacr/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "facturacr"
+  spec.version       = FE::VERSION
+  spec.authors       = ["Josef Sauter"]
+  spec.email         = ["Josef.Sauter@gmail.com"]
+
+  spec.summary       = %q{Facturación Electrónica de Costa Rica}
+  spec.homepage      = "https://github.com/apokalipto/facturacr"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-colorize"
+  
+  spec.add_dependency 'rest-client'
+  spec.add_dependency 'nokogiri'
+  spec.add_dependency 'colorize'
+  spec.add_dependency 'thor'
+  spec.add_dependency 'activemodel'
+  spec.add_dependency 'awesome_print'
+end

data/lib/facturacr.rb

@@ -0,0 +1,37 @@
+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/signer/signer'
+
+module FE
+  class << self
+    attr_accessor :configuration
+  end
+  
+  def self.configure
+    if self.configuration.nil?
+      self.configuration ||= Configuration.new
+    end
+    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

@@ -0,0 +1,68 @@
+require 'facturacr/api/document_status'
+
+require 'base64'
+require 'rest-client'
+require 'json'
+
+module FE
+  class Api
+    
+    attr_accessor :authentication_endpoint, :document_endpoint, :username, :password, :client_id, :errors
+    
+    def initialize(configuration = nil)
+      @authentication_endpoint = (configuration || FE.configuration).authentication_endpoint
+      @document_endpoint = (configuration || FE.configuration).documents_endpoint
+      @username = (configuration || FE.configuration).api_username
+      @password = (configuration || FE.configuration).api_password
+      @client_id = (configuration || FE.configuration).api_client_id
+      @errors = {}
+    end
+    
+    def authenticate
+      response = RestClient.post @authentication_endpoint, auth_data
+      @token = JSON.parse(response)["access_token"]
+      
+      @token
+    rescue => e
+      raise "AUTH ERROR"
+    end
+    
+        
+    def send_document(payload)
+      authenticate    
+      response = RestClient.post "#{@document_endpoint}/recepcion", payload.to_json, {:Authorization=> "bearer #{@token}", content_type: :json}
+      return true if response.code.eql?(200) || response.code.eql?(202)
+    rescue => e
+      @errors[:request] = {message: e.message, response: e.response}
+      return false      
+    end
+    
+    def get_document_status(key)
+      authenticate
+      response = RestClient.get "#{@document_endpoint}/recepcion/#{key}", {:Authorization=> "bearer #{@token}", content_type: :json}
+      return FE::Api::DocumentStatus.new(response)
+    end
+    
+    def get_document(key)
+      authenticate
+      response = RestClient.get "#{@document_endpoint}/comprogantes/#{key}", {:Authorization=> "bearer #{@token}", content_type: :json}
+      JSON.parse(response)
+    end
+        
+    
+    private
+    
+    
+    
+    def auth_data
+      {
+        grant_type: 'password',
+        client_id: @client_id,
+        username: @username,
+        password: @password,
+        client_secret: '',
+        scope: ''
+      }
+    end
+  end
+end

data/lib/facturacr/api/document_status.rb

@@ -0,0 +1,36 @@
+require 'base64'
+require 'json'
+require 'nokogiri'
+
+module FE
+  class Api
+    class DocumentStatus
+      
+      attr_reader :document
+      attr_accessor  :json, :xml, :key, :date, :status
+      
+      def initialize(json)
+        @json = json
+        @response = JSON.parse(json)
+        @xml = Base64.decode64(@response["respuesta-xml"]) if @response["respuesta-xml"]
+        @status = @response["ind-estado"]
+        @date = @response["fecha"]
+        @key = @response["clave"]
+        @document = Nokogiri::XML(@xml) if @xml
+      end
+      
+      def details
+        @document.css("MensajeHacienda DetalleMensaje").first.text if @document
+      end
+      
+      def to_h
+        {
+          key: @key,
+          date:  @date,
+          status: @status,
+          details: details
+        }
+      end
+    end
+  end
+end