groupdocs 1.1.0 → 1.2.0

data/lib/groupdocs/questionnaire/execution.rb

@@ -4,21 +4,34 @@ module GroupDocs
     include Api::Helpers::Status
 
     #
-    # Returns an array of all executions.
+    # Returns execution by identifier.
     #
+    # @param [String] guid
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
-    # @return [Array<GroupDocs::Questionnaire::Execution>]
+    # @return [GroupDocs::Questionnaire::Execution, nil]
     #
-    def self.all!(access = {})
-      Questionnaire.executions!(access)
+    def self.get!(guid, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{guid}"
+      end.execute!
+
+      new(json[:execution])
+    rescue BadResponseError
+      nil
     end
 
     # @attr [Integer] id
     attr_accessor :id
-    # @attr [Integer] questionnaire_id
-    attr_accessor :questionnaire_id
+    # @attr [String] guid
+    attr_accessor :guid
+    # @attr [Integer] collector_id
+    attr_accessor :collector_id
+    # @attr [String] collector_guid
+    attr_accessor :collector_guid
     # @attr [String] questionnaire_name
     attr_accessor :questionnaire_name
     # @attr [GroupDocs::User] owner
@@ -31,18 +44,41 @@ module GroupDocs
     attr_accessor :datasource_id
     # @attr [Symbol] status
     attr_accessor :status
-    # @attr [String] guid
-    attr_accessor :guid
+    # @attr [Time] modified
+    attr_accessor :modified
+    # @attr [GroupDocs::Storage::File] document
+    attr_accessor :document
 
     #
     # Converts status to human-readable format.
-    #
     # @return [Symbol]
     #
     def status
       parse_status(@status)
     end
 
+    #
+    # Converts timestamp which is return by API server to Time object.
+    # @return [Time]
+    #
+    def modified
+      Time.at(@modified / 1000)
+    end
+
+    #
+    # Converts document to GroupDocs::Document object.
+    # @param [Hash] options
+    #
+    def document=(options)
+      if options.is_a?(Hash)
+        options = GroupDocs::Storage::File.new(options)
+      elsif options.is_a?(Document)
+        options = options.file
+      end
+
+      @document = options
+    end
+
     %w(owner executive approver).each do |method|
       #
       # Converts hash of user options to GroupDocs::User object.
@@ -51,7 +87,7 @@ module GroupDocs
       #
       define_method(:"#{method}=") do |options|
         case options
-        when GroupDocs::User then instance_variable_set(:"@#{method}", options)
+        when User then instance_variable_set(:"@#{method}", options)
         when Hash then instance_variable_set(:"@#{method}", User.new(options))
         end
       end
@@ -94,5 +130,52 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Deletes execution.
+    #
+    # @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] = "/merge/{{client_id}}/questionnaires/executions/#{id}"
+      end.execute!
+    end
+
+    #
+    # Creates new job to merge datasource into questionnaire collector execution.
+    #
+    # When you fill collector, execution for it creates. You can then fill this execution
+    # (for example if you didn't answered all the questions at first).
+    #
+    # @param [GroupDocs::DataSource] datasource
+    # @param [Hash] options
+    # @option options [Boolean] :new_type New file format type
+    # @option options [Boolean] :email_results Set to true if converted document should be emailed
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [GroupDocs::Job]
+    #
+    # @raise [ArgumentError] if datasource is not GroupDocs::DataSource object
+    #
+    def fill!(datasource, options = {}, access = {})
+      datasource.is_a?(GroupDocs::DataSource) or raise ArgumentError,
+        "Datasource should be GroupDocs::DataSource object, received: #{datasource.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/executions/#{guid}/datasources/#{datasource.id}"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      Job.new(id: json[:job_id])
+    end
+
   end # Questionnaire::Execution
 end # GroupDocs

data/lib/groupdocs/questionnaire/question.rb

@@ -19,8 +19,7 @@ module GroupDocs
     attr_accessor :answers
 
     # Human-readable accessors
-    alias_method :default_answer,  :def_answer
-    alias_method :default_answer=, :def_answer=
+    alias_accessor :default_answer, :def_answer
 
     #
     # Converts each answer to GroupDocs::Questionnaire::Question::Answer object.

data/lib/groupdocs/signature.rb

@@ -11,6 +11,8 @@ module GroupDocs
     require 'groupdocs/signature/role'
     require 'groupdocs/signature/template'
 
+    include Api::Helpers::MIME
+
     #
     # Returns a list of all user signatures.
     #
@@ -61,32 +63,22 @@ module GroupDocs
     attr_accessor :initialsImageUrl
     # @attr [String] createdTimeStamp
     attr_accessor :createdTimeStamp
+    # @attr [String] image_path
+    attr_accessor :image_path
 
     # 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=
+    alias_accessor :user_guid,               :userGuid
+    alias_accessor :recipient_id,            :recipientId
+    alias_accessor :company_name,            :companyName
+    alias_accessor :first_name,              :firstName
+    alias_accessor :last_name,               :lastName
+    alias_accessor :full_name,               :fullName
+    alias_accessor :text_initials,           :textInitials
+    alias_accessor :signature_image_file_id, :signatureImageFileId
+    alias_accessor :initials_image_file_id,  :initialsImageFileId
+    alias_accessor :signature_image_url,     :signatureImageUrl
+    alias_accessor :initials_image_url,      :initialsImageUrl
+    alias_accessor :created_time_stamp,      :createdTimeStamp
 
     #
     # Creates signature.

data/lib/groupdocs/signature/contact.rb

@@ -76,10 +76,8 @@ module GroupDocs
     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=
+    alias_accessor :first_name, :firstName
+    alias_accessor :last_name,  :lastName
 
     #
     # Adds contact.

data/lib/groupdocs/signature/envelope.rb

@@ -92,12 +92,9 @@ module GroupDocs
     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=
+    alias_accessor :creation_date_time,   :creationDateTime
+    alias_accessor :status_date_time,     :statusDateTime
+    alias_accessor :envelope_expire_time, :envelopeExpireTime
 
     #
     # Converts status to human-readable format.

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

@@ -13,10 +13,8 @@ module GroupDocs
     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=
+    alias_accessor :remote_address, :remoteAddress
+    alias_accessor :user_name,      :userName
 
   end # Signature::Envelope::Log
 end # GroupDocs

data/lib/groupdocs/signature/field.rb

@@ -92,48 +92,27 @@ module GroupDocs
     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=
+    alias_accessor :template_id,        :templateId
+    alias_accessor :recipient_id,       :recipientId
+    alias_accessor :signature_field_id, :signatureFieldId
+    alias_accessor :graph_size_w,       :graphSizeW
+    alias_accessor :graph_size_w,       :graphSizeW
+    alias_accessor :graph_size_width,   :graphSizeW
+    alias_accessor :graph_size_h,       :graphSizeH
+    alias_accessor :graph_size_height,  :graphSizeH
+    alias_accessor :get_data_from,      :getDataFrom
+    alias_accessor :regular_expression, :regularExpression
+    alias_accessor :font_name,          :fontName
+    alias_accessor :font_color,         :fontColor
+    alias_accessor :font_size,          :fontSize
+    alias_accessor :font_bold,          :fontBold
+    alias_accessor :font_italic,        :fontItalic
+    alias_accessor :font_underline,     :fontUnderline
+    alias_accessor :is_system,          :isSystem
+    alias_accessor :acceptable_values,  :acceptableValues
+    alias_accessor :default_value,      :defaultValue
+    alias_accessor :text_rows,          :textRows
+    alias_accessor :text_columns,       :textColumns
 
     #
     # Converts location to GroupDocs::Signature::Field::Location object.

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

@@ -31,42 +31,24 @@ module GroupDocs
     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=
+    alias_accessor :document_id,     :documentId
+    alias_accessor :field_id,        :fieldId
+    alias_accessor :location_x,      :locationX
+    alias_accessor :x,               :locationX
+    alias_accessor :location_y,      :locationY
+    alias_accessor :y,               :locationY
+    alias_accessor :location_w,      :locationWidth
+    alias_accessor :location_width,  :locationWidth
+    alias_accessor :w,               :locationWidth
+    alias_accessor :location_h,      :locationHeight
+    alias_accessor :location_height, :locationHeight
+    alias_accessor :h,               :locationHeight
+    alias_accessor :font_name,       :fontName
+    alias_accessor :font_color,      :fontColor
+    alias_accessor :font_size,       :fontSize
+    alias_accessor :font_bold,       :fontBold
+    alias_accessor :font_italic,     :fontItalic
+    alias_accessor :font_underline,  :fontUnderline
 
   end # Signature::Field::Location
 end # GroupDocs

data/lib/groupdocs/signature/form.rb

@@ -69,24 +69,15 @@ module GroupDocs
     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=
+    alias_accessor :owner_guid,                    :ownerGuid
+    alias_accessor :template_guid,                 :templateGuid
+    alias_accessor :created_time_stamp,            :createdTimeStamp
+    alias_accessor :status_date_time,              :statusDateTime
+    alias_accessor :documents_count,               :documentsCount
+    alias_accessor :documents_pages,               :documentsPages
+    alias_accessor :participants_count,            :participantsCount
+    alias_accessor :fields_in_final_file_name,     :fieldsInFinalFileName
+    alias_accessor :can_participant_download_form, :canParticipantDownloadForm
 
     #
     # Converts status to human-readable format.

data/lib/groupdocs/signature/list.rb

@@ -31,8 +31,7 @@ module GroupDocs
     attr_accessor :defaultValue
 
     # Human-readable accessors
-    alias_method :default_value,  :defaultValue
-    alias_method :default_value=, :defaultValue=
+    alias_accessor :default_value, :defaultValue
 
     #
     # Converts values to API compatible view.

data/lib/groupdocs/signature/recipient.rb

@@ -28,12 +28,9 @@ module GroupDocs
     attr_accessor :status
 
     # Human-readable accessors
-    alias_method :first_name,  :firstName
-    alias_method :first_name=, :firstName=
-    alias_method :last_name,   :lastName
-    alias_method :last_name=,  :lastName=
-    alias_method :role_id,     :roleId
-    alias_method :role_id=,    :roleId=
+    alias_accessor :first_name, :firstName
+    alias_accessor :last_name,  :lastName
+    alias_accessor :role_id,    :roleId
 
     #
     # Converts status to human-readable format.