groupdocs 1.5.0 → 1.5.1

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

@@ -12,18 +12,18 @@ post '/sample14' do
 
   begin
     # check required variables
-    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.folder.empty?
+    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})
+    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})
+    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 }
+  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

@@ -11,10 +11,10 @@ post '/sample15' do
 
   begin
     # check required variables
-    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty?
+    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})
+    views = GroupDocs::Document.views!({}, {:client_id => settings.client_id, :private_key => settings.private_key})
     total = views.count()
 
   rescue Exception => e
@@ -22,5 +22,5 @@ post '/sample15' do
   end
 
   # set variables for template
-  haml :sample15, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :total => total, :err => err }
+  haml :sample15, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :total => total, :err => err}
 end

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

@@ -10,7 +10,7 @@ post '/sample16' do
 
   begin
     # check required variables
-    raise "Please enter all required parameters" if settings.fileId.empty?
+    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>"
@@ -20,5 +20,5 @@ post '/sample16' do
   end
 
   # set variables for template
-  haml :sample16, :locals => { :fileId => settings.fileId, :iframe => iframe, :err => err }
+  haml :sample16, :locals => {:fileId => settings.fileId, :iframe => iframe, :err => err}
 end

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

@@ -12,7 +12,7 @@ post '/sample17' do
 
   begin
     # check required variables
-    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file.nil?
+    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]}"
@@ -32,5 +32,5 @@ post '/sample17' do
   end
 
   # set variables for template
-  haml :sample17, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :iframe=>iframe, :massage => massage, :err => err }
+  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

@@ -3,91 +3,42 @@ get '/sample18' do
   haml :sample18
 end
 
-post '/sample18/test_callback' do
-    downloads_path = "#{File.dirname(__FILE__)}/../public/downloads"
-    unless File.directory?(downloads_path)
-      Dir::mkdir(downloads_path)
-    else
-      Dir.foreach(downloads_path) {|f| fn = File.join(downloads_path, f); File.delete(fn) if f != '.' && f != '..'}
-    end
-
-    SourceId = nil
-    client_key = nil
-    private_key = nil
-    
-    data = JSON.parse(request.body.read)
-    data.each do |key, value|
-      if key == 'SourceId'
-        SourceId = value
-      end
-    end
-
-    if File.exist?("#{File.dirname(__FILE__)}/../public/user_info.txt")
-      contents = File.read("#{File.dirname(__FILE__)}/../public/user_info.txt")
-      contents = contents.split(' ')
-      client_key = contents.first
-      private_key = contents.last
-    end
-
-    outFile = File.new("#{File.dirname(__FILE__)}/../public/downloads/signed", "w")
-    outFile.write("private_key: #{private_key} \n")
-    outFile.write("client_key: #{client_key} \n")
-    outFile.write("SourceId: #{SourceId} \n")
-    outFile.close
-
-    job = GroupDocs::Job.new({:id=>SourceId})
-    documents = job.documents!({:client_id => client_key, :private_key => private_key})
-    tttt = documents[:inputs].first.file.download!(downloads_path, {:client_id => client_key, :private_key => private_key})
-
-    outFile = File.new("#{File.dirname(__FILE__)}/../public/downloads/t", "w")
-    outFile.write("documents: #{documents} \n")
-    outFile.write("tttt: #{tttt} \n")
-    outFile.close
-end
-
-# GET request to check if envelop was signed
-get '/sample18/test_check' do
-  if File.exist?("#{File.dirname(__FILE__)}/../public/downloads/signed")
-    File.readlines("#{File.dirname(__FILE__)}/../public/downloads/signed").each do |line|
-    end
-  else 
-    'not yet'
-  end
-end
-
-# 
+# POST request
 post '/sample18/convert_callback' do
+  # Set download path
   downloads_path = "#{File.dirname(__FILE__)}/../public/downloads"
-  unless File.directory?(downloads_path)
-    Dir::mkdir(downloads_path)
-  else
-    Dir.foreach(downloads_path) {|f| fn = File.join(downloads_path, f); File.delete(fn) if f != '.' && f != '..'}
-  end
- 
+
+  # Get callback request
   data = JSON.parse(request.body.read)
   begin
-    raise "Empty params!" if data.empty?
-    SourceId = nil
-    client_key = nil
+    raise 'Empty params!' if data.empty?
+    source_id = nil
+    client_id = nil
     private_key = nil
 
-
+    # Get value of SourceId
     data.each do |key, value|
       if key == 'SourceId'
-        SourceId = value
+        source_id = value
       end
     end
 
+    # Get private key and client_id from file user_info.txt
     if File.exist?("#{File.dirname(__FILE__)}/../public/user_info.txt")
       contents = File.read("#{File.dirname(__FILE__)}/../public/user_info.txt")
       contents = contents.split(' ')
-      client_key = contents.first
+      client_id = contents.first
       private_key = contents.last
     end
 
-    job = GroupDocs::Job.new({:id=>SourceId})
-    documents = job.documents!({:client_id => client_key, :private_key => private_key})
-    documents[:inputs].first.file.download!(downloads_path, {:client_id => client_key, :private_key => private_key})
+    # Create Job instance
+    job = GroupDocs::Job.new({:id => source_id})
+
+    # Get document by job id
+    documents = job.documents!({:client_id => client_id, :private_key => private_key})
+
+    # Download converted file
+    documents[:inputs].first.outputs.first.download!(downloads_path, {:client_id => client_id, :private_key => private_key})
 
   rescue Exception => e
     err = e.message
@@ -95,23 +46,27 @@ post '/sample18/convert_callback' do
 end
 
 
-# 
+# GET request
 get '/sample18/check' do
-  
+
+  # Check is there download directory
   unless File.directory?("#{File.dirname(__FILE__)}/../public/downloads")
-    return "Directory was not found."
+    return 'Directory was not found.'
   end
 
+  # Get file name from download directory
   name = nil
   Dir.entries("#{File.dirname(__FILE__)}/../public/downloads").each do |file|
     name = file if file != '.' && file != '..'
   end
 
-  if name
-    return name
-  else
-    return "File was not found."
-  end
+  name
+end
+
+# GET request
+get '/sample18/downloads/:filename' do |filename|
+  # Send file with header to download it
+  send_file "#{File.dirname(__FILE__)}/../public/downloads/#{filename}", :filename => filename, :type => 'Application/octet-stream'
 end
 
 
@@ -120,48 +75,77 @@ post '/sample18' do
   # set variables
   set :client_id, params[:client_id]
   set :private_key, params[:private_key]
+  set :source, params[:source]
   set :file_id, params[:fileId]
+  set :url, params[:url]
   set :convert_type, params[:convert_type]
   set :callback, params[:callback]
 
+  # Set download path
+  downloads_path = "#{File.dirname(__FILE__)}/../public/downloads"
+
+  # Remove all files from download directory or create folder if it not there
+  if File.directory?(downloads_path)
+    Dir.foreach(downloads_path) { |f| fn = File.join(downloads_path, f); File.delete(fn) if f != '.' && f != '..' }
+  else
+    Dir::mkdir(downloads_path)
+  end
+
   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?
-   
+    raise 'Please enter all required parameters' if settings.client_id.empty? or settings.private_key.empty?
+
+    # Write client and private key to the file for callback job
     if settings.callback[0]
-      outFile = File.new("#{File.dirname(__FILE__)}/../public/user_info.txt", "w")
-      outFile.write("#{settings.client_id} ")
-      outFile.write("#{settings.private_key}")
-      outFile.close
+      out_file = File.new("#{File.dirname(__FILE__)}/../public/user_info.txt", 'w')
+      # white space is required
+      out_file.write("#{settings.client_id} ")
+      out_file.write("#{settings.private_key}")
+      out_file.close
     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})
     file = nil
 
-    # get document by file ID
-    files_list.each do |element|
-      if element.respond_to?('guid') == true and element.guid == settings.file_id
-        file = element
-      end
+    # get document by file GUID
+    case settings.source
+      when 'guid'
+        # Create instance of File
+        file = GroupDocs::Storage::File.new({:guid => settings.file_id})
+      when 'local'
+        # construct path
+        file_path = "#{Dir.tmpdir}/#{params[:file][:filename]}"
+        # open file
+        File.open(file_path, 'wb') { |f| f.write(params[:file][:tempfile].read) }
+        # make a request to API using client_id and private_key
+        file = GroupDocs::Storage::File.upload!(file_path, {}, {:client_id => settings.client_id, :private_key => settings.private_key})
+      when 'url'
+        # Upload file from defined url
+        file = GroupDocs::Storage::File.upload_web!(settings.url, {:client_id => settings.client_id, :private_key => settings.private_key})
+      else
+        raise 'Wrong GUID source.'
     end
 
-    message = "No file with such GUID"
-    unless file.nil?
-
-      document = file.to_document
-      # convert file
-      convert = document.convert!(settings.convert_type, {:callback=>settings.callback}, {:client_id => settings.client_id, :private_key => settings.private_key})
-      sleep(10)
-
-      original_document = convert.documents!({:client_id => settings.client_id, :private_key => settings.private_key})
-      # TODO: add Exception if not enough time for convertation
-      guid = original_document[:inputs].first.outputs.first.guid
-      
-      if guid
-        iframe = "<iframe src='https://apps.groupdocs.com/document-viewer/embed/#{guid}' frameborder='0' width='100%' height='600'></iframe>"
-        message = "<p>Converted file saved successfully."
-      end
+    # Raise exception if something went wrong
+    raise 'No such file' unless file.is_a?(GroupDocs::Storage::File)
+
+    # Make document from file
+    document = file.to_document
+    # convert document
+    convert = document.convert!(settings.convert_type, {:callback => settings.callback}, {:client_id => settings.client_id, :private_key => settings.private_key})
+    # waite 10 seconds for while file converting
+    sleep(10)
+
+    # Get array of changes in document from job
+    original_document = convert.documents!({:client_id => settings.client_id, :private_key => settings.private_key})
+
+    # Get converted document GUID
+    guid = original_document[:inputs].first.outputs.first.guid
+
+    # Set iframe with document GUID or raise an error
+    if guid
+      iframe = "<iframe width='100%' height='600' frameborder='0' src='https://apps.groupdocs.com/document-viewer/embed/#{guid}'></iframe>"
+    else
+      raise 'File was not converted'
     end
 
   rescue Exception => e
@@ -169,5 +153,5 @@ post '/sample18' do
   end
 
   # set variables for template
-  haml :sample18, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :fileId => settings.file_id, :message => message, :iframe => iframe, :err => err }
+  haml :sample18, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :callback => settings.callback, :fileId => file, :converted => guid, :iframe => iframe, :err => err}
 end

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

@@ -14,10 +14,10 @@ post '/sample19' do
 
   begin
     # check required variables
-    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.sourceFileId.empty? or settings.targetFileId.empty?
+    raise 'Please enter all required parameters' if settings.client_id.empty? or settings.private_key.empty? or settings.sourceFileId.empty? or settings.targetFileId.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})
+    files_list = GroupDocs::Storage::Folder.list!('/', {}, {:client_id => settings.client_id, :private_key => settings.private_key})
 
     source_document = ''
     target_document = ''
@@ -34,7 +34,7 @@ post '/sample19' do
 
     unless source_document.instance_of? String and target_document.instance_of? String
 
-      info = source_document.to_document.compare!(target_document.to_document, {:client_id => settings.client_id, :private_key => settings.private_key});
+      info = source_document.to_document.compare!(target_document.to_document, {:client_id => settings.client_id, :private_key => settings.private_key})
       sleep(5)
 
       # get job by ID
@@ -42,7 +42,7 @@ post '/sample19' do
       # get all job documents
       documents = job.documents!({:client_id => settings.client_id, :private_key => settings.private_key})
       # get compared file giud
-      guid =  documents[:outputs].first.file.guid
+      guid = documents[:outputs].first.file.guid
 
       # construct result iframe
       iframe = "<iframe src='https://apps.groupdocs.com/document-viewer/embed/#{guid}' frameborder='0' width='100%' height='600'></iframe>"
@@ -54,5 +54,5 @@ post '/sample19' do
   end
 
   # set variables for template
-  haml :sample19, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :sourceFileId => settings.sourceFileId, :targetFileId => settings.targetFileId, :callbackUrl => settings.callbackUrl, :iframe => iframe, :err => err }
+  haml :sample19, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :sourceFileId => settings.sourceFileId, :targetFileId => settings.targetFileId, :callbackUrl => settings.callbackUrl, :iframe => iframe, :err => err}
 end

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

@@ -11,19 +11,19 @@ post '/sample2' do
 
   begin
     # check required variables
-    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty?
+    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
-    files_list = GroupDocs::Storage::Folder.list!('/', {}, { :client_id => settings.client_id, :private_key => settings.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
 
   # set variables for template
-  haml :sample2, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :filelist => filelist, :err => err }
+  haml :sample2, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :filelist => filelist, :err => err}
 end

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

@@ -13,7 +13,7 @@ post '/sample20' do
   begin
 
     # check required variables
-    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.resultFileId.empty?
+    raise 'Please enter all required parameters' if settings.client_id.empty? or settings.private_key.empty? or settings.resultFileId.empty?
 
     # construct new storage file
     file = GroupDocs::Storage::File.new(guid: settings.resultFileId)
@@ -22,7 +22,7 @@ post '/sample20' do
     # get compare changes
     changes = document.changes!({:client_id => settings.client_id, :private_key => settings.private_key})
 
-    result = ""
+    result = ''
     result += "<table class='border'>"
     result += "<tr><td><font color='green'>Change Name</font></td><td><font color='green'>Change</font></td></tr>"
     changes.each do |change|
@@ -39,12 +39,12 @@ post '/sample20' do
       result += "<tr bgcolor='#808080'><td></td><td></td></tr>"
     end
 
-    result += "</table>"
+    result += '</table>'
 
   rescue Exception => e
     err = e.message
   end
 
   # set variables for template
-  haml :sample20, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :resultFileId => settings.resultFileId, :result => result, :err => err }
+  haml :sample20, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :resultFileId => settings.resultFileId, :result => result, :err => err}
 end

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

@@ -16,7 +16,7 @@ post '/sample21' do
   begin
 
     # check required variables
-    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.email.empty? or settings.name.empty? or settings.lastName.empty? or settings.file.nil?
+    raise 'Please enter all required parameters' if settings.client_id.empty? or settings.private_key.empty? or settings.email.empty? or settings.name.empty? or settings.lastName.empty? or settings.file.nil?
 
     # construct path
     filepath = "#{Dir.tmpdir}/#{params[:file][:filename]}"
@@ -28,7 +28,7 @@ post '/sample21' do
     # create envelope using user id and entered by user name
     envelope = GroupDocs::Signature::Envelope.new
     envelope.name = params[:file][:filename]
-    envelope.email_subject = "Sing this!"
+    envelope.email_subject = 'Sing this!'
     envelope.create!({}, client_id: settings.client_id, private_key: settings.private_key)
 
     # Add uploaded document to envelope
@@ -42,7 +42,7 @@ post '/sample21' do
     recipient.email = settings.email
     recipient.first_name = settings.name
     recipient.last_name = settings.lastName
-    recipient.role_id = roles.detect { |role| role.name == "Signer" }.id
+    recipient.role_id = roles.detect { |role| role.name == 'Signer' }.id
 
     # Add recipient to envelope
     add = envelope.add_recipient!(recipient, {client_id: settings.client_id, private_key: settings.private_key})
@@ -61,5 +61,5 @@ post '/sample21' do
   end
 
   # set variables for template
-  haml :sample21, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :email => settings.email, :name => settings.name, :lastName => settings.lastName, :iframe => iframe, :err => err }
+  haml :sample21, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :email => settings.email, :name => settings.name, :lastName => settings.lastName, :iframe => iframe, :err => err}
 end