br-invoice-download 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: '087765e8459a45578d7bf60c20e598e5ed67536dfbf749e8159faab5ef23fb3a'
+  data.tar.gz: e6dfc19691a832a69516570607f39c1f8f364589b27a56546ae1cd9ea8b21d05
+SHA512:
+  metadata.gz: cbfb13a73e0f3dcb1df0d418f46438557fcd1e448c0b818a99bc29ba16c6cf9a38aebc0afb352ee9aa878480f27bf3dffc34a8755a87e89869091732eff9c754
+  data.tar.gz: 779d9a175fbd20c8b24cf26076e523ac07e5d66144e0e6ccaa77f615e490efc70d609a361d5b5efa14e29b42804bcd19b33f46742de4a9ca40c44eee28eb6253

data/.gitignore

@@ -0,0 +1,6 @@
+coverage/
+.dropbox
+**/*.subl*
+**/*.~lock.*
+dev
+*.gem

data/Gemfile

@@ -0,0 +1,3 @@
+source 'http://rubygems.org'
+
+gemspec

data/Gemfile.lock

@@ -0,0 +1,108 @@
+PATH
+  remote: .
+  specs:
+    br-invoice-download (1.0.0)
+      activesupport (>= 3)
+      savon (>= 2.11)
+      slim (>= 3.0)
+      slim-rails (>= 3.1)
+      stringio (>= 0.0.2)
+      zlib (>= 1.0)
+
+GEM
+  remote: http://rubygems.org/
+  specs:
+    actionpack (6.0.2.2)
+      actionview (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      rack (~> 2.0, >= 2.0.8)
+      rack-test (>= 0.6.3)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.0, >= 1.2.0)
+    actionview (6.0.2.2)
+      activesupport (= 6.0.2.2)
+      builder (~> 3.1)
+      erubi (~> 1.4)
+      rails-dom-testing (~> 2.0)
+      rails-html-sanitizer (~> 1.1, >= 1.2.0)
+    activesupport (6.0.2.2)
+      concurrent-ruby (~> 1.0, >= 1.0.2)
+      i18n (>= 0.7, < 2)
+      minitest (~> 5.1)
+      tzinfo (~> 1.1)
+      zeitwerk (~> 2.2)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.2.4)
+    concurrent-ruby (1.1.6)
+    crass (1.0.6)
+    erubi (1.9.0)
+    gyoku (1.3.1)
+      builder (>= 2.1.2)
+    httpi (2.4.4)
+      rack
+      socksify
+    i18n (1.8.2)
+      concurrent-ruby (~> 1.0)
+    loofah (2.4.0)
+      crass (~> 1.0.2)
+      nokogiri (>= 1.5.9)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    minitest (5.14.0)
+    nokogiri (1.10.9)
+      mini_portile2 (~> 2.4.0)
+    nori (2.6.0)
+    rack (2.2.2)
+    rack-test (1.1.0)
+      rack (>= 1.0, < 3)
+    rails-dom-testing (2.0.3)
+      activesupport (>= 4.2.0)
+      nokogiri (>= 1.6)
+    rails-html-sanitizer (1.3.0)
+      loofah (~> 2.3)
+    railties (6.0.2.2)
+      actionpack (= 6.0.2.2)
+      activesupport (= 6.0.2.2)
+      method_source
+      rake (>= 0.8.7)
+      thor (>= 0.20.3, < 2.0)
+    rake (13.0.1)
+    savon (2.12.0)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    slim (4.0.1)
+      temple (>= 0.7.6, < 0.9)
+      tilt (>= 2.0.6, < 2.1)
+    slim-rails (3.2.0)
+      actionpack (>= 3.1)
+      railties (>= 3.1)
+      slim (>= 3.0, < 5.0)
+    socksify (1.7.1)
+    stringio (0.1.0)
+    temple (0.8.2)
+    thor (1.0.1)
+    thread_safe (0.3.6)
+    tilt (2.0.10)
+    tzinfo (1.2.6)
+      thread_safe (~> 0.1)
+    wasabi (3.5.0)
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+    zeitwerk (2.3.0)
+    zlib (1.1.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  br-invoice-download!
+
+BUNDLED WITH
+   1.17.2

data/LICENSE

@@ -0,0 +1,20 @@
+Copyright (c) 2016 Bruno M. Mergen
+
+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,52 @@
+
+# **br-invoice-download**
+Gem para fazer o download de notas fiscais através da chave de acesso
+
+**Introdução**
+
+Através do serviço **NFeDistribuicaoDFe** é possível obter o XML da nota fiscal com suas informações.
+Com base na documentação da [NT 2014.002 v1.02](/Brunomm/doc/NT2014.002_v1.02_WsNFeDistribuicaoDFe.pdf) foi criado apenas o serviço para a disponibilização do xml da nota fiscal, onde somente o destinatário, transportador e terceiros (identificados na tag `autXML`) podem usar este serviço.
+
+## Instalação
+**Manualmente**
+
+    gem install br-invoice-download
+
+**Gemfile**
+
+     gem 'br-invoice-download'
+
+## Utilização
+
+```ruby
+@engine = BrInvoiceDownload::NfeDistribuicaoDfe.new({
+  certificate_pkcs12_password: 'CERTIFITACE_PASSWORD',
+  certificate_pkcs12_path:     '/path/for/certificate-A1.pfx',
+  cnpj:                        '12345678901234',
+  invoice_key:                 '42200231775690400191560010004277701695237709',
+  ibge_uf:                     42 # vide https://www.ibge.gov.br/explica/codigos-dos-municipios.php
+})
+
+@engine.request
+
+@engine.invoice_xml
+# => "<nfeProc versao=\"4.00\" xmlns=\"http://www.portalfiscal.inf.br" ...."
+
+@engine.invoice_hash
+# => {"nfeProc"=>{"versao"=>"4.00", "xmlns"=>"http://www.portalfiscal.inf.br/nfe", ...}
+
+```
+
+## Contribuições
+
+Seja um contribuidor. Você pode contribuir de várias formas:
+
+* Desenvolver as outras funcionalidades disponibilizadas pelo serviço **NFeDistribuicaoDFe**.
+* Refatorando código.
+* Fornecendo Feedback construtivo (*Sempre bem vindo!*).
+
+
+## Licença
+
+- MIT
+- Copyleft 2020 Bruno Mucelini Mergen

data/Rakefile

@@ -0,0 +1,32 @@
+require 'rake/testtask'
+ 
+Rake::TestTask.new do |task|
+  task.libs << %w(test lib)
+  task.pattern = 'test/**/*_test.rb'
+end
+
+desc "Open an irb session preloaded with this library"
+task :console do
+  sh "irb -rubygems -I lib -r br_nfe.rb"
+end
+ 
+task :default => :test
+
+namespace :test do
+  desc "Test lib source"
+  Rake::TestTask.new(:product) do |t|    
+    t.libs << "test"
+    t.pattern = 'test/br_nfe/product/**/*_test.rb'
+    t.verbose = true    
+  end
+
+end
+
+namespace :test do
+  desc "Test lib source"
+  Rake::TestTask.new(:service) do |t|    
+    t.libs << "test"
+    t.pattern = 'test/br_nfe/service/**/*_test.rb'
+    t.verbose = true    
+  end
+end

data/br_invoice_download.gemspec

@@ -0,0 +1,29 @@
+# -*- encoding: utf-8 -*-
+require File.expand_path('../lib/br_invoice_download/version', __FILE__)
+
+Gem::Specification.new do |gem|
+	gem.name          = 'br-invoice-download'
+	gem.version       = BrInvoiceDownload::Version::CURRENT
+	gem.license       = 'MIT'
+	gem.description   = %q{BrInvoiceDownload é uma gem para projetos Ruby on Rails que tem como objetivo fazer o download do xml das notas fiscais de produto emitidas no Brasil.}
+	gem.summary       = %q{Download de Notas Fiscais Eletrônicas em Ruby}
+	gem.authors       = ['Bruno M. Mergen']
+	gem.email         = ['brunomergen@gmail.com']
+	gem.homepage      = 'https://github.com/Brunomm/br-invoice-download'
+
+	gem.files         = `git ls-files`.split("\n").reject{|fil|
+		fil.include?('dev/') ||
+		fil.include?('doc/')
+	}
+	gem.require_paths = ["lib"]
+	gem.required_ruby_version = ['>= 2.1.0', '< 3.0.0']
+
+	# gem.add_dependency "rake", '>= 10'
+	gem.add_dependency 'activesupport', '>= 3'
+	gem.add_dependency 'savon', '>= 2.11'
+	# gem.add_dependency 'signer', '>= 1.4'
+	gem.add_dependency 'slim', '>= 3.0'
+	gem.add_dependency 'slim-rails', '>= 3.1'
+	gem.add_dependency 'zlib', '>= 1.0'
+	gem.add_dependency 'stringio', '>= 0.0.2'
+end

data/lib/br_invoice_download.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require 'active_support/core_ext/string'
+require 'active_support/core_ext/hash'
+require 'savon'
+require 'slim'
+
+require 'br_invoice_download/version'
+require 'br_invoice_download/nfe_distribuicao_dfe'
+
+
+# Copyright (C) 2020 Bruno M. Mergen
+#
+# @author Bruno Mucelini Mergen <brunomergen@gmail.com>
+#
+#
+module BrInvoiceDownload
+	def self.root
+		File.expand_path '../..', __FILE__
+	end
+end

data/lib/br_invoice_download/nfe_distribuicao_dfe.rb

@@ -0,0 +1,192 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+require "zlib"
+require "stringio"
+require "base64"
+
+module BrInvoiceDownload
+	class NfeDistribuicaoDfe
+
+		def initialize(opts={})
+			opts.each do |key, value|
+				instance_variable_set("@#{key}", value)
+			end
+		end
+
+		attr_accessor :certificate_pkcs12_password
+		attr_accessor :certificate_pkcs12_path
+		attr_accessor :certificate_pkcs12_value
+		attr_accessor :ibge_uf
+		attr_accessor :cnpj
+		attr_accessor :invoice_key
+
+		def response
+			@response
+		end
+
+		def request
+			@response = client_wsdl.call(:nfe_dist_d_fe_interesse, xml: soap_xml)
+			rescue Savon::SOAPFault => error
+				return @response = {request_status: :soap_error,    request_message_error: error.message}
+			rescue Savon::HTTPError => error
+				return @response = {request_status: :http_error,    request_message_error: error.message}
+			rescue Exception => error
+				return @response = {request_status: :unknown_error, request_message_error: error.message}
+		end
+
+		def invoice_hash
+			@invoice ||= handle_invoice
+		end
+
+		def invoice_xml
+			@invoice_xml ||= handle_invoice_xml
+		end
+
+	private
+
+		def handle_invoice_xml
+			ret = response.try(:body).dig(:nfe_dist_d_fe_interesse_response, :nfe_dist_d_fe_interesse_result, :ret_dist_d_fe_int, :lote_dist_d_fe_int, :doc_zip)
+			return unless ret
+
+			Zlib::GzipReader.new(
+		  	StringIO.new(
+		  		Base64.decode64( ret )
+		  	)
+		  ).read
+		end
+
+		def handle_invoice
+			Hash.from_xml invoice_xml
+		end
+
+		# Esse método serve para ser utilizado no Base de cada orgão emissor
+		# onde em alguns casos é necessário colocar o xml em um CDATA
+		# É esse método que é passado dentro do Body da equisição SOAP
+		#
+		def content_xml
+			@content_xml ||= render_xml 'root/NfeDistribuicaoDfe'
+		end
+
+		# Tag XML que vai na requisição SOAP
+		#
+		# <b>Tipo de retorno: </b> _String_
+		#
+		def tag_xml
+			'<?xml version="1.0" encoding="UTF-8"?>'
+		end
+
+		# XML que irá na requisição SOAP
+		#
+		# <b>Tipo de retorno: </b> _String XML_
+		#
+		def soap_xml
+			@soap_xml ||= "#{tag_xml}#{render_xml('soap_env')}".html_safe
+		end
+
+		def client_wsdl_params
+			{
+				log:                   true,
+				pretty_print_xml:      true,
+				ssl_verify_mode:       :none,
+				ssl_cert:              certificate,
+				ssl_cert_key:          certificate_key,
+				ssl_cert_key_password: certificate_pkcs12_password,
+				wsdl: 'https://www1.nfe.fazenda.gov.br/NFeDistribuicaoDFe/NFeDistribuicaoDFe.asmx?wsdl',
+				ssl_version: :TLSv1
+			}
+		end
+
+		def url_xmlns
+			'http://www.portalfiscal.inf.br/nfe/wsdl/NFeDistribuicaoDFe'
+		end
+
+		# Cliente WSDL utilizado para fazer a requisição.
+		# Utilizando a gem savon.
+		# Veja mais detalhes em http://savonrb.com/version2/client.html
+		def client_wsdl
+			@client_wsdl ||= Savon.client( client_wsdl_params )
+		end
+
+		# Caso não tenha o certificate_pkcs12 salvo em arquivo, pode setar a string do certificate_pkcs12 direto pelo atributo certificate_pkcs12_value
+		# Caso tenha o certificate_pkcs12 em arquivo, basta setar o atributo certificate_pkcs12_path e deixar o atributo certificate_pkcs12_value em branco
+		def certificate_pkcs12_value
+			@certificate_pkcs12_value ||= File.read(certificate_pkcs12_path)
+		end
+
+		def certificate_pkcs12
+			return @certificate_pkcs12 if @certificate_pkcs12
+			@certificate_pkcs12 = nil
+
+			# É utilizado uma Thread e limpado os errors do OpenSSL para evitar perda de
+			# conexão com o banco de dados PostgreSQL.
+			# Veja: http://stackoverflow.com/questions/33112155/pgconnectionbad-pqconsumeinput-ssl-error-key-values-mismatch/36283315#36283315
+			# Veja: https://github.com/tedconf/front_end_builds/pull/66
+			Thread.new do
+				@certificate_pkcs12 = OpenSSL::PKCS12.new(certificate_pkcs12_value, certificate_pkcs12_password)
+				OpenSSL.errors.clear
+			end.join
+			OpenSSL.errors.clear
+
+			@certificate_pkcs12
+		rescue
+		end
+
+		def certificate_pkcs12=(value)
+			@certificate_pkcs12 = value
+		end
+
+		def certificate=(value)
+			@certificate = value
+		end
+
+		def certificate
+			@certificate ||= (certificate_pkcs12 && certificate_pkcs12.certificate)
+		end
+
+		def certificate_key
+			@certificate_key ||= (certificate_pkcs12 && certificate_pkcs12.key)
+		end
+
+		def certificate_key=(value)
+			@certificate_key = value
+		end
+
+		# Utilização
+		# `render_xml('file_name', {dir_path: '/my/custom/dir', context: Object}`
+		#
+		# <b>Tipo de retorno: <b> _String_ (XML)
+		#
+		def render_xml file_name, opts={}
+			opts = {
+				dir_path: nil,
+				context:  self,
+			}.merge(opts)
+
+			# Inicializa a variavel xml com nil para comparar se oa rquivo foi de fato encontrado.
+			xml = nil
+			get_xml_dirs(opts[:dir_path]).each do |dir|
+				if xml = find_xml(file_name, dir, opts[:context], opts)
+					break # Stop loop
+				end
+			end
+
+			# Lança uma excessão se não for encontrado o xml
+			# Deve verificar se é nil pois o arquivo xml pode estar vazio
+			if xml.nil?
+				raise "Arquivo #{file_name}.xml.slim não encontrado nos diretórios #{get_xml_dirs(default_options[:dir_path])}"
+			end
+			xml
+		end
+
+		def find_xml(file_name, dir, context=nil, options={})
+			if File.exists?("#{dir}/#{file_name}.xml.slim")
+				Slim::Template.new("#{dir}/#{file_name}.xml.slim").render(context, options).html_safe
+			end
+		end
+
+		def get_xml_dirs(custom_dir_path=nil)
+			[custom_dir_path, "#{BrInvoiceDownload.root}/lib/br_invoice_download/xml"].flatten.select(&:present?)
+		end
+	end
+end

data/lib/br_invoice_download/version.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+# encoding: utf-8
+
+module BrInvoiceDownload
+	module Version
+		MAJOR = 1 #inclui alterações de API e pode quebrar compatibilidade com versões anteriores
+		MINOR = 0 #inclui novas funcionalidades, sem quebrar APIs existentes
+		PATCH = 0 #corrige bugs ou traz melhorias em implementações já existentes
+		CURRENT = "#{MAJOR}.#{MINOR}.#{PATCH}"
+	end
+end

data/lib/br_invoice_download/xml/root/NfeDistribuicaoDfe.xml.slim

@@ -0,0 +1,6 @@
+distDFeInt xmlns="http://www.portalfiscal.inf.br/nfe" versao="1.01"
+  tpAmb = 1
+  cUFAutor = ibge_uf
+  CNPJ  = cnpj
+  consChNFe
+    chNFe = invoice_key

data/lib/br_invoice_download/xml/soap_env.xml.slim

@@ -0,0 +1,9 @@
+soap:Envelope xmlns:soap="http://www.w3.org/2003/05/soap-envelope" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema"
+  soap:Header
+    nfeCabecMsg xmlns="#{url_xmlns}"
+      cUF = ibge_uf
+      versaoDados = '1.00'
+  soap:Body
+    nfeDistDFeInteresse xmlns="#{url_xmlns}"
+      nfeDadosMsg
+        = content_xml.html_safe

metadata

@@ -0,0 +1,143 @@
+--- !ruby/object:Gem::Specification
+name: br-invoice-download
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Bruno M. Mergen
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2020-03-22 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '2.11'
+- !ruby/object:Gem::Dependency
+  name: slim
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: slim-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '3.1'
+- !ruby/object:Gem::Dependency
+  name: zlib
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '1.0'
+- !ruby/object:Gem::Dependency
+  name: stringio
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.0.2
+description: BrInvoiceDownload é uma gem para projetos Ruby on Rails que tem como
+  objetivo fazer o download do xml das notas fiscais de produto emitidas no Brasil.
+email:
+- brunomergen@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- br_invoice_download.gemspec
+- lib/br_invoice_download.rb
+- lib/br_invoice_download/nfe_distribuicao_dfe.rb
+- lib/br_invoice_download/version.rb
+- lib/br_invoice_download/xml/root/NfeDistribuicaoDfe.xml.slim
+- lib/br_invoice_download/xml/soap_env.xml.slim
+homepage: https://github.com/Brunomm/br-invoice-download
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.1.0
+  - - "<"
+    - !ruby/object:Gem::Version
+      version: 3.0.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3
+signing_key: 
+specification_version: 4
+summary: Download de Notas Fiscais Eletrônicas em Ruby
+test_files: []