turkish_id 1.3.0 → 1.5.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f2ce68dae19376b6afae68d92f079c60661ef424d26a58f7a201c43893860dc
-  data.tar.gz: 3370d7423c4cd7b60df5143f6e890242e5381b7d7fe7a0224d9bf3d25950aa8b
+  metadata.gz: b6f16411294196075f7ddc2420a83b1073bca92bbcbf08d872afd22c88de0198
+  data.tar.gz: 3a340241b1446a80046e1b3f62ceaffb77d7ed37ff37c4343bfeb7c2fa236ab3
 SHA512:
-  metadata.gz: b87c07e37a6e77264a43ab52e218c6419b859d6daa79bfcfe38cb35b379fd39f25bf447576fbdaf3b3c43bafca4dca83639ffa485e2bd1e34ddac8b87398c962
-  data.tar.gz: fd1974ed82dd65682b1f5a09a265dc020282551b2be4e53c5eca23bdf5f28bee0c18f6c882c5ca3f40b0501ebd6750c16394f80ae4f7d343d3b06eb16271ecf5
+  metadata.gz: ab688e6d2faf494f3ddcfb3f24d26840d9231dae8639af97145d39408658919140ef52dfbab5d583596517801232ff5b6e4c49aa2bf200be777ec7acf941fd04
+  data.tar.gz: f9d19b0cf457aa1f257c8547ac9122ae4293b66aa875945f604c569bcdfe1955d4a5f07eed26f751d6252b528ca7eef4d7ba1fd3d73078b395d773ec69606e4e

data/.github/workflows/publish.yml

@@ -0,0 +1,24 @@
+name: Publish
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build:
+    name: Publish Packages
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+
+      - name: Set up Ruby
+        uses: ruby/setup-ruby@v1
+        with:
+          bundler-cache: true
+
+      - name: Publish to RubyGems
+        uses: dawidd6/action-publish-gem@v1
+        with:
+          api_key: ${{secrets.RUBYGEMS_AUTH_TOKEN}}
+

data/.github/workflows/test.yml

@@ -0,0 +1,52 @@
+name: Test
+
+on:
+  pull_request:
+
+  push:
+    branches: [develop, master]
+
+env:
+  GIT_COMMIT_SHA: ${{ github.sha }}
+  GIT_BRANCH: ${{ github.ref }}
+  COVERALLS_REPO_TOKEN: ${{ secrets.COVERALLS_REPO_TOKEN }}
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    name: lint ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7.8", "3.0.6", "3.1.4", "3.2.2"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: StandardRB
+        continue-on-error: ${{ matrix.experimental }}
+        run: bundle exec standardrb --parallel --format progress
+
+  test:
+    needs: [lint]
+    runs-on: ubuntu-latest
+    name: test ${{ matrix.ruby }}
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ["2.7.8", "3.0.6", "3.1.4", "3.2.2"]
+
+    steps:
+      - uses: actions/checkout@v2
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{ matrix.ruby }}
+          bundler-cache: true
+
+      - name: Test
+        continue-on-error: ${{ matrix.experimental }}
+        run: bundle exec rake

data/.tool-versions

@@ -0,0 +1 @@
+ruby 3.2.2

data/Gemfile

@@ -1,13 +1,8 @@
 # frozen_string_literal: true
 
-source 'https://rubygems.org'
+source "https://rubygems.org"
 
-# Specify your gem's dependencies in turkish_id.gemspec
-gemspec
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
 
-group :test do
-  gem 'bundler'
-  gem 'rake'
-  gem 'rspec'
-  gem 'simplecov'
-end
+# Specify your gem's dependencies in viabtc.gemspec
+gemspec

data/LICENSE.txt

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2015 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,6 +1,12 @@
 # Turkish ID 🔖
 
-[![Build Status](https://travis-ci.org/krmbzds/turkish_id.svg?branch=master)](https://travis-ci.org/krmbzds/turkish_id) [![Gem](https://img.shields.io/gem/v/turkish_id.svg)](https://github.com/krmbzds/turkish_id) [![Dependencies](https://img.shields.io/badge/dependencies-none-brightgreen.svg)](https://rubygems.org/gems/turkish_id) [![Gem](https://img.shields.io/gem/dt/turkish_id.svg)](https://rubygems.org/gems/turkish_id) [![Code Climate](https://codeclimate.com/github/krmbzds/turkish_id/badges/gpa.svg)](https://codeclimate.com/github/krmbzds/turkish_id) [![Test Coverage](https://codeclimate.com/github/krmbzds/turkish_id/badges/coverage.svg)](https://codeclimate.com/github/krmbzds/turkish_id/coverage)
+[![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-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)
 
 This gem provides methods to validate Turkish Identification Numbers.
 
@@ -36,10 +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  #=> Your identification number is valid.
+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
@@ -78,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.
@@ -90,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
 
@@ -98,9 +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:
 
-- ✅ `2.7.1` (stable)
-- ✅ `2.6.6` (stable)
-- ⏳ `2.5.8` (security maintenance)
+- ✅ `3.2.2` (stable)
+- ✅ `3.1.4` (stable)
+- ⏳ `3.0.6` (security maintenance)
+- 🪦 `2.7.8` (end of life)
 
 ## Development
 
@@ -126,7 +175,7 @@ Yes.
 
 ## License
 
-Copyright © 2019 [Kerem Bozdas][Personal Webpage]
+Copyright © 2015-2023 [Kerem Bozdas][Personal Webpage]
 
 This gem is available under the terms of the [MIT License][License].
 

data/Rakefile

@@ -1,7 +1,7 @@
 # frozen_string_literal: true
 
-require 'bundler/gem_tasks'
-require 'rspec/core/rake_task'
+require "bundler/gem_tasks"
+require "rspec/core/rake_task"
 
 RSpec::Core::RakeTask.new(:spec)
 task default: :spec

data/bin/console

@@ -1,11 +1,11 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-require 'bundler/setup'
-require 'turkish_id'
+require "bundler/setup"
+require "turkish_id"
 
 # 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.
 
-require 'irb'
+require "irb"
 IRB.start

data/bin/turkish_id

@@ -1,36 +1,45 @@
 #!/usr/bin/env ruby
 # frozen_string_literal: true
 
-lib = File.expand_path(File.dirname(__FILE__) + '/../lib')
+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"
+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
 
 '
 
-def parse_input
-  ARGV[0] ? validate_id(ARGV[0]) : print_help
-end
-
-def validate_id(id_number)
-  identity_number = TurkishId.new(id_number)
-  print_result(identity_number.valid?)
-end
-
-def print_result(result)
-  STDOUT.puts "Your identification number is #{result ? 'valid' : 'invalid'}."
+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
 
-def print_help
-  STDOUT.puts @help
+if ["-v", "-V", "--version"].include?(ARGV[0])
+  $stdout.puts TurkishId::VERSION
+  exit 0
 end
 
-parse_input
+$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.3.0'
+  VERSION = "1.5.0"
 end

data/lib/turkish_id.rb

@@ -1,6 +1,7 @@
 # frozen_string_literal: true
 
-require 'turkish_id/version'
+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)
@@ -32,7 +37,7 @@ class TurkishId
 
     # Return checksum
     [d10, d11]
-  rescue StandardError
+  rescue
     []
   end
 
@@ -42,7 +47,7 @@ class TurkishId
   end
 
   def next_relative(id_array, direction)
-    tree = { up: 1, down: -1 }
+    tree = {up: 1, down: -1}
     get_core(id_array) + 29_999 * tree[direction]
   end
 
@@ -60,7 +65,7 @@ class TurkishId
 
   def get_id_array(id)
     split_num(Integer(id))
-  rescue StandardError
+  rescue
     []
   end
 
@@ -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

@@ -1,22 +1,32 @@
 # frozen_string_literal: true
 
-lib = File.expand_path('lib', __dir__)
+lib = File.expand_path("lib", __dir__)
 $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
-require 'turkish_id/version'
+require "turkish_id/version"
 
 Gem::Specification.new do |spec|
-  spec.name          = 'turkish_id'
-  spec.version       = TurkishId::VERSION
-  spec.authors       = ['Kerem Bozdas']
-  spec.email         = ['krmbzds.github@gmail.com']
+  spec.name = "turkish_id"
+  spec.version = TurkishId::VERSION
+  spec.authors = ["Kerem Bozdas"]
+  spec.email = ["krmbzds.github@gmail.com"]
 
-  spec.summary       = 'Validate Turkish Identification Numbers and More!'
-  spec.description   = 'Validate Turkish Identification Numbers and More!'
-  spec.homepage      = 'https://github.com/krmbzds/turkish_id'
-  spec.license       = 'MIT'
+  spec.summary = "Validate Turkish Identification Numbers and More!"
+  spec.description = "Validate Turkish Identification Numbers and More!"
+  spec.homepage = "https://github.com/krmbzds/turkish_id"
+  spec.license = "MIT"
 
-  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
-  spec.bindir        = 'bin'
-  spec.executables   = ['turkish_id']
-  spec.require_paths = ['lib', 'lib/turkish_id']
+  spec.files = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir = "bin"
+  spec.executables = ["turkish_id"]
+  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 "vcr"
+  spec.add_development_dependency "webmock"
+
+  spec.add_runtime_dependency "savon"
 end

metadata

@@ -1,15 +1,127 @@
 --- !ruby/object:Gem::Specification
 name: turkish_id
 version: !ruby/object:Gem::Version
-  version: 1.3.0
+  version: 1.5.0
 platform: ruby
 authors:
 - Kerem Bozdas
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2020-07-18 00:00:00.000000000 Z
-dependencies: []
+date: 2023-07-06 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  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: 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
+    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: rspec
+  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: standard
+  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: 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:
+    - - ">="
+      - !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: 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
@@ -18,11 +130,11 @@ executables:
 extensions: []
 extra_rdoc_files: []
 files:
+- ".github/workflows/publish.yml"
+- ".github/workflows/test.yml"
 - ".gitignore"
 - ".rspec"
-- ".ruby-gemset"
-- ".ruby-version"
-- ".travis.yml"
+- ".tool-versions"
 - Gemfile
 - LICENSE.txt
 - README.md
@@ -53,7 +165,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.1.3
+rubygems_version: 3.4.14
 signing_key:
 specification_version: 4
 summary: Validate Turkish Identification Numbers and More!

data/.ruby-gemset

@@ -1 +0,0 @@
-turkish_id

data/.ruby-version

@@ -1 +0,0 @@
-ruby-2.7.1

data/.travis.yml

@@ -1,20 +0,0 @@
-language: ruby
-rvm:
-  - 2.7.1
-  - 2.6.6
-  - 2.5.8
-before_install:
-  - 'gem update --system'
-  - 'gem --version'
-  - 'gem install bundler'
-env:
-  global:
-    - CC_TEST_REPORTER_ID=92655ba2c8b47200f80e996afb80c410b9491514845d414d7517108ad35a5178
-before_script:
-  - curl -L https://codeclimate.com/downloads/test-reporter/test-reporter-latest-linux-amd64 > ./cc-test-reporter
-  - chmod +x ./cc-test-reporter
-  - ./cc-test-reporter before-build
-script:
-  - bundle exec rspec
-after_script:
-  - ./cc-test-reporter after-build --exit-code $TRAVIS_TEST_RESULT