signable

署名可能

Signable クライアントは、Signable API にシンプルな Ruby インターフェイスを提供します。

インストール

次の行をアプリケーションの 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' )

パーティー ID はテンプレートから取得できます

封筒を作成する

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

envelope . save 

テスト

テスト スイートは RSpec で、VCR を使用して API 呼び出しをテストします。

VCR カセットはこのリポジトリに含まれているため、次のように 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 .

注記：

• VCR 録画には有効期限があるため、変更を加えていない場合でも再録画する必要がある場合があります。
• テスト スイートは破壊的であるため、テスト用の署名可能なアカウントのみを使用してください。テスト スイートを実行するには、アカウントに 1 つのテンプレート リソースが必要です。

有効な Signable API キーを取得するには、Signable アカウントにログインし、[会社設定] → [Api と Webhook] に移動し、[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. 新しいプルリクエストを作成する