pdf filler

PDF-наполнитель

PDF Filler — это служба RESTful (API), которая помогает заполнять существующие формы на основе PDF и дает веб-разработчикам возможность использовать формы на основе браузера и современные веб-стандарты для облегчения сбора информации.

PDF Filler работает практически с любыми незашифрованными PDF-файлами, поддерживая как заполняемые (например, PDF-файлы с предопределенными полями ввода), так и незаполняемые (например, отсканированные PDF-файлы) формы. Просто передайте ему URL-адрес любого общедоступного PDF-файла. PDF Filler может даже автоматически создавать разметку, необходимую для встраивания HTML-формы в существующую веб-страницу.

Функции

• Служба RESTful (API) для помощи в заполнении форм в формате PDF.
• Отправляйте значения формы через HTTP POST и получайте готовый PDF-файл для загрузки.
• Работает как с заполняемыми, так и с незаполняемыми (например, отсканированными) PDF-файлами.
• Динамически генерирует HTML-формы для любого заполняемого PDF-файла.
• Предоставляет разработчикам службу поиска имен полей для облегчения быстрой разработки клиентских приложений.

Под капотом

Проект абстрагирует логику заполнения форм pdftk и prawn.

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

PDF Filler работает, принимая пару ключ => значение имен и значений полей. Эти поля могут быть либо заполняемыми полями PDF-формы, либо представлять собой произвольную координату x/y незаполняемого поля. Для заполняемых PDF-файлов ключ должен представлять собой имя поля. В незаполняемых PDF-файлах ключ должен представлять координаты поля, как описано ниже (например, 100,100 ). В обоих случаях значение поля должно содержать введенные пользователем данные для данного поля.

Получение имен полей

Имена полей можно обнаружить локально с помощью PDF-утилиты pdftk с открытым исходным кодом или динамически с помощью службы.

Чтобы получить список всех полей в данном PDF-файле

/fields?pdf={URL to the PDF}

Чтобы получить JSON-представление всех полей в данном PDF-файле

/fields.json?pdf={URL to the PDF}

Заполнение форм

Чтобы заполнить PDF-файл, отправьте POST запрос к /fill . Данные POST должны быть в формате ключ => значение, где ключ представляет имя поля, а значение представляет значение поля. Обязательно передайте ключ «pdf» с URL-адресом PDF-файла для заполнения. Сервис вернет заполненный PDF-файл для загрузки.

Примечание. Из-за того, как HTML обрабатывает формы, некоторые специальные символы, такие как квадратные скобки, не будут правильно отправляться в службу POST. Если поле PDF содержит зарезервированные символы, просто закодируйте имя поля перед отправкой POST.

Генерация HTML-форм

Чтобы получить общее HTML-представление любой заполняемой формы PDF.

/form?pdf={URL To PDF}

Незаполняемые PDF-файлы

Незаполняемые PDF-файлы (например, отсканированные или другие PDF-файлы без структурированных форм) требуют передачи координат X, Y и (необязательно) номера страницы. Эти данные передаются с использованием следующего соглашения об именовании поля: x,y,page (или просто x,y ), где X и Y представляют собой координаты указателя из нижнего левого угла документа. Если страница не указана, предполагается первая страница.

Структурирование HTML-формы

Данные могут быть отправлены программным путем (например, через API) или в виде стандартной веб-формы. Например, чтобы структурировать HTML-форму, вы можете сделать это следующим образом:

    < form method =" post " action =" /fill " >
      
      <!-- A standard, fillable field, simply pass the field name -->
      < label > First Name: < input type =" text " name =" first_name " /> < label >
      
      <!-- A non-fillable field for which we pass coordinates -->
      < label > Last Name: < input type =" text " name =" 100,100,1 " /> < label >
      
      < input type =" submit " value =" Submit " />
      
    </ form >
    

Требования

• Последняя стабильная версия Ruby (+ драгоценный камень Bundler)
• PDFtk

Настройка

1. Установите последнюю версию Ruby, если она еще не установлена ​​( $ curl -L https://get.rvm.io | bash -s stable --ruby )
2. Установить PDFtk
3. Установите упаковщик, если он еще не установлен ( gem install bundler )
4. Установите git, если он еще не установлен (или просто загрузите репозиторий и разархивируйте его на следующем шаге).
5. Клонируйте репозиторий git ( git clone [email protected]:GSA-OCSIT/pdf-filler.git и cd в целевой каталог (скорее всего, pdf-filler )
6. bundle install

Бег

Для запуска просто запустите команду ruby app.rb из каталога проекта. По умолчанию служба будет доступна через порт 4567 .

Вы можете свободно использовать PDF Filler в качестве веб-сервиса. Но если вы хотите получить исходный код и разместить его локально, это на самом деле довольно просто.

PDF Filler использует pdftk для обработки заполнения формы действий. pdftk можно бесплатно загрузить и установить в большинстве систем. Если установлено в место, отличное от /usr/local/bin/pdftk , обязательно обновите конфигурацию, задав для переменной среды PATH_TO_PDFTK правильный путь.

PDF Filler написан на Ruby и использует Sinatra для создания RESTful API.

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

PDF Filler легко развернуть в качестве серверной службы на вашем сервере. Следуйте инструкциям здесь: http://www.kalzumeus.com/2010/01/15/deploying-sinatra-on-ubuntu-in-that-i-employ-a-secretary/ в качестве примера развертывания и установки. установите приложение в качестве серверной службы на своем компьютере. Для этой цели в приложении имеется файл daemon.rb.

Хостинг

Приложение предназначено для размещения на таких хостингах, как Heroku. Если вы используете Heroku, обязательно выберите сборку «Bamboo» (которая скомпилирована с pdftk) и установите конфигурацию среды для PATH_TO_PDFTK в /usr/bin/pdftk .

Примеры

• Поля
• Форма

Содействие

Приглашаем всех желающих внести свой вклад в проект, создав его форк и отправив запрос на включение. (Если вы новичок в GitHub, вы можете начать с базового руководства.)

Внося свой вклад в этот проект, вы предоставляете всемирную, безвозмездную, бессрочную, безотзывную, неисключительную, передаваемую лицензию всем пользователям в соответствии с условиями лицензии MIT.

Лицензия

Этот проект представляет собой работу правительства США в соответствии с разделом 17 USC 105 и распространяется на условиях лицензии MIT.