signaturit-sdk 0.0.5 → 1.0.0

data/CHANGELOG.md

@@ -0,0 +1,21 @@
+CHANGELOG
+=========
+
+* 1.0.0 (2016-01-20)
+ * updated all methods to use api v3
+
+* 0.0.5 (2015-02-10)
+ * added send reminder for signature request method
+ * fixed a bug sending params
+
+* 0.0.4 (2014-10-20)
+ * added cancel signature request
+
+* 0.0.3 (2014-10-17)
+ * fixed a bug with ssl
+
+* 0.0.2 (2014-09-16)
+ * added a new method to revert document storage
+
+* 0.0.1 (2014-09-04)
+ * initial release

data/Gemfile

@@ -1,4 +1,4 @@
 source 'http://rubygems.org'
 
-gem 'rest_client', '~> 1.7.3'
-gem 'webmock', '~> 1.18.0'
+gem 'rest_client', '~> 1.7'
+gem 'webmock', '~> 1.18'

data/Gemfile.lock

@@ -1,20 +1,25 @@
 GEM
   remote: http://rubygems.org/
   specs:
-    addressable (2.3.6)
-    crack (0.4.2)
+    addressable (2.4.0)
+    crack (0.4.3)
       safe_yaml (~> 1.0.0)
-    netrc (0.7.7)
-    rest_client (1.7.3)
+    hashdiff (0.2.3)
+    netrc (0.7.9)
+    rest_client (1.8.3)
       netrc (~> 0.7.7)
-    safe_yaml (1.0.3)
-    webmock (1.18.0)
+    safe_yaml (1.0.4)
+    webmock (1.22.6)
       addressable (>= 2.3.6)
       crack (>= 0.3.2)
+      hashdiff
 
 PLATFORMS
   ruby
 
 DEPENDENCIES
-  rest_client (~> 1.7.3)
-  webmock (~> 1.18.0)
+  rest_client (~> 1.7)
+  webmock (~> 1.18)
+
+BUNDLED WITH
+   1.11.2

data/README.md

@@ -1,7 +1,7 @@
 Signaturit Ruby SDK
 ===================
 
-This package is a wrapper for Signaturit Api. If you didn't read the documentation yet, maybe it's time to take a look [here](http://docs.signaturit.com/).
+This package is a wrapper for Signaturit Api. If you didn't read the documentation yet, maybe it's time to take a look [here](https://docs.signaturit.com/).
 
 You can install the package through gem.
 
@@ -42,37 +42,37 @@ Retrieve all data from your signature requests using different filters.
 ##### All signatures
 
 ```
-response = client.get_signatures()
+response = client.get_signatures
 ```
 
 ##### Getting the last 50 signatures
 
 ```
-response = client.get_signatures(50)
+response = client.get_signatures 50
 ```
 
 ##### Getting the following last 50 signatures
 
 ```
-response = client.get_signatures(50, 50)
+response = client.get_signatures 50, 50
 ```
 
-##### Getting only the finished signatures 
+##### Getting only the finished signatures
 
 ```
-response = client.get_signatures(100, 0, 3)
+response = client.get_signatures 100, 0, {:status => 'completed'}
 ```
 
 ##### Getting the finished signatures created since July 20th of 2014
 
 ```
-response = client.get_signatures(100, 0, 3, '2014-7-20')
+response = client.get_signatures 100, 0, 3, {:since => '2014-7-20'}
 ```
 
 ##### Getting signatures with custom field "crm_id"
 
 ```
-response = client.get_signatures(100, 0, nil, nil, :crm_id => 2445)
+response = client.get_signatures 100, 0, {:crm_id => 2445}
 ```
 
 ### Count signature requests
@@ -80,7 +80,7 @@ response = client.get_signatures(100, 0, nil, nil, :crm_id => 2445)
 Count your signature requests.
 
 ```
-response = client.count_signatures()
+response = client.count_signatures
 ```
 
 ### Get signature request
@@ -88,34 +88,27 @@ response = client.count_signatures()
 Get a single signature request.
 
 ```
-response = client.get_signature('SIGNATURE_ID')
+response = client.get_signature 'SIGNATURE_ID'
 ```
 
-### Get signature documents
-
-Get all documents from a signature request.
-
-```
-response = client.get_signature_documents('SIGNATURE_ID')
-```
-
-### Get signature document
+### Signature request
 
-Get a single document from a signature request.
+Create a new signature request. You can check all signature [params](https://docs.signaturit.com/api/v3#sign_create_sign).
 
 ```
-response = client.get_signature_document('SIGNATURE_ID','DOCUMENT_ID')
+recipients =  ['bobsoap@signatur.it']
+params = {:subject: 'Receipt number 250', :body: 'Please, can you sign this document?'}
+file_path = '/documents/contracts/125932_important.pdf'
+response = client.create_signature file_path, recipients, params
 ```
 
-### Signature request
-
-Create a new signature request. Check all [params](http://docs.signaturit.com/api/#sign_create_sign).
+You can send templates with the fields filled
 
 ```
 recipients =  ['bobsoap@signatur.it']
-params = {:subject: 'Receipt number 250', :body: 'Please, can you sign this document?'}
-file_path = '/documents/contracts/125932_important.pdf'
-response = client.create_signature_request(file_path, recipients, params)
+params = {:subject =>  'Receipt number 250', :body => 'Please, can you sign this document?', :templates =>  {'TEMPLATE_ID'}, :data => {:WIDGET_ID => 'DEFAULT_VALUE'}}
+
+response = client.create_signature {}, recipients, params
 ```
 
 You can add custom info in your requests
@@ -124,7 +117,7 @@ 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)
+response = client.create_signature file_path, recipients, params
 ```
 
 ### Cancel signature request
@@ -132,7 +125,7 @@ response = client.create_signature_request(file_path, recipients, params)
 Cancel a signature request.
 
 ```
-response = client.cancel_signature_request('SIGNATURE_ID');
+response = client.cancel_signature 'SIGNATURE_ID'
 ```
 
 ### Send reminder
@@ -140,123 +133,135 @@ response = client.cancel_signature_request('SIGNATURE_ID');
 Send a reminder for signature request job.
 
 ```
-response = client.send_reminder('SIGNATURE_ID', 'DOCUMENT_ID');
+response = client.send_signature_reminder 'SIGNATURE_ID'
 ```
 
 ### Get audit trail
 
-Get the audit trail of a signature request document and save it in the submitted path.
+Get the audit trail of a signature request document
 
 ```
-response = client.get_audit_trail('ID', 'DOCUMENT_ID', '/path/doc.pdf')
+response = client.download_audit_trail 'ID', 'DOCUMENT_ID'
 ```
 
 ### Get signed document
 
-Get the signed document of a signature request document and save it in the submitted path.
+Get the signed document of a signature request document
 
 ```
-response = client.get_signed_document('ID', 'DOCUMENT_ID', '/path/doc.pdf')
+response = client.download_signed_document 'ID', 'DOCUMENT_ID'
 ```
 
-## Account
+## Branding
+
+### Get brandings
+
+Get all account brandings.
+
+```
+response = client.get_brandings
+```
 
-### Get account
+### Get branding
 
-Retrieve the information of your account.
+Get a single branding.
 
 ```
-response = client.get_account()
+response = client.get_branding 'BRANDING_ID'
 ```
 
-### Set document storage
+### Create branding
 
-Set your own storage credentials, to store a copy of the documents. You can get all the info of credential types [here](http://docs.signaturit.com/api/#account_set_credentials).
+Create a new branding. You can check all branding [params](https://docs.signaturit.com/api/v3#set_branding).`
 
 ```
-credentials = {
-    :user: 'john',
-    :port: 22,
-    :dir: '/test',
-    :host: 'john.doe.server',
-    :password: 'XXX',
-    :auth_method: 'PASS'
+params = {
+    :layout_color: '#FFBF00',
+    :text_color: '#2A1B0A',
+    :application_texts: { :sign_button: 'Sign!' }
 }
-response = client.set_document_storage('sftp', credentials)
+response = client.create_branding params
 ```
 
-### Revert to default document storage
+### Update branding
 
-If you ever want to store your files in Signaturit's servers just run this method:
+Update a single branding.
 
 ```
-client.revert_to_default_document_storage()
+params = { :application_texts: { :send_button: 'Send!' } }
+response = client.update_branding 'BRANDING_ID', params
 ```
 
-## Branding
+## Template
 
-### Get brandings
+### Get all templates
 
-Get all account brandings.
+Retrieve all data from your templates.
 
 ```
-response = client.get_brandings()
+response = client.get_templates
 ```
 
-### Get branding
+## Email
 
-Get a single branding.
+### Get emails
+
+####Get all certified emails
 
 ```
-response = client.get_branding('BRANDING_ID')
+response = client.get_emails
 ```
 
-### Create branding
+####Get last 50 emails
+
+```
+response = client.get_emails 50
+```
 
-Create a new branding. You can check all branding params [here](http://docs.signaturit.com/api/#set_branding).`
+####Navigate through all emails in blocks of 50 results
 
 ```
-params = {
-    :corporate_layout_color: '#FFBF00',
-    :corporate_text_color: '#2A1B0A',
-    :application_texts: { :sign_button: 'Sign!' }
-}
-response = client.create_branding(params)
+response = client.get_emails 50, 50
 ```
 
-### Update branding
+### Count emails
 
-Update a single branding.
+Count all certified emails
 
 ```
-params = { :application_texts: { :send_button: 'Send!' } }
-response = client.update_branding('BRANDING_ID', params)
+response = client.count_emails
 ```
 
-### Update branding logo
+### Get email
 
-Change the branding logo.
+Get a single email
 
 ```
-file_path = '/path/new_logo.png'
-response = client.update_branding_logo('BRANDING_ID', file_path)
+client.get_email 'EMAIL_ID'
 ```
 
-### Update branding template
+### Create email
 
-Change a template. Learn more about the templates [here](http://docs.signaturit.com/api/#put_template_branding).
+Create a new certified email.
 
 ```
-file_path = '/path/new_template.html'
-response = client.update_branding_template('BRANDING_ID', 'sign_request', file_path)
+file_path  = '/path/document.pdf'
+recipients = [{:name => 'Mr John', :email => 'john.doe@signaturit.com'}]
+response  = client.create_email file_path, recipients, 'ruby subject', 'ruby body', {}
 ```
 
-## Template
+### Get original file
 
-### Get all templates
+Get the original document of an email request
 
-Retrieve all data from your templates.
+```
+response = client.download_email_original_file 'EMAIL_ID','CERTIFICATE_ID'
+```
+
+### Get audit trail document
+
+Get the audit trail document of an email request
 
 ```
-response = client.get_templates()
+response = client.download_email_audit_trail 'EMAIL_ID','CERTIFICATE_ID'
 ```

data/lib/signaturit_client.rb

@@ -9,46 +9,9 @@ class SignaturitClient
 
     # Initialize the object with the token and environment
     def initialize(token, production = false)
-        base = production ? 'https://api.signaturit.com' : 'http://api.sandbox.signaturit.com'
+        base = production ? 'https://api.signaturit.com' : 'https://api.sandbox.signaturit.com'
 
-        @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
-    def get_account
-        request :get, '/v2/account.json'
-    end
-
-    # Set the credentials in account, in order to store a copy from all documents
-    #
-    # Params:
-    # +type+:: Type of storage, sftp or s3
-    # +params+:: An array with credentials data
-    #     sftp:
-    #         - host: Your host
-    #         - port: Connection port
-    #         - dir: Directory where store the files
-    #         - user: Username
-    #         - auth_method: KEY or PASS
-    #         pass:
-    #             - password: Password
-    #         key:
-    #             - private: Private key
-    #             - public: Public key
-    #             - passphrase: The passphrase
-    #     s3:
-    #         - bucket: Name of bucket
-    #         - key: S3 key
-    #         - secret: S3 secret
-    def set_document_storage(type, params)
-        params[:type] = type
-
-        request :post, '/v2/account/storage.json', params
-    end
-
-    # Revert the document storage to the signaturit's default
-    def revert_to_default_document_storage
-        request :delete, '/v2/account/storage.json'
+        @client = RestClient::Resource.new base, :headers => { :Authorization => "Bearer #{token}", :user_agent => 'signaturit-ruby-sdk 1.0.0' }, :ssl_version => :TLSv1_2
     end
 
     # Get a concrete signature object
@@ -56,7 +19,7 @@ class SignaturitClient
     # Params:
     # +signature_id+:: The id of the signature object
     def get_signature(signature_id)
-        request :get, "/v2/signs/#{signature_id}.json"
+        request :get, "/v3/signatures/#{signature_id}.json"
     end
 
     # Get a list of signature objects
@@ -64,64 +27,24 @@ class SignaturitClient
     # Params:
     # +limit+:: Maximum number of results to return
     # +offset+:: Offset of results to skip
-    # +status+:: Status of the signature objects to filter
-    # +since+:: Filter signature objects created since this date
-    # +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 }
+    # +conditions+:: Filter conditions
+    def get_signatures(limit = 100, offset = 0, conditions = {})
+        params = extract_query_params conditions
 
-        params[:status] = status unless status.nil?
-        params[:since]  = since unless since.nil?
+        params['limit']  = limit
+        params['offset'] = offset
 
-        if data
-          data.each do |key, value|
-            new_key = "data.#{key}"
-
-            params[new_key] = value
-          end
-        end
-
-        request :get, '/v2/signs.json', params
+        request :get, "/v3/signatures.json", params
     end
 
     # Get the number of signature objects
     #
     # Params:
-    # +status+:: Status of the signature objects to filter
-    # +since+:: Filter signature objects created since this date
-    # +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
+    # +conditions+:: Filter conditions
+    def count_signatures(conditions = {})
+        params = extract_query_params conditions
 
-        request :get, '/v2/signs/count.json', params
-    end
-
-    # Get a concrete document from a concrete Signature
-    #
-    # Params:
-    # +signature_id+:: The id of the signature object
-    # +document_id+:: The id of the document object
-    def get_signature_document(signature_id, document_id)
-        request :get, "/v2/signs/#{signature_id}/documents/#{document_id}.json"
-    end
-
-    # Get all documents in the given signature object
-    #
-    # Params:
-    # +signature_id+:: The id of the signature object
-    def get_signature_documents(signature_id)
-        request :get, "/v2/signs/#{signature_id}/documents.json"
+        request :get, "/v3/signatures/count.json", params
     end
 
     # Get the audit trail of concrete document
@@ -129,15 +52,8 @@ class SignaturitClient
     # Params:
     # +signature_id++:: The id of the signature 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
-
-        File.open(path, 'wb') do |file|
-            file.write(response)
-        end
-
-        nil
+    def download_audit_trail(signature_id, document_id)
+        request :get, "/v3/signatures/#{signature_id}/documents/#{document_id}/download/audit_trail", {}, false
     end
 
     # Get the signed document
@@ -145,15 +61,8 @@ class SignaturitClient
     # Params:
     # +signature_id++:: The id of the signature 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
-
-        File.open(path, 'wb') do |file|
-            file.write(response)
-        end
-
-        nil
+    def download_signed_document(signature_id, document_id)
+        request :get, "/v3/signatures/#{signature_id}/documents/#{document_id}/download/signed", {}, false
     end
 
     # Create a new Signature request
@@ -164,47 +73,36 @@ class SignaturitClient
     # {:name => "a name", :email => "me@domain.com", :phone => "34655123456"}
     # or an array of hashes.
     # +params+:: An array of parameters for the signature object
-    #   - subject: Subject of the email
-    #   - body: Body of the email
-    #   - in_person: If you want to do an in person sign (system will not send
-    #   an email to the user, but return the signature url instead)
-    #   - sequential: If you want to do a sequential sign (for multiple
-    #   recipients, the sign goes in sequential way)
-    #   - photo: If a photo is required in sign process
-    #   - mandatory_pages: An array with the pages the signer must sign
-    #   - branding_id: The id of the branding you want to use
-    #   - templates: An array ot template ids to use.
-    def create_signature_request(filepath, recipients, params = {})
+    def create_signature(filepath, recipients, params = {})
         params[:recipients] = {}
 
-        [recipients].flatten().each_with_index do |recipient, index|
+        [recipients].flatten.each_with_index do |recipient, index|
             params[:recipients][index] = recipient
         end
 
-        params[:files] = [filepath].flatten().map do |filepath|
+        params[:files] = [filepath].flatten.map do |filepath|
             File.new(filepath, 'rb')
         end
 
-        params[:templates] = [params[:templates]].flatten() if params[:templates]
+        params[:templates] = [params[:templates]].flatten if params[:templates]
 
-        request :post, '/v2/signs.json', params
+        request :post, "/v3/signatures.json", params
     end
 
     # Cancel a signature request
     #
     # Params
     # +signature_id++:: The id of the signature object
-    def cancel_signature_request(signature_id)
-        request :patch, "/v2/signs/#{signature_id}/cancel.json"
+    def cancel_signature(signature_id)
+        request :patch, "/v3/signatures/#{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"
+    def send_signature_reminder(signature_id)
+        request :post, "/v3/signatures/#{signature_id}/reminder.json"
     end
 
     # Get a concrete branding
@@ -212,52 +110,20 @@ class SignaturitClient
     # Params
     # +branding_id+:: The id of the branding object
     def get_branding(branding_id)
-        request :get, "/v2/brandings/#{branding_id}.json"
+        request :get, "/v3/brandings/#{branding_id}.json"
     end
 
     # Get all account brandings
     def get_brandings
-        request :get, '/v2/brandings.json'
+        request :get, "/v3/brandings.json"
     end
 
     # Create a new branding
     #
     # Params:
     # +params+:: An array of parameters for the branding object
-    #   - primary: If set, this new branding will be the default one
-    #   - corporate_layout_color: Default color for all application widgets
-    #   - corporate_text_color: Default text color for all application widgets
-    #   - application_texts: A dict with the new text values
-    #     - sign_button: Text for sign button
-    #     - send_button: Text for send button
-    #     - decline_button: Text for decline button:
-    #     - decline_modal_title: Title for decline modal
-    #     - decline_modal_body: Body for decline modal
-    #     - photo: Photo message text, which tells the user that a photo is
-    #       needed in the current process
-    #     - multi_pages: Header of the document, which tells the user the
-    #       number of pages to sign
-    #   - subject_tag: This tag appears at the subject of all your messages
-    #   - reminders: A list with reminder times (in seconds). Every reminder
-    #   time, a email will be sent, if the signer didn't sign the document
-    #   - expire_time: The signature time (in seconds). When the expire time is
-    #   over, the document cannot be signed. Set 0 if you want a signature
-    #   without expire time.
-    #   - callback_url: A url to redirect the user, when the process is over.
-    #   - signature_pos_x: Default position x of signature
-    #   - signature_pos_y: Default position y of signature
-    #   - terms_and_conditions_label: The terms text that appears when you need
-    #   to check the button to accept.
-    #   - terms_and_conditions_body: Custom text that appears below signature
-    #   conditions
-    #   - hide_legal_section: If true, legal section in email footer doesn't
-    #   appear
-    #   - hide_info_section: If true, info section in email footer doesn't
-    #   appear
-    #   - hide_contact_section: If true, contact section in email footer
-    #   doesn't appear
     def create_branding(params)
-        request :post, '/v2/brandings.json', params
+        request :post, "/v3/brandings.json", params
     end
 
     # Update a existing branding
@@ -266,48 +132,111 @@ class SignaturitClient
     # +branding_id+:: Id of the branding to update
     # +params+:: Same params as method create_branding, see above
     def update_branding(branding_id, params)
-        request :patch, "/v2/brandings/#{branding_id}.json", params
+        request :patch, "/v3/brandings/#{branding_id}.json", params
     end
 
-    # Update the logo of a branding
+    # Get a list of template objects
     #
     # Params:
-    # +branding_id+:: Id of the branding to update
-    # +filepath+:: The path to the image file
-    def update_branding_logo(branding_id, filepath)
-        request :put, "/v2/brandings/#{branding_id}/logo.json", File.read(filepath)
+    # +limit+:: Maximum number of results to return
+    # +offset+:: Offset of results to skip
+    def get_templates(limit = 100, offset = 0)
+        params = { :limit => limit, :offset => offset }
+
+        request :get, "/v3/templates.json", params
     end
 
-    # Update the template of a branding
+    # Get all emails
     #
     # Params:
-    # +branding_id+:: Id of the branding to update
-    # +filepath+:: The path to the html file
-    # +template+:: The email template trying to update
-    def update_branding_template(branding_id, template, filepath)
-        request :put, "/v2/brandings/#{branding_id}/emails/#{template}.json", File.read(filepath)
+    # +limit+:: Maximum number of results to return
+    # +offset+:: Offset of results to skip
+    # +conditions+:: Query conditions
+    def get_emails(limit = 100, offset = 0, conditions = {})
+        params = extract_query_params conditions
+
+        params['limit']  = limit
+        params['offset'] = offset
+
+        request :get, "/v3/emails.json", params
     end
 
-    # Get a list of template objects
+    # Count all emails
     #
     # Params:
-    # +limit+:: Maximum number of results to return
-    # +offset+:: Offset of results to skip
-    def get_templates(limit = 100, offset = 0)
-        params = { :limit => limit, :offset => offset }
+    # +conditions+:: Query conditions
+    def count_emails(conditions = {})
+        params = extract_query_params conditions
 
-        request :get, '/v2/templates.json', params
+        request :get, "/v3/emails/count.json", params
     end
 
-    # PRIVATE METHODS FROM HERE
+    # Get a single email
+    #
+    # Params:
+    # +email_id+:: Id of email
+    def get_email(email_id)
+        request :get, "/v3/emails/#{email_id}.json"
+    end
+
+    # Create a new email
+    #
+    # Params:
+    # +files+:: File or files to send with the email
+    # +recipients+:: Recipients for the email
+    # +subject+:: Email subject
+    # +body+:: Email body
+    # +params+:: Extra params
+    def create_email(files, recipients, subject, body, params = {})
+        params[:recipients] = {}
+
+        [recipients].flatten.each_with_index do |recipient, index|
+            params[:recipients][index] = recipient
+        end
 
+        params[:files] = [files].flatten.map do |filepath|
+            File.new(filepath, 'rb')
+        end
+
+        params[:subject] = subject
+        params[:body]    = body
+
+        request :post, "/v3/emails.json", params
+    end
+
+    # Get the audit trail of concrete certificate
+    #
+    # Params:
+    # +email_id++:: The id of the signature object
+    # +certificate_id++:: The id of the document object
+    def download_email_audit_trail(email_id, certificate_id)
+        request :get, "/v3/emails/#{email_id}/certificates/#{certificate_id}/download/audit_trail", {}, false
+    end
+
+    # PRIVATE METHODS FROM HERE
     private
 
+    # Parse query parameters
+    def extract_query_params(conditions)
+        params = {}
+
+        conditions.each do |key, value|
+            if key == 'ids'
+                value = value.join(',')
+            end
+
+            params[key] = value
+        end
+
+        params
+    end
+
     # Common request method
     def request(method, path, params = {}, to_json = true)
         case method
             when :get, :delete
                 encoded = URI.encode_www_form(params)
+
                 path = "#{path}?#{encoded}" if encoded.length > 0
 
                 body = @client[path].send method
@@ -320,4 +249,5 @@ 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.5'
-    s.date        = '2015-02-10'
+    s.version     = '1.0.0'
+    s.date        = '2016-01-20'
     s.summary     = 'Signaturit Ruby SDK'
     s.description = 'Sign Documents Online'
 
@@ -15,7 +15,7 @@ Gem::Specification.new do |s|
 
     s.license     = 'MIT'
 
-    s.add_dependency 'rest_client', '~> 1.7.3'
+    s.add_dependency 'rest_client', '~> 1.7'
 
-    s.add_development_dependency 'webmock', '~> 1.18.0'
+    s.add_development_dependency 'webmock', '~> 1.18'
 end

data/test/test_signaturit_client.rb

@@ -12,36 +12,12 @@ class TestSignaturitClient < Test::Unit::TestCase
         @client = SignaturitClient.new TOKEN, true
     end
 
-    def test_get_account
-        stub_request(:any, /.*/).to_return(:body => '{}')
-
-        @client.get_account()
-
-        assert_requested :get, 'https://api.signaturit.com/v2/account.json', :headers => { :Authorization => 'Bearer a_token' }
-    end
-
-    def test_set_document_storage
-        stub_request(:any, /.*/).to_return(:body => '{}')
-
-        @client.set_document_storage('sftp', {})
-
-        assert_requested :post, 'https://api.signaturit.com/v2/account/storage.json', :headers => { :Authorization => 'Bearer a_token' }
-    end
-
-    def test_revert_to_default_document_storage
-        stub_request(:any, /.*/).to_return(:body => '{}')
-
-        @client.revert_to_default_document_storage()
-
-        assert_requested :delete, 'https://api.signaturit.com/v2/account/storage.json', :headers => { :Authorization => 'Bearer a_token' }
-    end
-
     def test_get_signature
         stub_request(:any, /.*/).to_return(:body => '{}')
 
         @client.get_signature 'an_id'
 
-        assert_requested :get, 'https://api.signaturit.com/v2/signs/an_id.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/signatures/an_id.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_get_signatures
@@ -49,47 +25,32 @@ class TestSignaturitClient < Test::Unit::TestCase
 
         @client.get_signatures(5, 10)
 
-        assert_requested :get, 'https://api.signaturit.com/v2/signs.json?limit=5&offset=10', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/signatures.json?limit=5&offset=10', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_count_signatures
         stub_request(:any, /.*/).to_return(:body => '{}')
 
-        @client.count_signatures('signed', '1982-07-27')
+        @client.count_signatures({:status => 'signed', :since =>'1982-07-27'})
 
-        assert_requested :get, 'https://api.signaturit.com/v2/signs/count.json?status=signed&since=1982-07-27', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/signatures/count.json?status=signed&since=1982-07-27', :headers => { :Authorization => 'Bearer a_token' }
     end
 
-    def test_get_signature_document
-        stub_request(:any, /.*/).to_return(:body => '{}')
-
-        @client.get_signature_document('an_id', 'another_id')
-
-        assert_requested :get, 'https://api.signaturit.com/v2/signs/an_id/documents/another_id.json', :headers => { :Authorization => 'Bearer a_token' }
-    end
-
-    def test_get_signature_documents
-        stub_request(:any, /.*/).to_return(:body => '[]')
-
-        @client.get_signature_documents('an_id')
-
-        assert_requested :get, 'https://api.signaturit.com/v2/signs/an_id/documents.json', :headers => { :Authorization => 'Bearer a_token' }
-    end
 
     def test_get_audit_trail
         stub_request(:any, /.*/).to_return(:body => '')
 
-        @client.get_audit_trail('an_id', 'another_id', Tempfile.new('pdf').path)
+        @client.download_audit_trail('an_id', 'another_id')
 
-        assert_requested :get, 'https://api.signaturit.com/v2/signs/an_id/documents/another_id/download/doc_proof', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/signatures/an_id/documents/another_id/download/audit_trail', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_get_signed_document
         stub_request(:any, /.*/).to_return(:body => '')
 
-        @client.get_signed_document('an_id', 'another_id', Tempfile.new('pdf').path)
+        @client.download_signed_document('an_id', 'another_id')
 
-        assert_requested :get, 'https://api.signaturit.com/v2/signs/an_id/documents/another_id/download/signed', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/signatures/an_id/documents/another_id/download/signed', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_create_signature_request
@@ -97,25 +58,25 @@ class TestSignaturitClient < Test::Unit::TestCase
 
         path = File.join(File.expand_path(File.dirname(__FILE__)), 'file.pdf')
 
-        @client.create_signature_request(path, 'admin@signatur.it')
+        @client.create_signature path, 'admin@signatur.it'
 
-        assert_requested :post, 'https://api.signaturit.com/v2/signs.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :post, 'https://api.signaturit.com/v3/signatures.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_cancel_signature_request
         stub_request(:any, /.*/).to_return(:body => '{}')
 
-        @client.cancel_signature_request('an_id')
+        @client.cancel_signature 'an_id'
 
-        assert_requested :patch, 'https://api.signaturit.com/v2/signs/an_id/cancel.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :patch, 'https://api.signaturit.com/v3/signatures/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')
+        @client.send_signature_reminder 'an_id'
 
-        assert_requested :post, 'https://api.signaturit.com/v2/signs/an_id/documents/another_id/reminder.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :post, 'https://api.signaturit.com/v3/signatures/an_id/reminder.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_create_signature_request_multi
@@ -126,9 +87,9 @@ class TestSignaturitClient < Test::Unit::TestCase
             File.join(File.expand_path(File.dirname(__FILE__)), 'file.pdf')
         ]
 
-        @client.create_signature_request(paths, 'admin@signatur.it')
+        @client.create_signature paths, 'admin@signatur.it'
 
-        assert_requested :post, 'https://api.signaturit.com/v2/signs.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :post, 'https://api.signaturit.com/v3/signatures.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_get_branding
@@ -136,15 +97,15 @@ class TestSignaturitClient < Test::Unit::TestCase
 
         @client.get_branding('an_id')
 
-        assert_requested :get, 'https://api.signaturit.com/v2/brandings/an_id.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/brandings/an_id.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_get_brandings
         stub_request(:any, /.*/).to_return(:body => '[]')
 
-        @client.get_brandings()
+        @client.get_brandings
 
-        assert_requested :get, 'https://api.signaturit.com/v2/brandings.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/brandings.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_create_branding
@@ -152,7 +113,7 @@ class TestSignaturitClient < Test::Unit::TestCase
 
         @client.create_branding({})
 
-        assert_requested :post, 'https://api.signaturit.com/v2/brandings.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :post, 'https://api.signaturit.com/v3/brandings.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_update_branding
@@ -160,27 +121,7 @@ class TestSignaturitClient < Test::Unit::TestCase
 
         @client.update_branding('an_id', {})
 
-        assert_requested :patch, 'https://api.signaturit.com/v2/brandings/an_id.json', :headers => { :Authorization => 'Bearer a_token' }
-    end
-
-    def test_update_branding_logo
-        stub_request(:any, /.*/).to_return(:body => '{}')
-
-        path = File.join(File.expand_path(File.dirname(__FILE__)), 'file.png')
-
-        @client.update_branding_logo('an_id', path)
-
-        assert_requested :put, 'https://api.signaturit.com/v2/brandings/an_id/logo.json', :headers => { :Authorization => 'Bearer a_token' }
-    end
-
-    def test_update_branding_template
-        stub_request(:any, /.*/).to_return(:body => '{}')
-
-        path = File.join(File.expand_path(File.dirname(__FILE__)), 'file.html')
-
-        @client.update_branding_template('an_id', 'a_template', path)
-
-        assert_requested :put, 'https://api.signaturit.com/v2/brandings/an_id/emails/a_template.json', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :patch, 'https://api.signaturit.com/v3/brandings/an_id.json', :headers => { :Authorization => 'Bearer a_token' }
     end
 
     def test_get_templates
@@ -188,6 +129,7 @@ class TestSignaturitClient < Test::Unit::TestCase
 
         @client.get_templates(5, 10)
 
-        assert_requested :get, 'https://api.signaturit.com/v2/templates.json?limit=5&offset=10', :headers => { :Authorization => 'Bearer a_token' }
+        assert_requested :get, 'https://api.signaturit.com/v3/templates.json?limit=5&offset=10', :headers => { :Authorization => 'Bearer a_token' }
     end
+
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signaturit-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.5
+  version: 1.0.0
   prerelease: 
 platform: ruby
 authors:
@@ -9,7 +9,7 @@ authors:
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2015-02-10 00:00:00.000000000 Z
+date: 2016-01-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: rest_client
@@ -18,7 +18,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: '1.7'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -26,7 +26,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.7.3
+        version: '1.7'
 - !ruby/object:Gem::Dependency
   name: webmock
   requirement: !ruby/object:Gem::Requirement
@@ -34,7 +34,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.18'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
@@ -42,7 +42,7 @@ dependencies:
     requirements:
     - - ~>
       - !ruby/object:Gem::Version
-        version: 1.18.0
+        version: '1.18'
 description: Sign Documents Online
 email: api@signaturit.com
 executables: []
@@ -50,6 +50,7 @@ extensions: []
 extra_rdoc_files: []
 files:
 - .gitignore
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - LICENSE