ruby_universign 1.0.0 → 1.2.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 11f8da6678fe2eabbade54811eadfcb73fd97d05
-  data.tar.gz: d72c7cc029d9de15de14da7ab6ba466f1913aa0f
+SHA256:
+  metadata.gz: be66f3f3888dfa5be80ae0a7b04bb24abdcd1d968459fe947155195354774323
+  data.tar.gz: e8a8bb26267e7b475f29f36bb2e5d019b18766c29e0a1381f2cfff20c2ee302b
 SHA512:
-  metadata.gz: 60ed3572c4fcee9a15f5918a439e174cfaf6ef1731988f73beab96e9a3779cbdc6623ef1e4defa472981b3d00116cbdfef61f1d81387c322408b53faadeafb6e
-  data.tar.gz: eaa7ba2fed5b941647c054f1dc73440939685f0e27eab1b59804e20cf2372636524203db95b0a3282825025bf94a269c227f24bd3029c2dc3e237929361ca873
+  metadata.gz: dbe62e8c57efec45a9680380e478564750d8cdae030cd59697a7b6cd02ce49410a2fc1465c03729eca7f1d725f1669b6aef19933069b964e94295a69c7e2b6bb
+  data.tar.gz: fb66dd95ce4c4806217ac2f921148823de882045b845631bee2f564470a3d53b768f014aa4becb3a8612f9ee6e3499d3e3faaa4d2526681828702d1d0b5087cc

data/CHANGELOG.md

@@ -1,7 +1,24 @@
-v???
+v1.2.0
 -------------------------
 
-- rename gem to `ruby_universign` and `ESign` module to `Universign`
+- Add `chaining_mode` to `Universign::Transaction` options.
+
+v1.1.1
+-------------------------
+
+- bugfix : do not add `name` parameter to SignatureField when it's nil.
+
+v1.1.0
+-------------------------
+
+- SignatureField can be managed with a named field instead of coordinates.
+
+v1.0.0
+-------------------------
+
+- rename gem to `ruby_universign`
+- rename`ESign` module to `Universign`
+- release gem on rubygems
 
 v0.1.6 (26/11/2015)
 -------------------------

data/README.md

@@ -4,7 +4,7 @@ RubyUniversign is a Ruby gem for interacting with [Universign](https://www.unive
 
 It ease requests to Universign API, documents uploads and following signature state.
 
-This gem is **not** officialy made by Universign, but was originally created for [CapSens](https://capsens.eu/) internal usage.
+This gem is **not** officialy made by Universign, but was originally created by [CapSens](https://capsens.eu/) for internal usage.
 
 This gem currently integrate electronic signature service, but not other Universign services (timestamping and server stamp).
 
@@ -83,6 +83,33 @@ 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 }
+)
+```
+
 ### `Universign::Document`
 
 It can be created with either your file's content or your file's url.
@@ -91,6 +118,10 @@ It can be created with either your file's content or your file's url.
 
 Nothing much to say here. It follows Universign's signature field.
 
+You can pass the coordinates of the signature or the name of the field.
+
+If the PDF already contains a named signature field, you can use this parameter instead of giving the coordinates (which will be ignored). If the name of this field does not exist in the document, the given coordinates will be used instead.
+
 ### `Universign::TransactionSigner`
 
 * `success_url` is where your user will be redirected after signing the documents.
@@ -114,6 +145,7 @@ handwritten_signature
 profile
 final_doc_sent
 final_doc_requester_sent
+chaining_mode
 ```
 
 Default options are:
@@ -135,7 +167,7 @@ Once your transaction is created:
 
 ## Universign documentation
 
-As of September 25th 2018, all official Universign documentation can be found at [https://help.universign.com/hc/fr/sections/360000148149-Guides-Universign]().
+As of September 25th 2018, all official Universign documentation can be found at https://help.universign.com/hc/fr/sections/360000148149-Guides-Universign.
 
 ## Development
 

data/lib/universign/document.rb

@@ -75,6 +75,19 @@ module Universign
       params['name'] = data
     end
 
+    def signature_fields=(data)
+      if !data.is_a?(Array)
+        raise 'SignatureFieldsMustBeAnArray'
+      end
+
+      @signature_fields = data
+      params['signatureFields'] = data.map do |d|
+        raise 'BadSignatureFieldType' unless d.instance_of?(SignatureField)
+
+        d.params
+      end
+    end
+
     # The meta data of the PDF document
     #
     # @return [Hash]

data/lib/universign/service/transaction.rb

@@ -11,7 +11,8 @@ module Universign
         handwritten_signature:      :handwrittenSignature,
         profile:                    :profile,
         final_doc_sent:             :finalDocSent,
-        final_doc_requester_sent:   :finalDocRequesterSent
+        final_doc_requester_sent:   :finalDocRequesterSent,
+        chaining_mode:              :chainingMode
       }
 
       DEFAULT_OPTIONS = {

data/lib/universign/signature_field.rb

@@ -2,15 +2,22 @@ module Universign
   class SignatureField
     attr_reader :params
 
-    def initialize(coordinate:, page:)
-      @coordinate   = coordinate
+    def initialize(coordinate:, name: nil, page:, signer_index:)
+      @coordinate   = coordinate || [0, 0]
+      @name         = name
       @page         = page
+      @signer_index = signer_index
 
       @params = {
-        page: @page,
-        x:    @coordinate[0],
-        y:    @coordinate[1]
+        page:          @page,
+        x:             @coordinate[0],
+        y:             @coordinate[1],
+        'signerIndex': @signer_index
       }
+
+      @params[:name] = @name unless @name.nil?
+
+      @params
     end
   end
 end

data/lib/universign/version.rb

@@ -1,3 +1,3 @@
 module Universign
-  VERSION = "1.0.0"
+  VERSION = "1.2.1"
 end

data/ruby_universign.gemspec

@@ -11,9 +11,9 @@ Gem::Specification.new do |spec|
 
   spec.summary       = "Universign's API Wrapper"
   spec.description   = <<~EOF
-    Ruby gem for interacting with [Universign](https://www.universign.com/) electronic signature API.
+    Ruby gem for interacting with Universign electronic signature API.
     It ease requests to Universign API, documents uploads and following signature state.
-    This gem is **not** officialy made by Universign, but was originally created for [CapSens](https://capsens.eu/) internal usage.
+    This gem is *not* officialy made by Universign, but was originally created by CapSens for internal usage.
   EOF
   spec.homepage      = "https://github.com/CapSens/universign"
   spec.license       = "MIT"
@@ -28,7 +28,7 @@ Gem::Specification.new do |spec|
   spec.add_runtime_dependency 'activesupport', '>= 4.1'
 
   spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "rake", ">= 12.3.3"
   spec.add_development_dependency "rspec", "~> 3.0"
   spec.add_development_dependency "dotenv", "~> 2.0"
   spec.add_development_dependency "webmock", "~> 3.0"

metadata

@@ -1,7 +1,7 @@
 --- !ruby/object:Gem::Specification
 name: ruby_universign
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.2.1
 platform: ruby
 authors:
 - Nicolas Besnard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2018-09-26 00:00:00.000000000 Z
+date: 2020-11-03 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -44,16 +44,16 @@ dependencies:
   name: rake
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
-        version: '10.0'
+        version: 12.3.3
 - !ruby/object:Gem::Dependency
   name: rspec
   requirement: !ruby/object:Gem::Requirement
@@ -111,9 +111,9 @@ dependencies:
       - !ruby/object:Gem::Version
         version: '4.0'
 description: |
-  Ruby gem for interacting with [Universign](https://www.universign.com/) electronic signature API.
+  Ruby gem for interacting with Universign electronic signature API.
   It ease requests to Universign API, documents uploads and following signature state.
-  This gem is **not** officialy made by Universign, but was originally created for [CapSens](https://capsens.eu/) internal usage.
+  This gem is *not* officialy made by Universign, but was originally created by CapSens for internal usage.
 email:
 - besnard.nicolas@gmail.com
 - yassine@capsens.eu
@@ -148,7 +148,6 @@ files:
 - lib/universign/transaction.rb
 - lib/universign/transaction_signer.rb
 - lib/universign/version.rb
-- ruby_universign-0.2.0.gem
 - ruby_universign.gemspec
 homepage: https://github.com/CapSens/universign
 licenses:
@@ -169,8 +168,7 @@ required_rubygems_version: !ruby/object:Gem::Requirement
     - !ruby/object:Gem::Version
       version: '0'
 requirements: []
-rubyforge_project: 
-rubygems_version: 2.6.8
+rubygems_version: 3.0.3
 signing_key: 
 specification_version: 4
 summary: Universign's API Wrapper