call-up-io/callup

There is no license information available for the latest version (dev-main) of this package.

dev-main 2021-09-06 12:10 UTC

Requires

• php: >=7.3.0
• guzzlehttp/guzzle: 7.3
• vlucas/phpdotenv: ^5.3

Requires (Dev)

• phpunit/phpunit: 9.5

Unknown License

• Igor Poyarkov

README

PHP библиотека для взаимодействия с сервисом CallUp.

Содержание

• Входные данные
• Примеры
• Тестирование

Входные данные

Объект CallUp принимает 3 параметра

• params - массив параметров
• dir - директория файла конфигураций
• filename - название файла конфигурации

new CallUp($params, $dir, $filename);

ВАЖНО: если не указан массив params, то данные берутся из файла. Если параметры файла не указаны, то данные берутся по умолчанию от корня проекта из файла .env

Примеры

Для генерации кода необходимо использовать функцию verify(string $phone)

где

$phone - номер телефона, на который необходимо отправить код верификации

try {
  $callUp = new CallUp();
  $r = $callUp->verify($phone);
  if ($r->hasErrors() === true) {
    throw new Exception($r->getErrors());
  }
} catch (Exception $e) {
  // some actions after catching the error
}

Для авторизации используется функция signIn(string $id, string $code)

где

$id - идентификатор заказа

$code - 4-х значный код

try {
  $callUp = new CallUp();
  $r = $callUp->signIn($id, $code);
  if ($r->hasErrors() === true) {
    throw new Exception($r->getErrors());
  }
  if ($r->getData()['success'] === true) {
    // actions after successful authorization
  };
} catch (Exception $e) {
  // some actions after catching the error
}

Тестирование

Для тестирования используется библиотека PHPUnit 9

Для запуска unit-тестов необходимо выполнить команду

> ./vendor/bin/phpunit tests

Для запуска отдельного unit-теста необходимо выполнить команду

> ./vendor/bin/phpunit tests ./tests/unit/path/to/file.php