signable

Signierbar

Der signierbare Client stellt eine einfache Ruby-Schnittstelle zur Signable API bereit.

Installation

Fügen Sie diese Zeile zur Gemfile Ihrer Anwendung hinzu:

 gem 'signable'

Und dann ausführen:

 $ bundle

Oder installieren Sie es selbst als:

 $ gem install signable

Verwendung

Konfiguration

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

Rufen Sie eine Vorlage ab

 Signable :: Template . find 'fingerprint'

Erstellen Sie ein Dokument

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

Ein Dokument kann auch merge_fields enthalten (siehe signierbare Dokumentation).

Bauen Sie eine Party auf

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

Die Party-ID kann aus der Vorlage abgerufen werden

Erstellen Sie einen Umschlag

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

envelope . save 

Testen

Die Testsuite ist RSpec und verwendet VCR zum Testen von API-Aufrufen.

Die VCR-Kassetten sind in diesem Repository enthalten, sodass Sie die Spezifikationen ausführen können, ohne die Signable-API wie folgt zu verwenden:

 bundle exec rspec

Wenn Sie die Interaktionen zwischen dem Ruby-Code und der Signable API neu aufzeichnen müssen, können Sie wie folgt einen API-Schlüssel angeben, den die Tests verwenden sollen:

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

Wenn Sie eine ungültige oder fehlende API haben, wird eine Fehlermeldung wie die folgende angezeigt:

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

NOTIZ:

• Die VCR-Aufnahmen haben eine Ablaufzeit, sodass Sie möglicherweise gezwungen sind, sie erneut aufzunehmen, auch wenn Sie keine Änderungen vorgenommen haben
• Die Testsuite ist destruktiv. Verwenden Sie daher bitte nur ein signierbares Testkonto. Das Konto benötigt eine Vorlagenressource, damit die Testsuite ausgeführt werden kann.

Um einen gültigen Signable-API-Schlüssel zu erhalten, melden Sie sich bei Ihrem Signable-Konto an, navigieren Sie zu Unternehmenseinstellungen → API & Webhooks und klicken Sie auf „API-Schlüssel hinzufügen“, um einen Schlüssel zu generieren. Wir empfehlen Ihnen, den Schlüssel zu löschen, wenn Sie damit fertig sind.

Mitwirken

1. Forken Sie es (http://github.com//signable/fork)
2. Erstellen Sie Ihren Feature-Zweig ( git checkout -b my-new-feature )
3. Übernehmen Sie Ihre Änderungen ( git commit -am 'Add some feature' )
4. Zum Zweig pushen ( git push origin my-new-feature )
5. Erstellen Sie eine neue Pull-Anfrage