ruby_universign 1.2.0 → 1.5.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a826c0040b24885ccbde5486f9fcc16a582ced8fd0e37b2c363836d69bff16d2
-  data.tar.gz: 2fe254d5364b8b085082cf1bd2b57b3c51a6d19ffbd6947af4d7e8a067abdcbd
+  metadata.gz: b7f7b34b6f2e64791dbf6910f67dc2d39fda890db4e90c0c6e20a3516a50b26e
+  data.tar.gz: 24b47db3af2b7dd0a644649e80fc61880e06ef546909c2479d0c3b93fac7aa66
 SHA512:
-  metadata.gz: 6ef9c2d6c3df55be722c2cc113a04dfa6d5114ffba6d6814ac2c054d982666ea9838807eea9918c46937228768e83b95b025339364a1c2c8637da2e044485826
-  data.tar.gz: 7c7655992acb0e7983b09cd1931ab184b6c9d1a1979b30513005a18f6f6bb731af14f0f9623e8fe38aa98530255ad9900d4c20bd4621c0728da01384d2bac7e9
+  metadata.gz: b868fd44745e5fc5671f17977249d538a406de57c04219448eec046f7f053c5325bfdaa78ca70e0c8f4fd67fb1bcda738590725f01ba692e207ac4b0c80794d4
+  data.tar.gz: 6a7fbc730e6687ad99fb528f638cc3b43121f5728229b634065545fedff9bc111ed487f06f71d10fbc448173e46eb77856d8363376d4e3a6d40a99af2b89e7a4

data/.gitignore

@@ -8,4 +8,6 @@
 /spec/reports/
 /tmp/
 .env
-.idea
+.idea
+*.swp
+*.swo

data/CHANGELOG.md

@@ -1,3 +1,30 @@
+v1.5.1
+-------------------------
+- Fix bugs on multi-threads requests.
+
+v1.5.0
+-------------------------
+- Add `xmlrpc` as dependency, and raise required ruby version to 2.3.
+
+v1.4.0
+-------------------------
+- Refactor and rename errors. They now all inherit from `Universign::Error`.
+
+v1.3.1
+-------------------------
+
+- Fixing regressions added
+
+v1.3.0 - NOT WORKING
+-------------------------
+
+- Adding the possibility to configure proxy and timeout options for the XMLRPC Client
+
+v1.2.1
+-------------------------
+
+- Bumping rake development dependancy due to security issues
+
 v1.2.0
 -------------------------
 

data/README.md

@@ -38,9 +38,11 @@ Configuration:
 ```ruby
 # if you're using Rails, put this in an initializer
 Universign.configure do |config|
-  config.endpoint = ENV['UNIVERSIGN_ENDPOINT']
-  config.login    = ENV['UNIVERSIGN_LOGIN']
-  config.password = ENV['UNIVERSIGN_PASSWORD']
+  config.endpoint = 'your_universign_endpoint' # Required ...
+  config.login    = 'your_login' # Required ...
+  config.password = 'your_password' # Required ...
+  config.proxy    = 'your_proxy_uri:your_proxy_port' # Optionnal ...
+  config.timeout  = 30 # Optionnal if you wanna change the default XMLRPC Timeout ...
 end
 ```
 
@@ -57,12 +59,12 @@ document_from_content = Universign::Document.new(
 )
 
 signer = Universign::TransactionSigner.new(
-  first_name:   "Signer's first name",
-  last_name:    "Signer's last name",
-  email:        'test@gmail.com',
-  phone_number: '0101010101',
-  success_url:  'https://google.com/',
-  signature:    Universign::SignatureField.new(coordinate: [20, 20], page: 1)
+  first_name:      "Signer's first name",
+  last_name:       "Signer's last name",
+  email:           'test@gmail.com',
+  phone_number:    '0101010101',
+  success_url:     'https://google.com/',
+  signature_field: Universign::SignatureField.new(coordinate: [20, 20], page: 1)
 )
 
 transaction = Universign::Transaction.create(
@@ -83,6 +85,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.

data/lib/universign.rb

@@ -10,11 +10,10 @@ require 'universign/transaction'
 require 'universign/signature_field'
 require 'universign/signer_infos'
 require 'universign/transaction_signer'
+require 'universign/error'
 require 'universign/client'
 require 'universign/document'
 require 'universign/configuration'
-require 'universign/error'
 
 module Universign
-  include Error
 end

data/lib/universign/client.rb

@@ -2,11 +2,14 @@ require 'singleton'
 
 module Universign
   class Client
-    include ::Singleton
     attr_reader :client
 
     def initialize
-      @client          = XMLRPC::Client.new2(Universign.configuration.endpoint)
+      @client          = XMLRPC::Client.new2(
+        Universign.configuration.endpoint,
+        Universign.configuration.proxy,
+        Universign.configuration.timeout
+      )
       @client.user     = Universign.configuration.login
       @client.password = Universign.configuration.password
     end
@@ -18,15 +21,5 @@ module Universign
         super(method, *args, &block)
       end
     end
-
-    #                          _   _
-    #   _____  _____ ___ _ __ | |_(_) ___  _ __  ___
-    #  / _ \ \/ / __/ _ \ '_ \| __| |/ _ \| '_ \/ __|
-    # |  __/>  < (_|  __/ |_) | |_| | (_) | | | \__ \
-    #  \___/_/\_\___\___| .__/ \__|_|\___/|_| |_|___/
-    #                   |_|
-    class InvalidCredentials < StandardError; end
-    class ErrorWhenSigningPDF < StandardError; end
-    class UnknownException < StandardError; end
   end
 end

data/lib/universign/configuration.rb

@@ -1,11 +1,13 @@
 module Universign
   class Configuration
-    attr_accessor :login, :password, :endpoint
+    attr_accessor :login, :password, :endpoint, :proxy, :timeout
 
     def initialize
-      @login    = ''
-      @password = ''
-      @endpoint = ''
+      @login    = nil
+      @password = nil
+      @endpoint = nil
+      @proxy    = nil
+      @timeout  = nil
     end
   end
 

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]
@@ -90,27 +103,5 @@ module Universign
       @meta_data         = data
       params['metaData'] = data
     end
-
-    #                          _   _
-    #   _____  _____ ___ _ __ | |_(_) ___  _ __  ___
-    #  / _ \ \/ / __/ _ \ '_ \| __| |/ _ \| '_ \/ __|
-    # |  __/>  < (_|  __/ |_) | |_| | (_) | | | \__ \
-    #  \___/_/\_\___\___| .__/ \__|_|\___/|_| |_|___/
-    #                   |_|
-    class UnknownDocument < StandardError; end
-    class NotSigned < StandardError; end
-    class MissingDocument < StandardError; end
-    class MetaDataMustBeAHash < StandardError; end
-    class DocumentURLInvalid < StandardError
-      attr_accessor :url
-
-      def initialize(url)
-        @url = url
-      end
-
-      def to_s
-        "Can't find document at '#{@url}''"
-      end
-    end
   end
 end

data/lib/universign/error.rb

@@ -1,14 +1,34 @@
 module Universign
-  module Error
-    autoload :Client, 'client'
-    ERROR_CODE = {
-      73002 => Universign::Client::ErrorWhenSigningPDF, # An error occured when signing the PDF document
-      73010 => Universign::Client::InvalidCredentials, # The login and/or password are invalid.
-      73025 => Universign::Document::UnknownDocument, # The used transaction id or custom id is invalid
-      73027 => Universign::Document::NotSigned
-    }
-
-    class UniversignError < StandardError; end
-    class NotEnoughTokens < UniversignError; end
+  class Error < ::StandardError
+    def self.match_class(code)
+      {
+        73002 => Universign::ErrorWhenSigningPDF, # An error occured when signing the PDF document
+        73010 => Universign::InvalidCredentials, # The login and/or password are invalid.
+        73025 => Universign::UnknownDocument, # The used transaction id or custom id is invalid
+        73027 => Universign::DocumentNotSigned
+      }.fetch(code, nil)
+    end
+  end
+
+  class NotEnoughTokens < Error; end
+
+  class ErrorWhenSigningPDF < Error; end
+  class InvalidCredentials < Error; end
+  class UnknownException < Error; end
+
+  class UnknownDocument < Error; end
+  class DocumentNotSigned < Error; end
+  class MissingDocument < Error; end
+  class MetaDataMustBeAHash < Error; end
+  class DocumentURLInvalid < Error
+    attr_accessor :url
+
+    def initialize(url)
+      @url = url
+    end
+
+    def to_s
+      "Can't find document at '#{@url}'"
+    end
   end
 end

data/lib/universign/safeguard.rb

@@ -16,27 +16,27 @@ module Universign
           raise ex
         end
 
-        known_exception = Universign::ERROR_CODE[ex.faultCode]
+        known_exception = Universign::Error.match_class(ex.faultCode)
 
         if known_exception
           raise known_exception
         elsif ex.faultString.include?('Error on document download for this URL')
           url = ex.faultString.match(/<(.+)>/)[1] rescue 'unknown URL'
-          raise Universign::Document::DocumentURLInvalid.new(url)
+          raise Universign::DocumentURLInvalid.new(url)
         elsif ex.faultString.include?('Invalid document URL')
           url = ex.faultString.match(/<(.+)>/)[1] rescue 'unknown URL'
-          raise Universign::Document::DocumentURLInvalid.new(url)
+          raise Universign::DocumentURLInvalid.new(url)
         elsif ex.faultString.include?('Not enough tokens')
           raise Universign::NotEnoughTokens
         elsif ex.faultString.include?('ID is unknown')
-          raise Universign::Document::UnknownDocument
+          raise Universign::UnknownDocument
         else
           handle_exception(ex, callback)
         end
 
       rescue RuntimeError => ex
         if ex.message.include?('Authorization failed')
-          raise Universign::Client::InvalidCredentials
+          raise Universign::InvalidCredentials
         end
         raise ex
       end

data/lib/universign/service/document.rb

@@ -5,7 +5,7 @@ module Universign
       #
       # @return [Array<Universign::Document>]
       def documents
-        @client = Universign::Client.instance
+        @client = Universign::Client.new
 
         @documents ||= safeguard do
           result = @client.call('requester.getDocuments', @transaction_id)

data/lib/universign/service/transaction.rb

@@ -26,7 +26,7 @@ module Universign
       #
       # @return [Universign::Transaction]
       def get
-        @client = Universign::Client.instance
+        @client = Universign::Client.new
 
         safeguard do
           result = @client.call('requester.getTransactionInfo', @transaction_id)
@@ -59,7 +59,7 @@ module Universign
         #
         # @return [Universign::Transaction]
         def create(documents:, signers:, options: {})
-          @client = Universign::Client.instance
+          @client = Universign::Client.new
 
           sign_options = DEFAULT_OPTIONS.merge(
             documents: documents.map(&:params),

data/lib/universign/signature_field.rb

@@ -2,15 +2,17 @@ module Universign
   class SignatureField
     attr_reader :params
 
-    def initialize(coordinate:, name: nil, page:)
+    def initialize(coordinate:, name: nil, page:, signer_index: 0)
       @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?

data/lib/universign/transaction.rb

@@ -95,7 +95,7 @@ module Universign
     private
 
     def client
-      @client ||= Universign::Client.new.client
+      Universign::Client.new.client
     end
   end
 end

data/lib/universign/version.rb

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

data/ruby_universign.gemspec

@@ -23,12 +23,13 @@ Gem::Specification.new do |spec|
   spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
   spec.require_paths = ["lib"]
 
-  spec.required_ruby_version = '>= 2.0'
+  spec.required_ruby_version = '>= 2.3'
 
   spec.add_runtime_dependency 'activesupport', '>= 4.1'
+  spec.add_runtime_dependency "xmlrpc"
 
-  spec.add_development_dependency "bundler", "~> 1.10"
-  spec.add_development_dependency "rake", "~> 10.0"
+  spec.add_development_dependency "bundler", ">= 1.10"
+  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.2.0
+  version: 1.5.1
 platform: ruby
 authors:
 - Nicolas Besnard
@@ -10,7 +10,7 @@ authors:
 autorequire: 
 bindir: exe
 cert_chain: []
-date: 2020-07-01 00:00:00.000000000 Z
+date: 2021-03-09 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: activesupport
@@ -26,34 +26,48 @@ dependencies:
     - - ">="
       - !ruby/object:Gem::Version
         version: '4.1'
+- !ruby/object:Gem::Dependency
+  name: xmlrpc
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
 - !ruby/object:Gem::Dependency
   name: bundler
   requirement: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
   type: :development
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
-    - - "~>"
+    - - ">="
       - !ruby/object:Gem::Version
         version: '1.10'
 - !ruby/object:Gem::Dependency
   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
@@ -161,7 +175,7 @@ required_ruby_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="
     - !ruby/object:Gem::Version
-      version: '2.0'
+      version: '2.3'
 required_rubygems_version: !ruby/object:Gem::Requirement
   requirements:
   - - ">="