receitaws 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 3143d2561d56b51e76ba04d9fb3416ea24a353f0
+  data.tar.gz: 3089c4e95d211771e00247eb7040d54fe091ca15
+SHA512:
+  metadata.gz: 12b6a6bc7d1e88abef60b9ef94e653b5a26c38879a332cb26b7d42b9378baeb10fc0f5100971adf5618e50435edf0f4fc3a026a26bfb911195625d220a5b272a
+  data.tar.gz: 9eef68b1abeb7ccfb8dbd4aff086d6e326a30fbd6e7c1d20872b1e10eb63d296cbd7b5549c20cd67f0a598c725ecaab11255c8a957e212a93a4375bd14940f7c

data/.gitignore

@@ -0,0 +1,52 @@
+*.gem
+*.rbc
+/.config
+/coverage/
+/InstalledFiles
+/pkg/
+/spec/reports/
+/spec/examples.txt
+/test/tmp/
+/test/version_tmp/
+/tmp/
+
+# Used by dotenv library to load environment variables.
+# .env
+
+## Specific to RubyMotion:
+.dat*
+.repl_history
+build/
+*.bridgesupport
+build-iPhoneOS/
+build-iPhoneSimulator/
+
+## Specific to RubyMotion (use of CocoaPods):
+#
+# We recommend against adding the Pods directory to your .gitignore. However
+# you should judge for yourself, the pros and cons are mentioned at:
+# https://guides.cocoapods.org/using/using-cocoapods.html#should-i-check-the-pods-directory-into-source-control
+#
+# vendor/Pods/
+
+## Documentation cache and generated files:
+/.yardoc/
+/_yardoc/
+/doc/
+/rdoc/
+
+## Environment normalization:
+/.bundle/
+/vendor/bundle
+/lib/bundler/man/
+
+# for a library or gem, you might want to ignore these files since the code is
+# intended to run in multiple environments; otherwise, check them in:
+# Gemfile.lock
+# .ruby-version
+# .ruby-gemset
+
+# unless supporting rvm < 1.11.0 or doing something fancy, ignore this:
+.rvmrc
+
+.to_do

data/Gemfile

@@ -0,0 +1,2 @@
+source "https://rubygems.org"
+gemspec

data/Gemfile.lock

@@ -0,0 +1,17 @@
+PATH
+  remote: .
+  specs:
+    receitaws (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  receitaws!
+
+BUNDLED WITH
+   1.16.4

data/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2018 QW3 - Software, Marketing e Consultoria
+
+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,179 @@
+# Gem ReceitaWS API - Consulta de Dados de CNPJ
+
+Mantenha seu sistema sempre atualizado com dados fiéis das empresas que se relacionam com você.
+
+## Versão Beta
+
+Uma Gem simples para recuperação de informações de empresas através de seu CNPJ utilizando Webservice da [ReceitaWS](https://receitaws.com.br/) versão **Comercial**. Acreditamos que estas informações devem estar acessíveis a qualquer indivíduo ou empresa, e sem nenhum custo.
+
+Acesso a documentação de desenvolvimento da [https://receitaws.com.br/](https://receitaws.com.br/api)
+
+## Instalando
+
+### Gemfile
+
+Adicione esta linha ao Gemfile do seu aplicativo:
+
+```ruby
+  gem 'receitaws'
+```
+
+ - Execute o comando `bundle install`.
+
+### Instalação direta
+
+```ruby
+  gem install receitaws
+```
+
+## Configuração
+
+Para fazer a autenticação, você precisará configurar as credenciais da ReceitaWS. Crie o arquivo `config/initializers/receitaws.rb` com o conteúdo abaixo.
+
+```ruby
+Receitaws.configure do |config|
+
+  #
+  # Cadastrar token fornecido no cadastro na ReceitaWS
+  config.token = 'cPHqyaLe6X2mVsFp1dBogWh92x7HLizeKu4AbsZo3t1qg5HIzh8ns6fwjFcBkc2b'
+
+  #
+  # Opções de ambiente
+  # Quantidade máxima de dias com relação à última consulta na Receita Federal deste CNPJ
+  config.days = 365
+
+  #
+  # Tempo de espera pela resposta do WeService em segundos
+  config.timeout = 10
+
+end
+```
+
+## Consultar CNPJ
+
+Nesse endpoint é realizado a consulta de um CNPJ.
+
+> Enviar somente os números do CNPJ, sem pontos e traços.
+
+Será retornado um objeto do tipo **Receitaws::Cnpj** descrito abaixo.
+
+
+```ruby
+cnpj =  = Receitaws::ConsultarCnpj.executar 27865757000102
+```
+
+Verificar se se a consulta foi realizada com sucesso.
+
+```ruby
+#
+# Caso tenha ocorrido algum erro na consulta
+cnpj.status == :error
+
+#
+# Mensagem explicativa indicando erro.
+cnpj.message
+
+#
+# Consulta realizada com sucesso
+cnpj.status == :ok
+
+
+#
+# LIsta de atributos disponíveis
+
+# CNPJ no formato 00.000.000/0000-00.
+cnpj.cnpj
+
+# Data de abertura no formato dd/mm/aaaa.
+cnpj.abertura
+
+# Razão social.
+cnpj.nome
+
+# Nome fantasia.
+cnpj.fantasia
+
+# Logradouro.
+cnpj.logradouro
+
+# Número.
+cnpj.numero
+
+# Complemento.
+cnpj.complemento
+
+# CEP no formato 00.000-000.
+cnpj.cep
+
+# Bairro.
+cnpj.bairro
+
+# Município.
+cnpj.municipio
+
+# Sigla da Unidade da Federação.
+cnpj.uf
+
+# Email.
+cnpj.email
+
+  # Telefone.
+cnpj.telefone
+
+# Situação.
+cnpj.situacao
+
+# Data da situação no formato dd/mm/aaaa.
+cnpj.data_situacao
+
+# Lista (Array de Hash) completa de todos os CNAE do CNPJ
+# O primeiro da lista será sempre o CNAE Principal
+cnpj.atividades
+
+# Descrição da atividade.
+cnpj.atividades[0][:text]
+
+# Código CNAE da atividade no formato 00.00-0-00.
+cnpj.atividades[0][:code]
+
+# Lista (Array) completa de todos os CNAE do CNPJ
+# Somente os números dos CNAES sem pontos e traços
+cnpj.cnaes
+
+```
+
+---
+
+
+## Autor
+
+- [QW3 Software & Marketing](http://qw3.com.br)
+- [Leandro dos Santos Falcão](https://www.linkedin.com/in/lsfalcao)
+
+## Copyright
+
+[QW3 Software & Marketing](http://qw3.com.br)
+
+![QW3 Logo](http://qw3.com.br/qw3_logo.png)
+
+MIT License
+
+Copyright (c) 2018 QW3 - Software, Marketing e Consultoria
+
+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/Rakefile

@@ -0,0 +1,2 @@
+require "bundler/gem_tasks"
+task :default => :spec

data/lib/receitaws/base.rb

@@ -0,0 +1,46 @@
+# -*- encoding : utf-8 -*-
+module Receitaws
+  class Base
+    require 'uri'
+    require 'net/http'
+    require 'timeout'
+
+    def self.build_request endpoint, metodo, body=nil
+
+      url = URI("#{Receitaws.base_uri}/#{endpoint}")
+
+      http = Net::HTTP.new(url.host, url.port)
+      http.use_ssl = true
+
+      case metodo
+      when "delete"
+        request = Net::HTTP::Delete.new(url)
+      when "get"
+        request = Net::HTTP::Get.new(url)
+      when "put"
+        request = Net::HTTP::Put.new(url)
+      when "post"
+        request = Net::HTTP::Post.new(url)
+      end
+      request = Receitaws::Base.default_headers request
+
+      request.body = body.to_json unless body.nil?
+
+      begin
+        status = Timeout::timeout(Receitaws.timeout.to_i) {
+          return http.request(request)
+        }
+      rescue Timeout::Error
+        puts 'That took too long, exiting...'
+        return nil
+      end
+    end
+
+    def self.default_headers request
+      request["authorization"] = "Bearer #{Receitaws.token}"
+      request["Content-Type"] = "application/json"
+      return request
+    end
+
+  end
+end

data/lib/receitaws/cnpj.rb

@@ -0,0 +1,48 @@
+# -*- encoding : utf-8 -*-
+module Receitaws
+  class Cnpj
+
+    attr_reader :status, :message, :nome, :uf, :telefone, :email, :fantasia, :cnpj, :bairro, :logradouro, :numero, :cep, :municipio, :abertura, :data_situacao, :complemento, :atividades, :cnaes
+
+    def initialize(result=nil)
+
+      if result.nil?
+        @status = :error
+        @message = "Timeout"
+      end
+
+      if result["status"] == "ERROR"
+        @status = :error
+        @message = result["message"]
+        return self
+      end
+
+      @status = :ok
+      @nome = result["nome"]
+      @uf = result["uf"]
+      @telefone = result["telefone"]
+      @email = result["email"]
+      @fantasia = result["fantasia"]
+      @cnpj = result["cnpj"]
+      @bairro = result["bairro"]
+      @logradouro = result["logradouro"]
+      @numero = result["numero"]
+      @cep = result["cep"]
+      @municipio = result["municipio"]
+      @abertura = result["abertura"]
+      @data_situacao = result["data_situacao"]
+      @situacao = result["situacao"]
+      @complemento = result["complemento"]
+      @atividades = []
+      result["atividade_principal"].each do |atividade|
+        @atividades << {code: atividade["code"], text: atividade["text"]}
+      end
+      result["atividades_secundarias"].each do |atividade|
+        @atividades << {code: atividade["code"], text: atividade["text"]}
+      end
+      @cnaes = @atividades.collect{|a| a[:code].to_s.gsub(/[^0-9A-Za-z]/, '')}
+
+    end
+
+  end
+end

data/lib/receitaws/configure.rb

@@ -0,0 +1,73 @@
+# -*- encoding : utf-8 -*-
+module Receitaws
+  module Configure
+
+    # Endereço do WeService
+    URL_RECEITAWS   = "https://www.receitaws.com.br"
+
+    # Parâmetros iniciais
+    API_VERSION     = 'v1'
+
+    # Parâmetros iniciais
+    TOKEN           = 'cPHqyaLe6X2mVsFp1dBogWh92x7HLizeKu4AbsZo3t1qg5HIzh8ns6fwjFcBkc2b'
+
+    # Parâmetros iniciais
+    DAYS            = 365
+
+    # Parâmetros iniciais
+    TIMEOUT         = 10
+
+    # Endereço do WeService
+    attr_writer :url
+
+    # Enviado pela ReceitaWS
+    attr_writer :api_version
+
+    # Enviado pela ReceitaWS
+    attr_writer :token
+
+    # Obrigatório, numérico, quantidade máxima de dias com relação à última consulta na Receita Federal deste CNPJ
+    attr_writer :days
+
+    # Obrigatório, numérico, Tempo de espera pela resposta do WeService em segundos
+    attr_writer :timeout
+
+    # Comando que recebe as configurações
+    def configure
+      yield self if block_given?
+    end
+
+    # Definir url_receitaws
+    def url_receitaws
+      @url_receitaws ||= URL_RECEITAWS
+    end
+
+    # Definir api_version
+    def api_version
+      @api_version ||= API_VERSION
+    end
+
+    # Definir token
+    def token
+      @token ||= TOKEN
+    end
+
+    # Definir days
+    # Obrigatório, numérico, quantidade máxima de dias com relação à última consulta na Receita Federal deste CNPJ
+    def days
+      @days ||= DAYS
+    end
+
+    # Definir timeout em segundos
+    # Tempo de espera pela resposta do WeService em segundos
+    def timeout
+      @timeout ||= TIMEOUT
+    end
+
+    # Definir url que será utilizado
+    def base_uri
+      return "#{self.url_receitaws}/#{self.api_version}"
+    end
+
+  end
+end

data/lib/receitaws/consultar_cnpj.rb

@@ -0,0 +1,29 @@
+# -*- encoding : utf-8 -*-
+module Receitaws
+  class ConsultarCnpj < Base
+
+    # Metodo para consultar um CNPJ
+    # cnpj: obrigatório, numérico, o CNPJ a ser pesquisado
+    # Retonar um obejto do tipo Receitaws::Cnpj
+    def self.executar cnpj
+
+      response = self.build_request self.endpoint(cnpj), "get"
+
+      begin
+        result = JSON.parse(response.read_body) unless response.nil?
+      rescue
+        result = nil
+      end
+
+      return Receitaws::Cnpj.new(result)
+
+    end
+
+    private
+
+    def self.endpoint cnpj
+      return "cnpj/#{cnpj}/days/#{Receitaws.days}"
+    end
+
+  end
+end

data/lib/receitaws/version.rb

@@ -0,0 +1,9 @@
+# -*- encoding : utf-8 -*-
+module Receitaws
+  module Version
+    MAJOR = 0
+    MINOR = 1
+    PATCH = 0
+    STRING = "#{MAJOR}.#{MINOR}.#{PATCH}"
+  end
+end

data/lib/receitaws.rb

@@ -0,0 +1,13 @@
+# -*- encoding : utf-8 -*-
+require 'rubygems'
+require 'active_model'
+
+require "receitaws/version"
+require "receitaws/configure"
+require "receitaws/base"
+require "receitaws/consultar_cnpj"
+require "receitaws/cnpj"
+
+module Receitaws
+  extend Receitaws::Configure
+end

data/receitaws.gemspec

@@ -0,0 +1,25 @@
+# -*- encoding: utf-8 -*-
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'receitaws/version'
+
+Gem::Specification.new do |spec|
+  spec.name                   = "receitaws"
+  spec.version                = Receitaws::Version::STRING
+  spec.platform               = Gem::Platform::RUBY
+  spec.authors                = ["QW3 Software & Marketing"]
+  spec.email                  = ["contato@qw3.com.br"]
+  spec.summary                = "Gem ReceitaWS API - Consulta de Dados de CNPJ"
+  spec.description            = "Uma Gem simples para recuperação de informações de empresas através de seu CNPJ utilizando Webservice da ReceitaWS - https://receitaws.com.br/ versão Comercial. Acreditamos que estas informações devem estar acessíveis a qualquer indivíduo ou empresa, e sem nenhum custo."
+  spec.homepage               = "https://github.com/qw3/receitaws"
+  spec.license                = "MIT"
+
+  spec.files                  = `git ls-files`.split($/)
+  spec.executables            = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files             = spec.files.grep(%r{^(test|spec|features)/})
+
+  spec.require_paths          = ["lib"]
+
+  spec.required_ruby_version  = Gem::Requirement.new(">= 1.9")
+
+end

metadata

@@ -0,0 +1,60 @@
+--- !ruby/object:Gem::Specification
+name: receitaws
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- QW3 Software & Marketing
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2018-12-15 00:00:00.000000000 Z
+dependencies: []
+description: Uma Gem simples para recuperação de informações de empresas através de
+  seu CNPJ utilizando Webservice da ReceitaWS - https://receitaws.com.br/ versão Comercial.
+  Acreditamos que estas informações devem estar acessíveis a qualquer indivíduo ou
+  empresa, e sem nenhum custo.
+email:
+- contato@qw3.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- Gemfile.lock
+- LICENSE
+- README.md
+- Rakefile
+- lib/receitaws.rb
+- lib/receitaws/base.rb
+- lib/receitaws/cnpj.rb
+- lib/receitaws/configure.rb
+- lib/receitaws/consultar_cnpj.rb
+- lib/receitaws/version.rb
+- receitaws.gemspec
+homepage: https://github.com/qw3/receitaws
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '1.9'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: Gem ReceitaWS API - Consulta de Dados de CNPJ
+test_files: []