README.md

Signable

The signable client provides a simple Ruby interface to the Signable API.

Installation

Add this line to your application's Gemfile:

gem 'signable'

And then execute:

$ bundle

Or install it yourself as:

$ gem install signable

Usage

Configuration

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

Retrieve a template

Signable::Template.find 'fingerprint'

Build a document

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

A document may also contain merge_fields (see signable documentation)

Build a party

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

Party id can be retrieved from the template

Create an envelope

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

envelope.save

Contributing

1. Fork it ( http://github.com//signable/fork )
2. Create your feature branch (git checkout -b my-new-feature)
3. Commit your changes (git commit -am 'Add some feature')
4. Push to the branch (git push origin my-new-feature)
5. Create new Pull Request