pl-commerce 0.1.0

data/lib/pl-commerce/nip.rb

@@ -0,0 +1,122 @@
+# Copyright: mati@sz.home.pl
+# License: LGPL
+# Date: 12-02-2007
+# Version 0.1
+# http://pl.wikipedia.org/wiki/NIP
+module PLCommerce
+  class Nip
+  
+    CONTROL_CODE_POSITION = 9;
+    WAGES = [6,5,7,2,3,4,5,6,7];
+  
+    #constructor
+    def initialize(nipL, opts = {:lenient => false})
+      raise ArgumentError, 'nip argument must be either of type String or Bignum' unless nipL.instance_of? String or nipL.instance_of? Bignum
+      @lenient = opts[:lenient];
+      #puts nip
+      @nip = strip_NIP(nipL);
+      if not @lenient
+        pre_validate_NIP(@nip);
+      end
+    end
+    
+    def valid?
+      #if lenient and validation produces problems
+      #it means that this number is not correct
+      begin
+        pre_validate_NIP(@nip)
+      rescue Exception => e
+        if @lenient
+          return false;
+        end
+        
+        raise e;
+      end
+    
+      sum = 0;
+      for i in 0..(@nip.length-2)
+        sum += @nip[i, 1].to_i * WAGES[i].to_i;
+      end
+      
+      iControlCode = sum % 11;
+      iControlCode = iControlCode % 10;
+      
+      iControlNIPValue = @nip[CONTROL_CODE_POSITION, 1].to_i;
+      
+      return (iControlCode == iControlNIPValue);
+    end
+    
+    #gets the code of Inland Revenue
+    def get_ir_code
+      begin
+        pre_validate_NIP(@nip, true, false, false)
+        #3 characters is minimum to get IR code
+        if @nip.length < 3
+          return '?';
+        end
+      rescue Exception => e
+        if @lenient
+          return '?';
+        end
+        
+        raise e;
+      end
+
+      return @nip[0, 3].to_i;
+    end
+    
+    def get_ir_code_desc
+      begin
+        pre_validate_NIP(@nip, true, false, false)
+      rescue Exception => e
+        if @lenient
+          return '?';
+        end
+        
+        raise e;
+      end
+      
+      return PLCommerce::IRCodes.get_ir_code_dsc(get_ir_code);
+    end
+    
+    def self.valid?(nip, lenient = false)
+      return Nip.new(nip, lenient).valid?;
+    end
+    
+    def to_s
+      return @nip;
+    end
+    
+    def pre_validate_NIP(nip, val_nil_and_empty = true, val_size = true, val_numeric = true)
+      raise ArgumentError, 'Must provide NIP' if (nip.nil? || nip.empty?) && val_nil_and_empty
+      raise ArgumentError, 'Must be 10 digit' if ((not nip.length == 10) && val_size)
+      if (Regexp.compile('(\d{3}-\d{3}-\d{2}-\d{2})|(\d{3}-\d{2}-\d{2}-\d{3})|(\d{10})').match(nip) == nil && val_numeric)
+        raise ArgumentError, 'NIP should be numeric and have format of xxx-xxx-xx-xx or xxx-xx-xx-xxx'
+      end
+    end
+      
+      #removed dashed and whitespaces, tabs from a string number
+    def strip_NIP(nip)
+      #first sub replaces all dash characters with empty string
+      #second sub replaced all whitespaced, tabs with empty string
+      
+      sStrippedNIP = String.new(nip.to_s)
+      for i in 1..nip.to_s.count(' -')
+        sStrippedNIP = sStrippedNIP.sub(/[-]/, '')
+        sStrippedNIP = sStrippedNIP.sub(/[\s]/, '')
+      end
+
+      return sStrippedNIP
+    end
+    
+    alias ir_code get_ir_code;
+    alias ir_code_desc get_ir_code_desc;
+    private(:strip_NIP, :pre_validate_NIP);
+  
+  end
+end
+
+#aFile = File.new('src/nip_ir_codes.yml')
+#aFile.each_line do |line|
+#  puts line[0,3] + " => '" + line[5,line.length-(5+1)] + "',";
+#end

data/lib/pl-commerce/pesel.rb

@@ -0,0 +1,169 @@
+# Copyright: mati@sz.home.pl
+# License: LGPL
+# Date: 12-02-2007
+# Version 0.1.0
+# 
+# http://chemeng.p.lodz.pl/zylla/ut/pesel.html
+# http://pl.wikipedia.org/wiki/PESEL
+require 'date'
+module PLCommerce
+  class Pesel
+
+    SEX_POSITION = 9;
+    CONTROL_CODE_POSITION = 10;
+    
+    WAGES = [1,3,7,9,1,3,7,9,1,3];
+  
+    # Constructor
+    # It takes pesel as first argument
+    # first argument can be either number or string
+    def initialize(pesel, opts = {:lenient => false})
+      raise ArgumentError, 'pesel argument must be either of type String or Bignum' unless pesel.instance_of? String or pesel.instance_of? Bignum
+
+      @lenient = opts[:lenient];
+      @pesel = strip_PESEL(pesel);
+      if not @lenient
+        pre_validate_PESEL(@pesel);
+      end
+    end
+  
+    def sex
+      begin
+        #to get sex we don't need all characters to be numeric but we need the same length
+        pre_validate_PESEL(@pesel, true, true, false)
+      rescue Exception => e
+        return '?'
+      end
+      
+      iSexValue = @pesel[SEX_POSITION, 1].to_i
+      if (iSexValue % 2) == 0
+        return 'F'
+      end
+  
+      return 'M'
+    end
+    
+    def male?
+      return sex == 'M'
+    end
+    
+    def female?
+      return sex == 'F'
+    end
+    
+    def valid?
+      #if lenient, it means we will not be throwing exceptions if pesel is incorrect
+      # we will simply return false in that case
+      if @lenient
+        begin
+          pre_validate_PESEL(@pesel)
+        rescue Exception => e
+          return false
+        end
+      end
+    
+      sum = 0
+      for i in 0..(@pesel.length-2)
+        sum += @pesel[i, 1].to_i * WAGES[i].to_i
+      end
+    
+      iControlCode = sum % 10;
+  
+      iControlCode = 10 - iControlCode;
+      if iControlCode == 10
+        iControlCode = 0;
+      end
+      
+      iControlPESELValue = @pesel[CONTROL_CODE_POSITION, 1].to_i;
+      
+      return (iControlPESELValue == iControlCode);
+    end
+    
+    def get_date_of_birth
+      begin
+        pre_validate_PESEL(@pesel, true, false, false)
+        #we need at least first 6 numbers
+        if @pesel.length < 6
+          return '?';
+        end
+        
+      rescue Exception => e
+        if @lenient
+          return '?'
+        end
+
+        raise e
+      end
+  
+      sYearLow = '19';
+      sYearHigh = @pesel[0, 2];
+      iMonth = @pesel[2, 2].to_i;
+      iDay = @pesel[4, 2].to_i;
+      
+      iMileniumCode = @pesel[2, 1].to_i;
+      case iMileniumCode
+        #(1900 - 1999) 20 century
+        when 0..1
+          sYearLow = '19';
+        #(2000 - 2099) 21st century
+        when 2..3
+          sYearLow = '20';
+          iMonth = iMonth - 20;
+        #(2100 - 2199) 22nd century
+        when 4..5
+          begin
+            sYearLow = '21';
+            iMonth = iMonth - 40;
+          end
+        #(2200 - 2299) 23rd century
+       when 6..7
+          sYearLow = '22';
+          iMonth = iMonth - 60;
+          
+       #(1800 - 1899) 19th century
+       when 8..9
+          sYearLow = '18';
+          iMonth = iMonth - 80;
+      end
+      
+      sYear = sYearLow + sYearHigh;
+      iYear = sYear.to_i;
+  
+      return Date.new(iYear, iMonth, iDay)
+    end
+    
+    def self.valid?(pesel, lenient = false)
+      return Pesel.new(pesel, lenient).valid?
+    end
+    
+    def self.sex?(pesel, lenient = false)
+      return Pesel.new(pesel, lenient).sex?
+    end
+  
+    def to_s
+      return @pesel;
+    end
+  
+    def pre_validate_PESEL(pesel, val_nil_and_empty = true, val_size = true, val_numeric = true)
+      raise ArgumentError, 'Must provide PESEL' if ((pesel.nil? || pesel.empty?) && val_nil_and_empty);
+      raise ArgumentError, 'Pesel size should be exacly eleven characters' if ((not pesel.length == 11) && val_size);
+      raise ArgumentError, 'Pesel should be numeric' if (Regexp.compile('(\d{11})').match(pesel) == nil && val_numeric);
+    end
+    
+    ##removes whitespaces, tabs from a string pesel number
+    def strip_PESEL(pesel)
+      sStrippedPESEL = String.new(pesel.to_s)
+      for i in 1..sStrippedPESEL.count(' ')
+        sStrippedPESEL = sStrippedPESEL.sub(/[\s]/, '')
+      end
+
+      return sStrippedPESEL
+    end
+    
+    alias dob get_date_of_birth
+    alias date_of_birth get_date_of_birth
+    
+    private(:pre_validate_PESEL, :strip_PESEL)
+  
+  end
+end

data/test/test_ir_codes.rb

@@ -0,0 +1,19 @@
+require 'test/unit'
+require 'lib/pl-commerce'
+
+class IRCodesTest < Test::Unit::TestCase
+	#def setup
+	#end
+
+	#def teardown
+	#end
+
+	def test_ir_code1
+		assert('Urząd Skarbowy Poznań-Nowe Miasto' == PLCommerce::IRCodes.get_ir_code_dsc(362));
+	end
+
+	def test_ir_code2
+		assert('Urząd Skarbowy we Wrześni' == PLCommerce::IRCodes.get_ir_code_dsc(369));
+	end
+
+end

data/test/test_nip.rb

@@ -0,0 +1,66 @@
+require 'test/unit'
+require 'date'
+require 'lib/pl-commerce'
+
+class NipTest < Test::Unit::TestCase
+	#def setup
+	#end
+
+	#def teardown
+	#end
+
+	def test_nip1
+		n = PLCommerce::Nip.new('362-398-12-30');
+		assert(n.valid?, 'Nip should be valid');
+		assert(n.ir_code == 362, 'IR code should be 362');
+		assert(n.ir_code_desc == 'Urząd Skarbowy Poznań-Nowe Miasto', 'Should not be null');
+	end
+
+	def test_nip2
+		n = PLCommerce::Nip.new('123-456-32-18');
+		assert(n.valid?, 'NIP should be valid');
+		assert(n.to_s == '1234563218');
+		assert(n.ir_code_desc == 'Urząd Skarbowy w Piasecznie', 'Should not be null');
+	end
+
+	def test_nip3
+		n = PLCommerce::Nip.new('120-456-33-17');
+		assert(!n.valid?, 'NIP should not be valid');
+	end
+
+	def test_nip4
+		n = PLCommerce::Nip.new('1234563218');
+		assert(n.valid?, 'NIP should be valid');
+	end
+
+	def test_nip5
+		n = PLCommerce::Nip.new(' 1 2 3 4 5 6 3 2 1 8');
+		assert(n.valid?, 'NIP should be valid');
+		assert(n.to_s == '1234563218');
+	end
+
+	def test_nip6
+		n = PLCommerce::Nip.new('123-4 5 6 3 2-18');
+		assert(n.valid?, 'NIP should be valid');
+		assert(n.to_s == '1234563218');
+	end
+
+	def test_nip7
+		n = PLCommerce::Nip.new(1234563218);
+		assert(n.valid?, 'NIP should be valid');
+		assert(n.to_s == '1234563218');
+	end
+
+	def test_nip8
+		n = PLCommerce::Nip.new('123456321x', :lenient => true);
+		assert(n.valid? == false, 'NIP should be invalid');
+	end
+
+	def test_nip9
+		n = PLCommerce::Nip.new('362', :lenient => true);
+		assert(n.valid? == false, 'NIP should be invalid');
+		assert(n.ir_code == 362);
+		assert(n.ir_code_desc == 'Urząd Skarbowy Poznań-Nowe Miasto');
+	end
+
+end

data/test/test_pesel.rb

@@ -0,0 +1,137 @@
+require 'test/unit'
+require 'date'
+require 'lib/pl-commerce'
+
+class PeselTest < Test::Unit::TestCase
+	#def setup
+	#end
+
+	#def teardown
+	#end
+
+	def test_pesel1
+		p = PLCommerce::Pesel.new('49040501580');
+		assert(p.valid?, 'Pesel should be valid');
+		assert(p.female?, 'Should be female');
+		assert(p.sex == 'F', 'Should be F');
+		assert(p.dob == Date.new(1949, 4, 5), 'Date should match');
+		assert(p.to_s == '49040501580', 'to_s method should return pesel');
+	end
+
+	def test_pesel2
+		p = PLCommerce::Pesel.new('79082203573');
+		assert(p.valid?, 'Pesel should be valid');
+		assert(p.male?, 'Should be male');
+		assert(p.sex == 'M', 'Should be M');
+		assert(p.dob == Date.new(1979, 8, 22), 'Date should match');
+	end
+
+	def test_pesel2a
+		p = PLCommerce::Pesel.new(79082203573);
+		assert(p.valid?, 'Pesel should be valid');
+		assert(p.male?, 'Should be male');
+		assert(p.sex == 'M', 'Should be M');
+		assert(p.dob == Date.new(1979, 8, 22), 'Date should match');
+	end
+
+	def test_pesel3
+		p = PLCommerce::Pesel.new('76101105382');
+		assert(p.valid?, 'Pesel should be valid');
+		assert(p.female?, 'Should be female');
+		assert(p.sex == 'F', 'Should be F');
+		assert(p.dob == Date.new(1976, 10, 11), 'Date should match');
+	end
+
+	def test_pesel3a
+		p = PLCommerce::Pesel.new('7 6 1 0 1 1 0 5 3 8 2');
+		assert(p.valid?, 'Pesel should be valid');
+		assert(p.female?, 'Should be female');
+		assert(p.sex == 'F', 'Should be F');
+		assert(p.dob == Date.new(1976, 10, 11), 'Date should match');
+		assert(p.to_s == '76101105382', 'to string method should return pesel');
+	end
+
+	def test_pesel4
+		p = PLCommerce::Pesel.new('76101105381');
+		assert(!p.valid?, 'Pesel should be invalid');
+		begin
+			assert(p.female?, 'Should be female');
+			assert(false, 'should not happen');
+		rescue Exception => e
+        end
+
+		begin
+			assert(p.sex == 'F', 'Should be F');
+			assert(false, 'should not happen');
+		rescue Exception => e
+        end
+
+		begin
+			assert(p.dob == Date.new(1976, 10, 11));
+			assert(false, 'should not happen');
+		rescue Exception => e
+		end
+	end
+
+	def test_pesel5
+		p = PLCommerce::Pesel.new('4904050158x', :lenient => true);
+		assert(p.valid? == false, 'Pesel should be invalid');
+		assert(p.dob == Date.new(1949, 4, 5), 'Date should match even pesel is invalid');
+		assert(p.female?, 'We should be able to find out that it is female');
+	end
+
+	def test_pesel6
+		p = PLCommerce::Pesel.new('', :lenient => true);
+		assert(p.valid? == false, 'Pesel should be invalid');
+		assert(p.sex == '?', 'We have no idea of sex');
+		assert(p.female? == false, 'We have no idea of sex');
+		assert(p.male? == false, 'We have no idea of sex');
+	end
+
+	def test_pesel7
+		p = PLCommerce::Pesel.new('790822', :lenient => true);
+		assert(p.valid? == false, 'Pesel should be invalid');
+		assert(p.sex == '?', 'We have no idea of sex');
+		assert(p.female? == false, 'We have no idea of sex');
+		assert(p.male? == false, 'We have no idea of sex');
+		assert(p.dob == Date.new(1979, 8, 22), 'Date should match, enough date fields');
+	end
+
+	def test_pesel8
+      p = PLCommerce::Pesel.new('79082', :lenient => true);
+   	  assert(p.valid? == false, 'Pesel should be invalid');
+   	  assert(p.sex == '?', 'We have no idea of sex');
+   	  assert(p.female? == false, 'We have no idea of sex');
+   	  assert(p.male? == false, 'We have no idea of sex');
+	  assert(p.dob == '?', 'Not enough of date fields');
+	end
+
+	def test_pesel9
+      p = PLCommerce::Pesel.new('49240501586');
+	  assert(p.valid?, 'Pesel should be valid');
+	  assert(p.female?, 'Should be female');
+	  assert(p.sex == 'F', 'Should be F');
+	  assert(p.dob == Date.new(2049, 4, 5), 'Date should match');
+	  assert(p.to_s == '49240501586', 'to_s method should return pesel');
+	end
+
+    #year 2149
+	def test_pesel10
+      p = PLCommerce::Pesel.new('49440501582');
+	  assert(p.valid?, 'Pesel should be valid');
+	  assert(p.female?, 'Should be female');
+	  assert(p.sex == 'F', 'Should be F');
+	  assert(p.dob == Date.new(2149, 4, 5), 'Date should match');
+	  assert(p.to_s == '49440501582', 'to_s method should return pesel');
+	end
+
+	def test_pesel11
+      p = PLCommerce::Pesel.new('49520501583');
+	  assert(p.valid?, 'Pesel should be valid');
+	  assert(p.female?, 'Should be female');
+	  assert(p.sex == 'F', 'Should be F');
+	  assert(p.dob == Date.new(2149, 12, 5), 'Date should match');
+	  assert(p.to_s == '49520501583', 'to_s method should return pesel');
+	end
+
+end