2.1.0 • Published 7 years ago

@neiromancer/ggs-client v2.1.0

Weekly downloads
-
License
UNLICENCED
Repository
-
Last release
7 years ago

GGS-client

Клиентский модуль для получения уникальных GUID через GUID-generation-service (GGS).

Версия 2.1.0

Изменения:

  • Убрана вся аутентификация (теперь совместимость только с GGS v1.3 и выше)
  • Убрана зависимость от модуля @neiromancer/service-auth-client
  • Убран .npmrc
  • Исправления в package.json

Версия 2.0.0

В версии 2.0.0 клиента сохраняется совместимость с GGS v1.1.0, но не сохраняется совместимость с GGS-client v1.1.0

Изменения:

  • Добавлена зависимость от модуля @neiromancer/service-auth-client
  • Исправления в package.json
  • Добавлен .npmrc для установки модуля из частного репозитория
  • Файл модуля клиента переименован в client.js
  • Написаны тесты (test/test.js)
  • Изменен и упрощен код модуля (45 строк вместо 92)
  • Функция get() теперь возвращает Promise, что упрощает использование клиента.
  • Для модуля создан npm-модуль: @neiromancer/ggs-client
  • Изменено описание модуля (этот файл)

Версия 1.1.0

Первая работающая версия клиента

Использование

  • Для корректной работы клиента должен быть запущен GGS
  • Установить модуль ggs-client:
$ npm install @neiromancer/ggs-client --save
  • Перед использованием для конфигурирования клиента от администратора сервиса надо получить:
    • адрес хоста (host), где запущен GUID generation service,
    • номер порта (port), к которому обращаться
  • Пример использования:
// Подключаем модуль клиента
var ggs_client = require('@neiromancer/ggs-client');
// Конфигурируем клиента
ggs_client.config({
  host: 'localhost',
  port: 3000
});
// Запрос GUID
// ggs_client.get() возвращает Promise
ggs_client.get().then(function(guid){
    // Используем полученный GUID
    console.log(guid);
}).catch(function(error){
  // Обработка ошибки
  console.log(error.message)
});
  • Если GUID успешно сгенерирован и получен, тогда ответ сервиса - guid
kWUEcXMw
  • В случае ошибки, код ошибки и текстовое сообщение в error:
{ status: 503, message: 'Service Unavailable' }

Возможные ошибки

  • 400 Bad Request - ошибка запроса (как правило, форматдайджеста строки запроса)
  • 429 Too Many Requests - более 10 запросов в миллисекунду (попробовать запрос чуть позже)
  • 503 Service Unavailable - клиенту не подключиться к серверу (вероятно проблема в адресе хоста/порта)