enotas_api 0.1.0 → 1.0.0

data/lib/enotas_api/request_provider.rb

@@ -4,27 +4,37 @@ require 'net/http'
 
 module EnotasApi
   class RequestProvider
-    def get(url, headers = {})
-      request(Net::HTTP::Get, url, nil, headers)
+    def get(url)
+      request(obj: Net::HTTP::Get, url: url)
     end
 
-    def post(url, body, headers = {})
-      request(Net::HTTP::Post, url, body, headers)
+    def post(url, body)
+      request(obj: Net::HTTP::Post, url: url, body: body)
+    end
+
+    def post_form(url, form_data)
+      request(obj: Net::HTTP::Post, url: url, form_data: form_data.to_a)
+    end
+
+    def delete(url)
+      request(obj: Net::HTTP::Delete, url: url)
     end
 
     private
 
-    def request(request_obj, url, body, headers)
-      track_request_time(url) do
-        uri = URI(url)
+    def request(obj:, url:, body: nil, form_data: nil, headers: {})
+      uri = URI(url)
+
+      http = Net::HTTP.new(uri.host, uri.port)
+      http.use_ssl = true if url.start_with?('https')
 
-        http = Net::HTTP.new(uri.host, uri.port)
-        http.use_ssl = true if url.start_with?('https')
+      request = obj.new(uri)
+      configure_request_headers(request, headers)
 
-        request = request_obj.new(uri)
-        configure_request_headers(request, headers)
+      request.body = body if body
+      request.set_form(form_data, 'multipart/form-data') if form_data
 
-        request.body = body if body
+      track_request_time(request) do
         response = http.request(request)
 
         [response.code.to_i, response.body]
@@ -34,17 +44,20 @@ module EnotasApi
     def configure_request_headers(request, custom_headers)
       {
         'Authorization' => "Basic #{EnotasApi::Configuration.current.api_key}",
+        "Accept": 'application/json',
         'Content-Type' => 'application/json',
-        'User-Agent' => 'Enotas-Ruby-SDK',
-        "Accept": 'application/json'
+        'User-Agent' => 'Enotas-Ruby-SDK'
       }.merge(custom_headers).each { |key, value| request[key] = value }
     end
 
-    def track_request_time(url)
+    def track_request_time(request)
       start = Process.clock_gettime(Process::CLOCK_MONOTONIC)
       value = yield
       finish = Process.clock_gettime(Process::CLOCK_MONOTONIC)
-      EnotasApi::Configuration.current.logger.info("[RequestProvider] #{url} done in #{(finish - start).round(2)} seconds")
+
+      info = "#{request.method} #{request.path}"
+      time = "#{(finish - start).round(2)} seconds"
+      EnotasApi::Configuration.current.logger.info("[RequestProvider] #{info} done in #{time}")
       value
     end
   end

data/lib/enotas_api/support/{dynamic_attributes.rb → attributable.rb}

@@ -1,9 +1,9 @@
 # frozen_string_literal: true
 
-require_relative 'conversion_helper'
+require_relative 'type_handler'
 
 module EnotasApi
-  module DynamicAttributes
+  module Attributable
     def self.included(base)
       base.extend ClassMethods
     end
@@ -17,7 +17,11 @@ module EnotasApi
     end
 
     def attribute_changed?(attribute)
-      attributes_changed.includes?(attribute)
+      attributes_changed.include?(attribute)
+    end
+
+    def attributes
+      self.class.attributes
     end
 
     def set(attributes)
@@ -34,16 +38,15 @@ module EnotasApi
 
     module ClassMethods
       def attribute(name, type)
-        raise EnotasApi::Error, "Type #{type} not supported" unless EnotasApi::ConversionHelper.support_type?(type)
+        handler = EnotasApi::TypeHandler.new(type)
 
         (@attributes ||= {})[name] = type
-
-        define_method name do
-          instance_variable_get("@#{name}")
-        end
+        attr_reader name
 
         define_method "#{name}=" do |value|
-          instance_variable_set("@#{name}", EnotasApi::ConversionHelper.convert_value(type, value))
+          handler.validate!(value)
+
+          instance_variable_set("@#{name}", handler.entity? && value.is_a?(Hash) ? type.new(value) : value)
           (@attributes_changed ||= []) << name
         end
       end

data/lib/enotas_api/support/encoding_helper.rb

@@ -1,7 +1,6 @@
 # frozen_string_literal: true
 
 require 'erb'
-require 'CGI'
 
 module EnotasApi
   module EncodingHelper
@@ -9,10 +8,6 @@ module EnotasApi
       ERB::Util.url_encode(value)
     end
 
-    def query_encode(value)
-      CGI.escape(value)
-    end
-
     def encode_query_params(params)
       URI.encode_www_form(params.compact { |_k, v| v.nil? })
     end

data/lib/enotas_api/support/type_handler.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module EnotasApi
+  class TypeHandler
+    VALIDATOR = {
+      boolean: ->(value, _type) { value.is_a?(TrueClass) || value.is_a?(FalseClass) },
+      decimal: ->(value, _type) { value.is_a?(Float) || value.is_a?(Integer) },
+      integer: ->(value, _type) { value.is_a?(Integer) },
+      string: ->(value, _type) { value.is_a?(String) },
+      entity: ->(value, type) { value.is_a?(type) || value.is_a?(Hash) }
+    }.freeze
+
+    def initialize(type)
+      @type = type
+      @validator_type = type.is_a?(Class) && type < EnotasApi::Entity ? :entity : type
+      @validator = VALIDATOR[@validator_type]
+      raise EnotasApi::Error, "Type #{type} not supported" unless @validator
+    end
+
+    def entity?
+      @validator_type == :entity
+    end
+
+    def validate!(value)
+      return if value.nil? || @validator.call(value, @type)
+
+      raise EnotasApi::Error, "Invalid value set '#{value}:#{value.class}' for type '#{@type}'"
+    end
+  end
+end

data/lib/enotas_api/v1/baixar_pdf_nfs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+require_relative '../common/raw_result'
+
+module EnotasApi
+  module V1
+    class BaixarPdfNfs < EnotasApi::Request
+      def initialize(empresa_id, nfs_id)
+        uri = "/v1/empresas/#{url_encode(empresa_id)}/nfes/#{url_encode(nfs_id)}/pdf"
+        super(uri: uri, result_object: EnotasApi::RawResult)
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/baixar_pdf_nfs_id_externo.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+require_relative '../common/raw_result'
+
+module EnotasApi
+  module V1
+    class BaixarPdfNfsIdExterno < EnotasApi::Request
+      def initialize(empresa_id, id_externo)
+        uri = "/v1/empresas/#{url_encode(empresa_id)}/nfes/porIdExterno/#{url_encode(id_externo)}/pdf"
+        super(uri: uri, result_object: EnotasApi::RawResult)
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/baixar_xml_nfs.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+require_relative '../common/raw_result'
+
+module EnotasApi
+  module V1
+    class BaixarXmlNfs < EnotasApi::Request
+      def initialize(empresa_id, nfs_id)
+        uri = "/v1/empresas/#{url_encode(empresa_id)}/nfes/#{url_encode(nfs_id)}/xml"
+        super(uri: uri)
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/baixar_xml_nfs_id_externo.rb

@@ -0,0 +1,15 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+require_relative '../common/raw_result'
+
+module EnotasApi
+  module V1
+    class BaixarXmlNfsIdExterno < EnotasApi::Request
+      def initialize(empresa_id, id_externo)
+        uri = "/v1/empresas/#{url_encode(empresa_id)}/nfes/porIdExterno/#{url_encode(id_externo)}/xml"
+        super(uri: uri)
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/cancelar_nfs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+
+module EnotasApi
+  module V1
+    class CancelarNfs < EnotasApi::Request
+      def initialize(empresa_id, nfs_id)
+        super(method: :DELETE, uri: "/v1/empresas/#{url_encode(empresa_id)}/nfes/#{url_encode(nfs_id)}")
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/cancelar_nfs_id_externo.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+
+module EnotasApi
+  module V1
+    class CancelarNfsIdExterno < EnotasApi::Request
+      def initialize(empresa_id, id_externo)
+        super(method: :DELETE, uri: "/v1/empresas/#{url_encode(empresa_id)}/nfes/porIdExterno/#{url_encode(id_externo)}")
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/consultar_caracteristicas_prefeitura.rb

@@ -6,12 +6,7 @@ module EnotasApi
   module V1
     class ConsultarCaracteristicasPrefeitura < EnotasApi::Request
       def initialize(codigo_ibge_cidade)
-        @codigo_ibge_cidade = codigo_ibge_cidade
-        super()
-      end
-
-      def uri
-        "/v1/estados/cidades/#{url_encode(@codigo_ibge_cidade)}/provedor"
+        super(uri: "/v1/estados/cidades/#{url_encode(codigo_ibge_cidade)}/provedor")
       end
     end
   end

data/lib/enotas_api/v1/consultar_cidades_servico_municipal_unificado.rb

@@ -4,11 +4,11 @@ require_relative '../common/request'
 
 module EnotasApi
   module V1
-    class ConsultarCidadesServicioMunicipalUnificado < EnotasApi::Request
+    class ConsultarCidadesServicoMunicipalUnificado < EnotasApi::Request
       paginable
 
-      def uri
-        '/v1/servicos/cidades'
+      def initialize
+        super(uri: '/v1/servicos/cidades')
       end
     end
   end

data/lib/enotas_api/v1/consultar_empresa.rb

@@ -6,12 +6,7 @@ module EnotasApi
   module V1
     class ConsultarEmpresa < EnotasApi::Request
       def initialize(id)
-        @id = id
-        super()
-      end
-
-      def uri
-        "/v1/empresas/#{url_encode(@id)}"
+        super(uri: "/v1/empresas/#{url_encode(id)}")
       end
     end
   end

data/lib/enotas_api/v1/consultar_nfs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+
+module EnotasApi
+  module V1
+    class ConsultarNfs < EnotasApi::Request
+      def initialize(empresa_id, nfe_id)
+        super(uri: "/v1/empresas/#{url_encode(empresa_id)}/nfes/#{url_encode(nfe_id)}")
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/consultar_nfs_id_externo.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+
+module EnotasApi
+  module V1
+    class ConsultarNfsIdExterno < EnotasApi::Request
+      def initialize(empresa_id, id_externo)
+        super(uri: "/v1/empresas/#{url_encode(empresa_id)}/nfes/porIdExterno/#{url_encode(id_externo)}")
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/consultar_servicos_municipais.rb

@@ -9,13 +9,7 @@ module EnotasApi
       filterable :descricao, :contains
 
       def initialize(uf, nome_cidade)
-        @uf = uf
-        @nome_cidade = nome_cidade
-        super()
-      end
-
-      def uri
-        "/v1/estados/#{url_encode(@uf)}/cidades/#{url_encode(@nome_cidade)}/servicos"
+        super(uri: "/v1/estados/#{url_encode(uf)}/cidades/#{url_encode(nome_cidade)}/servicos")
       end
     end
   end

data/lib/enotas_api/v1/desabilitar_empresa.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+
+module EnotasApi
+  module V1
+    class DesabilitarEmpresa < EnotasApi::Request
+      def initialize(empresa_id)
+        super(method: :POST, uri: "/v1/empresas/#{url_encode(empresa_id)}/desabilitar")
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/emitir_nfs.rb

@@ -0,0 +1,13 @@
+# frozen_string_literal: true
+
+require_relative '../common/request'
+
+module EnotasApi
+  module V1
+    class EmitirNfs < EnotasApi::Request
+      def initialize(empresa_id, nfs)
+        super(method: :POST, uri: "/v1/empresas/#{url_encode(empresa_id)}/nfes", content: nfs.to_json)
+      end
+    end
+  end
+end

data/lib/enotas_api/v1/entities/empresa.rb

@@ -1,28 +1,31 @@
 # frozen_string_literal: true
 
 require_relative '../../common/entity'
-require_relative 'endereco'
+require_relative 'empresa_endereco'
 require_relative 'empresa_configuracoes'
 
 module EnotasApi
-  class Empresa < EnotasApi::Entity
-    attribute :id, :string
-    attribute :cnpj, :string
-    attribute :inscricaoMunicipal, :string
-    attribute :inscricaoEstadual, :string
-    attribute :razaoSocial, :string
-    attribute :nomeFantasia, :string
-    attribute :optanteSimplesNacional, :boolean
-    attribute :email, :string
-    attribute :telefoneComercial, :string
-    attribute :incentivadorCultural, :boolean
-    attribute :regimeEspecialTributacao, :string
-    attribute :codigoServicoMunicipal, :string
-    attribute :cnae, :string
-    attribute :aliquotaIss, :decimal
-    attribute :descricaoServico, :string
-    attribute :endereco, EnotasApi::Endereco
-    attribute :configuracoesNFSeHomologacao, EnotasApi::EmpresaConfiguracoes
-    attribute :configuracoesNFSeProducao, EnotasApi::EmpresaConfiguracoes
+  module V1
+    class Empresa < EnotasApi::Entity
+      attribute :id, :string
+      attribute :cnpj, :string
+      attribute :inscricaoMunicipal, :string
+      attribute :inscricaoEstadual, :string
+      attribute :razaoSocial, :string
+      attribute :nomeFantasia, :string
+      attribute :optanteSimplesNacional, :boolean
+      attribute :email, :string
+      attribute :telefoneComercial, :string
+      attribute :incentivadorCultural, :boolean
+      attribute :regimeEspecialTributacao, :string
+      attribute :codigoServicoMunicipal, :string
+      attribute :cnae, :string
+      attribute :aliquotaIss, :decimal
+      attribute :descricaoServico, :string
+      attribute :itemListaServicoLC116, :string
+      attribute :endereco, EnotasApi::V1::EmpresaEndereco
+      attribute :configuracoesNFSeHomologacao, EnotasApi::V1::EmpresaConfiguracoes
+      attribute :configuracoesNFSeProducao, EnotasApi::V1::EmpresaConfiguracoes
+    end
   end
 end

data/lib/enotas_api/v1/entities/empresa_configuracoes.rb

@@ -3,12 +3,14 @@
 require_relative '../../common/entity'
 
 module EnotasApi
-  class EmpresaConfiguracoes < EnotasApi::Entity
-    attribute :sequencialNFe, :integer
-    attribute :serieNFe, :string
-    attribute :sequencialLoteNFe, :integer
-    attribute :usuarioAcessoProvedor, :string
-    attribute :senhaAcessoProvedor, :string
-    attribute :tokenAcessoProvedor, :string
+  module V1
+    class EmpresaConfiguracoes < EnotasApi::Entity
+      attribute :sequencialNFe, :integer
+      attribute :serieNFe, :string
+      attribute :sequencialLoteNFe, :integer
+      attribute :usuarioAcessoProvedor, :string
+      attribute :senhaAcessoProvedor, :string
+      attribute :tokenAcessoProvedor, :string
+    end
   end
 end