signable

Dapat ditandatangani

Klien signable menyediakan antarmuka Ruby sederhana ke Signable API.

Instalasi

Tambahkan baris ini ke Gemfile aplikasi Anda:

 gem 'signable'

Dan kemudian jalankan:

 $ bundle

Atau instal sendiri sebagai:

 $ gem install signable

Penggunaan

Konfigurasi

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

Ambil templat

 Signable :: Template . find 'fingerprint'

Buatlah sebuah dokumen

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

Sebuah dokumen mungkin juga berisi merge_fields (lihat dokumentasi yang dapat ditandatangani)

Bangun pesta

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

ID pihak dapat diambil dari template

Buat amplop

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

envelope . save 

Pengujian

Test suite adalah RSpec dan menggunakan VCR untuk menguji panggilan API.

Kaset VCR disertakan dalam repositori ini sehingga Anda dapat menjalankan spesifikasi tanpa menekan Signable API seperti:

 bundle exec rspec

Jika Anda perlu merekam ulang interaksi antara kode Ruby dan Signable API, Anda dapat menentukan kunci API untuk digunakan pengujian seperti:

 SIGNABLE_API_KEY = 'valid_signable_api_key' bundle exec rspec

Jika Anda memiliki API yang tidak valid atau hilang, Anda akan melihat kesalahan seperti berikut:

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

CATATAN:

• Rekaman VCR mempunyai masa kadaluwarsa, jadi Anda mungkin terpaksa merekam ulang meskipun Anda tidak melakukan perubahan apa pun.
• Rangkaian pengujian bersifat merusak, jadi harap gunakan hanya akun pengujian yang dapat ditandatangani. Akun tersebut memerlukan satu sumber daya Templat agar rangkaian pengujian dapat berjalan.

Untuk mendapatkan kunci Signable API yang valid, masuk ke akun Signable Anda dan navigasikan ke Pengaturan Perusahaan → Api & Webhook dan klik "Tambahkan Kunci API" untuk membuat kunci. Kami menyarankan Anda menghapus kunci setelah selesai menggunakannya.

Berkontribusi

1. Garpu ( http://github.com//signable/fork )
2. Buat cabang fitur Anda ( git checkout -b my-new-feature )
3. Komit perubahan Anda ( git commit -am 'Add some feature' )
4. Dorong ke cabang ( git push origin my-new-feature )
5. Buat Permintaan Tarik baru