envek / postindexapi.ru

Very small service for providing russian post codes in JSON

JSON API доступа к почтовым индексам Почты России

Небольшое веб-приложение, предоставляющее доступ к официальной базе почтовых индексов ФГУП «Почта России» в формате JSON.

Написано на языке программирования Ruby с использованием программного каркаса Sinatra.

URL: http://postindexapi.ru

Зависимости:

• Ruby
• Sinatra
• PostgreSQL
• pgdbf

Разработка

Для разработки вам потребуется POSIX-совместимая ОС (желательно Linux или Mac OS X), СУБД PostgreSQL, интерпретатор Ruby (рекомендуется устанавливать через RVM) и текстовый редактор (попробуйте Sublime Text).

1. Склонируйте исходный код: git clone git://[email protected]:Envek/postindexapi.ru и перейдите в папку с исходным кодом;
2. Установите требуемые зависимости: bundle install;
3. Скопируйте файлы config/*.yml.sample в config/*.yml и отредактируйте под себя;
4. Создайте учётную запись в PostgreSQL;
5. Разверните бэкап БД или установите новую: rake db:schema:load;
6. Установите утилиту pgdbf для следующего шага;
7. Скачайте актуальную базу почтовых индексов: rake post_index:update;
8. Работайте!

Помощь в разработке

Буду рад любой помощи и дополнениям!

Если вы хотите помочь проекту:

1. Сделайте форк проекта в своём github-аккаунте.
2. Создайте отдельную ветвь разработки.
3. Внесите в неё желаемые изменения.
4. Создайте pull-request из вашей ветви в ветвь master данного репозитария.

Подробнее об этой модели разработки вы можете прочесть в статье о pull request'ах.

Развёртывание

Для развёртывания системы используется Capistrano.

Первое развёртывание

# Установите на сервере следующие пакеты: git pgdbf unzip postgresql postgresql-client libpq-dev wget ca-certificates g++ gcc make libc6-dev libreadline6-dev zlib1g-dev libssl-dev libyaml-dev libsqlite3-dev sqlite3 autoconf libgdbm-dev libncurses5-dev automake libtool bison pkg-config libffi-dev gawk
cap rvm:install_rvm
cap rvm:install_ruby
cap deploy:setup
cap deploy:update
# Отредактируйте на сервере settings.yml и database.yml, создайте пользователя и БД
# Выполните на сервере rake db:setup post_index:update
cap deploy

Повторные развёртывания

cap deploy

Лицензирование

Данное программное обеспечение распространяется на условиях лицензии MIT:

Copyright © 2013-2016 Новиков Андрей Александрович

Данная лицензия разрешает лицам, получившим копию данного программного обеспечения и сопутствующей документации (в дальнейшем именуемыми «Программное Обеспечение»), безвозмездно использовать Программное Обеспечение без ограничений, включая неограниченное право на использование, копирование, изменение, добавление, публикацию, распространение, сублицензирование и/или продажу копий Программного Обеспечения, также как и лицам, которым предоставляется данное Программное Обеспечение, при соблюдении следующих условий:

Указанное выше уведомление об авторском праве и данные условия должны быть включены во все копии или значимые части данного Программного Обеспечения.

ДАННОЕ ПРОГРАММНОЕ ОБЕСПЕЧЕНИЕ ПРЕДОСТАВЛЯЕТСЯ «КАК ЕСТЬ», БЕЗ КАКИХ-ЛИБО ГАРАНТИЙ, ЯВНО ВЫРАЖЕННЫХ ИЛИ ПОДРАЗУМЕВАЕМЫХ, ВКЛЮЧАЯ, НО НЕ ОГРАНИЧИВАЯСЬ ГАРАНТИЯМИ ТОВАРНОЙ ПРИГОДНОСТИ, СООТВЕТСТВИЯ ПО ЕГО КОНКРЕТНОМУ НАЗНАЧЕНИЮ И ОТСУТСТВИЯ НАРУШЕНИЙ ПРАВ. НИ В КАКОМ СЛУЧАЕ АВТОРЫ ИЛИ ПРАВООБЛАДАТЕЛИ НЕ НЕСУТ ОТВЕТСТВЕННОСТИ ПО ИСКАМ О ВОЗМЕЩЕНИИ УЩЕРБА, УБЫТКОВ ИЛИ ДРУГИХ ТРЕБОВАНИЙ ПО ДЕЙСТВУЮЩИМ КОНТРАКТАМ, ДЕЛИКТАМ ИЛИ ИНОМУ, ВОЗНИКШИМ ИЗ, ИМЕЮЩИМ ПРИЧИНОЙ ИЛИ СВЯЗАННЫМ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ ИЛИ ИСПОЛЬЗОВАНИЕМ ПРОГРАММНОГО ОБЕСПЕЧЕНИЯ ИЛИ ИНЫМИ ДЕЙСТВИЯМИ С ПРОГРАММНЫМ ОБЕСПЕЧЕНИЕМ.

С оригинальным текстом лицензии вы можете ознакомиться на сайте opensource.org.