groupdocs 1.6.0 → 1.7.0

data/groupdocs.gemspec

@@ -10,6 +10,8 @@ Gem::Specification.new do |s|
   s.summary     = 'Ruby SDK for GroupDocs REST API'
   s.description = 'Ruby SDK for GroupDocs REST API'
 
+  s.license = 'MIT'
+
   s.files        = `git ls-files`.split("\n")
   s.test_files   = `git ls-files -- {test,spec,features}/*`.split("\n")
   s.executables  = `git ls-files -- bin/*`.split("\n").map { |f| File.basename(f) }

data/lib/groupdocs/datasource/field.rb

@@ -8,6 +8,15 @@ module GroupDocs
     # @attr [Array<String>] values
     attr_accessor :values
 
+    # added in release 1.7.0
+    # @attr [String] contentType
+    attr_accessor :contentType
+    # @attr [List<GroupDocs::DataSource::Field>] nested_fields
+    attr_accessor :nested_fields
+    # @attr [String] regionName
+    attr_accessor :regionName
+    # @attr [String] dimension
+    attr_accessor :dimension
     #
     # Updates type with machine-readable format.
     #

data/lib/groupdocs/document.rb

@@ -7,6 +7,8 @@ module GroupDocs
     require 'groupdocs/document/metadata'
     require 'groupdocs/document/rectangle'
     require 'groupdocs/document/view'
+    require 'groupdocs/document/editor'
+    require 'groupdocs/document/style'
 
     ACCESS_MODES = {
         :private    => 0,
@@ -49,18 +51,22 @@ module GroupDocs
     #
     # Returns an array of all templates (documents in "Templates" directory).
     #
+    # @param [Hash] options Options
+    # @option options [String] :orderBy Order by column
+    # @option options [Boolean] :isAscending Order by ascending or descending
     # @param [Hash] access Access credentials
     # @option access [String] :client_id
     # @option access [String] :private_key
     # @return [Array<GroupDocs::Document>]
     #
     def self.templates!(options = {}, access = {})
-      json = Api::Request.new do |request|
+      api = Api::Request.new do |request|
         request[:access] = access
         request[:method] = :GET
         request[:path] = '/merge/{{client_id}}/templates'
-      end.execute!
-
+      end
+      api.add_params(options)
+      json = api.execute!
       json[:templates].map do |template|
         template.merge!(:file => Storage::File.new(template))
         Document.new(template)
@@ -199,7 +205,7 @@ module GroupDocs
 
     #added in release 1.6.0
     # @attr [String] fieldType
-    attr_accessor :fileType
+    attr_accessor :fieldType
     # @attr [Int] dependent_questionnaires_count
     attr_accessor :dependent_questionnaires_count
     # @attr [Long] upload_time
@@ -1462,5 +1468,61 @@ module GroupDocs
       end.execute!
     end
 
+    # added in release 1.7.0
+    #
+    # Get template fields.
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def editor_fields!(access = {})
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/doc/{{client_id}}/files/#{file.guid}/editor_fields"
+      end.execute!
+      json[:fields].map do |field|
+        TemplateEditorFields.new(field)
+      end
+    end
+
+    # added in release 1.7.0
+    #
+    # Create questionnaire template from file.
+    #
+    #  @example
+    #
+    # file = GroupDocs::Storage::File.new({:guid => '3be4e06494caed131d912c75e17d5f22592e3044032e0f81b35f13a8c9fefb49'}).to_document
+    # field = GroupDocs::Document::TemplateEditorFields.new
+    # field.name = 'test'
+    # field.fieldtype = 'TextBox'
+    # field.page = 1
+    # file.questionnaire_template!([field] )
+    #
+    #
+    # @param List[GroupDocs::Document::TemplateEditorFields] fields
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def questionnaire_template!(fields, access = {})
+
+      fields.each do |field|
+        field.is_a?(GroupDocs::Document::TemplateEditorFields) or raise ArgumentError,
+                                                                        "Fields should be List GroupDocs::Document::TemplateEditorFields objects, received: #{fields.inspect}"
+      end
+
+      json = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/files/#{file.guid}/templates"
+        request[:request_body] = fields
+      end.execute!
+      json[:templateFields].map do |field|
+        Document::Field.new(field)
+      end
+    end
+
   end # Document
 end # GroupDocs

data/lib/groupdocs/document/annotation.rb

@@ -6,10 +6,10 @@ module GroupDocs
 
     include Api::Helpers::AccessMode
 
-    #AnnotationType = { Text: 0, Area: 1, Point: 2, TextStrikeout: 3, Polyline: 4, TextField: 5, Watermark: 6,  TextReplacement: 7, TextRemoval: 8 }
+    #AnnotationType = { Text: 0, Area: 1, Point: 2, TextStrikeout: 3, Polyline: 4, TextField: 5, Watermark: 6,  TextReplacement: 7, Arrow: 8, TextRedaction 9, ResourceRedaction 10, TextUnderline 11, Distance 12, All 13 }
 
-    # updateed in release 1.6.0
-    TYPES  = %w(Text Area Point TextStrikeout Polyline TextField Watermark TextReplacement TextRemoval )
+    # updated in release 1.7.0
+    TYPES  = %w(Text Area Point TextStrikeout Polyline TextField Watermark TextReplacement Arrow TextRedaction ResourceRedaction ResourceRedaction TextUnderline Distance All)
 
     # @attr [GroupDocs::Document] document
     attr_accessor :document
@@ -54,7 +54,7 @@ module GroupDocs
     attr_accessor :serverTime
     #attr [Array]
 
-    #added in release 1.6.0
+    #added in release 1.7.0
     #@attr [Int] penColor
     attr_accessor :penColor
     #@attr [Int] penWidth
@@ -65,7 +65,10 @@ module GroupDocs
     attr_accessor :creatorName
     #@attr [Int] creatorEmail
     attr_accessor :creatorEmail
-
+    #@attr [Long] penColor
+    attr_accessor :layerId
+    #@attr [Int] penWidth
+    attr_accessor :backgroundColor
 
     # Compatibility with response JSON
     alias_method :annotationGuid=, :guid=
@@ -82,12 +85,14 @@ module GroupDocs
     alias_accessor :page_number,         :pageNumber
     alias_accessor :server_time,         :serverTime
 
-    #added in release 1.6.0
+    #added in release 1.7.0
     alias_accessor :pen_color,           :penColor
     alias_accessor :pen_width,           :penWidth
     alias_accessor :pen_style,           :penStyle
     alias_accessor :creator_name,        :creatorName
     alias_accessor :creator_email,       :creatorEmail
+    alias_accessor :layer_id,            :layerId
+    alias_accessor :background_color,    :backgroundColor
 
     #
     # Creates new GroupDocs::Document::Annotation.

data/lib/groupdocs/document/editor.rb

@@ -0,0 +1,53 @@
+# added in release 1.7.0
+module GroupDocs
+  class Document::TemplateEditorFields < Api::Entity
+
+    # @attr [Integer] page
+    attr_accessor :page
+    # @attr [String] name
+    attr_accessor :name
+    # @attr [String] type
+    attr_accessor :type
+    # @attr [GroupDocs::Document::Rectangle] rect
+    attr_accessor :rect
+    # @attr [String] fieldtype
+    attr_accessor :fieldtype
+    # @attr [Array] acceptableValues
+    attr_accessor :acceptableValues
+    # @attr [Int] selectionPosition
+    attr_accessor :selectionPosition
+    # @attr [Int] selectionLength
+    attr_accessor :selectionLength
+    # @attr [GroupDocs::Document::Style] style
+    attr_accessor :style
+    # @attr [Boolean] isTableMarker
+    attr_accessor :isTableMarker
+
+    #
+    # Converts passed hash to GroupDocs::Document::Rectangle object.
+    # @param [Hash] options
+    #
+    def rect=(rectangle)
+      if rectangle.is_a?(Hash)
+        rectangle = GroupDocs::Document::Rectangle.new(rectangle)
+      end
+
+      @rect = rectangle
+    end
+    #
+    # Converts passed hash to GroupDocs::Document::TemplateEditorFieldStyle object.
+    # @param [Hash] options
+    #
+    def style=(style)
+      if style.is_a?(Hash)
+        style = GroupDocs::Document::TemplateEditorFieldStyle.new(style)
+      end
+
+      @style = style
+    end
+
+    # Human-readable accessors
+    alias_accessor :rectangle, :rect
+
+  end # Document::TemplateEditorFields
+end # GroupDocs

data/lib/groupdocs/document/field.rb

@@ -18,6 +18,22 @@ module GroupDocs
     # @attr [Array] acceptableValues
     attr_accessor :acceptableValues
 
+    # added in release 1.7.0
+
+    # @attr [Int] selectionPosition
+    attr_accessor :selectionPosition
+    # @attr [Int] selectionLength
+    attr_accessor :selectionLength
+    # @attr [Boolean] isTableStartMarker
+    attr_accessor :isTableStartMarker
+    # @attr [Boolean] isTableEndMarker
+    attr_accessor :isTableEndMarker
+    # @attr [String] regionName
+    attr_accessor :regionName
+
+
+
+
     #
     # Coverts passed hash to GroupDocs::Document::Rectangle object.
     # @param [Hash] options

data/lib/groupdocs/document/style.rb

@@ -0,0 +1,30 @@
+# added in release 1.7.0
+module GroupDocs
+  class Document::TemplateEditorFieldStyle < Api::Entity
+
+    # @attr [String] fontName
+    attr_accessor :fontName
+    # @attr [String] fontSize
+    attr_accessor :fontSize
+    # @attr [String] color
+    attr_accessor :color
+    # @attr [String] backgroundColor
+    attr_accessor :backgroundColor
+    # @attr [String] borderWidth
+    attr_accessor :borderWidth
+    # @attr [String] borderColor
+    attr_accessor :borderColor
+    # @attr [String] textAlignment
+    attr_accessor :textAlignment
+
+    # Human-readable accessors
+    alias_accessor :font_name, :fontName
+    alias_accessor :font_size, :fontSize
+    alias_accessor :background_color, :backgroundColor
+    alias_accessor :border_width, :borderWidth
+    alias_accessor :border_color, :borderColor
+    alias_accessor :text_alignment, :textAlignment
+
+
+  end # Document::TemplateEditorFieldStyle
+end # GroupDocs

data/lib/groupdocs/job.rb

@@ -440,5 +440,29 @@ module GroupDocs
       byte_from_array(actions, ACTIONS)
     end
 
+    #added in release 1.7.0
+
+    #
+    # Get Possible Conversions.
+    #
+    # @example
+    #   GroupDocs::Job.get_conversions! "pdf"
+    #
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    # @param [String] file_ext File extension to check
+    #
+    def self.get_conversions!(access = {}, file_ext)
+      api = Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/async/{{client_id}}/possibleConversions/#{file_ext}"
+      end
+      json = api.execute!
+      json[:possibleConversions]
+    end
+
   end # Job
 end # GroupDocs

data/lib/groupdocs/questionnaire.rb

@@ -5,6 +5,8 @@ module GroupDocs
     require 'groupdocs/questionnaire/execution'
     require 'groupdocs/questionnaire/page'
     require 'groupdocs/questionnaire/question'
+    require 'groupdocs/questionnaire/collector_style'
+
 
     include Api::Helpers::Status
 

data/lib/groupdocs/questionnaire/collector.rb

@@ -279,5 +279,57 @@ module GroupDocs
 
     end
 
+    #
+    # Added in release 1.7.0
+    #
+    # Decorate questionnaire collector
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   style = GroupDocs::Questionnaire::QuestionnaireCollectorStyle.new
+    #   style.collectorId = collector.id
+    #   title = GroupDocs::Questionnaire::QuestionnaireCollectorStyle::Title.new
+    #   title.color = 'blue'
+    #   style.title = title
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def decorate!(style, access = {})
+      style.is_a?(GroupDocs::Questionnaire::QuestionnaireCollectorStyle) or raise ArgumentError,
+                                                       "Style should be GroupDocs::Questionnaire::QuestionnaireCollectorStyle object, received: #{style.inspect}"
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :POST
+        request[:path] = "/merge/{{client_id}}/questionnaires/collectors/#{guid}/decorate"
+        request[:request_body] = style
+      end.execute!
+    end
+
+
+    #
+    # Added in release 1.7.0
+    #
+    # Returns questionnaire collector style
+    #
+    # @example
+    #   questionnaire = GroupDocs::Questionnaire.get!(1)
+    #   collector = questionnaire.collectors!.first
+    #   collector.decorate!
+    #
+    # @param [Hash] access Access credentials
+    # @option access [String] :client_id
+    # @option access [String] :private_key
+    #
+    def get_decorate!(access = {})
+      Api::Request.new do |request|
+        request[:access] = access
+        request[:method] = :GET
+        request[:path] = "/merge/{{client_id}}/questionnaires/collector/#{guid}/style"
+      end.execute!
+    end
+
   end # Questionnaire::Collector
 end # GroupDocs

data/lib/groupdocs/questionnaire/collector_style.rb

@@ -0,0 +1,54 @@
+# added in release 1.7.0
+module GroupDocs
+  class Questionnaire::QuestionnaireCollectorStyle < Api::Entity
+    require 'groupdocs/questionnaire/style/title'
+    require 'groupdocs/questionnaire/style/base_font'
+    require 'groupdocs/questionnaire/style/question_title'
+
+    # @attr [String] page
+    attr_accessor :collectorId
+    # @attr [GroupDocs::Questionnaire::Rectangle] title
+    attr_accessor :title
+    # @attr [GroupDocs::Questionnaire::Rectangle] questionTitle
+    attr_accessor :questionTitle
+    # @attr [GroupDocs::Questionnaire::Rectangle] baseFont
+    attr_accessor :baseFont
+
+    #
+    # Converts passed hash to GroupDocs::Questionnaire::QuestionnaireCollectorStyle::Title object.
+    # @param [Hash] options
+    #
+    def title=(title)
+      if title.is_a?(Hash)
+        title = GroupDocs::Questionnaire::QuestionnaireCollectorStyle::Title.new(title)
+      end
+
+      @title = title
+    end
+
+    #
+    # Converts passed hash to GroupDocs::Questionnaire::QuestionnaireCollectorStyle::QuestionTitle object.
+    # @param [Hash] options
+    #
+    def questionTitle=(questionTitle)
+      if questionTitle.is_a?(Hash)
+        questionTitle = GroupDocs::Questionnaire::QuestionnaireCollectorStyle::QuestionTitle.new(questionTitle)
+      end
+
+      @questionTitle = questionTitle
+    end
+    #
+    # Converts passed hash to GroupDocs::Questionnaire::QuestionnaireCollectorStyle::BaseFont object.
+    # @param [Hash] options
+    #
+    def baseFont=(baseFont)
+      if baseFont.is_a?(Hash)
+        baseFont = GroupDocs::Questionnaire::QuestionnaireCollectorStyle::BaseFont.new(baseFont)
+      end
+
+      @baseFont = baseFont
+    end
+
+
+  end # Document::QuestionnaireCollectorStyle
+end # GroupDocs