aspose_pdf_cloud 24.7.0 → 24.9.0

data/lib/aspose_pdf_cloud/models/layer_info.rb

@@ -0,0 +1,239 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2024 Aspose.PDF Cloud
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+--------------------------------------------------------------------------------------------------------------------
+=end
+
+require 'date'
+require 'time'
+
+module AsposePdfCloud
+
+  class LayerInfo
+    # Layer Page Number.
+    attr_accessor :page_number
+
+    # Layer Id.
+    attr_accessor :id
+
+    # Layer Name.
+    attr_accessor :name
+
+    # Gets a value indicating whether the layer is locked.
+    attr_accessor :locked
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'page_number' => :'PageNumber',
+        :'id' => :'Id',
+        :'name' => :'Name',
+        :'locked' => :'Locked'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'page_number' => :'Integer',
+        :'id' => :'String',
+        :'name' => :'String',
+        :'locked' => :'BOOLEAN'
+      }
+    end
+
+    # Initializes the object
+    # @param [Hash] attributes Model attributes in the form of hash
+    def initialize(attributes = {})
+      return unless attributes.is_a?(Hash)
+
+      # convert string to symbol for hash key
+      attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
+
+      if attributes.has_key?(:'PageNumber')
+        self.page_number = attributes[:'PageNumber']
+      end
+
+      if attributes.has_key?(:'Id')
+        self.id = attributes[:'Id']
+      end
+
+      if attributes.has_key?(:'Name')
+        self.name = attributes[:'Name']
+      end
+
+      if attributes.has_key?(:'Locked')
+        self.locked = attributes[:'Locked']
+      end
+
+    end
+
+    # Show invalid properties with the reasons. Usually used together with valid?
+    # @return Array for valid properies with the reasons
+    def list_invalid_properties
+      invalid_properties = Array.new
+      if @page_number.nil?
+        invalid_properties.push("invalid value for 'page_number', page_number cannot be nil.")
+      end
+
+      if @locked.nil?
+        invalid_properties.push("invalid value for 'locked', locked cannot be nil.")
+      end
+
+      return invalid_properties
+    end
+
+    # Check to see if the all the properties in the model are valid
+    # @return true if the model is valid
+    def valid?
+      return false if @page_number.nil?
+      return false if @locked.nil?
+      return true
+    end
+
+    # Checks equality by comparing each attribute.
+    # @param [Object] Object to be compared
+    def ==(o)
+      return true if self.equal?(o)
+      self.class == o.class &&
+          page_number == o.page_number &&
+          id == o.id &&
+          name == o.name &&
+          locked == o.locked
+    end
+
+    # @see the `==` method
+    # @param [Object] Object to be compared
+    def eql?(o)
+      self == o
+    end
+
+    # Calculates hash code according to all attributes.
+    # @return [Fixnum] Hash code
+    def hash
+      [page_number, id, name, locked].hash
+    end
+
+    # Builds the object from hash
+    # @param [Hash] attributes Model attributes in the form of hash
+    # @return [Object] Returns the model itself
+    def build_from_hash(attributes)
+      return nil unless attributes.is_a?(Hash)
+      self.class.swagger_types.each_pair do |key, type|
+        if type =~ /\AArray<(.*)>/i
+          # check to ensure the input is an array given that the the attribute
+          # is documented as an array but the input is not
+          if attributes[self.class.attribute_map[key]].is_a?(Array)
+            self.send("#{key}=", attributes[self.class.attribute_map[key]].map{ |v| _deserialize($1, v) } )
+          end
+        elsif !attributes[self.class.attribute_map[key]].nil?
+          self.send("#{key}=", _deserialize(type, attributes[self.class.attribute_map[key]]))
+        end # or else data not found in attributes(hash), not an issue as the data can be optional
+      end
+
+      self
+    end
+
+    # Deserializes the data based on type
+    # @param string type Data type
+    # @param string value Value to be deserialized
+    # @return [Object] Deserialized data
+    def _deserialize(type, value)
+      case type.to_sym
+      when :DateTime
+        DateTime.parse(value)
+      when :Date
+        Date.parse(value)
+      when :String
+        value.to_s
+      when :Integer
+        value.to_i
+      when :Float
+        value.to_f
+      when :BOOLEAN
+        if value.to_s =~ /\A(true|t|yes|y|1)\z/i
+          true
+        else
+          false
+        end
+      when :Object
+        # generic object (usually a Hash), return directly
+        value
+      when /\AArray<(?<inner_type>.+)>\z/
+        inner_type = Regexp.last_match[:inner_type]
+        value.map { |v| _deserialize(inner_type, v) }
+      when /\AHash<(?<k_type>.+?), (?<v_type>.+)>\z/
+        k_type = Regexp.last_match[:k_type]
+        v_type = Regexp.last_match[:v_type]
+        {}.tap do |hash|
+          value.each do |k, v|
+            hash[_deserialize(k_type, k)] = _deserialize(v_type, v)
+          end
+        end
+      else # model
+        temp_model = AsposePdfCloud.const_get(type).new
+        temp_model.build_from_hash(value)
+      end
+    end
+
+    # Returns the string representation of the object
+    # @return [String] String presentation of the object
+    def to_s
+      to_hash.to_s
+    end
+
+    # to_body is an alias to to_hash (backward compatibility)
+    # @return [Hash] Returns the object in the form of hash
+    def to_body
+      to_hash
+    end
+
+    # Returns the object in the form of hash
+    # @return [Hash] Returns the object in the form of hash
+    def to_hash
+      hash = {}
+      self.class.attribute_map.each_pair do |attr, param|
+        value = self.send(attr)
+        next if value.nil?
+        hash[param] = _to_hash(value)
+      end
+      hash
+    end
+
+    # Outputs non-array value in the form of hash
+    # For object, use to_hash. Otherwise, just return the value
+    # @param [Object] value Any valid value
+    # @return [Hash] Returns the value in the form of hash
+    def _to_hash(value)
+      if value.is_a?(Array)
+        value.compact.map{ |v| _to_hash(v) }
+      elsif value.is_a?(Hash)
+        {}.tap do |hash|
+          value.each { |k, v| hash[k] = _to_hash(v) }
+        end
+      elsif value.respond_to? :to_hash
+        value.to_hash
+      else
+        value
+      end
+    end
+
+  end
+
+end

data/lib/aspose_pdf_cloud/models/optimize_options.rb

@@ -28,7 +28,7 @@ module AsposePdfCloud
     # Specifies document password (if any) encoded with base-64.
     attr_accessor :password
 
-    # If true page contents will be reused when document is optimized for equal pages.
+    # If true page contents will be reused when document is optimized for equal pages. LinkDuplcateStreams option must be set to true.
     attr_accessor :allow_reuse_page_content
 
     # If this flag is set to true images will be compressed in the document. Compression level is specified with ImageQuality property.
@@ -46,7 +46,7 @@ module AsposePdfCloud
     # If this flag set to true, every resource is checked on it's usage. If resource is never used, then resources is removed. This may decrease document size for example when pages were extracted from document. 
     attr_accessor :remove_unused_streams
 
-    # Make fonts not embedded if set to true. 
+    # Make fonts not embedded if set to true. Unembedding a font means removing the embedded byte stream data of the font included in a PDF document.
     attr_accessor :unembed_fonts
 
     # If this flag set to true and CompressImages is true images will be resized if image resolution is greater then specified MaxResolution parameter.
@@ -55,7 +55,7 @@ module AsposePdfCloud
     # Specifies maximum resolution of images. If image has higher resolution it will be scaled.
     attr_accessor :max_resolution
 
-    # Fonts will be converted into subsets if set to true.
+    # Fonts will be converted into subsets if set to true. Only those characters that are actually used in the layout are stored in the PDF. 
     attr_accessor :subset_fonts
 
     # Remove private information (page piece info).

data/lib/aspose_pdf_cloud/version.rb

@@ -20,5 +20,5 @@ SOFTWARE.
 =end
 
 module AsposePdfCloud
-  VERSION = "24.7.0"
+  VERSION = "24.9.0"
 end

data/lib/aspose_pdf_cloud.rb

@@ -56,6 +56,7 @@ require_relative 'aspose_pdf_cloud/models/doc_format'
 require_relative 'aspose_pdf_cloud/models/doc_mdp_access_permission_type'
 require_relative 'aspose_pdf_cloud/models/doc_recognition_mode'
 require_relative 'aspose_pdf_cloud/models/document_config'
+require_relative 'aspose_pdf_cloud/models/document_layers'
 require_relative 'aspose_pdf_cloud/models/document_privilege'
 require_relative 'aspose_pdf_cloud/models/epub_recognition_mode'
 require_relative 'aspose_pdf_cloud/models/error'
@@ -80,6 +81,7 @@ require_relative 'aspose_pdf_cloud/models/image_src_type'
 require_relative 'aspose_pdf_cloud/models/image_template'
 require_relative 'aspose_pdf_cloud/models/image_templates_request'
 require_relative 'aspose_pdf_cloud/models/justification'
+require_relative 'aspose_pdf_cloud/models/layer_info'
 require_relative 'aspose_pdf_cloud/models/letters_positioning_methods'
 require_relative 'aspose_pdf_cloud/models/line_ending'
 require_relative 'aspose_pdf_cloud/models/line_intent'

data/test/pdf_tests.rb

@@ -4702,6 +4702,39 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to add Text Stamp into page.')
   end
 
+  def test_post_document_text_stamps
+    file_name = 'PageNumberStamp.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    text_state = TextState.new
+    text_state.font_size = 14
+
+    stamp = TextStamp.new
+    stamp.background = true
+    stamp.left_margin = 1
+    stamp.right_margin = 2
+    stamp.top_margin = 3
+    stamp.bottom_margin = 4
+    stamp.horizontal_alignment = HorizontalAlignment::CENTER
+    stamp.vertical_alignment = VerticalAlignment::CENTER
+    stamp.opacity = 1
+    stamp.rotate = Rotation::NONE
+    stamp.rotate_angle = 0
+    stamp.x_indent = 0
+    stamp.y_indent = 0
+    stamp.zoom = 1
+    stamp.text_alignment = HorizontalAlignment::CENTER
+    stamp.value = 'Text Stamp'
+    stamp.text_state = text_state
+
+    response = @pdf_api.post_document_text_stamps(file_name, [stamp], opts)
+    assert(response, 'Failed to add Text Stamp into document.')
+  end
+
   def test_post_page_image_stamps
     file_name = 'PageNumberStamp.pdf'
     upload_file(file_name)
@@ -4735,6 +4768,37 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to add Image Stamp into page.')
   end
 
+  def test_post_document_image_stamps
+    file_name = 'PageNumberStamp.pdf'
+    upload_file(file_name)
+
+    image_name = 'Koala.jpg'
+    upload_file(image_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    stamp = ImageStamp.new
+    stamp.background = true
+    stamp.left_margin = 1
+    stamp.right_margin = 2
+    stamp.top_margin = 3
+    stamp.bottom_margin = 4
+    stamp.horizontal_alignment = HorizontalAlignment::CENTER
+    stamp.vertical_alignment = VerticalAlignment::CENTER
+    stamp.opacity = 1
+    stamp.rotate = Rotation::NONE
+    stamp.rotate_angle = 0
+    stamp.x_indent = 0
+    stamp.y_indent = 0
+    stamp.zoom = 1
+    stamp.file_name = @temp_folder + '/' + image_name
+
+    response = @pdf_api.post_document_image_stamps(file_name, [stamp], opts)
+    assert(response, 'Failed to add Image Stamp into document.')
+  end
+
   def test_post_page_pdf_page_stamps
     file_name = 'PageNumberStamp.pdf'
     upload_file(file_name)
@@ -6492,4 +6556,46 @@ class PdfTests < Minitest::Test
     response = @pdf_api.post_import_fields_from_xml(file_name, opts)
     assert(response, 'Failed to import fields from xml.')
   end
+
+  # Layers Tests
+
+  def test_get_document_layers
+    file_name = 'PdfWithLayers.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.get_document_layers(file_name, opts)
+    assert_equal(2, response[0].layers.count(), 'Failed to read document layers.')
+  end
+
+  def test_delete_document_layer
+    file_name = 'PdfWithLayers.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.delete_document_layer(file_name, 1, "oc1", opts)
+    assert(response, 'Failed to delete document layer.')
+
+    response = @pdf_api.get_document_layers(file_name, opts)
+    assert_equal(1, response[0].layers.count(), 'Failed to read document layers.')
+  end
+
+  def test_put_create_pdf_from_layer
+    file_name = 'PdfWithLayers.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.put_create_pdf_from_layer(file_name, 1, "output.pdf", "oc1", opts)
+    assert(response, 'Failed to create a separate PDF from a PDF Layer.')
+  end
+
 end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspose_pdf_cloud
 version: !ruby/object:Gem::Version
-  version: 24.7.0
+  version: 24.9.0
 platform: ruby
 authors:
 - Aspose PDF Cloud
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-07-23 00:00:00.000000000 Z
+date: 2024-09-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -245,6 +245,7 @@ files:
 - docs/DocRecognitionMode.md
 - docs/Document.md
 - docs/DocumentConfig.md
+- docs/DocumentLayers.md
 - docs/DocumentPageResponse.md
 - docs/DocumentPagesResponse.md
 - docs/DocumentPrivilege.md
@@ -305,6 +306,7 @@ files:
 - docs/InkAnnotations.md
 - docs/InkAnnotationsResponse.md
 - docs/Justification.md
+- docs/LayerInfo.md
 - docs/LettersPositioningMethods.md
 - docs/LineAnnotation.md
 - docs/LineAnnotationResponse.md
@@ -536,6 +538,7 @@ files:
 - lib/aspose_pdf_cloud/models/doc_recognition_mode.rb
 - lib/aspose_pdf_cloud/models/document.rb
 - lib/aspose_pdf_cloud/models/document_config.rb
+- lib/aspose_pdf_cloud/models/document_layers.rb
 - lib/aspose_pdf_cloud/models/document_page_response.rb
 - lib/aspose_pdf_cloud/models/document_pages_response.rb
 - lib/aspose_pdf_cloud/models/document_privilege.rb
@@ -596,6 +599,7 @@ files:
 - lib/aspose_pdf_cloud/models/ink_annotations.rb
 - lib/aspose_pdf_cloud/models/ink_annotations_response.rb
 - lib/aspose_pdf_cloud/models/justification.rb
+- lib/aspose_pdf_cloud/models/layer_info.rb
 - lib/aspose_pdf_cloud/models/letters_positioning_methods.rb
 - lib/aspose_pdf_cloud/models/line_annotation.rb
 - lib/aspose_pdf_cloud/models/line_annotation_response.rb
@@ -789,6 +793,7 @@ files:
 - test_data/PdfWithEmbeddedFiles.pdf
 - test_data/PdfWithImages.pdf
 - test_data/PdfWithImages2.pdf
+- test_data/PdfWithLayers.pdf
 - test_data/PdfWithLinks.pdf
 - test_data/PdfWithScreenAnnotations.pdf
 - test_data/PdfWithTable.pdf