sefaz 0.2.0 → 1.3.0

data/README.md

@@ -1,33 +1,465 @@
-# Sefaz
+# Biblioteca SEFAZ
 
-Welcome to your new gem! In this directory, you'll find the files you need to be able to package up your Ruby library into a gem. Put your Ruby code in the file `lib/sefaz`. To experiment with that code, run `bin/console` for an interactive prompt.
+[![Gem Version](https://badge.fury.io/rb/sefaz.svg)](https://badge.fury.io/rb/sefaz)
 
-TODO: Delete this and the text above, and describe your gem
+## Instalação
 
-## Installation
+Biblioteca SEFAZ está disponível no RubyGems e pode ser instalada via:
 
-Install the gem and add to the application's Gemfile by executing:
+```bash
+gem install sefaz
+```
 
-    $ bundle add sefaz
+ou adiciona no arquivo Gemfile e execute o `bundle install`:
 
-If bundler is not being used to manage dependencies, install the gem by executing:
+```ruby
+gem 'sefaz'
+```
 
-    $ gem install sefaz
+## Configuração
 
-## Usage
+Crie uma instância da classe `SEFAZ::Webservice::NFE::Client` para acessar os serviços disponíveis na biblioteca:
 
-TODO: Write usage instructions here
+```ruby
+@webservice = SEFAZ::Webservice::NFE::Client.new
+```
 
-## Development
+Após instanciar, é necessário parametrizar a biblioteca:
 
-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.
+- Configuração do Ambiente
 
-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 the created tag, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+```ruby
+@webservice.setaAmbiente({
+    ambiente: "2",              # 1=Produção; 2=Homologação
+    uf: "35"                    # Código IBGE do Estado
+    cnpj: "00.000.000/0000-00"  # CNPJ da empresa emissora
+})
+```
 
-## Contributing
+- Configuração do Responsável Técnico
 
-Bug reports and pull requests are welcome on GitHub at https://github.com/henriqueshiraishi/ruby-sefaz.
+```ruby
+@webservice.setaRespTecnico({
+    cnpj: "00.000.000/0000-00",
+    contato: "EMPRESA",
+    email: "contato@empresa.com.br",
+    fone: "+551100000000",
+    idCSRT: "01",
+    CSRT: "G8063VRTNDMO886SFNK5LDUDEI24XJ22YIPO" 
+})
+```
 
-## License
+- Configuração do PFX de transmissão
 
-The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+```ruby
+@webservice = setaPFXTss({
+    pfx: File.read("certificado_tss.pfx"),
+    senha: "senha_super_secreta"
+})
+```
+
+*Observação: A biblioteca não permite o certificado A3 para transmissão SOAP. Lembrando que, o certificado de transmissão pode ser diferente do certificado de assinatura de XML.*
+
+- Configuração do PFX de assinatura
+
+```ruby
+@webservice.setaPFXAss({
+    pfx: File.read("certificado_ass.pfx"),
+    senha: "senha_super_secreta"
+})
+```
+
+*Observação: Caso é utilizado certificado A3 para assinatura de XML, não é necessário executar essa configuração. A biblioteca disponibiliza métodos que permite exportar o XML e HASH para realizar tratamento externo, como por exemplo, assinatura local de XML com certificado A3.*
+
+## Utilização
+
+Após a configuração, é possível acessar os seguintes serviços:
+
+```ruby
+# Consulta Status SEFAZ
+xml, hash = @webservice.statusDoServico
+
+# Consulta Situação NF
+# @chaveNF(String) = Chave de acesso de uma NF
+xml, hash = @webservice.consultarNF(@chaveNF)
+
+# Consulta Cadastro
+# @nroDocumento(String) = Número do documento
+# @tpDocumento(String)  = CNPJ/CPF/IE
+# @uf(String) = Sigla do estado que será consultado (SP; MG; RJ; ...)
+xml, hash = @webservice.consultarCadastro(@nroDocumento, @tpDocumento, @uf)
+
+# Consulta Recebido de Lote
+# @numRecibo(String) = Número do recibo do lote de NF-e
+xml, hash = @webservice.consultarRecibo(@numRecibo)
+
+# Assinar NF - PFX de assinatura - Certificado A1
+# @documento(Hash ou String) = XML ou HASH que será assinado
+xml, hash = @webservice.assinarNF(@documento)
+
+# Enviar NF - Necessário uma NF assinada
+# @documento(Hash ou String) = XML ou HASH assinado que será enviado
+# @indSinc(String) = "0"=Assíncrono / "1"=Síncrono
+# @idLote(String) = Identificador de controle do Lote de envio do Lote
+xml, hash = @webservice.enviarNF(@documento, @indSinc, @idLote)
+
+# Envia Lote de NF - Necessário que cada NF esteja assinada
+# OBS: Recomendado para envio em lote de NF, cada elemento do Array pode ser Hash ou XML assinados
+# @lote(Array) = Array de NF assinadas
+# @indSinc(String) = "0"=Assíncrono / "1"=Síncrono
+# @idLote(String) = Identificador de controle do Lote de envio do Lote
+# Exemplo de @lote:
+# @nf1_xml, @nf1_hash = @webservice.assinarNF(...)
+# @nf2_xml, @nf2_hash = @webservice.assinarNF(...)
+# @lote = [ @nf1_xml, @nf2_hash ]
+xml, hash = @webservice.enviarLoteNF(@lote, @indSinc, @idLote)
+
+# Calcular Chave NF
+# @uf = Código da UF do emitente do Documento Fiscal
+# @aamm = Ano e Mês de emissão da NF-e
+# @cnpj = CNPJ do emitente
+# @modelo = Modelo do Documento Fiscal (55 ou 65)
+# @serie = Série do Documento Fiscal
+# @nNF = Número do Documento Fiscal
+# @tpEmis = Forma de emissão da NF-e
+# @cNF = Código Numérico que compõe a Chave de Acesso (ID do sistema)
+chaveNF, cDV = @webservice.calculaChaveNF(@uf, @aamm, @cnpj, @modelo, @serie, @nNF, @tpEmis, @cNF)
+
+# Valida NF no SEFAZ RS NF-e (https://www.sefaz.rs.gov.br/NFE/NFE-VAL.aspx)
+# @documento(Hash ou String) = XML ou HASH que será validado
+# @openTimeout(Integer) = Tempo de espera em segundos para abrir conexão (opcional: padrão 60)
+# @readTimeout(Integer) = Tempo de espera em segundos para ler resposta (opcional: padrão 60)
+# => @stat = True/False se a validação foi executada com sucesso
+# => @msg  = Hash com todas as mensagens geradas pelo validador
+# => @err  = Hash com todas as mensagens de erros geradas pelo validador
+stat, msg, err = @webservice.validarNF(@documento)
+
+# Auditar NF no validador TecnoSpeed (https://validador.nfe.tecnospeed.com.br/)
+# @documento(Hash ou String) = XML ou HASH que será auditado
+# @openTimeout(Integer) = Tempo de espera em segundos para abrir conexão (opcional: padrão 60)
+# @readTimeout(Integer) = Tempo de espera em segundos para ler resposta (opcional: padrão 60)
+# => @stat = True/False se o auditor foi executado com sucesso
+# => @msg  = Hash com todas as mensagens geradas pelo auditor
+stat, msg = @webservice.auditarNF(@documento)
+
+# Inutilizar NF - Gera, assina e envia o documento com certificado A1 (exportarInutilizarNF, assinarNF, enviarInutilizarNF)
+# OBS: Caso parâmetro @chaveInut estiver em branco, a chave será calculada automaticamente (calculaChaveInutilizacao)
+# @chaveInut = Identificador da TAG a ser assinada
+# @ano = Ano de inutilização da numeração
+# @modelo = Modelo do documento (55 ou 65)
+# @serie = Série da NF-e
+# @nroNFIni = Número da NF-e inicial a ser inutilizada
+# @nroNFFin = Número da NF-e final a ser inutilizada
+# @justificativa = Informar a justificativa do pedido de inutilização
+xml, hash = @webservice.inutilizarNF(@chaveInut, @ano, @modelo, @serie, @nroNFIni, @nroNFFin, @justificativa)
+
+# Exportar Inutilização NF - Exporta um documento bruto (sem assinatura)
+# OBS: Recomendado quando utilizado o certificado A3
+#      Caso parâmetro @chaveInut estiver em branco, a chave será calculada automaticamente (calculaChaveInutilizacao)
+# @chaveInut = Identificador da TAG a ser assinada
+# @ano = Ano de inutilização da numeração
+# @modelo = Modelo do documento (55 ou 65)
+# @serie = Série da NF-e
+# @nroNFIni = Número da NF-e inicial a ser inutilizada
+# @nroNFFin = Número da NF-e final a ser inutilizada
+# @justificativa = Informar a justificativa do pedido de inutilização
+xml, hash = @webservice.exportarInutilizarNF(@chaveInut, @ano, @modelo, @serie, @nroNFIni, @nroNFFin, @justificativa)
+
+# Enviar Inutilização NF - Necessário um documento assinado
+# OBS: Recomendado quando utilizado o certificado A3
+# @documento(Hash ou String) = XML ou HASH assinado que será enviado
+xml, hash = @webservice.enviarInutilizarNF(@documento)
+
+# Calcular Chave de Inutilização
+# @ano = Ano de inutilização da numeração
+# @cnpj = CNPJ do emitente
+# @modelo = Modelo do documento (55 ou 65)
+# @serie = Série da NF-e
+# @nroNFIni = Número da NF-e inicial a ser inutilizada
+# @nroNFFin = Número da NF-e final a ser inutilizada
+chaveInut = @webservice.calculaChaveInutilizacao(@ano, @cnpj, @modelo, @serie, @nroNFIni, @nroNFFin)
+
+# Cancelar NF - Gera, assina e envia o documento com certificado A1 (exportarCancelarNF, assinarNF, enviarEvento)
+# @chaveNF = Chave de acesso de uma NF
+# @sequenciaEvento = O número do evento
+# @dataHoraEvento = Data e Hora da Emissão do Evento (ex: 2023-01-15T17:23:00+03:00)
+# @numProtocolo = Número do Protocolo de registro da NF
+# @justificativa = Motivo do cancelamento da NF
+# @idLote = Número de controle interno
+xml, hash = @webservice.cancelarNF(@chaveNF, @sequenciaEvento, @dataHoraEvento, @numProtocolo, @justificativa, @idLote)
+
+# Exportar Cancelar NF - Exporta um documento bruto (sem assinatura)
+# OBS: Recomendado quando utilizado o certificado A3
+# @chaveNF = Chave de acesso de uma NF
+# @sequenciaEvento = O número do evento
+# @dataHoraEvento = Data e Hora da Emissão do Evento (ex: 2023-01-15T17:23:00+03:00)
+# @numProtocolo = Número do Protocolo de registro da NF
+# @justificativa = Motivo do cancelamento da NF
+# @idLote = Número de controle interno
+xml, hash = @webservice.exportarCancelarNF(@chaveNF, @sequenciaEvento, @dataHoraEvento, @numProtocolo, @justificativa)
+
+# Enviar Evento - Necessário um documento assinado
+# OBS: Recomendado quando utilizado o certificado A3
+# @evento(Hash ou String) = XML ou HASH assinado que será enviado
+# @idLote(String) = Identificador de controle do Lote de envio do Evento
+xml, hash = @webservice.enviarEvento(@evento, @idLote)
+
+# Envia Lote de Eventos - Necessário que cada evento esteja assinado
+# OBS: Recomendado quando utilizado o certificado A3 e/ou para envio em lote de eventos
+#      Cada elemento do Array pode ser Hash ou XML assinados
+# @lote(Array) = Array de eventos assinados
+# @idLote(String) = Identificador de controle do Lote de envio do Evento
+# Exemplo de @lote:
+# @eve1_xml, @eve1_hash = @webservice.exportarCancelarNF(...)
+# @eve2_xml, @eve2_hash = @webservice.exportarCancelarNF(...)
+# @lote = [ @eve1_xml, @eve2_hash ]
+xml, hash = @webservice.enviarLoteDeEvento(@lote, @idLote)
+
+# Enviar CCe - Gera, assina e envia o documento com certificado A1 (exportarCCe, assinarNF, enviarEvento)
+# @chaveNF = Chave de acesso de uma NF
+# @sequenciaEvento = O número do evento
+# @dataHoraEvento = Data e Hora da Emissão do Evento (ex: 2023-01-15T17:23:00+03:00)
+# @textoCorrecao = Motivo do cancelamento da NF
+# @idLote = Número de controle interno
+xml, hash = @webservice.enviarCCe(@chaveNF, @sequenciaEvento, @dataHoraEvento, @textoCorrecao, @idLote)
+
+# Exportar CCe - Exporta um documento bruto (sem assinatura)
+# OBS: Recomendado quando utilizado o certificado A3
+# @chaveNF = Chave de acesso de uma NF
+# @sequenciaEvento = O número do evento
+# @dataHoraEvento = Data e Hora da Emissão do Evento (ex: 2023-01-15T17:23:00+03:00)
+# @textoCorrecao = Motivo do cancelamento da NF
+xml, hash = @webservice.exportarCCe(@chaveNF, @sequenciaEvento, @dataHoraEvento, @textoCorrecao)
+
+# Gera Informações do Responsável Técnico - Calcula o hashCSRT e cria o grupo do responsável técnico
+# Necessário quando estiver emitindo uma NF-e/NFC-e
+# @documento(Hash ou String) = XML ou HASH que será tratado
+xml, hash = @webservice.gerarInfRespTec(@documento)
+```
+
+## Enviando NF com Dataset
+
+Acessa o arquivo [docs/NFe-NFCe/_dataset.md](https://github.com/henriqueshiraishi/ruby-sefaz/blob/main/docs/NFe-NFCe/_dataset.md) para visualizar todos os campos que pode ser informado no Dataset.
+
+```ruby
+# Declarando os campos necessários para calcular a chave da NF
+@uf = "35"
+@aamm = "2303"
+@cnpj = "21684155000164"
+@modelo = "55"
+@serie = "1"
+@nNF = "244"
+@tpEmis = "1"
+@cNF = "07522998"
+
+# Calculando a chave e o dígito verificador da NF
+@chaveNF, @cDV = @webservice.calculaChaveNF(@uf, @aamm, @cnpj, @modelo, @serie, @nNF, @tpEmis, @cNF)
+
+# Instanciando objeto Dataset
+@dataset = SEFAZ::Webservice::NFE::Dataset.new(@chaveNF)
+
+# Inserindo os dados da NF
+@dataset.ide.cUF = @uf
+@dataset.ide.cNF = @cNF
+@dataset.ide.natOp = "Venda de Mercadoria"
+@dataset.ide.mod = @modelo
+@dataset.ide.serie = @serie
+@dataset.ide.nNF = @nNF
+@dataset.ide.dhEmi = "2023-03-21T17:10:03+00:00"
+@dataset.ide.dhSaiEnt = "2023-03-21T17:10:03+00:00"
+@dataset.ide.tpNF = "1"
+@dataset.ide.idDest = "1"
+@dataset.ide.cMunFG = "3550308"
+@dataset.ide.tpImp = "1"
+@dataset.ide.tpEmis = @tpEmis
+@dataset.ide.cDV = @cDV
+@dataset.ide.tpAmb = "2"
+@dataset.ide.finNFe = "1"
+@dataset.ide.indFinal = "0"
+@dataset.ide.indPres = "0"
+@dataset.ide.procEmi = "0"
+@dataset.ide.verProc = "4.0.1"
+
+@dataset.emit.CNPJ = @cnpj
+@dataset.emit.xNome = "PHS INDUSTRIA METALURGICA EIRELI"
+@dataset.emit.xFant = "PHS"
+@dataset.emit.enderEmit.xLgr = "RUA SANTO HENRIQUE"
+@dataset.emit.enderEmit.nro = "926"
+@dataset.emit.enderEmit.xBairro = "VILA RE"
+@dataset.emit.enderEmit.cMun = "3550308"
+@dataset.emit.enderEmit.xMun = "SAO PAULO"
+@dataset.emit.enderEmit.UF = "SP"
+@dataset.emit.enderEmit.CEP = "03664010"
+@dataset.emit.enderEmit.cPais = "1058"
+@dataset.emit.enderEmit.xPais = "Brasil"
+@dataset.emit.enderEmit.fone = "1134676938"
+@dataset.emit.IE = "144190701117"
+@dataset.emit.IM = "51610965"
+@dataset.emit.CNAE = "2599399"
+@dataset.emit.CRT = "1"
+
+@dataset.dest.CNPJ = "01947271000111"
+@dataset.dest.xNome = "NF-E EMITIDA EM AMBIENTE DE HOMOLOGACAO - SEM VALOR FISCAL"
+@dataset.dest.enderDest.xLgr = "RUA SALGADO DE CASTRO"
+@dataset.dest.enderDest.nro = "265"
+@dataset.dest.enderDest.xBairro = "VILA MARINA"
+@dataset.dest.enderDest.cMun = "3513801"
+@dataset.dest.enderDest.xMun = "DIADEMA"
+@dataset.dest.enderDest.UF = "SP"
+@dataset.dest.enderDest.CEP = "09920690"
+@dataset.dest.enderDest.cPais = "1058"
+@dataset.dest.enderDest.xPais = "BRASIL"
+@dataset.dest.enderDest.fone = "1140555455"
+@dataset.dest.indIEDest = "1"
+@dataset.dest.IE = "286145468117"
+
+@dataset.add("DET") do |det|
+    det.prod.cProd = "5.35.0160"
+    det.prod.cEAN = "SEM GTIN"
+    det.prod.xProd = "T-176, LATAO D5X4,,5MM, FURO 1.2MM"
+    det.prod.NCM = "74153300"
+    det.prod.CEST = "1006600"
+    det.prod.CFOP = "5101"
+    det.prod.uCom = "PC"
+    det.prod.qCom = "1000.0"
+    det.prod.vUnCom = "0.3800"
+    det.prod.vProd = "380.00"
+    det.prod.cEANTrib = "SEM GTIN"
+    det.prod.uTrib = "PC"
+    det.prod.qTrib = "1000.0"
+    det.prod.vUnTrib = "0.3800"
+    det.prod.indTot = "1"
+    det.prod.xPed = "OC 0123-000033"
+
+    det.imposto.vTotTrib = "0.00"
+
+    det.imposto.ICMS.ICMSSN101.orig = "0"
+    det.imposto.ICMS.ICMSSN101.CSOSN = "101"
+    det.imposto.ICMS.ICMSSN101.pCredSN = "1.86"
+    det.imposto.ICMS.ICMSSN101.vCredICMSSN = "7.07"
+
+    det.imposto.PIS.PISNT.CST = "07"
+    det.imposto.COFINS.COFINSNT.CST = "07"
+end
+
+@dataset.total.ICMSTot.vBC = "0.00"
+@dataset.total.ICMSTot.vICMS = "0.00"
+@dataset.total.ICMSTot.vICMSDeson = "0.00"
+@dataset.total.ICMSTot.vFCPUFDest = "0.00"
+@dataset.total.ICMSTot.vICMSUFDest = "0.00"
+@dataset.total.ICMSTot.vICMSUFRemet = "0.00"
+@dataset.total.ICMSTot.vFCP = "0.00"
+@dataset.total.ICMSTot.vBCST = "0.00"
+@dataset.total.ICMSTot.vST = "0.00"
+@dataset.total.ICMSTot.vFCPST = "0.00"
+@dataset.total.ICMSTot.vFCPSTRet = "0.00"
+@dataset.total.ICMSTot.vProd = "380.00"
+@dataset.total.ICMSTot.vFrete = "0.00"
+@dataset.total.ICMSTot.vSeg = "0.00"
+@dataset.total.ICMSTot.vDesc = "0.00"
+@dataset.total.ICMSTot.vII = "0.00"
+@dataset.total.ICMSTot.vIPI = "0.00"
+@dataset.total.ICMSTot.vIPIDevol = "0.00"
+@dataset.total.ICMSTot.vPIS = "0.00"
+@dataset.total.ICMSTot.vCOFINS = "0.00"
+@dataset.total.ICMSTot.vOutro = "0.00"
+@dataset.total.ICMSTot.vNF = "380.00"
+@dataset.total.ICMSTot.vTotTrib = "0.00"
+
+@dataset.transp.modFrete = "0"
+
+@dataset.add("VOL") do |vol|
+    vol.qVol = "1"
+    vol.esp = "VOLUME"
+    vol.pesoL = "1.000"
+    vol.pesoB = "1.000"
+end
+
+@dataset.cobr.fat.nFat = "86"
+@dataset.cobr.fat.vOrig = "380.00"
+@dataset.cobr.fat.vDesc = "0.00"
+@dataset.cobr.fat.vLiq = "380.00"
+
+@dataset.add("DUP") do |dup|
+    dup.nDup = "001"
+    dup.dVenc = "2023-03-31"
+    dup.vDup = "380.00"
+end
+
+@dataset.add("DETPAG") do |detpag|
+    detpag.tPag = "15"
+    detpag.vPag = "380.00"
+end
+
+@dataset.infAdic.infCpl = "PEDIDO DO CLIENTE N OC 0123-000033. DOCUMENTO EMITIDO POR ME OU EPP OPTANTE PELO SIMPLES NACIONAL: PERMITE O APROVEITAMENTO DO CREDITO DE ICMS NO VALOR DE R 7,07; CORRESPONDENTE A ALIQUOTA DE 1.86, NOS TERMOS DO ART. 23 DA LEI COMPLEMENTAR N 123, DE 2006"
+
+# Gerando e assinando XML
+@xml, _ = @dataset.gerarNF
+@xml, _ = @webservice.assinarNF(@xml)
+
+# Enviando NF
+@retEnviNFe = @webservice.enviarNF(@xml, "0", "1")
+```
+
+## Consulta de recibo da NF
+
+```ruby
+# A partir do @retEnviNFe do exemplo anterior
+@nRec = @retEnviNFe[1][:nfeResultMsg][:retEnviNFe][:infRec][:nRec]
+@retConsReciNFe = @webservice.consultarRecibo(@nRec)
+
+@cStat = @retConsReciNFe[1][:nfeResultMsg][:retConsReciNFe][:protNFe][:infProt][:cStat]
+@nProt = @retConsReciNFe[1][:nfeResultMsg][:retConsReciNFe][:protNFe][:infProt][:nProt]
+```
+
+## Cancelamento da NF
+
+```ruby
+# A partir da @chaveNF e @nProt dos exemplos anteriores
+@sequenciaEvento = "1"
+@dataHoraEvento = "2023-03-22T17:00:00+03:00"
+@justificativa = "NF-e emitida em duplicidade."
+@idLote = "1"
+@retEnvEvento = @webservice.cancelarNF(@chaveNF, @sequenciaEvento, @dataHoraEvento, @nProt, @justificativa, @idLote)
+
+@cStat = @retEnvEvento[1][:nfeResultMsg][:retEnvEvento][:retEvento][:infEvento][:cStat]
+@xMotivo = @retEnvEvento[1][:nfeResultMsg][:retEnvEvento][:retEvento][:infEvento][:xMotivo]
+```
+
+## CFe-SAT
+
+### Arquivo de Venda
+
+Acessa o arquivo [docs/CFe-SAT/_SALE_dataset.md](https://github.com/henriqueshiraishi/ruby-sefaz/blob/main/docs/CFe-SAT/_SALE_dataset.md) para visualizar todos os campos que pode ser informado no Dataset.
+
+```ruby
+# Dataset para gerar arquivo de venda do CFe-SAT
+@dataset = SEFAZ::Webservice::SAT::Dataset::Sale.new
+...
+@xml, @hash = @dataset.gerarCF
+```
+
+### Arquivo de Cancelamento
+
+Acessa o arquivo [docs/CFe-SAT/_CANCEL_dataset.md](https://github.com/henriqueshiraishi/ruby-sefaz/blob/main/docs/CFe-SAT/_CANCEL_dataset.md) para visualizar todos os campos que pode ser informado no Dataset.
+
+```ruby
+# Dataset para gerar arquivo de cancelamento do CFe-SAT
+@dataset = SEFAZ::Webservice::SAT::Dataset::Cancel.new
+...
+@xml, @hash = @dataset.gerarCF
+```
+
+## Desenvolvimento
+
+Depois de verificar o repositório, execute `bin/setup` para instalar as dependências. Em seguida, execute `rake test` para executar os testes. Você também pode executar `bin/console` para um prompt interativo que permitirá que você experimente.
+
+Para instalar esta gem em sua máquina local, execute `bundle exec rake install`. Para lançar uma nova versão, atualize o número da versão em `version.rb`, e então execute `bundle exec rake release`, que criará uma tag git para a versão, push git commits e a tag criada, e envia o pacote `.gem` para o [rubygems.org](https://rubygems.org).
+
+## Contribuição
+
+Relatórios de bugs e solicitações pull são bem-vindos no GitHub em <https://github.com/henriqueshiraishi/ruby-sefaz>.
+
+## Licença
+
+A gema está disponível como código aberto sob os termos da [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -7,6 +7,7 @@ Rake::TestTask.new(:test) do |t|
   t.libs << "test"
   t.libs << "lib"
   t.test_files = FileList["test/**/test_*.rb"]
+  t.warning = false
 end
 
 task default: :test

data/docs/CFe-SAT/_CANCEL_dataset.md

@@ -0,0 +1,14 @@
+# Lista dos campos do Cancel Dataset
+
+```ruby
+# Instanciando objeto Dataset
+@dataset = SEFAZ::Webservice::SAT::Dataset::Cancel.new(@chCanc)
+
+# Identificação do Cupom Fiscal Eletrônico
+@dataset.ide.CNPJ = ""
+@dataset.ide.signAC = ""
+@dataset.ide.numeroCaixa = ""
+
+# Gerando o XML e Hash do Dataset
+@xml, @hash = @dataset.gerarCF
+```

data/docs/CFe-SAT/_SALE_dataset.md

@@ -0,0 +1,171 @@
+# Lista dos campos do Sale Dataset
+
+```ruby
+# Instanciando objeto Dataset
+@dataset = SEFAZ::Webservice::SAT::Dataset::Sale.new
+
+# Identificação do Cupom Fiscal Eletrônico
+@dataset.ide.CNPJ = ""
+@dataset.ide.signAC = ""
+@dataset.ide.numeroCaixa = ""
+
+# Identificação do Emitente do Cupom Fiscal eletrônico
+@dataset.emit.CNPJ = ""
+@dataset.emit.IE = ""
+@dataset.emit.IM = ""
+@dataset.emit.cRegTribISSQN = ""
+@dataset.emit.indRatISSQN = ""
+
+# Identificação do Destinatário do Cupom Fiscal Eletrônico
+@dataset.dest.CNPJ = ""
+@dataset.dest.CPF = ""
+@dataset.dest.xNome = ""
+
+# Identificação do Local de Entrega
+@dataset.entrega.xLgr = ""
+@dataset.entrega.nro = ""
+@dataset.entrega.xCpl = ""
+@dataset.entrega.xBairro = ""
+@dataset.entrega.xMun = ""
+@dataset.entrega.UF = ""
+
+# Detalhamento de Produtos e Serviços do CF-e
+@dataset.add("DET") do |det|
+  # Produtos e Serviços do CF-e
+  det.prod.cProd = ""
+  det.prod.cEAN = ""
+  det.prod.xProd = ""
+  det.prod.NCM = ""
+  det.prod.CEST = ""
+  det.prod.CFOP = ""
+  det.prod.uCom = ""
+  det.prod.qCom = ""
+  det.prod.vUnCom = ""
+  det.prod.indRegra = ""
+  det.prod.vDesc = ""
+  det.prod.vOutro = ""
+  det.prod.cANP = ""
+
+  # Grupo do campo de uso livre do Fisco
+  @dataset.add("OBSFISCODET") do |obsfiscodet|
+    obsfiscodet.xCampoDet = ""
+    obsfiscodet.xTextoDet = ""
+  end
+
+  # Tributos incidentes no Produto ou Serviço
+  det.imposto.vItem12741 = ""
+
+  # ICMS Normal e ST
+  # Grupo de Tributação do ICMS = 00,01,12,13,14,20,21,72,73,74,90
+  det.imposto.ICMS.ICMS00.Orig = ""
+  det.imposto.ICMS.ICMS00.CST = ""
+  det.imposto.ICMS.ICMS00.pICMS = ""
+
+  # Grupo de Tributação do ICMS = 30,40,41,60,61
+  det.imposto.ICMS.ICMS40.Orig = ""
+  det.imposto.ICMS.ICMS40.CST = ""
+
+  # Simples Nacional e CSOSN = 102,300,400,500
+  det.imposto.ICMS.ICMSSN102.Orig = ""
+  det.imposto.ICMS.ICMSSN102.CSOSN = ""
+
+  # Simples Nacional e CSOSN = 900
+  det.imposto.ICMS.ICMSSN900.Orig = ""
+  det.imposto.ICMS.ICMSSN900.CSOSN = ""
+  det.imposto.ICMS.ICMSSN900.pICMS = ""
+
+  # Grupo do PIS
+  # Grupo de PIS tributado pela alíquota
+  det.imposto.PIS.PISAliq.CST = ""
+  det.imposto.PIS.PISAliq.vBC = ""
+  det.imposto.PIS.PISAliq.pPIS = ""
+
+  # Grupo de PIS tributado por Qtde
+  det.imposto.PIS.PISQtde.CST = ""
+  det.imposto.PIS.PISQtde.qBCProd = ""
+  det.imposto.PIS.PISQtde.vAliqProd = ""
+
+  # Grupo de PIS não tributado
+  det.imposto.PIS.PISNT.CST = ""
+
+  # Grupo de PIS para contribuinte do SIMPLES NACIONAL
+  det.imposto.PIS.PISSN.CST = ""
+
+  # Grupo de PIS Outras Operações
+  det.imposto.PIS.PISOutr.CST = ""
+  det.imposto.PIS.PISOutr.vBC = ""
+  det.imposto.PIS.PISOutr.pPIS = ""
+  det.imposto.PIS.PISOutr.qBCProd = ""
+  det.imposto.PIS.PISOutr.vAliqProd = ""
+
+  # Grupo de PIS Substituição Tributária
+  det.imposto.PISST.vBC = ""
+  det.imposto.PISST.pPIS = ""
+  det.imposto.PISST.qBCProd = ""
+  det.imposto.PISST.vAliqProd = ""
+
+  # Grupo do COFINS
+  # Grupo de COFINS tributado pela alíquota
+  det.imposto.COFINS.COFINSAliq.CST = ""
+  det.imposto.COFINS.COFINSAliq.vBC = ""
+  det.imposto.COFINS.COFINSAliq.pCOFINS = ""
+
+  # Grupo de COFINS tributado por Qtde
+  det.imposto.COFINS.COFINSQtde.CST = ""
+  det.imposto.COFINS.COFINSQtde.qBCProd = ""
+  det.imposto.COFINS.COFINSQtde.vAliqProd = ""
+
+  # Grupo de COFINS não tributado
+  det.imposto.COFINS.COFINSNT.CST = ""
+
+  # Grupo de COFINS para contribuinte do SIMPLES NACIONAL
+  det.imposto.COFINS.COFINSSN.CST = ""
+
+  # Grupo de COFINS Outras Operações
+  det.imposto.COFINS.COFINSOutr.CST = ""
+  det.imposto.COFINS.COFINSOutr.vBC = ""
+  det.imposto.COFINS.COFINSOutr.pCOFINS = ""
+  det.imposto.COFINS.COFINSOutr.qBCProd = ""
+  det.imposto.COFINS.COFINSOutr.vAliqProd = ""
+
+  # Grupo de COFINS Substituição Tributária
+  det.imposto.COFINSST.vBC = ""
+  det.imposto.COFINSST.pCOFINS = ""
+  det.imposto.COFINSST.qBCProd = ""
+  det.imposto.COFINSST.vAliqProd = ""
+
+  # Grupo do ISSQN
+  det.imposto.ISSQN.vDeducISSQN = ""
+  det.imposto.ISSQN.vAliq = ""
+  det.imposto.ISSQN.cMunFG = ""
+  det.imposto.ISSQN.cListServ = ""
+  det.imposto.ISSQN.cServTribMun = ""
+  det.imposto.ISSQN.cNatOp = ""
+  det.imposto.ISSQN.indIncFisc = ""
+
+  # Informações adicionais
+  det.infAdProd = ""
+end
+
+# Valores Totais do CF-e
+@dataset.total.vCFeLei12741 = ""
+
+# Grupo de valores de entrada de Desconto/Acréscimo sobre Subtotal
+@dataset.total.DescAcrEntr.vDescSubtot = ""
+@dataset.total.DescAcrEntr.vAcresSubtot = ""
+
+# Informações sobre Pagamento
+# Grupo de informações dos Meios de Pagamento empregados na quitação do CF-e
+@dataset.add("MP") do |mp|
+  mp.cMP = ""
+  mp.vMP = ""
+  mp.cAdmC = ""
+  mp.cAut = ""
+end
+
+# Grupo de Informações Adicionais
+@dataset.infAdic.infCpl = ""
+
+# Gerando o XML e Hash do Dataset
+@xml, @hash = @dataset.gerarCF
+```