nip_pesel_regon 1.0.0.rc2

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: f30d4c87a60d20d3acbd9fb0507e5238169cad5d
+  data.tar.gz: 270fc6bfd476bfaf6912217ad9633cd246bf996a
+SHA512:
+  metadata.gz: d671933c3a82ab3a6680ebacbe2fddc161134a85718c4f088e77c5b00fb79d07a102394b939c6acf9fcffa9e2227494d6ef8f059f70d2e513dc45be32261ce2b
+  data.tar.gz: 5ee1a51fbc3531d088a2fafdecc35385e2c5f0e7771b300e38190b636970c8ed4656c83e71fb3aae8f52d9651a4220b120e7f52218c791b289798d2864f574e7

data/.gitignore

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

data/.travis.yml

@@ -0,0 +1,7 @@
+language: ruby
+rvm:
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - 2.2
+before_install: gem install bundler -v 1.10.3

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 psagan
+
+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,42 @@
+
+# NipPeselRegon - rc1
+
+[![Build Status](https://travis-ci.org/psagan/nip_pesel_regon.svg?branch=master)](https://travis-ci.org/psagan/nip_pesel_regon)
+
+Validates polish identification numbers NIP, PESEL, REGON. Can be used in any ruby script or integrated with Rails validation
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'nip_pesel_regon'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install nip_pesel_regon
+
+## Usage
+
+```ruby
+class Company < ActiveRecord::Base
+    validates_nip_of :my_nip_field
+    validates_pesel_of :my_pesel_field
+    validates_regon_of :my_regon_field
+end
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/psagan/nip_pesel_regon.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,10 @@
+require "bundler/gem_tasks"
+require "rake/testtask"
+
+Rake::TestTask.new(:test) do |t|
+  t.libs << "test"
+  t.libs << "lib"
+  t.test_files = FileList['test/**/*_test.rb']
+end
+
+task :default => :test

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "nip_pesel_regon"
+
+# 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,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/nip_pesel_regon.rb

@@ -0,0 +1,19 @@
+require "nip_pesel_regon/version"
+require 'nip_pesel_regon/calculator/checksum'
+require 'nip_pesel_regon/validator/base'
+require "nip_pesel_regon/validator/nip"
+require "nip_pesel_regon/validator/regon"
+require "nip_pesel_regon/validator/regon9"
+require "nip_pesel_regon/validator/regon14"
+require "nip_pesel_regon/validator/pesel"
+require "nip_pesel_regon/validator/not_valid"
+
+
+if defined? Rails
+  require "nip_pesel_regon/integration/rails"
+end
+
+
+module NipPeselRegon
+  # Your code goes here...
+end

data/lib/nip_pesel_regon/calculator/checksum.rb

@@ -0,0 +1,17 @@
+module NipPeselRegon
+  module Calculator
+
+    # This class is responsible
+    # for calculating checksum
+    class Checksum
+      def initialize(weights, number)
+        @weights = weights
+        @number = number
+      end
+
+      def calculate
+        @weights.each_with_index.inject(0) {|sum, (weight, i)| sum + @number[i].to_i * weight}
+      end
+    end
+  end
+end

data/lib/nip_pesel_regon/integration/rails.rb

@@ -0,0 +1,66 @@
+require 'active_support/inflector'
+
+module NipPeselRegon
+  module Integration
+      # class responsible for simple integration
+      # NIP/PESEL/REGON validation into active model validation
+    class Rails < ActiveModel::EachValidator
+
+      # hash with default options
+      DEFAULT_OPTIONS = {
+          save_normalized: true,
+          message: 'invalid %s'
+      }
+
+      def initialize(*attr)
+        super
+        handle_default_options
+      end
+
+      # method responsible for handling default options
+      # and merging them with custom options provided by developer
+      def handle_default_options
+        # before mergin check if custom :message provided by developer
+        message_provided = options[:message]
+
+        # do merge
+        @options = DEFAULT_OPTIONS.merge(options)
+
+        # handle default message template based on condition if
+        # custom message was provided by developer
+        @options[:message] = options[:message] % options[:validator].upcase unless message_provided
+      end
+
+
+      def validate_each(record, attribute, value)
+        # do validation
+        validator = "NipPeselRegon::Validator::#{options[:validator].capitalize}".constantize.new(value, options)
+
+        if validator.valid?
+          # if NIP/PESEL/REGON is valid and 'save_normalized' options is set to true
+          # then assign normalized value to attribute otherwise it will be
+          # saved as provided by user (without normalization)
+          record.send(attribute.to_s + '=', validator.to_s) if options[:save_normalized]
+        else
+          # add errors message to record's attribute
+          record.errors[attribute] << options[:message]
+        end
+      end
+    end
+  end
+end
+
+module ActiveModel
+  module Validations
+    module HelperMethods
+      %w{nip pesel regon}.each do |validator_name|
+        define_method("validates_#{validator_name}_of") do |*attr_names|
+          options = attr_names.extract_options!
+          options[:validator] = validator_name
+          attr_names << options
+          validates_with NipPeselRegon::Integration::Rails, _merge_attributes(attr_names)
+        end
+      end
+    end
+  end
+end

data/lib/nip_pesel_regon/validator/base.rb

@@ -0,0 +1,61 @@
+module NipPeselRegon
+  module Validator
+    class Base
+
+      attr_reader :number, :original_number, :options
+
+      def initialize(number, options = {})
+        # need to make string from input number because
+        # whole functionality is based on string
+        @number = number.to_s
+        # keep original number
+        @original_number = number
+
+        @options = options
+
+        # normalize provided number
+        normalize
+      end
+
+      def valid?
+        # check if NIP provided has proper format
+        return false unless has_proper_format?
+        validate
+      end
+
+      def to_s
+        number
+      end
+
+      private
+
+      # method responsible for detection if number provided has proper format
+      def has_proper_format?
+        !number.nil? && matches_pattern?
+      end
+
+      # method responsible for pattern matching
+      def matches_pattern?
+        self.class::PATTERN =~ number
+      end
+
+      def validate
+        raise NoMethodError, "No validate method defined in #{self.class}"
+      end
+
+      def checksum
+        @checksum ||= calculate_checksum
+      end
+
+      def calculate_checksum
+        NipPeselRegon::Calculator::Checksum.new(self.class::WEIGHTS, number).calculate
+      end
+
+      def normalize
+        return number if options[:strict] && options[:strict] == true
+        @number = number.gsub(/[-\s]/, '')
+      end
+
+    end
+  end
+end

data/lib/nip_pesel_regon/validator/nip.rb

@@ -0,0 +1,35 @@
+module NipPeselRegon
+  module Validator
+
+    # class responsible
+    # for nip validation (including standard normalization)
+    # please not only polish NIP's are valid with or without 'PL' prefix
+    # NIP's with other prefixes like eg. 'DE', 'EN' are invalid
+    class Nip < Base
+      # array with weights
+      WEIGHTS = [6, 5, 7, 2, 3, 4, 5, 6, 7] # @todo - candidate for sumcalculator object resonsible only for calculating sum
+
+      # pattern for NIP
+      PATTERN = /^\d{10}$/
+
+      private
+
+      # main validation method
+      def validate
+        # check if calculated checksum modulo 11 is equal to last digit of NIP
+        # if yes then validation is correct
+        (checksum % 11) == number[-1].to_i
+      end
+
+      # method responsible for
+      # input number normalization before validation
+      # 1. Makes input a string
+      # 2. Removes all '-' and whitespaces
+      # 3. remove 'PL' substring from the beginning if any
+      def normalize
+        @number = super.gsub(/^PL/i, '') # only pl NIP's are valid
+      end
+
+    end
+  end
+end

data/lib/nip_pesel_regon/validator/not_valid.rb

@@ -0,0 +1,13 @@
+module NipPeselRegon
+  module Validator
+
+    # Class responsible for
+    # acting as not valid in
+    # Null Object Pattern
+    class NotValid
+      def valid?
+        false
+      end
+    end
+  end
+end

data/lib/nip_pesel_regon/validator/pesel.rb

@@ -0,0 +1,20 @@
+module NipPeselRegon
+  module Validator
+    class Pesel < Base
+      # last digit is 1 - it's not official weight but
+      # but it will help to calculate all checksum like: a+3b+7c+9d+e+3f+7g+9h+i+3j+k
+      # en - https://en.wikipedia.org/wiki/PESEL
+      # pl - https://pl.wikipedia.org/wiki/PESEL
+      WEIGHTS = [1, 3, 7, 9, 1, 3 ,7, 9, 1, 3, 1].freeze
+
+      PATTERN = /^\d{11}$/
+
+      private
+
+      def validate
+        checksum % 10 == 0
+      end
+
+    end
+  end
+end

data/lib/nip_pesel_regon/validator/regon.rb

@@ -0,0 +1,28 @@
+module NipPeselRegon
+  module Validator
+
+    # Extends Abstract to meet common, public interface
+    class Regon < Base
+
+      attr_reader :regon_validator
+
+      def initialize(*attr)
+        super
+        case(number.length) # number is after normalization
+          when 9
+            @regon_validator = Regon9.new(number)
+          when 14
+            @regon_validator = Regon14.new(number)
+          else
+            @regon_validator = NotValid.new # Null Object Pattern
+        end
+      end
+
+      def valid?
+        regon_validator.valid?
+      end
+
+    end
+
+  end
+end

data/lib/nip_pesel_regon/validator/regon14.rb

@@ -0,0 +1,30 @@
+module NipPeselRegon
+  module Validator
+    class Regon14 < Base
+      WEIGHTS = [2, 4, 8, 5, 0, 9, 7, 3, 6, 1, 2, 4, 8]
+
+      PATTERN = /^\d{14}$/
+
+      private
+
+      def validate
+        # check if REGON with 14 digits is proper
+        # REGON with 9 digits by slicing
+        # first 9 digits and testing against Regon9
+        return false unless is_valid_regon9?
+
+        # check if calculated checksum modulo 11 is equal to last digit of REGON
+        # if yes then validation is correct
+        (checksum % 11) == number[-1].to_i
+      end
+
+      # method responsible
+      # for testing if first 9 digits of 14-digit REGON
+      # are proper 9-digits regon (Regon9 class)
+      def is_valid_regon9?
+        Regon9.new(number[0,9]).valid?
+      end
+
+    end
+  end
+end

data/lib/nip_pesel_regon/validator/regon9.rb

@@ -0,0 +1,24 @@
+module NipPeselRegon
+  module Validator
+    class Regon9 < Base
+      WEIGHTS = [8, 9, 2, 3, 4, 5, 6, 7]
+
+      PATTERN = /^\d{9}$/
+
+      private
+
+      def validate
+        mod = checksum % 11
+
+        # if mod is equal to 10 then set it to 0
+        mod = 0 if mod == 10
+
+        # check if mod is equal to last digit of REGON
+        # if yes then validation is correct
+        mod == number[-1].to_i
+      end
+
+    end
+  end
+end
+

data/lib/nip_pesel_regon/version.rb

@@ -0,0 +1,3 @@
+module NipPeselRegon
+  VERSION = "1.0.0.rc2"
+end

data/nip_pesel_regon.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'nip_pesel_regon/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "nip_pesel_regon"
+  spec.version       = NipPeselRegon::VERSION
+  spec.authors       = ["Patryk Sagan"]
+  spec.email         = ["patryk.sagan@icloud.com"]
+
+  spec.summary       = %q{NIP, PESEL, REGON validator for Ruby, Rails}
+  spec.description   = %q{Validates polish identification numbers NIP, PESEL, REGON. Can be used in any ruby script or integrated with Rails validation}
+  spec.homepage      = "https://github.com/psagan/nip_pesel_regon"
+  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_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+  spec.add_development_dependency "supermodel", "~> 0.1", ">= 0.1.6"
+  spec.add_development_dependency "activesupport", "~> 3.0", ">= 3.0.0"
+end

metadata

@@ -0,0 +1,147 @@
+--- !ruby/object:Gem::Specification
+name: nip_pesel_regon
+version: !ruby/object:Gem::Version
+  version: 1.0.0.rc2
+platform: ruby
+authors:
+- Patryk Sagan
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-10-13 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !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: minitest
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '5.0'
+- !ruby/object:Gem::Dependency
+  name: supermodel
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '0.1'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 0.1.6
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: 3.0.0
+description: Validates polish identification numbers NIP, PESEL, REGON. Can be used
+  in any ruby script or integrated with Rails validation
+email:
+- patryk.sagan@icloud.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/nip_pesel_regon.rb
+- lib/nip_pesel_regon/calculator/checksum.rb
+- lib/nip_pesel_regon/integration/rails.rb
+- lib/nip_pesel_regon/validator/base.rb
+- lib/nip_pesel_regon/validator/nip.rb
+- lib/nip_pesel_regon/validator/not_valid.rb
+- lib/nip_pesel_regon/validator/pesel.rb
+- lib/nip_pesel_regon/validator/regon.rb
+- lib/nip_pesel_regon/validator/regon14.rb
+- lib/nip_pesel_regon/validator/regon9.rb
+- lib/nip_pesel_regon/version.rb
+- nip_pesel_regon.gemspec
+homepage: https://github.com/psagan/nip_pesel_regon
+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: 1.3.1
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.4.8
+signing_key: 
+specification_version: 4
+summary: NIP, PESEL, REGON validator for Ruby, Rails
+test_files: []