amka 1.0.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 76922012dc2b85729db33348da7753fc164eed0b
+  data.tar.gz: d3260e6a18b05709bc15267203cbbe736af86f99
+SHA512:
+  metadata.gz: cac4f4858fb5a86a16b4d6f3691ab1fb9e0dc05710d204b99df4ca07dc471ed134e248982e78eaa8dff9b5e6929f9d264a7d5fc4bc0bbcf34d449e20b1961f15
+  data.tar.gz: 54479b23df39970651323b2a2760d93ba810f67caf93d2e85f2dacd05376681d1b905a0d67a864986def51cbcb87cba66fcf33fc51b8ccbf6c2ae179bbeeae6b

data/.gitignore

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

data/.ruby-version

@@ -0,0 +1 @@
+2.2.3@amka

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in amka.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2015 Ioannis Angelakopoulos
+
+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,80 @@
+# AMKA and Luhn IDs Validator / Generator
+##### Α.Μ.Κ.Α (Αριθμός Μητρώου Κοινωνικής Ασφάλισης)
+This gem validates **A.M.K.A** Greek social security IDs by
+using the Luhn algorithm, as described in this [Wikipedia article](https://en.wikipedia.org/wiki/Luhn_algorithm).
+The only additional validation needed that applies to Greek A.M.K.A is that the
+first 6 digits must be a valid date (date of birth).
+
+The gem also *validates* and *generates* **Luhn** ids, as well as *generating*
+**AMKA** (like) ids. The *like* here means that the AMKA generated are not
+**real** as those provided by the Official Authorities in Greece.
+
+There is an online calculator in [planetcalc](http://planetcalc.com/2464/), you
+can validate the results of the gem, until you are confident that is working
+as it should. Try you own and your family AMKA.
+
+**DISCLAIMER**: The gem *does not* validate the real existence of the A.M.K.A or that it
+belongs to a given person. The same applies to the generator.
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'amka'
+```
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install amka
+
+## Usage
+
+```ruby
+require 'amka'
+
+# To validate (takes the AMKA as a string and returns true or false)
+Amka.valid?('01011441432')
+# returns false (i did not use a valid one in this example just in case
+# it belonged to a real person!!!!)
+
+# To generate (returns the AMKA as a string)
+Amka.generate
+
+# To generate with a specific date (date format: [d]d/[m]m/yyyy)
+# returns: 101190xxxxx
+Amka.generate('10/11/1990')
+
+###### Bonus ######
+
+# To validate any number against the Luhn algorithm
+Amka::Luhn.valid?('1142376755673') # returns true
+
+# To generate a Luhn id
+# takes up to 2 arguments: total, id_start(optional)
+# total: how many digits you want in the Luhn generated
+# id_start: string of numbers to include from the start of the Luhn
+# - total must be greater than id_start by at least one, to account for the
+#   rightmost check digit.
+Amka::Luhn.generate(13) # returns '5361281695669'
+Amka::Luhn.generate(10, '123456789') # returns '1234567897', 7 is the check digit.
+Amka::Luhn.generate(15, '12345') # returns something like: '123450789968798'
+```
+
+## TODO
+
+Add tests for the Luhn class.
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/ioagel/amka.
+
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+

data/Rakefile

@@ -0,0 +1,8 @@
+require 'bundler/gem_tasks'
+
+require 'rake/testtask'
+
+Rake::TestTask.new do |t|
+  t.libs << 'test'
+  t.pattern = 'test/*_test.rb'
+end

data/amka.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'amka/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "amka"
+  spec.version       = Amka::VERSION
+  spec.authors       = ["Ioannis Angelakopoulos"]
+  spec.email         = ["ioagel@gmail.com"]
+
+  spec.summary       = %q{AMKA/Luhn IDs Generator and Validator}
+  spec.description   = %q{Generates and Validates Greek A.M.K.A (social security number) and Luhn IDs, using the Luhn algorithm. DISCLAIMER: It does not validate the real existence of the A.M.K.A or that it belongs to a given person. The same applies to the generator.}
+  spec.homepage      = "https://github.com/ioagel/amka"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.add_development_dependency "minitest"
+  spec.add_development_dependency "minitest-reporters"
+  spec.add_development_dependency "mocha"
+  spec.add_development_dependency "bundler", "~> 1.10"
+  spec.add_development_dependency "rake", "~> 10.0"
+end

data/bin/console

@@ -0,0 +1,14 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "amka"
+
+# 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

data/bin/setup

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

data/lib/amka.rb

@@ -0,0 +1,56 @@
+require 'amka/version'
+require 'date'
+
+module Amka
+
+  def self.valid?(amka, year = nil)
+    Utils.string_with_digits_or_fail amka
+
+    return false unless length_is_11?(amka)
+
+    return Luhn.valid?(amka) if Utils.valid_date?(amka, year)
+
+    false
+  end
+
+  def self.generate(date_of_birth = nil)
+    return generate_with_date_of_birth(date_of_birth) unless date_of_birth.nil?
+
+    date_6_digits = ''
+    loop do
+      day = rand(0..3).to_s << rand(0..9).to_s
+      next if day == '00' || day.to_i > 31
+      month = rand(0..1).to_s << rand(0..2).to_s
+      next if month == '00' || month.to_i > 12
+      year = rand(19..20).to_s << rand(0..9).to_s << rand(0..9).to_s
+      next if year.to_i > Date.today.year
+
+      if Utils.valid_date?(date = day << month << year[2..3], year)
+        date_6_digits = date
+        break
+      end
+    end
+
+    Luhn.generate(11, date_6_digits)
+  end
+
+  def self.generate_with_date_of_birth(date_of_birth)
+    Utils.string_with_date_or_fail date_of_birth
+
+    day, month, year = date_of_birth.split('/').map { |i| i.length == 1 && ('0' << i) or i }
+    date_6_digit = day << month << year[2..3]
+    fail ArgumentError, 'The date of birth is invalid!' unless Utils.valid_date?(date_6_digit, year)
+
+    Luhn.generate(11, date_6_digit)
+  end
+  private_class_method :generate_with_date_of_birth
+
+  def self.length_is_11?(id)
+    id.length == 11
+  end
+  private_class_method :length_is_11?
+
+end
+
+require 'amka/luhn'
+require 'amka/utils'

data/lib/amka/luhn.rb

@@ -0,0 +1,55 @@
+module Amka
+  # Implements the Luhn algorithm as described in the wikipedia article
+  # https://en.wikipedia.org/wiki/Luhn_algorithm
+  class Luhn
+
+    def self.valid?(luhn_id)
+      Utils.string_with_digits_or_fail luhn_id
+
+      digits_sum = calculate_digits_sum(luhn_id)
+
+      (digits_sum % 10) == 0
+    end
+
+    def self.generate(total, id_start = '')
+      validate_generate_args_or_fail(total, id_start)
+      id_start == '' && total == 1 and return '0'
+
+      last_digits_length = total - id_start.length
+      last_digits_except_check = ''
+      # subtract by one to account for the check digit
+      (last_digits_length - 1).times { last_digits_except_check << rand(0..9).to_s }
+      luhn_id_except_check_digit = id_start << last_digits_except_check
+
+      digits_sum = calculate_digits_sum(luhn_id_except_check_digit, true)
+
+      check_digit = (digits_sum * 9) % 10
+
+      luhn_id_except_check_digit << check_digit.to_s
+    end
+
+    def self.calculate_digits_sum(luhn_id, generate = false)
+      luhn_id_double = luhn_id.chars.reverse.map(&:to_i).map.with_index do |digit, i|
+        if (!generate && i.odd?) || (generate && i.even?)
+          if (digit *= 2) > 9
+            # digit = digit.to_s.chars.map(&:to_i).reduce(:+)
+            digit -= 9
+          end
+        end
+        digit
+      end
+      luhn_id_double.reduce(:+)
+    end
+    private_class_method :calculate_digits_sum
+
+    def self.validate_generate_args_or_fail(total, id_start)
+      Utils.string_with_digits_or_empty_or_fail id_start
+      Utils.positive_integer_or_fail total
+      total > id_start.length or
+        fail ArgumentError, "'#{total}': must be greater at least by one from string length: "\
+                            "#{id_start.length}, to account for the check digit!"
+    end
+    private_class_method :validate_generate_args_or_fail
+
+  end
+end

data/lib/amka/utils.rb

@@ -0,0 +1,57 @@
+module Amka
+
+  class Utils
+    class << self
+      def string_with_digits_or_fail(id)
+        id.is_a?(String) && id.match(/\A\d+\Z/) or
+          fail ArgumentError, "'#{id}': must be a string of digits only!"
+      end
+
+      def string_with_digits_or_empty_or_fail(id)
+        id.is_a?(String) && id.match(/\A\d*\Z/) or
+          fail ArgumentError, "'#{id}': must be a string of digits or even an empty one!"
+      end
+
+      def string_with_date_or_fail(date)
+        date.is_a?(String) && date.match(%r{\A\d?\d{1}/\d?\d{1}/\d{4}\Z}) or
+          fail ArgumentError, 'date of birth must be in this format: [d]d/[m]m/yyyy'
+      end
+
+      def positive_integer_or_fail(num)
+        num.is_a?(Integer) && num > 0 or
+          fail ArgumentError, "'#{num}': must be a non-zero positive integer!"
+      end
+
+      def valid_date?(date, year = nil)
+        return false unless date.match(/\A\d{6,}\Z/)
+
+        unless year.nil?
+          year.is_a?(String) && year.match(/\A\d{4}\Z/) or
+            fail ArgumentError, 'Year must be a 4 digit string'
+          year.to_i >= 1800 && year.to_i <= Date.today.year or
+            fail ArgumentError, 'Year must be between 1800 and current!'
+          year[2..3] == date[4..5] or
+            fail ArgumentError, 'The last 2 digits of year parameter and the 2 digits'\
+                                ' that correspond to the year in date must be equal!'
+          begin
+            dob = Date.strptime(date[0..3] << year, '%d%m%Y')
+            return dob < Date.today
+          rescue ArgumentError
+            return false
+          end
+        end
+
+        begin
+          date_2_digit_year = Date.strptime(date[0..5], '%d%m%y')
+          if date_2_digit_year > Date.today
+            Date.strptime(date[0..3] << '19' << date[4..5], '%d%m%Y')
+          end
+          return true
+        rescue ArgumentError
+          return false
+        end
+      end
+    end
+  end
+
+end

data/lib/amka/version.rb

@@ -0,0 +1,3 @@
+module Amka
+  VERSION = '1.0.0'
+end

metadata

@@ -0,0 +1,129 @@
+--- !ruby/object:Gem::Specification
+name: amka
+version: !ruby/object:Gem::Version
+  version: 1.0.0
+platform: ruby
+authors:
+- Ioannis Angelakopoulos
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2015-12-16 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: minitest
+  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: minitest-reporters
+  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: mocha
+  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: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.10'
+- !ruby/object:Gem::Dependency
+  name: rake
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+description: 'Generates and Validates Greek A.M.K.A (social security number) and Luhn
+  IDs, using the Luhn algorithm. DISCLAIMER: It does not validate the real existence
+  of the A.M.K.A or that it belongs to a given person. The same applies to the generator.'
+email:
+- ioagel@gmail.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".gitignore"
+- ".ruby-version"
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- amka.gemspec
+- bin/console
+- bin/setup
+- lib/amka.rb
+- lib/amka/luhn.rb
+- lib/amka/utils.rb
+- lib/amka/version.rb
+homepage: https://github.com/ioagel/amka
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.5.0
+signing_key: 
+specification_version: 4
+summary: AMKA/Luhn IDs Generator and Validator
+test_files: []