clicksign-api 1.1.2.alpha → 1.1.6.alpha

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a5a70bb08f88deb5af74e43399f3f3176262d66a008757d5a9685d2821c9cb7c
-  data.tar.gz: 4ebd3827259a3cf829168f61589f7f73960fb8b87efd3264750f93b84b5e5738
+  metadata.gz: 0a9eb42d76393834f835ad5d9765289d65f0c68b39a490d94d9542e58476b5f4
+  data.tar.gz: d646e41a0b8f8c03635458d82ee1f9b92a0637c85518fa079adb651052cd8ba2
 SHA512:
-  metadata.gz: 6adeb414c6e3f9a9dbcb85e25c75c642e9e4e00e04be7e243332b60ae2ad71316b12a30da6e66a1e3a350feb1cfa4f25f3511cb4704fbb5b057a3352068c2a6f
-  data.tar.gz: 388b2eef8ff721f0f7a961c3136f9481478e3612076a7e800525fbe7afb0e83d855fa1f7d09145871ae715a83e7b3b8f3a6ba7811558b30553d4471f9fe369cc
+  metadata.gz: 9a8eb53d21705d3ee6aeb9da94421a4720c159c02291a3a1f93006daf40190ac54ed577b4798d528ad619aed7c057871b0010cb7c62d3bd269591d976cd6191e
+  data.tar.gz: fbddf951fc4445b6ac0eb3c300092baee33cbc8655f76b811579bf96fc1ab1f7f45e035a7de98258fc11b78cf5f1dabaeaa66458cfd49088992d6a8ccb655481

data/Gemfile.lock

@@ -1,8 +1,8 @@
 PATH
   remote: .
   specs:
-    clicksign-api (1.1.2.alpha)
-      faraday
+    clicksign-api (1.1.6.alpha)
+      faraday (= 1.8.0)
 
 GEM
   remote: https://rubygems.org/
@@ -87,4 +87,4 @@ DEPENDENCIES
   webmock (~> 3.0)
 
 BUNDLED WITH
-   2.2.29
+   2.2.33

data/README.md

@@ -54,32 +54,52 @@ 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: "key.sandbox")
-# => {"document"=> {"key"=>"00000000-0000-0000-0000-000000000000"}
+document = Clicksign::API::Document.create( params: { path: '/path/to/file/on/clicksign.pdf', file: file }, token: 'valid_token')
+# => #<Faraday::Response ...>
 
+document.success?
+# => true # false
+
+response_document = JSON.parse(document.body)
+# => {:document=> {:key=> '...', :path=> '...', :status => '...', ... }
 ```
 
 #### View documents
 
 ```ruby
-find_document = Clicksign::API::Document.find(params: { key: response_document['document']['key'] }, token: "key.sandbox")
-# => {"document"=> {"key"=>"00000000-0000-0000-0000-000000000000"}
+find_document = Clicksign::API::Document.find(params: { key: response_document['document']['key'] }, token: 'valid_token')
+# => #<Faraday::Response ...>
+
+find_document.success?
+# => true # false
 
+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: "key.sandbox")
-# => {"signer"=> {"key"=>"00000000-0000-0000-0000-000000000000"}
+signer = Clicksign::API::Signer.create(params: { email: 'mail@email.com', auths: ['email'], delivery: 'email' }, token: 'valid_token')
+# => #<Faraday::Response ...>
+
+signer.success?
+# => true # false
 
+response_signer = JSON.parse(signer.body)
+# => {: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: "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)
+# => {:list=> {:key=> '...', ... }
   ```
 
 ##### Creating Documents in Batches
@@ -91,25 +111,37 @@ batch = Clicksign::API::Batch.create(
     signer_key: response_signer['key'],
     summary: true
   },
-  token: "key.sandbox"
+  token: 'valid_token'
 )
+# => #<Faraday::Response ...>
 
-# => {"batch"=>{"key"=>"00000000-0000-0000-0000-000000000000"}
+batch.success?
+# => true # false
 
+rseponse_batch = JSON.parse(batch.body)
+# => #{"batch"=> {"key"=>"..."
 ```
 #### Notifying Signer by e-mail
 
 ```ruby
-notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: "key.sandbox")
-# => {:status=>202} 
+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
-notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: "key.sandbox")
-# => {:status=>202} 
+notify = Clicksign::API::Notifier.notify(params: { request_signature_key: 'request_signature_key' }, token: 'valid_token')
+# => #<Faraday::Response ...>
+
+notify.success?
+# => true # false
 
 ## Development
 

data/clicksign-api.gemspec

@@ -24,7 +24,7 @@ Gem::Specification.new do |spec|
   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'
+  spec.add_dependency 'faraday', '1.8.0'
 
   spec.add_development_dependency 'simplecov', '~> 0.16'
   spec.add_development_dependency 'vcr', '~> 4.0'

data/lib/clicksign/api/document.rb

@@ -16,6 +16,11 @@ module Clicksign
           get(REQUEST_PATH + params[:key], token)
         end
 
+        def cancel(token:, params: {})
+          params = params.transform_keys(&:to_sym)
+          patch("#{REQUEST_PATH}#{params[:key]}/cancel", body(params), token)
+        end
+
         def body(params)
           params = params.transform_keys(&:to_sym)
 

data/lib/clicksign/api/documents_signers.rb

@@ -17,13 +17,15 @@ module Clicksign
           )
         end
 
-        def batch_create(token:, params:)
-          params[:batch].map do |single_params|
-            create(token: token, params: single_params)
+        def batch_create(token:, batch:)
+          batch.map do |params|
+            create(token: token, params: params)
           end
         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/requests.rb

@@ -2,37 +2,31 @@ module Clicksign
   module API
     module Requests
       def post(request_path, body, token)
-        response = conn.post do |req|
+        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)
-        response = conn.get do |req|
+        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 patch(request_path, body, token)
+        conn.patch do |req|
+          req.url request_path, { access_token: Clicksign::API.credentials[token] }
+          req.headers['Content-Type'] = 'application/json'
+          req.body = body.to_json
+        end
+      end
 
       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.2.alpha"
+    VERSION = "1.1.6.alpha"
   end
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: clicksign-api
 version: !ruby/object:Gem::Version
-  version: 1.1.2.alpha
+  version: 1.1.6.alpha
 platform: ruby
 authors:
 - Francisco Martins
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2021-11-16 00:00:00.000000000 Z
+date: 2022-02-01 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: bundler
@@ -56,16 +56,16 @@ dependencies:
   name: faraday
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - ">="
+    - - '='
       - !ruby/object:Gem::Version
-        version: '0'
+        version: 1.8.0
 - !ruby/object:Gem::Dependency
   name: simplecov
   requirement: !ruby/object:Gem::Requirement
@@ -198,7 +198,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: 1.3.1
 requirements: []
-rubygems_version: 3.2.3
+rubygems_version: 3.0.8
 signing_key: 
 specification_version: 4
 summary: Clicksign API ruby interface