ruby_universign 0.2.0

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA1:
+  metadata.gz: d1fa1af558c66f055f6fe0199c1733e6397f963c
+  data.tar.gz: c5b5525f439229fa8b4633bb804971324ba07481
+SHA512:
+  metadata.gz: 5f81314ec97a5383cbc63eee709122508ec6c6af177c08f4359419f50499df4389f6b405576982aba02c6f9b5ee1553e28a8c756e5e401e039764ba39116afb3
+  data.tar.gz: 9cd5a8bf9c16232d8593304fed7e6ba098baf057646f02837bee5a78c61bbddfbd3fe175e0baae66f3158e9b2ea4f18e447832119a6da257960d34345554714d

data/.env.example

@@ -0,0 +1,3 @@
+UNIVERSIGN_ENDPOINT=https://sign.test.cryptolog.com/sign/rpc/
+UNIVERSIGN_LOGIN=foo@bar.com
+UNIVERSIGN_PASSWORD=e_________Yp

data/.gitignore

@@ -0,0 +1,11 @@
+/.bundle/
+/.yardoc
+/Gemfile.lock
+/_yardoc/
+/coverage/
+/doc/
+/pkg/
+/spec/reports/
+/tmp/
+.env
+.idea

data/.rspec

@@ -0,0 +1,2 @@
+--format documentation
+--color

data/.travis.yml

@@ -0,0 +1,4 @@
+language: ruby
+rvm:
+  - 2.2.2
+before_install: gem install bundler -v 1.10.3

data/CHANGELOG.md

@@ -0,0 +1,9 @@
+v???
+-------------------------
+
+- rename gem to `ruby_universign` and `ESign` module to `Universign`
+
+v0.1.6 (26/11/2015)
+-------------------------
+
+- Add `final_doc_sent` and `final_doc_requester_sent` parameters to `ESign::Service::Transaction`

data/CODE_OF_CONDUCT.md

@@ -0,0 +1,13 @@
+# Contributor Code of Conduct
+
+As contributors and maintainers of this project, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
+
+We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, or religion.
+
+Examples of unacceptable behavior by participants include the use of sexual language or imagery, derogatory comments or personal attacks, trolling, public or private harassment, insults, or other unprofessional conduct.
+
+Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. Project maintainers who do not follow the Code of Conduct may be removed from the project team.
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
+
+This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.0.0, available at [http://contributor-covenant.org/version/1/0/0/](http://contributor-covenant.org/version/1/0/0/)

data/Gemfile

@@ -0,0 +1,4 @@
+source 'https://rubygems.org'
+
+# Specify your gem's dependencies in universign.gemspec
+gemspec

data/LICENSE.txt

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2018 CapSens
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

data/README.md

@@ -0,0 +1,149 @@
+# RubyUniversign
+
+RubyUniversign is a Ruby gem for interacting with [Universign](https://www.universign.com/) 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 currently integrate electronic signature service, but not other Universign services (timestamping and server stamp).
+
+## Installation
+
+Add this line to your application's Gemfile:
+
+```ruby
+gem 'ruby_universign', require: 'universign'
+```
+
+And then run `bundle`
+
+Or, #TODO
+
+## Usage
+
+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']
+end
+```
+
+Then, you can create a transaction like this:
+
+```ruby
+document_from_url = Universign::Document.new(
+  name: 'my_contract.pdf',
+  url:  'http://www.orimi.com/pdf-test.pdf'
+)
+document_from_content = Universign::Document.new(
+  name:    'another.pdf',
+  content: File.open('spec/fixtures/universign-guide-8.8.pdf').read
+)
+
+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)
+)
+
+transaction = Universign::Transaction.create(
+  documents: [document_from_url, document_from_content],
+  signers:   [signer],
+  options:   { profile: 'default', final_doc_sent: true }
+)
+
+transaction.url
+# => "https://sign.test.universign.eu/fr/signature/?id=f052e35e-a792-4440-bb67-6b5c3f17aa30"
+
+transaction.transaction_id
+# => "9696179e-a43d-4803-beeb-9e5c02fd159b"
+
+# get back universign transaction:
+transaction = Universign::Transaction.new('9696179e-a43d-4803-beeb-9e5c02fd159b')
+transaction.signed?
+
+```
+
+### `Universign::Document`
+
+It can be created with either your file's content or your file's url.
+
+### `Universign::SignatureField`
+
+Nothing much to say here. It follows Universign's signature field.
+
+### `Universign::TransactionSigner`
+
+* `success_url` is where your user will be redirected after signing the documents.
+* `phone_number` is optional. If you don't specify it, Universign will ask the user for it at the time of the signature.
+* `email` is optional, unless you want to use transaction's `final_doc_sent` option (to send signed documents to user's email).
+
+### `Universign::Transaction`
+
+To start a transaction with Universign, you only require documents and signers.
+
+Options are, as the name imply, optional ! Available options are (snake_case of Universign's names):
+
+```
+custom_id
+description
+handwritten_signature_mode
+certificate_type
+language
+identification_type
+handwritten_signature
+profile
+final_doc_sent
+final_doc_requester_sent
+```
+
+Default options are:
+```ruby
+{
+  handwrittenSignatureMode: 1,
+  identificationType:       'sms',
+  language:                 'fr',
+  certificateType:          'simple'
+}
+```
+
+For more informations on theses options, see Universign's official documentation
+
+Once your transaction is created:
+* `url` is where you must redirect your users for them to sign
+* `transaction_id` is the id you must save to retrieve it later. You can request up-to-date informations from Universign with `Universign::Transaction.new(transaction_id)`.
+* `signed?` returns a boolean that tells you if the transaction is signed, or not !
+
+## 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]().
+
+## Development
+
+After checking out the repo, run `bin/setup` to install dependencies. Then, run `rake rspec` to run the tests. You can also run `bin/console` for an interactive prompt that will allow you to experiment.
+
+To install this gem onto your local machine, run `bundle exec rake install`.
+
+(# TODO) To release a new version, update the version number in `version.rb`, and then run `bundle exec rake release`, which will create a git tag for the version, push git commits and tags, and push the `.gem` file to [rubygems.org](https://rubygems.org).
+
+## Contributing
+
+Bug reports and pull requests are welcome on GitHub at https://github.com/CapSens/universign. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the [Contributor Covenant](contributor-covenant.org) code of conduct.
+
+## License
+
+The gem is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
+
+
+
+## notes
+
+final_doc_sent: pour que le document soit envoyé par mail au signataire

data/Rakefile

@@ -0,0 +1,4 @@
+require "bundler/gem_tasks"
+require 'rspec/core/rake_task'
+
+RSpec::Core::RakeTask.new(:spec)

data/bin/console

@@ -0,0 +1,23 @@
+#!/usr/bin/env ruby
+
+require "bundler/setup"
+require "universign"
+
+# You can add fixtures and/or initialization code here to make experimenting
+# with your gem easier. You can also use a different console, if you like.
+
+# (If you use this, don't forget to add pry to your Gemfile!)
+# require "pry"
+# Pry.start
+require 'dotenv'
+
+Dotenv.load
+
+Universign.configure do |config|
+  config.endpoint = ENV['UNIVERSIGN_ENDPOINT']
+  config.login    = ENV['UNIVERSIGN_LOGIN']
+  config.password = ENV['UNIVERSIGN_PASSWORD']
+end
+
+require "irb"
+IRB.start

data/bin/setup

@@ -0,0 +1,7 @@
+#!/bin/bash
+set -euo pipefail
+IFS=$'\n\t'
+
+bundle install
+
+# Do any other automated setup that you need to do here

data/lib/universign.rb

@@ -0,0 +1,20 @@
+require 'active_support/core_ext/hash/indifferent_access'
+
+require "universign/version"
+require 'xmlrpc/client'
+require 'universign/service/document'
+require 'universign/service/transaction'
+require 'universign/safeguard'
+require 'universign/signer'
+require 'universign/transaction'
+require 'universign/signature_field'
+require 'universign/signer_infos'
+require 'universign/transaction_signer'
+require 'universign/client'
+require 'universign/document'
+require 'universign/configuration'
+require 'universign/error'
+
+module Universign
+  include Error
+end

data/lib/universign/client.rb

@@ -0,0 +1,32 @@
+require 'singleton'
+
+module Universign
+  class Client
+    include ::Singleton
+    attr_reader :client
+
+    def initialize
+      @client          = XMLRPC::Client.new2(Universign.configuration.endpoint)
+      @client.user     = Universign.configuration.login
+      @client.password = Universign.configuration.password
+    end
+
+    def method_missing(method, *args, &block)
+      if @client.respond_to?(method)
+        @client.send(method, *args, &block)
+      else
+        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

@@ -0,0 +1,33 @@
+module Universign
+  class Configuration
+    attr_accessor :login, :password, :endpoint
+
+    def initialize
+      @login    = ''
+      @password = ''
+      @endpoint = ''
+    end
+  end
+
+  # @return [Universign::Configuration] Universign's current configuration
+  def self.configuration
+    @configuration ||= Configuration.new
+  end
+
+  # Set Universign's configuration
+  # @param config [Universign::Configuration]
+  def self.configuration=(config)
+    @configuration = config
+  end
+
+  # Modify Universign's current configuration
+  # @yieldparam [Universign::Configuration] config current Universign config
+  # ```
+  # Universign.configure do |config|
+  #   config.login = "your-mail@provider.com"
+  # end
+  # ```
+  def self.configure
+    yield configuration
+  end
+end

data/lib/universign/document.rb

@@ -0,0 +1,116 @@
+module Universign
+  class Document
+    include Universign::Safeguard
+
+    attr_reader :name, :file_content, :file_url
+    attr_accessor :params
+
+    # Create a new Universign::Document
+    #
+    # @param [Hash] options
+    # @option options [Array<Byte>] :content Content of the PDF
+    # @option options [String] :url URL of the PDF
+    # @option options [String] :name Name of the PDF
+    # @option options [Hash] :meta_data Hash to join to the PDF
+    def initialize(options = {})
+      @params = HashWithIndifferentAccess.new
+
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    # Create a new document from a Hash
+    #
+    # @param [Hash] data
+    # @return [Universign::Document]
+    def self.from_data(data)
+      @params = data
+
+      document = Universign::Document.new
+      document.params.merge!(@params)
+      document
+    end
+
+    # The raw content of the PDF document
+    #
+    # @return [Array<Byte>]
+    def content
+      @content ||= params['content']
+    end
+
+    def content=(data)
+      @content         = data
+      params[:content] =  XMLRPC::Base64.new(data)
+    end
+
+    # The URL to download the PDF document
+    #
+    # @return [String]
+    def url
+      @url ||= params['url']
+    end
+
+    def url=(data)
+      @url          = data
+      params['url'] = data
+    end
+
+    # The type of this document
+    #
+    # @return [String]
+    def document_type
+      @document_type ||= params['documentType']
+    end
+
+    # The file name of this document
+    #
+    # @return [String]
+    def name
+      @name ||= params['name']
+    end
+
+    def name=(data)
+      @name          = data
+      params['name'] = data
+    end
+
+    # The meta data of the PDF document
+    #
+    # @return [Hash]
+    def meta_data
+      @meta_data ||= params['metaData']
+    end
+
+    def meta_data=(data)
+      if !data.is_a?(Hash)
+        raise MetaDataMustBeAHash
+      end
+
+      @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

@@ -0,0 +1,14 @@
+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
+  end
+end

data/lib/universign/safeguard.rb

@@ -0,0 +1,59 @@
+module Universign
+  module Safeguard
+    def self.included(klass)
+      klass.extend ClassMethods
+    end
+
+    def safeguard(callback = nil, &block)
+      self.class.safeguard(callback, &block)
+    end
+
+    module ClassMethods
+      def safeguard(callback = nil, &block)
+        block.call
+      rescue XMLRPC::FaultException => ex
+        if ex.faultCode == 73020
+          raise ex
+        end
+
+        known_exception = Universign::ERROR_CODE[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)
+        elsif ex.faultString.include?('Invalid document URL')
+          url = ex.faultString.match(/<(.+)>/)[1] rescue 'unknown URL'
+          raise Universign::Document::DocumentURLInvalid.new(url)
+        elsif ex.faultString.include?('Not enough tokens')
+          raise Universign::NotEnoughTokens
+        elsif ex.faultString.include?('ID is unknown')
+          raise Universign::Document::UnknownDocument
+        else
+          handle_exception(ex, callback)
+        end
+
+      rescue RuntimeError => ex
+        if ex.message.include?('Authorization failed')
+          raise Universign::Client::InvalidCredentials
+        end
+        raise ex
+      end
+
+      private
+
+      def handle_exception(ex, callback)
+        if callback.respond_to?(:call)
+          if callback.lambda? && callback.arity.zero?
+            callback.call
+          else
+            callback.call(ex)
+          end
+        else
+          raise ex
+        end
+      end
+    end
+  end
+end

data/lib/universign/service/document.rb

@@ -0,0 +1,45 @@
+module Universign
+  module Service
+    module Document
+      # Retrieve documents signed
+      #
+      # @return [Array<Universign::Document>]
+      def documents
+        @client = Universign::Client.instance
+
+        @documents ||= safeguard do
+          result = @client.call('requester.getDocuments', @transaction_id)
+          result.map do |document|
+            Universign::Document.from_data(document)
+          end
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        attr_reader :documents
+      end
+
+      # def signed_with_transaction_id(transaction_id)
+      #   @client = Universign::Client.new.client
+      #
+      #   safeguard(-> { return false }) do
+      #     result = @client.call('requester.getTransactionInfo', transaction_id)
+      #     !result['signerInfos'].any? { |s| s['status'] != 'signed' }
+      #   end
+      # end
+      #
+      # def signed_with_custom_id(custom_id)
+      #   @client = Universign::Client.new.client
+      #
+      #   safeguard(-> { return false }) do
+      #     result = @client.call('requester.getTransactionInfoByCustomId', custom_id)
+      #     !result['signerInfos'].any? { |s| s['status'] != 'signed' }
+      #   end
+      # end
+    end
+  end
+end

data/lib/universign/service/transaction.rb

@@ -0,0 +1,86 @@
+module Universign
+  module Service
+    module Transaction
+      AVAILABLE_OPTIONS = {
+        custom_id:                  :customId,
+        description:                :description,
+        handwritten_signature_mode: :handwrittenSignatureMode,
+        certificate_type:           :certificateType,
+        language:                   :language,
+        identification_type:        :identificationType,
+        handwritten_signature:      :handwrittenSignature,
+        profile:                    :profile,
+        final_doc_sent:             :finalDocSent,
+        final_doc_requester_sent:   :finalDocRequesterSent
+      }
+
+      DEFAULT_OPTIONS = {
+        handwrittenSignatureMode: 1,
+        identificationType:       'sms',
+        language:                 'fr',
+        certificateType:          'simple'
+      }
+
+      # Get a transaction from Universign
+      #
+      # @return [Universign::Transaction]
+      def get
+        @client = Universign::Client.instance
+
+        safeguard do
+          result = @client.call('requester.getTransactionInfo', @transaction_id)
+          self.from_data(result)
+        end
+      end
+
+      def self.included(base)
+        base.extend(ClassMethods)
+      end
+
+      module ClassMethods
+        # Signs a document
+        #
+        # @param [Array<Universign::Document>] documents Documents to sign
+        # @param [Array<Universign::SignerTransaction>] signers
+        # @param [Hash] options
+        # @option options: [String] :custom_id Custom ID of the document
+        # @option options: [String] :description Description of the signature
+        # @option options: [String] :handwritten_signature_mode Type of signature
+        # @option options: [String] :certificate_type Type of certificate
+        # @option options: [String] :language Document's language
+        # @option options: [String] :identification_type
+        # @option options: [Boolean] :handwritten_signature
+        # @option options: [String] :profile
+        # @option options: [Boolean] :final_doc_sent
+        # @option options: [Boolean] :final_doc_requester_sent
+        #
+        # @raise [ArgumentError] Raised if unknown_key passed in options
+        #
+        # @return [Universign::Transaction]
+        def create(documents:, signers:, options: {})
+          @client = Universign::Client.instance
+
+          sign_options = DEFAULT_OPTIONS.merge(
+            documents: documents.map(&:params),
+            signers:   signers.map(&:params),
+          )
+
+          options.each do |key, value|
+            known_key = AVAILABLE_OPTIONS[key]
+
+            if known_key
+              sign_options[known_key] = value
+            else
+              raise "Unknown Key"
+            end
+          end
+
+          safeguard do
+            result = @client.call("requester.requestTransaction", sign_options)
+            Universign::Transaction.new(result['id'], result['url'])
+          end
+        end
+      end
+    end
+  end
+end

data/lib/universign/signature_field.rb

@@ -0,0 +1,16 @@
+module Universign
+  class SignatureField
+    attr_reader :params
+
+    def initialize(coordinate:, page:)
+      @coordinate   = coordinate
+      @page         = page
+
+      @params = {
+        page: @page,
+        x:    @coordinate[0],
+        y:    @coordinate[1]
+      }
+    end
+  end
+end

data/lib/universign/signer.rb

@@ -0,0 +1,41 @@
+module Universign
+  class Signer
+    attr_accessor :params
+
+    def initialize(options = {})
+      @params = {}
+
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    def self.from_data(data)
+      @params = data
+    end
+
+    # This signer’s firstname
+    #
+    # @return [String]
+    def first_name
+      @first_name || params['firstName']
+    end
+
+    def first_name=(data)
+      @first_name        = data
+      params[:firstname] = data
+    end
+
+    # This signer’s lastname
+    #
+    # @return [String]
+    def last_name
+      @last_name || params['lastName']
+    end
+
+    def last_name=(data)
+      @last_name        = data
+      params[:lastname] = data
+    end
+  end
+end

data/lib/universign/signer_infos.rb

@@ -0,0 +1,56 @@
+module Universign
+  class SignerInfos < Signer
+    # The status of the signer
+    #
+    # The existing statuses are:
+    #
+    # |        Status        |                                         Description                                         |
+    # |:--------------------:|:-------------------------------------------------------------------------------------------:|
+    # | `waiting`            | The signer has not yet been invited to sign. Others signers must sign prior to this user    |
+    # | `ready`              | The signer has been invited to sign, but has not tried yet                                  |
+    # | `accessed`           | The signer has accessed the signature service                                               |
+    # | `code-sent`          | The signer agreed to sign and has been sent an OTP                                          |
+    # | `signed`             | The signer has successfully signed.                                                         |
+    # | `pending-validation` | The signer has successfully signed and is pending RA validation                             |
+    # | `canceled`           | The signer refused to sign, or one of the previous signers canceled or failed its signature |
+    # | `failed`             | An error occured during the signature. In this case, error is set                           |
+    def status
+      data['status']
+    end
+
+    # The error message in case status == `failed`
+    #
+    # @return [String]
+    def error
+      data['error']
+    end
+
+    # The URL of the signature page
+    #
+    # @return [String]
+    def url
+      data['url']
+    end
+
+    # the action date
+    #
+    # @return [String]
+    def action_date
+      data['actionDate']
+    end
+
+    # List of refused docs indexes
+    #
+    # @return [Array<Integer>]
+    def refused_docs
+      data['refusedDocs']
+    end
+
+    # The signer’s email
+    #
+    # @return [String]
+    def email
+      data['email']
+    end
+  end
+end

data/lib/universign/transaction.rb

@@ -0,0 +1,101 @@
+module Universign
+  class Transaction
+    include Universign::Safeguard
+    include Service::Transaction
+    include Service::Document
+
+    attr_reader :transaction_id, :url, :data
+
+    def initialize(transaction_id = nil, url = nil)
+      @transaction_id = transaction_id
+      @url            = url
+      @data           = {}
+
+      self.get
+    end
+
+    def from_data(data)
+      @data = data
+    end
+
+    # @return [String]
+    #
+    # The status of the transaction. The existing statuses are:
+    #
+    # | Status      | Description                                                                                      |
+    # |-------------|--------------------------------------------------------------------------------------------------|
+    # | `ready`     | Signers can connect and sign                                                                     |
+    # | `expired`   | The transaction has been requested more than 7 days ago. It will no more be available to signers |
+    # | `canceled`  | A signer has canceled the transaction. Signers will no more be able to connect to the service    |
+    # | `failed`    | An error occured during a signature. The signers won’t be able to connect to the service         |
+    # | `completed` | All signers have successfuly sign, the requester can retrieve the documents                      |
+    def status
+      data['status']
+    end
+
+    # @return [Array<String>]
+    def url
+      @url ||= data['signerInfos'].map { |si| si['url'] }
+    end
+
+    # A list of bean containing information about the signers
+    # and their progression in the signature process
+    #
+    # @return [Array<Universign::Signer]
+    def signers
+      raise 'NotImplementedYet'
+    end
+
+    # A bean containing information about the requester of a
+    # transaction
+    # @return
+    def initiator
+      data['initiatorInfo']
+    end
+
+    # The index of current signer if the status of transaction
+    # is ready or who ended the transactions for other status
+    #
+    # @return [Integer]
+    def current_signer
+      data['currentSigner']
+    end
+
+    # The creation date or last relaunch date of this transaction
+    #
+    # @return [Date]
+    def created_at
+      data['creationDate'].to_date
+    end
+
+    # The description of the Transaction
+    #
+    # @return [String]
+    def description
+      data['description']
+    end
+
+    # Whether the transaction was requested with requesting handwritten signature
+    # for each signature field or not.
+    #
+    # @return [Boolean]
+    def each_field
+      data['eachField']
+    end
+
+    # Whether the transaction is signed... or not !
+    #
+    # @return [Boolean]
+    def signed?
+      status == 'completed'
+    end
+
+    ########################
+
+    private
+
+    def client
+      @client ||= Universign::Client.new.client
+    end
+  end
+end

data/lib/universign/transaction_signer.rb

@@ -0,0 +1,107 @@
+module Universign
+  class TransactionSigner < Signer
+    attr_accessor :phone_number, :signature, :callbacks
+
+    def initialize(options = {})
+      super(options)
+
+      options.each do |key, value|
+        send("#{key}=", value)
+      end
+    end
+
+    # This signer’s organization
+    #
+    # @params [String] data
+    def organization=(data)
+      @organization         = data
+      params[:organisation] = data
+    end
+
+    # This signer’s e-mail address
+    #
+    # @params [String] data
+    def email=(data)
+      @email                = data
+      params[:emailAddress] = data
+    end
+
+    # This signer’s mobile phone number that should be
+    # written in the international format
+    #
+    # Mandatory if the authentication by sms is activated
+    #
+    # @params [String] data
+    def phone_number=(data)
+      @phone_number     = data
+      params[:phoneNum] = data
+    end
+
+    # The role of this transaction actor
+    #
+    # |    Role    |                                        Description                                       |
+    # |:----------:|:----------------------------------------------------------------------------------------:|
+    # |  `signer`  | (default) This actor is a signer and he will be able to view the documents and sign them |
+    # | `observer` |         This actor is an observer and he will be able only to view the documents         |
+    #
+    # @params [String] data
+    def role=(data)
+      @role         = data
+      params[:role] = data
+    end
+
+    # A description of a visible PDF signature field. If none
+    # provided, no signature field will be produced on the
+    # signed document
+    #
+    # @params [Universign::SignatureField] data
+    def signature_field=(data)
+      if !data.instance_of?(Universign::SignatureField)
+        raise 'BadSignatureFieldType' # TODO: create custom Exception
+      end
+
+      @signature_field        = data
+      params[:signatureField] = data.params
+    end
+
+    # This signer’s birth date. This is an option for the certified
+    # signature
+    #
+    # @params [Date] data
+    def birtdate=(data)
+      @birthdate         = data
+      params[:birthDate] = data
+    end
+
+    # The url to where the signer will be  redirected, after the signatures are completed.
+    # If it is null it takes the value of {Universign::Transaction#success_url}
+    # If it is also null, it takes the default Universign success URL
+    def success_url=(data)
+      @success_url        = data
+      params[:successURL] = data
+    end
+
+    def cancel_url=(data)
+      @cancel_url        = data
+      params[:cancelURL] = data
+    end
+
+    def fail_url=(data)
+      @fail_url        = data
+      params[:failURL] = data
+    end
+
+    # Which authentication type will be used when a signer will attempt to sign.
+    #
+    # The available values are :
+    # |   Type  |                                                                                    Description                                                                                   |
+    # |:-------:|:--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------:|
+    # |  `none` |                                                           The signer won’t be asked an authentication code when signing                                                          |
+    # | `email` |       The signer will be sent a authentication code by e-mail. Using this option implies that this signer has a valid email property set, otherwise, an exception is thrown      |
+    # |  `sms`  | The signer will be sent a authentication code by sms. Using this option implies that this signer has a valid `phone_number` property set, in other cases, an exception is thrown |
+    def identification_type=(data)
+      @identification_type        = data
+      params[:identificationType] = data
+    end
+  end
+end

data/lib/universign/version.rb

@@ -0,0 +1,3 @@
+module Universign
+  VERSION = "0.2.0"
+end

data/ruby_universign.gemspec

@@ -0,0 +1,36 @@
+# coding: utf-8
+lib = File.expand_path('../lib', __FILE__)
+$LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
+require 'universign/version'
+
+Gem::Specification.new do |spec|
+  spec.name          = "ruby_universign"
+  spec.version       = Universign::VERSION
+  spec.authors       = ["Nicolas Besnard", "Yassine Zenati", "Antoine Becquet"]
+  spec.email         = ["besnard.nicolas@gmail.com", "yassine@capsens.eu", "antoine@capsens.eu"]
+
+  spec.summary       = "Universign's API Wrapper"
+  spec.description   = <<~EOF
+    Ruby gem for interacting with [Universign](https://www.universign.com/) 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.
+  EOF
+  spec.homepage      = "https://github.com/CapSens/universign"
+  spec.license       = "MIT"
+
+  spec.files         = `git ls-files -z`.split("\x0").reject { |f| f.match(%r{^(test|spec|features)/}) }
+  spec.bindir        = "exe"
+  spec.executables   = spec.files.grep(%r{^exe/}) { |f| File.basename(f) }
+  spec.require_paths = ["lib"]
+
+  spec.required_ruby_version = '>= 2.0'
+
+  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 "rspec", "~> 3.0"
+  spec.add_development_dependency "dotenv", "~> 2.0"
+  spec.add_development_dependency "webmock", "~> 3.0"
+  spec.add_development_dependency "vcr", "~> 4.0"
+end

metadata

@@ -0,0 +1,176 @@
+--- !ruby/object:Gem::Specification
+name: ruby_universign
+version: !ruby/object:Gem::Version
+  version: 0.2.0
+platform: ruby
+authors:
+- Nicolas Besnard
+- Yassine Zenati
+- Antoine Becquet
+autorequire: 
+bindir: exe
+cert_chain: []
+date: 2018-09-26 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: activesupport
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4.1'
+- !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'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '10.0'
+- !ruby/object:Gem::Dependency
+  name: rspec
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: dotenv
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.0'
+- !ruby/object:Gem::Dependency
+  name: webmock
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '3.0'
+- !ruby/object:Gem::Dependency
+  name: vcr
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '4.0'
+description: |
+  Ruby gem for interacting with [Universign](https://www.universign.com/) 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.
+email:
+- besnard.nicolas@gmail.com
+- yassine@capsens.eu
+- antoine@capsens.eu
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- ".env.example"
+- ".gitignore"
+- ".rspec"
+- ".travis.yml"
+- CHANGELOG.md
+- CODE_OF_CONDUCT.md
+- Gemfile
+- LICENSE.txt
+- README.md
+- Rakefile
+- bin/console
+- bin/setup
+- lib/universign.rb
+- lib/universign/client.rb
+- lib/universign/configuration.rb
+- lib/universign/document.rb
+- lib/universign/error.rb
+- lib/universign/safeguard.rb
+- lib/universign/service/document.rb
+- lib/universign/service/transaction.rb
+- lib/universign/signature_field.rb
+- lib/universign/signer.rb
+- lib/universign/signer_infos.rb
+- lib/universign/transaction.rb
+- lib/universign/transaction_signer.rb
+- lib/universign/version.rb
+- ruby_universign.gemspec
+homepage: https://github.com/CapSens/universign
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '2.0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubyforge_project: 
+rubygems_version: 2.6.8
+signing_key: 
+specification_version: 4
+summary: Universign's API Wrapper
+test_files: []