ruby_universign 1.5.1 → 1.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b7f7b34b6f2e64791dbf6910f67dc2d39fda890db4e90c0c6e20a3516a50b26e
-  data.tar.gz: 24b47db3af2b7dd0a644649e80fc61880e06ef546909c2479d0c3b93fac7aa66
+  metadata.gz: 6b9f405760f5eb18d3bad2c05134f42af4d4dc9defe30639b2f1e60e93c7a223
+  data.tar.gz: a109b5e69cbcab3e2314f98976054543269047ee04e984ddb2847e238189c8e3
 SHA512:
-  metadata.gz: b868fd44745e5fc5671f17977249d538a406de57c04219448eec046f7f053c5325bfdaa78ca70e0c8f4fd67fb1bcda738590725f01ba692e207ac4b0c80794d4
-  data.tar.gz: 6a7fbc730e6687ad99fb528f638cc3b43121f5728229b634065545fedff9bc111ed487f06f71d10fbc448173e46eb77856d8363376d4e3a6d40a99af2b89e7a4
+  metadata.gz: 2cdb8b72105f47ad3bf4280687c37b20e8c54f3ee8b04e6a35ec799c6db2872231000ec1f3976927b313c12b795ec5387552b74470ef250ae8b69385bd230d5d
+  data.tar.gz: b9fac92d473ac23ddd78431ee05b29a1f4b9df8c0aa2515c5b57718caf3175b6af8aee2bbff6dee0bceb5de3e242eae8ebb430526162fc1e50575ef935b92574

data/CHANGELOG.md

@@ -1,3 +1,7 @@
+v1.6.0
+-------------------------
+- Added the possibility to add required checkboxes to `Universign::Document`.
+
 v1.5.1
 -------------------------
 - Fix bugs on multi-threads requests.

data/README.md

@@ -85,32 +85,47 @@ transaction = Universign::Transaction.new('9696179e-a43d-4803-beeb-9e5c02fd159b'
 transaction.signed?
 ```
 
-The gem also supports the updated way of creating multiple signature fields per document:
-
-```ruby
-doc_1 = Universign::Document.new(
-  name:    'one.pdf',
-  content: File.open('spec/fixtures/universign-guide-8.8.pdf').read,
-  signature_fields: [
-    Universign::SignatureField.new(coordinate: [20, 20], page: 1, signer_index: 0),
-    Universign::SignatureField.new(coordinate: [80, 20], page: 1, signer_index: 0)
-  ]
-)
-
-doc_2 = Universign::Document.new(
-  name:    'two.pdf',
-  content: File.open('spec/fixtures/universign-guide-8.8.pdf').read,
-  signature_fields: [
-    Universign::SignatureField.new(coordinate: [100, 120], page: 4, signer_index: 0),
-  ]
-)
-
-transaction = Universign::Transaction.create(
-  documents: [doc_1, doc_2],
-  signers:   [signer],
-  options:   { profile: 'default', final_doc_sent: true }
-)
-```
+The gem also supports the updated way of creating multiple fields per document:
+
+- Multiple signatures
+  ```ruby
+  doc_1 = Universign::Document.new(
+    name:    'one.pdf',
+    content: File.open('spec/fixtures/universign-guide-8.8.pdf').read,
+    signature_fields: [
+      Universign::SignatureField.new(coordinate: [20, 20], page: 1, signer_index: 0),
+      Universign::SignatureField.new(coordinate: [80, 20], page: 1, signer_index: 0)
+    ]
+  )
+
+  doc_2 = Universign::Document.new(
+    name:    'two.pdf',
+    content: File.open('spec/fixtures/universign-guide-8.8.pdf').read,
+    signature_fields: [
+      Universign::SignatureField.new(coordinate: [100, 120], page: 4, signer_index: 0),
+    ]
+  )
+
+  transaction = Universign::Transaction.create(
+    documents: [doc_1, doc_2],
+    signers:   [signer],
+    options:   { profile: 'default', final_doc_sent: true }
+  )
+  ```
+
+- Multiple checkboxes
+  ```ruby
+  Universign::Document.new(
+    name:    "one.pdf",
+    content: File.open("spec/fixtures/universign-guide-8.8.pdf").read,
+    check_box_texts: [
+      "My first checkbox text",
+      "My second checkbox text",
+      ""
+    ]
+  )
+  ```
+  Note that the last checkbox must be an empty string as requested in the official documentation.
 
 ### `Universign::Document`
 

data/lib/universign/document.rb

@@ -88,6 +88,19 @@ module Universign
       end
     end
 
+    def check_box_texts
+      @check_box_texts ||= params["checkBoxTexts"]
+    end
+
+    def check_box_texts=(data)
+      if !data.is_a?(Array)
+        raise "CheckBoxTextsMustBeAnArray"
+      end
+
+      @check_box_texts = data
+      params["checkBoxTexts"] = data
+    end
+
     # The meta data of the PDF document
     #
     # @return [Hash]

data/lib/universign/version.rb

@@ -1,3 +1,3 @@
 module Universign
-  VERSION = "1.5.1"
+  VERSION = "1.6.0"
 end

metadata

@@ -1,16 +1,16 @@
 --- !ruby/object:Gem::Specification
 name: ruby_universign
 version: !ruby/object:Gem::Version
-  version: 1.5.1
+  version: 1.6.0
 platform: ruby
 authors:
 - Nicolas Besnard
 - Yassine Zenati
 - Antoine Becquet
-autorequire: 
+autorequire:
 bindir: exe
 cert_chain: []
-date: 2021-03-09 00:00:00.000000000 Z
+date: 2023-05-11 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -167,7 +167,7 @@ homepage: https://github.com/CapSens/universign
 licenses:
 - MIT
 metadata: {}
-post_install_message: 
+post_install_message:
 rdoc_options: []
 require_paths:
 - lib
@@ -182,8 +182,8 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubygems_version: 3.0.3
-signing_key: 
+rubygems_version: 3.3.7
+signing_key:
 specification_version: 4
 summary: Universign's API Wrapper
 test_files: []