clicksign-api 1.1.6.alpha → 1.1.7.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 0a9eb42d76393834f835ad5d9765289d65f0c68b39a490d94d9542e58476b5f4
-  data.tar.gz: d646e41a0b8f8c03635458d82ee1f9b92a0637c85518fa079adb651052cd8ba2
+  metadata.gz: bea5a754ab560b1b59a2897b6b64deefaca14deb47153800a4a0eebeba0883d3
+  data.tar.gz: 479506b71a5048c8610fffafbec6e21f69987bbc7f8dafd9cc266688b1260b4f
 SHA512:
-  metadata.gz: 9a8eb53d21705d3ee6aeb9da94421a4720c159c02291a3a1f93006daf40190ac54ed577b4798d528ad619aed7c057871b0010cb7c62d3bd269591d976cd6191e
-  data.tar.gz: fbddf951fc4445b6ac0eb3c300092baee33cbc8655f76b811579bf96fc1ab1f7f45e035a7de98258fc11b78cf5f1dabaeaa66458cfd49088992d6a8ccb655481
+  metadata.gz: 58fd06ac23e271f99f763ba375836512970e0d6f0986e70f7ff23b0b22383c2a8817632184d998c1ba1ccb7dc29d35c9a167f0aed64f5accb60aca59b0356105
+  data.tar.gz: c3c1967a2a16697b8b8935cc5f7fab4a8856e8895a664b781aa7c61da07b3db42218371c981baefa8d115ff64fea2b4d3ed57e09d0361041460a343b72784bfa

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clicksign-api (1.1.6.alpha)
+    clicksign-api (1.1.7.alpha)
       faraday (= 1.8.0)
 
 GEM

data/README.md

@@ -54,52 +54,32 @@ To see all available parameters, please, check the [API docs](https://developers
 
 ```ruby
 file = File.open('/path/to/file/local/file.pdf', 'r')
-document = Clicksign::API::Document.create( params: { path: '/path/to/file/on/clicksign.pdf', file: file }, token: 'valid_token')
-# => #<Faraday::Response ...>
+document = Clicksign::API::Document.create( params: { path: '/path/to/file/on/clicksign.pdf', file: file }, token: "key.sandbox")
+# => {"document"=> {"key"=>"00000000-0000-0000-0000-000000000000"}
 
-document.success?
-# => true # false
-
-response_document = JSON.parse(document.body)
-# => {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
 ```
 
 #### View documents
 
 ```ruby
-find_document = Clicksign::API::Document.find(params: { key: response_document['document']['key'] }, token: 'valid_token')
-# => #<Faraday::Response ...>
-
-find_document.success?
-# => true # false
+find_document = Clicksign::API::Document.find(params: { key: response_document['document']['key'] }, token: "key.sandbox")
+# => {"document"=> {"key"=>"00000000-0000-0000-0000-000000000000"}
 
-JSON.parse(find_document.body)
-# => {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
 ```
 
 #### Create Signers
 
 ```ruby
-signer = Clicksign::API::Signer.create(params: { email: 'mail@email.com', auths: ['email'], delivery: 'email' }, token: 'valid_token')
-# => #<Faraday::Response ...>
-
-signer.success?
-# => true # false
+signer = Clicksign::API::Signer.create(params: { email: 'mail@email.com', auths: ['email'], delivery: 'email' }, token: "key.sandbox")
+# => {"signer"=> {"key"=>"00000000-0000-0000-0000-000000000000"}
 
-response_signer = JSON.parse(signer.body)
-# => {:signer=> {:key=> '...', :email=> '...', ... }
 ```
 #### Add Signers to Document
 
 ```ruby
-signer_document = Clicksign::API::DocumentsSigners.create(params: { document_key: response_document['document']['key'], signer_key: response_signer['key'], sign_as: 'sign_as' }, token: 'valid_token')
-# => #<Faraday::Response ...>
+signer_document = Clicksign::API::DocumentsSigners.create(params: { document_key: response_document['document']['key'], signer_key: response_signer['key'], sign_as: 'sign_as' }, token: "key.sandbox")
+# => {"list"=>{"key"=>"00000000-0000-0000-0000-000000000000"}
 
-signer_document.success?
-# => true # false
-
-response_signer_document = JSON.parse(signer_document.body)
-# => {:list=> {:key=> '...', ... }
   ```
 
 ##### Creating Documents in Batches
@@ -111,37 +91,25 @@ batch = Clicksign::API::Batch.create(
     signer_key: response_signer['key'],
     summary: true
   },
-  token: 'valid_token'
+  token: "key.sandbox"
 )
-# => #<Faraday::Response ...>
 
-batch.success?
-# => true # false
+# => {"batch"=>{"key"=>"00000000-0000-0000-0000-000000000000"}
 
-rseponse_batch = JSON.parse(batch.body)
-# => #{"batch"=> {"key"=>"..."
 ```
 #### Notifying Signer by e-mail
 
 ```ruby
-notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: 'valid_token')
-# => #<Faraday::Response ...>
-
-notify.success?
-# => true # false
+notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: "key.sandbox")
+# => {:status=>202} 
 
-JSON.parse(notify.body)
-# => ##<struct Faraday::Env, method=:post request_body="{\"request_signature_key\":
 ```
 
 #### Notifying Signer by whatsapp
 
 ```ruby
-notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: 'valid_token')
-# => #<Faraday::Response ...>
-
-notify.success?
-# => true # false
+notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: "key.sandbox")
+# => {:status=>202} 
 
 ## Development
 

data/lib/clicksign/api/documents_signers.rb

@@ -17,9 +17,11 @@ module Clicksign
           )
         end
 
-        def batch_create(token:, batch:)
-          batch.map do |params|
-            create(token: token, params: params)
+        def batch_create(token:, params:)
+          params = params.transform_keys(&:to_sym)
+
+          params[:batch].map do |single_params|
+            create(token: token, params: single_params)
           end
         end
 

data/lib/clicksign/api/requests.rb

@@ -2,20 +2,36 @@ module Clicksign
   module API
     module Requests
       def post(request_path, body, token)
-        conn.post do |req|
+        response = conn.post do |req|
           req.url request_path, { access_token: Clicksign::API.credentials[token] }
           req.headers['Content-Type'] = 'application/json'
           req.body = body.to_json
         end
+        
+        parse(response)
       end
 
       def get(request_path, token)
-        conn.get do |req|
+        response = conn.get do |req|
           req.url request_path, { access_token: Clicksign::API.credentials[token] }
           req.headers['Content-Type'] = 'application/json'
         end
+        
+        parse(response)
       end
 
+      def patch(request_path, body, token)
+        response = conn.patch do |req|
+          req.url request_path, { access_token: Clicksign::API.credentials[token] }
+          req.headers['Content-Type'] = 'application/json'
+          req.body = body.to_json
+        end
+
+        parse(response)
+      end
+      
+      private
+
       def patch(request_path, body, token)
         conn.patch do |req|
           req.url request_path, { access_token: Clicksign::API.credentials[token] }
@@ -27,6 +43,14 @@ module Clicksign
       def conn
         @conn ||= Faraday.new(url: Clicksign::API.url)
       end
+      
+      def parse(response)
+        if !response.body.empty?
+          JSON.parse(response.body, symbolize_keys: true).merge(status: response.status)
+        else
+          { status: response.status }
+        end
+      end
     end
   end
 end

data/lib/clicksign/api/version.rb

@@ -1,5 +1,5 @@
 module Clicksign
   module API
-    VERSION = "1.1.6.alpha"
+    VERSION = "1.1.7.alpha"
   end
 end

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.6.alpha
+  version: 1.1.7.alpha
 platform: ruby
 authors:
 - Francisco Martins