clicksign-api 1.1.0.alpha6 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d78c1e1512951c7213b73440679297f738376895698654fd8580a8a0290cf7
-  data.tar.gz: d899a9ac359212534f3e75a2d77bbe0f0c6e9e01f534a668ce8161e3b7d52d71
+  metadata.gz: 061bb74814df58a57be2fe91efc07adf51bced436abcc52c66d0845fa8a0d5c4
+  data.tar.gz: f57a4fd5de30e9ab39ee4d6eb00226fe892c079a22e9536ffa0b7162ade253d9
 SHA512:
-  metadata.gz: af14c66c6e4a1a5cb8471c0dcc32072e889381aaa815ad65c89b63e6fb830ab48514338f0465d96cd8f6bed8f804cd0ae997abc5056702a4946a9bc67abac6b8
-  data.tar.gz: e66b3372d2204d83917c65974e6eef811ab4c049cd242b2858dc15a2a8f1a16a2e4571cdbedd31502309be4a654f8e3d2e82add6617c31d929b1f803dc9424c1
+  metadata.gz: b63752187adf661d6b62f09a6f7988385bb1e364677d1125f21cce5d8ff24e8ede765931a3ef8102e9be6b82ab0fd8556b38a45cadc8893baf4da5769784b856
+  data.tar.gz: 562c3b925acee7c369ff5c3aadc961065c6c38cdbddc7c4add58805b3d72e0df6f720e12ea4ed659a35548ed8c616d7980efdb1c19c4e0565203fa376b06e2c1

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.alpha6)
+    clicksign-api (1.1.0)
       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/version.rb

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

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0.alpha6
+  version: 1.1.0
 platform: ruby
 authors:
 - Francisco Martins
@@ -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: