id_validator 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 4ab0ebe883bfc647be492fdbc4fd3b80e35a4a33e2a9f3d9a97802ac4e8e99c4
+  data.tar.gz: 84e81d6823a9aaf1ed12ffa4d1ecb0a35d54ea4c46a96a1aaf46dabb608ba280
+SHA512:
+  metadata.gz: 35bc2b3ba1e7deb4d2340d9ad83cbf1e924a5e06917ca77f2e1cb9660ec8c1d3648a68a230955b9ebeb3a1ec56e5adcbfcba6444453a02f4b74efc512ed96938
+  data.tar.gz: 0f77b4441b862d41b6f55d5b9bfc6801d39f986c8273ca1559fff747e849020a1a8bab19dca7481882bd385095c78a76d0d6ee6ea4b934601dcdf8274d2e5113

data/.gitignore

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

data/.idea/vcs.xml

@@ -0,0 +1,6 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<project version="4">
+  <component name="VcsDirectoryMappings">
+    <mapping directory="$PROJECT_DIR$" vcs="Git" />
+  </component>
+</project>

data/.travis.yml

@@ -0,0 +1,12 @@
+sudo: false
+language: ruby
+rvm:
+  - 2.5.1
+  - 2.4.4
+  - 2.3.6
+before_install:
+  - gem install bundler
+
+install:
+  - bundle install
+

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+* Using welcoming and inclusive language
+* Being respectful of differing viewpoints and experiences
+* Gracefully accepting constructive criticism
+* Focusing on what is best for the community
+* Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+* The use of sexualized language or imagery and unwelcome sexual attention or
+advances
+* Trolling, insulting/derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at lanyuejin1108@gmail.com. All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

data/Gemfile

@@ -0,0 +1,6 @@
+source "https://rubygems.org"
+
+git_source(:github) {|repo_name| "https://github.com/#{repo_name}" }
+
+# Specify your gem's dependencies in id_validator.gemspec
+gemspec

data/Gemfile.lock

@@ -0,0 +1,22 @@
+PATH
+  remote: .
+  specs:
+    id_validator (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    minitest (5.11.3)
+    rake (10.5.0)
+
+PLATFORMS
+  ruby
+
+DEPENDENCIES
+  bundler (~> 1.16)
+  id_validator!
+  minitest (~> 5.0)
+  rake (~> 10.0)
+
+BUNDLED WITH
+   1.16.1

data/README.md

@@ -0,0 +1,122 @@
+[![Build Status](https://travis-ci.com/renyijiu/id_validator.svg?branch=master)](https://travis-ci.com/renyijiu/id_validator)
+
+
+# IdValidator
+
+**中华人民共和国居民身份证** 、**中华人民共和国港澳居民居住证** 以及 **中华人民共和国台湾居民居住证** 号码验证工具（Ruby
+版）支持 15 位与 18 位号码。
+
+- [JavaScript 版本](https://github.com/mc-zone/IDValidator)
+- [PHP 版本](https://github.com/jxlwqq/id-validator)
+- [Python 版本](https://github.com/jxlwqq/id-validator.py)
+
+## 安装
+
+将下列代码增加到对应项目的Gemfile中：
+
+```ruby
+gem 'id_validator'
+```
+
+然后执行下列命令：
+
+    $ bundle
+
+或者，直接安装对应的gem包使用：
+
+    $ gem install id_validator
+
+## 使用
+
+   `440308199901101512` 和 `610104620927690`
+   
+   示例大陆居民身份证均为随机生成的假数据，如有看雷同，请联系删除。
+ 
+   `810000199408230021` 和 `830000199201300022`
+ 
+   示例港澳台居民居住证为北京市公安局公布的居住证样式号码。
+   
+### 验证身份证合法性
+
+验证身份证合法性，合法返回 `true`, 不合法返回 `false`
+
+```ruby
+IdValidator.is_valid?('440308199901101512') # => true, 大陆居民身份证 18 位
+IdValidator.is_valid?('610104620927690')    # => true, 大陆居民身份证 15 位
+IdValidator.is_valid?('810000199408230021') # => true, 港澳居民身份证 18 位
+IdValidator.is_valid?('830000199201300022') # => true, 台湾居民身份证 18 位
+```
+
+### 获取身份证号信息
+
+当身份证号合法时，返回分析信息（地区、出生日期、星座、生肖、性别、校验码），不合法时返回 `false`
+
+
+```ruby
+
+IdValidator.get_info('440308199901101512') # 大陆居民身份证 18 位
+IdValidator.get_info('610104620927690')    # 大陆居民身份证 15 位
+
+```
+返回信息格式如下：
+
+```ruby
+{
+    :address_code => "440308",         # 地址码
+    :address => "广东省深圳市盐田区",      # 地址信息
+    :abandoned => false,               # 地址码是否已经废弃
+    :birthday_code => "1999-01-10",    # 出生日期
+    :constellation => "摩羯座",         # 星座
+    :chinese_zodiac => "卯兔",          # 生肖 
+    :sex => 1,                         # 性别，0：女性，1：男性
+    :length => 18,                     # 号码长度 
+    :check_bit=>"2"                    # 校验码
+}
+```
+ 
+> 注：判断地址码是否废弃的依据是[中华人民共和国行政区划代码历史数据集](https://github.com/jxlwqq/address-code-of-china) ，本数据集的采集源来自：[中华人民共和国民政部](http://www.mca.gov.cn/article/sj/xzqh//1980/) ，每年更新一次。本数据集采用 csv 格式存储，方便大家进行数据分析或者开发其他语言的版本。
+
+### 生成可通过校验的假数据
+
+```ruby
+IdValidator.fake_id(eighteen = true, address = nil, birthday = nil, sex = nil)
+
+IdValidator.fake_id                                      # 18位 身份证
+IdValidator.fake_id(false)                               # 15位 身份证    
+IdValidator.fake_id(true, '上海市')                       # 18位 上海市居民身份证
+IdValidator.fake_id(true, '南山区', '1993')               # 18位 出生于 1993年 广东省深圳市南山区身份证
+IdValidator.fake_id(true, '江苏省', '199301')             # 18位 出生于 1993年01月 江苏省身份证
+IdValidator.fake_id(true, '厦门市', '19930101', 1)        # 18位 出生于 1993年01月01日 福建省厦门市男性身份证
+IdValidator.fake_id(true, '台湾省', '20131010', 0)        # 18位 出生于 2013年10月10日 台湾省女性身份证
+IdValidator.fake_id(true, '香港特别行政区', '20131010', 0)  # 18位 出生于 2013年10月10日 香港特别行政区女性身份证
+```
+
+### 身份证升级
+
+15 位号码升级为 18 位
+```ruby
+IdValidator.upgrade_id('610104620927690')
+=> "610104196209276908"
+```
+ 
+## 参考资料
+
+- [中华人民共和国公民身份号码](https://zh.wikipedia.org/wiki/中华人民共和国公民身份号码)
+
+- [中华人民共和国民政部：行政区划代码](http://www.mca.gov.cn/article/sj/xzqh/)
+
+- [中华人民共和国行政区划代码历史数据集](https://github.com/jxlwqq/address-code-of-china)
+
+- [国务院办公厅关于印发《港澳台居民居住证申领发放办法》的通知](http://www.gov.cn/zhengce/content/2018-08/19/content_5314865.htm)
+
+- [港澳台居民居住证](https://zh.wikipedia.org/wiki/港澳台居民居住证)
+
+## 如何贡献
+
+1. Fork it
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create new Pull Request
+
+欢迎贡献相关代码或是提交你的使用反馈👏，另外请记得为你的代码编写测试。

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 "id_validator"
+
+# 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(__FILE__)

data/bin/setup

@@ -0,0 +1,8 @@
+#!/usr/bin/env bash
+set -euo pipefail
+IFS=$'\n\t'
+set -vx
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/id_validator.gemspec

@@ -0,0 +1,26 @@
+
+lib = File.expand_path("../lib", __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require "id_validator/version"
+
+Gem::Specification.new do |spec|
+  spec.name          = "id_validator"
+  spec.version       = IdValidator::VERSION
+  spec.authors       = ["renyijiu"]
+  spec.email         = ["lanyuejin1108@gmail.com"]
+
+  spec.summary       = %q{Chinese Mainland Personal ID Card Validation.}
+  spec.description   = %q{A Ruby Gem For Chinese Mainland Personal ID Card Validation}
+  spec.homepage      = "https://github.com/renyijiu/id_validator"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject do |f|
+    f.match(%r{^(test|spec|features)/})
+  end
+  spec.bindir        = "bin"
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "bundler", "~> 1.16"
+  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "minitest", "~> 5.0"
+end

data/lib/id_validator/concern/helper.rb

@@ -0,0 +1,229 @@
+module IdValidator
+  module Concern
+    module Func
+      extend self
+
+      # 检测出生日期, example: '20181015'
+      def check_birthday(birthday)
+        return false if birthday.to_s.length != 8
+        date = Date.parse(birthday.to_s) rescue nil
+
+        return false if date.nil?
+        return false if date.year < 1800 || date > Date.today
+
+        true
+      end
+
+      # 格式化出生日期
+      def format_birthday_code(birthday_code)
+        "#{birthday_code[0..3]}-#{birthday_code[4..5]}-#{birthday_code[6..7]}"
+      end
+
+      # 格式化地址栏
+      def format_address_info(address_info)
+        "#{address_info[:province]}#{address_info[:city]}#{address_info[:district]}"
+      end
+
+      # 随意获取一个符合要求的地址码
+      def get_random_address_code(reg)
+        keys = IdValidator::Config.address_info.keys.shuffle
+
+        keys.find { |key| key.to_s =~ reg }.to_s
+      end
+
+      # 字符串填充
+      def get_str_pad(str, length = 2, character = '0', right = true)
+        str = str.to_s
+        return str if length <= str.length
+
+        frequency = length - str.length
+        right ? (str + character.to_s * frequency) : (character.to_s * frequency + str)
+      end
+
+      # 随机获取一个符合条件的数字
+      def get_random_right_num(num, min, max)
+        return num if (min..max).member?(num)
+
+        rand(min..max)
+      end
+
+      # 随意生成一个生日
+      def get_random_birthday_code
+        Time.at(rand * Time.now.to_i).strftime('%Y%m%d')
+      end
+    end
+
+    module Helper
+      # 获取身份证信息
+      def get_id_argument(id_card)
+        id_card = id_card.to_s.upcase
+
+        if id_card.length == 18
+          {
+              body: id_card[0...17],
+              address_code: id_card[0...6],
+              birthday_code: id_card[6...14],
+              order_code: id_card[14...17],
+              check_bit: id_card[17],
+              type: 18
+          }
+        else
+          {
+              body: id_card,
+              address_code: id_card[0...6],
+              birthday_code: '19' + id_card[6...12],
+              order_code: id_card[12...15],
+              check_bit: '',
+              type: 15
+          }
+        end
+      end
+
+      # 获取地址信息
+      def get_address_info(address_code)
+        address_code_hash = IdValidator::Config.address_info
+        abandoned_address_code_hash = IdValidator::Config.abandoned_address_code
+
+        province_address_code = "#{address_code[0...2]}0000".to_i
+        city_address_code = "#{address_code[0...4]}00".to_i
+
+        province = address_code_hash[province_address_code] || abandoned_address_code_hash[province_address_code]
+
+        if address_code[0].to_i != 8
+          city = address_code_hash[city_address_code] || abandoned_address_code_hash[city_address_code]
+          district = address_code_hash[address_code.to_i] ||abandoned_address_code_hash[address_code.to_i]
+        else
+          city = nil
+          district = nil
+        end
+
+        {
+            province: province,
+            city: city,
+            district: district
+        }
+      end
+
+      # 获取星座信息
+      def get_constellation(birthday_code)
+        date = Date.parse(birthday_code.to_s)
+
+        month = date.month
+        day = date.day
+        constellation = IdValidator::Config.constellation
+
+        start_day = constellation[month][:start_date].split('-').last.to_i
+        if day < start_day
+          tmp_month = month - 1 == 0 ? 12 : month - 1
+
+          constellation[tmp_month][:name]
+        else
+          constellation[month][:name]
+        end
+      end
+
+      # 获取生肖信息
+      def get_chinese_zodiac(birthday_code)
+        # 1900为子鼠
+        index = (birthday_code[0...4].to_i - 1900) % 12
+
+        IdValidator::Config.chinese_zodiac[index]
+      end
+
+      # 检查地址码
+      def check_address_code(address_code)
+        address_info = get_address_info(address_code.to_s)
+        return false if address_info[:province].nil?
+
+        true
+      end
+
+      # 检查出生日期
+      def check_birthday_code(birthday_code)
+        return false unless Func.check_birthday(birthday_code.to_s)
+
+        true
+      end
+
+      # 检查顺序码
+      def check_order_code(order_code)
+        return false if order_code.length != 3
+
+        true
+      end
+
+      # 检查是否已经废弃
+      def check_is_abandoned(address_code)
+        address = IdValidator::Config.abandoned_address_code.fetch(address_code.to_i, nil)
+
+        !address.nil?
+      end
+
+      # 生成校验码
+      def generate_check_bit(body)
+        body = body.to_s.reverse
+        return nil if body.length != 17
+
+        body_sum = 0
+        weight = (2..18).map{ |a| 2**(a - 1) % 11 }
+        weight.each_with_index{ |w, i| body_sum += body[i].to_i * w }
+
+        check_bit = (12 - (body_sum % 11)) % 11
+        check_bit < 10 ? check_bit.to_s : 'X'
+      end
+
+      # 生成地址码
+      def generate_address_code(address)
+        key = IdValidator::Config.address_info.key(address).to_s
+
+        case
+        when key.empty?
+          reg = %r(^\d{4}(?!00)\d{2}$)
+          return Func.get_random_address_code(reg)
+        when key[0] == '8'
+          return key
+        when key =~ /^\d{2}0000$/
+          reg = %r(^#{key[0..1]}\d{2}(?!00)\d{2}$)
+          return Func.get_random_address_code(reg)
+        when key =~ /^\d{4}00$/
+          reg = %r(^#{key[0..3]}(?!00)\d{2}$)
+          return Func.get_random_address_code(reg)
+        else
+          return key.to_s
+        end
+      end
+
+      # 生成生日信息
+      def generate_birthday_code(birthday)
+        return birthday if Func.check_birthday(birthday)
+        birthday = Func.get_str_pad(birthday.to_s, 8)
+
+        year = Func.get_random_right_num(birthday[0..3].to_i, 1900, Time.now.year - 1)
+        month = Func.get_random_right_num(birthday[4..5].to_i, 1, 12)
+        day = Func.get_random_right_num(birthday[6..7], 1, 28)
+
+        year = Func.get_str_pad(year.to_s, 4)
+        month = Func.get_str_pad(month.to_s, 2, '0', false)
+        day = Func.get_str_pad(day.to_s, 2, '0', false)
+        result = year + month + day
+
+        if Func.check_birthday(result)
+          result
+        else
+          Func.get_random_birthday_code
+        end
+      end
+
+      # 生成顺序码
+      def generate_order_code(sex)
+        order_code = rand(1..999)
+
+        order_code = order_code % 2 == 0 ? order_code : order_code - 1 if sex == 0
+        order_code = order_code % 2 == 0 ? order_code - 1 : order_code if sex == 1
+
+        Func.get_str_pad(order_code, 3, '0', false)
+      end
+
+    end
+  end
+end