clicksign-api 1.1.0.alpha2 → 1.1.0.alpha3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 35e2042ab4a9a94f3159c1b56192f92db15a84f301de3c9e9fa8bfe0be7d447a
-  data.tar.gz: a26c118f1a234525a17a2f6f210ef95eef1112b5405956512e2a5d7b8437f19f
+  metadata.gz: d11f64e7417787bde2ab879785fccf87ebfcf30f4b3db77c1ca8ba6798c9117b
+  data.tar.gz: 7f56bec3b6074b20f50e6ac3fa8ff13e2ebcd215d2cba373ca86b1e1d97505e8
 SHA512:
-  metadata.gz: 901d00b80482587ac7a89af935331109cae51e31e7879d51993e64b5a3ff99214692e124f66478079be84ba1d795837e23502075d9a04738c92ac50014c8fd33
-  data.tar.gz: 6d32615a4a4dd3e37e73a1190f29ca572a446da50063a51e198bbad5dc8ec4b23a82e4256de6df5b3634f70c6021f42964c10b012b46d7a1cc3aeff27f7a3b31
+  metadata.gz: 54be14b9d9e0eb0e965d965800d79a8fc0b209945b232c524836d334392430b4ef256c7b24bc396896a0e284ffb2bc74ae5f9963d3e8c3a933ce69f8b7aa9c2b
+  data.tar.gz: b987296d24c8885b3e0559ed9860a0de273d4c70d851802fcbec2b7c665a722336cd2af4a4eb1444afb36d8eacbcb2d787f8b3c927b02473321fe3f27c1c597b

data/CHANGELOG.md

@@ -0,0 +1,25 @@
+# Clicksign::API 1.1.0 (Octuber 29, 2021)
+
+Add support to multiple credentials.
+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. 
+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']
+```
+
+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')
+```

data/Gemfile.lock

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

data/README.md

@@ -26,8 +26,14 @@ Or install it yourself as:
 By default, all requests use Clicksign's SANDBOX.
 
 ```ruby
+credentials = {
+  "key.production" => ENV["CLICKSIGN_ACCESS_TOKEN_PRODUCTION"]
+  "key.sandbox" => ENV["CLICKSIGN_ACCESS_TOKEN_SANDBOX"]
+}
+
 Clicksign::API.configure do |config|
-  config.access_token = ENV['CLICKSIGN_ACCESS_TOKEN']
+  config.credentials = credentials
+  config.production = false
 end
 ```
 
@@ -47,41 +53,102 @@ To see all available parameters, please, check the [API docs](https://developers
 #### Create documents
 
 ```ruby
-response = Clicksign::API::Document.create(path: '/path/to/file.pdf', file: file)
+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 ...>
 
-response.success?
+document.success?
 => true # false
 
-JSON.parse(response.body)
+response_document = JSON.parse(document.body)
 => {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+=> # key: '123abcd' as example!
 ```
 
 #### View documents
 
 ```ruby
-response = Clicksign::API::Document.find('DOCUMENT_KEY')
+find_document = Clicksign::API::Document.find(params: { key: response_document['document']['key'] }, token: 'valid_token')
 => #<Faraday::Response ...>
 
-response.success?
+find_document.success?
 => true # false
 
-JSON.parse(response.body)
+JSON.parse(find_document.body)
 => {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
 ```
 
-#### Add signers
+#### Create Signers
 
 ```ruby
-response = Clicksign::API::Signer.create('DOCUMENT_KEY', signer)
+signer = Clicksign::API::Signer.create(params: { email: 'mail@email.com', auths: ['email'], delivery: 'email' }, token: 'valid_token')
 => #<Faraday::Response ...>
 
-response.success?
+signer.success?
 => true # false
 
-JSON.parse(response.body)
+response_signer = JSON.parse(signer.body)
 => {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+=> # signer_key: '999poo' as example!
 ```
+#### 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.success?
+=> true # false
+
+response_signer_document = JSON.parse(signer_document.body)
+=> {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
+  ```
+
+##### 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.success?
+=> true # false
+
+rseponse_batch = JSON.parse(batch.body)
+=> #{"batch"=> {"key"=>"3dd7fa89-15f7-48b6-81e8-7d14a273bbb8"
+
+```
+#### 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.success?
+=> true # false
+
+JSON.parse(notify.body)
+=> ##<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.success?
+=> true # false
+
+JSON.parse(notify.body)
+=> ##<struct Faraday::Env, method=:post request_body="{\"request_signature_key\":
+
 
 ## Development
 

data/lib/clicksign/api/document.rb

@@ -11,8 +11,8 @@ module Clicksign
           post(REQUEST_PATH, body(params), token)
         end
 
-        def find(token:, key:)
-          get(REQUEST_PATH + key, token)
+        def find(token:, params:)
+          get(REQUEST_PATH + params[:key], token)
         end
 
         def body(params)

data/lib/clicksign/api/version.rb

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

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0.alpha2
+  version: 1.1.0.alpha3
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-10-27 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -163,6 +163,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -197,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Clicksign API ruby interface