groupdocs 1.5.7 → 1.5.8

data/lib/groupdocs/signature/envelope.rb

@@ -109,6 +109,8 @@ module GroupDocs
       STATUSES.invert[@status]
     end
 
+    #
+    # Changed in release 1.5.8
     #
     # Adds recipient to envelope.
     #
@@ -142,7 +144,9 @@ module GroupDocs
                      :lastname  => recipient.last_name,
                      :role      => recipient.role_id,
                      :order     => recipient.order)
-      api.execute!
+      json = api.execute!
+      Signature::Recipient.new(json[:recipient])
+
     end
 
     #
@@ -297,7 +301,7 @@ module GroupDocs
     # @option access [String] :private_key
     # @raise [ArgumentError] if recipient is not GroupDocs::Signature::Recipient
     #
-    def sign!(recipient, options = {}, ccess = {})
+    def sign!(recipient, options = {}, access = {})
       recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
         "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
 
@@ -362,7 +366,9 @@ module GroupDocs
     end
 
     #
-    # Downloads signed document to given path.
+    # Changed in release 1.5.8
+	#
+	# Downloads signed document to given path.
     #
     # @param [GroupDocs::Document] document Signed document
     # @param [String] path Directory to download file to
@@ -381,7 +387,7 @@ module GroupDocs
         request[:path] = "/signature/{{client_id}}/envelopes/#{id}/document/#{document.file.guid}"
       end.execute!
 
-      filepath = "#{path}/#{name}.pdf"
+      document.file.name ? filepath = "#{path}/#{document.file.name}" : filepath = "#{path}/#{name}.pdf"
 
       Object::File.open(filepath, 'wb') do |file|
         file.write(response)
@@ -483,6 +489,7 @@ module GroupDocs
       end.execute!
 
       filepath = "#{path}/#{name}."
+
       if documents!.size == 1
         filepath << 'pdf'
       else
@@ -545,5 +552,140 @@ module GroupDocs
 
     end
 
+    #
+    # Modify signature envelope field location.
+    #
+    # @example Modify field location in envelope
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   document = envelope.documents!.first
+    #   recipient = envelope.recipients!.first
+    #   field = envelope.fields!(document, recipient).first
+    #   location = field.locations.first
+    #   envelope.modify_field_location! location, field, document, recipient
+    #
+    # @param [GroupDocs::Signature::Field::Location] location
+    # @param [GroupDocs::Signature::Field] field
+    # @param [GroupDocs::Document] document
+    # @param [GroupDocs::Signature::Recipient] recipient
+    # @param [Integer] order  Location order
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if location is not GroupDocs::Signature::Field::Location
+    # @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 modify_field_location!(location, field, document, recipient, order, access = {})
+      location.is_a?(GroupDocs::Signature::Field::Location) or raise ArgumentError,
+                                                                     "Location should be GroupDocs::Signature::Field::Location object, received: #{location.inspect}"
+      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}/fields/#{field.id}/locations/#{location.id}"
+      end
+      api.add_params(:order => order)
+      api.execute!
+    end
+
+    #
+    # Changed in release 1.5.8
+    #
+    # Get signature envelope.
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient Recipient GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def public_get!(recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+                                                                "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/envelopes/#{id}/recipient/#{recipient.id}"
+      end.execute!
+
+      Signature::Envelope.new(json[:envelope])
+    end
+
+    #
+    # Changed in release 1.5.8
+    #
+    # Public downloads signed documents to given path.
+    #
+    # If there is only one file in envelope, it's saved as PDF.
+    # If there are two or more files in envelope, it's saved as ZIP.
+    #
+    # @param [String] path Directory to download file to
+    # @param [GroupDocs::Signature::Recipient] recipient Recipient GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def public_signed_documents!(path, recipient, access = {})
+      recipient.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+                                                                "Recipient should be GroupDocs::Signature::Recipient object, received: #{recipient.inspect}"
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DOWNLOAD
+        request[:path] = "/signature/public/envelopes/#{id}/recipient/#{recipient.id}/documents/get"
+      end.execute!
+      filepath = "#{path}/#{name}."
+      if documents!.size == 1
+        filepath << 'pdf'
+      else
+        filepath << 'zip'
+      end
+
+      Object::File.open(filepath, 'wb') do |file|
+        file.write(json)
+      end
+
+      filepath
+    end
+
+
+    #
+    # Changed in release 1.5.8
+    #
+    #
+    # Get signed envelope field data.
+    #
+    # @param [GroupDocs::Signature::Recipient] recipient Recipient GUID
+    # @param [GroupDocs::Signature::Field] field Field GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def date!(recipient, field, access = {})
+      field.is_a?(GroupDocs::Signature::Field) or raise ArgumentError,
+                                                        "Field should be GroupDocs::Signature::Field object, received: #{field.inspect}"
+      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] = :GET
+        request[:path] = "/signature/public/envelopes/#{id}/fields/recipient/#{recipient.id}/field/#{field.id}"
+      end.execute!
+
+    end
+
+
+
+
   end # Signature::Envelope
 end # GroupDocs

data/lib/groupdocs/signature/field.rb

@@ -70,7 +70,7 @@ module GroupDocs
     attr_accessor :isSystem
     # @attr [Boolean] mandatory
     attr_accessor :mandatory
-    # @attr [Symbol] fieldType
+    # @attr [Integer] fieldType
     attr_accessor :fieldType
     # @attr [Array<String>] acceptableValues
     attr_accessor :acceptableValues
@@ -91,6 +91,19 @@ module GroupDocs
     # @attr [Array<GroupDocs::Signature::Field::Location>] locations
     attr_accessor :locations
 
+    # added in realise 1.5.8
+    # @attr [Integer] pageWidth
+    attr_accessor :pageWidth
+    # @attr [Integer] pageHeight
+    attr_accessor :pageHeight
+    # @attr [String] groupName
+    attr_accessor :groupName
+    # @attr [String] settings
+    attr_accessor :settings
+    # @attr [Integer] align
+    attr_accessor :align
+    # @attr [String] guidanceText
+    attr_accessor :guidanceText
 
     # Human-readable accessors
     alias_accessor :template_id,        :templateId
@@ -113,6 +126,12 @@ module GroupDocs
     alias_accessor :default_value,      :defaultValue
     alias_accessor :text_rows,          :textRows
     alias_accessor :text_columns,       :textColumns
+    # added in release 1.5.8
+    alias_accessor :page_width,         :pageWidth
+    alias_accessor :page_height,        :pageHeight
+    alias_accessor :group_name,         :groupName
+    alias_accessor :guidance_text,      :guidanceText
+
 
     #
     # Converts location to GroupDocs::Signature::Field::Location object.

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

@@ -7,15 +7,15 @@ module GroupDocs
     attr_accessor :documentId
     # @attr [String] fieldId
     attr_accessor :fieldId
-    # @attr [Integer] page
+    # @attr [Integer] page (required)
     attr_accessor :page
-    # @attr [Float] locationX
+    # @attr [Float] locationX (required)
     attr_accessor :locationX
-    # @attr [Float] locationY
+    # @attr [Float] locationY (required)
     attr_accessor :locationY
-    # @attr [Float] locationWidth
+    # @attr [Float] locationWidth (required)
     attr_accessor :locationWidth
-    # @attr [Float] locationHeight
+    # @attr [Float] locationHeight (required)
     attr_accessor :locationHeight
     # @attr [String] fontName
     attr_accessor :fontName
@@ -34,6 +34,15 @@ module GroupDocs
     # @attr [String] page
     attr_accessor :page
 
+    # added in realise 1.5.8
+    # @attr [Integer] pageWidth
+    attr_accessor :pageWidth
+    # @attr [Integer] pageHeight
+    attr_accessor :pageHeight
+    # @attr [Integer] align
+    attr_accessor :align
+
+
     # Human-readable accessors
     alias_accessor :document_id,     :documentId
     alias_accessor :field_id,        :fieldId
@@ -53,8 +62,10 @@ module GroupDocs
     alias_accessor :font_bold,       :fontBold
     alias_accessor :font_italic,     :fontItalic
     alias_accessor :font_underline,  :fontUnderline
-    alias_accessor :forceNewField,   :forceNewField
-    alias_accessor :page,            :page
+    alias_accessor :force_new_field, :forceNewField
+    # added in release 1.5.8
+    alias_accessor :page_width,         :pageWidth
+    alias_accessor :page_height,        :pageHeight
 
   end # Signature::Field::Location
 end # GroupDocs

data/lib/groupdocs/signature/form.rb

@@ -30,7 +30,7 @@ module GroupDocs
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
-    # @return [Array<GroupDocs::Signature::Envelope>]
+    # @return [Array<GroupDocs::Signature::Form>]
     #
     def self.all!(options = {}, access = {})
       status_id = options.delete(:status_id)
@@ -117,7 +117,7 @@ module GroupDocs
     alias_accessor :can_participant_download_form, :canParticipantDownloadForm
     alias_accessor :water_mark_text,               :waterMarkText
     alias_accessor :water_mark_image,              :waterMarkImage
-    alias_accessor :notifyOwnerOnSign,             :notifyOwnerOnSign
+    alias_accessor :notify_owner_on_sign,          :notifyOwnerOnSign
 
 
     #
@@ -154,7 +154,7 @@ module GroupDocs
     # @example
     #   form = GroupDocs::Signature::Form.new
     #   form.name = "Form"
-    #   form.create! template
+    #   form.create!
     #
     # @param [Hash] options Hash of options
     # @option options [String] :template_id Template GUID to create form from
@@ -258,24 +258,30 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Changed in release 1.5.8
     #
     # Returns an array of fields for document per participant.
     #
     # @param [GroupDocs::Document] document
+    # @param  [Hash] options
+    # @option options [String] :field Field GUID
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
     # @raise [ArgumentError] if document is not GroupDocs::Document
     #
-    def fields!(document, access = {})
+    def fields!(document, options = {}, access = {})
       document.is_a?(GroupDocs::Document) or raise ArgumentError,
         "Document should be GroupDocs::Document object, received: #{document.inspect}"
 
-      json = Api::Request.new do |request|
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = "/signature/{{client_id}}/forms/#{id}/documents/#{document.file.guid}/fields"
-      end.execute!
+      end
+      api.add_params(options)
+      json = api.execute!
 
       json[:fields].map do |field|
         Signature::Field.new(field)
@@ -347,7 +353,7 @@ module GroupDocs
     # @raise [ArgumentError] if field is not GroupDocs::Signature::Field
     # @raise [ArgumentError] if document is not GroupDocs::Document
     #
-    def modify_field_location!(location, field, document, recipient, access = {})
+    def modify_field_location!(location, field, document, access = {})
       location.is_a?(GroupDocs::Signature::Field::Location) or raise ArgumentError,
         "Location should be GroupDocs::Signature::Field::Location object, received: #{location.inspect}"
       field.is_a?(GroupDocs::Signature::Field) or raise ArgumentError,
@@ -388,9 +394,8 @@ module GroupDocs
     #
     # @example
     #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
-    #   document = envelope.documents!.first
-    #   recipient = envelope.recipients!.first
-    #   field = envelope.fields!(document, recipient).first
+    #   document = form.documents!.first
+    #   field = form.fields!(document).first
     #   field.name = "Field"
     #   envelope.modify_field! field, document
     #
@@ -416,6 +421,8 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Changed in release 1.5.8
     #
     # Downloads signed documents to given path.
     # If there is only one file in envelope, it's saved as PDF.
@@ -434,6 +441,188 @@ module GroupDocs
         request[:path] = "/signature/{{client_id}}/forms/#{id}/documents/get"
       end.execute!
 
+      filepath = "#{path}/#{name}.zip"
+
+
+      Object::File.open(filepath, 'wb') do |file|
+        file.write(response)
+      end
+
+      filepath
+    end
+
+    #
+    # Changed in release 1.5.8
+	#
+	# Public fill signature form.
+    #
+    # @param [String] form Form GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def public_fill!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/forms/#{id}/fill"
+      end.execute!
+    end
+
+    #
+    # Changed in release 1.5.8
+    #
+    # Public fill form field.
+    #
+    # @example Fill single line field
+    #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+    #   document = form.documents!.first
+    #   field = form.fields!(document).first
+    #   fill_form = form.public_fill!
+    #   participant = fill_form[:participant][:id]
+    #   envelope.fill_field! "my_data", field, document, participant
+    #
+    # @example Fill signature field
+    #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+    #   document = form.documents!.first
+    #   field = form.fields!(document).first
+    #   fill_form = form.public_fill!
+    #   participant = fill_form[:participant][:id]
+    #   signature = GroupDocs::Signature.get!.first
+    #   form.fill_field! signature, field, document, participant
+    #
+    # @example Fill checkbox field
+    #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+    #   document = form.documents!.first
+    #   field = form.fields!(document).first
+    #   fill_form = form.public_fill!
+    #   participant = fill_form[:participant][:id]
+    #   form.fill_field! false, field, document, participant
+    #
+    #
+    # @param [GroupDocs::Document] document Document GUID
+    # @param [String] participant Participant ID
+    # @param [GroupDocs::Signature::Field] field Field GUID
+    # @param [String] authentication Authentication signature
+    # @param [File Stream] value Data to be placed in field
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def public_fill_field!(value, field, document, participant, authentication,  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}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/public/forms/#{id}/documents/#{document.guid}/participant/#{participant}/field/#{field.id}"
+        request[:request_body] = value
+        request[:plain] = true
+      end
+      api.add_params(:participantAuthSignature => authentication)
+      json = api.execute!
+      Signature::Field.new(json[:field])
+    end
+
+    #
+    # Changed in release 1.5.8
+    #
+    # Public sign form.
+    #
+    # @param [String] form Form GUID
+    # @param [String] participant Participant GUID
+    # @param [String] authentication Authentication signature
+    # @param [String] participant_name Participant Name
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def sign!( participant, authentication, participant_name, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/public/forms/#{id}/participant/#{participant}/sign"
+      end
+      api.add_params(:participantAuthSignature => authentication, :name => participant_name)
+      api.execute!
+    end
+
+    #
+    #  Changed in release 1.5.8
+    #
+    #
+    # Get form fields for document in form per participant
+    #
+    # @param [Hash] options
+    # @option [String] :document Document GUID
+    # @option [String] :participant Participant GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def public_fields!(options = {}, access = {})
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/forms/#{id}/fields"
+      end
+      api.add_params(options)
+      json = api.execute!
+
+      json[:fields].map do |field|
+        Signature::Field.new(field)
+      end
+    end
+
+    #
+    #  Changed in release 1.5.8
+    #
+    #
+    # Get signature form participant.
+    #
+    # @param [String] participant Participant GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def participant!(participant, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/forms/#{form}/participants/#{participant}"
+      end.execute!
+
+      json[:participant]
+    end
+
+    #
+    # Changed in release 1.5.8
+    #
+    #
+    # Get signed form documents.
+    #
+    # @param [String] participant Participant GUID
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def public_signed_documents!(path, participant, access = {})
+      response = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DOWNLOAD
+        request[:path] = "/signature/public/forms/#{id}/participant/#{participant}/documents/get"
+      end.execute!
+
+
       filepath = "#{path}/#{name}."
       if documents!.size == 1
         filepath << 'pdf'