signaturit-sdk 0.0.4 → 0.0.5

data/README.md

@@ -69,6 +69,12 @@ response = client.get_signatures(100, 0, 3)
 response = client.get_signatures(100, 0, 3, '2014-7-20')
 ```
 
+##### Getting signatures with custom field "crm_id"
+
+```
+response = client.get_signatures(100, 0, nil, nil, :crm_id => 2445)
+```
+
 ### Count signature requests
 
 Count your signature requests.
@@ -112,6 +118,31 @@ file_path = '/documents/contracts/125932_important.pdf'
 response = client.create_signature_request(file_path, recipients, params)
 ```
 
+You can add custom info in your requests
+
+```
+recipients =  ['bobsoap@signatur.it']
+params = {:subject =>  'Receipt number 250', :body => 'Please, can you sign this document?', :data => {:crm_id => 2445}}
+file_path = '/documents/contracts/125932_important.pdf'
+response = client.create_signature_request(file_path, recipients, params)
+```
+
+### Cancel signature request
+
+Cancel a signature request.
+
+```
+response = client.cancel_signature_request('SIGNATURE_ID');
+```
+
+### Send reminder
+
+Send a reminder for signature request job.
+
+```
+response = client.send_reminder('SIGNATURE_ID', 'DOCUMENT_ID');
+```
+
 ### Get audit trail
 
 Get the audit trail of a signature request document and save it in the submitted path.

data/lib/signaturit_client.rb

@@ -11,7 +11,7 @@ class SignaturitClient
     def initialize(token, production = false)
         base = production ? 'https://api.signaturit.com' : 'http://api.sandbox.signaturit.com'
 
-        @client = RestClient::Resource.new base, :headers => { :Authorization => "Bearer #{token}" }, :ssl_version => :TLSv1_2
+        @client = RestClient::Resource.new base, :headers => { :Authorization => "Bearer #{token}", :user_agent => 'signaturit-ruby-sdk 0.0.4' }, :ssl_version => :TLSv1_2
     end
 
     # get info from your account
@@ -66,12 +66,21 @@ class SignaturitClient
     # +offset+:: Offset of results to skip
     # +status+:: Status of the signature objects to filter
     # +since+:: Filter signature objects created since this date
-    def get_signatures(limit = 100, offset = 0, status = nil, since = nil)
+    # +data+:: Filter signature objects using custom data
+    def get_signatures(limit = 100, offset = 0, status = nil, since = nil, data = nil)
         params = { :limit => limit, :offset => offset }
 
         params[:status] = status unless status.nil?
         params[:since]  = since unless since.nil?
 
+        if data
+          data.each do |key, value|
+            new_key = "data.#{key}"
+
+            params[new_key] = value
+          end
+        end
+
         request :get, '/v2/signs.json', params
     end
 
@@ -80,12 +89,21 @@ class SignaturitClient
     # Params:
     # +status+:: Status of the signature objects to filter
     # +since+:: Filter signature objects created since this date
-    def count_signatures(status = nil, since = nil)
+    # +data+:: Filter signature objects using custom data
+    def count_signatures(status = nil, since = nil, data = nil)
         params = {}
 
         params[:status] = status unless status.nil?
         params[:since]  = since unless since.nil?
 
+        if data
+          data.each do |key, value|
+            new_key = "data.#{key}"
+
+            params[new_key] = value
+          end
+        end
+
         request :get, '/v2/signs/count.json', params
     end
 
@@ -110,7 +128,7 @@ class SignaturitClient
     #
     # Params:
     # +signature_id++:: The id of the signature object
-    # +document_id++:: THe id of the document object
+    # +document_id++:: The id of the document object
     # +path++:: Path where the document will be stored
     def get_audit_trail(signature_id, document_id, path)
         response = request :get, "/v2/signs/#{signature_id}/documents/#{document_id}/download/doc_proof", {}, false
@@ -126,7 +144,7 @@ class SignaturitClient
     #
     # Params:
     # +signature_id++:: The id of the signature object
-    # +document_id++:: THe id of the document object
+    # +document_id++:: The id of the document object
     # +path++:: Path where the document will be stored
     def get_signed_document(signature_id, document_id, path)
         response = request :get, "/v2/signs/#{signature_id}/documents/#{document_id}/download/signed", {}, false
@@ -180,6 +198,15 @@ class SignaturitClient
         request :patch, "/v2/signs/#{signature_id}/cancel.json"
     end
 
+    # Send a reminder for the given signature request document
+    #
+    # Param
+    # +signature_id++:: The id of the signature object
+    # +document_id++:: The id of the document object
+    def send_reminder(signature_id, document_id)
+        request :post, "/v2/signs/#{signature_id}/documents/#{document_id}/reminder.json"
+    end
+
     # Get a concrete branding
     #
     # Params
@@ -293,5 +320,4 @@ class SignaturitClient
 
         body
     end
-
 end

data/signaturit-sdk.gemspec

@@ -1,8 +1,8 @@
 Gem::Specification.new do |s|
     s.platform    = Gem::Platform::RUBY
     s.name        = 'signaturit-sdk'
-    s.version     = '0.0.4'
-    s.date        = '2014-10-17'
+    s.version     = '0.0.5'
+    s.date        = '2015-02-10'
     s.summary     = 'Signaturit Ruby SDK'
     s.description = 'Sign Documents Online'
 

data/test/test_signaturit_client.rb

@@ -110,6 +110,14 @@ class TestSignaturitClient < Test::Unit::TestCase
         assert_requested :patch, 'https://api.signaturit.com/v2/signs/an_id/cancel.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
+    def test_send_reminder
+        stub_request(:any, /.*/).to_return(:body => '{}')
+
+        @client.send_reminder('an_id', 'another_id')
+
+        assert_requested :post, 'https://api.signaturit.com/v2/signs/an_id/documents/another_id/reminder.json', :headers => { :Authorization => 'Bearer a_token' }
+    end
+
     def test_create_signature_request_multi
         stub_request(:any, /.*/).to_return(:body => '{}')
 

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signaturit-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.4
+  version: 0.0.5
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2014-10-17 00:00:00.000000000 Z
+date: 2015-02-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest_client