groupdocs 0.3.11 → 1.0.0

data/lib/groupdocs/questionnaire/question.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Questionnaire::Question < GroupDocs::Api::Entity
+  class Questionnaire::Question < Api::Entity
 
     require 'groupdocs/questionnaire/question/answer'
 

data/lib/groupdocs/questionnaire/question/answer.rb

@@ -1,5 +1,5 @@
 module GroupDocs
-  class Questionnaire::Question::Answer < GroupDocs::Api::Entity
+  class Questionnaire::Question::Answer < Api::Entity
 
     # @attr [String] text
     attr_accessor :text

data/lib/groupdocs/signature.rb

@@ -0,0 +1,134 @@
+module GroupDocs
+  class Signature < Api::Entity
+
+    require 'groupdocs/signature/shared'
+    require 'groupdocs/signature/contact'
+    require 'groupdocs/signature/envelope'
+    require 'groupdocs/signature/field'
+    require 'groupdocs/signature/form'
+    require 'groupdocs/signature/list'
+    require 'groupdocs/signature/recipient'
+    require 'groupdocs/signature/role'
+    require 'groupdocs/signature/template'
+
+    #
+    # Returns a list of all user signatures.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature>]
+    #
+    def self.get!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/signatures'
+      end.execute!
+
+      json[:signatures].map do |signature|
+        new(signature)
+      end
+    end
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] userGuid
+    attr_accessor :userGuid
+    # @attr [String] recipientId
+    attr_accessor :recipientId
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [String] companyName
+    attr_accessor :companyName
+    # @attr [String] position
+    attr_accessor :position
+    # @attr [String] firstName
+    attr_accessor :firstName
+    # @attr [String] lastName
+    attr_accessor :lastName
+    # @attr [String] fullName
+    attr_accessor :fullName
+    # @attr [String] textInitials
+    attr_accessor :textInitials
+    # @attr [String] signatureImageFileId
+    attr_accessor :signatureImageFileId
+    # @attr [String] initialsImageFileId
+    attr_accessor :initialsImageFileId
+    # @attr [String] signatureImageUrl
+    attr_accessor :signatureImageUrl
+    # @attr [String] initialsImageUrl
+    attr_accessor :initialsImageUrl
+    # @attr [String] createdTimeStamp
+    attr_accessor :createdTimeStamp
+
+    # Human-readable accessors
+    alias_method :user_guid,                :userGuid
+    alias_method :user_guid=,               :userGuid=
+    alias_method :recipient_id,             :recipientId
+    alias_method :recipient_id=,            :recipientId=
+    alias_method :company_name,             :companyName
+    alias_method :company_name=,            :companyName=
+    alias_method :first_name,               :firstName
+    alias_method :first_name=,              :firstName=
+    alias_method :last_name,                :lastName
+    alias_method :last_name=,               :lastName=
+    alias_method :full_name,                :fullName
+    alias_method :full_name=,               :fullName=
+    alias_method :text_initials,            :textInitials
+    alias_method :text_initials=,           :textInitials=
+    alias_method :signature_image_file_id,  :signatureImageFileId
+    alias_method :signature_image_file_id=, :signatureImageFileId=
+    alias_method :initials_image_file_id,   :initialsImageFileId
+    alias_method :initials_image_file_id=,  :initialsImageFileId=
+    alias_method :signature_image_url,      :signatureImageUrl
+    alias_method :signature_image_url=,     :signatureImageUrl=
+    alias_method :initials_image_url,       :initialsImageUrl
+    alias_method :initials_image_url=,      :initialsImageUrl=
+    alias_method :created_time_stamp,       :createdTimeStamp
+    alias_method :created_time_stamp=,      :createdTimeStamp=
+
+    #
+    # Creates signature.
+    #
+    # @example
+    #   signature = GroupDocs::Signature.new
+    #   signature.first_name = 'John'
+    #   signature.last_name = 'Smith'
+    #   signature.create! "John Smith's Signature"
+    #
+    # @param [String] title Signature title
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def create!(title, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/signature/{{client_id}}/signature'
+        request[:request_body] = to_hash
+      end
+      api.add_params(name: title)
+      json = api.execute!
+
+      self.id = json[:signature][:id]
+    end
+
+    #
+    # Deletes signature.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/signature/{{client_id}}/signatures/#{id}"
+      end.execute!
+    end
+
+  end # Signature
+end # GroupDocs

data/lib/groupdocs/signature/contact.rb

@@ -0,0 +1,141 @@
+module GroupDocs
+  class Signature::Contact < Api::Entity
+
+    #
+    # Returns a list of all contacts.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [Integer] :page Page to start with
+    # @option options [Integer] :records How many items to list
+    # @option options [String] :firstName Filter by first name
+    # @option options [String] :lastName Filter by last name
+    # @option options [String] :email Filter by last name
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::Contact>]
+    #
+    def self.get!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/contacts'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:contacts].map do |contact|
+        new(contact)
+      end
+    end
+
+    #
+    # Imports array of contacts.
+    #
+    # @example
+    #   contact_one = GroupDocs::Signature::Contact.new
+    #   contact_one.first_name = 'John'
+    #   contact_one.last_name = 'Smith'
+    #   contact_one.email = 'john@smith.com'
+    #   contact_two = GroupDocs::Signature::Contact.new
+    #   contact_two.first_name = 'Carla'
+    #   contact_two.last_name = 'Smith'
+    #   contact_two.email = 'carla@smith.com'
+    #   GroupDocs::Signature::Contact.import!([contact_one, contact_two])
+    #
+    # @param [Array<GroupDocs::Signature::Contact>] contacts
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def self.import!(contacts, access = {})
+      contacts.is_a?(Array) or raise ArgumentError, "Contacts should be array, received: #{contacts.inspect}"
+      contacts.each do |contact|
+        contact.is_a?(GroupDocs::Signature::Contact) or raise ArgumentError, "Contact should be GroupDocs::Signature::Contact, received: #{contact.inspect}"
+      end
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/signature/{{client_id}}/contacts'
+        request[:request_body] = contacts.map { |contact| contact.to_hash }
+      end.execute!
+    end
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] firstName
+    attr_accessor :firstName
+    # @attr [String] lastName
+    attr_accessor :lastName
+    # @attr [String] nickname
+    attr_accessor :nickname
+    # @attr [String] email
+    attr_accessor :email
+    # @attr [String] provider
+    attr_accessor :provider
+
+    # Human-readable accessors
+    alias_method :first_name,  :firstName
+    alias_method :first_name=, :firstName=
+    alias_method :last_name,   :lastName
+    alias_method :last_name=,  :lastName=
+
+    #
+    # Adds contact.
+    #
+    # @example
+    #   contact = GroupDocs::Signature::Contact.new
+    #   contact.first_name = 'John'
+    #   contact.last_name = 'Smith'
+    #   contact.email = 'john@smith.com'
+    #   contact.add!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def add!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/signature/{{client_id}}/contact'
+        request[:request_body] = to_hash
+      end.execute!
+
+      self.id = json[:contact][:id]
+    end
+
+    #
+    # Updates contact.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def update!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/{{client_id}}/contacts/#{id}"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Deletes contact.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def delete!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DELETE
+        request[:path] = "/signature/{{client_id}}/contacts/#{id}"
+      end.execute!
+    end
+
+  end # Signature::Contact
+end # GroupDocs

data/lib/groupdocs/signature/envelope.rb

@@ -0,0 +1,376 @@
+module GroupDocs
+  class Signature::Envelope < Api::Entity
+
+    require 'groupdocs/signature/envelope/log'
+
+    STATUSES = {
+      draft:      -1,
+      annotation:  0,
+      in_progress: 1,
+      expired:     2,
+      canceled:    3,
+      failed:      4,
+      completed:   5,
+      archived:    6,
+    }
+
+    include Signature::DocumentMethods
+    include Signature::EntityFields
+    include Signature::EntityMethods
+    include Signature::FieldMethods
+    include Signature::RecipientMethods
+    extend  Signature::ResourceMethods
+
+    #
+    # Returns a list of all envelopes.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [Integer] :page Page to start with
+    # @option options [Integer] :records How many items to list
+    # @option options [Integer] :status_id Filter by status identifier
+    # @option options [String] :document Filter by document GUID
+    # @option options [String] :recipient Filter by recipient email
+    # @option options [String] :date Filter by date
+    # @option options [String] :name Filter by name
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::Envelope>]
+    #
+    def self.all!(options = {}, access = {})
+      status_id = options.delete(:status_id)
+      options[:statusId] = status_id if status_id
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/envelopes'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:envelopes].map do |envelope|
+        new(envelope)
+      end
+    end
+
+    #
+    # Returns a list of all envelopes where user is recipient.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [Integer] :page Page to start with
+    # @option options [Integer] :records How many items to list
+    # @option options [Integer] :statusId Filter by status identifier
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::Envelope>]
+    #
+    def self.for_me!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/envelopes/recipient'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:envelopes].map do |envelope|
+        new(envelope)
+      end
+    end
+
+    # @attr [String] creationDateTime
+    attr_accessor :creationDateTime
+    # @attr [Symbol] status
+    attr_accessor :status
+    # @attr [String] statusDateTime
+    attr_accessor :statusDateTime
+    # @attr [Integer] envelopeExpireTime
+    attr_accessor :envelopeExpireTime
+    # @attr [Symbol] status
+    attr_accessor :status
+
+    # Human-readable accessors
+    alias_method :creation_date_time,    :creationDateTime
+    alias_method :creation_date_time=,   :creationDateTime=
+    alias_method :status_date_time,      :statusDateTime
+    alias_method :status_date_time=,     :statusDateTime=
+    alias_method :envelope_expire_time,  :envelopeExpireTime
+    alias_method :envelope_expire_time=, :envelopeExpireTime=
+
+    #
+    # Converts status to human-readable format.
+    # @return [Symbol]
+    #
+    def status
+      STATUSES.invert[@status]
+    end
+
+    #
+    # Adds recipient to envelope.
+    #
+    # @example
+    #   roles = GroupDocs::Signature::Role.get!
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   recipient = GroupDocs::Signature::Recipient.new
+    #   recipient.email = 'john@smith.com'
+    #   recipient.first_name = 'John'
+    #   recipient.last_name = 'Smith'
+    #   recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
+    #   envelope.add_recipient! recipient
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+    #
+    def add_recipient!(recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/recipient"
+      end
+      api.add_params(email:     recipient.email,
+                     firstname: recipient.first_name,
+                     lastname:  recipient.last_name,
+                     role:      recipient.role_id,
+                     order:     recipient.order)
+      api.execute!
+    end
+
+    #
+    # Modify recipient of envelope.
+    #
+    # @example
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   recipient = envelope.recipients!.first
+    #   recipient.first_name = 'Johnny'
+    #   envelope.modify_recipient! recipient
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+    #
+    def modify_recipient!(recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/recipient/#{recipient.id}"
+      end
+      api.add_params(email:     recipient.email,
+                     firstname: recipient.first_name,
+                     lastname:  recipient.last_name,
+                     role:      recipient.role_id,
+                     order:     recipient.order)
+      api.execute!
+    end
+
+    #
+    # Fills field with value.
+    #
+    # Value differs depending on field type. See examples below.
+    #
+    # @example Fill single line field
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   document = envelope.documents!.first
+    #   recipient = envelope.recipients!.first
+    #   field = envelope.fields!(document, recipient).first
+    #   envelope.fill_field! "my_data", field, document, recipient
+    #
+    # @example Fill signature field
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   document = envelope.documents!.first
+    #   recipient = envelope.recipients!.first
+    #   field = envelope.fields!(document, recipient).first
+    #   signature = GroupDocs::Signature.get!.first
+    #   envelope.fill_field! signature, field, document, recipient
+    #
+    # @example Fill checkbox field
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   document = envelope.documents!.first
+    #   recipient = envelope.recipients!.first
+    #   field = envelope.fields!(document, recipient).first
+    #   envelope.fill_field! false, field, document, recipient
+    #
+    # @param [String, Boolean, GroupDocs::Signature] value
+    # @param [GroupDocs::Signature::Field] field
+    # @param [GroupDocs::Document] document
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Signature::Field] filled field
+    # @raise [ArgumentError] if field is not GroupDocs::Signature::Field
+    # @raise [ArgumentError] if document is not GroupDocs::Document
+    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+    #
+    def fill_field!(value, field, document, recipient, access = {})
+      field.is_a?(GroupDocs::Signature::Field) or raise ArgumentError,
+        "Field should be GroupDocs::Signature::Field object, received: #{field.inspect}"
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+        "Document should be GroupDocs::Document object, received: #{document.inspect}"
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/documents/#{document.file.guid}/recipient/#{recipient.id}/field/#{field.id}"
+      end
+
+      type = field.field_type
+      if type == :signature && value.is_a?(GroupDocs::Signature)
+        api.add_params(signatureId: value.id)
+      else
+        if type == :checkbox
+          value = (value ? 'on' : 'off')
+        end
+        api.options[:request_body] = value
+        api.options[:plain] = true
+      end
+
+      json = api.execute!
+      Signature::Field.new(json[:field])
+    end
+
+    #
+    # Signs envelope.
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+    #
+    def sign!(recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/recipient/#{recipient.id}/sign"
+      end.execute!
+    end
+
+    #
+    # Declines envelope.
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
+    #
+    def decline!(recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/recipient/#{recipient.id}/decline"
+      end.execute!
+    end
+
+    #
+    # Downloads all signed documents as ZIP file to given pat.
+    #
+    # @param [String] path Directory to download file to
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [String] path to file
+    #
+    def signed_documents!(path, access = {})
+      response = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DOWNLOAD
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/documents/get"
+      end.execute!
+
+      filepath = "#{path}/#{name}.zip"
+      Object::File.open(filepath, 'w') do |file|
+        file.write(response)
+      end
+
+      filepath
+    end
+
+    #
+    # Returns a list of audit logs.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::Envelope::Log>]
+    #
+    def logs!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/logs"
+      end.execute!
+
+      json[:logs].map do |log|
+        Log.new(log)
+      end
+    end
+
+    #
+    # Sends envelope.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def send!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/send"
+      end.execute!
+    end
+
+    #
+    # Archives completed envelope.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def archive!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/archive"
+      end.execute!
+    end
+
+    #
+    # Restarts expired envelope.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def restart!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/restart"
+      end.execute!
+    end
+
+  end # Signature::Envelope
+end # GroupDocs