README.md in faker-russian-0.0.3 vs 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)
Генерация русских значений: ИНН, ОКПО, КПП и т.д.
+* [БИК](http://ru.wikipedia.org/wiki/Банковский_идентификационный_код) (Faker::Russian.bik)
* [ИНН](http://ru.wikipedia.org/wiki/Идентификационный_номер_налогоплательщика) (Faker::Russian.inn)
* [ОКПО](http://ru.wikipedia.org/wiki/Общероссийский_классификатор_предприятий_и_организаций) (Faker::Russian.okpo)
* [КПП](http://ru.wikipedia.org/wiki/Код_причины_постановки_на_учёт) (Faker::Russian.kpp)
* (TODO) [ОГРН](http://ru.wikipedia.org/wiki/Основной_государственный_регистрационный_номер) (Faker::Russian.ogrn)
* (TODO) [Корреспондентский счёт] (http://ru.wikipedia.org/wiki/Корреспондентский_счёт) (Faker::Russian.ks)
* (TODO) [Рассчётный счёт] (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) [СНИЛС](http://ru.wikipedia.org/wiki/Страховой_номер_индивидуального_лицевого_счёта) (Faker::Russian.snils)
* (TODO) [Значение паспорта](http://ru.wikipedia.org/wiki/Паспорт_гражданина_Российской_Федерации) (Faker::Russian.passport)
Для проверки сгенерированных значений можешь использовать [gem 'validates_russian'](https://github.com/asiniy/validates_russian)
@@ -26,10 +27,31 @@
gem 'faker-russian'
## Использование
+### БИК
+
+По умолчанию генерирует БИК со случайным номером региона по ОКАТО
+
+``` ruby
+ Faker::Russian.bik # => '0454954616'
+```
+
+Можно указывать номер региона по ОКАТО
+
+``` ruby
+ Faker::Russian.bik(okato_region_number: '40') # => '0440754281'
+```
+
+Также существуют последовательности, позволяющие получать псевдослучайные БИКи
+
+``` ruby
+ Faker::Russian.bik(sequence_number: 1) # => '0451491755'
+ Faker::Russian.bik(sequence_number: 1) # => '0451491755'
+```
+
### ИНН
Стандартно генерирует ИНН со случайным номером региона и со случайным типом (физ или юрлицо)
``` ruby
@@ -81,10 +103,39 @@
Также можно использовать последовательности (не более 1000 - количество КПП ограничено):
``` ruby
Faker::Russian.kpp(sequence_number: 1) # => '381201001'
- Faker::Russian.inn(sequence_number: 1) # => '381201001'
+ Faker::Russian.kpp(sequence_number: 1) # => '381201001'
+```
+
+### ОКАТО
+
+Генерирует ОКАТО со случайным номером региона и случайной длиной
+
+``` ruby
+ Faker::Russian.okato # => '849012471'
+```
+
+Можно указать регион по классификации окато
+
+``` ruby
+ Faker::Russian.okato(okato_region_number: 25) # => '251'
+```
+
+Можно указать длину ОКАТО:
+
+``` ruby
+ Faker::Russian.okato(length: 3) # => '251'
+ Faker::Russian.okato(length: 6) # => '443758'
+ Faker::Russian.okato(length: 9) # => '849012471'
+```
+
+Также можно использовать последовательности:
+
+``` ruby
+ Faker::Russian.okato(sequence_number: 1) # => '517'
+ Faker::Russian.okato(sequence_number: 1) # => '517'
```
## Инструкции разработчикам
Читай [CONTRIBUTING.md](CONTRIBUTING.md)