tin_valid 1.1.1 → 1.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0dc6696e709037b0b4366b05c398e951cfb291691eb732412dd2091e7f17f025
-  data.tar.gz: 0cbf922fa63b254934f39fd978d0037824acc54363ce0fa88fc98d3e6c87525d
+  metadata.gz: 3fb98f7f433b3c6a6755c0caa0835c75ed58408fee17ee0e96a083603fd965d5
+  data.tar.gz: 2eb697ac67268456c7cd8ff346144b3cbbfcb2b4bbff8052065ad6b7789b0d15
 SHA512:
-  metadata.gz: e48fccc3f431949c165d4aaab617bf6ef6a13e58e5e41484ef14a05766e07f424a4b1da5dc9b229839685baf52219d160012541ac46a7517d870cd4b1e95c88a
-  data.tar.gz: 00b6226d2e85cb1371fc67792bcdc51d491ee7174faf76837b9a931a98af3754a4af079732dd259c6f9321f604d5148e655955496507556a96994a94462df590
+  metadata.gz: ea7cd37992f808250a153fa5be6728489438136701318e8397d1822512efaddfd8ed395534cdc0e62f8523f9ec225cb151f37409ea741accdcd8c233e7858e5f
+  data.tar.gz: 91eefad78dd3d3219cb7e4add5b5022cd72f62e09a7d6fa5b8b9279e60e165a7620ca2ab25fe4ccb94da5b629f6251e814aeeff0007399830b275be3b99e5ce7

data/.rubocop.yml

@@ -12,6 +12,7 @@ Layout/LineLength:
   Max: 80
   Exclude:
     - bin/rspec
+    - bin/rake
 
 Layout/MultilineMethodCallIndentation:
   # On multiline calls, indent starting from the receiver.
@@ -33,6 +34,13 @@ Metrics/BlockLength:
   Exclude:
     - spec/**/*
 
+# Security
+
+Security/Eval:
+  # Allow the use of `eval` in specs.
+  Exclude:
+    - spec/**/*
+
 # Style
 
 Style/Documentation:

data/CHANGELOG.md

@@ -1,5 +1,20 @@
 ## [Unreleased]
 
+## [1.2.0] - 2025-05-14
+
+Features:
+- Add generic `TinValid::Tin.new(country_code: "…", tin: "…").valid?`
+- Add `#siren?` and `#siret?` on `TinValid::FranceTin`
+
+Fixes:
+- Accept SIRET for France
+
+## [1.1.2] - 2025-05-06
+
+Fixes:
+- Fix Luxembourg check
+- Accept SIREN for France
+
 ## [1.1.1] - 2025-04-28
 
 Fixes:

data/README.md

@@ -31,8 +31,11 @@ Validate Tax Identification Numbers (TINs) for the following European countries:
 - Sweden 🇸🇪
 - United Kingdom 🇬🇧
 
-See also the [descriptions of the structure provided by the European
-Union](https://taxation-customs.ec.europa.eu/online-services/online-services-and-databases-taxation/taxpayer-identification-number-tin_en).
+See also the
+[TIN specifications](https://ec.europa.eu/taxation_customs/tin/#/check-tin)
+and the
+[descriptions of the structure](https://taxation-customs.ec.europa.eu/online-services/online-services-and-databases-taxation/taxpayer-identification-number-tin_en)
+provided by the European Union.
 
 ## Installation
 
@@ -51,117 +54,287 @@ gem install tin_valid
 
 ## Usage
 
+Check a TIN by providing the country code as a lowercase string.
+
+Also accepts the following optional arguments:
+
+- `birth_date`: Date
+- `kind`: `"individual"` or `"company"`
+
 ```rb
-# Austria
-TinValid::AustriaTin.new(tin: "…").valid? # => true
+TinValid::Tin.new(country_code: "fr", tin: "3023217600053").valid?
+```
 
-# Belgium
-# Optional birth_date
-TinValid::BelgiumTin.new(tin: "…", birth_date: Date.new(…)).valid?
+You can also call countries individually:
 
-# Bulgaria
-# Optional birth_date
-TinValid::BulgariaTin.new(tin: "…", birth_date: Date.new(…)).valid?
+### Austria (at)
 
-# Croatia
-TinValid::CroatiaTin.new(tin: "…").valid?
+```rb
+TinValid::AustriaTin.new(
+  tin: "931736581",
+).valid?
+```
 
-# Cyprus
-# Optional kind ("individual" or "company")
-TinValid::CyprusTin.new(tin: "…", kind: "individual").valid?
+### Belgium (be)
 
-# Czechia
-# Optional birth_date
-TinValid::CzechiaTin.new(tin: "…", birth_date: Date.new(…)).valid?
+`birth_date` is optional
 
-# Denmark
-# Optional birth_date
-TinValid::DenmarkTin.new(tin: "…", birth_date: Date.new(…)).valid?
+```rb
+TinValid::BelgiumTin.new(
+  tin: "00012511119",
+  birth_date: Date.new(1900, 1, 25),
+).valid?
+```
 
-# Estonia
-# Optional birth_date
-TinValid::EstoniaTin.new(tin: "…", birth_date: Date.new(…)).valid?
+### Bulgaria (bg)
 
-# Finland
-# Optional birth_date
-TinValid::FinlandTin.new(tin: "…", birth_date: Date.new(…)).valid?
+`birth_date` is optional
 
-# France
-TinValid::FranceTin.new(tin: "…").valid?
+```rb
+TinValid::BulgariaTin.new(
+  tin: "7501010010",
+  birth_date: Date.new(1975, 1, 1),
+).valid?
+```
 
-# Germany
-TinValid::GermanyTin.new(tin: "…").valid?
+### Croatia (hr)
 
-# Greece
-TinValid::GreeceTin.new(tin: "…").valid?
+```rb
+TinValid::CroatiaTin.new(
+  tin: "94577403194",
+).valid?
+```
 
-# Hungary
-TinValid::HungaryTin.new(tin: "…").valid?
+### Cyprus (cy)
 
-# Ireland
-TinValid::IrelandTin.new(tin: "…").valid?
+`kind` is optional and can be `"individual"` or `"company"`
 
-# Italy
-# Optional birth_date
-TinValid::ItalyTin.new(tin: "…", birth_date: Date.new(…)).valid?
+```rb
+TinValid::CyprusTin.new(tin: "00123123T", kind: "individual").valid?
+```
 
-# Latvia
-# Optional birth_date
-TinValid::LatviaTin.new(tin: "…", birth_date: Date.new(…)).valid?
+### Czechia (cz)
 
-# Lithuania
-# Optional birth_date
-TinValid::LithuaniaTin.new(tin: "…", birth_date: Date.new(…)).valid?
+`birth_date` is optional
 
-# Luxembourg
-# Optional birth_date
-TinValid::LuxembourgTin.new(tin: "…", birth_date: Date.new(…)).valid?
+```rb
+TinValid::CzechiaTin.new(
+  tin: "420901999",
+  birth_date: Date.new(1942, 9, 1),
+).valid?
+```
+
+### Denmark (dk)
 
-# Malta
-TinValid::MaltaTin.new(tin: "…").valid?
+`birth_date` is optional
 
-# Netherlands
-TinValid::NetherlandsTin.new(tin: "…").valid?
+```rb
+TinValid::DenmarkTin.new(
+  tin: "0101111113",
+  birth_date: Date.new(1911, 1, 1),
+).valid?
+```
 
-# Poland
-# Optional birth_date
-TinValid::PolandTin.new(tin: "…", birth_date: Date.new(…)).valid?
+### Estonia (ee)
 
-# Portugal
-TinValid::PortugalTin.new(tin: "…").valid?
+`birth_date` is optional
+
+```rb
+TinValid::EstoniaTin.new(
+  tin: "37102250382",
+  birth_date: Date.new(1971, 2, 25),
+).valid?
+```
 
-# Romania
-# Optional birth_date
-TinValid::RomaniaTin.new(tin: "…", birth_date: Date.new(…)).valid?
+### Finland (fi)
 
-# Slovakia
-# Optional birth_date
-TinValid::SlovakiaTin.new(tin: "…", birth_date: Date.new(…)).valid?
+`birth_date` is optional
 
-# Slovenia
-TinValid::SloveniaTin.new(tin: "…").valid?
+```rb
+TinValid::FinlandTin.new(
+  tin: "131052-308T",
+  birth_date: Date.new(1952, 10, 13),
+).valid?
+```
 
-# Spain
-TinValid::SpainTin.new(tin: "…").valid?
+### France (fr)
 
-# Sweden
-# Optional birth_date
-TinValid::SwedenTin.new(tin: "…", birth_date: Date.new(…)).valid?
+```rb
+TinValid::FranceTin.new(tin: "3023217600053").valid?
+```
 
-# United Kingdom
-TinValid::UnitedKingdomTin.new(tin: "…").valid?
+```rb
+TinValid::FranceTin.new(tin: "732829320").siren?
+```
+
+```rb
+TinValid::FranceTin.new(tin: "73282932000074").siret?
+```
+
+### Germany (de)
+
+```rb
+TinValid::GermanyTin.new(tin: "5133081508159").valid?
+```
+
+### Greece (gr)
+
+```rb
+TinValid::GreeceTin.new(tin: "999999999").valid?
+```
+
+### Hungary (hu)
+
+```rb
+TinValid::HungaryTin.new(tin: "8071592153").valid?
+```
+
+### Ireland (ie)
+
+```rb
+TinValid::IrelandTin.new(tin: "1234567T").valid?
+```
+
+### Italy (it)
+
+`birth_date` is optional
+
+```rb
+TinValid::ItalyTin.new(
+  tin: "DMLPRY77D15H501F",
+  birth_date: Date.new(1977, 4, 15),
+).valid?
+```
+
+### Latvia (lv)
+
+`birth_date` is optional
+
+```rb
+TinValid::LatviaTin.new(
+  tin: "01011012345",
+  birth_date: Date.new(1910, 1, 1),
+).valid?
+```
+
+### Lithuania (lt)
+
+`birth_date` is optional
+
+```rb
+TinValid::LithuaniaTin.new(
+  tin: "10101010005",
+  birth_date: Date.new(2001, 1, 1),
+).valid?
+```
+
+### Luxembourg (lu)
+
+`birth_date` is optional
+
+```rb
+TinValid::LuxembourgTin.new(
+  tin: "1893120105732",
+  birth_date: Date.new(1893, 12, 1),
+).valid?
+```
+
+### Malta (mt)
+
+```rb
+TinValid::MaltaTin.new(tin: "1234567A").valid?
+```
+
+### Netherlands (nl)
+
+```rb
+TinValid::NetherlandsTin.new(tin: "174559434").valid?
+```
+
+### Poland (pl)
+
+`birth_date` is optional
+
+```rb
+TinValid::PolandTin.new(
+  tin: "02070803628",
+  birth_date: Date.new(1902, 7, 8),
+).valid?
+```
+
+### Portugal (pt)
+
+```rb
+TinValid::PortugalTin.new(tin: "299999998").valid?
+```
+
+### Romania (ro)
+
+`birth_date` is optional
+
+```rb
+TinValid::RomaniaTin.new(
+  tin: "8001011234567",
+  birth_date: Date.new(2000, 10, 11),
+).valid?
+```
+
+### Slovakia (sk)
+
+`birth_date` is optional
+
+```rb
+TinValid::SlovakiaTin.new(
+  tin: "7711167420",
+  birth_date: Date.new(1977, 11, 16),
+).valid?
+```
+
+### Slovenia (si)
+
+```rb
+TinValid::SloveniaTin.new(tin: "15012557").valid?
+```
+
+### Spain (es)
+
+```rb
+TinValid::SpainTin.new(tin: "54237A").valid?
+```
+
+### Sweden (se)
+
+`birth_date` is optional
+
+```rb
+TinValid::SwedenTin.new(
+  tin: "640823-3234",
+  birth_date: Date.new(1964, 8, 23),
+).valid?
+```
+
+### United Kingdom (gb)
+
+```rb
+TinValid::UnitedKingdomTin.new(tin: "9234567890").valid?
 ```
 
 ## Development
 
 After checking out the repo, run `bin/setup` to install dependencies. Then, run
-`rake spec` to run the tests. You can also run `bin/console` for an interactive
+`bin/rspec` to run the tests. You can also run `bin/console` for an interactive
 prompt that will allow you to experiment.
 
-To install this gem onto your local machine, run `bundle exec rake install`. To
-release a new version, update the version number in `version.rb`, and then run
-`bundle exec rake release`, which will create a git tag for the version, push
-git commits and the created tag, and push the `.gem` file to
+To install this gem onto your local machine, run `bin/rake install`. To
+release a new version, update the version number in `version.rb`, call `bundle`
+and then create a commit using:
+
+```sh
+git commit -m "v`ruby -r./lib/tin_valid/version <<< 'puts TinValid::VERSION + \" 🎉\"'`"
+```
+
+Finally, call `bin/rake release`, which will create a git tag for the version,
+push git commits and the created tag, and add the `.gem` file to
 [rubygems.org](https://rubygems.org).
 
 ## Contributing

data/lib/tin_valid/france_tin.rb

@@ -1,5 +1,6 @@
 # frozen_string_literal: true
 
+# https://www.economie.gouv.fr/cedef/fiches-pratiques/quest-ce-que-le-nif
 module TinValid
   class FranceTin
     def initialize(tin:)
@@ -8,21 +9,48 @@ module TinValid
 
     attr_reader :tin
 
-    def valid?
-      return false unless /\A[0-3][0-9]{12}\z/.match?(tin)
-      return false if tin == "0000000000000"
+    def valid? = valid_v1? || siren? || siret?
 
-      tin[-3..].to_i == check
+    # https://fr.wikipedia.org/wiki/Syst%C3%A8me_d%27identification_du_r%C3%A9pertoire_des_entreprises
+    def siren?
+      return false unless /\A[1-9][0-9]{8}\z/.match?(tin)
+      return false if tin == "123456789"
+
+      luhn_valid?
+    end
+
+    # https://fr.wikipedia.org/wiki/Syst%C3%A8me_d%27identification_du_r%C3%A9pertoire_des_%C3%A9tablissements
+    def siret?
+      return false unless /\A\d{14}\z/.match?(tin)
+      return false if tin == "00000000000000"
+
+      luhn_valid?
     end
 
     private
 
-    def check
+    def valid_v1?
+      return false unless /\A[0-3][0-9]{12}\z/.match?(tin)
+      return false if tin == "0000000000000"
+
+      tin[-3..].to_i == v1_check
+    end
+
+    def v1_check
       # 1. Concatenate C1, C2, C3, C4, C5, C6, C7, C8, C9, C10;
       # 2. Get modulo 511 of the result of the previous result;
       # 3. Check digit = remainder if remainder < 100, C11 = 0
       # (if remainder < 10, C11 = 0 and C12 = 0).
       tin[..-4].to_i % 511
     end
+
+    # https://en.wikipedia.org/wiki/Luhn_algorithm
+    def luhn_valid?
+      check = tin.chars.reverse.each_slice(2).sum do |a, b|
+        a.to_i + (b.to_i * 2).to_s.chars.sum(&:to_i)
+      end
+
+      check % 10 == 0
+    end
   end
 end

data/lib/tin_valid/luxembourg_tin.rb

@@ -95,7 +95,7 @@ module TinValid
       [0, 1, 2, 3, 4, 5, 6, 7, 8, 9],
       [1, 5, 7, 6, 2, 8, 3, 0, 9, 4],
       [5, 8, 0, 3, 7, 9, 6, 1, 4, 2],
-      [8, 9, 1, 6, 0, 5, 3, 5, 2, 7],
+      [8, 9, 1, 6, 0, 4, 3, 5, 2, 7],
       [9, 4, 5, 3, 1, 2, 6, 8, 7, 0],
       [4, 2, 8, 6, 5, 7, 3, 9, 0, 1],
       [2, 7, 9, 3, 8, 0, 6, 4, 1, 5],

data/lib/tin_valid/tin.rb

@@ -0,0 +1,55 @@
+# frozen_string_literal: true
+
+module TinValid
+  class Tin
+    def initialize(country_code:, tin:, birth_date: nil, kind: nil)
+      @country_code = country_code
+      @tin = tin
+      @birth_date = birth_date
+      @kind = kind
+    end
+
+    attr_reader :country_code, :tin, :birth_date, :kind
+
+    # rubocop:disable Metrics/AbcSize
+    # rubocop:disable Metrics/CyclomaticComplexity
+    # rubocop:disable Metrics/PerceivedComplexity
+    # rubocop:disable Metrics/MethodLength
+    def valid?
+      case country_code
+      in "at" then AustriaTin.new(tin:).valid?
+      in "be" then BelgiumTin.new(tin:, birth_date:).valid?
+      in "bg" then BulgariaTin.new(tin:, birth_date:).valid?
+      in "cy" then CyprusTin.new(tin:, kind:).valid?
+      in "cz" then CzechiaTin.new(tin:, birth_date:).valid?
+      in "de" then GermanyTin.new(tin:).valid?
+      in "dk" then DenmarkTin.new(tin:, birth_date:).valid?
+      in "ee" then EstoniaTin.new(tin:, birth_date:).valid?
+      in "es" then SpainTin.new(tin:).valid?
+      in "fi" then FinlandTin.new(tin:).valid?
+      in "fr" then FranceTin.new(tin:).valid?
+      in "gb" then UnitedKingdomTin.new(tin:).valid?
+      in "gr" then GreeceTin.new(tin:).valid?
+      in "hr" then CroatiaTin.new(tin:).valid?
+      in "hu" then HungaryTin.new(tin:).valid?
+      in "ie" then IrelandTin.new(tin:).valid?
+      in "it" then ItalyTin.new(tin:, birth_date:).valid?
+      in "lt" then LithuaniaTin.new(tin:, birth_date:).valid?
+      in "lu" then LuxembourgTin.new(tin:, birth_date:).valid?
+      in "lv" then LatviaTin.new(tin:, birth_date:).valid?
+      in "mt" then MaltaTin.new(tin:).valid?
+      in "nl" then NetherlandsTin.new(tin:).valid?
+      in "pl" then PolandTin.new(tin:, birth_date:).valid?
+      in "pt" then PortugalTin.new(tin:).valid?
+      in "ro" then RomaniaTin.new(tin:, birth_date:).valid?
+      in "se" then SwedenTin.new(tin:, birth_date:).valid?
+      in "si" then SloveniaTin.new(tin:).valid?
+      in "sk" then SlovakiaTin.new(tin:).valid?
+      end
+    end
+    # rubocop:enable Metrics/AbcSize
+    # rubocop:enable Metrics/CyclomaticComplexity
+    # rubocop:enable Metrics/PerceivedComplexity
+    # rubocop:enable Metrics/MethodLength
+  end
+end

data/lib/tin_valid/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module TinValid
-  VERSION = "1.1.1"
+  VERSION = "1.2.0"
 end

data/lib/tin_valid.rb

@@ -3,6 +3,7 @@
 require "date"
 require_relative "tin_valid/version"
 require_relative "tin_valid/helpers"
+require_relative "tin_valid/tin"
 require_relative "tin_valid/austria_tin"
 require_relative "tin_valid/belgium_tin"
 require_relative "tin_valid/bulgaria_tin"

metadata

@@ -1,13 +1,13 @@
 --- !ruby/object:Gem::Specification
 name: tin_valid
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.2.0
 platform: ruby
 authors:
 - Sunny Ripert
 bindir: exe
 cert_chain: []
-date: 2025-04-28 00:00:00.000000000 Z
+date: 2025-05-14 00:00:00.000000000 Z
 dependencies: []
 email:
 - sunny@sunfox.org
@@ -51,6 +51,7 @@ files:
 - lib/tin_valid/slovenia_tin.rb
 - lib/tin_valid/spain_tin.rb
 - lib/tin_valid/sweden_tin.rb
+- lib/tin_valid/tin.rb
 - lib/tin_valid/united_kingdom_tin.rb
 - lib/tin_valid/version.rb
 - sig/tin_valid.rbs