class Universign::Document
Attributes
file_content[R]
file_url[R]
name[R]
params[RW]
Public Class Methods
from_data(data)
click to toggle source
Create a new document from a Hash
@param [Hash] data @return [Universign::Document]
# File lib/universign/document.rb, line 27 def self.from_data(data) @params = data document = Universign::Document.new document.params.merge!(@params) document end
new(options = {})
click to toggle source
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
# File lib/universign/document.rb, line 15 def initialize(options = {}) @params = HashWithIndifferentAccess.new options.each do |key, value| send("#{key}=", value) end end
Public Instance Methods
content()
click to toggle source
The raw content of the PDF document
@return [Array<Byte>]
# File lib/universign/document.rb, line 38 def content @content ||= params['content'] end
content=(data)
click to toggle source
# File lib/universign/document.rb, line 42 def content=(data) @content = data params[:content] = XMLRPC::Base64.new(data) end
document_type()
click to toggle source
The type of this document
@return [String]
# File lib/universign/document.rb, line 62 def document_type @document_type ||= params['documentType'] end
meta_data()
click to toggle source
The meta data of the PDF document
@return [Hash]
# File lib/universign/document.rb, line 94 def meta_data @meta_data ||= params['metaData'] end
meta_data=(data)
click to toggle source
# File lib/universign/document.rb, line 98 def meta_data=(data) if !data.is_a?(Hash) raise MetaDataMustBeAHash end @meta_data = data params['metaData'] = data end
name=(data)
click to toggle source
# File lib/universign/document.rb, line 73 def name=(data) @name = data params['name'] = data end
signature_fields=(data)
click to toggle source
# File lib/universign/document.rb, line 78 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
url()
click to toggle source
The URL to download the PDF document
@return [String]
# File lib/universign/document.rb, line 50 def url @url ||= params['url'] end
url=(data)
click to toggle source
# File lib/universign/document.rb, line 54 def url=(data) @url = data params['url'] = data end