signaturit-sdk 0.0.1 → 0.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA1:
-  metadata.gz: 037bd35cedc20fe874d582632a5bcfb831a5caa7
-  data.tar.gz: 971dff460cd1887b677381850f32c31372ec044f
+  metadata.gz: 66f1d1637ac7b7d18378bfbacb4769d08511d269
+  data.tar.gz: 9d7f84f0d4f7b1691028a62cad5469df34fff2d1
 SHA512:
-  metadata.gz: 072a70412f160c241773ef55bc908e8220b27c2ee8018b9d0e9fef27abc4004e79d30a8dced9f5b908cc9b0f6aa865678f7dfe1691fae82e23cf2089c7eccda2
-  data.tar.gz: 0744ca43f5bf0786dda15bc0e112441186f2eec47981cb11c784eebced4080498deb3eefb6abcb693bcbe3fc05fad17bfb820c58d3a932418dc084e79a1098dd
+  metadata.gz: ba7a5e2a4df1ce24fc2e6442fb786e7ab05f101c26e6a20d72d6b5ca01dfa9b6493771ff10ba6e0df13a63390c8d82b46c4aff4d867c1bb289e75500c5a27f2e
+  data.tar.gz: 899a307d90e475f78493fef6c1843e9028eca0b6ebe7d2f464355b587ded4eabd5cd7e9d98bf2bddf6acfb65d64b62e43033dd611f666a05e3826f980bd02ea5

data/README.md

@@ -1,5 +1,6 @@
 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/).
 
 You can install the package through gem.
@@ -12,16 +13,19 @@ Configuration
 -------------
 
 Just import the Signaturit Client this way
+
 ```
 require 'signaturit_client'
 ```
 
 Then you can authenticate yourself using your AuthToken
+
 ```
 client = SignaturitClient.new('TOKEN')
 ```
 
 Remember, the default calls are made to our Sandbox server. If you want to do in production, just set the flag when you do the call.
+
 ```
 client = SignaturitClient.new('TOKEN', true)
 ```
@@ -32,59 +36,75 @@ Examples
 ## Signature request
 
 ### Get all signature requests
+
 Retrieve all data from your signature requests using different filters.
 
 ##### All signatures
+
 ```
 response = client.get_signatures()
 ```
 
 ##### Getting the last 50 signatures
+
 ```
 response = client.get_signatures(50)
 ```
 
 ##### Getting the following last 50 signatures
+
 ```
 response = client.get_signatures(50, 50)
 ```
 
 ##### Getting only the finished signatures 
+
 ```
 response = client.get_signatures(100, 0, 3)
 ```
 
 ##### Getting the finished signatures created since July 20th of 2014
+
 ```
 response = client.get_signatures(100, 0, 3, '2014-7-20')
 ```
 
 ### Count signature requests
+
 Count your signature requests.
+
 ```
 response = client.count_signatures()
 ```
 
 ### Get signature request
+
 Get a single signature request.
+
 ```
 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
+
 Get a single document from a signature request.
+
 ```
 response = client.get_signature_document('SIGNATURE_ID','DOCUMENT_ID')
 ```
 
 ### Signature request
+
 Create a new signature request. Check all [params](http://docs.signaturit.com/api/#sign_create_sign).
+
 ```
 recipients =  ['bobsoap@signatur.it']
 params = {:subject: 'Receipt number 250', :body: 'Please, can you sign this document?'}
@@ -93,13 +113,17 @@ response = client.create_signature_request(file_path, recipients, params)
 ```
 
 ### Get audit trail
+
 Get the audit trail of a signature request document and save it in the submitted path.
+
 ```
 response = client.get_audit_trail('ID', 'DOCUMENT_ID', '/path/doc.pdf')
 ```
 
 ### Get signed document
+
 Get the signed document of a signature request document and save it in the submitted path.
+
 ```
 response = client.get_signed_document('ID', 'DOCUMENT_ID', '/path/doc.pdf')
 ```
@@ -107,13 +131,17 @@ response = client.get_signed_document('ID', 'DOCUMENT_ID', '/path/doc.pdf')
 ## Account
 
 ### Get account
+
 Retrieve the information of your account.
+
 ```
 response = client.get_account()
 ```
 
 ### Set document storage
+
 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).
+
 ```
 credentials = {
     :user: 'john',
@@ -126,22 +154,36 @@ credentials = {
 response = client.set_document_storage('sftp', credentials)
 ```
 
+### Revert to default document storage
+
+If you ever want to store your files in Signaturit's servers just run this method:
+
+```
+client.revert_to_default_document_storage()
+```
+
 ## Branding
 
 ### Get brandings
+
 Get all account brandings.
+
 ```
 response = client.get_brandings()
 ```
 
 ### Get branding
+
 Get a single branding.
+
 ```
 response = client.get_branding('BRANDING_ID')
 ```
 
 ### Create branding
+
 Create a new branding. You can check all branding params [here](http://docs.signaturit.com/api/#set_branding).`
+
 ```
 params = {
     :corporate_layout_color: '#FFBF00',
@@ -152,21 +194,27 @@ response = client.create_branding(params)
 ```
 
 ### Update branding
+
 Update a single branding.
+
 ```
 params = { :application_texts: { :send_button: 'Send!' } }
 response = client.update_branding('BRANDING_ID', params)
 ```
 
 ### Update branding logo
+
 Change the branding logo.
+
 ```
 file_path = '/path/new_logo.png'
 response = client.update_branding_logo('BRANDING_ID', file_path)
 ```
 
 ### Update branding template
+
 Change a template. Learn more about the templates [here](http://docs.signaturit.com/api/#put_template_branding).
+
 ```
 file_path = '/path/new_template.html'
 response = client.update_branding_template('BRANDING_ID', 'sign_request', file_path)
@@ -174,8 +222,10 @@ response = client.update_branding_template('BRANDING_ID', 'sign_request', file_p
 
 ## Template
 
-###Get all templates
+### Get all templates
+
 Retrieve all data from your templates.
+
 ```
 response = client.get_templates()
 ```

data/lib/signaturit_client.rb

@@ -42,7 +42,12 @@ class SignaturitClient
     def set_document_storage(type, params)
         params[:type] = type
 
-        request :patch, '/v2/account.json', params
+        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'
     end
 
     # Get a concrete signature object
@@ -267,11 +272,11 @@ class SignaturitClient
         base = @production ? 'https://api.signaturit.com' : 'http://api.sandbox.signaturit.com'
 
         case method
-            when :get
+            when :get, :delete
                 encoded = URI.encode_www_form(params)
                 path = "#{path}?#{encoded}" if encoded.length > 0
 
-                body = RestClient.get("#{base}#{path}", :Authorization => "Bearer #{@token}")
+                body = RestClient.send(method, "#{base}#{path}", :Authorization => "Bearer #{@token}")
 
             else
                 body = RestClient.send(method, "#{base}#{path}", params, :Authorization => "Bearer #{@token}")

data/signaturit-sdk.gemspec

@@ -1,7 +1,7 @@
 Gem::Specification.new do |s|
     s.platform    = Gem::Platform::RUBY
     s.name        = 'signaturit-sdk'
-    s.version     = '0.0.1'
+    s.version     = '0.0.2'
     s.date        = '2014-09-04'
     s.summary     = 'Signaturit Ruby SDK'
     s.description = 'Sign Documents Online'

data/test/test_signaturit_client.rb

@@ -25,7 +25,15 @@ class TestSignaturitClient < Test::Unit::TestCase
 
         @client.set_document_storage('sftp', {})
 
-        assert_requested :patch, 'https://api.signaturit.com/v2/account.json', :headers => { :Authorization => 'Bearer a_token' }
+        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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: signaturit-sdk
 version: !ruby/object:Gem::Version
-  version: 0.0.1
+  version: 0.0.2
 platform: ruby
 authors:
 - Signaturit