portuguese_validators 0.0.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: cb5e228a583342dcd6b0afdfe85cadc5508054f3
+  data.tar.gz: 398b47b5b3f861d5a94bb5d537c5fa7647247ba8
+SHA512:
+  metadata.gz: dcb090dc850e45d3259dede6dd878975526712d55773ac07c92062e8fa94500fcf213a6c291b634a6b40ad42d7717d982f20540d495a18ea730e942ce8179c95
+  data.tar.gz: d74ed5af267eea869f35efd8c3482f99a86453a00c3e13aab6d7b7f1f6bc823a220fc1d9f6eab9e627c98e2a1ca3b5f255e662eae79d4a65802912075f76304b

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/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Ricardo Otero
+
+MIT License
+
+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,55 @@
+# PortugueseValidators
+
+This is a simple gem to validate NIB, NIF and BI numbers.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```console
+$ gem 'portuguese_validators'
+```
+
+And then execute:
+
+```console
+$ bundle
+```
+
+Or install it yourself as:
+
+```console
+$ gem install portuguese_validators
+```
+
+## Usage
+
+You will have to include `PortugueseValidators` and then just add the validators to your model:
+
+```ruby
+class MyModel < ActiveRecord::Base
+  include PortugueseValidators
+
+  validates :nif_field, nif: true
+  validates :nib_field, nib: true
+  validates :bi_field, bi: true
+end
+```
+
+Note that these validators are just like the ones that Rails provide you so you can customize the error message or add an `:if` condition and all that. For example:
+
+```ruby
+class MyModel < ActiveRecord::Base
+  include PortugueseValidators
+
+  validates :bi_field, bi: { message: 'é um número errado' }, if: :user_pt?
+end
+```
+
+## Contributing
+
+1. Fork it ( http://github.com/rikas/portuguese_validators/fork )
+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/lib/portuguese_validators/bi_validator.rb

@@ -0,0 +1,39 @@
+module PortugueseValidators
+  # Validates Portuguese BI's.
+  #
+  # A Portuguese BI number is comprised by eight digits. Between that number and the "issue" box,
+  # the card also has a small box with a single digit. That's the control digit. In order to
+  # validate a Portuguese BI you have to give the full number (including the control digit).
+  class BiValidator
+    def validate_each(record, attribute, value)
+      unless is_valid?(value)
+        record.errors[attribute] << (options[:message] || 'is not a valid BI')
+      end
+    end
+
+    def is_valid?(number)
+      looks_like_bi?(number.to_s) && is_valid_bi?(number.to_s)
+    end
+
+    private
+
+    def is_valid_bi?(number)
+      control = number.split('').map { |digit| digit.to_i }
+
+      sum = 0
+      9.downto(2) do |num|
+        sum += num * control.shift
+      end
+
+      expected = 11 - sum % 11;
+      expected = 0 if expected > 9 # when the value is greater than 9 then we assume 0
+
+      expected == control.last
+    end
+
+    def looks_like_bi?(number)
+      return false unless number
+      number.match(/^\d{9}$/) ? true : false
+    end
+  end
+end

data/lib/portuguese_validators/nib_validator.rb

@@ -0,0 +1,37 @@
+module PortugueseValidators
+  # Validates Portuguese bank numbers (NIB).
+  #
+  # The number is always composed by 21 where the last two form the control number.
+  class NibValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      unless is_valid?(value)
+        record.errors[attribute] << (options[:message] || 'is not a valid NIB')
+      end
+    end
+
+    def is_valid?(number)
+      number = sprintf("%021o", number) if number.kind_of?(Integer)
+      looks_like_nib?(number) && is_valid_nib?(number)
+    end
+
+    private
+
+    def is_valid_nib?(number)
+      nib = number.slice(0..18).split('').map { |digit| digit.to_i }
+      control = number.slice(19..20).to_i
+
+      sum = 0
+      nib.each do |num|
+        sum = ((sum + num) * 10) % 97
+      end
+
+      expected = 98 - ((sum * 10) % 97)
+      expected == control
+    end
+
+    def looks_like_nib?(number)
+      return false unless number
+      number.match(/^\d{21}$/) ? true : false
+    end
+  end
+end

data/lib/portuguese_validators/nif_validator.rb

@@ -0,0 +1,41 @@
+module PortugueseValidators
+  # Validates Portuguese NIF's.
+  #
+  # The portuguese NIF is composed by 9 digits and it must start with 1, 2, 5, 6, 7, 8 or 9. The
+  # last digit is the control digit.
+  class NifValidator < ActiveModel::EachValidator
+    def validate_each(record, attribute, value)
+      unless is_valid?(value)
+        record.errors[attribute] << (options[:message] || 'is not a valid NIF')
+      end
+    end
+
+    def is_valid?(number)
+      nif = number.to_s
+      looks_like_nif?(nif) && is_valid_nif?(nif)
+    end
+
+    private
+
+    def is_valid_nif?(number)
+      control = number.split('').map { |digit| digit.to_i }
+
+      sum = 0
+      9.downto(2) do |num|
+        sum += num * control.shift
+      end
+
+      expected = 11 - sum % 11
+      expected = 0 if expected > 9 # when the value is greater than 9 then we assume 0
+
+      expected == control.last
+    end
+
+    # Checks if at least the given number has the correct number of digits and starts with a valid
+    # digit.
+    def looks_like_nif?(number)
+      return false unless number
+      number.match(/^\d{9}$/) && number.match(/^[1256789]/) ? true : false
+    end
+  end
+end

data/lib/portuguese_validators/version.rb

@@ -0,0 +1,3 @@
+module PortugueseValidators
+  VERSION = '0.0.1'
+end

data/lib/portuguese_validators.rb

@@ -0,0 +1,9 @@
+require 'active_model/validator'
+
+require 'portuguese_validators/version'
+require 'portuguese_validators/nif_validator'
+require 'portuguese_validators/nib_validator'
+require 'portuguese_validators/bi_validator'
+
+module PortugueseValidators
+end

data/portuguese_validators.gemspec

@@ -0,0 +1,25 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'portuguese_validators/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'portuguese_validators'
+  spec.version       = PortugueseValidators::VERSION
+  spec.authors       = ['Ricardo Otero']
+  spec.email         = ['oterosantos@gmail.com']
+  spec.summary       = 'Validators for portuguese related numbers like NIB, NIF and BI.'
+  spec.description   = spec.summary
+  spec.homepage      = 'http://github.com/rikas/portuguese_validators/fork'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  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.add_development_dependency 'bundler', '~> 1.5'
+  spec.add_development_dependency 'rake'
+
+  spec.add_dependency 'activemodel'
+end

metadata

@@ -0,0 +1,97 @@
+--- !ruby/object:Gem::Specification
+name: portuguese_validators
+version: !ruby/object:Gem::Version
+  version: 0.0.1
+platform: ruby
+authors:
+- Ricardo Otero
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-02-10 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.5'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: activemodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Validators for portuguese related numbers like NIB, NIF and BI.
+email:
+- oterosantos@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- lib/portuguese_validators.rb
+- lib/portuguese_validators/bi_validator.rb
+- lib/portuguese_validators/nib_validator.rb
+- lib/portuguese_validators/nif_validator.rb
+- lib/portuguese_validators/version.rb
+- portuguese_validators.gemspec
+homepage: http://github.com/rikas/portuguese_validators/fork
+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.2.1
+signing_key: 
+specification_version: 4
+summary: Validators for portuguese related numbers like NIB, NIF and BI.
+test_files: []