common_numbers 0.1.5

data/.gitignore

@@ -0,0 +1,5 @@
+*.gem
+.bundle
+Gemfile.lock
+pkg/*
+.rvmrc

data/Gemfile

@@ -0,0 +1,5 @@
+source "http://rubygems.org"
+
+gem "rspec"
+# Specify your gem's dependencies in nip_number.gemspec
+gemspec

data/README.markdown

@@ -0,0 +1,67 @@
+###MAGICK NUMBERS
+
+Magic Numbers are numbers verfied with Luhn Algoritm like ISBN, VIN
+
+magick_numbers gem simple verify this numbers.
+In first version gem is focused on Polish numbers like:
+
+- PESEL - (Polish ID Number)
+- NIP - (Polish Taxation Identification Number)
+- REGON - (Polish Company Identification Number)
+
+but in near future will validate also:
+
+- ISBN
+- EAN
+- VIN
+
+meybe something else :)
+
+###Instalation:
+
+    gem install common_numbers
+
+###Usage:
+
+All numbers are in module MagickNumbers and have simple method `valid?`
+
+    require 'common_numbers'
+    
+    CommonNumbers::Polish::Nip.new(nip_number).valid?
+    CommonNumbers::Polish::Pesel.new(pesel_number).valid?
+    CommonNumbers::Polish::Regon.new(regon_number).valid?
+
+###Valid numbers:
+
+####NIP
+
+NIP is valid when has 11 digits witn optional '-' between
+    
+    1234563218
+    123-456-32-18
+    123-45-63-218
+
+are valid numbers
+
+In international notation NIP has country code as first two signs, and:
+
+    PL1234563218
+    PL123-456-32-18
+    PL123-45-63-218
+
+are also valid.
+
+####PESEL
+
+Pesel's valid format is 11 digits, no other signs
+
+####REGON
+
+Regon has two options, first 9 digits for small companies and 14 digits
+with companies with regional offices.
+
+Both are validated.
+
+
+
+Copyright (c) 2011 Mariusz Nosiński, released under the MIT license

data/Rakefile

@@ -0,0 +1,2 @@
+require 'bundler'
+Bundler::GemHelper.install_tasks

data/common_numbers.gemspec

@@ -0,0 +1,21 @@
+# -*- encoding: utf-8 -*-
+$:.push File.expand_path("../lib", __FILE__)
+require "common_numbers/version"
+
+Gem::Specification.new do |s|
+  s.name        = "common_numbers"
+  s.version     = CommonNumbers::VERSION
+  s.platform    = Gem::Platform::RUBY
+  s.authors     = ["Mariusz Nosinski"]
+  s.email       = ["marioosh@5dots.pl"]
+  s.homepage    = "http://github.com/marioosh/common_numbers"
+  s.summary     = %q{Basic library to validate numbers like PESEL, NIP, etc}
+  s.description = %q{Common Numbers validates popular numbers like polish PESEL, NIP, REGON, or global ISBN, EAN, etc.}
+
+  s.rubyforge_project = "common_numbers"
+
+  s.files         = `git ls-files`.split("\n")
+  s.test_files    = `git ls-files -- {test,spec,features}/*`.split("\n")
+  s.executables   = `git ls-files -- bin/*`.split("\n").map{ |f| File.basename(f) }
+  s.require_paths = ["lib"]
+end

data/lib/common_numbers.rb

@@ -0,0 +1,7 @@
+require 'common_numbers/version'
+require 'common_numbers/base'
+require 'common_numbers/nip'
+require 'common_numbers/pesel'
+require 'common_numbers/regon'
+require 'common_numbers/regon14'
+require 'common_numbers/regon9'

data/lib/common_numbers/base.rb

@@ -0,0 +1,40 @@
+module CommonNumbers
+  
+  class Base
+    
+    attr_reader :magick_number, :regexp, :mask, :modulo, :length, :magick_array
+
+    def initialize(num)
+      @magick_number = num.to_s.gsub('-', '')
+    end
+
+    def valid?
+      validate
+    end
+
+    def validate
+      validate_regexp && validate_length && validate_sum_control
+    end
+
+    def validate_regexp
+        regexp =~ magick_number
+    end
+
+    def validate_length
+      magick_number.size == length
+    end
+
+    def validate_sum_control
+      mod = checksum % modulo
+      mod = 0 if mod == 10
+      mod === magick_array.shift
+    end
+    
+    def checksum
+      @magick_array = magick_number.split( "").collect &:to_i
+      checksum = mask.inject(0) {|sum, weight| sum + weight * magick_array.shift}
+    end
+    
+  end
+
+end

data/lib/common_numbers/nip.rb

@@ -0,0 +1,34 @@
+module CommonNumbers
+  
+  module Polish
+
+    class Nip < CommonNumbers::Base
+
+      def initialize(num)
+        super(num)
+        @mask = [ 6, 5, 7, 2, 3, 4, 5, 6, 7]
+        @modulo = 11 
+        @regexp = /^(PL)?[0-9]*/
+        # @magick_number = num.to_s.gsub('-', '')
+
+      end
+
+      def validate_length
+        @magick_number.size == (international? ? 12 : 10)
+      end
+      
+      def international?
+        /^PL/ =~ @magick_number
+      end
+
+      def validate_sum_control
+        magick_number.slice!(0..1) if international?
+        mod = checksum % modulo
+        mod === magick_array.shift
+      end
+
+    end
+
+  end
+
+end

data/lib/common_numbers/pesel.rb

@@ -0,0 +1,25 @@
+module CommonNumbers
+
+  module Polish
+    class Pesel < CommonNumbers::Base
+
+      def initialize(num)
+        super num
+        @mask = [ 1, 3, 7, 9, 1, 3, 7, 9, 1, 3]
+        @modulo = 10
+        @regexp = /\d{11}/
+        @length = 11
+      end
+
+      def validate_sum_control
+        mod = checksum % modulo
+        mod = 10 - mod
+        mod = 0 if mod == 10
+        mod === magick_array.shift
+      end
+
+    end
+  
+  end
+
+end

data/lib/common_numbers/regon.rb

@@ -0,0 +1,25 @@
+module CommonNumbers
+
+  module Polish
+
+    class Regon 
+
+      def initialize(num)
+        @factory = if(/^\d{9}$/ =~ num)
+                      Regon9.new num
+                   elsif(/^\d{14}$/ =~ num)
+                      Regon14.new num
+                   else
+                     nil
+                   end
+
+      end
+
+      def valid?
+        return @factory.valid? if @factory
+        false
+      end
+
+    end
+  end
+end

data/lib/common_numbers/regon14.rb

@@ -0,0 +1,15 @@
+module CommonNumbers
+
+  class Regon14 < CommonNumbers::Base
+    
+    def initialize(num)
+      super num
+      @mask = [2, 4, 8, 5, 0, 9, 7, 3, 6, 1, 2, 4, 8]
+      @modulo = 11
+      @regexp = /^\d{14}$/
+      @length = 14
+    end
+
+  end
+
+end

data/lib/common_numbers/regon9.rb

@@ -0,0 +1,15 @@
+module CommonNumbers
+
+  class Regon9 < CommonNumbers::Base
+    def initialize(num)
+      super num
+      @mask = [8, 9, 2, 3, 4, 5, 6, 7]
+      @modulo = 11
+      @regexp = /^\d{9}$/
+      @length = 9
+
+    end
+
+  end
+
+end

data/lib/common_numbers/version.rb

@@ -0,0 +1,3 @@
+module CommonNumbers
+  VERSION = "0.1.5"
+end

data/spec/nip_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'rspec'
+
+describe "Nip"  do
+
+  it "should be valid"do
+    valid_numbers = %w[123-456-32-18 1234563218 123-45-63-218 PL123-456-32-18]
+    valid_numbers.each do |n|
+        nip = CommonNumbers::Polish::Nip.new(n)
+        nip.should be_valid
+    end
+  end
+
+  it "should be invalid" do
+    invalid_numbers = %w[PL5912158688 PP5911158688 591-116-86-88 591-11-48-688 PL_591-115-86-88 PL591 591-11-58-6887]
+    invalid_numbers.each do |n|
+      nip = CommonNumbers::Polish::Nip.new(n)
+      nip.should_not be_valid
+    end
+  end
+end

data/spec/pesel_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'rspec'
+
+describe "Pesel"  do
+
+  it "should be valid"do
+    valid_numbers = %w[44051401359 02070803628]
+    valid_numbers.each do |n|
+        pesel = CommonNumbers::Polish::Pesel.new(n)
+        pesel.should be_valid
+    end
+  end
+
+  it "should be invalid" do
+    invalid_numbers = %w[44051401358 02070803629]
+    invalid_numbers.each do |n|
+      pesel = CommonNumbers::Polish::Pesel.new(n)
+      pesel.should_not be_valid
+    end
+  end
+end

data/spec/regon_spec.rb

@@ -0,0 +1,21 @@
+require 'spec_helper'
+require 'rspec'
+
+describe "Regon"  do
+
+  it "should be valid"do
+    valid_numbers = %w[192598184 123456785 12345678512347]
+    valid_numbers.each do |n|
+        regon = CommonNumbers::Polish::Regon.new(n)
+        regon.should be_valid
+    end
+  end
+
+  it "should be invalid" do
+    invalid_numbers = %w[192598284 1925982843 19259828 123456786 12345638512347]
+    invalid_numbers.each do |n|
+      regon = CommonNumbers::Polish::Regon.new(n)
+      regon.should_not be_valid
+    end
+  end
+end

data/spec/spec_helper.rb

@@ -0,0 +1,3 @@
+Dir[File.expand_path(File.dirname(__FILE__) + "/../lib/**/*.rb")].each { |f| require f}
+require 'rspec'
+

metadata

@@ -0,0 +1,76 @@
+--- !ruby/object:Gem::Specification 
+name: common_numbers
+version: !ruby/object:Gem::Version 
+  prerelease: 
+  version: 0.1.5
+platform: ruby
+authors: 
+- Mariusz Nosinski
+autorequire: 
+bindir: bin
+cert_chain: []
+
+date: 2011-04-18 00:00:00 +02:00
+default_executable: 
+dependencies: []
+
+description: Common Numbers validates popular numbers like polish PESEL, NIP, REGON, or global ISBN, EAN, etc.
+email: 
+- marioosh@5dots.pl
+executables: []
+
+extensions: []
+
+extra_rdoc_files: []
+
+files: 
+- .gitignore
+- Gemfile
+- README.markdown
+- Rakefile
+- common_numbers.gemspec
+- lib/common_numbers.rb
+- lib/common_numbers/base.rb
+- lib/common_numbers/nip.rb
+- lib/common_numbers/pesel.rb
+- lib/common_numbers/regon.rb
+- lib/common_numbers/regon14.rb
+- lib/common_numbers/regon9.rb
+- lib/common_numbers/version.rb
+- spec/nip_spec.rb
+- spec/pesel_spec.rb
+- spec/regon_spec.rb
+- spec/spec_helper.rb
+has_rdoc: true
+homepage: http://github.com/marioosh/common_numbers
+licenses: []
+
+post_install_message: 
+rdoc_options: []
+
+require_paths: 
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+required_rubygems_version: !ruby/object:Gem::Requirement 
+  none: false
+  requirements: 
+  - - ">="
+    - !ruby/object:Gem::Version 
+      version: "0"
+requirements: []
+
+rubyforge_project: common_numbers
+rubygems_version: 1.6.2
+signing_key: 
+specification_version: 3
+summary: Basic library to validate numbers like PESEL, NIP, etc
+test_files: 
+- spec/nip_spec.rb
+- spec/pesel_spec.rb
+- spec/regon_spec.rb
+- spec/spec_helper.rb