eversign-sdk 0.2.1

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 5af06750d603bb41b4eed125818e0579adafb0c5f8ee697b53fc149a85d17d5b
+  data.tar.gz: ee662d44b412958dcf513570699180d8437f84791f80c426ee90ee1693e8526a
+SHA512:
+  metadata.gz: 6b247028ac81c4accfe0a86c988345b693904f1c1dad8d45532570cdefc1fa2f57027b44acbd887ed57836295cce3eb6cb638ad7a79d9937743c8a50f1f9d95c
+  data.tar.gz: 30640dcaf8365d8986a5f95dd7f8afe12f974cff268025533b243ba44c0e603ee87110b426248a69ac0dac6a08530df112bb516b28ab6f1824a11355312a8439

data/lib/eversign.rb

@@ -0,0 +1,33 @@
+require 'eversign/version'
+require 'configurations'
+require 'addressable/uri'
+require_relative 'eversign/client'
+require_relative 'eversign/models/business'
+require_relative 'eversign/models/file'
+require_relative 'eversign/models/field'
+require_relative 'eversign/models/signer'
+require_relative 'eversign/models/recipient'
+require_relative 'eversign/models/document'
+require_relative 'eversign/models/template'
+require_relative 'eversign/models/error'
+require_relative 'eversign/models/exception'
+require_relative 'eversign/mappings/business'
+require_relative 'eversign/mappings/file'
+require_relative 'eversign/mappings/document'
+require_relative 'eversign/mappings/exception'
+
+module Eversign
+	include Configurations
+	configurable String, :access_key
+	configurable Integer, :business_id
+	configurable String, :oauth_base
+	configurable String, :api_base do |value|
+		value ||= 'https://api.eversign.com'
+		parsed = Addressable::URI.parse(value)
+  	if %w(http https).include?(parsed.scheme)
+  		value
+		else
+			raise ArgumentError 'Invalid API Base URL' 
+		end
+	end
+end

data/lib/eversign/client.rb

@@ -0,0 +1,207 @@
+require "addressable/template"
+require "faraday"
+require "json"
+require "logger"
+
+module Eversign
+  class FileNotFoundException < Exception
+  end
+
+  class Client
+    attr_accessor :access_key, :base_uri, :business_id, :token
+
+    def initialize()
+      self.base_uri = Eversign.configuration.api_base || "https://api.eversign.com"
+      access_key = Eversign.configuration.access_key
+      if access_key.start_with?("Bearer ")
+        self.set_oauth_access_token(access_key)
+      else
+        self.access_key = access_key
+      end
+      self.business_id = Eversign.configuration.business_id
+    end
+
+    def set_oauth_access_token(oauthtoken)
+      if oauthtoken.startswith("Bearer ")
+        self.token = oauthtoken
+      else
+        self.token = "Bearer " + oauthtoken
+      end
+      self.get_businesses()
+    end
+
+    def generate_oauth_authorization_url(options)
+      check_arguments(["client_id", "state"], options)
+      template = Addressable::Template.new(Eversign.configuration.oauth_base + "/authorize{?clinet_id,state}")
+      return template.partial_expand(clinet_id: options["client_id"], state: options["state"]).pattern
+    end
+
+    def request_oauth_token(options)
+      check_arguments(["client_id", "client_secret", "code", "state"], options)
+
+      req = execute_request(:post, "/token", options)
+      if req.status == 200
+        response_obj = JSON.parse(req.body)
+
+        if response_obj.key?("success")
+          raise response_obj["message"]
+        else
+          return response_obj["access_token"]
+        end
+      end
+      raise "no success"
+    end
+
+    def get_buisnesses
+      response = execute_request(:get, "/api/business?access_key=#{access_key}")
+      extract_response(response.body, Eversign::Mappings::Business)
+    end
+
+    def get_all_documents
+      get_documents("all")
+    end
+
+    def get_completed_documents
+      get_documents("completed")
+    end
+
+    def get_draft_documents
+      get_documents("draft")
+    end
+
+    def get_cancelled_documents
+      get_documents("cancelled")
+    end
+
+    def get_action_required_documents
+      get_documents("my_action_required")
+    end
+
+    def get_waiting_for_others_documents
+      get_documents("waiting_for_others")
+    end
+
+    def get_templates
+      get_documents("templates")
+    end
+
+    def get_archived_templates
+      get_documents("templates_archived")
+    end
+
+    def get_draft_templates
+      get_documents("template_draft")
+    end
+
+    def get_document(document_hash)
+      path = "/api/document?access_key=#{access_key}&business_id=#{business_id}&document_hash=#{document_hash}"
+      response = execute_request(:get, path)
+      extract_response(response.body, Eversign::Mappings::Document)
+    end
+
+    def create_document(document, isFromTemplate = false)
+      if document.files
+        for file in document.files
+          if file.file_url
+            file_response = self.upload_file(file.file_url)
+            file.file_url = nil
+            file.file_id = file_response.file_id
+          end
+        end
+      end
+      path = "/api/document?access_key=#{access_key}&business_id=#{business_id}"
+      data = Eversign::Mappings::Document.representation_for(document, isFromTemplate)
+      response = execute_request(:post, path, data)
+      extract_response(response.body, Eversign::Mappings::Document)
+    end
+
+    def create_document_from_template(template)
+      create_document(template, true)
+    end
+
+    def delete_document(document_hash)
+      path = "/api/document?access_key=#{access_key}&business_id=#{business_id}&document_hash=#{document_hash}"
+      delete(path, document_hash)
+    end
+
+    def cancel_document(document_hash)
+      path = "/api/document?access_key=#{access_key}&business_id=#{business_id}&document_hash=#{document_hash}&cancel=1"
+      delete(path, document_hash)
+    end
+
+    def download_raw_document_to_path(document_hash, path)
+      sub_uri = "/api/download_raw_document?access_key=#{access_key}&business_id=#{business_id}&document_hash=#{document_hash}"
+      download(sub_uri, path)
+    end
+
+    def download_final_document_to_path(document_hash, path, audit_trail = 1)
+      sub_uri = "/api/download_raw_document?access_key=#{access_key}&business_id=#{business_id}&document_hash=#{document_hash}&audit_trail=#{audit_trail}"
+      download(sub_uri, path)
+    end
+
+    def upload_file(file_path)
+      payload = { upload: Faraday::UploadIO.new(file_path, "text/plain") }
+      path = "/api/file?access_key=#{access_key}&business_id=#{business_id}"
+      response = execute_request(:post, path, payload, true)
+      extract_response(response.body, Eversign::Mappings::File)
+    end
+
+    def send_reminder_for_document(document_hash, signer_id)
+      path = "/api/send_reminder?access_key=#{access_key}&business_id=#{business_id}"
+      response = execute_request(:post, path, { document_hash: document_hash, signer_id: signer_id }.to_json)
+      eval(response.body)[:success] ? true : extract_response(response.body)
+    end
+
+    private
+
+    def execute_request(method, path, body = nil, multipart = false)
+      @faraday ||= Faraday.new(base_uri) do |conn|
+        conn.headers = {}
+        conn.headers["User-Agent"] = "Eversign_Ruby_SDK"
+        conn.headers["Authorization"] = token if token
+        conn.request :multipart if multipart
+        conn.adapter :net_http
+      end
+
+      @faraday.send(method) do |request|
+        request.url path
+        request.body = body if body
+      end
+    end
+
+    def check_arguments(arguments = [], options = {})
+      arguments.each do |argument|
+        raise ("Please specify " + argument) unless options.has_key?(argument.to_sym)
+      end
+    end
+
+    def delete(path, document_hash)
+      response = execute_request(:delete, path)
+      eval(response.body)[:success] ? true : extract_response(response.body)
+    end
+
+    def download(sub_uri, path)
+      response = execute_request(:get, sub_uri)
+      File.open(path, "wb") { |fp| fp.write(response.body) }
+    end
+
+    def get_documents(doc_type)
+      path = "/api/document?access_key=#{access_key}&business_id=#{business_id}&type=#{doc_type}"
+      response = execute_request(:get, path)
+      extract_response(response.body, Eversign::Mappings::Document)
+    end
+
+    def extract_response(body, mapping = nil)
+      data = JSON.parse(body)
+      if data.kind_of?(Array)
+        mapping.extract_collection(body, nil)
+      else
+        if data.key?("success")
+          Eversign::Mappings::Exception.extract_single(body, nil)
+        else
+          mapping.extract_single(body, nil)
+        end
+      end
+    end
+  end
+end

data/lib/eversign/mappings/business.rb

@@ -0,0 +1,16 @@
+require 'kartograph'
+require_relative '../models/business'
+
+module Eversign
+	module Mappings
+		class Business
+			include Kartograph::DSL
+
+			kartograph do
+		    mapping Eversign::Models::Business
+
+		    property :business_id, :business_status, :business_identifier, :business_name, :creation_time_stamp, :is_primary
+		  end
+		end
+	end
+end

data/lib/eversign/mappings/document.rb

@@ -0,0 +1,105 @@
+require "kartograph"
+require_relative "../models/document"
+
+module Eversign
+  module Mappings
+    class File
+      include Kartograph::DSL
+
+      kartograph do
+        mapping Eversign::Models::File
+
+        property :name, :file_id, :file_url, :file_base64
+      end
+    end
+
+    class Signer
+      include Kartograph::DSL
+
+      kartograph do
+        mapping Eversign::Models::Signer
+
+        property :id, :name, :email, :order, :pin, :message, :deliver_email, :role
+      end
+    end
+
+    class Field
+      include Kartograph::DSL
+
+      kartograph do
+        mapping Eversign::Models::Field
+
+        property :name, :type, :x, :y, :width, :height, :page, :signer, :identifier, :required, :readonly, :merge, :type,
+                 :validation_type, :text_style, :text_font, :text_size, :text_color, :value, :options, :group
+      end
+    end
+
+    class Recipient
+      include Kartograph::DSL
+
+      kartograph do
+        mapping Eversign::Models::Recipient
+
+        property :name, :email, :role
+      end
+    end
+
+    class Document
+      include Kartograph::DSL
+
+      kartograph do
+        mapping Eversign::Models::Document
+
+        property :document_hash, :template_id, :sandbox, :is_draft, :title, :message, :use_signer_order, :reminders, :require_all_signers,
+                 :redirect, :redirect_decline, :client, :expires, :embedded_signing_enabled, :requester_email, :is_template,
+                 :is_completed, :is_archived, :is_deleted, :is_trashed, :is_cancelled, :embedded, :in_person, :permission
+        property :files, plural: true, include: File
+        property :signers, plural: true, include: Signer
+        property :recipients, plural: true, include: Recipient
+      end
+
+      def self.extract_collection(content, scope)
+        data = JSON.parse(content)
+        result = []
+        data.each do |item|
+          result << extract_single(item.to_json, nil)
+        end
+        result
+      end
+
+      def self.extract_single(content, scope)
+        obj = super(content, scope)
+        data = JSON.parse(content)
+        if data["fields"]
+          data["fields"].each do |field_list|
+            field_data = []
+            field_list.each do |field|
+              extracted_field = Field.extract_single(field.to_json, nil)
+              field_data << extracted_field if extracted_field
+            end
+            obj.add_field_list(field_data)
+          end
+        end
+        obj
+      end
+
+      def self.representation_for(document, isFromTemplate = false)
+        data = super(nil, document)
+        list = []
+        if document.fields
+          document.fields.each do |field_list|
+            field_data = []
+            field_list.each do |field|
+              field_data << JSON.parse(Field.representation_for(nil, field))
+            end
+            list << field_data
+          end
+        end
+        data = JSON.parse(data)
+        # Fix for issue 7. When we create a document from template (isFromTemplate=true) fields array is 1 dimentional, so we flatten it:
+        data["fields"] = isFromTemplate ? list.flatten : list
+        JSON.dump(data)
+      end
+    end
+  end
+end

data/lib/eversign/mappings/exception.rb

@@ -0,0 +1,27 @@
+require 'kartograph'
+#require_relative '../models/document'
+
+module Eversign
+	module Mappings
+		class Error
+			include Kartograph::DSL
+
+			kartograph do
+		    mapping Eversign::Models::Error
+
+		    property :code, :type, :info
+		  end
+		end
+
+		class Exception
+			include Kartograph::DSL
+
+			kartograph do
+		    mapping Eversign::Models::Exception
+
+		    property :success
+		    property :error, include: Error
+		  end
+		end
+	end
+end

data/lib/eversign/mappings/file.rb

@@ -0,0 +1,16 @@
+require 'kartograph'
+require_relative '../models/file'
+
+module Eversign
+	module Mappings
+		class File
+			include Kartograph::DSL
+
+			kartograph do
+		    mapping Eversign::Models::File
+
+		    property :name, :file_id, :file_url, :file_base64, :pages, :total_pages
+		  end
+		end
+	end
+end

data/lib/eversign/models/business.rb

@@ -0,0 +1,7 @@
+module Eversign
+	module Models
+		class Business
+	    attr_accessor :business_id, :business_status, :business_identifier, :business_name, :creation_time_stamp, :is_primary
+		end
+	end
+end

data/lib/eversign/models/document.rb

@@ -0,0 +1,34 @@
+module Eversign
+	module Models
+		class Document
+	    attr_accessor :document_hash, :template_id, :sandbox, :is_draft, :title, :message, :use_signer_order, :reminders, :require_all_signers,
+		    				  :redirect, :redirect_decline, :client, :expires, :embedded_signing_enabled, :requester_email, :is_template,
+		    				  :is_completed, :is_archived, :is_deleted, :is_trashed, :is_cancelled, :embedded, :in_person, :permission,
+		    				  :files, :signers, :recipients, :meta, :fields
+
+		  def add_file(file)
+		  	self.files ||= []
+		  	self.files << file
+		  end
+
+		  def add_field(field)
+		  	add_field_list([field])
+		  end
+
+		  def add_field_list(field_list)
+		  	self.fields ||= []
+		  	self.fields << field_list
+		  end
+
+		  def add_recipient(recipient)
+		  	self.recipients ||= []
+		  	self.recipients << recipient
+		  end
+
+		  def add_signer(signer)
+		  	self.signers ||= []
+		  	self.signers << signer
+		  end
+		end
+	end
+end

data/lib/eversign/models/error.rb

@@ -0,0 +1,7 @@
+module Eversign
+	module Models
+		class Error
+	    attr_accessor :code, :type, :info
+		end
+	end
+end

data/lib/eversign/models/exception.rb

@@ -0,0 +1,7 @@
+module Eversign
+	module Models
+		class Exception
+	    attr_accessor :success, :error
+		end
+	end
+end

data/lib/eversign/models/field.rb

@@ -0,0 +1,8 @@
+module Eversign
+	module Models
+		class Field
+      attr_accessor :name, :type, :x, :y, :width, :height, :page, :signer, :identifier, :required, :readonly, :merge, :type,
+		    					:validation_type, :text_style, :text_font, :text_size, :text_color, :value, :options, :group
+		end
+	end
+end

data/lib/eversign/models/file.rb

@@ -0,0 +1,30 @@
+require 'active_model'
+module Eversign
+	module Models
+		class File
+      include ActiveModel::Validations
+
+	    attr_accessor :name, :file_id, :file_url, :file_base64, :pages, :total_pages
+
+      validate :only_one_option
+
+	    def initialize(name=nil)
+	    	self.name = name
+	    end
+
+      def only_one_option()
+        error = false
+        if file_id && !file_id.empty?
+          error = file_url || file_base64
+        elsif file_url && !file_url.empty?
+          error = file_id || file_base64
+        elsif file_base64 && !file_base64.empty?
+          error = file_id || file_url
+        else
+          error = true
+        end
+        errors.add('Please provide only one file option') if error
+      end
+		end
+	end
+end

data/lib/eversign/models/recipient.rb

@@ -0,0 +1,13 @@
+module Eversign
+	module Models
+		class Recipient
+	    attr_accessor :name, :email, :role
+
+	    def initialize(name=nil, email=nil, role=nil)
+	    	self.name = name
+	    	self.email = email
+        self.role = role
+	    end
+		end
+	end
+end

data/lib/eversign/models/signer.rb

@@ -0,0 +1,13 @@
+module Eversign
+	module Models
+		class Signer
+	    attr_accessor :id, :name, :email, :order, :pin, :message, :deliver_email, :role  
+
+      def initialize(name=nil, email=nil, role=nil)
+        self.name = name
+        self.email = email
+        self.role = role
+      end
+		end
+	end
+end

data/lib/eversign/models/template.rb

@@ -0,0 +1,6 @@
+module Eversign
+  module Models
+    class Template < Document
+    end
+  end
+end

data/lib/eversign/version.rb

@@ -0,0 +1,3 @@
+module Eversign
+  VERSION = '0.2.1'
+end

metadata

@@ -0,0 +1,199 @@
+--- !ruby/object:Gem::Specification
+name: eversign-sdk
+version: !ruby/object:Gem::Version
+  version: 0.2.1
+platform: ruby
+authors:
+- eversign
+autorequire: 
+bindir: bin
+cert_chain: []
+date: 2021-04-07 00:00:00.000000000 Z
+dependencies:
+- !ruby/object:Gem::Dependency
+  name: rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '4'
+- !ruby/object:Gem::Dependency
+  name: faraday
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0.13'
+- !ruby/object:Gem::Dependency
+  name: addressable
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.5'
+- !ruby/object:Gem::Dependency
+  name: kartograph
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: 0.2.3
+- !ruby/object:Gem::Dependency
+  name: configurations
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+  type: :runtime
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2.2'
+- !ruby/object:Gem::Dependency
+  name: bundler
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - "~>"
+      - !ruby/object:Gem::Version
+        version: '2'
+- !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: simplecov
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+- !ruby/object:Gem::Dependency
+  name: dotenv-rails
+  requirement: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+  type: :development
+  prerelease: false
+  version_requirements: !ruby/object:Gem::Requirement
+    requirements:
+    - - ">="
+      - !ruby/object:Gem::Version
+        version: '0'
+description: Gem for Eversign API SDK.
+email:
+- support@eversign.com
+executables: []
+extensions: []
+extra_rdoc_files: []
+files:
+- lib/eversign.rb
+- lib/eversign/client.rb
+- lib/eversign/mappings/business.rb
+- lib/eversign/mappings/document.rb
+- lib/eversign/mappings/exception.rb
+- lib/eversign/mappings/file.rb
+- lib/eversign/models/business.rb
+- lib/eversign/models/document.rb
+- lib/eversign/models/error.rb
+- lib/eversign/models/exception.rb
+- lib/eversign/models/field.rb
+- lib/eversign/models/file.rb
+- lib/eversign/models/recipient.rb
+- lib/eversign/models/signer.rb
+- lib/eversign/models/template.rb
+- lib/eversign/version.rb
+homepage: https://github.com/workatbest/eversign-ruby-sdk
+licenses:
+- MIT
+metadata: {}
+post_install_message: 
+rdoc_options: []
+require_paths:
+- lib
+required_ruby_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+required_rubygems_version: !ruby/object:Gem::Requirement
+  requirements:
+  - - ">="
+    - !ruby/object:Gem::Version
+      version: '0'
+requirements: []
+rubygems_version: 3.1.2
+signing_key: 
+specification_version: 4
+summary: Gem for Eversign API Client.
+test_files: []