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 录音有有效期，因此即使您没有进行任何更改，您也可能被迫重新录制它们
• 该测试套件具有破坏性，因此请仅使用测试可签名帐户。该帐户需要一个模板资源才能运行测试套件。

要获取有效的 Signable API 密钥，请登录您的 Signable 帐户并导航至“公司设置”→“Api 和 Webhooks”，然后单击“添加 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. 创建新的拉取请求