br_documents 0.0.2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 2a4b4ddd2caa2c23d58d23a4467094a831490466
+  data.tar.gz: afdeb05383f8d7b83f995ff0b45cf6c9765a67c1
+SHA512:
+  metadata.gz: 53a62e408338ee84e882cdf0ac5293f9ddd9a6f811f8d91dc547506bbdb8ae50ad6a9743bb7a8e20f5ed613fe03374a747d1c6138e317eb69e68e3ccf118b4da
+  data.tar.gz: c999e3b9bbc5e6a9298cb3aa7863d28f2b25985089fb0fc00718021d8d76bb8882c7c5c504cbf484a3c65b1b2d20b4e9a094e7dde57fd28c8f789e6b5ba4e604

data/.gitignore

@@ -0,0 +1,17 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp

data/.rspec

@@ -0,0 +1 @@
+--color --format documentation --order rand

data/Gemfile

@@ -0,0 +1,4 @@
+source "https://rubygems.org"
+ruby "2.0.0"
+
+gemspec

data/README.md

@@ -0,0 +1,146 @@
+# BrDocuments
+
+This gem validates Brazilian documents for application use. Today it can validate CNPJ, CPF and IE.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem "br_documents"
+```
+
+And then execute:
+
+```ruby
+$ bundle
+```
+
+Or install it yourself as:
+
+```ruby
+$ gem install br_documents
+```
+
+## Usage
+
+### Active Record
+
+#### CNPJ
+
+```ruby
+class Person < ActiveRecord::Base
+
+  attr_accessor :cnpj
+
+  validates :cnpj,
+    cnpj: true
+end
+
+
+pj = Person.new
+pj.cnpj = "85961757000102"
+pj.valid? # => true
+
+pj.cnpj = "85.961.757/0001-02" # with mask
+pf.valid? # => true
+
+pj.cnpj = "11111111111111"
+pj.valid? # => false
+```
+
+#### CPF
+
+```ruby
+class Person < ActiveRecord::Base
+
+  attr_accessor :cpf
+
+  validates :cpf,
+    cpf: true
+end
+
+
+pf = Person.new
+pf.cpf = "11144477735"
+pf.valid? # => true
+
+pf.cpf = "111.444.777-35" # with mask
+pf.valid? # => true
+
+pf.cpf = "111.111.111-11"
+pf.valid? # => false
+```
+
+#### IE
+
+```ruby
+class City < ActiveRecord::Base
+  attr_accessor :name, :uf
+
+  has_many :people
+end
+
+class Person < ActiveRecord::Base
+
+  attr_accessor :ie
+
+  belongs_to :city
+
+  validates :ie,
+    ie: {uf: "city#uf"} # you need to inform how it can get the "uf" attribute
+end
+
+
+c = City.new
+c.name = "Tijucas"
+c.uf = "SC"
+
+pj = Person.new
+pj.city = c
+
+pj.ie = "253667852"
+pj.valid? # => true
+
+pj.ie = "253.667.852" # with mask
+pj.valid? # => true
+
+c.uf = "SP"
+pj.valid? # => false
+
+c.uf = "SC"
+pj.ie = "111.111.111"
+pj.valid? # => false
+```
+
+### Ruby
+
+#### CNPJ
+
+```ruby
+cnpj = BrDocuments::CnpjCpf::Cnpj.new("04.001.155/0001-01")
+cnpj.valid? # => true
+```
+
+#### CPF
+
+```ruby
+cpf = BrDocuments::CnpjCpf::Cpf.new("111.444.777-35")
+cpf.valid? # => true
+```
+
+#### IE
+
+```ruby
+ie = BrDocuments::IE::Factory.create("SC", "254062407")
+ie.formatted # => "254.062.407"
+ie.valid?    # => true
+```
+
+## Contributing
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request

data/Rakefile

@@ -0,0 +1 @@
+require "bundler/gem_tasks"

data/br_documents.gemspec

@@ -0,0 +1,30 @@
+# 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          = "br_documents"
+  spec.version       = BrDocuments::VERSION
+  spec.authors       = ["ASSEINFO - Sistemas de Informação"]
+  spec.email         = ["asseinfo@asseinfo.com.br"]
+  spec.description   = "Solução para validar documentos brasileiros"
+  spec.summary       = "Solução para validar documentos brasileiros"
+  spec.homepage      = "http://github.com/asseinfo/br_documents"
+  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.metadata["allowed_push_host"] = "http://github.com/asseinfo/br_documents"
+
+  spec.add_development_dependency "bundler",            "~> 1.3"
+  spec.add_development_dependency "rake",               "~> 10.1.0"
+  spec.add_development_dependency "rspec",              "~> 2.14.1"
+  spec.add_development_dependency "codeclimate-test-reporter"
+
+  spec.add_runtime_dependency     "activemodel",         "~> 4.0.0"
+  spec.add_runtime_dependency     "i18n",                "~> 0.6.5"
+end

data/config/locales/pt-BR.yml

@@ -0,0 +1,8 @@
+pt-BR:
+  validator:
+    ie:
+      uf:
+        read_error: "Não foi possível ler o atributo '%{uf}'"
+        no_configured: "Não foi configurado o atributo 'uf' em IeValidator"
+        invalid: "UF é inválida"
+        no_present: "Quando informado a Inscrição Estadual a UF não deve ficar em branco"

data/lib/br_documents.rb

@@ -0,0 +1,4 @@
+require "active_model"
+Dir[File.dirname(__FILE__) + "/**/*.rb"].each { |f| require f }
+
+I18n.load_path << File.expand_path("../../config/locales/pt-BR.yml", __FILE__)

data/lib/br_documents/cnpj_cpf/cnpj.rb

@@ -0,0 +1,21 @@
+require_relative "document"
+
+module BrDocuments
+  module CnpjCpf
+    class Cnpj
+      include Document
+
+      def initialize(number)
+        @number = number
+      end
+
+      def valid?
+        regex = /^(\d{2}\.\d{3}\.\d{3}\/\d{4}-\d{2})$|^(\d{14})$/
+        weight13 = [5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
+        weight14 = [6, 5, 4, 3, 2, 9, 8, 7, 6, 5, 4, 3, 2]
+
+        valid_number?(@number, regex, weight13, weight14)
+      end
+    end
+  end
+end

data/lib/br_documents/cnpj_cpf/cpf.rb

@@ -0,0 +1,21 @@
+require_relative "document"
+
+module BrDocuments
+  module CnpjCpf
+    class Cpf
+      include Document
+
+      def initialize(number)
+        @number = number
+      end
+
+      def valid?
+        regex = /^(\d{3}\.\d{3}\.\d{3}-\d{2})$|^(\d{11})$/
+        weight10 = [10, 9, 8, 7, 6, 5, 4, 3, 2]
+        weight11 = [11, 10, 9, 8, 7, 6, 5, 4, 3, 2]
+
+        valid_number?(@number, regex, weight10, weight11)
+      end
+    end
+  end
+end

data/lib/br_documents/cnpj_cpf/document.rb

@@ -0,0 +1,35 @@
+require_relative "../commons/mod11"
+
+module BrDocuments
+  module CnpjCpf
+    module Document
+      include Commons::Mod11
+
+      protected
+      def valid_number?(number, regex, weight1, weight2)
+        valid_format?(number, regex) and
+         not sequence_of_equal_numbers?(number) and
+         valid_digital_check?(number, weight1, weight2)
+      end
+
+      private
+      def valid_format?(number, regex)
+        regex.match(number).present?
+      end
+
+      def sequence_of_equal_numbers?(number)
+        remove_mask(number).split("").uniq.length == 1
+      end
+
+      def valid_digital_check?(number, weight1, weight2)
+        digital_check1 = generate_digital_check(remove_mask(number), weight1)
+        digital_check2 = generate_digital_check(remove_mask(number), weight2)
+        number[-2, 2].eql? "#{digital_check1}#{digital_check2}"
+      end
+
+      def remove_mask(number)
+        number.gsub(/[\.\/-]/, "")
+      end
+    end
+  end
+end

data/lib/br_documents/cnpj_validator.rb

@@ -0,0 +1,8 @@
+class CnpjValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if value.present?
+      cnpj = BrDocuments::CnpjCpf::Cnpj.new(value)
+      record.errors.add(attribute, :invalid) if not cnpj.valid?
+    end
+  end
+end

data/lib/br_documents/commons/mod11.rb

@@ -0,0 +1,20 @@
+module BrDocuments
+  module Commons
+    module Mod11
+
+      def generate_digital_check(values, weights)
+        sum = reduce_weights(values, weights)
+        mod = sum % 11
+        mod < 2 ? 0 : (11 - mod)
+      end
+
+      def reduce_weights(values, weights)
+        sum = 0
+        weights.each_index do |i|
+          sum += weights[i] * values[i].to_i
+        end
+        sum
+      end
+    end
+  end
+end

data/lib/br_documents/cpf_validator.rb

@@ -0,0 +1,8 @@
+class CpfValidator < ActiveModel::EachValidator
+  def validate_each(record, attribute, value)
+    if value.present?
+      cpf = BrDocuments::CnpjCpf::Cpf.new(value)
+      record.errors.add(attribute, :invalid) if not cpf.valid?
+    end
+  end
+end

data/lib/br_documents/ie/ac.rb

@@ -0,0 +1,17 @@
+require_relative "pattern2"
+
+module BrDocuments
+  module IE
+    class AC < Pattern2
+      def initialize(number)
+        super
+        @mask = /^(\d{2}\.\d{3}\.\d{3}\/\d{3}\-\d{2})$|^(\d{13})$/
+      end
+
+      private
+      def format_ie(number)
+        number.sub(/(\d{2})(\d{3})(\d{3})(\d{3})(\d{2})/, "\\1.\\2.\\3/\\4-\\5")
+      end
+    end
+  end
+end

data/lib/br_documents/ie/al.rb

@@ -0,0 +1,17 @@
+require_relative "pattern1"
+
+module BrDocuments
+  module IE
+    class AL < Pattern1
+      def initialize(number)
+        super
+        @mask = /(\d{9})$/
+      end
+
+      private
+      def format_ie(number)
+        number
+      end
+    end
+  end
+end

data/lib/br_documents/ie/am.rb

@@ -0,0 +1,17 @@
+require_relative "pattern1"
+
+module BrDocuments
+  module IE
+    class AM < Pattern1
+      def initialize(number)
+        super
+        @mask = /^(\d{2}\.\d{3}\.\d{3}\-\d{1})$|^(\d{9})$/
+      end
+
+      private
+      def format_ie(number)
+        number.sub(/(\d{2})(\d{3})(\d{3})(\d{1})/, "\\1.\\2.\\3-\\4")
+      end
+    end
+  end
+end

data/lib/br_documents/ie/ap.rb

@@ -0,0 +1,52 @@
+require_relative "base"
+
+module BrDocuments
+  module IE
+    class AP < Base
+      include Commons::Mod11
+
+      private
+      def format_ie(number)
+        number
+      end
+
+      def valid_format?
+        regex = /(\d{9})$/
+        regex.match(@number).present?
+      end
+
+      def valid_digital_check?
+        weight = [9, 8, 7, 6, 5, 4, 3, 2]
+        detect_range_digits
+        @number.gsub!(/\./, "")
+        @number[-1].eql? generate_digital_check(@number, weight).to_s
+      end
+
+      def detect_range_digits
+        number = @number[0, 8]
+        if number.to_i >= 3000001 and number.to_i <= 3017000
+          @p = 5
+          @d = 0
+        else
+          if number.to_i >= 3017001 and number.to_i <= 3019022
+            @p = 9
+            @d = 1
+          else
+            @p = 0
+            @d = 0
+          end
+        end
+      end
+
+      def generate_digital_check(values, weights)
+        sum = reduce_weights(values, weights)
+        sum += @p
+        mod = sum % 11
+        digital_check = 11 - mod
+        digital_check = 0 if digital_check == 10
+        digital_check = @d if digital_check == 11
+        digital_check
+      end
+    end
+  end
+end