groupdocs 1.2.11 → 1.3.0

data/.travis.yml

@@ -1,4 +1,6 @@
 language: ruby
 rvm:
+  - 1.8.7
   - 1.9.2
   - 1.9.3
+  - 2.0.0

data/Gemfile

@@ -1,3 +1,3 @@
-source :rubygems
+source 'https://rubygems.org'
 
 gemspec

data/README.md

@@ -4,8 +4,6 @@ Ruby SDK for [GroupDocs](http://groupdocs.com) REST API.
 
 ## Installation
 
-GroupDocs requires Ruby 1.9. Ruby 1.8 is not supported!
-
 Install as usually
 
     gem install groupdocs

data/Rakefile

@@ -6,4 +6,4 @@ RSpec::Core::RakeTask.new do |spec|
   spec.pattern = 'spec/**/*_spec.rb'
 end
 
-task default: :spec
+task :default => :spec

data/examples/api-samples/Gemfile

@@ -1,5 +1,5 @@
 source :rubygems
 
 gem 'sinatra'
-gem 'groupdocs', "1.2"
+gem 'groupdocs', "1.2.10"
 gem 'haml'

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

@@ -0,0 +1,50 @@
+# GET request
+get '/annotation-sample' do
+  haml :annotation_sample
+end
+
+# POST request
+post '/annotation-sample' do
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :file_name, params[:file_name]
+
+  begin
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.file_name.empty?
+
+    GroupDocs.configure do |groupdocs|
+      groupdocs.client_id = params[:client_id]
+      groupdocs.private_key = params[:private_key]
+      groupdocs.api_server = 'https://api.groupdocs.com'
+    end
+    # get document metadata
+    metadata = GroupDocs::Document.metadata!('resume.pdf')
+    document = GroupDocs::Storage::File.new(id: metadata.id, guid: metadata.guid).to_document
+     
+    # create new user
+    user = GroupDocs::User.new
+    user.nickname = 'test_account'
+    user.primary_email = 'test_email@email.com'
+    user.first_name = 'First name'
+    user.last_name = 'Last name'
+    user = GroupDocs::User.update_account!(user)
+     
+    # add collaborator
+    document.add_collaborator! user unless document.collaborators!.any? { |c| c.guid == user.guid }
+     
+    # build url
+    annotation = true # looks like "IsAnnotation" is some helper method so I stub it here
+    url = if annotation
+    "/document-annotation2/embed?quality=50&guid=#{document.file.guid}&uid=#{user.guid}&download=True"
+    else
+    "/document-viewer/embed?quality=50&guid=#{document.file.guid}&uid=#{user.guid}&download=True"
+    end
+
+    url = GroupDocs::Api::Request.new(path: url).prepare_and_sign_url
+    iframe_url = "https://apps.groupdocs.com#{url}"
+  rescue Exception => e
+    err = e.message
+  end
+
+  haml :annotation_sample, :locals => { :client_id => settings.client_id, :private_key => settings.private_key, :err => err, :file_name => settings.file_name, :iframe_url => iframe_url}
+end

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

@@ -27,11 +27,12 @@ post '/sample18' do
     end
 
     message = ""
+    iframe = ""
     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)
+      sleep(5)
 
       if convert.instance_of? GroupDocs::Job
         # get all jobs
@@ -46,6 +47,14 @@ post '/sample18' do
         end
 
         if job.status == :archived
+          # get job by ID
+          job = GroupDocs::Job.new(id: convert.id)
+          # get all job documents
+          documents = job.documents!({:client_id => settings.client_id, :private_key => settings.private_key})
+          # get compared file giud
+          guid =  documents[:inputs].first.outputs.first.guid
+          # construct result iframe
+          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
 
@@ -57,5 +66,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, :err => err }
+  haml :sample18, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :fileId => settings.file_id, :message => message, :iframe => iframe, :err => err }
 end

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

@@ -0,0 +1,58 @@
+# GET request
+get '/sample19' do
+  haml :sample19
+end
+
+# POST request
+post '/sample19' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :sourceFileId, params[:sourceFileId]
+  set :targetFileId, params[:targetFileId]
+  set :callbackUrl, params[:callbackUrl]
+
+  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?
+
+    # 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})
+
+    source_document = ''
+    target_document = ''
+
+    # get source and target documents by file ID
+    files_list.each do |element|
+      if element.respond_to?('guid') == true and element.guid == settings.sourceFileId
+        source_document = element
+      end
+      if element.respond_to?('guid') == true and element.guid == settings.targetFileId
+        target_document = element
+      end
+    end
+
+    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});
+      sleep(5)
+
+      # get job by ID
+      job = GroupDocs::Job.new(id: info.id)
+      # 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
+
+      # construct result iframe
+      iframe = "<iframe src='https://apps.groupdocs.com/document-viewer/embed/#{guid}' frameborder='0' width='100%' height='600'></iframe>"
+
+    end
+
+  rescue Exception => e
+    err = e.message
+  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 }
+end

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

@@ -0,0 +1,50 @@
+# GET request
+get '/sample20' do
+  haml :sample20
+end
+
+# POST request
+post '/sample20' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :resultFileId, params[:resultFileId]
+
+  begin
+
+    # check required variables
+    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)
+    # construct new document
+    document = GroupDocs::Document.new(file: file)
+    # get compare changes
+    changes = document.changes!({:client_id => settings.client_id, :private_key => settings.private_key})
+
+    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|
+      result += "<tr><td>id</td><td>#{change.id}</td></tr>"
+      result += "<tr><td>type</td><td>#{change.type}</td></tr>"
+      result += "<tr><td>text</td><td>#{change.text}</td></tr>"
+      result += "<tr><td>page id</td><td>#{change.page[:Id]}</td></tr>"
+      result += "<tr><td>page weight</td><td>#{change.page[:Width]}</td></tr>"
+      result += "<tr><td>page height</td><td>#{change.page[:Height]}</td></tr>"
+      result += "<tr><td>box x</td><td>#{change.box.x}</td></tr>"
+      result += "<tr><td>box y</td><td>#{change.box.y}</td></tr>"
+      result += "<tr><td>box weight</td><td>#{change.box.width}</td></tr>"
+      result += "<tr><td>box height</td><td>#{change.box.height}</td></tr>"
+      result += "<tr bgcolor='#808080'><td></td><td></td></tr>"
+    end
+
+    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 }
+end

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

@@ -0,0 +1,65 @@
+# GET request
+get '/sample21' do
+  haml :sample21
+end
+
+# POST request
+post '/sample21' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :email, params[:email]
+  set :name, params[:name]
+  set :lastName, params[:lastName]
+  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.email.empty? or settings.name.empty? or settings.lastName.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)
+
+    # 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.create!({}, client_id: settings.client_id, private_key: settings.private_key)
+
+    # Add uploaded document to envelope
+    envelope.add_document!(file.to_document, {}, {client_id: settings.client_id, private_key: settings.private_key})
+
+    # Get role list for current user
+    roles = GroupDocs::Signature::Role.get!({}, {client_id: settings.client_id, private_key: settings.private_key})
+
+    # Create new recipient
+    recipient = GroupDocs::Signature::Recipient.new
+    recipient.email = settings.email
+    recipient.first_name = settings.name
+    recipient.last_name = settings.lastName
+    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})
+
+    # get recipient id
+    recipient_id = add[:recipient][:id]
+
+    # Send envelop
+    envelope.send!(nil, {client_id: settings.client_id, private_key: settings.private_key})
+
+    # Make iframe
+    iframe = "<iframe src='https://apps.groupdocs.com/signature/signembed/#{envelope.id}/#{recipient_id}' frameborder='0' width='720' height='600'></iframe>"
+
+  rescue Exception => e
+    err = e.message
+  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 }
+end

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

@@ -0,0 +1,52 @@
+# GET request
+get '/sample22' do
+  haml :sample22
+end
+
+# POST request
+post '/sample22' do
+  # set variables
+  set :client_id, params[:client_id]
+  set :private_key, params[:private_key]
+  set :fileId, params[:fileId]
+  set :email, params[:email]
+  set :first_name, params[:first_name]
+  set :last_name, params[:last_name]
+
+  begin
+
+    # check required variables
+    raise "Please enter all required parameters" if settings.client_id.empty? or settings.private_key.empty? or settings.fileId.empty? or settings.email.empty? or settings.first_name.empty? or settings.last_name.empty?
+
+    # create new user
+    user = GroupDocs::User.new
+    user.primary_email = settings.email
+    user.nickname = settings.first_name
+    user.first_name = settings.first_name
+    user.last_name = settings.last_name
+
+    # update account
+    GroupDocs::User.update_account!(user, {client_id: settings.client_id, private_key: settings.private_key})
+
+    # create file from GUID
+    file = GroupDocs::Storage::File.new(guid: settings.fileId)
+
+    # create document from file
+    document = GroupDocs::Document.new(file: file)
+
+    # set new collaboration
+    document.set_collaborators!([settings.email], 2, {:client_id => settings.client_id, :private_key => settings.private_key})
+
+    # get all collaborations
+    collaborations = document.collaborators!({:client_id => settings.client_id, :private_key => settings.private_key})
+
+    # set document reviewers
+    document.set_reviewers!(collaborations, {:client_id => settings.client_id, :private_key => settings.private_key})
+
+  rescue Exception => e
+    err = e.message
+  end
+
+  # set variables for template
+  haml :sample22, :locals => { :userId => settings.client_id, :privateKey => settings.private_key, :fileId => settings.fileId, :email => settings.email, :first_name => settings.first_name, :last_name => settings.last_name }
+end

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

@@ -0,0 +1,64 @@
+%h3{:style => "text-align:center;"}
+  %a{:href => "/"} GroupDocs Ruby SDK Samples
+  \- Envelope sample
+.samplecontent{:style => "padding:10px;"}
+  %i This sample will show how to use annotation and user API using Ruby SDK
+  %br/
+  %br/
+  %p
+    You entered:
+  %p
+    UserId = #{(defined? client_id) ? client_id : ""}
+  %p
+    PrivateKey = #{(defined? private_key) ? private_key : ""}
+  %p
+    File name = #{(defined? file_name) ? file_name : ""}
+  %p
+    %font{:color => "red"} #{(defined? err) ? err : ""}
+  %br/
+  #requestForm{:style => "padding:20px; border:1px solid black;"}
+    %p Enter data for request and press "Make request" button
+    %form{:action => "/annotation-sample", :enctype => "multipart/form-data", :method => "post"}
+      %label{:for => "client_id"} GroupDocs ClientID
+      %br/
+      %input{:type=>"text", :name=>"client_id"}
+      %br/
+      %label{:for => "private_key"} GroupDocs PrivateKey
+      %br/
+      %input{:type=>"text", :name=>"private_key"}
+      %br/
+      %label{:for => "file"} File name with extension (filename.doc)
+      %br/
+      %input{:type => "text", :name => "file_name" }/
+      %br/
+      %br/
+      %input{:type => "submit", :value => "Submit"}/
+    %div{:style => "padding:20px; border:1px solid black;"}
+      %p 
+        Results: 
+        %br/
+        #{(defined? iframe_url) ? iframe_url : ""}
+            
+%div{:style => "padding:10px;"}
+  Choose anothe one sample:
+  %ul
+    %li
+      %a{:href => "/sample1"} Sample1 - How to login to GroupDocs using the API
+    %li
+      %a{:href => "/sample2"} Sample2 - 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
+    %li
+      %a{:href => "/sample4"} Sample4 - 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
+    %li
+      %a{:href => "/sample6"} Sample6 - 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
+    %li
+      %a{:href => "/sample8"} Sample8 - 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
+    %li
+      %a{:href => "/sample10"} Sample10 - How to share a document to other users

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

@@ -37,5 +37,13 @@
       %a{:href => "/sample17"}Sample17 - How to upload a file into the storage and compress it into zip archive
     %li
       %a{:href => "/sample18"}Sample18 - How to convert Doc to Docx, Docx to Doc, Docx to PDF, PPT to PDF
+    %li
+      %a{:href => "/sample19"}Sample19 - How to Compare documents using Ruby SDK
+    %li
+      %a{:href => "/sample20"}Sample20 - How to Get Compare Change list for document using Ruby SDK
+    %li
+      %a{:href => "/sample21"}Sample21 - How to Create and Upload Envelop to GroupDocs account using Ruby SDK
+    %li
+      %a{:href => "/sample22"}Sample22 - How create or update user and add him to collaborators using PHP SDK
     %li
       %a{:href => "/envelope-sample"}Envelope sample - How to use envelope and signature API

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

@@ -50,7 +50,7 @@
         %br/
         %input{:type => "submit", :value => "Make Request"}/
 %div{:style => "padding:10px;"}
-  Choose anothe one sample:
+  Choose another one sample:
   %ul
     %li
       %a{:href => "/sample1"} Sample1 - How to login to GroupDocs using the API
@@ -88,5 +88,13 @@
       %a{:href => "/sample17"}Sample17 - How to upload a file into the storage and compress it into zip archive
     %li
       %a{:href => "/sample18"}Sample18 - How to convert Doc to Docx, Docx to Doc, Docx to PDF, PPT to PDF
+    %li
+      %a{:href => "/sample19"}Sample19 - How to Compare documents using Ruby SDK
+    %li
+      %a{:href => "/sample20"}Sample20 - How to Get Compare Change list for document using Ruby SDK
+    %li
+      %a{:href => "/sample21"}Sample21 - How to Create and Upload Envelop to GroupDocs account using Ruby SDK
+    %li
+      %a{:href => "/sample22"}Sample22 - How create or update user and add him to collaborators using PHP SDK
     %li
       %a{:href => "/envelope-sample"}Envelope sample - How to use envelope and signature API