snils 0.1.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: 6a2f1950c8b25a7604324cbb84d179fb53251f10
+  data.tar.gz: dfdc5be3335785ece5d5bf3964e509acc7424be9
+SHA512:
+  metadata.gz: 070f9179663627b3d3fb152037f63fdb5790da26429dc7d9db3beb2ec5950597e43d28d1c1a7ef80ab25f96d07d4514bef8d260e0196b808126e37a7d13edd14
+  data.tar.gz: a1032ea644a7f785855ca70b45301ecae1e6d95770f6bb0fbf3394f35e2d609bc8602d2b3c3cdfba2192f5c98f265c1c8bd4fe3743cb50b9925bbca114a52b3c

data/.gitignore

@@ -0,0 +1,23 @@
+*.gem
+*.rbc
+.bundle
+.config
+.yardoc
+Gemfile.lock
+InstalledFiles
+_yardoc
+coverage
+doc/
+html/
+lib/bundler/man
+pkg
+rdoc
+spec/reports
+test/tmp
+test/version_tmp
+tmp
+*.bundle
+*.so
+*.o
+*.a
+mkmf.log

data/.rspec

@@ -0,0 +1,3 @@
+--color
+--warnings
+--format documentation

data/.travis.yml

@@ -0,0 +1,15 @@
+language: ruby
+
+rvm:
+  - 1.8.7
+  - ree
+  - 1.9.3
+  - 2.0.0
+  - 2.1
+  - jruby
+  - rbx
+  - ruby-head
+
+matrix:
+  allow_failures:
+    - rvm: ruby-head

data/Gemfile

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

data/LICENSE.txt

@@ -0,0 +1,22 @@
+Copyright (c) 2014 Andrey Novikov
+
+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.

data/README.md

@@ -0,0 +1,82 @@
+SNILS
+=====
+
+[![Gem Version](https://badge.fury.io/rb/snils.svg)](http://badge.fury.io/rb/snils)
+[![Continuous Integration status](https://api.travis-ci.org/Envek/snils.svg)](http://travis-ci.org/Envek/snils)
+
+Generating, validating and formatting [SNILS] number (Russian pension insurance individual account number).
+
+Генерация, валидация и форматирование СНИЛС (Страхового номера индивидуального лицевого счёта).
+
+[Read this README in Russian (Читать это README на русском)](README.ru.md)
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+    gem 'snils'
+
+And then execute:
+
+    $ bundle
+
+Or install it yourself as:
+
+    $ gem install snils
+
+## Usage
+
+Generate new SNILS:
+
+```ruby
+Snils.new.formatted
+#=> "216-471-647 63"
+```
+
+Validate SNILS:
+
+```ruby
+Snils.new("21647164763").valid?
+#=> true
+
+Snils.new("21647164760").valid?
+#=> false
+
+Snils.new("21647164760").errors
+#=> [:invalid]
+
+Snils.new("216471647").errors
+#=> [[:wrong_length, {:count=>11}], :invalid]
+```
+
+Validating Rails model attributes:
+
+```ruby
+require 'snils'
+
+class User < ActiveRecord::Base
+  validates :snils, presence: true, uniqueness: true
+  validate  :snils_validation
+  
+  protected
+  
+  def snils_validation
+    validated_snils = Snils.new(snils)
+    unless validated_snils.valid?
+      validated_snils.errors.each do |error|
+        errors.add(:snils, *error)
+      end
+    end
+  end
+end
+```
+
+## Contributing
+
+1. Fork it ( https://github.com/Envek/snils/fork )
+2. Create your feature branch (`git checkout -b my-new-feature`)
+3. Commit your changes (`git commit -am 'Add some feature'`)
+4. Push to the branch (`git push origin my-new-feature`)
+5. Create a new Pull Request
+
+[SNILS]: http://en.wikipedia.org/wiki/SNILS_(Russia) "Insurance individual account number"

data/README.ru.md

@@ -0,0 +1,77 @@
+СНИЛС
+=====
+
+Генерация, валидация и форматирование [СНИЛС] (Страхового номера индивидуального лицевого счёта).
+
+[Read this README in English (Читать это README на английском)](README.ru.md)
+
+## Установка
+
+Добавьте следующую строчку в Gemfile в вашем приложении:
+
+    gem 'snils'
+
+И затем выполните:
+
+    $ bundle
+
+Или установите вручную:
+
+    $ gem install snils
+
+## Использование
+
+Генерирование новых СНИЛСов:
+
+```ruby
+Snils.new.formatted
+#=> "216-471-647 63"
+```
+
+Проверка корректности СНИЛСов:
+
+```ruby
+Snils.new("21647164763").valid?
+#=> true
+
+Snils.new("21647164760").valid?
+#=> false
+
+Snils.new("21647164760").errors
+#=> [:invalid]
+
+Snils.new("216471647").errors
+#=> [[:wrong_length, {:count=>11}], :invalid]
+```
+
+Валидация в Ruby on Rails для атрибутов моделей:
+
+```ruby
+require 'snils'
+
+class User < ActiveRecord::Base
+  validates :snils, presence: true, uniqueness: true
+  validate  :snils_validation
+  
+  protected
+  
+  def snils_validation
+    validated_snils = Snils.new(snils)
+    unless validated_snils.valid?
+      validated_snils.errors.each do |error|
+        errors.add(:snils, *error)
+      end
+    end
+  end
+end
+```
+
+## Помощь в разработке
+
+1. Сделайте форк проекта в своём github-аккаунте. ( https://github.com/Envek/snils/fork )
+2. Создайте отдельную ветвь разработки. (`git checkout -b my-new-feature`)
+3. Внесите в неё желаемые изменения (не забудьте про тесты!) и сделайте коммит(ы). (`git commit -am 'Add some feature'`)
+4. Запушьте изменения (`git push origin my-new-feature`)
+5. Создайте новый Pull Request
+
+[СНИЛС]: http://ru.wikipedia.org/wiki/%D0%A1%D1%82%D1%80%D0%B0%D1%85%D0%BE%D0%B2%D0%BE%D0%B9_%D0%BD%D0%BE%D0%BC%D0%B5%D1%80_%D0%B8%D0%BD%D0%B4%D0%B8%D0%B2%D0%B8%D0%B4%D1%83%D0%B0%D0%BB%D1%8C%D0%BD%D0%BE%D0%B3%D0%BE_%D0%BB%D0%B8%D1%86%D0%B5%D0%B2%D0%BE%D0%B3%D0%BE_%D1%81%D1%87%D1%91%D1%82%D0%B0

data/Rakefile

@@ -0,0 +1,14 @@
+require 'bundler/gem_tasks'
+
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)
+
+task :default => :spec
+
+require 'rdoc/task'
+
+RDoc::Task.new do |rdoc|
+  rdoc.main = 'README.md'
+  rdoc.rdoc_files.include('README.md', 'README.ru.md', 'LICENSE.txt', 'lib/**/*.rb')
+end

data/lib/snils.rb

@@ -0,0 +1,80 @@
+require 'snils/version'
+
+# Generating, validating and formatting SNILS number Russian pension insurance individual account number)
+class Snils
+
+  # New object with SNILS +number+ if provided. Otherwise, it generated randomly
+  def initialize(number = nil)
+    @snils = if number.kind_of? Numeric
+               '%011d' % number
+             elsif number
+               number.to_s.gsub(/[^\d]/, '')
+             else
+               self.class.generate
+             end
+    @errors = []
+    @validated = false
+  end
+
+  # Calculates checksum (last 2 digits) of a number
+  def checksum
+    digits = @snils.split('').take(9).map(&:to_i)
+    checksum = digits.each.with_index.inject(0) do |sum, (digit, index)|
+      sum + digit * (9 - index)
+    end
+    checksum = case
+                 when (100..101).cover?(checksum)
+                   0
+                 when checksum > 101
+                   checksum % 101
+                 else
+                   checksum
+               end
+    '%02d' % checksum
+  end
+
+  # Validates SNILS. Valid SNILS is a 11 digits long and have correct checksum
+  def valid?
+    validate  unless @validated
+    @errors.none?
+  end
+
+  # Validates string with a SNILS. Valid SNILS is a 11 digits long and have correct checksum.
+  def self.valid?(snils)
+    self.new(snils).valid?
+  end
+
+  # Returns SNILS in format 000-000-000 00
+  def formatted
+    "#{@snils[0..2]}-#{@snils[3..5]}-#{@snils[6..8]} #{@snils[9..10]}"
+  end
+
+  # Returns unformatted SNILS (only 11 digits)
+  def raw
+    @snils
+  end
+  alias_method :to_s, :raw
+
+  # Returns array with errors if SNILS invalid
+  def errors
+    validate  unless @validated
+    @errors
+  end
+
+  # Generates new random valid SNILS
+  def self.generate
+    digits = Array.new(9).map{ rand (0..9) }.join
+    sum = self.new(digits).checksum
+    "#{digits}#{sum}"
+  end
+
+  protected
+
+  def validate
+    @errors << [:wrong_length, :count => 11]  unless @snils.length == 11
+    @errors << :invalid unless @snils[-2..-1] == self.checksum
+    @validated = true
+  end
+
+end
+

data/lib/snils/version.rb

@@ -0,0 +1,3 @@
+class Snils
+  VERSION = '0.1.0'
+end

data/snils.gemspec

@@ -0,0 +1,27 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'snils/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = 'snils'
+  spec.version       = Snils::VERSION
+  spec.authors       = ['Andrey Novikov']
+  spec.email         = ['envek@envek.name']
+  spec.summary       = %q{Generating, validating and formatting SNILS number (Russian pension insurance number)}
+  spec.homepage      = 'https://github.com/Envek/snils'
+  spec.license       = 'MIT'
+
+  spec.files         = `git ls-files -z`.split("\x0")
+  spec.executables   = spec.files.grep(%r{^bin/}) { |f| File.basename(f) }
+  spec.test_files    = spec.files.grep(%r{^(test|spec|features)/})
+  spec.require_paths = ['lib']
+
+  spec.add_development_dependency 'bundler', '~> 1.6'
+  spec.add_development_dependency 'rake'
+  spec.add_development_dependency 'rspec', '~> 3.0'
+  spec.add_development_dependency 'rdoc'
+
+  spec.extra_rdoc_files = ['README.md', 'README.ru.md', 'LICENSE.txt']
+  spec.rdoc_options << '--main' << 'README.md'
+end

data/spec/snils_spec.rb

@@ -0,0 +1,123 @@
+require 'rspec'
+require 'snils'
+
+describe Snils do
+
+  # DISCLAIMER: All SNILS used there ARE GENERATED AND RANDOM. Any coincidences are accidental.
+
+  describe '#initialize' do
+
+    it 'should initialize with formatted snils' do
+      snils = described_class.new('963-117-158 08')
+      expect(snils.raw).to eq('96311715808')
+    end
+
+    it 'should initialize with unformatted snils' do
+      snils = described_class.new('96311715808')
+      expect(snils.raw).to eq('96311715808')
+    end
+
+    it 'should initialize with numeric snils' do
+      snils = described_class.new(96311715808)
+      expect(snils.raw).to eq('96311715808')
+    end
+
+    it 'should generate new snils if nothing provided' do
+      snils = described_class.new
+      expect(snils.raw.length).to eq(11)
+      expect(snils.valid?).to be true
+    end
+
+  end
+
+  describe '#valid?' do
+
+    it 'should validate valid snils' do
+      snils = described_class.new('963-117-158 08')
+      expect(snils.valid?).to be true
+    end
+
+    it 'should not validate invalid snils (with wrong checksum)' do
+      snils = described_class.new('963-117-158 00')
+      expect(snils.valid?).to be false
+    end
+
+    it 'should not validate invalid snils (with wrong length)' do
+      snils = described_class.new('963-117-158 000')
+      expect(snils.valid?).to be false
+    end
+
+    it 'should not validate invalid snils (with wrong length)' do
+      snils = described_class.new('963-117-158')
+      expect(snils.valid?).to be false
+    end
+
+  end
+
+  describe '#errors' do
+
+    it 'should return empty array for valid snils' do
+      snils = described_class.new('963-117-158 08')
+      expect(snils.errors).to eq []
+    end
+
+    it 'should not validate invalid snils (with wrong checksum)' do
+      snils = described_class.new('963-117-158 00')
+      expect(snils.errors).to include :invalid
+    end
+
+    it 'should not validate invalid snils (with wrong length)' do
+      snils = described_class.new('963-117-158 080')
+      expect(snils.errors).to include [:wrong_length, :count => 11]
+    end
+
+    it 'should not validate invalid snils (with wrong length)' do
+      snils = described_class.new('963-117-158')
+      expect(snils.errors).to include [:wrong_length, :count => 11]
+    end
+
+  end
+
+  describe '#checksum' do
+
+    it 'calculates valid checksum' do
+      snils = described_class.new('96311715808')
+      expect(snils.checksum).to eq('08')
+      snils = described_class.new('83568300320')
+      expect(snils.checksum).to eq('20')
+      snils = described_class.new('61310200300')
+      expect(snils.checksum).to eq('00')
+    end
+
+    it 'calculates valid checksum even for invalid snils' do
+      snils = described_class.new('96311715800')
+      expect(snils.checksum).to eq('08')
+    end
+
+    it 'calculates valid checksum even for incomplete snils' do
+      snils = described_class.new('188299822')
+      expect(snils.checksum).to eq('50')
+    end
+
+  end
+
+  describe '#formatted' do
+    it 'outputs formatted snils' do
+      snils = described_class.new('96311715808')
+      expect(snils.formatted).to eq('963-117-158 08')
+    end
+  end
+
+  describe '.generate' do
+    it 'generates valid snils' do
+      expect(described_class.valid?(described_class.generate)).to be true
+    end
+  end
+
+  describe '.validate' do
+    it 'validates valid snils' do
+      expect(described_class.valid?(described_class.generate)).to be true
+    end
+  end
+
+end

metadata

@@ -0,0 +1,119 @@
+--- !ruby/object:Gem::Specification
+name: snils
+version: !ruby/object:Gem::Version
+  version: 0.1.0
+platform: ruby
+authors:
+- Andrey Novikov
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2014-06-30 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '1.6'
+- !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: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: rdoc
+  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'
+description: 
+email:
+- envek@envek.name
+executables: []
+extensions: []
+extra_rdoc_files:
+- README.md
+- README.ru.md
+- LICENSE.txt
+files:
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- Gemfile
+- LICENSE.txt
+- README.md
+- README.ru.md
+- Rakefile
+- lib/snils.rb
+- lib/snils/version.rb
+- snils.gemspec
+- spec/snils_spec.rb
+homepage: https://github.com/Envek/snils
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options:
+- "--main"
+- README.md
+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.2.2
+signing_key: 
+specification_version: 4
+summary: Generating, validating and formatting SNILS number (Russian pension insurance
+  number)
+test_files:
+- spec/snils_spec.rb