clicksign-api 1.1.0.alpha6 → 1.1.3.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 12d78c1e1512951c7213b73440679297f738376895698654fd8580a8a0290cf7
-  data.tar.gz: d899a9ac359212534f3e75a2d77bbe0f0c6e9e01f534a668ce8161e3b7d52d71
+  metadata.gz: 764750a15069c2e1aa12f2fa2777436cc21cfdf3fa9b7d7469b2a806c9c77de4
+  data.tar.gz: f369ea3517b9174ac50f36dcde37cad63dc7b2309f15ce3aa06085a605cb0cc0
 SHA512:
-  metadata.gz: af14c66c6e4a1a5cb8471c0dcc32072e889381aaa815ad65c89b63e6fb830ab48514338f0465d96cd8f6bed8f804cd0ae997abc5056702a4946a9bc67abac6b8
-  data.tar.gz: e66b3372d2204d83917c65974e6eef811ab4c049cd242b2858dc15a2a8f1a16a2e4571cdbedd31502309be4a654f8e3d2e82add6617c31d929b1f803dc9424c1
+  metadata.gz: 470a75dc6e7380cc0126de7624eb2e6afd650d9b6d0846b16c577049f2d63658677ab8d3c8774808ffa7bdd5372dbd7bca9fb75a9c0586785bd81ffd0e9f8693
+  data.tar.gz: d0c80bccd33b516b9704564516decb8ef38360d4050909cd4ce430d5691bd34b43bc0566b9524147684170077a6ddbc3d0e9954acc8daf56f792cb343edc8258

data/CHANGELOG.md

@@ -13,13 +13,13 @@ Now all requests receive token parameter, that represents the key associated wit
 ## Examples:
 
 YML file
-```ruby
-=> key.production: ENV['CLICKSIGN_ACCESS_TOKEN_PRODUCTION']
-=> key.sandbox:    ENV['CLICKSIGN_ACCESS_TOKEN_SANDBOX']
+```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')
+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.3.alpha)
       faraday
 
 GEM
@@ -56,7 +56,7 @@ GEM
     rspec-mocks (3.10.2)
       diff-lcs (>= 1.2.0, < 2.0)
       rspec-support (~> 3.10.0)
-    rspec-support (3.10.2)
+    rspec-support (3.10.3)
     ruby2_keywords (0.0.5)
     simplecov (0.21.2)
       docile (~> 1.1)
@@ -71,7 +71,6 @@ GEM
       hashdiff (>= 0.4.0, < 2.0.0)
 
 PLATFORMS
-  x86_64-darwin-20
   x86_64-linux
 
 DEPENDENCIES

data/README.md

@@ -54,101 +54,62 @@ 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 => '...', ... }
-=> # key: '123abcd' as example!
 ```
 
 #### 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 = Clicksign::API::Signer.create(params: { email: 'mail@email.com', auths: ['email'], delivery: 'email' }, token: "key.sandbox")
+# => {"signer"=> {"key"=>"00000000-0000-0000-0000-000000000000"}
 
-signer.success?
-=> true # false
-
-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: "key.sandbox")
+# => {"list"=>{"key"=>"00000000-0000-0000-0000-000000000000"}
 
-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: "key.sandbox"
+)
 
-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"
+# => {"batch"=>{"key"=>"00000000-0000-0000-0000-000000000000"}
 
 ```
 #### 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\":
+notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: "key.sandbox")
+# => {:status=>202} 
 
 ```
 
 #### 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\":
-
+notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: "key.sandbox")
+# => {:status=>202} 
 
 ## Development
 

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

@@ -17,9 +17,11 @@ module Clicksign
           )
         end
 
-        def batch_create(token:, batch:)
-          batch.map do |params|
-            create(token: token, params: params)
+        def batch_create(token:, params:)
+          params = params.transform_keys(&:to_sym)
+
+          params[:batch].map do |single_params|
+            create(token: token, params: single_params)
           end
         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.0.alpha6"
+    VERSION = "1.1.3.alpha"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.0.alpha6
+  version: 1.1.3.alpha
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-03 00:00:00.000000000 Z
+date: 2021-12-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       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