clicksign-api 1.1.1 → 1.1.2.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c4d73d8a0e57c13f35deb924e70f0cf2b55dec18ab4f1fe1b0ec72c9ecfe9a7d
-  data.tar.gz: 384d5c4a557a563576cf75e45efdf360b8ba343a2ecf44231a1e0a66489c19b3
+  metadata.gz: a5a70bb08f88deb5af74e43399f3f3176262d66a008757d5a9685d2821c9cb7c
+  data.tar.gz: 4ebd3827259a3cf829168f61589f7f73960fb8b87efd3264750f93b84b5e5738
 SHA512:
-  metadata.gz: 217334cbbf14ddffa78d804806bff973ede762d3acb49d3ea6d4bb8ec94fc96bef0af2ba7fddcf8ba5906e49f9a0947883a6b4f00f6ea0d8c0bfbfce97953b76
-  data.tar.gz: 4ef82bd3d37e148f3ad52104f1ccf6c766f700357112a6933262d112dadb2ee5ee34f5aa40d0d150928fe3f815144999aa144d6f675d705b8cd138820489f3b2
+  metadata.gz: 6adeb414c6e3f9a9dbcb85e25c75c642e9e4e00e04be7e243332b60ae2ad71316b12a30da6e66a1e3a350feb1cfa4f25f3511cb4704fbb5b057a3352068c2a6f
+  data.tar.gz: 388b2eef8ff721f0f7a961c3136f9481478e3612076a7e800525fbe7afb0e83d855fa1f7d09145871ae715a83e7b3b8f3a6ba7811558b30553d4471f9fe369cc

data/CHANGELOG.md

@@ -1,15 +1,25 @@
 # Clicksign::API 1.1.0 (Octuber 29, 2021)
 
 Add support to multiple credentials.
-This is useful to work with different accounts and environments, providing flexibility.
+This is useful to work with different environments, providing flexibility.
 For example, applications have different tokens for each environment.
 Other useful case, occurs working with multiple companies.
 
-The credentials should be a hash.
+The credentials should be a hash. 
+It is possible use a `.yml` file to configure the authentication tokens.
+The `.yml` file can get the tokens using environment variables.
+Now all requests receive token parameter, that represents the key associated with the token.
+
+## Examples:
+
+YML file
+```yml
+key.production: 'CLICKSIGN_ACCESS_TOKEN_PRODUCTION'
+key.sandbox:    'CLICKSIGN_ACCESS_TOKEN_SANDBOX'
+```
 
 Request:
 ```ruby
 file = File.open('/path/to/file/local/file.pdf', 'r')
-response = Clicksign::API::Document.create(params: { path: '/path/to/file/on/clicksign.pdf', file: file }, token: 'key.production')
-# =>
-```
+response = Clicksign::API::Document.create( params: { path: '/path/to/file/on/clicksign.pdf', file: file }, token: 'key.production')
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clicksign-api (1.1.1)
+    clicksign-api (1.1.2.alpha)
       faraday
 
 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,15 +17,13 @@ module Clicksign
           )
         end
 
-        def batch_create(token:, batch:)
-          batch.map do |params|
-            create(token: token, params: params)
+        def batch_create(token:, params:)
+          params[:batch].map do |single_params|
+            create(token: token, params: single_params)
           end
         end
 
         def body(params)
-          params = params.transform_keys(&:to_sym)
-
           list = ATTRIBUTES.each.with_object({}) do |key, hash|
             hash[key] = params[key] if params.has_key?(key)
           end

data/lib/clicksign/api/requests.rb

@@ -2,23 +2,37 @@ 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
+      
+      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
+end

data/lib/clicksign/api/version.rb

@@ -1,5 +1,5 @@
 module Clicksign
   module API
-    VERSION = "1.1.1"
+    VERSION = "1.1.2.alpha"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.1
+  version: 1.1.2.alpha
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-05 00:00:00.000000000 Z
+date: 2021-11-16 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -194,11 +194,11 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">="
+  - - ">"
     - !ruby/object:Gem::Version
-      version: '0'
+      version: 1.3.1
 requirements: []
-rubygems_version: 3.1.6
+rubygems_version: 3.2.3
 signing_key: 
 specification_version: 4
 summary: Clicksign API ruby interface