nfse_gyn 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 01a27dc406ace444898a4dca5f3588e136367c7c6083f398cfe147bd87b4d667
+  data.tar.gz: e6257d16d7d6f976f6f9ce595ef9fb5892cff2079311f156f328be0099a32aaf
+SHA512:
+  metadata.gz: ea2d7880cd0ba4f2f4efbf56b7833a199616e4662b1edcf120d33e377decb0fb270c6b18d811461a72829492b67d639e851d3398929e787e9fa0e902e9eedbb7
+  data.tar.gz: aebb617cb978903d7b1f9e024909e8ec12443b5bfe05b37da0ef3d047f2ec5a2c727cab84bb45fb3621df3bf2e93d43c2d94359cd8c25db529e58c32145d651d

data/.gitignore

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

data/.rspec

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

data/Gemfile

@@ -0,0 +1,6 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in nfse_gyn.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,83 @@
+PATH
+  remote: .
+  specs:
+    nfse_gyn (0.1.0)
+      activemodel (~> 3.0)
+      savon (~> 2.9)
+      signer (~> 1.10)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    activemodel (3.2.22.5)
+      activesupport (= 3.2.22.5)
+      builder (~> 3.0.0)
+    activesupport (3.2.22.5)
+      i18n (~> 0.6, >= 0.6.4)
+      multi_json (~> 1.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
+    akami (1.3.1)
+      gyoku (>= 0.4.0)
+      nokogiri
+    builder (3.0.4)
+    coderay (1.1.3)
+    concurrent-ruby (1.1.9)
+    diff-lcs (1.5.0)
+    gyoku (1.4.0)
+      builder (>= 2.1.2)
+      rexml (~> 3.0)
+    httpi (2.4.5)
+      rack
+      socksify
+    i18n (0.9.5)
+      concurrent-ruby (~> 1.0)
+    method_source (1.0.0)
+    mini_portile2 (2.4.0)
+    multi_json (1.15.0)
+    nokogiri (1.9.1)
+      mini_portile2 (~> 2.4.0)
+    nori (2.6.0)
+    pry (0.14.2)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (3.1.1)
+    rack (1.6.13)
+    rake (10.5.0)
+    rexml (3.2.5)
+    rspec (2.99.0)
+      rspec-core (~> 2.99.0)
+      rspec-expectations (~> 2.99.0)
+      rspec-mocks (~> 2.99.0)
+    rspec-core (2.99.2)
+    rspec-expectations (2.99.2)
+      diff-lcs (>= 1.1.3, < 2.0)
+    rspec-mocks (2.99.4)
+    savon (2.12.1)
+      akami (~> 1.2)
+      builder (>= 2.1.2)
+      gyoku (~> 1.2)
+      httpi (~> 2.3)
+      nokogiri (>= 1.8.1)
+      nori (~> 2.4)
+      wasabi (~> 3.4)
+    signer (1.10.0)
+      nokogiri (>= 1.5.1, != 1.12.3, != 1.12.2, != 1.12.1, != 1.12.0)
+    socksify (1.7.1)
+    wasabi (3.7.0)
+      addressable
+      httpi (~> 2.0)
+      nokogiri (>= 1.4.2)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.7)
+  nfse_gyn!
+  pry
+  rake (~> 10.0)
+  rspec
+
+BUNDLED WITH
+   1.17.3

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2024 Ramon Vicente
+
+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,113 @@
+# NFSeGyn
+
+NFSeGyn é uma gem que visa a integração com o webservice SOAP da prefeitura de Goiânia para Gerar NFS-e (Nota Fiscal de Serviços Eletrônica)
+
+### Operações Suportadas:
+* *GerarNfse*
+* *ConsultarNfseRps*
+
+## Instalação
+
+Adicione essa linha na Gemfile da sua aplicação:
+
+```ruby
+  gem 'nfse_gyn'
+```
+E então execute:
+
+```bash
+  bundle
+```
+
+Ou instale você mesmo, conforme abaixo:
+
+```bash
+  gem install nfse_gyn
+```
+
+## Como usar?
+
+### Gerando os certificados necessários
+
+```bash
+# exportar o certificado apartir de *.pfx
+$ openssl pkcs12 -in expired_certificate.pfx -clcerts -nokeys -out cert.crt
+
+# converte o certificado .cer para o formato .pem
+$ openssl x509 -in cert.crt -out cert.pem -outform PEM
+
+ # exportar a chave privada apartir de *.pfx
+$ openssl pkcs12 -in expired_certificate.pfx -nocerts -out cert_key.key
+```
+
+### Configurando os certificados
+
+Crie um arquivo `config/initializers/nfse_gyn.rb` e adicione:
+
+```ruby
+NfseGyn.configure do |nfse|
+  nfse.test_mode = true
+  nfse.log_level = :debug
+  nfse.cnpj = '000000000000000'
+  nfse.inscricao_municipal = '0000000'
+  nfse.codigo_tributacao_municipio = '00000000'
+  nfse.valor_aliquota    = 0
+  nfse.cert_path         = '/path/to/certificate.pem'
+  nfse.cert_key_path     = '/path/to/key.pem'
+  nfse.cert_key_password = 'certificate_key_password'
+end
+```
+
+### Criando uma NFS-e
+
+```ruby
+# valores a serem usados na NFSeGyn a ser gerada
+nota_fiscal_info = {
+  identification_number: '3033',
+  description: 'Teste de RPS',
+  data_emissao: '2024-01-11T23:33:22',
+  total: 100.10,
+  customer: {
+    document_type: 'Cnpj',
+    document_number: '98924674000187',
+    name: 'XPTO Tecnologia Ltda',
+    address: {
+      street: 'Rua das Rosas',
+      number: '111',
+      complement: 'Sobre Loja',
+      neighborhood: 'Centro',
+      city_ibge_code: '0025300',
+      state_code: 'GO',
+      zipcode: '74672680'
+    }
+  }
+}
+
+# Operação GerarNfse
+service = NfseGyn::GerarNfse.new(nota_fiscal_info)
+
+# Operação ConsultarNfseRps
+service = NfseGyn::ConsultarNfse.new(14, 'TESTE', 1)
+
+response = service.execute!
+```
+
+## Testes
+
+Para rodar os testes, execute:
+
+```bash
+  bundle exec rspec
+```
+
+## Contribuindo
+
+1. Faça um Fork
+2. Crie um branch para a nova funcionalidade (`git checkout -b minha-nova-funcionalidade`)
+3. Faça o commit de suas alterações  (`git commit -am 'Adicionada nova funcionalidade'`)
+4. Faça um push da sua nova funconalidade (`git push origin minha-nova-funcionalidade`)
+5. Submeta uma nova Pull Request
+
+## Creditos
+
+Essa gem é baseada na gem [nfse-carioca](https://rubygems.org/gems/nfse-carioca)

data/Rakefile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[spec rubocop]

data/bin/console

@@ -0,0 +1,27 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "pry"
+require_relative '../lib/nfse_gyn'
+require "irb"
+
+# 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.
+
+
+def reload!(print = true)
+  puts 'Reloading ...' if print
+  # Main project directory.
+  root_dir = File.expand_path('..', __dir__)
+  # Directories within the project that should be reloaded.
+  reload_dirs = %w{lib}
+  # Loop through and reload every file in all relevant project directories.
+  reload_dirs.each do |dir|
+    Dir.glob("#{root_dir}/#{dir}/**/*.rb").each { |f| load(f) }
+  end
+  # Return true when complete.
+  true
+end
+
+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/lib/nfse_gyn/configuration.rb

@@ -0,0 +1,35 @@
+module NfseGyn
+  class Configuration
+    attr_accessor :wsdl,
+                  :test_mode,
+                  :log_level,
+                  :ca_cert_path,
+                  :cert_key_path,
+                  :cert_path,
+                  :cert_key_password,
+                  :cnpj,
+                  :inscricao_municipal,
+                  :codigo_municipio,
+                  :rps_tipo,
+                  :valor_aliquota,
+                  :codigo_tributacao_municipio
+
+    def initialize
+      @test_mode = false
+      @log_level = :debug
+      @wsdl = 'https://nfse.goiania.go.gov.br/ws/nfse.asmx?wsdl'
+
+      @codigo_municipio = '0025300'
+      @rps_tipo = 1
+
+      @valor_aliquota = 2
+
+      @codigo_tributacao_municipio = ''
+    end
+
+    def rps_serie
+      return 'TESTE' if test_mode
+      'A'
+    end
+  end
+end

data/lib/nfse_gyn/consultar_nfse.rb

@@ -0,0 +1,58 @@
+module NfseGyn
+  class ConsultarNfse
+    attr_reader :invoice_number
+    attr_reader :invoice_serie
+    attr_reader :invoice_type
+
+    def initialize(invoice_number, invoice_serie, invoice_type)
+      @client = NfseGyn::SoapClient.new
+      @invoice_number = invoice_number
+      @invoice_serie = invoice_serie
+      @invoice_type = invoice_type
+    end
+
+    def execute!
+      @client.call(:consultar_nfse_rps, self)
+    end
+
+    def to_xml
+      Gyoku.xml(
+        'ConsultarNfseRpsEnvio' => {
+          '@xmlns' => 'http://nfse.goiania.go.gov.br/xsd/nfse_gyn_v02.xsd',
+
+          'IdentificacaoRps' => {
+            'Numero' => invoice_number,
+            'Serie' => invoice_serie,
+            'Tipo' => invoice_type
+          },
+          'Prestador' => {
+            'CpfCnpj' => {
+              'Cnpj' => NfseGyn.configuration.cnpj
+            },
+            'InscricaoMunicipal' => NfseGyn.configuration.inscricao_municipal
+          }
+        }
+      )
+    end
+
+    private
+
+    class Response < NfseGyn::Response
+      def content
+        @content ||= output['ConsultarNfseRpsResposta']
+      end
+
+      def number
+        content['CompNfse']['Nfse']['InfNfse']['Numero'] if successful?
+      end
+
+      def verification_code
+        content['CompNfse']['Nfse']['InfNfse']['CodigoVerificacao'] if successful?
+      end
+
+      def error?
+        !content['CompNfse'] || content['ListaMensagemRetorno']['MensagemRetorno']['Codigo'] != 'L000'
+      end
+    end
+  end
+end

data/lib/nfse_gyn/gerar_nfse.rb

@@ -0,0 +1,49 @@
+require 'nfse_gyn/gerar_nfse_xml'
+
+module NfseGyn
+  class GerarNfse
+    def initialize(invoice)
+      @invoice = invoice
+      @client = NfseGyn::SoapClient.new
+    end
+
+    def execute!
+      @client.call(:gerar_nfse, self)
+    end
+
+    def to_xml
+      GerarNfseXML.new(@invoice).to_xml
+    end
+
+    private
+
+    class Response < NfseGyn::Response
+      def content
+        @content ||= output['GerarNfseResposta']
+      end
+
+      def number
+        content['ListaNfse']['CompNfse']['Nfse']['InfNfse']['Numero'] if successful?
+      end
+
+      def verification_code
+        content['ListaNfse']['CompNfse']['Nfse']['InfNfse']['CodigoVerificacao'] if successful?
+      end
+
+      def error?
+        !content['ListaNfse'] || content['ListaMensagemRetorno']['MensagemRetorno']['Codigo'] != 'L000'
+      end
+
+      def errors
+        if error?
+          message = content['ListaMensagemRetorno']['MensagemRetorno']
+          message = [message] if message.is_a?(Hash)
+
+          message
+        end
+      rescue StandardError
+        content
+      end
+    end
+  end
+end

data/lib/nfse_gyn/gerar_nfse_xml.rb

@@ -0,0 +1,120 @@
+# frozen_string_literal: true
+
+require 'active_support'
+require 'active_support/core_ext'
+require 'signer'
+
+module NfseGyn
+  class GerarNfseXML
+    def initialize(invoice_info)
+      @invoice = invoice_info
+    end
+
+    def to_xml
+      "<GerarNfseEnvio xmlns=\"http://nfse.goiania.go.gov.br/xsd/nfse_gyn_v02.xsd\">#{sign(body)}</GerarNfseEnvio>"
+    end
+
+    def body
+      Gyoku.xml(
+        'Rps' => {
+          'InfDeclaracaoPrestacaoServico' => {
+            '@xmlns' => 'http://nfse.goiania.go.gov.br/xsd/nfse_gyn_v02.xsd',
+            'Rps' => {
+              '@Id' => @invoice[:identification_number],
+              'IdentificacaoRps' => {
+                'Numero' => @invoice[:identification_number],
+                'Serie' => NfseGyn.configuration.rps_serie,
+                'Tipo' => NfseGyn.configuration.rps_tipo
+              },
+              'DataEmissao' => @invoice[:data_emissao],
+              'Status' => 1
+            },
+
+            'Servico' => {
+              'Valores' => {
+                'ValorServicos' => @invoice[:total],
+                'Aliquota' => NfseGyn.configuration.valor_aliquota
+              },
+
+              'CodigoTributacaoMunicipio' => NfseGyn.configuration.codigo_tributacao_municipio,
+              'Discriminacao' => clear(@invoice[:description]),
+              'CodigoMunicipio' => NfseGyn.configuration.codigo_municipio
+            },
+
+            'Prestador' => {
+              'CpfCnpj' => {
+                'Cnpj' => NfseGyn.configuration.cnpj
+              },
+              'InscricaoMunicipal' => NfseGyn.configuration.inscricao_municipal
+            },
+
+            'Tomador' => tomador
+          }
+        }
+      )
+    end
+
+    def sign(xml)
+      return xml if !certificate.present? || !private_key.present?
+      signer = Signer.new(xml, canonicalize_algorithm: :c14n_1_0, wss: false)
+      signer.cert = OpenSSL::X509::Certificate.new(certificate)
+      signer.private_key = OpenSSL::PKey::RSA.new(private_key, NfseGyn.configuration.cert_key_password)
+      signer.security_node = signer.document.root
+      node = signer.document.dup.at_xpath("//*[@Id=#{@invoice[:identification_number]}]")
+      signer.digest!(node, enveloped: true)
+      signer.sign!(issuer_serial: true)
+      signer.document.to_xml(save_with: Nokogiri::XML::Node::SaveOptions::AS_XML | Nokogiri::XML::Node::SaveOptions::NO_DECLARATION).strip
+    end
+
+    def certificate
+      @certificate ||= File.read(NfseGyn.configuration.cert_path) if NfseGyn.configuration.cert_path.present?
+    end
+
+    def private_key
+      @private_key ||= File.read(NfseGyn.configuration.cert_key_path) if NfseGyn.configuration.cert_key_path.present?
+    end
+
+    def clear(value)
+      NfseGyn::Sanitizer.new(value).clear
+    end
+
+    def document_type
+      @invoice[:customer][:document_type]
+    end
+
+    def document_number
+      @invoice[:customer][:document_number]
+    end
+
+    def tomador
+      xml = {}
+
+      if document_type.present?
+        xml['IdentificacaoTomador'] = {
+          'CpfCnpj' => { document_type => document_number }
+        }
+      end
+
+      if @invoice[:customer][:name].present?
+        xml['RazaoSocial'] = clear(@invoice[:customer][:name])
+      end
+
+      if @invoice[:customer][:address].present?
+        xml['Endereco'] = {
+          'Endereco' => clear(@invoice[:customer][:address][:street]),
+          'Numero' => clear(@invoice[:customer][:address][:number])
+        }
+
+        if @invoice[:customer][:address][:complement].present?
+          xml['Endereco']['Complemento'] = clear(@invoice[:customer][:address][:complement])
+        end
+
+        xml['Endereco']['Bairro'] = clear(@invoice[:customer][:address][:neighborhood])
+        xml['Endereco']['CodigoMunicipio'] = @invoice[:customer][:address][:city_ibge_code]
+        xml['Endereco']['Uf'] = @invoice[:customer][:address][:state_code]
+        xml['Endereco']['Cep'] = @invoice[:customer][:address][:zipcode].scan(/\d/).join
+      end
+      xml
+    end
+  end
+end

data/lib/nfse_gyn/response.rb

@@ -0,0 +1,31 @@
+module NfseGyn
+  class Response
+    def initialize(payload)
+      @payload = payload
+    end
+
+    def class_name
+      self.class.to_s.split('::')[1]
+    end
+
+    def successful?
+      !error?
+    end
+
+    def error?
+      binding.pry
+      content['ListaMensagemRetorno'].present?
+    end
+
+    def error_message
+      if error? && content['ListaMensagemRetorno']['MensagemRetorno'].present?
+        content['ListaMensagemRetorno']['MensagemRetorno']['Correcao'].try(:strip)
+      end
+    end
+
+    def output
+      response = @payload.body.try(:values).try(:first)
+      @output ||= Nori.new.parse(response.try(:values).try(:first) || response)
+    end
+  end
+end

data/lib/nfse_gyn/sanitizer.rb

@@ -0,0 +1,17 @@
+module NfseGyn
+  class Sanitizer
+    attr_reader :value
+
+    def initialize(value)
+      @value = value
+    end
+
+    def clear
+      return nil if value.nil?
+      temp = I18n.transliterate(value)
+      temp.tr!('-', ' ')
+      temp.gsub!(/,|\./, '')
+      temp.scan(/\w+|\s+/i).join
+    end
+  end
+end

data/lib/nfse_gyn/soap_client.rb

@@ -0,0 +1,31 @@
+require 'savon'
+
+module NfseGyn
+  class SoapClient
+    def call(method, object)
+      xml = "<ArquivoXML><![CDATA[#{object.to_xml}]]></ArquivoXML>"
+      payload = client.call(method, message: xml)
+      object.class::Response.new payload
+    end
+
+    private
+
+    def client
+      @client ||= Savon.client(
+        wsdl: NfseGyn.configuration.wsdl,
+        env_namespace: :soap,
+        namespace_identifier: nil,
+        element_form_default: :unqualified,
+        ssl_verify_mode: :none,
+        ssl_cert_file: NfseGyn.configuration.cert_path,
+        ssl_cert_key_file: NfseGyn.configuration.cert_key_path,
+        ssl_ca_cert_file: NfseGyn.configuration.ca_cert_path,
+        ssl_cert_key_password: NfseGyn.configuration.cert_key_password,
+        log_level: NfseGyn.configuration.log_level,
+        log: true,
+        open_timeout: 120,
+        read_timeout: 120
+      )
+    end
+  end
+end

data/lib/nfse_gyn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module NfseGyn
+  VERSION = '0.1.0'.freeze
+end

data/lib/nfse_gyn.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+require 'ostruct'
+require 'active_model'
+
+require 'nfse_gyn/version'
+require 'nfse_gyn/configuration'
+require 'nfse_gyn/sanitizer'
+require 'nfse_gyn/soap_client'
+require 'nfse_gyn/response'
+require 'nfse_gyn/gerar_nfse'
+require 'nfse_gyn/consultar_nfse'
+
+HTTPI.adapter = :net_http
+
+module NfseGyn
+  def self.configure
+    yield configuration
+  end
+
+  def self.configuration
+    @configuration ||= NfseGyn::Configuration.new
+  end
+
+  def self.reset!
+    @configuration = nil
+  end
+end