signable

Firmable

El cliente firmable proporciona una interfaz Ruby simple para la API firmable.

Instalación

Agregue esta línea al Gemfile de su aplicación:

 gem 'signable'

Y luego ejecuta:

 $ bundle

O instálelo usted mismo como:

 $ gem install signable

Uso

Configuración

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

Recuperar una plantilla

 Signable :: Template . find 'fingerprint'

Construir un documento

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

Un documento también puede contener merge_fields (consulte la documentación firmable)

construir una fiesta

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

La identificación del partido se puede recuperar de la plantilla.

crear un sobre

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

envelope . save 

Pruebas

El conjunto de pruebas es RSpec y utiliza VCR para probar las llamadas API.

Los casetes de VCR están incluidos en este repositorio para que pueda ejecutar las especificaciones sin acceder a la API Signable de esta manera:

 bundle exec rspec

Si necesita volver a registrar las interacciones entre el código Ruby y la API firmable, puede especificar una clave API para que las pruebas la utilicen de esta manera:

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

Si tiene una API no válida o faltante, verá un error como el siguiente:

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

NOTA:

• Las grabaciones del VCR tienen un tiempo de caducidad, por lo que es posible que te veas obligado a volver a grabarlas incluso si no has realizado cambios.
• El conjunto de pruebas es destructivo, así que utilice únicamente una cuenta de prueba firmable. La cuenta requiere un recurso de plantilla para que se ejecute el conjunto de pruebas.

Para obtener una clave API Signable válida, inicie sesión en su cuenta Signable y navegue hasta Configuración de la empresa → Api y Webhooks y haga clic en "Agregar clave API" para generar una clave. Le recomendamos que elimine la clave cuando haya terminado con ella.

Contribuyendo

1. Bifurcarlo (http://github.com//signable/fork)
2. Crea tu rama de funciones ( git checkout -b my-new-feature )
3. Confirme sus cambios ( git commit -am 'Add some feature' )
4. Empujar a la rama ( git push origin my-new-feature )
5. Crear nueva solicitud de extracción