groupdocs 1.5.7 → 1.5.8

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

@@ -0,0 +1,59 @@
+%h3{:style => 'text-align:center;'}
+  %a{:href => '/'} GroupDocs Ruby SDK Samples
+  \- Sample42
+.samplecontent{:style => 'padding:10px;'}
+  %span.description
+    %i
+    This sample will show how to download document with annotations using GroupDocs Ruby SDK.
+
+  %br/
+  %br/
+  /
+  %span.documentation
+    %a{:href => '/docs/sample42.html'} Builtin documentation for this sample
+
+  %br/
+  %br/
+  %p
+    You entered:
+  %p
+    ClientID = #{(defined? userId) ? userId : ''}
+  %p
+    PrivateKey = #{(defined? privateKey) ? privateKey : ''}
+  %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 => '/sample42', :enctype => 'multipart/form-data', :method => 'post'}
+      %label{:for => 'clientId'} GroupDocs ClientID
+      %br/
+      %input{:type=>'text', :name=>'clientId'}
+      %br/
+      %label{:for => 'privateKey'} GroupDocs PrivateKey
+      %br/
+      %input{:type=>'text', :name=>'privateKey'}
+      %br/
+      %label{:for=>'fileId', :id=>'guid'} File ID (GUID)
+      %br/
+      %input{:type=>'text', :name=>'fileId'}
+      %br/
+      %label{:for => 'basePath'} Base Path
+      %span{:class => 'optional'} (Optional)
+      %br/
+      %input{:type=>'text', :name=>'basePath'}
+      %br/
+      %br/
+      %input{:type => 'submit', :value => 'Make request'}
+
+      %br/
+      %br/
+      %br/
+  %div{:style => 'padding:20px; border:1px solid black;'}
+    %p
+      Results:
+      %br/
+      #{(defined? message)? message : ''}
+      #{(defined? iframe) ? iframe : ''}
+
+= partial :_others_samples

data/lib/groupdocs/api/helpers/rest_helper.rb

@@ -37,12 +37,15 @@ module GroupDocs
           end
         end
 
+        #
+        # Changed in release 1.5.8
         #
         # Sends request to API server.
         #
         # @api private
         #
         def send_request
+
           self.response = case options[:method]
             when :get, :download
               resource[options[:path]].get(options[:headers])
@@ -51,7 +54,16 @@ module GroupDocs
             when :put
               resource[options[:path]].put(options[:request_body], options[:headers])
             when :delete
-              resource[options[:path]].delete(options[:headers])
+              if options[:request_body]
+              url = GroupDocs.api_server + options[:path]
+              RestClient::Request.execute(options.merge(
+                            :method => :delete,
+                            :url => url,
+                            :payload => options[:request_body],
+                            :headers => options[:headers]))
+              else
+                resource[options[:path]].delete(options[:headers])
+              end
             else
               raise UnsupportedMethodError, "Unsupported HTTP method: #{options[:method].inspect}"
           end

data/lib/groupdocs/datasource.rb

@@ -241,8 +241,9 @@ module GroupDocs
         request[:path] = "/merge/{{client_id}}/jobs/#{job.id}/files/#{file_id}/datasources"
         request[:request_body] = datasource.fields
       end.execute!
-
     end
 
+
+
   end # DataSource
 end # GroupDocs

data/lib/groupdocs/document.rb

@@ -178,7 +178,6 @@ module GroupDocs
         metadata.views_count = json[:views_count]
         if json[:last_view]
           metadata.last_view = json[:last_view]
-
         end
       end
     end
@@ -590,7 +589,7 @@ module GroupDocs
     # @example
     #   file = GroupDocs::Storage::Folder.list!.last
     #   document = file.to_document
-    #   document.thumbnails! first_page: 0, page_count: 1, passwordSalt: ***
+    #   document.representations! first_page: 0, page_count: 1, passwordSalt: ***
     #
     # @param [Hash] options
     # @option options [Integer] :page_number Start page to return image for (starting with 0)
@@ -645,7 +644,7 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
-        request[:path] = "/doc/{{client_id}}/files/#{file.guid}/accessinfo"
+        request[:path] = "/doc/{{client_id}}/files/#{file.id}/accessinfo"
       end
       api.add_params(:mode => ACCESS_MODES[mode])
       json = api.execute!
@@ -1061,6 +1060,7 @@ module GroupDocs
     end
 
     #
+    # Changed in release 1.5.8
     # Returns document details.
     #
     # @param [Hash] access Access credentials
@@ -1072,13 +1072,14 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/comparison/{{client_id}}/comparison/document"
+        request[:path] = "/comparison/{{client_id}}document"
       end
       api.add_params(:guid => file.guid)
       api.execute!
     end
 
     #
+    # Changed in release 1.5.8
     # Schedules a job for comparing document with given.
     #
     # @param [GroupDocs::Document] document
@@ -1096,7 +1097,7 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = "/comparison/{{client_id}}/comparison/compare"
+        request[:path] = "/comparison/{{client_id}}/compare"
       end
       api.add_params(:source => file.guid, :target => document.file.guid, :callback => callback)
       json = api.execute!
@@ -1124,10 +1125,9 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
-        request[:path] = "/comparison/{{client_id}}/comparison/changes"
+        request[:path] = "/comparison/public/#{file.guid}/changes"
         request[:request_body] = changes
       end
-      api.add_params(:resultFileId => file.guid)
       json = api.execute!
 
       json[:changes].map do |change|
@@ -1136,6 +1136,7 @@ module GroupDocs
     end
 
     #
+    # @Changed in realese 1.5.8
     # Returns an array of changes in document.
     #
     # @example
@@ -1154,9 +1155,8 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
-        request[:path] = '/comparison/{{client_id}}/comparison/changes'
+        request[:path] = '/comparison/public/#{file.guid}/changes'
       end
-      api.add_params(:resultFileId => file.guid)
       json = api.execute!
 
       json[:changes].map do |change|
@@ -1165,11 +1165,19 @@ module GroupDocs
     end
 
     #
+    # Changed in realese 1.5.8
     # Download comparison result file.
     #
+    # @example
+    #  document_one = GroupDocs::Storage::Folder.list![0].to_document
+    #  document_two = GroupDocs::Storage::Folder.list![1].to_document
+    #  job = document_one.compare!(document_two)
+    #  sleep(5) # wait for server to finish comparing
+    #  result = job.documents![:outputs].first
+    #  result.download!("#{File.dirname(__FILE__)}", {:format => 'pdf'})
+    #
     # @param [Hash] options
-    # @option format [String] :format Comparison result file GUID
-    # @option resultFileId [String] :resultFileId Comparison result file GUID
+    # @option format [String] :format Comparison result file GUID    #
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
@@ -1179,12 +1187,17 @@ module GroupDocs
       api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :DOWNLOAD
-        request[:path] = "/comparison/{{client_id}}/comparison/download"
+        request[:path] = "/comparison/public/#{file.guid}/download"
       end
       api.add_params(options)
       response = api.execute!
 
-      filepath = "#{path}/#{file.name}"
+      if file.name.split('.').last != options[:format]
+        file_name = file.name.delete!(file.name.split('.').last) +  options[:format]
+      else
+        file_name = file.name
+      end
+      filepath = "#{path}/#{file_name}"
       Object::File.open(filepath, 'wb') do |file|
         file.write(response)
       end
@@ -1357,6 +1370,7 @@ module GroupDocs
     # Pass all unknown methods to file.
     #
 
+
     def method_missing(method, *args, &blk)
       file.respond_to?(method) ? file.send(method, *args, &blk) : super
     end
@@ -1365,5 +1379,79 @@ module GroupDocs
       super or file.respond_to?(method)
     end
 
+
+    #
+    # added in release 1.5.8
+    #
+    # Returns document hyperlinks
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def hyperlinks!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/doc/{{client_id}}/files/#{file.guid}/hyperlinks"
+      end.execute!
+
+      json[:links]
+    end
+
+    #
+    # Changed in release 1.5.8
+    #
+    #
+    # Public Sign document
+    #
+    # @param [String] document Document GUID
+    # @param [Hash] settings Settings of the signing document
+    # @param settings [String] waterMarkText
+    # @param settings [String] waterMarkImage
+    # @param settings [String] name (required)
+    # @param settings [Double] top (required)
+    # @param settings [Double] left (required)
+    # @param settings [Double] width (required)
+    # @param settings [Double] height (required)
+    # @param settings [String] placeSignatureOn (required)
+    # @param settings [String] data
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def public_sign_document!(options = {}, access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/signature/public/documents/#{file.guid}/sign"
+        request[:request_body] = options
+      end.execute!
+
+      json[:jobId]
+    end
+
+    #
+    # Changed in release 1.5.8
+    #
+    #
+    # Get document fields
+    #
+    # @param [String] document Document GUID
+    # @param [Hash] settings Settings of the signing document
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @return [Array]
+    #
+    def self.public_fields!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/signature/public/documents/#{file.guid}/fields"
+      end.execute!
+    end
+
   end # Document
 end # GroupDocs

data/lib/groupdocs/document/annotation.rb

@@ -6,6 +6,8 @@ module GroupDocs
 
     include Api::Helpers::AccessMode
 
+    #AnnotationType = { Text: 0, Area: 1, Point: 2, TextStrikeout: 3, Polyline: 4, TextField: 5, Watermark: 6 }
+
     TYPES  = %w(Text Area Point TextStrikeout Polyline)
 
     # @attr [GroupDocs::Document] document
@@ -44,6 +46,13 @@ module GroupDocs
     #@attr [String]Font Color
     attr_accessor :fontColor
 
+    #added in release 1.5.8
+    #@attr [Int]pageNumber
+    attr_accessor :pageNumber
+    #@attr [Long] serverTime
+    attr_accessor :serverTime
+    #attr [Array]
+
     # Compatibility with response JSON
     alias_method :annotationGuid=, :guid=
 
@@ -54,8 +63,10 @@ module GroupDocs
     alias_accessor :reply_guid,          :replyGuid
     alias_accessor :created_on,          :createdOn
     alias_accessor :annotation_position, :annotationPosition
-    alias_accessor :position,            :annotationPosition
-
+   
+    #added in release 1.5.8
+    alias_accessor :page_number,         :pageNumber
+    alias_accessor :server_time,         :serverTime
 
     #
     # Creates new GroupDocs::Document::Annotation.
@@ -196,7 +207,7 @@ module GroupDocs
     # @option access [String] :client_id
     # @option access [String] :private_key
     #
-    def self.remove!(guid, access = {})
+    def remove!(access = {})
       Api::Request.new do |request|
         request[:access] = access
         request[:method] = :DELETE
@@ -240,28 +251,33 @@ module GroupDocs
       self.annotation_position = { :x => x, :y => y }
     end
 
+    #
+    # Changed in release 1.5.8
     #
     # Moves annotation marker to given coordinates.
     #
-    # @param [Integer, Float] x
-    # @param [Integer, Float] y
+    # @param [GroupDocs::Annotation::Marker] marker Marker position
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
     #
-    def move_marker!(x, y, access = {})
+    def move_marker!(marker, access = {})
+      marker.is_a?(GroupDocs::Document::Annotation::MarkerPosition) or raise ArgumentError,
+        "Marker should be GroupDocs::Document::Annotation::MarkerPosition object, received: #{marker.inspect}"
       Api::Request.new do |request|
         request[:access] = access
         request[:method] = :PUT
         request[:path] = "/ant/{{client_id}}/annotations/#{guid}/markerPosition"
-        request[:request_body] = { :x => x, :y => y }
+        request[:request_body] = marker
       end.execute!
 
-      if box
-        box.x = x
-        box.y = y
+      if box && page_number
+        box.x = marker.position[:x]
+        box.y = marker.position[:y]
+        page_number = marker.page
       else
-        self.box = { :x => x, :y => y }
+        self.box = { :x => marker.position[:x], :y => marker.position[:y] }
+        self.page_number = marker.page
       end
     end
 
@@ -300,9 +316,8 @@ module GroupDocs
         request[:path] = "/ant/{{client_id}}/annotations/#{guid}/size"
         request[:request_body] = { :width => x, :height => y }
       end.execute!
+        self.box = { :width => x, :height => y }
 
-      self.width = x
-      self.height = y
     end
 
     #

data/lib/groupdocs/document/annotation/marker.rb

@@ -0,0 +1,18 @@
+# added in release 1.5.8
+module GroupDocs
+  class Document::Annotation::MarkerPosition
+
+    #
+    # example
+    # marker = GroupDocs::Document::Annotation::MarkerPosition.new()
+    # marker.position = {:x => 100, :y => 100}
+    # marker.page = 1
+
+    # @attr [Array](x,y) position
+    attr_accessor :position
+
+    # @attr [Int] page
+    attr_accessor :page
+
+  end
+end

data/lib/groupdocs/document/annotation/reply.rb

@@ -49,16 +49,23 @@ module GroupDocs
     attr_accessor :userGuid
     # @attr [String] userName
     attr_accessor :userName
-    # @attr [String] text
-    attr_accessor :text
     # @attr [Time] repliedOn
     attr_accessor :repliedOn
 
+    # added in release 1.5.8
+    # @attr [String] parentReplyGuid
+    attr_accessor :parentReplyGuid
+    # @attr [Boolean] isAvatarExist
+    attr_accessor :isAvatarExist
+
     # Human-readable accessors
     alias_accessor :annotation_guid, :annotationGuid
     alias_accessor :user_guid,       :userGuid
     alias_accessor :user_name,       :userName
     alias_accessor :replied_on,      :repliedOn
+    # added in release 1.5.8
+    alias_accessor :parent_reply_guid, :parentReplyGuid
+    alias_accessor :is_avatar_exist,   :isAvatarExist
 
     #
     # Creates new GroupDocs::Document::Annotation.