groupdocs 1.5.7 → 1.5.8

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

@@ -0,0 +1,164 @@
+# GET request
+get '/sample40' do
+  haml :sample40
+end
+
+# POST request
+post '/sample40/check_guid' do
+  begin
+    result = nil
+    i = 0
+    for i in 1..10
+      i +=1
+      # Check is downloads folder exist
+      if File.exist?("#{File.dirname(__FILE__)}/../public/callback_info.txt")
+        result = File.read("#{File.dirname(__FILE__)}/../public/callback_info.txt")
+        if result != '' then break  end
+      end
+      sleep(5)
+    end
+
+    # Check result
+    if result == 'Error'
+      result = "File was not found. Looks like something went wrong."
+    else
+      result
+    end
+
+  rescue Exception => e
+    err = e.message
+  end
+end
+
+
+# POST request
+post '/sample40/callback' do
+
+  source_id = ''
+  client_id = ''
+  private_key = ''
+
+  # Get callback request
+  data = JSON.parse(request.body.read)
+  begin
+    participant = nil
+    raise 'Empty params!' if data.empty?
+
+    # Get value of SourceId
+    data.each do |key, value|
+      if key == 'SourceId'
+        source_id = value
+      end
+      if key == 'SerializedData'
+       data = JSON.parse(value)
+       data.each do |key, value|
+         if key == 'ParticipantGuid'
+           participant = value
+         end
+       end
+      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_id = contents[0]
+      private_key = contents[1]
+    end
+
+    # Create new Form
+    form = GroupDocs::Signature::Form.new({:id => source_id})
+     # Create new Signature
+    signature = GroupDocs::Signature.new()
+    doc_info = signature.get_sign_form_participant!(form.id , participant, {:client_id => client_id, :private_key => private_key} )
+
+    guid = doc_info[:documentGuid]
+
+    out_file = File.new("#{File.dirname(__FILE__)}/../public/callback_info.txt", 'w')
+     # white space is required
+    out_file.write(guid)
+    out_file.close
+
+  rescue Exception => e
+    err = e.message
+  end
+end
+
+
+
+# POST request
+post '/sample40' do
+  # set variables
+  set :client_id, params[:clientId]
+  set :private_key, params[:privateKey]
+  set :form_guid, params[:formGuid]
+  set :callback, params[:callbackUrl]
+  set :base_path, params[:basePath]
+
+  begin
+
+    # Check required variables
+    raise 'Please enter all required parameters' if settings.client_id.empty? or settings.private_key.empty? or settings.form_guid.empty?
+
+    if settings.base_path.empty? then settings.base_path = 'https://api.groupdocs.com' end
+
+    # Configure your access to API server
+    GroupDocs.configure do |groupdocs|
+      groupdocs.client_id = settings.client_id
+      groupdocs.private_key = settings.private_key
+      # Optionally specify API server and version
+      groupdocs.api_server = settings.base_path # default is 'https://api.groupdocs.com'
+    end
+
+    # Write client and private key to the file for callback job
+    if settings.callback
+      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
+
+    guid = settings.form_guid
+
+     # Create new Form with guid
+    form = GroupDocs::Signature::Form.new()
+    form.name = "Test Form"
+     # Get id with new Form
+    id = form.create!({:formId => guid})
+     # Get Form
+    form = GroupDocs::Signature::Form.get!(id)
+     # Publish the Form
+    form.publish!({:callbackUrl => settings.callback})
+
+     # Get url from request
+    case settings.base_path
+
+      when 'https://stage-api-groupdocs.dynabic.com'
+        url = "http://stage-apps-groupdocs.dynabic.com/signature2/forms/signembed/ #{guid}"
+      when 'https://dev-api-groupdocs.dynabic.com'
+        url = "http://dev-apps-groupdocs.dynabic.com/signature2/forms/signembed/ #{guid}"
+      else
+        url = "https://apps.groupdocs.com/signature2/forms/signembed/ #{guid}"
+    end
+     # Delete file callback_info.txt
+    if File.exist?("#{File.dirname(__FILE__)}/../public/callback_info.txt")
+      File.delete("#{File.dirname(__FILE__)}/../public/callback_info.txt")
+    end
+
+    # Add the signature to url the request
+    iframe = GroupDocs::Api::Request.new(:path => url).prepare_and_sign_url
+    iframe = "<iframe width='100%' id='downloadframe' height='600' src='#{iframe}'></iframe>"
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # Set variables for template
+  haml :sample40, :locals => {:userId => settings.client_id,
+                              :privateKey => settings.private_key,
+                              :callback => settings.callback,
+                              :iframe => iframe,
+                              :err => err}
+end

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

@@ -0,0 +1,118 @@
+# GET request
+get '/sample41' do
+  haml :sample41
+end
+
+# POST request
+post '/sample41' do
+  # set variables
+  set :client_id, params[:clientId]
+  set :private_key, params[:privateKey]
+  set :source, params[:source]
+  set :file_id, params[:fileId]
+  set :url, params[:url]
+  set :base_path, params[:basePath]
+
+  # 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?
+
+    if settings.base_path.empty? then settings.base_path = 'https://api.groupdocs.com' end
+
+    # Configure your access to API server
+    GroupDocs.configure do |groupdocs|
+      groupdocs.client_id = settings.client_id
+      groupdocs.private_key = settings.private_key
+      # Optionally specify API server and version
+      groupdocs.api_server = settings.base_path # default is 'https://api.groupdocs.com'
+    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, {})
+      when 'url'
+        # Upload file from defined url
+        file = GroupDocs::Storage::File.upload_web!(settings.url)
+      else
+        raise 'Wrong GUID source.'
+    end
+
+    # Raise exception if something went wrong
+    raise 'No such file' unless file.is_a?(GroupDocs::Storage::File)
+
+    # Make GroupDocs::Storage::Document instance
+    document = file.to_document
+
+    # Create Hash with the options for job. :status=> -1 means the Draft status of the job
+    options = {:actions => [:convert, :number_lines], :out_formats => ['doc'], :name => 'sample'}
+
+    # Create Job with provided options with Draft status (Sheduled job)
+    job = GroupDocs::Job.create!(options)
+
+    # Add the documents to previously created Job
+    job.add_document!(document, {:check_ownership => false})
+
+
+    # Update the Job with new status. :status => '0' mean Active status of the job (Start the job)
+    id = job.update!({:status => 'pending'})
+
+    i = 1
+
+    while i<5 do
+      sleep(5)
+      job = GroupDocs::Job.get!(id[:job_id])
+      break if job.status == :archived
+      i  = i + 1
+    end
+
+    # Get the document into Pdf format
+    file = job.documents!()
+
+    document = file[:inputs][0].outputs[0]
+
+    # Set iframe with document GUID or raise an error
+    if document
+
+      #Get url from request
+      case settings.base_path
+
+        when 'https://stage-api-groupdocs.dynabic.com'
+          url = "http://stage-apps-groupdocs.dynabic.com/document-viewer/embed/#{document.guid}"
+        when 'https://dev-api-groupdocs.dynabic.com'
+          url = "http://dev-apps-groupdocs.dynabic.com/document-viewer/embed/#{document.guid}"
+        else
+          url = "https://apps.groupdocs.com/document-viewer/embed/#{document.guid}"
+      end
+
+      # Add the signature in url
+      iframe = GroupDocs::Api::Request.new(:path => url).prepare_and_sign_url
+      iframe = "<iframe width='100%' height='600' frameborder='0' src='#{iframe}'></iframe>"
+    else
+      raise 'File was not converted'
+    end
+  rescue Exception => e
+    err = e.message
+  end
+
+  # Set variables for template
+  haml :sample41, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :err => err, :iframe => iframe}
+end

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

@@ -0,0 +1,97 @@
+# GET request
+get '/sample42' do
+  haml :sample42
+end
+
+# POST request
+post '/sample42' do
+  # set variables
+  set :client_id, params[:clientId]
+  set :private_key, params[:privateKey]
+  set :file_id, params[:fileId]
+  set :base_path, params[:basePath]
+
+  begin
+    # Check required variables
+    raise 'Please enter all required parameters' if settings.client_id.empty? or settings.private_key.empty?
+
+    if settings.base_path.empty? then settings.base_path = 'https://api.groupdocs.com' end
+
+    # Configure your access to API server
+    GroupDocs.configure do |groupdocs|
+      groupdocs.client_id = settings.client_id
+      groupdocs.private_key = settings.private_key
+      # Optionally specify API server and version
+      groupdocs.api_server = settings.base_path # default is 'https://api.groupdocs.com'
+    end
+
+    document = GroupDocs::Storage::File.new(:guid => settings.file_id).to_document
+
+    # Check, has document the annotations?
+    raise 'Your document has no annotations' if document.annotations!.empty?
+
+    # Create Hash with the options for job. :status=> -1 means the Draft status of the job
+    options = {:actions => [:import_annotations], :name => 'sample'}
+
+    # Create Job with provided options with Draft status (Sheduled job)
+    job = GroupDocs::Job.create!(options)
+
+    # Add the documents to previously created Job
+    job.add_document!(document, {:check_ownership => false})
+
+
+    # Update the Job with new status. :status => '0' mean Active status of the job (Start the job)
+    id = job.update!({:status => '0'})
+
+    i = 1
+
+    while i<5 do
+      sleep(5)
+      job = GroupDocs::Job.get!(id[:job_id])
+      break if job.status == :archived
+      i  = i + 1
+    end
+
+    # Get the document into Pdf format
+    file = job.documents!()
+
+    document = file[:inputs]
+
+    # Set iframe with document GUID or raise an error
+    if document
+
+      #Get url from request
+      case settings.base_path
+
+        when 'https://stage-api-groupdocs.dynabic.com'
+          url = "http://stage-apps-groupdocs.dynabic.com/document-annotation/embed/#{document[0].guid}"
+        when 'https://dev-api-groupdocs.dynabic.com'
+          url = "http://dev-apps-groupdocs.dynabic.com/document-annotation/embed/#{document[0].guid}"
+        else
+          url = "https://apps.groupdocs.com/document-annotation/embed/#{document[0].guid}"
+      end
+
+      # Add the signature in url
+      iframe = GroupDocs::Api::Request.new(:path => url).prepare_and_sign_url
+      iframe = "<iframe width='100%' height='600' frameborder='0' src='#{iframe}'></iframe>"
+
+      path = "#{File.dirname(__FILE__)}/../public/downloads"
+      # Remove all files from download directory or create folder if it not there
+      if File.directory?(path)
+        Dir.foreach(path) { |f| fn = File.join(downloads_path, f); File.delete(fn) if f != '.' && f != '..' }
+      else
+        Dir::mkdir(path)
+      end
+
+      GroupDocs::User.download!(path, document[0].outputs[0].name, document[0].outputs[0].guid)
+      message = "<span style=\"color:green\">File with annotations was downloaded to server's local folder. You can check them <a href=\"/downloads/#{document[0].outputs[0].name}\">here</a></span>"
+    else
+      raise 'File was not converted'
+    end
+  rescue Exception => e
+    err = e.message
+  end
+
+  # Set variables for template
+  haml :sample42, :locals => {:userId => settings.client_id, :privateKey => settings.private_key, :err => err, :iframe => iframe, :message => message}
+end

data/examples/api-samples/views/_others_samples.haml

@@ -2,23 +2,23 @@
   Choose another one sample:
   %ul
     %li
-      %a{:href => '/sample1'} Sample1 - How to login to GroupDocs using the API
+      %a{:href => '/sample01'} Sample01 - How to login to GroupDocs using the API
     %li
-      %a{:href => '/sample2'} Sample2 - How to list files within GroupDocs Storage using the Storage API
+      %a{:href => '/sample02'} Sample02 - How to list files within GroupDocs Storage using the Storage API
     %li
-      %a{:href => '/sample3'} Sample3 - How to upload a file to GroupDocs using the Storage API
+      %a{:href => '/sample03'} Sample03 - How to upload a file to GroupDocs using the Storage API
     %li
-      %a{:href => '/sample4'} Sample4 - How to download a file from GroupDocs Storage using the Storage API
+      %a{:href => '/sample04'} Sample04 - How to download a file from GroupDocs Storage using the Storage API
     %li
-      %a{:href => '/sample5'} Sample5 - How to copy / move a file using the GroupDocs Storage API
+      %a{:href => '/sample05'} Sample05 - How to copy / move a file using the GroupDocs Storage API
     %li
-      %a{:href => '/sample6'} Sample6 - How to add a Signature to a document in GroupDocs Signature
+      %a{:href => '/sample06'} Sample06 - How to add a Signature to a document in GroupDocs Signature
     %li
-      %a{:href => '/sample7'} Sample7 - How to create a list of thumbnails for a document
+      %a{:href => '/sample07'} Sample07 - How to create a list of thumbnails for a document
     %li
-      %a{:href => '/sample8'} Sample8 - How to return a URL representing a single page of a Document
+      %a{:href => '/sample08'} Sample08 - How to return a URL representing a single page of a Document
     %li
-      %a{:href => '/sample9'} Sample9 - How to generate an embedded Viewer URL for a Document
+      %a{:href => '/sample09'} Sample09 - How to generate an embedded Viewer URL for a Document
     %li
       %a{:href => '/sample10'} Sample10 - How to share a document to other users
     %li
@@ -68,6 +68,20 @@
     %li
       %a{:href => '/sample33'} Sample33 - How to convert and merge/combine several HTML documents into one PDF Document
     %li
-      %a{:href => '/annotation-sample'} Annotation sample
+      %a{:href => '/sample34'} Sample34 - How to create folder in the GroupDocs account
     %li
-      %a{:href => '/envelope-sample'} Envelop sample
+      %a{:href => '/sample35'} Sample35 - How to get fields and their data from PDF file
+    %li
+      %a{:href => '/sample36'} Sample36 - How to download signed documents when envelope was signed using Ruby SDK
+    %li
+      %a{:href => '/sample37'} Sample37 - How to create envelop and download signed document when envelop was signed using callback
+    %li
+      %a{:href => '/sample38'} Sample38 - How to create new user and add him as collaborator to doc with annotations
+    %li
+      %a{:href => '/sample39'} Sample39 - How to add a Signature to a document and redirect after signing with GroupDocs widget
+    %li
+      %a{:href => '/sample40'} Sample40 - How to set callback for signature form and re-direct when it was signed
+    %li
+      %a{:href => '/sample41'} Sample41 - How to add numeration in the doc file using GroupDocs Ruby SDK
+    %li
+      %a{:href => '/sample42'} Sample42 - How to download document with annotations using GroupDocs Ruby SDK

data/examples/api-samples/views/index.haml

@@ -2,23 +2,23 @@
 %div{:style => 'padding:10px;'}
   %ul
     %li
-      %a{:href => '/sample1'} Sample1 - How to login to GroupDocs using the API
+      %a{:href => '/sample01'} Sample01 - How to login to GroupDocs using the API
     %li
-      %a{:href => '/sample2'} Sample2 - How to list files within GroupDocs Storage using the Storage API
+      %a{:href => '/sample02'} Sample02 - How to list files within GroupDocs Storage using the Storage API
     %li
-      %a{:href => '/sample3'} Sample3 - How to upload a file to GroupDocs using the Storage API
+      %a{:href => '/sample03'} Sample03 - How to upload a file to GroupDocs using the Storage API
     %li
-      %a{:href => '/sample4'} Sample4 - How to download a file from GroupDocs Storage using the Storage API
+      %a{:href => '/sample04'} Sample04 - How to download a file from GroupDocs Storage using the Storage API
     %li
-      %a{:href => '/sample5'} Sample5 - How to copy / move a file using the GroupDocs Storage API
+      %a{:href => '/sample05'} Sample05 - How to copy / move a file using the GroupDocs Storage API
     %li
-      %a{:href => '/sample6'} Sample6 - How to add a Signature to a document in GroupDocs Signature
+      %a{:href => '/sample06'} Sample06 - How to add a Signature to a document in GroupDocs Signature
     %li
-      %a{:href => '/sample7'} Sample7 - How to create a list of thumbnails for a document
+      %a{:href => '/sample07'} Sample07 - How to create a list of thumbnails for a document
     %li
-      %a{:href => '/sample8'} Sample8 - How to return a URL representing a single page of a Document
+      %a{:href => '/sample08'} Sample08 - How to return a URL representing a single page of a Document
     %li
-      %a{:href => '/sample9'} Sample9 - How to generate an embedded Viewer URL for a Document
+      %a{:href => '/sample09'} Sample09 - How to generate an embedded Viewer URL for a Document
     %li
       %a{:href => '/sample10'} Sample10 - How to share a document to other users
     %li
@@ -68,6 +68,18 @@
     %li
       %a{:href => '/sample33'} Sample33 - How to convert and merge/combine several HTML documents into one PDF Document
     %li
-      %a{:href => '/annotation-sample'} Annotation sample
+      %a{:href => '/sample34'} Sample34 - How to create folder in the GroupDocs account
     %li
-      %a{:href => '/envelope-sample'} Envelop sample
+      %a{:href => '/sample35'} Sample35 - How to get fields and their data from PDF file
+    %li
+      %a{:href => '/sample36'} Sample36 - How to download signed documents when envelope was signed using Ruby SDK
+    %li
+      %a{:href => '/sample37'} Sample37 - How to create envelop and download signed document when envelop was signed using callback
+    %li
+      %a{:href => '/sample38'} Sample38 - How to create new user and add him as collaborator to doc with annotations
+    %li
+      %a{:href => '/sample39'} Sample39 - How to add a Signature to a document and re-direct after signing with GroupDocs widget
+    %li
+      %a{:href => '/sample41'} Sample41 - How to add numeration in the doc file using GroupDocs Ruby SDK
+    %li
+      %a{:href => '/sample42'} Sample42 - How to download document with annotations using GroupDocs Ruby SDK