doc/english_readme.md in faker-russian-0.0.3 vs doc/english_readme.md in faker-russian-0.0.4

- old
+ new

@@ -6,17 +6,18 @@ [![Build Status](https://travis-ci.org/asiniy/faker-russian.svg?branch=master)](https://travis-ci.org/asiniy/faker-russian) [![Code Climate](https://codeclimate.com/github/asiniy/faker-russian.png)](https://codeclimate.com/github/asiniy/faker-russian) Generation of specific russian values +* [BIK](http://ru.wikipedia.org/wiki/Банковский_идентификационный_код) (Faker::Russian.bik) Russian bank identification number * [INN](http://ru.wikipedia.org/wiki/Идентификационный_номер_налогоплательщика) (Faker::Russian.inn) Russian analogue of VAT identification number * [OKPO](http://ru.wikipedia.org/wiki/Общероссийский_классификатор_предприятий_и_организаций) (Faker::Russian.okpo) Legal code * [KPP](http://ru.wikipedia.org/wiki/Код_причины_постановки_на_учёт) (Faker::Russian.kpp) Code of reason for registration * (TODO) [OGRN](http://ru.wikipedia.org/wiki/Основной_государственный_регистрационный_номер) (Faker::Russian.ogrn) Main state registration number * (TODO) [Correspondent Account Value] (http://ru.wikipedia.org/wiki/Корреспондентский_счёт) (Faker::Russian.ks) * (TODO) [Bank account value] (http://ru.wikipedia.org/wiki/Расчётный_счёт) (Faker::Russian.rs) -* (TODO) [OKATO](http://ru.wikipedia.org/wiki/Общероссийский_классификатор_объектов_административно-территориального_деления) (Faker::Russian.okato) +* [OKATO](http://ru.wikipedia.org/wiki/Общероссийский_классификатор_объектов_административно-территориального_деления) (Faker::Russian.okato) * (TODO) [SNILS](http://ru.wikipedia.org/wiki/Страховой_номер_индивидуального_лицевого_счёта) (Faker::Russian.snils) * (TODO) [Passport value](http://ru.wikipedia.org/wiki/Паспорт_гражданина_Российской_Федерации) (Faker::Russian.passport) You can use [gem 'validates_russian'](https://github.com/asiniy/validates_russian) for validates generated values @@ -26,10 +27,31 @@ gem 'validates_russian' ## Usage +### Bik + +Generates bank identification number with random okato region number + +``` ruby + Faker::Russian.bik # => '0454954616' +``` + +You can pass okato region number + +``` ruby + Faker::Russian.bik(okato_region_number: '40') # => '0440754281' +``` + +Also you can use sequences for pseudo-random Bik's + +``` ruby + Faker::Russian.bik(sequence_number: 1) # => '0451491755' + Faker::Russian.bik(sequence_number: 1) # => '0451491755' +``` + ### INN Generate INN with random region number and type (:individual or :legal) ``` ruby @@ -81,9 +103,38 @@ Also, you can use pseudo random sequence numbers (not much 1000, there is limited count of kpps) ``` ruby Faker::Russian.kpp(sequence_number: 1) # => '381201001' Faker::Russian.inn(sequence_number: 1) # => '381201001' +``` + +### ОКАТО + +Generates okato with random okato region number and random length + +``` ruby + Faker::Russian.okato # => '849012471' +``` + +You can select okato region number + +``` ruby + Faker::Russian.okato(okato_region_number: 25) # => '251' +``` + +You can select okato region length: + +``` ruby + Faker::Russian.okato(length: 3) # => '251' + Faker::Russian.okato(length: 6) # => '443758' + Faker::Russian.okato(length: 9) # => '849012471' +``` + +You can use sequences + +``` ruby + Faker::Russian.okato(sequence_number: 1) # => '517' + Faker::Russian.okato(sequence_number: 1) # => '517' ``` ## Contributing Please read [CONTRIBUTING.md](../CONTRIBUTING.md) in Russian