e-id 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 95f1117835526ba0fa98a96f073c540d7cca1bd83016581060ec067f0280b746
+  data.tar.gz: a866ae7a9bcba3feb047929dd983437f08dd3f052367c0b78b88b977884c4666
+SHA512:
+  metadata.gz: 5ac32ed7526f059926411f54cfd64f950b554868c704246206157a77776c8a3201a6441921e1e6143b4e2804a5799abc90d2fd3bb49e8ae4de9a0b26acc6568c
+  data.tar.gz: f27d33289cebfc93546ec3d52927cd305884f400886e2d158ad5128c6bb8b83c7e1571f6ffb1fcea2a9362d487652091898cd2b05c02e7c1e660fc14481becb4

data/.dockerignore

@@ -0,0 +1,13 @@
+**/.git
+**/.idea
+/.github
+/docs
+/log
+/tmp
+/.dockerignore
+/.editorconfig
+/.gitattributes
+/.gitignore
+/docker-compose.yaml
+/Dockerfile
+/README.md

data/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_size = 2
+indent_style = space
+insert_final_newline = true
+trim_trailing_whitespace = true
+end_of_line = lf

data/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+## Status
+
+Ready
+
+## Description
+
+A brief description of the pull request

data/.github/dependabot.yml

@@ -0,0 +1,19 @@
+# https://docs.github.com/en/code-security/supply-chain-security/keeping-your-dependencies-updated-automatically/configuration-options-for-dependency-updates
+
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: daily
+    assignees:
+      - "tab"
+    open-pull-requests-limit: 10
+
+  - package-ecosystem: bundler
+    directory: /
+    schedule:
+      interval: daily
+    assignees:
+      - "tab"
+    open-pull-requests-limit: 10

data/.github/workflows/checks.yaml

@@ -0,0 +1,34 @@
+name: PR checks
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, ready_for_review]
+concurrency:
+  group: '${{ github.workflow }} @ ${{ github.event.pull_request.head.label || github.head_ref || github.ref }}'
+  cancel-in-progress: true
+jobs:
+  rspec:
+    name: RSpec with ruby ${{matrix.ruby}}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1', head]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+      - name: Test with RSpec
+        run: bundle exec rspec
+  rubocop:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.3
+          bundler-cache: true
+      - name: Check with RuboCop
+        run: bundle exec rubocop

data/.github/workflows/release.yaml

@@ -0,0 +1,53 @@
+name: Release
+on:
+  release:
+    types: [ released ]
+jobs:
+  rubocop:
+    name: RuboCop
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.3
+          bundler-cache: true
+      - name: Check with RuboCop
+        run: bundle exec rubocop
+  rspec:
+    name: RSpec with ruby ${{matrix.ruby}}
+    runs-on: ubuntu-latest
+    needs: rubocop
+    strategy:
+      fail-fast: false
+      matrix:
+        ruby: ['2.6', '2.7', '3.0', '3.1', head]
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: ${{matrix.ruby}}
+          bundler-cache: true
+      - name: Test with RSpec
+        run: bundle exec rspec
+  build-and-push:
+    name: Build and push gem
+    runs-on: ubuntu-latest
+    needs: rspec
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ruby/setup-ruby@v1
+        with:
+          ruby-version: 3.1.3
+          bundler-cache: true
+      - name: Setup credentials
+        run: |
+          mkdir -p $HOME/.gem
+          touch $HOME/.gem/credentials
+          chmod 0600 $HOME/.gem/credentials
+          printf -- "---\n:rubygems_api_key: ${RUBYGEMS_API_KEY}\n" > $HOME/.gem/credentials
+        env:
+          RUBYGEMS_API_KEY: ${{ secrets.RUBYGEMS_API_KEY }}
+      - name: Release gem
+        run: |
+          bundle exec rake release

data/.gitignore

@@ -0,0 +1,13 @@
+**/.idea
+
+/.bundle/
+/.yardoc
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+
+# rspec failure tracking
+.rspec_status

data/.rspec

@@ -0,0 +1,3 @@
+--format documentation
+--color
+--require spec_helper

data/.rubocop.yml

@@ -0,0 +1,19 @@
+require:
+  - rubocop-rspec
+  - rubocop-performance
+
+AllCops:
+  NewCops: enable
+  SuggestExtensions: false
+  TargetRubyVersion: 2.6
+
+RSpec/NestedGroups:
+  Enabled: true
+  Max: 5
+
+Style/Documentation:
+  Enabled: false
+
+Naming/FileName:
+  Exclude:
+    - lib/e-id.rb

data/CHANGELOG.md

@@ -0,0 +1,5 @@
+# Change log
+
+## v0.1.0
+
+* Initial release

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. 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/Dockerfile

@@ -0,0 +1,13 @@
+FROM ruby:3.1.3-alpine3.17
+
+WORKDIR /package
+
+COPY . .
+
+RUN apk add --update-cache --no-cache --virtual .build-deps g++ make  \
+    && apk add --update-cache --no-cache gcompat git openssh-client \
+    && bundle install --jobs $(nproc) --retry 3 \
+    && rm -rf /usr/local/bundle/cache/*.gem \
+    && find /usr/local/bundle/gems/ -name "*.c" -delete \
+    && find /usr/local/bundle/gems/ -name "*.o" -delete \
+    && apk --purge del .build-deps

data/Gemfile

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+source 'https://rubygems.org'
+
+git_source(:github) { |repo_name| "https://github.com/#{repo_name}" }
+
+gemspec
+
+group :development, :test do
+  gem 'rspec', '~> 3.12.0'
+  gem 'rubocop', '~> 1.50.2'
+  gem 'rubocop-performance', '~> 1.16.0'
+  gem 'rubocop-rspec', '~> 2.19.0'
+end
+
+group :test do
+  gem 'simplecov', '~> 0.22.0'
+end

data/Gemfile.lock

@@ -0,0 +1,77 @@
+PATH
+  remote: .
+  specs:
+    e-id (0.1.0)
+
+GEM
+  remote: https://rubygems.org/
+  specs:
+    ast (2.4.2)
+    diff-lcs (1.5.0)
+    docile (1.4.0)
+    json (2.6.3)
+    parallel (1.23.0)
+    parser (3.2.2.1)
+      ast (~> 2.4.1)
+    rainbow (3.1.1)
+    rake (13.0.6)
+    regexp_parser (2.8.0)
+    rexml (3.2.5)
+    rspec (3.12.0)
+      rspec-core (~> 3.12.0)
+      rspec-expectations (~> 3.12.0)
+      rspec-mocks (~> 3.12.0)
+    rspec-core (3.12.2)
+      rspec-support (~> 3.12.0)
+    rspec-expectations (3.12.3)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-mocks (3.12.5)
+      diff-lcs (>= 1.2.0, < 2.0)
+      rspec-support (~> 3.12.0)
+    rspec-support (3.12.0)
+    rubocop (1.50.2)
+      json (~> 2.3)
+      parallel (~> 1.10)
+      parser (>= 3.2.0.0)
+      rainbow (>= 2.2.2, < 4.0)
+      regexp_parser (>= 1.8, < 3.0)
+      rexml (>= 3.2.5, < 4.0)
+      rubocop-ast (>= 1.28.0, < 2.0)
+      ruby-progressbar (~> 1.7)
+      unicode-display_width (>= 2.4.0, < 3.0)
+    rubocop-ast (1.28.0)
+      parser (>= 3.2.1.0)
+    rubocop-capybara (2.18.0)
+      rubocop (~> 1.41)
+    rubocop-performance (1.16.0)
+      rubocop (>= 1.7.0, < 2.0)
+      rubocop-ast (>= 0.4.0)
+    rubocop-rspec (2.19.0)
+      rubocop (~> 1.33)
+      rubocop-capybara (~> 2.17)
+    ruby-progressbar (1.13.0)
+    simplecov (0.22.0)
+      docile (~> 1.1)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.4)
+    unicode-display_width (2.4.2)
+
+PLATFORMS
+  x86_64-linux
+  x86_64-linux-musl
+
+DEPENDENCIES
+  bundler (~> 2.3.0)
+  e-id!
+  rake (~> 13.0.6)
+  rspec (~> 3.12.0)
+  rubocop (~> 1.50.2)
+  rubocop-performance (~> 1.16.0)
+  rubocop-rspec (~> 2.19.0)
+  simplecov (~> 0.22.0)
+
+BUNDLED WITH
+   2.3.26

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2022 tab
+
+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,83 @@
+# E-ID
+
+Electronic identity in Estonia and in other countries
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'e-id', '~> 0.1.0'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install e-id
+
+## Usage
+
+### Estonia
+
+Identity code format is `GYYMMDDSSSC`
+
+* `G` – gender
+* `YYMMDD` – date of birth
+* `SSS` – serial number
+* `C` – checksum
+
+More info: https://www.id.ee/en/
+
+```bash
+irb -I lib
+require 'e-id'
+
+Eid::Estonia.new(50001029996).valid?
+=> true
+
+Eid::Estonia.new(50001029996).gender
+=> :female
+
+Eid::Estonia.new(50001029996).birth_date
+=> #<Date: 2000-01-02 ((2451546j,0s,0n),+0s,2299161j)>
+
+Eid::Estonia.new(50001029996).age
+=> 23
+```
+
+## Development
+
+Build docker container with compose:
+
+```bash
+docker-compose build
+docker-compose up
+```
+
+Access to the container:
+
+```bash
+docker-compose exec e-id sh
+```
+
+Run rspec or rubocop checks:
+
+```bash
+/package # bundle exec rubocop
+/package # bundle exec rspec
+```
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/tab/e-id. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](http://contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](https://opensource.org/licenses/MIT).
+
+## Code of Conduct
+
+Everyone interacting in the e-id project’s codebases, issue trackers, chat rooms and mailing lists is expected to follow the [code of conduct](https://github.com/tab/e-id/blob/master/CODE_OF_CONDUCT.md).

data/Rakefile

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

data/bin/console

@@ -0,0 +1,15 @@
+#!/usr/bin/env ruby
+# frozen_string_literal: true
+
+require 'bundler/setup'
+require 'eid'
+
+# 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/docker-compose.yaml

@@ -0,0 +1,7 @@
+services:
+  e-id:
+    build: .
+    tty: true
+    stdin_open: true
+    volumes:
+      - .:/package

data/e-id.gemspec

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+lib = File.expand_path('lib', __dir__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'eid/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'e-id'
+  spec.version       = Eid::VERSION
+  spec.authors       = ['tab']
+  spec.email         = ['tab@users.noreply.github.com']
+
+  spec.summary       = 'Electronic identity in Estonia and in other countries'
+  spec.description   = 'Electronic identity in Estonia and in other countries'
+  spec.homepage      = 'https://github.com/tab/e-id'
+  spec.license       = 'MIT'
+
+  spec.required_ruby_version = '>= 2.6'
+
+  # Prevent pushing this gem to RubyGems.org. To allow pushes either set the 'allowed_push_host'
+  # to allow pushing to a single host or delete this section to allow pushing to any host.
+  if spec.respond_to?(:metadata)
+    spec.metadata['homepage_uri'] = spec.homepage
+    spec.metadata['source_code_uri'] = spec.homepage
+    spec.metadata['changelog_uri'] = 'https://github.com/tab/e-id/blob/master/CHANGELOG.md'
+  else
+    raise 'RubyGems 2.0 or newer is required to protect against ' \
+          'public gem pushes.'
+  end
+
+  # Specify which files should be added to the gem when it is released.
+  # The `git ls-files -z` loads the files in the RubyGem that have been added into git.
+  spec.files = Dir.chdir(File.expand_path(__dir__)) do
+    `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features|rspec|rubocop|github)/}) }
+  end
+  spec.bindir        = 'exe'
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 2.3.0'
+  spec.add_development_dependency 'rake', '~> 13.0.6'
+
+  spec.metadata['rubygems_mfa_required'] = 'true'
+end

data/lib/e-id.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+require 'eid/core'
+require 'eid/estonia'
+require 'eid/version'

data/lib/eid/core.rb

@@ -0,0 +1,11 @@
+# frozen_string_literal: true
+
+module Eid
+  class Core
+    attr_accessor :identity
+
+    def initialize(identity)
+      @identity = identity.to_s
+    end
+  end
+end

data/lib/eid/estonia.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Eid
+  class Estonia < Core
+    # NOTE: identity GYYMMDDSSSC
+    # G – gender
+    # YYMMDD – date of birth
+    # SSS – serial number
+    # C – checksum
+
+    def valid?
+      identity.size == 11 && birth_date.is_a?(Date)
+    end
+
+    def female?
+      identity[0].to_i.even?
+    end
+
+    def male?
+      identity[0].to_i.odd?
+    end
+
+    def gender
+      female? ? :female : :male
+    end
+
+    def birth_date
+      Date.new((century + identity[1..2].to_i), identity[3..4].to_i, identity[5..6].to_i)
+    rescue StandardError
+      nil
+    end
+
+    def age
+      Date.today.year - birth_date&.year.to_i
+    end
+
+    private
+
+    def century
+      case identity[0].to_i
+      when 1..2 then 1800
+      when 3..4 then 1900
+      when 5..6 then 2000
+      else 2100
+      end
+    end
+  end
+end

data/lib/eid/version.rb

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

metadata

@@ -0,0 +1,100 @@
+--- !ruby/object:Gem::Specification
+name: e-id
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- tab
+autorequire:
+bindir: exe
+cert_chain: []
+date: 2023-04-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 2.3.0
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 13.0.6
+description: Electronic identity in Estonia and in other countries
+email:
+- tab@users.noreply.github.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".dockerignore"
+- ".editorconfig"
+- ".github/PULL_REQUEST_TEMPLATE.md"
+- ".github/dependabot.yml"
+- ".github/workflows/checks.yaml"
+- ".github/workflows/release.yaml"
+- ".gitignore"
+- ".rspec"
+- ".rubocop.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Dockerfile
+- Gemfile
+- Gemfile.lock
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- docker-compose.yaml
+- e-id.gemspec
+- lib/e-id.rb
+- lib/eid/core.rb
+- lib/eid/estonia.rb
+- lib/eid/version.rb
+homepage: https://github.com/tab/e-id
+licenses:
+- MIT
+metadata:
+  homepage_uri: https://github.com/tab/e-id
+  source_code_uri: https://github.com/tab/e-id
+  changelog_uri: https://github.com/tab/e-id/blob/master/CHANGELOG.md
+  rubygems_mfa_required: 'true'
+post_install_message:
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.6'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.3.26
+signing_key:
+specification_version: 4
+summary: Electronic identity in Estonia and in other countries
+test_files: []