Merge pull request #6 from movemove-io/Feature/Passport

pipisco · web-flow · commit 6827a459c313 · 2020-10-15T18:22:12.000+03:00
Added passport's methods. Tests. Documentation
diff --git a/README.md b/README.md
@@ -57,6 +57,9 @@ DADATA_TIMEOUT=10
 - **Работа с банками**
   - [Банк по БИК, SWIFT, ИНН или регистрационному номеру](https://github.com/movemove-io/laravel-dadata#%D0%B1%D0%B0%D0%BD%D0%BA-%D0%BF%D0%BE-%D0%B1%D0%B8%D0%BA-swift-%D0%B8%D0%BD%D0%BD-%D0%B8%D0%BB%D0%B8-%D1%80%D0%B5%D0%B3%D0%B8%D1%81%D1%82%D1%80%D0%B0%D1%86%D0%B8%D0%BE%D0%BD%D0%BD%D0%BE%D0%BC%D1%83-%D0%BD%D0%BE%D0%BC%D0%B5%D1%80%D1%83)
   - [API подсказок по банкам](https://github.com/movemove-io/laravel-dadata#api-%D0%BF%D0%BE%D0%B4%D1%81%D0%BA%D0%B0%D0%B7%D0%BE%D0%BA-%D0%BF%D0%BE-%D0%B1%D0%B0%D0%BD%D0%BA%D0%B0%D0%BC)
+- **Работа с паспортами**
+  - [Проверка по реестру МВД](https://github.com/movemove-io/laravel-dadata#%D0%BF%D1%80%D0%BE%D0%B2%D0%B5%D1%80%D0%BA%D0%B0-%D0%BF%D0%BE-%D1%80%D0%B5%D0%B5%D1%81%D1%82%D1%80%D1%83-%D0%BC%D0%B2%D0%B4)
+  - [Кем выдан паспорт](https://github.com/movemove-io/laravel-dadata#%D0%BA%D0%B5%D0%BC-%D0%B2%D1%8B%D0%B4%D0%B0%D0%BD-%D0%BF%D0%B0%D1%81%D0%BF%D0%BE%D1%80%D1%82)  
 
 
 
@@ -4200,3 +4203,266 @@ class DaData
 
 ```
 
+## Работа с паспортами
+### Проверка по реестру МВД
+`DaDataPassport::standardization(string $id)` Проверяет паспорт по справочнику недействительных паспортов МВД.
+
+Основные кейсы:
+- Проверяет формат серии и номера;
+- Проверяет паспорт по справочнику недействительных паспортов МВД;
+
+Пример вызова
+
+```php
+<?php
+
+namespace App;
+
+use MoveMoveIo\DaData\Facades\DaDataPassport;
+
+/**
+ * Class DaData
+ * @package App\DaData
+ */
+class DaData
+{
+
+   /**
+   * DaData passport
+   *
+   * @return void
+   */
+   public function passportExample() : void
+    {
+        $dadata = DaDataPassport::standardization('4509 235857');
+        
+        dd($dadata);
+    }
+
+}
+
+```
+
+Параметры вызова
+
+| **Название**      | **Тип**   | **Optional** | **Default value** |  **Описание**                               |
+|:------------------|:---------:|:------------:|:-----------------:|:--------------------------------------------|
+| `id`              | `string`  | `false`      |                   | Текст запроса                               |
+
+Пример ответа
+
+```php
+array:1 [
+  0 => array:4 [
+    "source" => "4509 235857"
+    "series" => "45 09"
+    "number" => "235857"
+    "qc" => 0
+  ]
+]
+
+```
+
+Описание ответа
+
+| **Название**      | **Длина**   |  **Описание**                               |
+|:------------------|:-----------:|:--------------------------------------------|
+| `source`          | `100`       | Исходная серия и номер одной строкой        |
+| `series`          | `20`        | Серия                                       |
+| `number`          | `20`        | Номер                                       |
+| `qc`              | `5`         | Код проверки.                               |
+
+| `qc`    | **Нужна ручная проверка?** |              **Описание**                                                                              |
+|:-------:|:---------------------------|:-------------------------------------------------------------------------------------------------------|
+| **0**   | нет                        | Действующий паспорт                                                                                    |
+| **2**   | нет                        | Исходное значение пустое                                                                               |
+| **1**   | да                         | Неправильный формат серии или номера                                                                   |
+| **100** | да                         | Недействительный паспорт                                                                               |
+
+**Exceptions**
+
+При вызове методов, вы можете обрабатывать коды исключений и их сообщения
+
+|       **Код**        |                       **Описание**                                                          |
+|:---------------------|:--------------------------------------------------------------------------------------------|
+| `400`                | Некорректный запрос                                                                         |
+| `401`                | В запросе отсутствует API-ключ или секретный ключ или в запросе указан несуществующий ключ  |
+| `403`                | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс      |
+| `405`                | Запрос сделан с методом, отличным от POST                                                   |
+| `429`                | Слишком много запросов в секунду или новых соединений в минуту                              |
+| `5xx`                | Произошла внутренняя ошибка сервиса                                                         |
+
+Более детальную информацию вы можете получить из сообщения исключения.
+
+Пример получения сообщения исключения
+
+```php
+<?php
+
+namespace App;
+
+use MoveMoveIo\DaData\Facades\DaDataPassport;
+
+/**
+ * Class DaData
+ * @package App\DaData
+ */
+class DaData
+{
+
+   /**
+   * DaData passport
+   *
+   * @return void
+   */
+   public function passportExample() : void
+    {
+        try {
+            $dadata = DaDataPassport::standardization('4509 235857');
+
+            dd($dadata);
+        } catch (\Exception $e) {
+            dd($e->getMessage());
+        }    
+    }
+
+}
+
+```
+
+### Кем выдан паспорт  
+`DaDataPassport::fns(string $passport, int $count)` Моментально заполняет организацию, выдавшую паспорт, по коду подразделения
+
+Самое утомительное поле при вводе паспорта — «Кем выдан». Писать какое-нибудь «Отделом внутренних дел Медведевского района республики Марий Эл» муторно. Поэтому мы сделали подсказки по полю «Паспорт выдан...».
+
+Пример вызова
+
+```php
+<?php
+
+namespace App;
+
+use MoveMoveIo\DaData\Facades\DaDataPassport;
+
+/**
+ * Class DaData
+ * @package App\DaData
+ */
+class DaData
+{
+
+   /**
+   * DaData FNS
+   *
+   * @return void
+   */
+   public function fnsExample() : void
+    {
+        $dadata = DaDataPassport::fms('772 053', 2);
+        
+        dd($dadata);   
+    }
+
+}
+
+```
+
+Параметры вызова
+
+| **Название**      | **Тип**   | **Optional** | **Default value** |  **Описание**                               |
+|:------------------|:---------:|:------------:|:-----------------:|:--------------------------------------------|
+| `id`              | `string`  | `false`      |                   | Текст запроса                               |
+| `count`           | `int`     | `true`       | 10                | Количество результатов. Максимум 20         |
+
+Пример ответа
+
+```php
+array:1 [
+  "suggestions" => array:2 [
+    0 => array:3 [
+      "value" => "ОВД ЗЮЗИНО Г. МОСКВЫ"
+      "unrestricted_value" => "ОВД ЗЮЗИНО Г. МОСКВЫ"
+      "data" => array:4 [
+        "code" => "772-053"
+        "name" => "ОВД ЗЮЗИНО Г. МОСКВЫ"
+        "region_code" => "77"
+        "type" => "2"
+      ]
+    ]
+    1 => array:3 [
+      "value" => "ОВД ЗЮЗИНО Г. МОСКВЫ ПАСПОРТНЫЙ СТОЛ 1"
+      "unrestricted_value" => "ОВД ЗЮЗИНО Г. МОСКВЫ ПАСПОРТНЫЙ СТОЛ 1"
+      "data" => array:4 [
+        "code" => "772-053"
+        "name" => "ОВД ЗЮЗИНО Г. МОСКВЫ ПАСПОРТНЫЙ СТОЛ 1"
+        "region_code" => "77"
+        "type" => "2"
+      ]
+    ]
+  ]
+]
+
+
+```
+
+Описание ответа
+
+| **Название**          |  **Описание**                               |
+|:----------------------|:--------------------------------------------|
+| `value`               | Значение одной строкой (как показывается в списке подсказок) |
+| `unrestricted_value`  | `== value` |
+| `data['code']`        | Код подразделения |
+| `data['name']`        | Название подразделения в творительном падеже («кем выдан?») |
+| `data['region_code']` | Код региона (2 цифры) |
+| `data['type']`        | Вид подразделения (1 цифра). `0` — подразделение ФМС, `1` — ГУВД или МВД региона, `2` — УВД или ОВД района или города, `3` — отделение полиции |
+
+**Exceptions**
+
+При вызове методов, вы можете обрабатывать коды исключений и их сообщения
+
+|       **Код**        |                       **Описание**                                                          |
+|:---------------------|:--------------------------------------------------------------------------------------------|
+| `400`                | Некорректный запрос                                                                         |
+| `401`                | В запросе отсутствует API-ключ или секретный ключ или в запросе указан несуществующий ключ  |
+| `403`                | Не подтверждена почта или недостаточно средств для обработки запроса, пополните баланс      |
+| `405`                | Запрос сделан с методом, отличным от POST                                                   |
+| `429`                | Слишком много запросов в секунду или новых соединений в минуту                              |
+| `5xx`                | Произошла внутренняя ошибка сервиса                                                         |
+
+Более детальную информацию вы можете получить из сообщения исключения.
+
+Пример получения сообщения исключения
+
+```php
+<?php
+
+namespace App;
+
+use MoveMoveIo\DaData\Facades\DaDataPassport;
+
+/**
+ * Class DaData
+ * @package App\DaData
+ */
+class DaData
+{
+
+   /**
+   * DaData FNS
+   *
+   * @return void
+   */
+   public function fnsExample() : void
+    {
+        try {
+            $dadata = DaDataPassport::fms('772 053', 2);
+
+            dd($dadata);
+        } catch (\Exception $e) {
+            dd($e->getMessage());
+        }    
+    }
+
+}
+
+```
diff --git a/src/DaDataPassport.php b/src/DaDataPassport.php
@@ -0,0 +1,40 @@
+<?php
+
+namespace MoveMoveIo\DaData;
+
+/**
+ * Class DaDataPassport
+ * @package MoveMoveIo\DaData
+ */
+class DaDataPassport extends DaDataService
+{
+
+    /**
+     * Standardization passports
+     *
+     * @param string $id
+     * @return array
+     * @throws \Exception
+     */
+    public function standardization(string $id) : array
+    {
+        return $this->cleanerApi()->post('clean/passport', [$id]);
+    }
+
+    /**
+     * Defin FMS unit by passport code or name
+     *
+     * @param string $passport
+     * @param int $count
+     * @return array
+     * @throws \Exception
+     */
+    public function fms(string $passport, int $count = 10) : array
+    {
+        return $this->suggestApi()->post('rs/suggest/fms_unit', [
+            'query'     => $passport,
+            'count'     => $count,
+        ]);
+    }
+
+}
diff --git a/src/DaDataServiceProvider.php b/src/DaDataServiceProvider.php
@@ -36,13 +36,17 @@ public function register()
         $this->app->singleton('da_data_bank', function () {
             return new DaDataBank();
         });
+        $this->app->singleton('da_data_passport', function () {
+            return new DaDataPassport();
+        });
 
         $this->app->alias('da_data_address', DaDataAddress::class);
         $this->app->alias('da_data_name', DaDataName::class);
         $this->app->alias('da_data_email', DaDataEmail::class);
         $this->app->alias('da_data_phone', DaDataPhone::class);
         $this->app->alias('da_data_company', DaDataCompany::class);
         $this->app->alias('da_data_bank', DaDataCompany::class);
+        $this->app->alias('da_data_passport', DaDataPassport::class);
     }
 
     /**
diff --git a/src/Facades/DaDataPassport.php b/src/Facades/DaDataPassport.php
@@ -18,7 +18,7 @@ class DaDataPassport extends Facade
      */
     protected static function getFacadeAccessor() : string
     {
-        return 'dadata_passport';
+        return 'da_data_passport';
     }
 
 }
diff --git a/tests/DaDataPassportTest.php b/tests/DaDataPassportTest.php
diff --git a/tests/TestCase.php b/tests/TestCase.php

Original file line number	Diff line number	Diff line change
`@@ -18,7 +18,7 @@ class DaDataPassport extends Facade`
`18`	`18`	`*/`
`19`	`19`	`protected static function getFacadeAccessor() : string`
`20`	`20`	`{`
`21`		`- return 'dadata_passport';`
	`21`	`+ return 'da_data_passport';`
`22`	`22`	`}`
`23`	`23`
`24`	`24`	`}`