• sample42.rb

  • ¶

    GET request

    get '/sample-42-how-to-download-document-with-annotations-using-groupdocs' do
      haml :sample42
    end
  • ¶

    POST request

    post '/sample-42-how-to-download-document-with-annotations-using-groupdocs' 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?
  • ¶

    Prepare base path

        if settings.base_path.empty?
          base_path = 'https://api.groupdocs.com'
        elsif settings.base_path.match('/v2.0')
          base_path = settings.base_path.split('/v2.0')[0]
        else
          base_path = settings.base_path
        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 = 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
  • ¶

    Add the signature in url

          iframe = "/document-annotation2/embed/#{document[0].guid}"
  • ¶

    Construct result string

          url = GroupDocs::Api::Request.new(:path => iframe).prepare_and_sign_url
  • ¶

    Generate iframe URL

          case base_path
            when 'https://stage-api-groupdocs.dynabic.com'
              iframe = "https://stage-api-groupdocs.dynabic.com#{url}"
            when 'https://dev-api-groupdocs.dynabic.com'
              iframe = "https://dev-apps.groupdocs.com#{url}"
            else
              iframe = "https://apps.groupdocs.com#{url}"
          end
    
          iframe = "<iframe width='100%' height='600' id='downloadframe' 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(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}\" download>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