groupdocs 1.2.8 → 1.2.9

data/examples/api-samples/samples/envelope-sample.rb

@@ -0,0 +1,132 @@
+# GET request
+get '/envelope-sample' do
+  haml :envelope_sample
+end
+
+# POST request to handle callback when document was signed
+post '/envelope-sample/sign' do
+  # Content Type of callback is application/json
+  data = JSON.parse(request.body.read)
+  begin
+    raise "Empty params!" if data.empty?
+    #create empty file and write data as "key: value" to it
+    outFile = File.new("signed", "w")
+    data.each do |key, value|
+      outFile.write("#{key}: #{value} \n")
+    end
+    outFile.close
+  rescue Exception => e
+    err = e.message
+  end
+end
+
+
+# POST request to handle callback and download envelop when document was signed
+post '/envelope-sample/sign-and-download' do
+  data = JSON.parse(request.body.read)
+  begin  
+    raise "Empty params!" if data.empty?
+    GroupDocs.configure do |groupdocs|
+        groupdocs.client_id = '' # Your client Client ID here
+        groupdocs.private_key = '' # Your API Key here
+        groupdocs.api_server = 'https://api.groupdocs.com'
+    end
+    data.each do |key, value|
+      if key == 'SourceId'
+        # Create envelop with id and name as SourceId parameter from callback
+        envelope = GroupDocs::Signature::Envelope.new id: value,
+                                                    name: value
+        # download signed documents as archive
+        envelope.signed_documents! '.'
+      end
+    end
+  rescue Exception => e
+    err = e.message
+  end
+end
+
+# GET request to check if envelop was signed
+get '/envelope-sample/check' do
+  if File.exist?('signed')
+    File.readlines('signed').each do |line|
+    end
+  else 
+    'Have not signed yet'
+  end
+end
+
+# POST request
+post '/envelope-sample' do
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+
+  begin
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty?
+
+    GroupDocs.configure do |groupdocs|
+      groupdocs.client_id = params[:client_id]
+      groupdocs.private_key = params[:private_key]
+      groupdocs.api_server = 'https://stage-api.groupdocs.com'
+    end
+     
+    # upload document
+    filepath = "#{Dir.tmpdir}/#{params[:file][:filename]}"
+    File.open(filepath, 'wb') { |f| f.write(params[:file][:tempfile].read) }
+    file = GroupDocs::Storage::File.upload!(filepath, {}, client_id: settings.client_id, private_key: settings.private_key)
+    document = file.to_document
+     
+    # create envelope
+    envelope = GroupDocs::Signature::Envelope.new
+    envelope.name = "Envelope"
+    envelope.email_subject = "Sing this!"
+    envelope.create!
+     
+    # add document to envelope
+    envelope.add_document! document
+     
+    # update document object after it's created
+    document = envelope.documents!.first
+     
+    # add new recipient to envelope
+    roles = GroupDocs::Signature::Role.get!
+    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
+     
+    # update recipient object after it's created
+    recipient = envelope.recipients!.first
+
+    #
+    # You can add fields manually.
+    #
+
+    # add city field to envelope
+    #field = GroupDocs::Signature::Field.get!.detect { |f| f.type == :single_line }
+    #field.name = 'City'
+    #field.location = { location_x: 0.3, location_y: 0.2, page: 1 }
+    #envelope.add_field! field, document, recipient
+     
+    # add signature field to envelope
+    #field = GroupDocs::Signature::Field.get!.detect { |f| f.type == :signature }
+    #field.location = { location_x: 0.3, location_y: 0.3, page: 1 }
+    #envelope.add_field! field, document, recipient
+
+    # URL for callback
+    webhook = 'http://groupdocs-ruby-samples.herokuapp.com/envelope-sample/sign'
+
+    # send envelope
+    envelope.send! webhook
+     
+    # construct embedded signature url
+    url = "https://stage-apps.groupdocs.com/signature/signembed/#{envelope.id}/#{recipient.id}"
+    iframe = "<iframe src='#{url}' frameborder='0' width='720' height='600'></iframe>"
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  haml :envelope_sample, :locals => { :client_id => settings.client_id, :private_key => settings.private_key, :err => err, :iframe =>  iframe}
+end

data/examples/api-samples/samples/sample1.rb

@@ -1,17 +1,25 @@
+# GET request
 get '/sample1' do
-
   haml :sample1
 end
 
+# POST request
 post '/sample1' do
+  # set variables
   set :client_id, params[:client_id]
   set :private_key, params[:private_key]
+
   begin
+    # check required variables
     raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty?
+
+    # make a request to API using client_id and private_key
     user = GroupDocs::User.get!({:client_id => settings.client_id, :private_key => settings.private_key})
+
   rescue Exception => e
     err = e.message
   end
-  
+
+  # set variables for template
   haml :sample1, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :user => user, :err => err }
 end

data/examples/api-samples/samples/sample10.rb

@@ -1,36 +1,48 @@
+# GET request
 get '/sample10' do
   haml :sample10
 end
 
+# POST request
 post '/sample10' do
+  # set variables
   set :client_id, params[:client_id]
   set :private_key, params[:private_key]
   set :guid, params[:guid]
   set :email, params[:email]
+
   begin
+    # check required variables
     raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.guid.empty? or settings.email.empty?
 
+    # make a request to API using client_id and private_key
     files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key})
+
     name = nil
     doc = nil
     files_list.each do |element|
       if element.class.name.split('::').last == 'Folder'
         next
       end
-      
+
+      # get document and document name
       if element.guid == settings.guid
         name = element.name 
         doc = element
       end
     end
 
+    # Share document. Make a request to API using client_id and private_key
     shared = doc.to_document.sharers_set!(settings.email.split(" "), { :client_id => settings.client_id, :private_key => settings.private_key});
-	if shared
-	  shared_emails = settings.email
-	end
+
+    # result
+    if shared
+      shared_emails = settings.email
+    end
   rescue Exception => e
     err = e.message
-  end  
+  end
 
+  # set variables for template
   haml :sample10, :locals => { :client_id => settings.client_id, :private_key => settings.private_key, :guid => settings.guid, :email=>settings.email, :shared => shared_emails, :err => err }
 end

data/examples/api-samples/samples/sample11.rb

@@ -0,0 +1,86 @@
+# GET request
+get '/sample11' do
+  haml :sample11
+end
+
+# POST request
+post '/sample11' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :file_id, params[:fileId]
+  set :annotation_type, params[:annotation_type]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file_id.empty? or settings.annotation_type.empty?
+
+    # annotation types
+    types = {'text' => 0, 'area' => 1, 'point' => 2}
+
+    # required parameters
+    allParams = allParams = ['annotation_type', 'box_x', 'box_y', 'text']
+
+    # added required parameters depends on  annotation type ['text' or 'area']
+    if settings.annotation_type == "text"
+      allParams = allParams | ['box_width', 'box_height', 'annotationPosition_x', 'annotationPosition_y']
+    elsif settings.annotation_type == "area"
+      allParams = allParams | ['box_width', 'box_height']
+    end
+
+    # checking required parameters
+    allParams.each do |param|
+      raise "Please enter all required parameters" if params[param].empty?
+    end
+
+    # make a request to API using client_id and private_key
+    files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key})
+    document = ''
+
+    # get document by file ID
+    files_list.each do |element|
+      if element.respond_to?('guid') == true and element.guid == settings.file_id
+        document = element
+      end
+    end
+
+    unless document.instance_of? String
+
+      # start create new annotation
+      annotation = GroupDocs::Document::Annotation.new(document: document.to_document)
+      annotation.type = types[settings.annotation_type]
+
+      # construct requestBody depends on annotation type
+      # text annotation
+      if settings.annotation_type == "text"
+        annotation.box = {x: params['box_x'], y: params['box_y'], width: params['box_width'], height: params['box_height']}
+        annotation.annotationPosition = {x: params['annotationPosition_x'], y: params['annotationPosition_y']}
+
+      # area annotation
+      elsif settings.annotation_type == "area"
+        annotation.box = {x: params['box_x'], y: params['box_y'], width: params['box_width'], height: params['box_height']}
+        annotation.annotationPosition = {x: 0, y: 0}
+
+      # point annotation
+      elsif settings.annotation_type == "point"
+        annotation.box = {x: params['box_x'], y: params['box_y'], width: 0, height: 0}
+        annotation.annotationPosition = {x: 0, y: 0}
+      end
+
+      # call create method
+      annotation.create!({ :client_id => settings.client_id, :private_key => settings.private_key})
+
+      # add annotation reply
+      reply = GroupDocs::Document::Annotation::Reply.new(annotation: annotation)
+      reply.text = params['text']
+      reply.create!({ :client_id => settings.client_id, :private_key => settings.private_key})
+
+    end
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample11, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :fileId => settings.file_id, :annotationType => settings.annotation_type, :annotationId => (defined? annotation.id) ? annotation.id : nil, :annotationText => params['text'], :err => err }
+end

data/examples/api-samples/samples/sample12.rb

@@ -0,0 +1,39 @@
+# GET request
+get '/sample12' do
+  haml :sample12
+end
+
+# POST request
+post '/sample12' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :file_id, params[:fileId]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file_id.empty?
+
+    # make a request to API using client_id and private_key
+    files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key})
+    document = ''
+
+    # get document by file ID
+    files_list.each do |element|
+      if element.respond_to?('guid') == true and element.guid == settings.file_id
+        document = element
+      end
+    end
+
+    unless document.instance_of? String
+      # get list of annotations
+      annotations = document.to_document.annotations!(:client_id => settings.client_id, :private_key => settings.private_key)
+    end
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample12, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :annotations => annotations, :fileId => settings.file_id, :err => err }
+end

data/examples/api-samples/samples/sample13.rb

@@ -0,0 +1,40 @@
+# GET request
+get '/sample13' do
+  haml :sample13
+end
+
+# POST request
+post '/sample13' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :file_id, params[:fileId]
+  set :email, params[:email]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file_id.empty? or settings.email.empty?
+
+    # make a request to API using client_id and private_key
+    files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key})
+    document = ''
+
+    # get document by file ID
+    files_list.each do |element|
+      if element.respond_to?('guid') == true and element.guid == settings.file_id
+        document = element
+      end
+    end
+
+    unless document.instance_of? String
+      # add collaborator to doc with annotations
+      result = document.to_document.set_collaborators!(settings.email.split(" "), 1, {:client_id => settings.client_id, :private_key => settings.private_key})
+    end
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample13, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :fileId => settings.file_id, :email => settings.email, :result => result,  :err => err }
+end

data/examples/api-samples/samples/sample14.rb

@@ -0,0 +1,29 @@
+# GET request
+get '/sample14' do
+  haml :sample14
+end
+
+# POST request
+post '/sample14' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :folder, params[:folder]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.folder.empty?
+
+    # make a request to API using client_id and private_key
+    files_list = GroupDocs::Storage::Folder.list!(settings.folder, {}, { :client_id => settings.client_id, :private_key => settings.private_key})
+
+    # get list of shares for a folder
+    shares =  files_list.first.sharers!({:client_id => settings.client_id, :private_key => settings.private_key})
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample14, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :folder => settings.folder, :shares => shares, :err => err }
+end

data/examples/api-samples/samples/sample15.rb

@@ -0,0 +1,26 @@
+# GET request
+get '/sample15' do
+  haml :sample15
+end
+
+# POST request
+post '/sample15' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty?
+
+    # check the number of document's views. Make a request to API using client_id and private_key
+    views = GroupDocs::Document.views!({}, { :client_id => settings.client_id, :private_key => settings.private_key})
+    total = views.count()
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample15, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :total => total, :err => err }
+end

data/examples/api-samples/samples/sample16.rb

@@ -0,0 +1,24 @@
+# GET request
+get '/sample16' do
+  haml :sample16
+end
+
+# POST request
+post '/sample16' do
+  # set variables
+  set :fileId, params[:fileId]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.fileId.empty?
+
+    # construct result iframe
+    iframe = "<iframe src='https://apps.groupdocs.com/assembly2/questionnaire-assembly/#{settings.fileId}' frameborder='0' width='100%' height='600'></iframe>"
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample16, :locals => { :fileId => settings.fileId, :iframe => iframe, :err => err }
+end

data/examples/api-samples/samples/sample17.rb

@@ -0,0 +1,36 @@
+# GET request
+get '/sample17' do
+  haml :sample17
+end
+
+# POST request
+post '/sample17' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :file, params[:file]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file.nil?
+
+    # construct path
+    filepath = "#{Dir.tmpdir}/#{params[:file][:filename]}"
+    # open file
+    File.open(filepath, 'wb') { |f| f.write(params[:file][:tempfile].read) }
+    # upload file
+    file = GroupDocs::Storage::File.upload!(filepath, {}, client_id: settings.client_id, private_key: settings.private_key)
+    # compress file
+    file.compress!({client_id: settings.client_id, private_key: settings.private_key})
+
+    # construct result messages
+    massage = "<p>Archive created and saved successfully. Here you can see your <strong>#{params[:file][:filename]}</strong> file in the GroupDocs Embedded Viewer.</p>"
+    iframe = "<iframe src='https://apps.groupdocs.com/document-viewer/Embed/#{file.guid}' frameborder='0' width='720' height='600'></iframe>"
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample17, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :iframe=>iframe, :massage => massage, :err => err }
+end

data/examples/api-samples/samples/sample18.rb

@@ -0,0 +1,61 @@
+# GET request
+get '/sample18' do
+  haml :sample18
+end
+
+# POST request
+post '/sample18' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :file_id, params[:fileId]
+  set :convert_type, params[:convert_type]
+
+  begin
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file_id.empty?
+
+    # make a request to API using client_id and private_key
+    files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key})
+    document = ''
+
+    # get document by file ID
+    files_list.each do |element|
+      if element.respond_to?('guid') == true and element.guid == settings.file_id
+        document = element
+      end
+    end
+
+    message = ""
+    unless document.instance_of? String
+
+      # convert file
+      convert = document.to_document.convert!(settings.convert_type, {}, {:client_id => settings.client_id, :private_key => settings.private_key})
+      sleep(3)
+
+      if convert.instance_of? GroupDocs::Job
+        # get all jobs
+        jobs = GroupDocs::Job::all!({}, {:client_id => settings.client_id, :private_key => settings.private_key})
+
+        # get job by job ID
+        job = ''
+        jobs.each do |element|
+          if element.id == convert.id
+            job = element
+          end
+        end
+
+        if job.status == :archived
+          message = "<p>Converted file saved successfully."
+        end
+
+      end
+    end
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample18, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :fileId => settings.file_id, :message => message, :err => err }
+end

data/examples/api-samples/samples/sample2.rb

@@ -1,19 +1,29 @@
+# GET request
 get '/sample2' do
   haml :sample2
 end
 
+# POST request
 post '/sample2' do
+  # set variables
   set :client_id, params[:client_id]
   set :private_key, params[:private_key]
 
   begin
+    # check required variables
     raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty?
-    files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key})
+
+    # make a request to API using client_id and private_key
+    files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key })
+
+    # construct list of files
     filelist = ''
-    files_list.each {|element| filelist += element.name + '<br />'}
+    files_list.each {|element| filelist << "#{element.name}<br />"}
+
   rescue Exception => e
     err = e.message
-  end  
-  
+  end
+
+  # set variables for template
   haml :sample2, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :filelist => filelist, :err => err }
 end

data/examples/api-samples/samples/sample3.rb

@@ -1,23 +1,33 @@
+# GET request
 get '/sample3' do
-
   haml :sample3
 end
 
+# POST request
 post '/sample3' do
+  # set variables
   set :client_id, params[:client_id]
   set :private_key, params[:private_key]
+
   begin
+    # check required variables
     raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty?
-    
+
+    # construct path
     filepath = "#{Dir.tmpdir}/#{params[:file][:filename]}"
+    # open file
     File.open(filepath, 'wb') { |f| f.write(params[:file][:tempfile].read) }
+    # make a request to API using client_id and private_key
     file = GroupDocs::Storage::File.upload!(filepath, {}, client_id: settings.client_id, private_key: settings.private_key)
+
+    # result massages
     massage = "<p>File was uploaded to GroupDocs. Here you can see your <strong>#{params[:file][:filename]}</strong> file in the GroupDocs Embedded Viewer.</p>"
     iframe = "<iframe src='https://apps.groupdocs.com/document-viewer/Embed/#{file.guid}' frameborder='0' width='720' height='600'></iframe>"
   
   rescue Exception => e
     err = e.message
-  end  
-  
+  end
+
+  # set variables for template
   haml :sample3, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :iframe=>iframe, :massage => massage, :err => err }
 end

data/examples/api-samples/samples/sample4.rb

@@ -1,23 +1,31 @@
+# GET request
 get '/sample4' do
   haml :sample4
 end
 
+# POST request
 post '/sample4' do
+  # set variables
   set :client_id, params[:client_id]
   set :private_key, params[:private_key]
   set :file_id, params[:file_id]
+
   begin
+    # check required variables
     raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file_id.empty?
-    
+
+    # make a request to API using client_id and private_key
     files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.private_key})
     dowload_file = ''
 
+    # get file by file ID
     files_list.each do |element|
       if element.id == Integer(settings.file_id)
         dowload_file = element
       end
     end
 
+    # download file
     dowloaded_file = dowload_file.download!(File.dirname(__FILE__), { :client_id => settings.client_id, :private_key => settings.private_key})
     unless dowloaded_file.empty?
       massage = "<font color='green'>File was downloaded to the <font color='blue'>#{dowloaded_file}</font> folder</font> <br />"
@@ -25,7 +33,8 @@ post '/sample4' do
 
   rescue Exception => e
     err = e.message
-  end  
-  
+  end
+
+  # set variables for template
   haml :sample4, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :file_id => settings.file_id, :massage => massage, :err => err }
 end