egn 0.2.0 → 0.4.0

data/.gitignore

@@ -16,3 +16,4 @@ test/tmp
 test/version_tmp
 tmp
 repl.rb
+.coveralls.yml

data/.rspec

@@ -0,0 +1,2 @@
+--color
+--format documentation

data/.travis.yml

@@ -0,0 +1,6 @@
+language: ruby
+rvm:
+  - "1.9.3"
+  - "2.0.0"
+  - "2.1.0"
+script: bundle exec rspec spec

data/README.md

@@ -1,6 +1,11 @@
+[![Build Status](https://travis-ci.org/gmitrev/egn.svg?branch=master)](https://travis-ci.org/gmitrev/egn)
+[![Coverage Status](https://coveralls.io/repos/gmitrev/egn/badge.png?branch=master)](https://coveralls.io/r/gmitrev/egn?branch=master)
+[![Code Climate](https://codeclimate.com/github/gmitrev/egn.png)](https://codeclimate.com/github/gmitrev/egn)
 # Egn
 
-TODO: Write a gem description
+EGN(ЕГН) is the national identification number of Bulgarian citizens. This gem 
+provides ways to generate, validate and parse any given valid number for
+information.
 
 ## Installation
 
@@ -18,7 +23,42 @@ Or install it yourself as:
 
 ## Usage
 
-TODO: Write usage instructions here
+    require "egn"
+
+    # Quickly generate a random number
+    Egn.generate
+    # => "6101047500"
+    
+    # Validate a given number
+    Egn.validate("6101047500")
+    # => true
+    
+    # Create an new EGN object with a random number
+    egn = Egn::Egn.new
+    # => 9212094524
+
+    # OR generate EGN for a specific date
+    egn = Egn::Egn.new({year: 1945, month: 5, day: 8}) 
+    # => 4505085346
+    
+    # OR parse an existing one
+    egn = Egn.parse("6101047500")
+    # => 6101047500
+    
+    egn.birth_date
+    # => #<Date: 1961-01-04 ((2437304j,0s,0n),+0s,2299161j)>
+    
+    egn.year
+    # => 1961
+    
+    egn.month 
+    # => 1
+
+    egn.day
+    # => 10
+
+    egn.valid?
+    # => true
 
 ## Contributing
 

data/Rakefile

@@ -1 +1,5 @@
 require "bundler/gem_tasks"
+
+require 'coveralls/rake/task'
+Coveralls::RakeTask.new
+task :test_with_coveralls => [:spec, :features, 'coveralls:push']

data/egn.gemspec

@@ -8,8 +8,8 @@ Gem::Specification.new do |spec|
   spec.version       = Egn::VERSION
   spec.authors       = ["gmitrev"]
   spec.email         = ["gvmitrev@gmail.com"]
-  spec.description   = %q{Generator, validator and info parser for EGN/EIK numbers}
-  spec.summary       = %q{An easy way to generate and validate EGN/EIK numbers and parse them for useful information}
+  spec.description   = %q{Generator, validator and info parser for EGN numbers}
+  spec.summary       = %q{An easy way to generate and validate EGN numbers and parse them for useful information}
   spec.homepage      = "https://github.com/gmitrev/egn"
   spec.license       = "MIT"
 
@@ -21,4 +21,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency "bundler", "~> 1.3"
   spec.add_development_dependency "rake"
   spec.add_development_dependency "rspec", "~> 2.6"
+  spec.add_development_dependency "coveralls"
 end

data/lib/egn/egn.rb

@@ -0,0 +1,60 @@
+# The main data class
+module Egn
+  class Egn
+    attr_reader :number, :birth_date
+
+    # Creates a new EGN object. Has different effects depending on the argument.
+    # When no arguments are given, it generates a new random EGN
+    # When a String is given, it is assumed that it is an EGN and is parsed
+    # When a hash is given, a new EGN is generated with the provided options
+    def initialize(args=nil)
+
+      if args.nil?
+        @number = Generator.generate
+      else
+        case args
+        when Hash
+          @number = Generator.generate(args)
+        when String
+          @number = args
+          raise ArgumentError, "Invalid EGN" unless self.valid?
+        else
+          raise ArgumentError, "Egn#new should be called either with an EGN or with an options hash"
+        end
+      end
+
+      parse!
+    end
+
+    # Is the number valid?
+    def valid?
+      @valid ||= Validator.validate(@number)
+    end
+
+    def day
+      @birth_date.day
+    end
+
+    def month
+      @birth_date.month
+    end
+
+    def year
+      @birth_date.year
+    end
+
+    def to_s
+      @number
+    end
+
+    private
+
+    # Extract the birth_date, sex and region
+    def parse!
+      info = Parser.new(@number)
+
+      @birth_date = info.date
+    end
+
+  end
+end

data/lib/egn/generator.rb

@@ -1,21 +1,27 @@
+# Generates a random valid EGN
 module Egn
   module Generator
 
-    PARITY_WEIGHTS = [2,4,8,5,10,9,7,3,6]
+    # The generated EGN will be completely random if no opitons are given.
+    # options is a hash that may have the following keys: :year, :month and :date
+    def self.generate(options={})
+      date = Util.time_rand
 
-    def self.egn
-      date = time_rand
-      year = date.year
-      mon = date.month
-      day = date.day
+      options = {
+        year:  date.year,
+        month: date.month,
+        day:   date.day
+      }.merge(options)
 
-      cent = year - (year % 100)
+      validate!(options)
+
+      century = options[:year] - (options[:year] % 100)
       sex = Random.rand(1..2)
 
-      if cent == 1800
-        mon += 20
-      elsif cent == 2000
-        mon += 40
+      if century == 1800
+        options[:month] += 20
+      elsif century == 2000
+        options[:month] += 40
       end
 
       region = Random.rand(0..999)
@@ -26,21 +32,18 @@ module Egn
         region += 1
       end
 
-      final_year = year - cent
-      egn = final_year.to_s.rjust(2, '0') + mon.to_s.rjust(2, '0') + day.to_s.rjust(2,'0') + region.to_s.rjust(3,'0')
+      final_year = options[:year] - century
+      egn = final_year.to_s.rjust(2, '0') + options[:month].to_s.rjust(2, '0') + options[:day].to_s.rjust(2,'0') + region.to_s.rjust(3,'0')
 
-      return egn + egn_checksum(egn).to_s
+      return egn + Util.egn_checksum(egn).to_s
     end
 
-    def self.egn_checksum(egn)
-      sum = egn.split('').map(&:to_i).zip(PARITY_WEIGHTS).map { |n| n.reduce(:*) }.reduce(:+)
-
-      rest = sum % 11
-      rest < 10 ? rest : 0
+    # Check if the options contain a date that is valid and be turned into an EGN
+    def self.validate!(options)
+      raise ArgumentError, "Year out of bounds" unless (1800..2099).include?(options[:year])
+      raise ArgumentError, "Month out of bounds" unless (1..12).include?(options[:month])
+      raise ArgumentError, "Day out of bounds" unless (1..31).include?(options[:day])
     end
 
-    def self.time_rand(from = 0.0, to = Time.now)
-      Time.at(from + rand * (to.to_f - from.to_f))
-    end
   end
 end

data/lib/egn/parser.rb

@@ -1,34 +1,17 @@
 module Egn
   class Parser
+    attr_reader :date, :sex
 
+    # Parses the given EGN and returns all information that can be
+    # extracted from it: date, sex and region
     def initialize(egn)
-      return ArgumentError, 'invalid length (should == 10)' unless egn.length == 10
+      raise ArgumentError, "Invalid EGN" unless Validator.validate(egn)
 
-      @year, @month, @day = egn.scan(/.{1,2}/)
-      @month = @month.to_i
-      @day = @day.to_i
-
-      case @month
-      when (1..12)
-        @year = "19#{@year}"
-      when (21..32)
-        @month -= 20
-        @year = "18#{@year}"
-      when (41..52)
-        @month -= 40
-        @year = "20#{@year}"
-      end
-      @year = @year.to_i
-
-      raise ArgumentError, "invalid date" unless Date.valid_date? @year, @month, @day
-    end
-
-    def birth_date
-      Date.parse("#{@year}-#{@month}-#{@day}")
-    end
-
-    def gender
+      # Extract the correct date
+      year, month, day = egn.scan(/.{1,2}/).map(&:to_i)
+      year, month = Util.determine_date(year, month)
 
+      @date = Date.new(year.to_i, month, day)
     end
 
   end

data/lib/egn/util.rb

@@ -0,0 +1,41 @@
+# Contains some utility methods that are used by the other classes
+module Egn
+  module Util
+    WEIGHTS = [2,4,8,5,10,9,7,3,6]
+
+    # The EGN can have three different formats depending on the century. It can 
+    # be determined by examining the month.
+    # The rules are as follows:
+    # * For people born in 1900..1999 the month does not change
+    # * For people born in 1800..1899 the month is +20 (e.g January is 21)
+    # * For people born in 2000..2099 the month is +40 (e.g December is 52)
+    def self.determine_date(year, month)
+      case month
+      when (1..12)
+        year = "19#{year}"
+      when (21..32)
+        month -= 20
+        year = "18#{year}"
+      when (41..52)
+        month -= 40
+        year = "20#{year}"
+      end
+
+      [year.to_i, month]
+    end
+
+    # The checksum is calculated from the first 9 digits.
+    def self.egn_checksum(egn)
+      sum = egn.split('').map(&:to_i).zip(WEIGHTS).map { |n| n.reduce(:*) }.reduce(:+)
+
+      rest = sum % 11
+      rest < 10 ? rest : 0
+    end
+
+    # Get a random date
+    def self.time_rand(from = 0.0, to = Time.now)
+      Time.at(from + rand * (to.to_f - from.to_f))
+    end
+
+  end
+end

data/lib/egn/validator.rb

@@ -1,29 +1,18 @@
 module Egn
-  module Validator
+  class Validator
 
-    def self.egn(egn)
+    # Checks if a given EGN is valid
+    def self.validate(egn)
       return false unless egn.length == 10
 
-      year, month, day = egn.scan(/.{1,2}/)
-      month = month.to_i
-      day = day.to_i
-
-      case month
-      when (1..12)
-        year = "19#{year}"
-      when (21..32)
-        month -= 20
-        year = "18#{year}"
-      when (41..52)
-        month -= 40
-        year = "20#{year}"
-      end
-      year = year.to_i
+      # Extract the correct year and month
+      year, month, day = egn.scan(/.{1,2}/).map(&:to_i)
+      year, month = Util.determine_date(year, month)
 
       return false unless Date.valid_date? year, month, day
 
-      checksum = Generator.egn_checksum egn[0,9]
-
+      # Calculate the checksum and check if the given one is correct
+      checksum = Util.egn_checksum egn[0,9]
       checksum == egn[9].to_i
     end
 

data/lib/egn/version.rb

@@ -1,3 +1,3 @@
 module Egn
-  VERSION = "0.2.0"
+  VERSION = "0.4.0"
 end

data/lib/egn.rb

@@ -1,22 +1,27 @@
 require "date"
 
-require "egn/generator"
+require "egn/egn"
 require "egn/parser"
 require "egn/validator"
+require "egn/generator"
 require "egn/version"
+require "egn/util"
 
 module Egn
 
-  def self.generate
-    Generator.egn
+  # Quick generate: returns a new number
+  def self.generate(options={})
+    Generator.generate(options)
   end
 
+  # Quick validate
   def self.validate(egn)
-    Validator.egn(egn)
+    Validator.validate(egn)
   end
 
+  # Quick parse
   def self.parse(egn)
-    Parser.new(egn)
+    Egn.new(egn)
   end
 
 end

data/spec/egn/egn_spec.rb

@@ -0,0 +1,85 @@
+require 'spec_helper' 
+
+describe "Egn" do
+
+  describe '.initialize' do
+
+    context "invoked with no args" do
+
+      it 'generates a valid number' do
+        egn = Egn::Egn.new
+
+        expect(egn).to be_valid
+      end
+
+      it 'returns different number every time' do
+        egn1 = Egn::Egn.new
+        egn2 = Egn::Egn.new
+
+        expect(egn1.number).not_to eq egn2.number
+      end
+
+      it "delegates the creation to Generators::Egn" do
+
+        Egn::Generator.should_receive(:generate).and_return "6101047500"
+
+        Egn::Egn.new
+      end
+
+    end
+
+    context "invoked with an EGN " do
+
+      it "returns a new Egn object if the provided EGN is valid" do
+        egn = Egn::Egn.new('6101047500')
+        
+        expect(egn).to be_valid
+      end
+
+      it "raises an ArgumentError if the provided EGN is not valid" do
+        expect{
+          Egn::Egn.new("I'm invalid")
+        }.to raise_error ArgumentError
+      end
+
+    end
+
+    context "invoked with an options hash" do
+
+      it "passes the options to the #generate method" do
+        options = {
+          year: 1960,
+          month: 12
+        }
+
+        Egn::Generator.should_receive(:generate).with(options).and_return('6012081988')
+
+        Egn::Egn.new(options)
+      end
+
+    end
+
+    context "invoked with something else" do
+      it 'raises an ArgumentError' do
+        expect{
+          Egn::Egn.new([1,2,'hi'])
+        }.to raise_error ArgumentError
+      end
+    end
+  end
+
+  describe "valid?" do
+    it 'delegates the validation to Validators::Egn' do
+      egn = Egn::Egn.new
+      Egn::Validator.should_receive(:validate).with(egn.number)
+      egn.valid?
+    end
+  end
+
+
+  describe 'validating'
+
+  describe 'parsing'
+
+end
+

data/spec/egn/generator_spec.rb

@@ -0,0 +1,88 @@
+require 'spec_helper'
+
+describe Egn::Generator do
+
+  describe "#generate" do
+    context "invoked with no arguments" do
+
+      it 'generates a valid number' do
+        egn = Egn::Generator.generate
+
+        expect(egn).not_to be_empty
+      end
+
+      it 'returns different number every time' do
+        egn1 = Egn::Generator.generate
+        egn2 = Egn::Generator.generate
+
+        expect(egn1).not_to eq egn2
+      end
+
+    end
+
+    context "invoked with arguments" do
+      it "generates a new EGN considering the given options" do
+        number = Egn::Generator.generate(year: 1990, month: 12, day: 30, sex: :m)
+        egn = Egn::Egn.new(number)
+
+        expect(egn).to be_valid
+      end
+
+      it "generates a new EGN with the given year" do
+        number = Egn::Generator.generate(year: 1990)
+        egn = Egn::Egn.new(number)
+
+        expect(egn.year).to eq(1990)
+      end
+
+      it "generates a new EGN with the given month" do
+        number = Egn::Generator.generate(month: 6)
+        egn = Egn::Egn.new(number)
+
+        expect(egn.month).to eq(6)
+      end
+
+      it "generates a new EGN with the given day" do
+        number = Egn::Generator.generate(day: 15)
+        egn = Egn::Egn.new(number)
+
+        expect(egn.day).to eq(15)
+      end
+
+      it "validates the options" do
+
+        options = {year: 1960, month: 6, day: 3}
+
+        Egn::Generator.should_receive(:validate!).with(options)
+
+        Egn::Generator.generate(options)
+      end
+
+
+    end
+  end
+
+  describe "#validate!" do
+
+    it "raises an exception if invalid year is given" do
+      expect{
+        Egn::Generator.generate(year: 1500)
+      }.to raise_error ArgumentError
+    end
+
+    it "raises an exception if invalid month is given" do
+      expect{
+        Egn::Generator.generate(month: 15)
+      }.to raise_error ArgumentError
+    end
+
+    it "raises an exception if invalid day is given" do
+      expect{
+        Egn::Generator.generate(day: 33)
+      }.to raise_error ArgumentError
+    end
+
+  end
+
+end
+

data/spec/egn/parser_spec.rb

@@ -0,0 +1,12 @@
+require 'spec_helper'
+
+describe Egn::Parser do
+
+  describe "#initialize" do
+    it "raises an exception if the argument is invalid" do
+      expect{ Egn::Parser.new("12345678") }.to raise_error ArgumentError
+    end
+  end
+
+end
+

data/spec/egn/validator_spec.rb

@@ -0,0 +1,29 @@
+require 'spec_helper'
+
+describe Egn::Validator do
+
+  describe "#validate" do
+
+    it "fails for strings with incorrect size" do
+      expect(Egn::Validator.validate("123456789")).to be_false
+      expect(Egn::Validator.validate("12345678901")).to be_false
+    end
+
+    it "fails for incorrect dates" do
+
+      expect(Egn::Validator.validate("6101347500")).to be_false
+    end
+
+    it "checks 500 000 of the generated numbers", :brute  do
+      egns = Array.new(500_000).map{ |i| Egn.generate }
+      egns.each do |egn|
+        result = Egn::Validator.validate(egn)
+        puts egn unless result
+        expect(result).to be_true
+      end
+    end
+
+  end
+
+end
+

data/spec/spec_helper.rb

@@ -0,0 +1,17 @@
+require 'bundler/setup'
+Bundler.setup
+
+require 'egn'
+
+require 'coveralls'
+Coveralls.wear!
+
+RSpec.configure do |config|
+  config.treat_symbols_as_metadata_keys_with_true_values = true
+  config.run_all_when_everything_filtered = true
+  config.filter_run :focus
+  config.filter_run_excluding :brute
+
+
+  config.order = 'random'
+end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: egn
 version: !ruby/object:Gem::Version
-  version: 0.2.0
+  version: 0.4.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-03-19 00:00:00.000000000 Z
+date: 2014-03-26 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -59,7 +59,23 @@ dependencies:
     - - ~>
       - !ruby/object:Gem::Version
         version: '2.6'
-description: Generator, validator and info parser for EGN/EIK numbers
+- !ruby/object:Gem::Dependency
+  name: coveralls
+  requirement: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    none: false
+    requirements:
+    - - ! '>='
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Generator, validator and info parser for EGN numbers
 email:
 - gvmitrev@gmail.com
 executables: []
@@ -67,17 +83,25 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- .rspec
+- .travis.yml
 - Gemfile
 - LICENSE
-- LICENSE.txt
 - README.md
 - Rakefile
 - egn.gemspec
 - lib/egn.rb
+- lib/egn/egn.rb
 - lib/egn/generator.rb
 - lib/egn/parser.rb
+- lib/egn/util.rb
 - lib/egn/validator.rb
 - lib/egn/version.rb
+- spec/egn/egn_spec.rb
+- spec/egn/generator_spec.rb
+- spec/egn/parser_spec.rb
+- spec/egn/validator_spec.rb
+- spec/spec_helper.rb
 homepage: https://github.com/gmitrev/egn
 licenses:
 - MIT
@@ -91,18 +115,28 @@ required_ruby_version: !ruby/object:Gem::Requirement
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 152494033
 required_rubygems_version: !ruby/object:Gem::Requirement
   none: false
   requirements:
   - - ! '>='
     - !ruby/object:Gem::Version
       version: '0'
+      segments:
+      - 0
+      hash: 152494033
 requirements: []
 rubyforge_project: 
 rubygems_version: 1.8.23
 signing_key: 
 specification_version: 3
-summary: An easy way to generate and validate EGN/EIK numbers and parse them for useful
+summary: An easy way to generate and validate EGN numbers and parse them for useful
   information
-test_files: []
-has_rdoc: 
+test_files:
+- spec/egn/egn_spec.rb
+- spec/egn/generator_spec.rb
+- spec/egn/parser_spec.rb
+- spec/egn/validator_spec.rb
+- spec/spec_helper.rb

data/LICENSE.txt

@@ -1,22 +0,0 @@
-Copyright (c) 2013 gmitrev
-
-MIT License
-
-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.