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 녹화에는 만료 시간이 있으므로 변경 사항이 없더라도 강제로 다시 녹화해야 할 수 있습니다.
• 테스트 스위트는 파괴적이므로 테스트 서명 가능한 계정만 사용하십시오. 테스트 도구 모음을 실행하려면 계정에 하나의 템플릿 리소스가 필요합니다.

유효한 서명 가능 API 키를 얻으려면 서명 가능 계정에 로그인하고 회사 설정 → 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. 새로운 Pull Request 생성