tw_ubn 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5d25165a4b4dd2fb26703aecfce05d6bd659f12ab1047c0c49779932fa3b4ab1
+  data.tar.gz: 25e41bcf66447518a3898e8e6846b7e8c3e0573eaa5aa9fbf97d4c33307917c8
+SHA512:
+  metadata.gz: a10c097ab4338ff17b0dad2ac495b356d3297d0482f50b6f5acbc2c3655333c66994d1dfb60dea1e79f59e812e05ba4dce2ab7c1e69eac067aaf4b4b1517b7be
+  data.tar.gz: 0c26ebd34db46e72ae99ddc3b8789a9eb3072ec1b18a8adc68fd3a29e61cca93084f580b0f58fa2dfadf09346a8914582505fe8f5e56a18fa72d065875f970ae

data/.rubocop.yml

@@ -0,0 +1,14 @@
+AllCops:
+  TargetRubyVersion: 2.5
+  SuggestExtensions: false
+
+Style/StringLiterals:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Style/StringLiteralsInInterpolation:
+  Enabled: true
+  EnforcedStyle: double_quotes
+
+Layout/LineLength:
+  Max: 120

data/Gemfile

@@ -0,0 +1,12 @@
+# frozen_string_literal: true
+
+source "https://rubygems.org"
+
+# Specify your gem's dependencies in tw_ubn.gemspec
+gemspec
+
+gem "rake", "~> 13.0"
+
+gem "minitest", "~> 5.0"
+
+gem "rubocop", "~> 1.21"

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Guanting Chen
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,70 @@
+# Taiwan UBN Validator (2021) 
+
+[![Gem Version](https://badge.fury.io/rb/tw_ubn.svg)](https://badge.fury.io/rb/tw_ubn)
+[![Maintainability](https://api.codeclimate.com/v1/badges/2e20efaaac6115c6df87/maintainability)](https://codeclimate.com/github/guanting112/tw_ubn/maintainability)
+
+![example workflow](https://github.com/guanting112/tw_ubn/actions/workflows/main.yml/badge.svg)
+
+此為針對 台灣營利事業統一編號 (UBN) 所開發的驗證套件。
+
+您可以使用它進行驗證，確認使用者提供的公司統一編號是否有效。
+
+* 本套件適用於電商平台發票資料、企業相關表單欄位 輔助驗證。
+* 可減少因消費者統編填錯，與客服溝通/重開的來往成本。
+* 已經過大量現實資料驗證，另有搭配 150 萬筆商工行政資料確定校對方式正確。
+* 與 財政部財資中心 2021年6月公告的新驗證邏輯同步 ( 因應 2024 年公司統一編號用盡之問題 )
+
+驗證之規則與細節參考，皆來自台灣財政部財政資訊中心之公告 「 [營利事業統一編號檢查碼邏輯修正說明][fia_rule] 」 
+
+## Installation / 安裝方式
+
+via Rubygems
+
+```shell
+gem install tw_ubn
+```
+
+In your Gemfile:
+
+```ruby
+gem 'tw_ubn'
+```
+
+## Usage / 如何使用
+
+使用很簡單，僅需要呼叫 TwUbn::Validator.call 即可確認是否正確
+
+```ruby
+TwUbn::Validator.call("8碼公司統編")
+```
+
+```ruby
+# 有效的公司統一編號
+TwUbn::Validator.call("22099131") # true
+TwUbn::Validator.call("47217677") # true
+TwUbn::Validator.call("22822281") # true
+
+# 錯誤的公司統編
+TwUbn::Validator.call("22822280") # false
+TwUbn::Validator.call("47217977") # false
+TwUbn::Validator.call("88123") # false
+TwUbn::Validator.call("11099131") # false
+```
+
+在 Ruby on Rails 內，您也可以將 TwUbn::Validator 導入到自建的 validator 內使用。
+
+https://api.rubyonrails.org/classes/ActiveModel/Validator.html
+
+```ruby
+class TaxDataValidator < ActiveModel::Validator
+  def validate(record)
+    if !TwUbn::Validator.call(record.tax_number)
+      record.errors.add(:tax_number, '統一編號格式不正確。')
+    end
+  end
+end
+```
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).

data/Rakefile

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+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
+
+require "rubocop/rake_task"
+
+RuboCop::RakeTask.new
+
+task default: %i[test rubocop]

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require "bundler/setup"
+require "tw_ubn"
+
+# 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/lib/tw_ubn/rules.rb

@@ -0,0 +1,7 @@
+# frozen_string_literal: true
+
+module TwUbn
+  VERIFY_UBN_KEY = 5
+
+  UBN_CALC_WEIGHT = [1, 2, 1, 2, 1, 2, 4, 1].freeze
+end

data/lib/tw_ubn/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module TwUbn
+  VERSION = "1.0.0"
+end

data/lib/tw_ubn.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+require_relative "tw_ubn/rules"
+require_relative "tw_ubn/version"
+
+module TwUbn
+  # taiwan unified business number validator
+  class Validator
+    def initialize(ubn)
+      @ubn = ubn.to_s
+    end
+
+    def self.call(*args)
+      new(*args).verify
+    end
+
+    def verify
+      return false if (@ubn =~ /^\d{8}$/).nil?
+
+      ubn_array = @ubn.chars.map(&:to_i)
+      checksum = calculate_checksum(ubn_array)
+
+      verify_checksum(checksum)
+    end
+
+    def calculate_checksum(ubn_array)
+      first_result =
+        ubn_array.map.with_index do |v, i|
+          v * TwUbn::UBN_CALC_WEIGHT[i]
+        end
+
+      second_result =
+        first_result.map { |v| (v / 10).floor + v % 10 }
+
+      second_result.sum
+    end
+
+    def verify_checksum(checksum)
+      key = TwUbn::VERIFY_UBN_KEY
+      use_special_verify = @ubn[6] == "7"
+
+      if use_special_verify
+        ((checksum - 10) % key).zero? ||
+          ((checksum - 9) % key).zero?
+      else
+        (checksum % key).zero?
+      end
+    end
+  end
+end

metadata

@@ -0,0 +1,54 @@
+--- !ruby/object:Gem::Specification
+name: tw_ubn
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Guanting Chen
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2021-12-11 00:00:00.000000000 Z
+dependencies: []
+description: 方便您在 ruby 校驗，台灣公司統一編號資料。(支援財政部2021版6月規則更新)
+email: 
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".rubocop.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/tw_ubn.rb
+- lib/tw_ubn/rules.rb
+- lib/tw_ubn/version.rb
+homepage: https://github.com/guanting112/tw_ubn
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/guanting112/tw_ubn
+  source_code_uri: https://github.com/guanting112/tw_ubn
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: 2.5.0
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.0.3.1
+signing_key: 
+specification_version: 4
+summary: TwUbn 台灣公司統一編號驗證器 (Taiwan unified business number validator)
+test_files: []