signable

Подписываемый

Клиент Signable предоставляет простой интерфейс Ruby для Signable API.

Установка

Добавьте эту строку в Gemfile вашего приложения:

 gem 'signable'

И затем выполните:

 $ bundle

Или установите его самостоятельно как:

 $ gem install signable

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

Конфигурация

 Signable . configure do | config |
  config . base_url = ENV . fetch ( 'SIGNABLE_BASE_URL' )
  config . api_key  = ENV . fetch ( 'SIGNABLE_API_KEY' )
end

Получить шаблон

 Signable :: Template . find 'fingerprint'

Создание документа

 Signable :: Document . new ( template_fingerprint : fingerprint , title : title )

Документ также может содержать merge_fields (см. подписываемую документацию).

Создайте вечеринку

 Signable :: Party . new ( id : id , name : 'name' , email : 'email' )

Идентификатор вечеринки можно получить из шаблона

Создать конверт

 envelope = Signable :: Envelope . new title : 'title' , redirect_url : 'https://www.autoenrolment.co.uk'
envelope . documents = documents
envelope . parties = parties

envelope . save 

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

Набор тестов — это RSpec, который использует VCR для тестирования вызовов API.

Кассеты видеомагнитофонов включены в этот репозиторий, поэтому вы можете запускать спецификации, не задействуя Signable API, например:

 bundle exec rspec

Если вам нужно перезаписать взаимодействие между кодом Ruby и Signable API, вы можете указать ключ API для использования тестами следующим образом:

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

Если у вас неверный или отсутствующий API, вы увидите следующую ошибку:

 Authentication failed . Either the API Key or password was blank .

ПРИМЕЧАНИЕ:

• Записи видеомагнитофона имеют срок годности, поэтому вам, возможно, придется перезаписать их, даже если вы не вносили никаких изменений.
• Набор тестов является деструктивным, поэтому используйте только тестовую учетную запись с возможностью подписи. Для запуска набора тестов учетной записи требуется один ресурс шаблона.

Чтобы получить действительный ключ Signable API, войдите в свою учетную запись Signable, перейдите в «Настройки компании» → «Api и веб-перехватчики» и нажмите «Добавить ключ API», чтобы сгенерировать ключ. Мы рекомендуем вам удалить ключ после завершения работы с ним.

Содействие

1. Форкните его ( http://github.com//signable/fork )
2. Создайте свою ветку функций ( git checkout -b my-new-feature )
3. Зафиксируйте изменения ( git commit -am 'Add some feature' )
4. Нажмите на ветку ( git push origin my-new-feature )
5. Создать новый запрос на включение