enotas_nfe 0.0.17 → 0.0.18

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: a53fbf29ac1b3cb257a1af2ae054735db71f5616
-  data.tar.gz: 455d90bee4405169603adf370ed5ae5978ff9e5b
+  metadata.gz: d707afc41c1f1e7ba03b71389c6cfbd5ebfdf6cf
+  data.tar.gz: 5660a4b3be11113fab6f3519b7d44e0699cabbe8
 SHA512:
-  metadata.gz: 6087ae57439296c4fe54b683d99800c9794cd0d79de14b13cb0caa80479857d19765bcdf8e5d9cd41b579c801609c00123555282aa5686ec2937ddf0c426abee
-  data.tar.gz: '09b4159f1ef1ee5ff37fc900fc0cf41090648012ec60531cedf8b77a163666c65875c34ea453695a85c2cb71c3a9b79268d7274386d5f2eb8c871fcb4cdcdaaf'
+  metadata.gz: 124816e933fb8421c513d45512a6fc5e14fb369230c713e0a84bfd0f9e10b9b3132cb7c69c85a5261e62d6cc7b0f2219b7656867e080d223f48b1b102f72a5ca
+  data.tar.gz: b60ed5cefce480088f524edb144630a22e680fc3650bb829ade51a927b660f9a960a83eaba6284c1dcb5d566d4dfab86b0c1daa2880653ecb3f32af1f9c69fa1

data/README.md

@@ -31,6 +31,147 @@ Ou instale manualmente:
 
     $ gem install enotas_nfe
 
+## Cadastro de empresa (emissor)
+
+* Instancie o cliente passando a sua API key:
+
+```ruby
+client = EnotasNfe::Client.new('sua-api-key-do-e-notas', 'nfse')
+```
+
+* Carregue uma instância de Empresa com os dados:
+
+```ruby
+empresa = EnotasNfe::Model::Empresa.new
+empresa.id = 1 # Usado para quando se deseja atualizar o cadastro
+empresa.cnpj = '000000000000000'
+empresa.nomeFantasia = 'Nome Fantasia'
+empresa.razaoSocial = 'Razão Social'
+empresa.inscricaoMunicipal = '00000000'
+empresa.inscricaoEstadual = '00000000'
+empresa.telefoneComercial = '00000000'
+empresa.email = 'email@mail.com'
+empresa.enviarEmailCliente = false
+empresa.regimeEspecialTributacao = '01'
+empresa.aedf = '00000'
+empresa.descricaoServico = '00'
+empresa.codigoServicoMunicipal = '00'
+empresa.cnae = '000000'
+empresa.aliquotaIss = '0.00'
+empresa.optanteSimplesNacional = true
+empresa.incentivadorCultural = false
+empresa.itemListaServicoLC116 = '0.00'
+empresa.endereco = {
+  logradouro: 'Logradouro',
+  complemento: 'Complemento',
+  numero: '1000',
+  bairro: 'Centro',
+  cidade: 'Cidade',
+  codigoIbgeCidade: 666999,
+  uf: SC,
+  cep: 00000000
+}
+empresa.configuracoesNFSeProducao = {
+  serieNFe = 'NFe',
+  sequencialNFe = 1,
+  sequencialLoteNFe = 1,
+
+  # Esses dados variam de acordo com a prefeitura, verifique a necessidade no endpoint de cidades suportadas
+  usuarioAcessoProvedor = 'user',
+  senhaAcessoProvedor = 'pass',
+  tokenAcessoProvedor = 'super-token'
+}
+empresa.configuracoesNFSeHomologacao = {
+  serieNFe = 'NFe',
+  sequencialNFe = 1,
+  sequencialLoteNFe = 1,
+
+  # Esses dados variam de acordo com a prefeitura, verifique a necessidade no endpoint de cidades suportadas
+  usuarioAcessoProvedor = 'user',
+  senhaAcessoProvedor = 'pass',
+  tokenAcessoProvedor = 'super-token'
+}
+```
+
+Como saber quais dados são obrigatórios em um prefeitura, ou se a prefeitura é suportada pelo Enotas?
+
+```ruby
+response = client.get_caracteristicas_prefeitura('codigo-ibge-cidade')
+```
+
+Caso a prefeitura não seja suportada, o response vai ter uma mensagem de erro, informando. Quando é suportada, 
+retorna dados relevantes sobre a prefeitura, que devem ser usados para auxiliar a formação do objeto empresa:
+
+```ruby
+prefeitura = EnotasNfe::Model::CaracteristicaPrefeitura.new(response)
+
+# 0: Nenhuma
+# 1: Certificado
+# 2: Usuário e Senha
+# 3: Token
+prefeitura.tipoAutenticacao
+
+# 0: Não utiliza
+# 1: Opcional
+# 2: Obrigatória
+prefeitura.assinaturaDigital
+
+prefeitura.usaCNAE
+prefeitura.usaItemListaServico
+prefeitura.campoLoginProvedor
+prefeitura.suportaCancelamento
+prefeitura.usaAEDF
+prefeitura.usaRegimeEspecialTributacao
+prefeitura.usaCodigoServicoMunicipal
+prefeitura.usaDescricaoServico
+prefeitura.usaCNAE
+prefeitura.usaItemListaServico
+prefeitura.helpTipoAutenticacao
+prefeitura.helpInscricaoMunicipal
+prefeitura.helpRegimeEspecialTributacao
+prefeitura.helpCodigoServicoMunicipal
+prefeitura.helpDescricaoServico
+prefeitura.helpCNAE
+prefeitura.helpItemListaServico
+prefeitura.suportaEmissaoNFeSemCliente
+prefeitura.suportaEmissaoNFeClienteSemCpf
+prefeitura.suportaEmissaoNFeClienteSemEndereco
+prefeitura.suportaCancelamentoNFeSemCliente
+prefeitura.suportaCancelamentoNFeClienteSemCpf
+
+# Retorna uma lista com os regimes de tributação suportados pela prefeitura
+prefeitura.regimesEspecialTributacao
+```
+
+* Salve:
+
+```ruby
+client.create_update_empresa(empresa)
+```
+
+No caso de sucesso dessa operação, será retornado o campo `empresaId`, que deve ser informado, quando deseja ser atualizado um cadastro, ou nos endpoints de Upload.
+
+## Upload do certificado
+
+```ruby
+certificate = {
+  arquivo: 'arquivo-de-upload',
+  senha: 'pass'
+}
+
+client.set_certificado_digital('empresaId', certificate)
+```
+
+## Upload da logo
+
+```ruby
+logo = {
+  arquivo: 'arquivo-de-upload'
+}
+
+client.set_logo('empresaId', logo)
+```
+
 ## Uso básico para NFSE
 
 * Instancie o cliente passando sua API key:
@@ -418,7 +559,6 @@ Issues e comentários são sempre bem-vindos no repoistório oficial: https://gi
 Quer contribuir e não sabe por onde começar? Veja nosso ROADMAP:
 
 * Escrever testes;
-* Finalizar chamada para troca de logotipo da empresa
 
 ## License
 

data/lib/enotas_nfe.rb

@@ -18,7 +18,11 @@ require "enotas_nfe/model/configuracoes_nfse_homologacao"
 require "enotas_nfe/model/configuracoes_nfse_producao"
 require "enotas_nfe/model/csc"
 require "enotas_nfe/model/emissao_nfe_consumidor"
+require "enotas_nfe/model/certificado_digital"
 require "enotas_nfe/model/empresa"
+require "enotas_nfe/model/help_tipo_autenticacao"
+require "enotas_nfe/model/regimes_especial_tributacao"
+require "enotas_nfe/model/caracteristica_prefeitura"
 require "enotas_nfe/model/pagamento"
 require "enotas_nfe/model/credenciadora_cartao"
 require "enotas_nfe/model/forma_pagamento"

data/lib/enotas_nfe/endpoints.rb

@@ -23,6 +23,10 @@ module EnotasNfe
       multipart_post("empresas/#{firm_id}/certificadoDigital", body)
     end
 
+    def get_caracteristicas_prefeitura(codigo_ibge_cidade)
+      get("estados/cidades/#{codigo_ibge_cidade}/provedor")
+    end
+
     ## rota para carta de correcao
     def cc_create(firm_id, body)
       post("empresas/#{firm_id}/nf-e/cartaCorrecao", body)

data/lib/enotas_nfe/model/caracteristica_prefeitura.rb

@@ -0,0 +1,31 @@
+module EnotasNfe
+  module Model
+    class CaracteristicaPrefeitura
+      include Virtus.model
+
+      attribute :tipoAutenticacao, Integer
+      attribute :assinaturaDigital, Integer
+      attribute :helpTipoAutenticacao, HelpTipoAutenticacao
+      attribute :campoLoginProvedor, Integer
+      attribute :suportaCancelamento, Boolean
+      attribute :usaAEDF, Boolean
+      attribute :usaRegimeEspecialTributacao, Boolean
+      attribute :usaCodigoServicoMunicipal, Boolean
+      attribute :usaDescricaoServico, Boolean
+      attribute :usaCNAE, Boolean
+      attribute :usaItemListaServico, Boolean
+      attribute :helpInscricaoMunicipal, String
+      attribute :helpRegimeEspecialTributacao, String
+      attribute :helpCodigoServicoMunicipal, String
+      attribute :helpDescricaoServico, String
+      attribute :helpCNAE, String
+      attribute :helpItemListaServico, String
+      attribute :suportaEmissaoNFeSemCliente, Boolean
+      attribute :suportaEmissaoNFeClienteSemCpf, Boolean
+      attribute :suportaEmissaoNFeClienteSemEndereco, Boolean
+      attribute :suportaCancelamentoNFeSemCliente, Boolean
+      attribute :suportaCancelamentoNFeClienteSemCpf, Boolean
+      attribute :regimesEspecialTributacao, Array
+    end
+  end
+end

data/lib/enotas_nfe/model/configuracoes_nfse_homologacao.rb

@@ -8,6 +8,7 @@ module EnotasNfe
       attribute :serieNFe, String
       attribute :sequencialLoteNFe, Integer
       attribute :usuarioAcessoProvedor, String
+      attribute :senhaAcessoProvedor, String
       attribute :tokenAcessoProvedor, String
 
     end

data/lib/enotas_nfe/model/configuracoes_nfse_producao.rb

@@ -8,6 +8,7 @@ module EnotasNfe
       attribute :serieNFe, String
       attribute :sequencialLoteNFe, Integer
       attribute :usuarioAcessoProvedor, String
+      attribute :senhaAcessoProvedor, String
       attribute :tokenAcessoProvedor, String
 
     end

data/lib/enotas_nfe/model/empresa.rb

@@ -24,6 +24,8 @@ module EnotasNfe
       attribute :endereco, Endereco
       attribute :inscricaoMunicipal, String
       attribute :inscricaoEstadual, String
+      attribute :prazo, Integer
+      attribute :status, String
       attribute :regimeEspecialTributacao, String
       attribute :descricaoServico, String
       attribute :codigoServicoMunicipal, String

data/lib/enotas_nfe/model/endereco.rb

@@ -6,7 +6,9 @@ module EnotasNfe
 
       attribute :pais, String
       attribute :uf, String
+      attribute :codigoIbgeUf, Integer
       attribute :cidade, String
+      attribute :codigoIbgeCidade, Integer
       attribute :logradouro, String
       attribute :numero, String
       attribute :complemento, String

data/lib/enotas_nfe/model/help_tipo_autenticacao.rb

@@ -0,0 +1,13 @@
+module EnotasNfe
+  module Model
+    class HelpTipoAutenticacao
+      include Virtus.model
+
+      attribute :certificadoDigital, String
+      attribute :usuario, String
+      attribute :senha, String
+      attribute :token, String
+      attribute :fraseSecreta, String
+    end
+  end
+end

data/lib/enotas_nfe/model/produto.rb

@@ -10,6 +10,7 @@ module EnotasNfe
       attribute :codigo, String
       attribute :descricao, String
       attribute :ncm, String
+      attribute :cest, String
       attribute :quantidade, Float
       attribute :unidadeMedida, String
       attribute :valorUnitario, Float

data/lib/enotas_nfe/model/regimes_especial_tributacao.rb

@@ -0,0 +1,10 @@
+module EnotasNfe
+  module Model
+    class RegimesEspecialTributacao
+      include Virtus.model
+
+      attribute :codigo, String
+      attribute :nome, String
+    end
+  end
+end

data/lib/enotas_nfe/model/servico.rb

@@ -13,11 +13,11 @@ module EnotasNfe
       attribute :itemListaServicoLC116, String
       attribute :ufPrestacaoServico, String
       attribute :municipioPrestacaoServico, String
-      attribute :valorCofins, Decimal
-      attribute :valorInss, Decimal
-      attribute :valorIr, Decimal
-      attribute :valorPis, Decimal
-      attribute :valorCsll, Decimal
+      attribute :valorCofins, Float
+      attribute :valorInss, Float
+      attribute :valorIr, Float
+      attribute :valorPis, Float
+      attribute :valorCsll, Float
 
     end
   end

data/lib/enotas_nfe/version.rb

@@ -1,3 +1,3 @@
 module EnotasNfe
-  VERSION = "0.0.17"
+  VERSION = "0.0.18"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: enotas_nfe
 version: !ruby/object:Gem::Version
-  version: 0.0.17
+  version: 0.0.18
 platform: ruby
 authors:
 - Luis Fernando Pimenta
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-01-24 00:00:00.000000000 Z
+date: 2018-03-15 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -132,6 +132,7 @@ files:
 - lib/enotas_nfe/middleware.rb
 - lib/enotas_nfe/model/ambiente_homologacao.rb
 - lib/enotas_nfe/model/ambiente_producao.rb
+- lib/enotas_nfe/model/caracteristica_prefeitura.rb
 - lib/enotas_nfe/model/carta_correcao.rb
 - lib/enotas_nfe/model/certificado_digital.rb
 - lib/enotas_nfe/model/cliente.rb
@@ -146,6 +147,7 @@ files:
 - lib/enotas_nfe/model/endereco_entrega.rb
 - lib/enotas_nfe/model/forma_pagamento.rb
 - lib/enotas_nfe/model/frete.rb
+- lib/enotas_nfe/model/help_tipo_autenticacao.rb
 - lib/enotas_nfe/model/icms.rb
 - lib/enotas_nfe/model/impostos.rb
 - lib/enotas_nfe/model/issqn.rb
@@ -155,6 +157,7 @@ files:
 - lib/enotas_nfe/model/pedido.rb
 - lib/enotas_nfe/model/pis.rb
 - lib/enotas_nfe/model/produto.rb
+- lib/enotas_nfe/model/regimes_especial_tributacao.rb
 - lib/enotas_nfe/model/servico.rb
 - lib/enotas_nfe/model/transportadora.rb
 - lib/enotas_nfe/model/transporte.rb