thai_id_utils 0.1.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: d9194c3362b9038193a979c13e0d7723bb0c6f0c3ce41ff17523086ef8a04672
+  data.tar.gz: dac42ef970424a31999019dc4c3d8d1fa5c5739c55427440906e118d4c2cecba
+SHA512:
+  metadata.gz: c3f92740ba6ac0700b5cddb7abdc23a74cdc759a822a14936a1a36acbd43e021ad42f395889ec09d4db5cf3ed1f641599d454d1b8eb4cc17756365f26f853ab9
+  data.tar.gz: 49bbfa319256583fd8156cea558995d2d555e17352b0391830046ff78cdb90034306c9cf5cb0d5eacf13195380d61c3196e14d7d7d27f38b266195b04c67240c

data/Gemfile

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+gemspec

data/README.md

@@ -0,0 +1,33 @@
+# Thai ID Utils
+
+Thai ID Utils is a zero-dependency Ruby gem for validating and decoding Thai national ID numbers. It provides a simple API to check the official modulus-11 checksum, extract the embedded components (category, office code, district code, sequence), and get a human-readable description of the category code.
+ 
+Thai ID Utils เป็น Ruby gem ที่ไม่ต้องพึ่งพาไลบรารีเสริม สำหรับตรวจสอบความถูกต้องและถอดรหัสหมายเลขบัตรประชาชนไทย โดยมี API ที่ใช้งานง่ายสำหรับตรวจสอบ checksum ตามมาตรฐาน modulus-11 ดึงส่วนประกอบต่างๆ (ประเภทผู้ลงทะเบียน รหัสหน่วยงาน รหัสอำเภอ และหมายเลขลำดับ) และแสดงคำอธิบายของรหัสประเภทในรูปแบบอ่านง่าย
+
+## Usage / วิธีใช้งาน
+
+```ruby
+require "thai_id_utils"
+
+id = "3012304567082"
+
+# ✅ Validate checksum
+if ThaiIdUtils.valid?(id)
+  puts "Valid!"
+else
+  puts "Invalid ID"
+end
+
+# 🔍 Decode components
+info = ThaiIdUtils.decode(id)
+# => { category: 1, office_code: "6099", district_code: "99", sequence: "00257" }
+puts info.inspect
+
+# 🏷️ Get category description
+desc = ThaiIdUtils.category_description(info[:category])
+# => "Thai nationals who were born after 1 January 1984 and had their birth notified within the given deadline (15 days)."
+puts desc
+
+# 🎲 Generate a new random valid ID
+new_id = ThaiIdUtils.generate
+puts new_id  # => e.g. "3601205234518"

data/Rakefile

@@ -0,0 +1,9 @@
+# frozen_string_literal: true
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+end
+
+task default: :test

data/lib/thai_id_utils/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module ThaiIdUtils
+  VERSION = '0.1.1'
+end

data/lib/thai_id_utils.rb

@@ -0,0 +1,89 @@
+# frozen_string_literal: true
+
+# ThaiIdUtils: Validate and decode Thai national ID numbers,
+# providing checksum validation, component decoding, ID generation,
+# and human-readable category descriptions.
+module ThaiIdUtils
+  class InvalidIDError < StandardError; end
+
+  # ----------------------------------------------------------------------------
+  # Mapping of category codes to their descriptions
+  # ----------------------------------------------------------------------------
+  # rubocop:disable Layout/LineLength
+  CATEGORY_DESCRIPTIONS = {
+    0 => '(Not found on cards of Thai nationals but may be found in the other issued identity cards below)',
+    1 => 'Thai nationals who were born after 1 January 1984 and had their birth notified within the given deadline (15 days).',
+    2 => 'Thai nationals who were born after 1 January 1984 but failed to have their birth notified in time.',
+    3 => 'Thai nationals or foreign nationals with identification cards who were born and whose names were included in a house registration book before 1 January 1984',
+    4 => 'Thai nationals who were born before 1 January 1984 but were not included in a house registration book at that time, for example due to moving residences',
+    5 => 'Thai nationals who missed the official census or other special cases, for instance those of dual nationality',
+    6 => 'Foreign nationals who are living in Thailand temporarily and illegal migrants',
+    7 => 'Children of people of category 6 who were born in Thailand',
+    8 => 'Foreign nationals who are living in Thailand permanently or Thai nationals by naturalization'
+  }.freeze
+  # rubocop:enable Layout/LineLength
+
+  # Public: Validate checksum using Thailand’s modulus-11 algorithm
+  def self.valid?(id)
+    digits = id.to_s.chars.map(&:to_i)
+    return false unless digits.size == 13
+
+    sum = digits[0..11].each_with_index.sum { |d, i| d * (13 - i) }
+    ((11 - (sum % 11)) % 10) == digits.last
+  rescue StandardError
+    false
+  end
+
+  # Public: Decode components present in a Thai ID
+  # Returns a hash with keys:
+  #   :category      => Integer
+  #   :office_code   => String (4-digit registrar)
+  #   :district_code => String (last 2 of office_code)
+  #   :sequence      => String (5-digit personal sequence)
+  def self.decode(id)
+    raise InvalidIDError, 'Invalid ID' unless valid?(id)
+
+    d = id.to_s.chars
+
+    {
+      category: d[0].to_i,
+      office_code: d[1..4].join,
+      district_code: d[3..4].join,
+      sequence: d[5..9].join
+    }
+  end
+
+  # Public: Generate a random, valid 13-digit Thai national ID.
+  # You can override any component or let it be randomized.
+  # rubocop:disable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+  def self.generate(category: rand(1..6),
+                    office_code: nil,
+                    district_code: nil,
+                    sequence: nil)
+    # Build and override office_code/district_code
+    office_code = format('%04d', office_code || rand(1..9_999))
+    office_code[2..3] = district_code.to_s.rjust(2, '0') if district_code
+
+    # Sequence (5 digits) and classification (2 digits)
+    sequence       = format('%05d', sequence || rand(0..99_999))
+    classification = format('%02d', rand(0..99))
+
+    # First 12 digits: category + office_code + sequence + classification
+    digits = [category.to_i] +
+             office_code.chars.map(&:to_i) +
+             sequence.chars.map(&:to_i) +
+             classification.chars.map(&:to_i)
+
+    # Checksum
+    sum = digits.each_with_index.sum { |d, i| d * (13 - i) }
+    check = (11 - (sum % 11)) % 10
+
+    (digits + [check]).join
+  end
+  # rubocop:enable Metrics/AbcSize, Metrics/CyclomaticComplexity, Metrics/MethodLength
+
+  # Public: Return a human-readable description for a category code
+  def self.category_description(category)
+    CATEGORY_DESCRIPTIONS[category.to_i] || 'Unknown category'
+  end
+end

metadata

@@ -0,0 +1,67 @@
+--- !ruby/object:Gem::Specification
+name: thai_id_utils
+version: !ruby/object:Gem::Version
+  version: 0.1.1
+platform: ruby
+authors:
+- Chayut Orapinpatipat
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2025-06-15 00:00:00.000000000 Z
+dependencies:
+- !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'
+description: |
+  Zero-dependency Ruby utilities for:
+    • checksum validation (modulus-11),
+    • component decoding (category, office_code, district_code, sequence),
+    • random valid ID generation,
+    • human-readable category descriptions.
+email:
+- chayut_o@hotmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- Gemfile
+- README.md
+- Rakefile
+- lib/thai_id_utils.rb
+- lib/thai_id_utils/version.rb
+homepage: https://github.com/chayuto/thai-id-utils
+licenses:
+- MIT
+metadata: {}
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.7'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.5.11
+signing_key:
+specification_version: 4
+summary: Validate and decode Thai national ID numbers
+test_files: []