Единицы измерения

Gem Version Bild Status Code Metrics Dependency Status Coverage Status License

О проекте

Модуль описывает единицы измерения по стандартам, действующим в Российской Федерации. Является плагином Rails 4.1 и выше.

В список включены единицы измерения в соответствии со следующими стандартами:

  • ОКЕИ (Общероссийский классификатор единиц измерения);

  • ГОСT 8.417-2002 (Государственная система обеспечения единства измерений. Единицы величин);

  • Рекомендация № 20 РГ 4 ЕЭК ООН “Коды единиц измерения, используемых в международной торговле” (Версия 9).

Модуль объявляет:

  • Модель единиц измерения (Okei::Unit);

  • Набор сервисов (use cases) для работы с единицами измерения;

  • RESTful public API для доступа к списку единиц измерения и отдельным записям.

Модель единиц измерения

Okei::Unit

Описывает единицу измерения согласно действующим стандартам. Единица идентифицируется уникальным кодом по стандарту UUID.

Сервисы (use cases)

Okei::GetUnit

Возвращает единицу измерения по указанному uuid

Okei::GetUnits

Возвращает список всех единиц с возможностью отбора по виду измерений.

Okei::FindUnit

Возвращает единицу измерения по названию.

RESTful public API

API содержит следующие маршруты для доступа к единицам измерения:

GET /api/v1/units

Перечень единиц с возможностью отбора по виду измерений.

GET /api/v1/units/{uuid}

Поиск единицы измерения по uuid.

GET /api/v1/units/seach

Поиск единицы измерения по названию.

Подробное описание см. в API Blueprint .

При установке модуля рекомендуется использовать соответствующее поле имен (например, /okei).

Установка модуля

Добавьте строку в Gemfile:

gem "okei"

и затем вызовите из командной строки:

$ bundle

или установите модуль вручную:

$ gem install okei

После установки выполните в командной строке:

При включении модуля в модуль Rails

$ rake app:okei:install

При включении модуля в приложение Rails

$ rake okei:install

Contributing (en)

  1. Fork it ( github.com/nepalez/okei/fork )

  2. Create your feature branch (`git checkout -b my-new-feature`)

  3. Commit your changes (`git commit -am 'Add some feature'`)

  4. Push to the branch (`git push origin my-new-feature`)

  5. Create a new Pull Request

Лицензия

Модуль распространяется на условиях свободной лицензии MIT.

Язык документации

Помимо данного описания и API Blueprint , выполненных на русском языке, остальная документация доступна только по-английски.