enotas_api 0.1.0 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 13a5351ba686d3a3210dad5388240d5cd7f6ba666bf0d5a1a91c7d9e77236695
-  data.tar.gz: 3586d0c17bc0088e6dc3de95d1832b0b828551f717db0b84ffebe8015757d13a
+  metadata.gz: 4721088f9ef97e488e098c9b6df68929b1807690911634eb14d334a12b733c0c
+  data.tar.gz: e938a5ed1dbcbd56893e177de99770329e99e3934c365a63d2447df3eb1cea91
 SHA512:
-  metadata.gz: 64e30fef619fbbed94af1d424312e812ad67b75232cef877891d60eefbb65cedcd00162f097fcb74516f22de1bd0c1017413f0d1e09a6bbedd0acda35b474770
-  data.tar.gz: 4abbb3a41c1585e7f74056e903860313fbc65703611f3129820619d2417ab0d3744539f2b10d364d3595f1d0eff4ed7669b97750f09d887bd70fb605e0695cb1
+  metadata.gz: bc396e03d1883571e80ded83c31d0a37d3248a5e2ad080dd4f4693cbeab1d00a37720cf84088a7f087eb0f757d485847dc4b2f26c236f2b291848404718a6cd5
+  data.tar.gz: d0437e3cc3b6e4981d9d54a4854796fa68a0a3ac3516dc0211fc2e7dc29688925f261a38d4945cb7d9b4bc2019a5829dd85d5aca6acc9eb376c85423044c2794

data/.gitignore

@@ -9,5 +9,6 @@
 
 # rspec failure tracking
 .rspec_status
+*.gem
 
 sample.rb

data/.rubocop.yml

@@ -5,11 +5,15 @@ AllCops:
     - sample.rb
   NewCops: enable
   UseCache: true
+Layout/LineLength:
+  Max: 150
+Metrics/AbcSize:
+  Max: 20
 Metrics/BlockLength:
   Exclude:
     - spec/**/*.rb
-Metrics/LineLength:
-  Max: 150
+Metrics/MethodLength:
+  Max: 15
 Naming/MethodParameterName:
   Enabled: false
 RSpec/ExampleLength:

data/CHANGELOG.md

@@ -1,2 +1,4 @@
+# 1.0.0
+- Implemenado suporte completo a API V1 (NFS-e)
 # 0.1.0
-* Versão em desenvolvimento, ainda não disponível para utilizar em produção
+- WIP (ainda não disponível para uso em produção)

data/README.md

@@ -1,14 +1,18 @@
-# EnotasApi (WORK IN PROGRESS)
+# EnotasApi
 *enotas_api* é um cliente ruby para a [API](https://docs.enotasgw.com.br/reference) do [e-notas](https://enotas.com.br/).
 
-Não oficial, porém com design simples e suportada com carinho por [@salaozen](https://github.com/salaozen).
+EnotasApi é uma gem não oficial porém com design simples, livre de dependências
+
+Criada e mantida com carinho por [@salaozen](https://github.com/salaozen).
 
 ## English Readers
 *enotas_api* is a ruby api client for [e-notas](https://enotas.com.br/) [API](https://docs.enotasgw.com.br/reference).
 
-Non oficial, but well supported with love by [@salaozen](https://github.com/salaozen).
+EnotasApi its a non oficial, but well with simple design an dependency free
+
+Created and supported with love by [@salaozen](https://github.com/salaozen).
 
-Because e-notas api is entire in portuguese, the code and documentation from here will also be. Sorry about that. :D
+PS: Because e-notas api is entire in portuguese, the code and documentation from here will also be. Sorry about that. :D
 
 ## Dependencias
 EnotasApi não depende de nenhuma Gem externa para executar, (aloha dependency hell).
@@ -32,7 +36,7 @@ Ou instale você mesmo com:
 $ gem install enotas_api
 ```
 
-## Utilização (WIP)
+## Utilização
 
 Primeiro é necessário configurar o `EnotasApi`
 ```ruby
@@ -69,78 +73,83 @@ result = instance.call
 result.to_json # = <JSON retornado pela API do e-notas>
 ```
 
-### Lista de objetos disponiveis
-```ruby
-EnotasApi::V1::ConsultarCaracteristicasPrefeitura.new(codigo_ibge_cidade)
-
-EnotasApi::V1::ConsultarCidadesServicioMunicipalUnificado.new
-
-EnotasApi::V1::ConsultarEmpresa.new(id)
-
-EnotasApi::V1::ConsultarServicosMunicipais.new(uf, nome_cidade)
-
-EnotasApi::V1::ListarEmpresas.new
-```
-
-
 ## Endpoints suportados (marcados com X) e em desenvolvimento (sem marcação)
-API - NFS-e (V1) - [Documentação](https://docs.enotasgw.com.br/reference)
-- [x] Empresa: Consultar Empresa
-- [x] Empresa: Listar Empresas
-- [ ] Empresa: Incluir / Atualizar Empresa
-- [ ] Empresa: Vincular Certificado
-- [ ] Empresa: Vincular Logotipo
-- [ ] Empresa: Desabilitar Empresa
-- [ ] Empresa: Habilitar Empresa
-- [ ] NFS-E: Listar Notas Fiscais
-- [ ] NFS-E: Consultar pelo ID do Gateway
-- [ ] NFS-E: Consultar pelo Id Externo
-- [ ] NFS-E: Download XML
-- [ ] NFS-E: Download XML (IdExterno)
-- [ ] NFS-E: Download PDF
-- [ ] NFS-E: Download PDF (IdExterno)
-- [ ] NFS-E: Emissão de Nota Fiscal
-- [ ] NFS-E: Cancelar
-- [ ] NFS-E: Cancelar (IdExterno)
-- [x] API Complementar: Serviços Municipais da Cidade
-- [x] API Complementar: Características da Prefeitura
-- [x] API Complementar: Cidades com Serviço Municipal Unificado
-
-API - NF-e & NFC-e (v2) - [Documentação](https://docs.enotasgw.com.br/v2/reference)
-- [ ] Empresa: Incluir/Alterar Empresa
-- [ ] Empresa: Vincular Certificado
-- [ ] Empresa: Vincular Logotipo
-- [ ] Empresa: Consultar Empresa
-- [ ] Empresa: Listar Empresas
-- [ ] NFC-E: Emitir Nota Fiscal
-- [ ] NFC-E: Consultar Nota Fiscal
-- [ ] NFC-E: Consultar XML
-- [ ] NFC-E: Cancelar Nota Fiscal
-- [ ] NFC-E: Consultar XML de Envio do Cancelamento
-- [ ] NFC-E: Consultar XML de Retorno do Cancelamento
-- [ ] NFC-E: Inutilizar Numeração
-- [ ] NFC-E: Consultar Inutilização de Número da Nota Fiscal
-- [ ] NFC-E: Consultar XML de Inutilização
-- [ ] NF-E: Emitir Nota Fiscal
-- [ ] NF-E: Consultar Nota Fiscal
-- [ ] NF-E: Cancelar Nota Fiscal
-- [ ] NF-E: Consultar XML de Cancelamento
-- [ ] NF-E: Emitir Carta de Correção pela Chave da NF-e
-- [ ] NF-E: Consultar Carta de Correção
-- [ ] NF-E: Consultar XML da Carta de Correção
-- [ ] NF-E: Inutilizar Numeração
-- [ ] NF-E: Consultar Inutilização de Número da Nota Fiscal
-- [ ] NF-E: Consultar XML de Inutilização
-- [ ] S@T - SÃO PAULO: Download EXE customizado do S@T
-- [ ] Consulta de nota prestada (emitida): NFS-e - Consulta de Nota Prestada (Emitida)
-- [ ] Consulta de nota tomada (recebida): NF-e - Consulta de Nota Tomada (Recebida)
-- [ ] Consulta de nota tomada (recebida): NF-e - Consulta de Nota Tomada sem manifestação
-- [ ] Consulta de nota tomada (recebida): NFS-e - Consulta de Nota Tomada (Recebida)
-- [ ] Manifestação de destinatário - NF-E: Manifestação de Destinatário (NF-e)
+Atualmente EnotasApi suporta por complexo a API V1 do enotas (NFS-e)
+O suporte as novas APIs (V2) com suporte a NFC-e e NF-e estarão disponíveis em breve.
+
+- [NFS-e (V1)](https://docs.enotasgw.com.br/reference)
+  - Empresa
+    - [x] Consultar Empresa - `EnotasApi::V1::ConsultarEmpresa`
+    - [x] Listar Empresas - `EnotasApi::V1::ListarEmpresas`
+    - [x] Incluir / Atualizar Empresa - `EnotasApi::V1::IncluirAtualizarEmpresa`
+    - [x] Vincular Certificado - `EnotasApi::V1::VincularCertificado`
+    - [x] Vincular Logotipo - `EnotasApi::V1::VincularLogotipo`
+    - [x] Desabilitar Empresa - `EnotasApi::V1::DesabilitarEmpresa`
+    - [x] Habilitar Empresa - `EnotasApi::V1::HabilitarEmpresa`
+  - Nota Fiscal eletrônica de serviço (NFS-e)
+    - [x] Listar Notas Fiscais - `EnotasApi::V1::ListarNotasFiscais`
+    - [x] Consultar pelo ID do Gateway - `EnotasApi::V1::ConsultarNotaFiscal`
+    - [x] Consultar pelo Id Externo - `EnotasApi::V1::ConsultarNotaFiscalIdExterno`
+    - [x] Download XML - `EnotasApi::V1::BaixarXmlNfs`
+    - [x] Download XML (IdExterno) - `EnotasApi::V1::BaixarXmlNfsIdExterno`
+    - [x] Download PDF - `EnotasApi::V1::BaixarPdfNfs`
+    - [x] Download PDF (IdExterno) - `EnotasApi::V1::BaixarPdfNfsIdExterno`
+    - [X] Emissão de Nota Fiscal - `EnotasApi::V1::EmitirNfs`
+    - [X] Cancelar - `EnotasApi::V1::CancelarNfs`
+    - [X] Cancelar (IdExterno) - `EnotasApi::V1::CancelarNfsIdExterno`
+  - API Complementar
+    - [x] Serviços Municipais da Cidade - `EnotasApi::V1::ConsultarServicosMunicipais`
+    - [x] Características da Prefeitura - `EnotasApi::V1::ConsultarCaracteristicasPrefeitura`
+    - [x] Cidades com Serviço Municipal Unificado - `EnotasApi::V1::ConsultarCidadesServicoMunicipalUnificado`
+- [NF-e & NFC-e (v2)](https://docs.enotasgw.com.br/v2/reference)
+  - Empresa
+    - [ ] Incluir/Alterar Empresa
+    - [ ] Vincular Certificado
+    - [ ] Vincular Logotipo
+    - [ ] Consultar Empresa
+    - [ ] Listar Empresas
+  - Nota Fiscal eletrônica de consumidor (NFC-e)
+    - [ ] Emitir Nota Fiscal
+    - [ ] Consultar Nota Fiscal
+    - [ ] Consultar XML
+    - [ ] Cancelar Nota Fiscal
+    - [ ] Consultar XML de Envio do Cancelamento
+    - [ ] Consultar XML de Retorno do Cancelamento
+    - [ ] Inutilizar Numeração
+    - [ ] Consultar Inutilização de Número da Nota Fiscal
+    - [ ] Consultar XML de Inutilização
+  - Nota fiscal eletrônica de produto (NF-e)
+    - [ ] Emitir Nota Fiscal
+    - [ ] Consultar Nota Fiscal
+    - [ ] Cancelar Nota Fiscal
+    - [ ] Consultar XML de Cancelamento
+    - [ ] Emitir Carta de Correção pela Chave da NF-e
+    - [ ] Consultar Carta de Correção
+    - [ ] Consultar XML da Carta de Correção
+    - [ ] Inutilizar Numeração
+    - [ ] Consultar Inutilização de Número da Nota Fiscal
+    - [ ] Consultar XML de Inutilização
+  - S@T - SÃO PAULO
+    - [ ] Download EXE customizado do S@T
+  - Consulta de nota prestada (emitida)
+    - [ ] NFS-e - Consulta de Nota Prestada (Emitida)
+  - Consulta de nota tomada (recebida)
+    - [ ] NF-e - Consulta de Nota Tomada (Recebida)
+    - [ ] NF-e - Consulta de Nota Tomada sem manifestação
+    - [ ] NFS-e - Consulta de Nota Tomada (Recebida)
+  - Manifestação de destinatário NF-e
+    - [ ] Manifestação de Destinatário (NF-e)
+
+# Como liberar uma nova versão
+1. Atualizar o [CHANGELOG](https://github.com/salaozen/enotas_api/blob/main/CHANGELOG.md)
+1. Atualizar a versão em [version.rb](https://github.com/salaozen/enotas_api/blob/main/lib/enotas_api/version.rb)
+1. Realizar o commit
+1. Enviar ao repositório `git push origin main`
+1. Criar uma tag `git tag <VERSAO> && git push origin <VERSAO>`
+1. Gerar uma nova versão da gem `gem build enotas_api`
+1. Publicar a gem `gem push enotas_api-<VERSAO>`
 ## Contributing
-
-Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/enotas_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/[USERNAME]/enotas_api/blob/master/CODE_OF_CONDUCT.md).
-
+Bug reports and pull requests are welcome on GitHub at https://github.com/salaozen/enotas_api. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [code of conduct](https://github.com/salaozen/enotas_api/blob/main/CODE_OF_CONDUCT.md).
 
 ## License
 
@@ -148,4 +157,4 @@ The gem is available as open source under the terms of the [MIT License](https:/
 
 ## Code of Conduct
 
-Everyone interacting in the EnotasApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/[USERNAME]/enotas_api/blob/master/CODE_OF_CONDUCT.md).
+Everyone interacting in the EnotasApi project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/salaozen/enotas_api/blob/main/CODE_OF_CONDUCT.md).

data/Rakefile

@@ -2,17 +2,14 @@
 
 require 'bundler/gem_tasks'
 require 'rspec/core/rake_task'
+require 'rubocop/rake_task'
 
 RSpec::Core::RakeTask.new(:spec)
-
-desc 'Run Rubocop'
-task :rubocop do
-  sh 'rubocop . --auto-correct'
-end
+RuboCop::RakeTask.new
 
 desc 'Run All Resources Check'
 task :check do
-  %w[rubocop spec].each do |task|
+  %w[rubocop:auto_correct spec].each do |task|
     Rake::Task[task].execute
   end
 end

data/lib/enotas_api/common/entity.rb

@@ -1,29 +1,17 @@
 # frozen_string_literal: true
 
 require 'json'
-require_relative '../support/dynamic_attributes'
+require_relative '../support/attributable'
 
 module EnotasApi
   class Entity
-    include EnotasApi::DynamicAttributes
+    include EnotasApi::Attributable
 
-    def apply_json(json)
-      json.each_pair do |field, value|
-        setter = "#{field}="
-        send(setter, value) if respond_to?(setter)
-      end
-      self
-    end
-
-    def as_json(_options = {})
-      self.class.attributes
-          .map { |att| [att, try(att)] }
-          .select { |e| !e[1].nil? || attribute_changed?(e[0]) }
-          .to_h
-    end
-
-    def to_json(*options)
-      as_json.to_json(*options)
+    def to_json(options = nil)
+      self.class.attributes.keys
+          .map { |att| [att, send(att)] }
+          .reject { |e| e[1].nil? && !attribute_changed?(e[0]) }
+          .to_h.to_json(options)
     end
   end
 end

data/lib/enotas_api/common/json_result.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+require 'json'
+require_relative 'raw_result'
+
+module EnotasApi
+  class JsonResult < EnotasApi::RawResult
+    def initialize(status_code, json)
+      @data = JSON.parse(json) unless json.nil? || json.empty?
+      @data = @data.first if @data.is_a?(Array) && @data.any?
+      content = @data.is_a?(String) ? @data : json
+      super(status_code, content, json)
+    end
+
+    def to_json(*_args)
+      @data.to_json
+    end
+
+    def respond_to_missing?(field, _include_private)
+      return true if complex_object? && @data.key?(field.to_s)
+
+      super
+    end
+
+    def method_missing(field, *_args)
+      if complex_object? && @data.key?(field.to_s)
+        value = @data[field.to_s]
+
+        return case value
+               when Array then value.map { |v| EnotasApi::JsonResult.new(@status_code, v.to_json) }
+               when Hash then EnotasApi::JsonResult.new(@status_code, value.to_json)
+               else value
+               end
+      end
+      super
+    end
+
+    def complex_object?
+      !@data.nil? && @data.is_a?(Hash)
+    end
+  end
+end

data/lib/enotas_api/common/raw_result.rb

@@ -0,0 +1,21 @@
+# frozen_string_literal: true
+
+module EnotasApi
+  class RawResult
+    attr_reader :status_code, :content, :raw_content
+
+    def initialize(status_code, content, raw_content = nil)
+      @status_code = status_code
+      @content = content
+      @raw_content = raw_content || content
+    end
+
+    def success?
+      status_code.between?(200, 299)
+    end
+
+    def error?
+      !success?
+    end
+  end
+end

data/lib/enotas_api/common/request.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require_relative 'result'
+require 'json'
+require_relative 'json_result'
 require_relative '../support/encoding_helper'
 require_relative '../support/filterable'
 require_relative '../support/paginable'
@@ -15,20 +16,20 @@ module EnotasApi
     include EnotasApi::Searchable
     include EnotasApi::Sortable
 
-    attr_reader :params
+    attr_reader :params, :uri, :content, :method, :result_object
 
-    def initialize
+    def initialize(uri:, method: :GET, content: nil, result_object: EnotasApi::JsonResult)
+      @method = method
+      @uri = uri
+      @content = content
+      @result_object = result_object
       @params = {}
       page if respond_to?(:page)
-      super
+      super()
     end
 
     def call
-      code, content = case method
-                      when :GET then configuration.request_provider.get(to_url)
-                      # when :POST then configuration.request_provider.post(to_url, to_json)
-                      else raise EnotasApi::Error, "Invalid method #{@method}"
-                      end
+      code, content = make_request
 
       result_object.new(code, content)
     end
@@ -40,29 +41,19 @@ module EnotasApi
       result
     end
 
-    def method
-      :GET
-    end
-
-    def entity; end
-
-    def result_object
-      EnotasApi::Result
-    end
-
-    def uri; end
-
     def to_url
-      url = "#{configuration.base_url}#{uri}"
+      url = "#{base_url}#{uri}"
 
-      query_params = encode_query_params(@params) if @params
+      query_params = encode_query_params(params) if params
       url += "?#{query_params}" unless query_params&.empty?
 
       url
     end
 
-    def to_json(*_args)
-      @entity&.to_json
+    def to_json(options = nil)
+      return nil if content.nil?
+
+      content.is_a?(String) ? content : content.to_json(options)
     end
 
     def param(name, value)
@@ -72,8 +63,22 @@ module EnotasApi
 
     private
 
-    def configuration
-      EnotasApi::Configuration.current
+    def make_request
+      case method
+      when :GET then request_provider.get(to_url)
+      when :POST then request_provider.post(to_url, content)
+      when :POST_FORM then request_provider.post_form(to_url, content)
+      when :DELETE then request_provider.delete(to_url)
+      else raise EnotasApi::Error, "Invalid http method '#{method}'"
+      end
+    end
+
+    def base_url
+      EnotasApi::Configuration.current.base_url
+    end
+
+    def request_provider
+      EnotasApi::Configuration.current.request_provider
     end
   end
 end