Ruby wrapper for RightSignature API
Switch branches/tags
Nothing to show
Clone or download
alexchee Merge pull request #18 from entrision/implement-trash-template
implement ability to trash a template
Latest commit 45c059f Feb 24, 2017

README.md

RightSignature API

This gem is a wrapper to RightSignature's API for both OAuth authentication and Token authentication

#####Install

gem install rightsignature

or in your Gemfile

gem 'rightsignature', '~> 1.0.0'

Setup

After getting an API key from RightSignature, you can use the Secure Token or generate an Access Token with the OAuth key and secret using RightSignature::Connection.new. Below are examples on how to use the gem as yourself.

#####Using Token authentication

@rs_connection = RightSignature::Connection.new(:api_token => YOUR_TOKEN)

#####Using OAuth authentication

@rs_connection = RightSignature::Connection.new(
  :consumer_key => "Consumer123",
  :consumer_secret => "Secret098",
  :access_token => "AccessToken098",
  :access_secret => "AccessSecret123"
)

Note: if the both OAuth credentials and api_token are set, the default action is to use Token Authentication.

#####Getting Access Token Make sure you have a server that is can recieve the parameters from RightSignature and the callback is setup correctly in the RightSignature API settings (https://rightsignature.com/oauth_clients).

request_token = @rs_connection.oauth_connection.new_request_token

Now Visit the url generated from

@rs_oauth = @rs_connection.oauth_connection
@rs_oauth.request_token.authorize_url

and log into the site.

After approving the application, you will be redirected to the callback url that is in the RightSignature API settings (https://rightsignature.com/oauth_clients). The OAuth verifier should be in the params "oauth_verifier". Put the verifier in:

@rs_oauth = @rs_connection.oauth_connection
@rs_oauth.generate_access_token(params[:oauth_verifer])

Now, you should have your Connection setup. You can save the access token and access token secret for later use and skip the previous steps.

@rs_oauth.access_token.token
@rs_oauth.access_token.secret

Will give you the Access Token's token and secret.

You can also load the Access Token and Secret by calling

@rs_oauth.set_access_token(token, secret)

If you need to set the Request Token for the OAuth Consumer:

@rs_oauth.set_request_token(token, secret)

After loading the configuration, you can use wrappers in RightSignature::Connection to call the API, or use RightSignature::Connection for more custom calls.

Documents

#####Listing Document For showing all documents

@rs_connection.documents_list

For showing page 1 of completed and trashed documents, with 20 per page, matching search term 'me', with tag "single_tag" and tag "key" with value of "with_value"

options = {
  :state => ['completed', 'trashed'],
  :page => 1,
  :per_page => 20,
  :search => "me",
  :tags => ["single_tag", "key" => "with_value"]
}
@rs_connection.documents_list(options)

Optional Options:

  • page: page number
  • per_page: number of documents to return per page. API only supports 10, 20, 30, 40, or 50. Default is 10.
  • tags: filter documents with given tags. Tags are an array of strings (single tag) and hashes (tag_name => tag_value). Ex. ["single_tag",{"tag_key" => "tag_value"}] would filter documents with 'single_tag' and the name/value of 'tag_key' with value 'tag_value'.
  • search: filter documents with given term.
  • state: An array of document states to filter documents by. API supports 'pending', 'completed', 'trash', and 'pending'.
  • sort: sort documents by given attribute. API supports 'created', 'completed', and 'activity'
  • range: return documents with a certain date range. API only supports 'today', 'thisweek', 'thismonth', 'alltime', or a Date
  • recipient_email: filter document where it has a recipient with given email and involves the current OAuth user.
  • account: include all documents in current account if true. Should be true or false Only available for account admins and owners.

#####Document Details

@rs_connection.document_details(guid)

#####Document Details for Multiple documents

@rs_connection.documents_batch_details(guids)
  • guids: Array of document GUIDs

#####Send Reminder

@rs_connection.send_reminder(guid)

#####Trash Document

@rs_connection.trash_document(guid)

#####Extend Expiration of Document by 7 days

@rs_connection.extend_document_expiration(guid)

#####Replace Tags on Document

tags=['sent_from_api', {'user_id' => '12345'}]
@rs_connection.update_document_tags(guid, tags)
  • guid
  • tags: An array of 'tag_name' or {'tag_name' => 'tag_value'}

#####Sending New Documents From file:

recipients = [
  {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
  {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
  {'is_sender' => true, :role => 'signer'}
]
options={
  :tags => [{:tag => {:name => 'sent_from_api'}}, {:tag => {:name => 'user_id', :value => '12345'}}],
  :expires_in => '5 days',
  :action => "redirect",
  'callback_location' => "http://example.com/doc_callback",
  'use_text_tags' => false
}

@rs_connection.send_document_from_file("here/is/myfile.pdf", 'My Subject', recipients, options)

Or

@rs_connection.send_document_from_file(File.open("here/is/myfile.pdf", 'r'), 'My Subject', recipients)
  • subject: Document subject
  • recipients: Recipients of the document, should be an array of hashes with :name, :email, and :role ('cc' or 'signer'). One recipient requires a :is_sender => true to reference the API User and doesn't need to supply :name and :email. Ex. {:is_sender => true, :role => "cc"}
  • Optional options:
    • description: document description that'll appear in the email
    • action: 'send' or 'redirect'. Redirect will prefill the document and generate a redirect token that can be used on for someone to send document under API user's account.
    • expires_in: number of days before expiring the document. API only allows 2,5,15, or 30.
    • tags: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs) Ex. ['sent_from_api', {"user_id" => "32"}]
    • callback_location: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. Ex. "http://yoursite/callback"
    • use_text_tags: Parse document for special Text Tags. true or false. More info: https://rightsignature.com/apidocs/text_tags

From raw data:

recipients = [
  {:name => "RightSignature", :email => "support@rightsignature.com", :role => 'cc'},
  {:name => "John Bellingham", :email => "john@rightsignature.com", :role => 'signer'},
  {'is_sender' => true, :role => 'signer'}
]
raw_data = File.read("here/is/myfile.pdf")
filename = "Desired Filename.pdf"
@rs_connection.send_document_from_file(raw_data, filename, 'My Subject', recipients)

#####Embedded Signing Links Generates URLs for the embedded signing page for documents with recipients with email of 'noemail@rightsignature.com'. Returns an array of {:name => "John Bellingham", "url" => "https://rightsignature.com/signatures/embedded?rt=1234"}

@rs_connection.get_document_signer_links_for(guid, redirect_location=nil)

Optional Option:

  • redirect_location: URL to redirect user after signing.

Templates

#####Listing Templates

@rs_connection.templates_list(options={})

Optional Options:

  • page: page number
  • per_page: number of documents to return per page. API only supports 10, 20, 30, 40, or 50. Default is 10.
  • tags: filter documents with given tags. Tags are an array of strings, name and value in a name/value tag should be separated by colon (:). Ex. ["single_tag","tag_key:tag_value"] would filter documents with 'single_tag' and the name/value of 'tag_key' with value 'tag_value'.
  • search: filter documents with given term.

#####Template Details

@rs_connection.template_details(guid)

#####Prepackage and Send template Most common use of API, clones a template and sends it for signature.

@rs_connection.prepackage_and_send(guid, roles, options={})
  • guid: template guid to use. Should be a template that was prepackaged
  • roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :email => "a@example.com"}} Optional options:
  • subject: document subject. Defaults to the subject in prepackage response.
  • description: document description that'll appear in the email
  • merge_fields: document merge fields, should be an array of merge_field_values in a hash with the merge_field_name. Ex. [{"Salary" => "$1,000,000"}]
  • expires_in: number of days before expiring the document. API only allows 2,5,15, or 30.
  • tags: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs) Ex. ['sent_from_api', {"user_id" => "32"}]
  • callback_location: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. Ex. "http://yoursite/callback"
  • use_merge_field_ids: Using merge field ids instead of merge field name for merge_fields. true or false.

#####Template Prepacking For cloning a Template before sending it.

@rs_connection.prepackage(guid)

#####Template Prefilling After prepacking, the new template can be updated with prefill data. This won't send out the template as a document.

@rs_connection.prefill(guid, subject, roles, options={})
  • guid: template guid to use. Should be a template that was prepackaged
  • subject: document subject.
  • roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :email => "a@example.com"}}
  • Optional options:
    • description: document description that'll appear in the email
    • merge_fields: document merge fields, should be an array of merge_field_values in a hash with the merge_field_name. Ex. [{"Salary" => "$1,000,000"}]
    • expires_in: number of days before expiring the document. API only allows 2,5,15, or 30.
    • tags: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs) Ex. ['sent_from_api', {"user_id" => "32"}]
    • callback_location: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. Ex. "http://yoursite/callback"
    • use_merge_field_ids: Using merge field ids instead of merge field name for merge_fields. true or false.
options = {
  :description => "Please read over the handbook and sign it.",
  :merge_fields => [
    { "Department" => "Fun and games" },
    { "Salary" => "$1,000,000" }
  ],
  :expires_in => 5,
  :tags => [
    {:name => 'sent_from_api'},
    {:name => 'user_id', :value => '32'}
  ],
  :callback_location => "http://yoursite/callback"
}
@rs_connection.prefill(guid, subject, roles, options)

#####Template Sending Send template as a document for signing. Same options as prefill.

@rs_connection.send_template(guid, subject, roles, options={})
  • guid: template guid to use. Should be a template that was prepackaged
  • subject: document subject.
  • roles: recipient names in array of {:name => "Person's Name", :email => "Email"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name", :email => "a@example.com"}}
  • Optional options:
    • description: document description that'll appear in the email
    • merge_fields: document merge fields, should be an array of merge_field_values in a hash with the merge_field_name. Ex. [{"Salary" => "$1,000,000"}]
    • expires_in: number of days before expiring the document. API only allows 2,5,15, or 30.
    • tags: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs) Ex. ['sent_from_api', {"user_id" => "32"}]
    • callback_location: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. Ex. "http://yoursite/callback"
    • use_merge_field_ids: Using merge field ids instead of merge field name for merge_fields. true or false.
options = {
  :description => "Please read over the handbook and sign it.",
  :merge_fields => [
    { "Department" => "Fun and games" },
    { "Salary" => "$1,000,000" }
  ],
  :expires_in => 5,
  :tags => [
    {:name => 'sent_from_api'},
    {:name => 'user_id', :value => '32'}
  ],
  :callback_location => "http://yoursite/callback"
}
@rs_connection.send_template(guid, subject, roles, options)

#####Embedded Signing Links for Sent Template Prepackages a template, and sends it out with each recipients marked as a embedded signer (email as noemail@rightsignature.com), then generates embedded signing URLs. Returns an array of {:name => "John Bellingham", "url" => "https://rightsignature.com/signatures/embedded?rt=1234"}

@rs_connection.send_as_embedded_signers(guid, recipients, options={})
  • guid: guid of template to create document with
  • recipient: recipient names in array of {:name => "Person's Name"} hashed by Role ID. Ex. {"signer_A" => {:name => "Your Name"}}
  • options:
    • subject: document subject that'll appear in the email
    • description: document description that'll appear in the email
    • merge_fields: document merge fields, should be an array of merge_field_values in a hash with the merge_field_name. Ex. [{"Salary" => "$1,000,000"}]
    • expires_in: number of days before expiring the document. API only allows 2,5,15, or 30.
    • tags: document tags, an array of string or hashes 'single_tag' (for simple tag) or {'tag_name' => 'tag_value'} (for tuples pairs) Ex. ['sent_from_api', {"user_id" => "32"}]
    • callback_location: A URI encoded URL that specifies the location for API to POST a callback notification to when the document has been created and signed. Ex. "http://yoursite/callback"
    • redirect_location: URL to redirect users after signing.
    • use_merge_field_ids: Using merge field ids instead of merge field name for merge_fields. true or false.

#####Create New Template Link Generate a url that let's someone upload and create a template under OAuth user's account.

@rs_connection.generate_build_url

You can also add restrictions to what the person can do:

  • callback_location: URI encoded URL that specifies the location we will POST a callback notification to when the template has been created.
  • redirect_location: A URI encoded URL that specifies the location we will redirect the user to, after they have created a template.
  • tags: tags to add to the template. an array of strings (for simple tag) or hashes like {'tag_name' => 'tag_value'} (for tuples pairs) Ex. ['created_from_api', {"user_id" => "123"}]
  • acceptable_role_names: The user creating the Template will be forced to select one of the values provided. There will be no free-form name entry when adding roles to the Template. An array of strings. Ex. ["Employee", "Employeer"]
  • acceptable_merge_field_names: The user creating the Template will be forced to select one of the values provided. There will be no free-form name entry when adding merge fields to the Template. Ex. ["Location", "Tax ID", "Company Name"]
options = {
  :acceptable_merge_field_names =>
    [
      "Site ID",
      "Starting City"
    ],
  :acceptable_role_names =>
    [
      "Http Monster",
      "Party Monster"
    ],
  :callback_location => "http://example.com/done_signing",
  :redirect_location => "http://example.com/come_back_here"
}
@rs_connection.generate_build_url(options)

Account

API calls involving API user's account.

#####User Details

@rs_connection.user_details

#####Add User to Account

@rs_connection.add_user(name, email)

#####Usage Report Returns number of documents sent. Can scope to week, month, or day and count only signed, unsigned, or all documents.

@rs_connection.usage_report(since=nil, signed=nil)
  • since: Only count documents sent withing the 'week', 'month', or 'day'.
  • signed: Only count signed documents if 'true', else all documents

Custom API calls using RightSignature::Connection

In case there are new API paths, RightSignature::Connection allows a specific path to be specified. #####Ex. GET https://rightsignature.com/api/documents.xml

@rs_connection.get('/api/documents.xml', {:my => 'params'}, {'custom_header' => 'headerValue'})

#####Ex. POST https://rightsignature.com/api/documents.xml

request_hash= {
  :document => {
    :subject => "Your Form",
    'document_data' => {:type => 'url', :value => 'http://localhost:3000/sub.pdf' }
  }
}
@rs_connection.post('/api/documents.xml', request_hash, {'custom_header' => 'headerValue'})

Getting API Error Messages

If a request does not return a success response (200), a RightSignature::ResponseError is raised. You can rescue the error and inspect the response object or call detailed_message. detailed_message only returns if the response from the server contains an error message in the XML. #####Ex. Trying to parse the error message response from API

begin
  @rs_connection.post('/api/documents.xml', {:bad => 'params'})
rescue RightSignature::ResponseError => error
  puts error.detailed_message
end

#####Ex. Trying to inspect the response object for more information

begin
  @rs_connection.post('/api/documents.xml', {:bad => 'params'})
rescue RightSignature::ResponseError => error
  puts error.response.inspect
end

Development Notes

To load in irb from project root:

$:.push File.expand_path("../lib", __FILE__); require "rightsignature"; RightSignature::Connection.new(MY_KEYS)