groupdocs 1.3.0 → 1.4.0

data/lib/groupdocs/api/request.rb

@@ -21,7 +21,7 @@ module GroupDocs
       # @example
       #   api = GroupDocs::Api::Request.new do |request|
       #     request[:method] = :POST
-      #     request[:path] = "/storage/#{GroupDocs.client_id}/info"
+      #     request[:path] = "/storage/{{client_id}}/info"
       #   end
       #
       # @param [Hash] options

data/lib/groupdocs/document.rb

@@ -485,13 +485,16 @@ module GroupDocs
     #   document = GroupDocs::Storage::Folder.list!.first.to_document
     #   job = document.convert!(:docx)
     #   sleep(5) # wait for server to finish converting
-    #   original_document = job.documents!.first
+    #   original_document = job.documents![:inputs].first
     #   converted_file = original_file.outputs.first
     #   converted_file.download!(File.dirname(__FILE__))
     #
     # @param [Symbol] format
     # @param [Hash] options
-    # @option options [Boolean] :email_results Set to true if converted document should be emailed
+    # @option options [Boolean] :email_results
+    # @option options [String] :new_description
+    # @option options [String] :print_script
+    # @option options [String] :callback
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
@@ -716,7 +719,7 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/comparison/{{client_id}}/comparison/changes"
+        request[:path] = '/comparison/{{client_id}}/comparison/changes'
       end
       api.add_params(:resultFileId => file.guid)
       json = api.execute!

data/lib/groupdocs/signature.rb

@@ -61,6 +61,10 @@ module GroupDocs
     attr_accessor :signatureImageUrl
     # @attr [String] initialsImageUrl
     attr_accessor :initialsImageUrl
+    # @attr [String] signatureData
+    attr_accessor :signatureData
+    # @attr [String] initialsData
+    attr_accessor :initialsData
     # @attr [String] createdTimeStamp
     attr_accessor :createdTimeStamp
     # @attr [String] image_path
@@ -78,6 +82,8 @@ module GroupDocs
     alias_accessor :initials_image_file_id,  :initialsImageFileId
     alias_accessor :signature_image_url,     :signatureImageUrl
     alias_accessor :initials_image_url,      :initialsImageUrl
+    alias_accessor :signature_data,          :signatureData
+    alias_accessor :initials_data,           :initialsData
     alias_accessor :created_time_stamp,      :createdTimeStamp
 
     #

data/lib/groupdocs/signature/contact.rb

@@ -1,6 +1,12 @@
 module GroupDocs
   class Signature::Contact < Api::Entity
 
+    INTEGRATION_PROVIDERS = {
+      :local     => 0,
+      :groupdocs => 1,
+      :google    => 2,
+    }
+
     #
     # Returns a list of all contacts.
     #
@@ -62,6 +68,42 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Adds contact integration.
+    #
+    # @example Add Google contacts integration
+    #   integration = {
+    #     provider:                :google,
+    #     refresh_token:           'token',
+    #     access_token:            'token',
+    #     access_token_expiration: '2014-12-12'
+    #   }
+    #
+    # @param [Hash] integration
+    # @option integration [Symbol] provider One of :local, :groupdocs or :google
+    # @option integration [String] refresh_token
+    # @option integration [String] access_token
+    # @option integration [String] access_token_exipration
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def self.add_integration!(integration, access = {})
+      payload = {
+        :provider              => INTEGRATION_PROVIDERS[integration[:provider]],
+        :refreshToken          => integration[:refresh_token],
+        :accessToken           => integration[:access_token],
+        :accessTokenExpiration => integration[:access_token_expiration],
+      }
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = '/signature/{{client_id}}/integration'
+        request[:request_body] = payload
+      end.execute!
+    end
+
     # @attr [String] id
     attr_accessor :id
     # @attr [String] firstName

data/lib/groupdocs/signature/envelope.rb

@@ -12,6 +12,7 @@ module GroupDocs
       :failed      =>  4,
       :completed   =>  5,
       :archived    =>  6,
+      :scheduled   => 99,
     }
 
     include Signature::DocumentMethods
@@ -88,6 +89,8 @@ module GroupDocs
     attr_accessor :statusDateTime
     # @attr [Integer] envelopeExpireTime
     attr_accessor :envelopeExpireTime
+    # @attr [Boolean] isDemo
+    attr_accessor :isDemo
     # @attr [Symbol] status
     attr_accessor :status
 
@@ -95,6 +98,7 @@ module GroupDocs
     alias_accessor :creation_date_time,   :creationDateTime
     alias_accessor :status_date_time,     :statusDateTime
     alias_accessor :envelope_expire_time, :envelopeExpireTime
+    alias_accessor :is_demo,              :isDemo
 
     #
     # Converts status to human-readable format.
@@ -172,6 +176,44 @@ module GroupDocs
       api.execute!
     end
 
+    #
+    # Delegates recipient to another one.
+    #
+    # @example
+    #   envelope = GroupDocs::Signature::Envelope.get!("g94h5g84hj9g4gf23i40j")
+    #   old = envelope.recipients!.first
+    #   old.first_name = 'Johnny'
+    #   new = GroupDocs::Signature::Recipient.new
+    #   new.email = 'john@smith.com'
+    #   new.first_name = 'John'
+    #   new.last_name = 'Smith'
+    #   envelope.delegate_recipient! old, new
+    #
+    # @param [GroupDocs::Signature::Recipient] old
+    # @param [GroupDocs::Signature::Recipient] new
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if old recipient is not GroupDocs::Signature::Recipient
+    # @raise [ArgumentError] if new recipient is not GroupDocs::Signature::Recipient
+    #
+    def delegate_recipient!(old, new, access = {})
+      old.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "Old recipient should be GroupDocs::Signature::Recipient object, received: #{old.inspect}"
+      new.is_a?(GroupDocs::Signature::Recipient) or raise ArgumentError,
+        "New recipient should be GroupDocs::Signature::Recipient object, received: #{new.inspect}"
+
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/recipient/#{old.id}/delegate"
+      end
+      api.add_params(:email     => new.email,
+                     :firstname => new.first_name,
+                     :lastname  => new.last_name)
+      api.execute!
+    end
+
     #
     # Fills field with value.
     #
@@ -312,6 +354,35 @@ module GroupDocs
       filepath
     end
 
+    #
+    # Downloads signed document to given path.
+    #
+    # @param [GroupDocs::Document] document Signed document
+    # @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_document!(document, path, access = {})
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+        "Document should be GroupDocs::Document object, received: #{document.inspect}"
+
+      response = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :DOWNLOAD
+        request[:path] = "/signature/{{client_id}}/envelopes/#{id}/document/#{document.file.guid}"
+      end.execute!
+
+      filepath = "#{path}/#{name}.pdf"
+
+      Object::File.open(filepath, 'wb') do |file|
+        file.write(response)
+      end
+
+      filepath
+    end
+
     #
     # Returns a list of audit logs.
     #

data/lib/groupdocs/signature/field.rb

@@ -72,7 +72,7 @@ module GroupDocs
     attr_accessor :mandatory
     # @attr [Symbol] fieldType
     attr_accessor :fieldType
-    # @attr [Boolean] acceptableValues
+    # @attr [Array<String>] acceptableValues
     attr_accessor :acceptableValues
     # @attr [String] defaultValue
     attr_accessor :defaultValue
@@ -109,7 +109,6 @@ module GroupDocs
     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
@@ -165,6 +164,26 @@ module GroupDocs
     end
     alias_method :type, :field_type
 
+    #
+    # Converts array of acceptable values to machine-readable format.
+    # @param [Array<String>] values
+    #
+    def acceptable_values=(values)
+      if values.is_a?(Array)
+        values = values.join(';')
+      end
+
+      @acceptableValues = values
+    end
+
+    #
+    # Converts acceptable values to human-readable format.
+    # @return [Array<String>]
+    #
+    def acceptable_values
+      @acceptableValues.split(';') if @acceptableValues
+    end
+
     #
     # Creates signature field.
     #

data/lib/groupdocs/signature/form.rb

@@ -2,8 +2,13 @@ module GroupDocs
   class Signature::Form < Api::Entity
 
     include Signature::EntityMethods
+    include Signature::DocumentMethods
+    include Signature::FieldMethods
     extend  Signature::ResourceMethods
 
+    # form doesn't have recipients
+    undef_method :assign_field!
+
     STATUSES = {
       :draft       => -1,
       :in_progress =>  1,
@@ -67,6 +72,10 @@ module GroupDocs
     attr_accessor :canParticipantDownloadForm
     # @attr [Symbol] status
     attr_accessor :status
+    # @attr [String] watermarkText
+    attr_accessor :watermarkText
+    # @attr [String] watermarkImage
+    attr_accessor :watermarkImage
 
     # Human-readable accessors
     alias_accessor :owner_guid,                    :ownerGuid
@@ -76,8 +85,9 @@ module GroupDocs
     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
+    alias_accessor :watermark_text,                :watermarkText
+    alias_accessor :watermark_image,               :watermarkImage
 
     #
     # Converts status to human-readable format.
@@ -87,28 +97,46 @@ module GroupDocs
       STATUSES.invert[@status]
     end
 
+    #
+    # Converts array of field names to machine-readable format.
+    # @param [Array<String>] fields
+    #
+    def fields_in_final_file_name=(fields)
+      if fields.is_a?(Array)
+        fields = fields.join(',')
+      end
+
+      @fieldsInFinalFileName = fields
+    end
+
+    #
+    # Converts field names to human-readable format.
+    # @return [Array<String>]
+    #
+    def fields_in_final_file_name
+      @fieldsInFinalFileName.split(',') if @fieldsInFinalFileName
+    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
+    # @option options [String] :template_id Template GUID to create form from
+    # @option options [Integer] :assembly_id Questionnaire identifier to create form from
     # @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}"
-
+    def create!(options = {}, access = {})      
+      template_id = options.delete(:template_id)
       assembly_id = options.delete(:assembly_id)
+      options[:templateId] = template_id if template_id
       options[:assemblyId] = assembly_id if assembly_id
 
       api = Api::Request.new do |request|
@@ -117,7 +145,7 @@ module GroupDocs
         request[:path] = '/signature/{{client_id}}/form'
         request[:request_body] = to_hash
       end
-      api.add_params(options.merge(:name => name, :templateId => template.id))
+      api.add_params(options.merge(:name => name))
       json = api.execute!
 
       self.id = json[:form][:id]
@@ -189,5 +217,130 @@ module GroupDocs
       end.execute!
     end
 
+    #
+    # Returns an array of fields for document per participant.
+    #
+    # @param [GroupDocs::Document] document
+    # @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 = {})
+      document.is_a?(GroupDocs::Document) or raise ArgumentError,
+        "Document should be GroupDocs::Document object, received: #{document.inspect}"
+
+      json = 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!
+
+      json[:fields].map do |field|
+        Signature::Field.new(field)
+      end
+    end
+
+    #
+    # Adds field for document.
+    #
+    # @example
+    #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+    #   field = GroupDocs::Signature::Field.get!.detect { |f| f.type == :signature }
+    #   field.location = { location_x: 0.1, location_y: 0.1, page: 1 }
+    #   document = form.documents!.first
+    #   form.add_field! field, document
+    #
+    # @param [GroupDocs::Signature::Field] field
+    # @param [GroupDocs::Document] document
+    # @param [Hash] options
+    # @option options [Boolean] :force_new_field Set to true to force new field create
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @raise [ArgumentError] if field is not GroupDocs::Signature::Field
+    # @raise [ArgumentError] if document is not GroupDocs::Document
+    # @raise [ArgumentError] if field does not specify location
+    #
+    def add_field!(field, document, opts = {}, 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}"
+      field.location or raise ArgumentError,
+        "You have to specify field location, received: #{field.location.inspect}"
+
+      opts[:force_new_field] = true if opts[:force_new_field].nil?
+      payload = field.to_hash # field itself
+      payload.merge!(field.location.to_hash) # location should added in plain view (i.e. not "location": {...})
+      payload.merge!(:forceNewField => opts[:force_new_field]) # create new field flag
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/documents/#{document.file.guid}/field/#{field.id}"
+        request[:request_body] = payload
+      end.execute!
+    end
+
+    #
+    # Modifies field location.
+    #
+    # @example Modify field location in template
+    #   form = GroupDocs::Signature::Form.get!("g94h5g84hj9g4gf23i40j")
+    #   document = form.documents!.first
+    #   field = form.fields!(document).first
+    #   location = field.locations.first
+    #   location.x = 0.123
+    #   location.y = 0.123
+    #   location.page = 2
+    #   form.modify_field_location! location, field, document
+    #
+    # @param [GroupDocs::Signature::Field::Location] location
+    # @param [GroupDocs::Signature::Field] field
+    # @param [GroupDocs::Document] document
+    # @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
+    #
+    def modify_field_location!(location, field, document, recipient, 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}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :PUT
+        request[:path] = "/signature/{{client_id}}/forms/#{id}/documents/#{document.file.guid}/fields/#{field.id}/locations/#{location.id}"
+        request[:request_body] = location.to_hash
+      end.execute!
+    end
+
+    #
+    # Updates form adding fields from template.
+    #
+    # @param [GroupDocs::Signature::Template] template
+    # @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 update_from_template!(template, access = {})
+      template.is_a?(GroupDocs::Signature::Template) or raise ArgumentError,
+        "Template should be GroupDocs::Signature::Template object, received: #{template.inspect}"
+
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/{{client_id}}/forms/#{form.id}/templates/#{template.id}"
+      end.execute!
+    end
+
   end # Signature::Form
 end # GroupDocs