brazilian_documents 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: ce861f68d1133840aa6d946360599d544ef049df
+  data.tar.gz: a1d8b2c6ff7a9a201bc8f0102cae450b3c295bb7
+SHA512:
+  metadata.gz: d957127f476c56923c209f4d2068c2552b8b1192aba19ca9ddfb556e3dcd68d93256c6e5756ac8fcc96d08d7044d87338f4622eb733f80b632e7ef38e82e9fa2
+  data.tar.gz: ac4d6be54ce6100896ec60bab4ca0ba2833d7e681fd65cebc1aac396d560e6bc4f5dab035d06fbe111763acb90dd88a2320a58e913fe8c37624dc96f29542942

data/.gitignore

@@ -0,0 +1,9 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,5 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.3.0
+before_install: gem install bundler -v 1.12.5

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,49 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, and in the interest of
+fostering an open and welcoming community, we pledge to respect all people who
+contribute through reporting issues, posting feature requests, updating
+documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free
+experience for everyone, regardless of level of experience, gender, gender
+identity and expression, sexual orientation, disability, personal appearance,
+body size, race, ethnicity, age, religion, or nationality.
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery
+* Personal attacks
+* Trolling or insulting/derogatory comments
+* Public or private harassment
+* Publishing other's private information, such as physical or electronic
+  addresses, without explicit permission
+* Other unethical or unprofessional conduct
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+By adopting this Code of Conduct, project maintainers commit themselves to
+fairly and consistently applying these principles to every aspect of managing
+this project. Project maintainers who do not follow or enforce the Code of
+Conduct may be permanently removed from the project team.
+
+This code of conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting a project maintainer at rafa_fidelis@yahoo.com.br. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. Maintainers are
+obligated to maintain confidentiality with regard to the reporter of an
+incident.
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 1.3.0, available at
+[http://contributor-covenant.org/version/1/3/0/][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/3/0/

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in br_documents.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2016 Rafael Fidelis
+
+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,132 @@
+# BRDocuments
+
+Esta gem tem como proposta ser um repositório com os principais validadores de documentos **oficiais do Brasil**.
+Atualmente existem **validadores**(e não geradores) para:
+
+* CPF
+* CNPJ
+* RG (Carteira de Identidade) [TODO]
+* Título de Eleitor [TODO]
+
+Essa gem é construída em cima da gem [**digit_checksum**](https://github.com/fidelisrafael/digit_checksum), que torna todo o processo muito mais simples e padronizado!
+
+---
+
+## Instalação
+
+Adicione no seu Gemfile:
+
+```ruby
+gem 'brazilian_documents'
+```
+
+E execute:
+
+    $ bundle
+
+Ou então instale separadamente (e globalmente) com:
+
+    $ gem install brazilian_documents
+
+---
+
+## Como usar 
+
+Entenda que a proposta dessa gem não é gerar número de documentos, somente validar! A ideia é ser pequena e portátil.
+
+### API
+
+#### Observação:
+
+ **TODOS** os documentos tem a mesma **assinatura e interface** de API, sendo assim para manusear tipos diferentes de documento, somente altere o nome da classe para o tipo de documento desejado, que podem ser:
+
+##### `BRDocuments::CPF`
+##### `BRDocuments::CNPJ`
+
+Nos exemplos abaixo, a classe `BRDocuments::CPF` será utilizada para detalhar a **API comum a todos os documentos**, porém lembre-se que você pode usar **qualquer uma** das classes acima listada.
+
+---
+
+Você pode usar essa biblioteca para:
+
+
+#### Validar documento
+
+```ruby
+require 'br_documents'
+
+BRDocuments::CPF.valid?(number) # verifica se um CPF é valido
+BRDocuments::CPF.invalid?(number) # verifica se um CPF é inválido
+
+# Ex: 
+
+BRDocuments::CPF.valid?("481.455.512-18") # true
+BRDocuments::CPF.valid?("481.455.512-20") # false
+BRDocuments::CPF.invalid?(48145551220) # true
+
+```
+
+#### Calcular dígitos verificadores (DV)
+
+```ruby
+require 'br_documents'
+
+# Calcula os dígitos verificadores de um CPF(number deve ser composto de 9 dígitos
+BRDocuments::CPF.calculate_verify_digits(number)
+
+# Ex:
+
+# Número válido
+BRDocuments::CPF.calculate_verify_digits("481.455.512") # [1, 8]
+
+# Número inválido
+BRDocuments::CPF.calculate_verify_digits("481.455.51") # []
+```
+
+#### Normalizar e formatar documento
+
+```ruby
+require 'br_documents'
+
+BRDocuments::CPF.pretty_formatted(number) # (XXX.XXX.XXX-XX)
+
+# Retorna CPF normalizado como Array ([X,X,X,X,X,X,X,X,X,X,X,X])
+BRDocuments::CPF.normalize_document_number(number)
+
+# Retorna CPF normalizado como String (XXXXXXXXXXXX)
+BRDocuments::CPF.normalize_document_number_to_s(number)
+
+# Ex:
+
+BRDocuments::CPF.pretty_formatted("48145551218") # 481.455.512-18
+
+# Normaliza número e retorna como Array: [4, 8, 1, 4, 5, 5, 5, 1, 2, 1, 8]
+BRDocuments::CPF.normalize_document_number("481.455.512-18")
+
+BRDocuments::CPF.normalize_document_number_to_s("481.455.512-18") # "48145551218"
+
+```
+---
+
+## Desenvolvimento
+
+Execute  `bin/setup` para instalar as dependências to install dependencies. Em seguida execute `rake spec` para executar todos os testes. Você pode também executar `bin/console` para iniciar um shell interativo para seus experimentos
+
+Para instalar essa gem localmente em sua máquina, execute `bundle exec rake install`. 
+
+---
+
+## Contribua!
+
+Você pode enviar bugs reports, pull requests e abrir issues no GitHub: https://github.com/fidelisrafael/br_documents. 
+Para entender a arquitetura e padrão de cada arquivo, veja a pasta `lib/br_documents/documents` e leia a documentação da gem [**digit_checksum**](https://github.com/fidelisrafael/digit_checksum).  
+Pense em cada documento como um **adapter** criado em cima da API da Gem `DigitCheckSum`.
+
+Obrigado!
+
+---
+
+## Licença
+
+Essa biblioteca está disponível como projeto open source sob os termos da [Licença MIT](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,6 @@
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "br_documents"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/br_documents.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+
+require 'br_documents/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "brazilian_documents"
+  spec.version       = BRDocuments::VERSION
+  spec.authors       = ["Rafael Fidelis"]
+  spec.email         = ["rafa_fidelis@yahoo.com.br"]
+
+  spec.summary       = %q{Coleção de validadores para documentos brasileiros}
+  spec.description   = %q{Esta gem implementa vários validadores de documentos oficiais brasileiros, como CPF, CNPJ, RG e Título de Eleitor}
+  spec.homepage      = "https://github.com/fidelisrafael/brazilian_documents"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_dependency 'digit_checksum', '~> 0.1.0'
+  spec.add_development_dependency "bundler", "~> 1.12"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rspec", "~> 3.0"
+end

data/lib/br_documents/documents/cnpj.rb

@@ -0,0 +1,19 @@
+require "digit_checksum"
+
+module BRDocuments
+  class CNPJ < ::DigitChecksum::BaseDocument
+    digits_verify_mask first:  %w(5 4 3 2 9 8 7 6 5 4 3 2),
+                       second: %w(6 5 4 3 2 9 8 7 6 5 4 3 2)
+
+    # MOD 11
+    division_factor_modulo 11
+
+    # remove any non digit from document number
+    clear_number_regexp %r{[^(\d+)]}
+
+    # match format such as: 99.999.999/9999-99 | 99-999-999/9999-99 | 99999999/999999 | 99999999999999
+    valid_format_regexp %r{(\d{2})[-.]?(\d{3})[-.]?(\d{3})[\/]?(\d{4})[-.]?(\d{2})}
+
+    pretty_format_mask %(%s.%s.%s/%s-%s)
+  end
+end

data/lib/br_documents/documents/cpf.rb

@@ -0,0 +1,19 @@
+require "digit_checksum"
+
+module BRDocuments
+  class CPF < ::DigitChecksum::BaseDocument
+    digits_verify_mask first:  %w(10 9 8 7 6 5 4 3 2),
+                       second: %w(11 10 9 8 7 6 5 4 3 2)
+
+    # MOD 11
+    division_factor_modulo 11
+
+    # remove any non digit from document number
+    clear_number_regexp %r{[^(\d+)]}
+
+    # match format such as: 999.999.999-99 | 999-999-999-99 | 99999999999
+    valid_format_regexp %r{(\d{3})[-.]?(\d{3})[-.]?(\d{3})[-.]?(\d{2})}
+
+    pretty_format_mask %(%s.%s.%s-%s)
+  end
+end

data/lib/br_documents/version.rb

@@ -0,0 +1,3 @@
+module BRDocuments
+  VERSION = "0.1.0"
+end

data/lib/br_documents.rb

@@ -0,0 +1,6 @@
+require "br_documents/version"
+require "br_documents/documents/cpf"
+require "br_documents/documents/cnpj"
+
+module BRDocuments
+end

data/lib/brazilian_documents.rb

@@ -0,0 +1 @@
+require 'br_documents'

metadata

@@ -0,0 +1,117 @@
+--- !ruby/object:Gem::Specification
+name: brazilian_documents
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Rafael Fidelis
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2016-07-01 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: digit_checksum
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.12'
+- !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'
+description: Esta gem implementa vários validadores de documentos oficiais brasileiros,
+  como CPF, CNPJ, RG e Título de Eleitor
+email:
+- rafa_fidelis@yahoo.com.br
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- br_documents.gemspec
+- lib/br_documents.rb
+- lib/br_documents/documents/cnpj.rb
+- lib/br_documents/documents/cpf.rb
+- lib/br_documents/version.rb
+- lib/brazilian_documents.rb
+homepage: https://github.com/fidelisrafael/brazilian_documents
+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.5.1
+signing_key: 
+specification_version: 4
+summary: Coleção de validadores para documentos brasileiros
+test_files: []