clicksign-api 1.1.0.alpha4 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 53f37c89406853a22420f28ada42cc02f354aaa0faab9f1250929e324befedfc
-  data.tar.gz: d5cebece973a0001692b0a4a32e42ca83e064d973835fcf1263c956b2a7ef40b
+  metadata.gz: c4d73d8a0e57c13f35deb924e70f0cf2b55dec18ab4f1fe1b0ec72c9ecfe9a7d
+  data.tar.gz: 384d5c4a557a563576cf75e45efdf360b8ba343a2ecf44231a1e0a66489c19b3
 SHA512:
-  metadata.gz: 26d092f0d08e34ed93d431779dd23b1e35c7797eb9ad0f8db741454a5685e61367fbad28cad36dff459cc6da5754a7eb55a975f912c62f307720af63b5aef2e0
-  data.tar.gz: a64f4b516b3377ae7bac49a165969179c6150cfca64e3fb013b2aae8315a72d4c5ddb2119342686e07394e9e7d2f330271b04174772e9fe15f86d51f1866abc9
+  metadata.gz: 217334cbbf14ddffa78d804806bff973ede762d3acb49d3ea6d4bb8ec94fc96bef0af2ba7fddcf8ba5906e49f9a0947883a6b4f00f6ea0d8c0bfbfce97953b76
+  data.tar.gz: 4ef82bd3d37e148f3ad52104f1ccf6c766f700357112a6933262d112dadb2ee5ee34f5aa40d0d150928fe3f815144999aa144d6f675d705b8cd138820489f3b2

data/CHANGELOG.md

@@ -1,25 +1,15 @@
 # Clicksign::API 1.1.0 (Octuber 29, 2021)
 
 Add support to multiple credentials.
-This is useful to work with different environments, providing flexibility.
+This is useful to work with different accounts and 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. 
-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
-```ruby
-=> key.production: ENV['CLICKSIGN_ACCESS_TOKEN_PRODUCTION']
-=> key.sandbox:    ENV['CLICKSIGN_ACCESS_TOKEN_SANDBOX']
-```
+The credentials should be a hash.
 
 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')
-```
+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')
+# =>
+```

data/Gemfile.lock

@@ -1,7 +1,7 @@
 PATH
   remote: .
   specs:
-    clicksign-api (1.1.0.alpha4)
+    clicksign-api (1.1.1)
       faraday
 
 GEM

data/README.md

@@ -55,100 +55,93 @@ 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 ...>
+# => #<Faraday::Response ...>
 
 document.success?
-=> true # false
+# => true # false
 
 response_document = JSON.parse(document.body)
-=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
-=> # key: '123abcd' as example!
+# => {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
 ```
 
 #### View documents
 
 ```ruby
 find_document = Clicksign::API::Document.find(params: { key: response_document['document']['key'] }, token: 'valid_token')
-=> #<Faraday::Response ...>
+# => #<Faraday::Response ...>
 
 find_document.success?
-=> true # false
+# => true # false
 
 JSON.parse(find_document.body)
-=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+# => {: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 ...>
+# => #<Faraday::Response ...>
 
 signer.success?
-=> true # false
+# => true # false
 
 response_signer = JSON.parse(signer.body)
-=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
-=> # signer_key: '999poo' as example!
+# => {: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 ...>
+# => #<Faraday::Response ...>
 
 signer_document.success?
-=> true # false
+# => true # false
 
 response_signer_document = JSON.parse(signer_document.body)
-=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+# => {:list=> {:key=> '...', ... }
   ```
 
 ##### Creating Documents in Batches
 
 ```ruby
-
-batch = Clicksign::API::Batch.create(params: { document_keys: [response_document['document']['key'], 'other_document_key'], signer_key: response_signer['key'], summary: true}, token: 'valid_token')
-=> #<Faraday::Response ...>
+batch = Clicksign::API::Batch.create(
+  params: {
+    document_keys: [response_document['document']['key'], 'other_document_key'],
+    signer_key: response_signer['key'],
+    summary: true
+  },
+  token: 'valid_token'
+)
+# => #<Faraday::Response ...>
 
 batch.success?
-=> true # false
+# => true # false
 
 rseponse_batch = JSON.parse(batch.body)
-=> #{"batch"=> {"key"=>"3dd7fa89-15f7-48b6-81e8-7d14a273bbb8"
-
+# => #{"batch"=> {"key"=>"..."
 ```
 #### Notifying Signer by e-mail
 
 ```ruby
-request_signature_key = JSON.parse(response_document_above.body)['document']['signers'].first['request_signature_key']
-notify = Clicksign::API::Notifier.notify(params: { request_signature_key: request_signature_key }, token: 'valid_token')
-=> #<Faraday::Response ...>
+notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: 'valid_token')
+# => #<Faraday::Response ...>
 
 notify.success?
-=> true # false
+# => true # false
 
 JSON.parse(notify.body)
-=> ##<struct Faraday::Env, method=:post request_body="{\"request_signature_key\":
-
+# => ##<struct Faraday::Env, method=:post request_body="{\"request_signature_key\":
 ```
 
 #### Notifying Signer by whatsapp
 
 ```ruby
-=> # To deliver this content, its necessary add `phone_number` on Signer
-
-request_signature_key = JSON.parse(response_document_above.body)['document']['signers'].first['request_signature_key']
-notify = Clicksign::API::Notifier.notify(params: { request_signature_key: request_signature_key }, token: 'valid_token')
-=> #<Faraday::Response ...>
+notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: 'valid_token')
+# => #<Faraday::Response ...>
 
 notify.success?
-=> true # false
-
-JSON.parse(notify.body)
-=> ##<struct Faraday::Env, method=:post request_body="{\"request_signature_key\":
-
+# => true # false
 
 ## Development
 

data/lib/clicksign/api/batch.rb

@@ -16,6 +16,8 @@ module Clicksign
         end
 
         def body(params)
+          params = params.transform_keys(&:to_sym)
+
           batch = ATTRIBUTES.each.with_object({}) do |attribute, hash|
             hash[attribute] = params[attribute] if params.has_key?(attribute)
           end

data/lib/clicksign/api/document.rb

@@ -12,6 +12,7 @@ module Clicksign
         end
 
         def find(token:, params:)
+          params = params.transform_keys(&:to_sym)
           get(REQUEST_PATH + params[:key], token)
         end
 

data/lib/clicksign/api/documents_signers.rb

@@ -24,6 +24,8 @@ module Clicksign
         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/notifier.rb

@@ -16,6 +16,8 @@ module Clicksign
         end
 
         def body(params)
+          params = params.transform_keys(&:to_sym)
+
           ATTRIBUTES.each.with_object({}) do |attribute, hash|
             hash[attribute] = params[attribute] if params.has_key?(attribute)
           end

data/lib/clicksign/api/version.rb

@@ -1,5 +1,5 @@
 module Clicksign
   module API
-    VERSION = "1.1.0.alpha4"
+    VERSION = "1.1.1"
   end
 end

data/lib/clicksign/api/whatsapp_notifier.rb

@@ -16,6 +16,8 @@ module Clicksign
         end
 
         def body(params)
+          params = params.transform_keys(&:to_sym)
+
           ATTRIBUTES.each.with_object({}) do |attribute, hash|
             hash[attribute] = params[attribute] if params.has_key?(attribute)
           end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0.alpha4
+  version: 1.1.1
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-01 00:00:00.000000000 Z
+date: 2021-11-05 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -194,9 +194,9 @@ required_ruby_version: !ruby/object:Gem::Requirement
       version: '0'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
-  - - ">"
+  - - ">="
     - !ruby/object:Gem::Version
-      version: 1.3.1
+      version: '0'
 requirements: []
 rubygems_version: 3.1.6
 signing_key: