turkish_id 1.4.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dbab23fd1a1c8ee8c67c3630a171a135bed41bce82708dc6c03c42b61651bf3
-  data.tar.gz: '0385cf9eb915caf2a0f8c41cb3663e7bdb2c9b50d17b8915f6fc2e1416eab8f8'
+  metadata.gz: b6f16411294196075f7ddc2420a83b1073bca92bbcbf08d872afd22c88de0198
+  data.tar.gz: 3a340241b1446a80046e1b3f62ceaffb77d7ed37ff37c4343bfeb7c2fa236ab3
 SHA512:
-  metadata.gz: 39f88acd307c6a3ac8d5c446cad44ed78a5fb7f998d8fdd4223c5550705880d67d617ed106f1465de98fb9c3c92415e72901b5ce8582fe3a04d80502f8c1402e
-  data.tar.gz: 6fa037e2073337069638a364f2a8277f48d50630a0bd80f46a43a5ef49bd674b5226dcfa941dd59d02c7c43466a8b6403be4288df33ad3403fbd748b04f6497a
+  metadata.gz: ab688e6d2faf494f3ddcfb3f24d26840d9231dae8639af97145d39408658919140ef52dfbab5d583596517801232ff5b6e4c49aa2bf200be777ec7acf941fd04
+  data.tar.gz: f9d19b0cf457aa1f257c8547ac9122ae4293b66aa875945f604c569bcdfe1955d4a5f07eed26f751d6252b528ca7eef4d7ba1fd3d73078b395d773ec69606e4e

data/.github/workflows/test.yml

@@ -4,7 +4,7 @@ on:
   pull_request:
 
   push:
-    branches: [ develop, master ]
+    branches: [develop, master]
 
 env:
   GIT_COMMIT_SHA: ${{ github.sha }}
@@ -12,14 +12,13 @@ env:
   COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
 
 jobs:
-
   lint:
     runs-on: ubuntu-latest
     name: lint ${{ matrix.ruby }}
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6.9', '2.7.5', '3.0.3', '3.1.1' ]
+        ruby: ["2.7.8", "3.0.6", "3.1.4", "3.2.2"]
 
     steps:
       - uses: actions/checkout@v2
@@ -33,13 +32,13 @@ jobs:
         run: bundle exec standardrb --parallel --format progress
 
   test:
-    needs: [ lint ]
+    needs: [lint]
     runs-on: ubuntu-latest
     name: test ${{ matrix.ruby }}
     strategy:
       fail-fast: false
       matrix:
-        ruby: [ '2.6.9', '2.7.5', '3.0.3', '3.1.1' ]
+        ruby: ["2.7.8", "3.0.6", "3.1.4", "3.2.2"]
 
     steps:
       - uses: actions/checkout@v2

data/.tool-versions

@@ -1 +1 @@
-ruby 3.1.1
+ruby 3.2.2

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015-2022 Kerem Bozdas
+Copyright (c) 2015-2023 Kerem Bozdas
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,9 +1,9 @@
 # Turkish ID 🔖
 
-[![Status](https://img.shields.io/github/workflow/status/krmbzds/turkish_id/Test/master)](https://github.com/krmbzds/turkish_id/actions/workflows/test.yml)
+[![Status](https://img.shields.io/github/actions/workflow/status/krmbzds/turkish_id/test.yml?branch=master)](https://github.com/krmbzds/turkish_id/actions/workflows/test.yml)
 [![Coverage](https://img.shields.io/coveralls/github/krmbzds/turkish_id)](https://coveralls.io/github/krmbzds/turkish_id)
 [![Downloads](https://img.shields.io/gem/dt/turkish_id.svg)](https://rubygems.org/gems/turkish_id)
-[![Dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)](https://rubygems.org/gems/turkish_id)
+[![Dependencies](https://img.shields.io/badge/dependencies-1-yellowgreen.svg)](https://rubygems.org/gems/turkish_id)
 [![Maintainability](https://img.shields.io/codeclimate/maintainability/krmbzds/turkish_id)](https://codeclimate.com/github/krmbzds/turkish_id)
 [![Version](https://img.shields.io/gem/v/turkish_id.svg)](https://github.com/krmbzds/turkish_id)
 [![Docs](https://img.shields.io/badge/rubydoc-info-blue.svg)](https://www.rubydoc.info/gems/turkish_id)
@@ -42,13 +42,18 @@ Use ```valid?``` method to check validity:
 identity_number.valid?  #=> true
 ```
 
-Or use the command line executable:
+### Querying the Government Registry
 
-```sh
-$ turkish_id 10000000078  #=> true
-$ echo $?                 #=> 0
-$ turkish_id 10000000079  #=> false
-$ echo $?                 #=> 1
+Create a new instance:
+
+```rb
+identity_number = TurkishId.new(10000000146)
+```
+
+Use ```registered?``` method to query the government registry:
+
+```rb
+identity_number.registered?("Ahmet", "Yılmaz", 1987)  #=> false
 ```
 
 ### Generating Relatives
@@ -87,6 +92,40 @@ me.elder_relative.take(5)  #=> [10003000082, 10005999902, 10008999848, 100119997
 
 And so on.
 
+## CLI (Command Line Interface)
+
+You can use the CLI for quick lookups:
+
+```sh
+$ turkish_id 10000000078  #=> true
+```
+
+The executable terminates with a proper [exit status](https://en.wikipedia.org/wiki/Exit_status):
+
+```sh
+$ turkish_id 10000000078  #=> true
+$ echo $?                 #=> 0
+$ turkish_id 10000000079  #=> false
+$ echo $?                 #=> 1
+```
+
+Run `turkish_id --help` to learn more:
+
+```groff
+Usage
+  turkish_id ID_NUMBER [GIVEN_NAME SURNAME YEAR_OF_BIRTH]
+
+Description
+  turkish_id validates Turkish identity numbers.
+  Only providing ID_NUMBER performs numerical validation (offline).
+  Providing all arguments will query government registry (online).
+
+Examples
+  turkish_id 10000000078
+  turkish_id 10000000146 Ahmet Yılmaz 1984
+  turkish_id 10005999902 "Ayşe Nur" Yılmaz 1996
+```
+
 ## Anatomy of the Turkish ID Number
 
 The Turkish Identification Number consists of ```11``` digits.
@@ -99,7 +138,7 @@ There are three conditions for a valid identification number:
 
 Where ```dn``` refers to the ```n-th``` digit of the identification number.
 
-Remember that a valid identification number does not imply the existence of an ID. It could only be used as a preliminary check e.g. before querying a government website. This is very similar to credit card validation.
+Remember that a valid identification number does not imply the existence of an ID. It could only be used as a preliminary check e.g. before [querying a government website](#querying-the-government-registry). This is very similar to credit card validation.
 
 ## Support
 
@@ -107,10 +146,10 @@ Remember that a valid identification number does not imply the existence of an I
 
 This gem is used in production and tested against the following Ruby versions:
 
-- ✅ `3.1.1` (stable)
-- ✅ `3.0.3` (stable)
-- ✅ `2.7.5` (stable)
-- ⏳ `2.6.9` (security maintenance)
+- ✅ `3.2.2` (stable)
+- ✅ `3.1.4` (stable)
+- ⏳ `3.0.6` (security maintenance)
+- 🪦 `2.7.8` (end of life)
 
 ## Development
 
@@ -136,7 +175,7 @@ Yes.
 
 ## License
 
-Copyright © 2015-2022 [Kerem Bozdas][Personal Webpage]
+Copyright © 2015-2023 [Kerem Bozdas][Personal Webpage]
 
 This gem is available under the terms of the [MIT License][License].
 

data/bin/turkish_id

@@ -5,21 +5,41 @@ lib = File.expand_path(File.dirname(__FILE__) + "/../lib")
 $LOAD_PATH.unshift(lib) if File.directory?(lib) && !$LOAD_PATH.include?(lib)
 
 require "turkish_id"
+require "turkish_id/version"
 
-@help = '
+HELP = '
   Usage
-    turkish_id QUERY
+    turkish_id ID_NUMBER [GIVEN_NAME SURNAME YEAR_OF_BIRTH]
+
+  Description
+    turkish_id validates Turkish identity numbers.
+    Only providing ID_NUMBER performs numerical validation (offline).
+    Providing all arguments will query government registry (online).
 
   Examples
     turkish_id 10000000078
-    turkish_id 10000000146
+    turkish_id 10000000146 Ahmet Yılmaz 1984
+    turkish_id 10005999902 "Ayşe Nur" Yılmaz 1996
 
 '
 
-if ARGV[0]
-  result = TurkishId.new(ARGV[0]).valid?
-  $stdout.puts result
-  exit result ? 0 : 1
-else
-  $stdout.puts @help
+result =
+  case ARGV.length
+  when 1 then TurkishId.new(ARGV[0]).valid?
+  when 4 then TurkishId.new(ARGV[0]).registered?(ARGV[1], ARGV[2], ARGV[3])
+  else $stdout.puts HELP
+       exit 1
+  end
+
+if ["-?", "-h", "--help", "--usage"].include?(ARGV[0])
+  $stdout.puts HELP
+  exit 1
 end
+
+if ["-v", "-V", "--version"].include?(ARGV[0])
+  $stdout.puts TurkishId::VERSION
+  exit 0
+end
+
+$stdout.puts result
+exit result ? 0 : 1

data/lib/turkish_id/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 class TurkishId
-  VERSION = "1.4.0"
+  VERSION = "1.5.0"
 end

data/lib/turkish_id.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
 require "turkish_id/version"
+require "savon"
 
 class TurkishId
   attr_reader :id_number, :checksum, :elder_relative, :younger_relative
@@ -19,6 +20,10 @@ class TurkishId
     true
   end
 
+  def registered?(given_name, surname, year_of_birth)
+    valid? && query_government_registry(given_name, surname, year_of_birth)
+  end
+
   private
 
   def calculate_checksum(id_array)
@@ -76,4 +81,18 @@ class TurkishId
   def get_core(id_array)
     join_num(split_num(id_array).take(9))
   end
+
+  def query_government_registry(given_name, surname, year_of_birth)
+    client = Savon.client(wsdl: "https://tckimlik.nvi.gov.tr/Service/KPSPublic.asmx?WSDL")
+    response = client.call(:tc_kimlik_no_dogrula, message: {
+      "TCKimlikNo" => join_num(@id_number),
+      "Ad" => given_name.upcase(:turkic),
+      "Soyad" => surname.upcase(:turkic),
+      "DogumYili" => String(Date.new(Integer(year_of_birth)).year)
+    })
+
+    response.body.dig(:tc_kimlik_no_dogrula_response, :tc_kimlik_no_dogrula_result).is_a?(TrueClass)
+  rescue TypeError, ArgumentError, NoMethodError
+    false
+  end
 end

data/turkish_id.gemspec

@@ -21,8 +21,12 @@ Gem::Specification.new do |spec|
   spec.require_paths = ["lib", "lib/turkish_id"]
 
   spec.add_development_dependency "bundler"
+  spec.add_development_dependency "coveralls_reborn"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec"
   spec.add_development_dependency "standard"
-  spec.add_development_dependency "coveralls_reborn"
+  spec.add_development_dependency "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "savon"
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: turkish_id
 version: !ruby/object:Gem::Version
-  version: 1.4.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kerem Bozdas
-autorequire: 
+autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-03-16 00:00:00.000000000 Z
+date: 2023-07-06 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -24,6 +24,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: coveralls_reborn
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -67,7 +81,21 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '0'
 - !ruby/object:Gem::Dependency
-  name: coveralls_reborn
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: webmock
   requirement: !ruby/object:Gem::Requirement
     requirements:
     - - ">="
@@ -80,6 +108,20 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '0'
+- !ruby/object:Gem::Dependency
+  name: savon
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: Validate Turkish Identification Numbers and More!
 email:
 - krmbzds.github@gmail.com
@@ -88,7 +130,6 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
-- ".github/dependabot.yml"
 - ".github/workflows/publish.yml"
 - ".github/workflows/test.yml"
 - ".gitignore"
@@ -108,7 +149,7 @@ homepage: https://github.com/krmbzds/turkish_id
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -124,8 +165,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.3.7
-signing_key: 
+rubygems_version: 3.4.14
+signing_key:
 specification_version: 4
 summary: Validate Turkish Identification Numbers and More!
 test_files: []

data/.github/dependabot.yml

@@ -1,8 +0,0 @@
-version: 2
-updates:
-- package-ecosystem: bundler
-  directory: "/"
-  schedule:
-    interval: daily
-    time: "03:00"
-  open-pull-requests-limit: 10