groupdocs 0.3.11 → 1.0.0

data/lib/groupdocs/signature/envelope/log.rb

@@ -0,0 +1,22 @@
+module GroupDocs
+  class Signature::Envelope::Log < Api::Entity
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] date
+    attr_accessor :date
+    # @attr [String] userName
+    attr_accessor :userName
+    # @attr [String] action
+    attr_accessor :action
+    # @attr [String] remoteAddress
+    attr_accessor :remoteAddress
+
+    # Human-readable accessors
+    alias_method :remote_address,  :remoteAddress
+    alias_method :remote_address=, :remoteAddress=
+    alias_method :user_name,       :userName
+    alias_method :user_name=,      :userName=
+
+  end # Signature::Envelope::Log
+end # GroupDocs

data/lib/groupdocs/signature/field.rb

@@ -0,0 +1,253 @@
+module GroupDocs
+  class Signature::Field < Api::Entity
+
+    require 'groupdocs/signature/field/location'
+
+    FIELD_TYPES = {
+      signature:   1,
+      single_line: 2,
+      multiline:   3,
+      date:        4,
+      dropdown:    5,
+      checkbox:    6,
+    }
+
+    #
+    # Returns array of predefined lists.
+    #
+    # @param [Hash] options Hash of options
+    # @option options [String] :id Filter by identifier
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Signature::Field>]
+    #
+    def self.get!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = '/signature/{{client_id}}/fields'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:fields].map do |field|
+        new(field)
+      end
+    end
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] templateId
+    attr_accessor :templateId
+    # @attr [String] recipientId
+    attr_accessor :recipientId
+    # @attr [String] signatureFieldId
+    attr_accessor :signatureFieldId
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [Integer] graphSizeW
+    attr_accessor :graphSizeW
+    # @attr [Integer] graphSizeH
+    attr_accessor :graphSizeH
+    # @attr [String] getDataFrom
+    attr_accessor :getDataFrom
+    # @attr [String] regularExpression
+    attr_accessor :regularExpression
+    # @attr [String] fontName
+    attr_accessor :fontName
+    # @attr [String] fontColor
+    attr_accessor :fontColor
+    # @attr [Integer] fontSize
+    attr_accessor :fontSize
+    # @attr [Boolean] fontBold
+    attr_accessor :fontBold
+    # @attr [Boolean] fontItalic
+    attr_accessor :fontItalic
+    # @attr [Boolean] fontUnderline
+    attr_accessor :fontUnderline
+    # @attr [Boolean] isSystem
+    attr_accessor :isSystem
+    # @attr [Boolean] mandatory
+    attr_accessor :mandatory
+    # @attr [Symbol] fieldType
+    attr_accessor :fieldType
+    # @attr [Boolean] acceptableValues
+    attr_accessor :acceptableValues
+    # @attr [String] defaultValue
+    attr_accessor :defaultValue
+    # @attr [String] tooltip
+    attr_accessor :tooltip
+    # @attr [Integer] input
+    attr_accessor :input
+    # @attr [Integer] order
+    attr_accessor :order
+    # @attr [String] textRows
+    attr_accessor :textRows
+    # @attr [String] textColumns
+    attr_accessor :textColumns
+    # @attr [GroupDocs::Signature::Field::Location] location
+    attr_accessor :location
+    # @attr [Array<GroupDocs::Signature::Field::Location>] locations
+    attr_accessor :locations
+
+    # Human-readable accessors
+    alias_method :template_id,         :templateId
+    alias_method :template_id=,        :templateId=
+    alias_method :recipient_id,        :recipientId
+    alias_method :recipient_id=,       :recipientId=
+    alias_method :signature_field_id,  :signatureFieldId
+    alias_method :signature_field_id=, :signatureFieldId=
+    alias_method :graph_size_w,        :graphSizeW
+    alias_method :graph_size_w=,       :graphSizeW=
+    alias_method :graph_size_w,        :graphSizeW
+    alias_method :graph_size_w=,       :graphSizeW=
+    alias_method :graph_size_width,    :graphSizeW
+    alias_method :graph_size_width=,   :graphSizeW=
+    alias_method :graph_size_h,        :graphSizeH
+    alias_method :graph_size_h=,       :graphSizeH=
+    alias_method :graph_size_height,   :graphSizeH
+    alias_method :graph_size_height=,  :graphSizeH=
+    alias_method :get_data_from,       :getDataFrom
+    alias_method :get_data_from=,      :getDataFrom=
+    alias_method :regular_expression,  :regularExpression
+    alias_method :regular_expression=, :regularExpression=
+    alias_method :font_name,           :fontName
+    alias_method :font_name=,          :fontName=
+    alias_method :font_color,          :fontColor
+    alias_method :font_color=,         :fontColor=
+    alias_method :font_size,           :fontSize
+    alias_method :font_size=,          :fontSize=
+    alias_method :font_bold,           :fontBold
+    alias_method :font_bold=,          :fontBold=
+    alias_method :font_italic,         :fontItalic
+    alias_method :font_italic=,        :fontItalic=
+    alias_method :font_underline,      :fontUnderline
+    alias_method :font_underline=,     :fontUnderline=
+    alias_method :is_system,           :isSystem
+    alias_method :is_system=,          :isSystem=
+    alias_method :acceptable_values,   :acceptableValues
+    alias_method :acceptable_values=,  :acceptableValues=
+    alias_method :default_value,       :defaultValue
+    alias_method :default_value=,      :defaultValue=
+    alias_method :text_rows,           :textRows
+    alias_method :text_rows=,          :textRows=
+    alias_method :text_columns,        :textColumns
+    alias_method :text_columns=,       :textColumns=
+
+    #
+    # Converts location to GroupDocs::Signature::Field::Location object.
+    #
+    # @param [GroupDocs::Signature::Field::Location, Hash] location
+    #
+    def location=(location)
+      if location
+        @location = (location.is_a?(GroupDocs::Signature::Field::Location) ? location : Signature::Field::Location.new(location))
+        locations ? locations << @location : self.locations = [@location]
+      end
+    end
+
+    #
+    # Converts each location to GroupDocs::Signature::Field::Location object.
+    #
+    # @param [Array<GroupDocs::Signature::Field::Location, Hash>] locations
+    #
+    def locations=(locations)
+      if locations
+        @locations = locations.map do |location|
+          if location.is_a?(GroupDocs::Signature::Field::Location)
+            location
+          else
+            Signature::Field::Location.new(location)
+          end
+        end
+      end
+    end
+
+    #
+    # Saves field type in machine-readable format.
+    # @param [Symbol, Integer] type
+    #
+    def field_type=(type)
+      if type.is_a?(Symbol)
+        type = FIELD_TYPES[type]
+      end
+
+      @fieldType = type
+    end
+    alias_method :type=, :field_type=
+
+    #
+    # Returns field type in human-readable format.
+    # @return [Symbol]
+    #
+    def field_type
+      FIELD_TYPES.invert[@fieldType]
+    end
+    alias_method :type, :field_type
+
+    #
+    # Creates signature field.
+    #
+    # @example
+    #   field = GroupDocs::Signature::Field.new
+    #   field.name = 'Field'
+    #   field.create!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def create!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/signature/{{client_id}}/field'
+        request[:request_body] = to_hash
+      end.execute!
+
+      self.id = json[:field][:id]
+    end
+
+    #
+    # Modifies signature field.
+    #
+    # @example
+    #   field = GroupDocs::Signature::Field.get!.first
+    #   field.name = 'Field'
+    #   field.modify!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def modify!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/{{client_id}}/fields/#{id}"
+        request[:request_body] = to_hash
+      end.execute!
+    end
+
+    #
+    # Deletes signature field.
+    #
+    # @example Remove all created fields
+    #   fields = GroupDocs::Signature::Field.get!.select { |field| !field.is_system }
+    #   fields.each { |field| field.delete! }
+    #
+    # @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}}/fields/#{id}"
+      end.execute!
+    end
+
+  end # Signature::Field
+end # GroupDocs

data/lib/groupdocs/signature/field/location.rb

@@ -0,0 +1,72 @@
+module GroupDocs
+  class Signature::Field::Location < Api::Entity
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] documentId
+    attr_accessor :documentId
+    # @attr [String] fieldId
+    attr_accessor :fieldId
+    # @attr [Integer] page
+    attr_accessor :page
+    # @attr [Float] locationX
+    attr_accessor :locationX
+    # @attr [Float] locationY
+    attr_accessor :locationY
+    # @attr [Float] locationWidth
+    attr_accessor :locationWidth
+    # @attr [Float] locationHeight
+    attr_accessor :locationHeight
+    # @attr [String] fontName
+    attr_accessor :fontName
+    # @attr [String] fontColor
+    attr_accessor :fontColor
+    # @attr [Integer] fontSize
+    attr_accessor :fontSize
+    # @attr [Boolean] fontBold
+    attr_accessor :fontBold
+    # @attr [Boolean] fontItalic
+    attr_accessor :fontItalic
+    # @attr [Boolean] fontUnderline
+    attr_accessor :fontUnderline
+
+    # Human-readable accessors
+    alias_method :document_id,      :documentId
+    alias_method :document_id=,     :documentId=
+    alias_method :field_id,         :fieldId
+    alias_method :field_id=,        :fieldId=
+    alias_method :location_x,       :locationX
+    alias_method :location_x=,      :locationX=
+    alias_method :x,                :locationX
+    alias_method :x=,               :locationX=
+    alias_method :location_y,       :locationY
+    alias_method :location_y=,      :locationY=
+    alias_method :y,                :locationY
+    alias_method :y=,               :locationY=
+    alias_method :location_w,       :locationWidth
+    alias_method :location_w=,      :locationWidth=
+    alias_method :location_width,   :locationWidth
+    alias_method :location_width=,  :locationWidth=
+    alias_method :w,                :locationWidth
+    alias_method :w=,               :locationWidth=
+    alias_method :location_h,       :locationHeight
+    alias_method :location_h=,      :locationHeight=
+    alias_method :location_height,  :locationHeight
+    alias_method :location_height=, :locationHeight=
+    alias_method :h,                :locationHeight
+    alias_method :h=,               :locationHeight=
+    alias_method :font_name,        :fontName
+    alias_method :font_name=,       :fontName=
+    alias_method :font_color,       :fontColor
+    alias_method :font_color=,      :fontColor=
+    alias_method :font_size,        :fontSize
+    alias_method :font_size=,       :fontSize=
+    alias_method :font_bold,        :fontBold
+    alias_method :font_bold=,       :fontBold=
+    alias_method :font_italic,      :fontItalic
+    alias_method :font_italic=,     :fontItalic=
+    alias_method :font_underline,   :fontUnderline
+    alias_method :font_underline=,  :fontUnderline=
+
+  end # Signature::Field::Location
+end # GroupDocs

data/lib/groupdocs/signature/form.rb

@@ -0,0 +1,202 @@
+module GroupDocs
+  class Signature::Form < Api::Entity
+
+    include Signature::EntityMethods
+    extend  Signature::ResourceMethods
+
+    STATUSES = {
+      draft:      -1,
+      in_progress: 1,
+      completed:   2,
+      archived:    3,
+    }
+
+    #
+    # Returns a list of all forms.
+    #
+    # @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] :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}}/forms'
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:forms].map do |form|
+        new(form)
+      end
+    end
+
+    # @attr [String] id
+    attr_accessor :id
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [String] ownerGuid
+    attr_accessor :ownerGuid
+    # @attr [String] templateGuid
+    attr_accessor :templateGuid
+    # @attr [String] createdTimeStamp
+    attr_accessor :createdTimeStamp
+    # @attr [String] statusDateTime
+    attr_accessor :statusDateTime
+    # @attr [Integer] documentsCount
+    attr_accessor :documentsCount
+    # @attr [Integer] documentsPages
+    attr_accessor :documentsPages
+    # @attr [Integer] participantsCount
+    attr_accessor :participantsCount
+    # @attr [Array] fieldsInFinalFileName
+    attr_accessor :fieldsInFinalFileName
+    # @attr [Boolean] canParticipantDownloadForm
+    attr_accessor :canParticipantDownloadForm
+    # @attr [Symbol] status
+    attr_accessor :status
+
+    # Human-readable accessors
+    alias_method :owner_guid,                     :ownerGuid
+    alias_method :owner_guid=,                    :ownerGuid=
+    alias_method :template_guid,                  :templateGuid
+    alias_method :template_guid=,                 :templateGuid=
+    alias_method :created_time_stamp,             :createdTimeStamp
+    alias_method :created_time_stamp=,            :createdTimeStamp=
+    alias_method :status_date_time,               :statusDateTime
+    alias_method :status_date_time=,              :statusDateTime=
+    alias_method :documents_count,                :documentsCount
+    alias_method :documents_count=,               :documentsCount=
+    alias_method :documents_pages,                :documentsPages
+    alias_method :documents_pages=,               :documentsPages=
+    alias_method :participants_count,             :participantsCount
+    alias_method :participants_count=,            :participantsCount=
+    alias_method :fields_in_final_file_name,      :fieldsInFinalFileName
+    alias_method :fields_in_final_file_name=,     :fieldsInFinalFileName=
+    alias_method :can_participant_download_form,  :canParticipantDownloadForm
+    alias_method :can_participant_download_form=, :canParticipantDownloadForm=
+
+    #
+    # Converts status to human-readable format.
+    # @return [Symbol]
+    #
+    def status
+      STATUSES.invert[@status]
+    end
+
+    #
+    # Creates form.
+    #
+    # @example
+    #   template = GroupDocs::Singature::Template!.get!('09662aab7187f31444476288ebaf7da4')
+    #   form = GroupDocs::Signature::Form.new
+    #   form.name = "Form"
+    #   form.create! template
+    #
+    # @param [GroupDocs::Signature::Template] template
+    # @param [Hash] options Hash of options
+    # @option options [Integer] :assembly_id Assembly GUID to use
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if template is not GroupDocs::Signature::Template
+    #
+    def create!(template, options = {}, access = {})
+      template.is_a?(GroupDocs::Signature::Template) or raise ArgumentError,
+        "Template should be GroupDocs::Signature::Template object, received: #{template.inspect}"
+
+      assembly_id = options.delete(:assembly_id)
+      options[:assemblyId] = assembly_id if assembly_id
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/signature/{{client_id}}/form'
+        request[:request_body] = to_hash
+      end
+      api.add_params(options.merge(name: name, templateId: template.id))
+      json = api.execute!
+
+      self.id = json[:form][:id]
+    end
+
+    #
+    # Returns documents array.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array<GroupDocs::Document>]
+    #
+    def documents!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/documents"
+      end.execute!
+
+      json[:documents].map do |document|
+        file = Storage::File.new(guid: document[:documentId], name: document[:name])
+        Document.new(document.merge(file: file))
+      end
+    end
+
+    #
+    # Publishes form.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def publish!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/publish"
+      end.execute!
+    end
+
+    #
+    # Completes form.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def complete!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/complete"
+      end.execute!
+    end
+
+    #
+    # Archives completed form.
+    #
+    # @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}}/forms/#{id}/archive"
+      end.execute!
+    end
+
+  end # Signature::Form
+end # GroupDocs