clicksign-api 1.1.4.alpha → 1.1.8.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3df69ceb1c08c6411ce3ed4cab0912a63038c01d49f55a45ae05f046a88a0f2f
-  data.tar.gz: 49bc96cf8c1f9bd1312c7144e2da82b56fe938aa8acbe93a450af6219f53e6ca
+  metadata.gz: 9c6e4b5ae39f037d3ea4ce8ce455ebc92ca492832e54de93e24286fbb108ab8e
+  data.tar.gz: 79fc0a42e8a53fb4081a5a6861a1ffdcd63b67b03793683659627f57de982913
 SHA512:
-  metadata.gz: 2e0bdd9f9e064ccaf6958367857aca6794dd13882a98334838d5f960508479977b0fc2991f7f0d0b68d96757d97cc66bc0c82353e4d147bbf8e712346de5ead3
-  data.tar.gz: 17ae913e31d97eb98f5c30e3adff8ba3e1f32d5dd20e9c84beee3f974a41f055400682dfbbdae7076ebf2b5e071fa2aee79b66ed66c22202d4f2501355b02e8b
+  metadata.gz: 26a9030878a01ea4c5867a3b07345b939a9a48bfcb6a8f0a46f7ce66d0a965ad09e5eb67a8bd6235dd02e44dfb757b502986ca348a50fb81d8f4b7963d453b95
+  data.tar.gz: 471e4123343623857176947d282862fd16f22f071889015603eaba9ceba6c7d311868179a127fefc08c72a9ac0f8d8fe2e99b05c46f48aa21eeb8e3c28cd263b

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    clicksign-api (1.1.4.alpha)
-      faraday
+    clicksign-api (1.1.8.alpha)
+      faraday (= 1.8.0)
 
 GEM
   remote: https://rubygems.org/

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/clicksign-api.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'bundler', '~> 2.2'
   spec.add_development_dependency 'rake', '~> 13.0'
   spec.add_development_dependency 'rspec', '~> 3.0'
-  spec.add_dependency 'faraday'
+  spec.add_dependency 'faraday', '1.8.0'
 
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 4.0'

data/lib/clicksign/api/document.rb

@@ -17,6 +17,7 @@ module Clicksign
         end
 
         def cancel(token:, params: {})
+          params = params.transform_keys(&:to_sym)
           patch("#{REQUEST_PATH}#{params[:key]}/cancel", body(params), token)
         end
 

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,31 +2,47 @@ 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)
-        conn.patch do |req|
+        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 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.4.alpha"
+    VERSION = "1.1.8.alpha"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.4.alpha
+  version: 1.1.8.alpha
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2022-01-28 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.8
+rubygems_version: 3.0.9
 signing_key: 
 specification_version: 4
 summary: Clicksign API ruby interface