enotas_nfe 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6cfe4ea755838189bd877b35fc55c831599b25a3
+  data.tar.gz: 755277cde82c745b9fb708b08c73c30b1f8f3574
+SHA512:
+  metadata.gz: d37764f1e8f6805999a32ee6bc33f9a349f553c9c352cd5f5706a5ebf1f5fd0195e10114366bd0b7670d768dc3d85d6a84382c9ab2448b124389563b17ffbbf3
+  data.tar.gz: 8e486c302174e4061af50dbaa52ed03c6ddadcb66de5d753b337d22f238c754467f07ec2e8cebfddf5c83b296f0ade3858633c5d631c7f9efc8529bf19a347b4

data/MIT-LICENSE

@@ -0,0 +1,20 @@
+Copyright 2017 Luis Fernando Pimenta
+
+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,110 @@
+# eNotas Gateway - Ruby
+
+Wrapper não OFICIAL Ruby da API do eNotas Gateway, plataforma de emissâo automática de nota fiscal eletrônica de serviço (NFS-e), Produto (NF-e) e Consumidor (NFC-e).
+
+A documentação completa dos endpoints pode ser encontrada aqui: [API eNotas Gateway](http://app.enotasgw.com.br/docs).
+
+Mais detalhes: [enotasgw.com.br](http://enotasgw.com.br)
+
+Exemplo em PHP pode ser [encontrado aqui.](https://github.com/eNotasGW) - na biblioteca oficial.
+
+## Instalação
+
+Adicione o código abaixo ao Gemfile da sua aplicação:
+
+```ruby
+gem 'enotas-nfe'
+```
+
+E execute:
+
+    $ bundle
+
+Ou instale manualmente:
+
+    $ gem install enotas-nfe
+
+## Uso básico
+
+* Instancie o cliente passando sua API key:
+
+```ruby
+client = Enotas::Client.new('sua-api-key-do-e-notas')
+```
+
+Agora já podemos emitir uma nota!
+
+* Emitindo uma nova nota de SERVIÇO:
+
+```ruby
+nfe = Enotas::Model::Nfe.new
+nfe.tipo = 'NFS-e' 
+nfe.idExterno = '42'
+nfe.cliente = {
+  name: 'Luis Fernando Pimenta',
+  email: 'email@luispimenta.me',
+  cpfCnpj: '33199707807'
+}
+nfe.enviarPorEmail = true
+nfe.cliente.endereco = {
+  uf: 'PR',
+  cidade: 'Curitiba',
+  logradouro: 'Rua 01',
+  numero: '112',
+  bairro: 'Centro',
+  cep: '80000000'
+}
+
+nfe.servico = {
+  descricao: 'Reparo em computador',
+  aliquotaIss: 0,
+  issRetidoFonte: true,
+  cnae: "4520001",
+  codigoServicoMunicipio: "666133",
+  descricaoServicoMunicipio: "Reparo em computador",
+  itemListaServicoLC116: "1000",
+  ufPrestacaoServico: "PR",
+  municipioPrestacaoServico: "Curitiba",
+  valorCofins: 0,
+  valorCsll: 0,
+  valorInss: 0,
+  valorIr: 0,
+  valorPis: 0
+}
+
+nfe.nfe_create('id-da-empresa-no-enotas', nfe)
+```
+
+* Emitindo uma nova nota NFe:
+
+## Testando a gem localmente
+
+```ruby
+gem build enotas_nfe.gemspec
+gem install enotas-nfe-0.0.1.gem
+irb
+require 'enotas_nfe'
+```
+
+## Contribuindo
+
+Para contruibuir de uma forma adequada, siga os passos abaixo:
+
+* Faça um fork do projeto;
+* Após clonar seu fork, crie um novo branch com a feature que deseja implementar;
+* Envie seu branch para seu repositório remoto;
+* Solicite um PR a partir desse novo branch enviado.
+
+Issues e comentários são sempre bem-vindos no repoistório oficial: https://github.com/enotas/enotas-ruby.
+
+## ROADMAP
+
+Quer contribuir e não sabe por onde começar? Veja nosso ROADMAP:
+
+* Escrever testes;
+* Normalizar campos dos models para o padrão ruby;
+* Cobrir os endpoints referentes ao resource "empresa".
+
+## License
+
+Esta gem está disponível através da [licença MIT](http://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,33 @@
+begin
+  require 'bundler/setup'
+rescue LoadError
+  puts 'You must `gem install bundler` and `bundle install` to run rake tasks'
+end
+
+require 'rdoc/task'
+
+RDoc::Task.new(:rdoc) do |rdoc|
+  rdoc.rdoc_dir = 'rdoc'
+  rdoc.title    = 'EnotasNfe'
+  rdoc.options << '--line-numbers'
+  rdoc.rdoc_files.include('README.md')
+  rdoc.rdoc_files.include('lib/**/*.rb')
+end
+
+
+
+
+
+
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << 'test'
+  t.pattern = 'test/**/*_test.rb'
+  t.verbose = false
+end
+
+
+task default: :test

data/lib/enotas_nfe/client.rb

@@ -0,0 +1,23 @@
+module EnotasNfe
+  class Client
+    include Connection
+    include Request
+    include Facades
+    include Endpoints
+
+    NFSE_ENDPOINT = "https://api.enotasgw.com.br/v1"
+    NFE_ENDPOINT = "https://api.enotasgw.com.br/v2"
+
+    attr_accessor :auth_token, :endpoint
+
+    def initialize(auth_token, endpoint)
+      @auth_token = auth_token
+      if endpoint == 'nfe'
+        @endpoint = NFE_ENDPOINT
+      else
+        @endpoint = NFSE_ENDPOINT      
+      end
+    end
+
+  end
+end

data/lib/enotas_nfe/connection.rb

@@ -0,0 +1,26 @@
+require 'faraday_middleware'
+
+module EnotasNfe
+  module Connection    
+    private
+
+    def connection
+      options = {
+        headers: {
+          "Content-Type": "application/json",
+          "Accept": "application/json",
+          "User-Agent": "Enotas ruby client"
+        },
+        url: endpoint
+      }
+
+      Faraday.new(options) do |connection|
+        connection.use Middleware, auth_token
+        connection.use Faraday::Response::ParseJson
+
+        connection.adapter :net_http
+      end
+    end
+
+  end
+end

data/lib/enotas_nfe/endpoints.rb

@@ -0,0 +1,58 @@
+module EnotasNfe
+  module Endpoints
+    include Request
+
+    def nfe_create(firm_id, body)
+      post("empresas/#{firm_id}/nf-e", body)
+    end
+
+    def nfe_delete(firm_id, nfe_id)
+      delete("empresas/#{firm_id}/nf-e/#{nfe_id}")
+    end
+
+    def nfe_get(firm_id, id)
+      get("empresas/#{firm_id}/nf-e/#{id}")
+    end
+
+    def nfse_list(firm_id, body = {})
+      get("empresas/#{firm_id}/nfes", body)
+    end
+
+    def nfse_create(firm_id, body)
+      post("empresas/#{firm_id}/nfes", body)
+    end
+
+    def nfse_delete(firm_id, nfe_id)
+      delete("empresas/#{firm_id}/nfes/#{nfe_id}")
+    end
+
+    def nfse_get(firm_id, id)
+      get("empresas/#{firm_id}/nfes/#{id}")
+    end
+
+    def nfse_get_by_external_id(firm_id, external_id)
+      get("empresas/#{firm_id}/nfes/porIdExterno/#{external_id}")
+    end
+
+    def nfse_delete_by_external_id(firm_id, external_id)
+      delete("empresas/#{firm_id}/nfes/porIdExterno/#{external_id}")
+    end
+
+    def nfse_get_pdf(firm_id, id)
+      get("empresas/#{firm_id}/nfes/#{id}")
+    end
+
+    def nfse_get_pdf_by_external_id(firm_id, external_id)
+      get("empresas/#{firm_id}/nfes/porIdExterno/#{external_id}/pdf")
+    end
+
+    def nfse_get_xml(firm_id, id)
+      get("empresas/#{firm_id}/nfes/#{id}/xml")
+    end
+
+    def nfse_get_xml_by_external_id(firm_id, external_id)
+      get("empresas/#{firm_id}/nfes/porIdExterno/#{external_id}/xml")
+    end
+
+  end
+end

data/lib/enotas_nfe/facades.rb

@@ -0,0 +1,9 @@
+module EnotasNfe
+  module Facades
+
+    def build_nfe(attributes = {})
+      Model::Nfe.new(attributes)
+    end
+
+  end
+end

data/lib/enotas_nfe/middleware.rb

@@ -0,0 +1,17 @@
+module EnotasNfe
+  class Middleware < Faraday::Middleware
+
+    def call(env)      
+      if @auth_token
+        env[:request_headers] = env[:request_headers].merge("Authorization": "Basic #{@auth_token}")
+      end
+      @app.call env
+    end
+
+    def initialize(app, auth_token = nil)
+      @app = app
+      @auth_token = auth_token
+    end
+
+  end
+end

data/lib/enotas_nfe/model/cliente.rb

@@ -0,0 +1,20 @@
+module EnotasNfe
+  module Model
+    class Cliente
+
+      include Virtus.model
+
+      attribute :tipoPessoa, String
+      attribute :nome, String
+      attribute :email, String
+      attribute :cpfCnpj, String
+      attribute :inscricaoMunicipal, String
+      attribute :inscricaoEstadual, String
+      attribute :indicadorContribuinteICMS, String
+      attribute :telefone, String
+
+      attribute :endereco, Endereco
+
+    end
+  end
+end

data/lib/enotas_nfe/model/cofins.rb

@@ -0,0 +1,11 @@
+module EnotasNfe
+  module Model
+    class Cofins
+
+      include Virtus.model
+
+      attribute :situacaoTributaria, String
+
+    end
+  end
+end

data/lib/enotas_nfe/model/endereco.rb

@@ -0,0 +1,18 @@
+module EnotasNfe
+  module Model
+    class Endereco
+
+      include Virtus.model
+
+      attribute :pais, String
+      attribute :uf, String
+      attribute :cidade, String
+      attribute :logradouro, String
+      attribute :numero, String
+      attribute :complemento, String
+      attribute :bairro, String
+      attribute :cep, String
+
+    end
+  end
+end

data/lib/enotas_nfe/model/icms.rb

@@ -0,0 +1,12 @@
+module EnotasNfe
+  module Model
+    class Icms
+
+      include Virtus.model
+
+      attribute :situacaoTributaria, String
+      attribute :origem, String
+
+    end
+  end
+end

data/lib/enotas_nfe/model/impostos.rb

@@ -0,0 +1,16 @@
+module EnotasNfe
+  module Model
+    class Impostos
+
+      include Virtus.model
+      require "enotas_nfe/model/cofins"
+      require "enotas_nfe/model/icms"
+      require "enotas_nfe/model/pis"
+
+      attribute :icms, Icms
+      attribute :pis, Pis
+      attribute :cofins, Cofins
+
+    end
+  end
+end

data/lib/enotas_nfe/model/issqn.rb

@@ -0,0 +1,12 @@
+module EnotasNfe
+  module Model
+    class Issqn
+
+      include Virtus.model
+
+      attribute :itemListaServicoLC116, String
+      attribute :aliquotaIss, Decimal
+
+    end
+  end
+end

data/lib/enotas_nfe/model/nfe.rb

@@ -0,0 +1,26 @@
+module EnotasNfe
+  module Model
+    class Nfe
+
+      include Virtus.model
+
+      attribute :id, String
+      attribute :enviarPorEmail, Boolean
+      attribute :ambienteEmissao, String
+      attribute :naturezaOperacao, String
+      attribute :consumidorFinal, Boolean
+      attribute :finalidade, String
+      attribute :tipo, String
+      attribute :idExterno, String
+      attribute :indicadorPresencaConsumidor, String
+      attribute :valorTotal, Float
+      attribute :idExternoSubstituir, String
+      attribute :nfeIdSubstitituir, String
+      attribute :informacoesAdicionais, String
+      attribute :itens, Array
+      attribute :servico, Servico
+      attribute :cliente, Cliente
+
+    end
+  end
+end

data/lib/enotas_nfe/model/pis.rb

@@ -0,0 +1,11 @@
+module EnotasNfe
+  module Model
+    class Pis
+
+      include Virtus.model
+
+      attribute :situacaoTributaria, String
+
+    end
+  end
+end

data/lib/enotas_nfe/model/produto.rb

@@ -0,0 +1,20 @@
+module EnotasNfe
+  module Model
+    class Produto
+
+      include Virtus.model
+      require "enotas_nfe/model/impostos"
+
+      attribute :descricao, String
+      attribute :cfop, String
+      attribute :codigo, String
+      attribute :descricao, String
+      attribute :ncm, String
+      attribute :quantidade, Integer
+      attribute :unidadeMedida, String
+      attribute :valorUnitario, Float
+      attribute :impostos, Impostos
+
+    end
+  end
+end

data/lib/enotas_nfe/model/servico.rb

@@ -0,0 +1,23 @@
+module EnotasNfe
+  module Model
+    class Servico
+
+      include Virtus.model
+
+      attribute :descricao, String
+      attribute :aliquotaIss, Float
+      attribute :issRetidoFonte, Boolean
+      attribute :cnae, String
+      attribute :codigoServicoMunicipio, String
+      attribute :descricaoServicoMunicipio, String
+      attribute :itemListaServicoLC116, String
+      attribute :ufPrestacaoServico, String
+      attribute :municipioPrestacaoServico, String
+      attribute :valorCofins, Decimal
+      attribute :valorInss, Decimal
+      attribute :valorIr, Decimal
+      attribute :valorPis, Decimal
+
+    end
+  end
+end

data/lib/enotas_nfe/request.rb

@@ -0,0 +1,43 @@
+module EnotasNfe
+  module Request
+    include Connection
+  
+    def get(path, body = {})
+      request(:get, path, body)
+    end
+
+    def post(path, body = {})
+      request(:post, path, body)
+    end
+
+    def delete(path, body = {})
+      request(:delete, path, body)
+    end
+
+    private
+
+    def request(method, path, body)
+      body_serialized = serialize_body(body)
+
+      response = connection.send(method) do |request|
+        path = URI.encode(path)
+
+        case method
+        when :get, :delete
+          request.url(path, body_serialized)
+        when :post
+          request.path = path
+          puts request.body = body_serialized.to_json
+          request.headers
+        end
+      end
+
+      response.body
+    end
+
+    def serialize_body(body)
+      VirtusConvert.new(body, reject_nils: true).to_hash
+    end
+
+  end
+end

data/lib/enotas_nfe/version.rb

@@ -0,0 +1,3 @@
+module EnotasNfe
+  VERSION = "0.0.1"
+end

data/lib/enotas_nfe.rb

@@ -0,0 +1,25 @@
+require "virtus"
+require "virtus_convert"
+require "faraday"
+require "faraday_middleware"
+
+require "enotas_nfe/version"
+require "enotas_nfe/middleware"
+require "enotas_nfe/connection"
+require "enotas_nfe/request"
+require "enotas_nfe/endpoints"
+require "enotas_nfe/model/endereco"
+require "enotas_nfe/model/servico"
+require "enotas_nfe/model/produto"
+require "enotas_nfe/model/cliente"
+require "enotas_nfe/model/nfe"
+require "enotas_nfe/model/cofins"
+require "enotas_nfe/model/icms"
+require "enotas_nfe/model/impostos"
+require "enotas_nfe/model/issqn"
+require "enotas_nfe/model/pis"
+require "enotas_nfe/facades"
+require "enotas_nfe/client"
+
+module EnotasNfe
+end

data/lib/tasks/enotas_nfe_tasks.rake

@@ -0,0 +1,4 @@
+# desc "Explaining what the task does"
+# task :enotas_nfe do
+#   # Task goes here
+# end

metadata

@@ -0,0 +1,170 @@
+--- !ruby/object:Gem::Specification
+name: enotas_nfe
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Luis Fernando Pimenta
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2017-11-21 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.13'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: virtus
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 1.0.5
+- !ruby/object:Gem::Dependency
+  name: virtus_convert
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.1.0
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.9'
+- !ruby/object:Gem::Dependency
+  name: faraday_middleware
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.12.0
+description: E-Notas nfe gateway wrapper
+email:
+- email@luispimenta.me
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- MIT-LICENSE
+- README.md
+- Rakefile
+- lib/enotas_nfe.rb
+- lib/enotas_nfe/client.rb
+- lib/enotas_nfe/connection.rb
+- lib/enotas_nfe/endpoints.rb
+- lib/enotas_nfe/facades.rb
+- lib/enotas_nfe/middleware.rb
+- lib/enotas_nfe/model/cliente.rb
+- lib/enotas_nfe/model/cofins.rb
+- lib/enotas_nfe/model/endereco.rb
+- lib/enotas_nfe/model/icms.rb
+- lib/enotas_nfe/model/impostos.rb
+- lib/enotas_nfe/model/issqn.rb
+- lib/enotas_nfe/model/nfe.rb
+- lib/enotas_nfe/model/pis.rb
+- lib/enotas_nfe/model/produto.rb
+- lib/enotas_nfe/model/servico.rb
+- lib/enotas_nfe/request.rb
+- lib/enotas_nfe/version.rb
+- lib/tasks/enotas_nfe_tasks.rake
+homepage: https://github.com/luispimenta/enotas-client
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.14
+signing_key: 
+specification_version: 4
+summary: E-Notas nfe
+test_files: []