clicksign-api 1.0.1 → 1.1.0.alpha4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e8ff8453d601e58a20996c73def672b647b21b4d92bf815899524f0111d28562
-  data.tar.gz: 3cf5d3c4f27010afa57c0048aaed5073bad418fa1d48f94541272dda2d740085
+  metadata.gz: 53f37c89406853a22420f28ada42cc02f354aaa0faab9f1250929e324befedfc
+  data.tar.gz: d5cebece973a0001692b0a4a32e42ca83e064d973835fcf1263c956b2a7ef40b
 SHA512:
-  metadata.gz: 25f5cfb1dbe872a9b6625c81d668877e847e18dc318838666dafbd06eeb0fbfdf827ff153f013b8fec11caf6f97831eea5efed323004e0c34df7cca36a220394
-  data.tar.gz: 8bb72ea19b6be9a5d99ae135771e93ae4b12b4f95b07637831e9d36a58492ddfbfe180842d6b9dd89ba8a856658033e808f78a24091336a88e229f45b80a732f
+  metadata.gz: 26d092f0d08e34ed93d431779dd23b1e35c7797eb9ad0f8db741454a5685e61367fbad28cad36dff459cc6da5754a7eb55a975f912c62f307720af63b5aef2e0
+  data.tar.gz: a64f4b516b3377ae7bac49a165969179c6150cfca64e3fb013b2aae8315a72d4c5ddb2119342686e07394e9e7d2f330271b04174772e9fe15f86d51f1866abc9

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,60 +1,85 @@
 PATH
   remote: .
   specs:
-    clicksign-api (1.0.1)
+    clicksign-api (1.1.0.alpha4)
       faraday
 
 GEM
   remote: https://rubygems.org/
   specs:
-    addressable (2.5.2)
-      public_suffix (>= 2.0.2, < 4.0)
+    addressable (2.8.0)
+      public_suffix (>= 2.0.2, < 5.0)
     byebug (10.0.2)
-    crack (0.4.3)
-      safe_yaml (~> 1.0.0)
-    diff-lcs (1.3)
-    docile (1.3.1)
-    dotenv (2.5.0)
-    faraday (0.15.4)
+    coderay (1.1.3)
+    crack (0.4.5)
+      rexml
+    diff-lcs (1.4.4)
+    docile (1.4.0)
+    dotenv (2.7.6)
+    faraday (1.8.0)
+      faraday-em_http (~> 1.0)
+      faraday-em_synchrony (~> 1.0)
+      faraday-excon (~> 1.1)
+      faraday-httpclient (~> 1.0.1)
+      faraday-net_http (~> 1.0)
+      faraday-net_http_persistent (~> 1.1)
+      faraday-patron (~> 1.0)
+      faraday-rack (~> 1.0)
       multipart-post (>= 1.2, < 3)
-    hashdiff (0.3.7)
-    json (2.1.0)
-    multipart-post (2.0.0)
-    public_suffix (3.0.3)
-    rake (13.0.1)
-    rspec (3.8.0)
-      rspec-core (~> 3.8.0)
-      rspec-expectations (~> 3.8.0)
-      rspec-mocks (~> 3.8.0)
-    rspec-core (3.8.0)
-      rspec-support (~> 3.8.0)
-    rspec-expectations (3.8.2)
+      ruby2_keywords (>= 0.0.4)
+    faraday-em_http (1.0.0)
+    faraday-em_synchrony (1.0.0)
+    faraday-excon (1.1.0)
+    faraday-httpclient (1.0.1)
+    faraday-net_http (1.0.1)
+    faraday-net_http_persistent (1.2.0)
+    faraday-patron (1.0.0)
+    faraday-rack (1.0.0)
+    hashdiff (1.0.1)
+    method_source (1.0.0)
+    multipart-post (2.1.1)
+    pry (0.14.1)
+      coderay (~> 1.1)
+      method_source (~> 1.0)
+    public_suffix (4.0.6)
+    rake (13.0.6)
+    rexml (3.2.5)
+    rspec (3.10.0)
+      rspec-core (~> 3.10.0)
+      rspec-expectations (~> 3.10.0)
+      rspec-mocks (~> 3.10.0)
+    rspec-core (3.10.1)
+      rspec-support (~> 3.10.0)
+    rspec-expectations (3.10.1)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-mocks (3.8.0)
+      rspec-support (~> 3.10.0)
+    rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
-      rspec-support (~> 3.8.0)
-    rspec-support (3.8.0)
-    safe_yaml (1.0.4)
-    simplecov (0.16.1)
+      rspec-support (~> 3.10.0)
+    rspec-support (3.10.2)
+    ruby2_keywords (0.0.5)
+    simplecov (0.21.2)
       docile (~> 1.1)
-      json (>= 1.8, < 3)
-      simplecov-html (~> 0.10.0)
-    simplecov-html (0.10.2)
+      simplecov-html (~> 0.11)
+      simplecov_json_formatter (~> 0.1)
+    simplecov-html (0.12.3)
+    simplecov_json_formatter (0.1.3)
     vcr (4.0.0)
-    webmock (3.4.2)
-      addressable (>= 2.3.6)
+    webmock (3.14.0)
+      addressable (>= 2.8.0)
       crack (>= 0.3.2)
-      hashdiff
+      hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  ruby
+  x86_64-darwin-20
+  x86_64-linux
 
 DEPENDENCIES
-  bundler (~> 1.16)
+  bundler (~> 2.2)
   byebug (~> 10.0)
   clicksign-api!
   dotenv (~> 2.5)
+  pry
   rake (~> 13.0)
   rspec (~> 3.0)
   simplecov (~> 0.16)
@@ -62,4 +87,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   1.17.3
+   2.2.29

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

@@ -5,7 +5,7 @@ require "clicksign/api/version"
 
 Gem::Specification.new do |spec|
   spec.name          = 'clicksign-api'
-  spec.version       = Clicksign::Api::VERSION
+  spec.version       = Clicksign::API::VERSION
   spec.authors       = ['Francisco Martins']
   spec.email         = ['franciscomxs@gmail.com']
 
@@ -21,7 +21,7 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ['lib']
 
-  spec.add_development_dependency 'bundler', '~> 1.16'
+  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'
@@ -31,4 +31,5 @@ Gem::Specification.new do |spec|
   spec.add_development_dependency 'webmock', '~> 3.0'
   spec.add_development_dependency 'byebug', '~> 10.0'
   spec.add_development_dependency 'dotenv', '~> 2.5'
+  spec.add_development_dependency 'pry'
 end

data/lib/clicksign/api/batch.rb

@@ -7,10 +7,11 @@ module Clicksign
       ATTRIBUTES = [:signer_key, :document_keys, :summary]
 
       class << self
-        def create(params = {})
+        def create(token:, params:  {})
           post(
             REQUEST_PATH,
-            body(params)
+            body(params),
+            token,
           )
         end
 

data/lib/clicksign/api/document.rb

@@ -4,18 +4,20 @@ module Clicksign
       extend Requests
 
       REQUEST_PATH = '/api/v1/documents/'
-      ATTRIBUTES = [:path, :deadline_at, :auto_close, :locale]
+      ATTRIBUTES = [:path, :deadline_at, :auto_close, :locale, :content_base64]
 
       class << self
-        def create(params = {})
-          post(REQUEST_PATH, body(params))
+        def create(token:, params: {})
+          post(REQUEST_PATH, body(params), token)
         end
 
-        def find(key)
-          get(REQUEST_PATH + key)
+        def find(token:, params:)
+          get(REQUEST_PATH + params[:key], token)
         end
 
         def body(params)
+          params = params.transform_keys(&:to_sym)
+
           document = ATTRIBUTES.each.with_object({}) do |attribute, hash|
             hash[attribute] = params[attribute] if params.has_key?(attribute)
           end

data/lib/clicksign/api/documents_signers.rb

@@ -9,16 +9,17 @@ module Clicksign
       ]
 
       class << self
-        def create(params)
+        def create(token:, params: {})
           post(
             REQUEST_PATH,
-            body(params)
+            body(params),
+            token
           )
         end
 
-        def batch_create(batch)
+        def batch_create(token:, batch:)
           batch.map do |params|
-            create(params)
+            create(token: token, params: params)
           end
         end
 

data/lib/clicksign/api/notifier.rb

@@ -7,10 +7,11 @@ module Clicksign
       ATTRIBUTES = [:request_signature_key, :message, :url]
 
       class << self
-        def notify(params = {})
+        def notify(token:, params: {})
           post(
             REQUEST_PATH,
-            body(params)
+            body(params),
+            token
           )
         end
 

data/lib/clicksign/api/requests.rb

@@ -1,17 +1,17 @@
 module Clicksign
   module API
     module Requests
-      def post(request_path, body)
+      def post(request_path, body, token)
         conn.post do |req|
-          req.url request_path, { access_token: Clicksign::API.access_token }
+          req.url request_path, { access_token: Clicksign::API.credentials[token] }
           req.headers['Content-Type'] = 'application/json'
           req.body = body.to_json
         end
       end
 
-      def get(request_path)
+      def get(request_path, token)
         conn.get do |req|
-          req.url request_path, { access_token: Clicksign::API.access_token }
+          req.url request_path, { access_token: Clicksign::API.credentials[token] }
           req.headers['Content-Type'] = 'application/json'
         end
       end

data/lib/clicksign/api/signer.rb

@@ -10,14 +10,17 @@ module Clicksign
       ]
 
       class << self
-        def create(params)
+        def create(token:, params:)
           post(
             REQUEST_PATH,
-            body(params)
+            body(params),
+            token
           )
         end
 
         def body(params)
+          params = params.transform_keys(&:to_sym)
+
           signer = ATTRIBUTES.each.with_object({}) do |key, hash|
             hash[key] = params[key] if params.has_key?(key)
           end

data/lib/clicksign/api/version.rb

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

data/lib/clicksign/api/whatsapp_notifier.rb

@@ -7,10 +7,11 @@ module Clicksign
       ATTRIBUTES = [:request_signature_key]
 
       class << self
-        def notify(params = {})
+        def notify(token:, params: {})
           post(
             REQUEST_PATH,
-            body(params)
+            body(params),
+            token
           )
         end
 

data/lib/clicksign/api.rb

@@ -1,27 +1,30 @@
-require "clicksign/api/version"
+require 'clicksign/api/version'
 
-require "faraday"
-require "base64"
+require 'faraday'
+require 'base64'
+require 'json'
+require 'yaml'
+require 'erb'
 
 begin
-  require "dotenv/load"
-  require "byebug"
+  require 'dotenv/load'
+  require 'byebug'
+  require 'pry'
 rescue LoadError
 end
 
-require "clicksign/api/requests"
-require "clicksign/api/batch"
-require "clicksign/api/document"
-require "clicksign/api/documents_signers"
-require "clicksign/api/signer"
-require "clicksign/api/notifier"
-require "clicksign/api/whatsapp_notifier"
-
+require 'clicksign/api/requests'
+require 'clicksign/api/batch'
+require 'clicksign/api/document'
+require 'clicksign/api/documents_signers'
+require 'clicksign/api/signer'
+require 'clicksign/api/notifier'
+require 'clicksign/api/whatsapp_notifier'
 
 module Clicksign
   module API
     class << self
-      attr_accessor :access_token, :production
+      attr_accessor :credentials, :production
 
       def configure
         yield(self)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0.alpha4
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-04-01 00:00:00.000000000 Z
+date: 2021-11-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '1.16'
+        version: '2.2'
 - !ruby/object:Gem::Dependency
   name: rake
   requirement: !ruby/object:Gem::Requirement
@@ -136,6 +136,20 @@ dependencies:
     - - "~>"
       - !ruby/object:Gem::Version
         version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: pry
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 description: 
 email:
 - franciscomxs@gmail.com
@@ -149,6 +163,7 @@ files:
 - ".ruby-gemset"
 - ".ruby-version"
 - ".travis.yml"
+- CHANGELOG.md
 - Gemfile
 - Gemfile.lock
 - README.md
@@ -179,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.0.3
+rubygems_version: 3.1.6
 signing_key: 
 specification_version: 4
 summary: Clicksign API ruby interface