aspose_pdf_cloud 19.3.0 → 19.4.0

data/lib/aspose_pdf_cloud/models/text_stamp.rb

@@ -31,33 +31,18 @@ module AsposePdfCloud
     # Sets or gets a bool value that indicates the content is stamped as background. If the value is true, the stamp content is layed at the bottom. By defalt, the value is false, the stamp content is layed at the top.
     attr_accessor :background
 
-    # Gets or sets bottom margin of stamp.
-    attr_accessor :bottom_margin
-
     # Gets or sets Horizontal alignment of stamp on the page. 
     attr_accessor :horizontal_alignment
 
-    # Gets or sets left margin of stamp.
-    attr_accessor :left_margin
-
     # Gets or sets a value to indicate the stamp opacity. The value is from 0.0 to 1.0. By default the value is 1.0.
     attr_accessor :opacity
 
-    # Gets or sets right margin of stamp.
-    attr_accessor :right_margin
-
     # Sets or gets the rotation of stamp content according  values. Note. This property is for set angles which are multiples of 90 degrees (0, 90, 180, 270 degrees). To set arbitrary angle use RotateAngle property.  If angle set by ArbitraryAngle is not multiple of 90 then Rotate property returns Rotation.None.
     attr_accessor :rotate
 
     # Gets or sets rotate angle of stamp in degrees. This property allows to set arbitrary rotate angle. 
     attr_accessor :rotate_angle
 
-    # Gets or sets top margin of stamp.
-    attr_accessor :top_margin
-
-    # Gets or sets vertical alignment of stamp on page.
-    attr_accessor :vertical_alignment
-
     # Horizontal stamp coordinate, starting from the left.
     attr_accessor :x_indent
 
@@ -76,27 +61,42 @@ module AsposePdfCloud
     # Gets text properties of the stamp. See  for details.
     attr_accessor :text_state
 
+    # Gets or sets vertical alignment of stamp on page.
+    attr_accessor :vertical_alignment
+
+    # Gets or sets bottom margin of stamp.
+    attr_accessor :bottom_margin
+
+    # Gets or sets left margin of stamp.
+    attr_accessor :left_margin
+
+    # Gets or sets top margin of stamp.
+    attr_accessor :top_margin
+
+    # Gets or sets right margin of stamp.
+    attr_accessor :right_margin
+
 
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
         :'links' => :'Links',
         :'background' => :'Background',
-        :'bottom_margin' => :'BottomMargin',
         :'horizontal_alignment' => :'HorizontalAlignment',
-        :'left_margin' => :'LeftMargin',
         :'opacity' => :'Opacity',
-        :'right_margin' => :'RightMargin',
         :'rotate' => :'Rotate',
         :'rotate_angle' => :'RotateAngle',
-        :'top_margin' => :'TopMargin',
-        :'vertical_alignment' => :'VerticalAlignment',
         :'x_indent' => :'XIndent',
         :'y_indent' => :'YIndent',
         :'zoom' => :'Zoom',
         :'text_alignment' => :'TextAlignment',
         :'value' => :'Value',
-        :'text_state' => :'TextState'
+        :'text_state' => :'TextState',
+        :'vertical_alignment' => :'VerticalAlignment',
+        :'bottom_margin' => :'BottomMargin',
+        :'left_margin' => :'LeftMargin',
+        :'top_margin' => :'TopMargin',
+        :'right_margin' => :'RightMargin'
       }
     end
 
@@ -105,21 +105,21 @@ module AsposePdfCloud
       {
         :'links' => :'Array<Link>',
         :'background' => :'BOOLEAN',
-        :'bottom_margin' => :'Float',
         :'horizontal_alignment' => :'HorizontalAlignment',
-        :'left_margin' => :'Float',
         :'opacity' => :'Float',
-        :'right_margin' => :'Float',
         :'rotate' => :'Rotation',
         :'rotate_angle' => :'Float',
-        :'top_margin' => :'Float',
-        :'vertical_alignment' => :'VerticalAlignment',
         :'x_indent' => :'Float',
         :'y_indent' => :'Float',
         :'zoom' => :'Float',
         :'text_alignment' => :'HorizontalAlignment',
         :'value' => :'String',
-        :'text_state' => :'TextState'
+        :'text_state' => :'TextState',
+        :'vertical_alignment' => :'VerticalAlignment',
+        :'bottom_margin' => :'Float',
+        :'left_margin' => :'Float',
+        :'top_margin' => :'Float',
+        :'right_margin' => :'Float'
       }
     end
 
@@ -141,26 +141,14 @@ module AsposePdfCloud
         self.background = attributes[:'Background']
       end
 
-      if attributes.has_key?(:'BottomMargin')
-        self.bottom_margin = attributes[:'BottomMargin']
-      end
-
       if attributes.has_key?(:'HorizontalAlignment')
         self.horizontal_alignment = attributes[:'HorizontalAlignment']
       end
 
-      if attributes.has_key?(:'LeftMargin')
-        self.left_margin = attributes[:'LeftMargin']
-      end
-
       if attributes.has_key?(:'Opacity')
         self.opacity = attributes[:'Opacity']
       end
 
-      if attributes.has_key?(:'RightMargin')
-        self.right_margin = attributes[:'RightMargin']
-      end
-
       if attributes.has_key?(:'Rotate')
         self.rotate = attributes[:'Rotate']
       end
@@ -169,14 +157,6 @@ module AsposePdfCloud
         self.rotate_angle = attributes[:'RotateAngle']
       end
 
-      if attributes.has_key?(:'TopMargin')
-        self.top_margin = attributes[:'TopMargin']
-      end
-
-      if attributes.has_key?(:'VerticalAlignment')
-        self.vertical_alignment = attributes[:'VerticalAlignment']
-      end
-
       if attributes.has_key?(:'XIndent')
         self.x_indent = attributes[:'XIndent']
       end
@@ -201,6 +181,26 @@ module AsposePdfCloud
         self.text_state = attributes[:'TextState']
       end
 
+      if attributes.has_key?(:'VerticalAlignment')
+        self.vertical_alignment = attributes[:'VerticalAlignment']
+      end
+
+      if attributes.has_key?(:'BottomMargin')
+        self.bottom_margin = attributes[:'BottomMargin']
+      end
+
+      if attributes.has_key?(:'LeftMargin')
+        self.left_margin = attributes[:'LeftMargin']
+      end
+
+      if attributes.has_key?(:'TopMargin')
+        self.top_margin = attributes[:'TopMargin']
+      end
+
+      if attributes.has_key?(:'RightMargin')
+        self.right_margin = attributes[:'RightMargin']
+      end
+
     end
 
     # Show invalid properties with the reasons. Usually used together with valid?
@@ -223,21 +223,21 @@ module AsposePdfCloud
       self.class == o.class &&
           links == o.links &&
           background == o.background &&
-          bottom_margin == o.bottom_margin &&
           horizontal_alignment == o.horizontal_alignment &&
-          left_margin == o.left_margin &&
           opacity == o.opacity &&
-          right_margin == o.right_margin &&
           rotate == o.rotate &&
           rotate_angle == o.rotate_angle &&
-          top_margin == o.top_margin &&
-          vertical_alignment == o.vertical_alignment &&
           x_indent == o.x_indent &&
           y_indent == o.y_indent &&
           zoom == o.zoom &&
           text_alignment == o.text_alignment &&
           value == o.value &&
-          text_state == o.text_state
+          text_state == o.text_state &&
+          vertical_alignment == o.vertical_alignment &&
+          bottom_margin == o.bottom_margin &&
+          left_margin == o.left_margin &&
+          top_margin == o.top_margin &&
+          right_margin == o.right_margin
     end
 
     # @see the `==` method
@@ -249,7 +249,7 @@ module AsposePdfCloud
     # Calculates hash code according to all attributes.
     # @return [Fixnum] Hash code
     def hash
-      [links, background, bottom_margin, horizontal_alignment, left_margin, opacity, right_margin, rotate, rotate_angle, top_margin, vertical_alignment, x_indent, y_indent, zoom, text_alignment, value, text_state].hash
+      [links, background, horizontal_alignment, opacity, rotate, rotate_angle, x_indent, y_indent, zoom, text_alignment, value, text_state, vertical_alignment, bottom_margin, left_margin, top_margin, right_margin].hash
     end
 
     # Builds the object from hash

data/lib/aspose_pdf_cloud/version.rb

@@ -20,5 +20,5 @@ SOFTWARE.
 =end
 
 module AsposePdfCloud
-  VERSION = "19.3.0"
+  VERSION = "19.4.0"
 end

data/test/pdf_tests.rb

@@ -21,6 +21,7 @@ SOFTWARE.
 
 require 'minitest/autorun'
 require 'minitest/unit'
+require 'base64'
 
 require_relative '../lib/aspose_pdf_cloud'
 
@@ -354,6 +355,121 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to delete table.')
   end
 
+  def test_post_page_tables
+    file_name = '4pages.pdf'
+    upload_file(file_name)
+
+    page_number = 1
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    table = __draw_table
+
+    response = @pdf_api.post_page_tables(file_name, page_number, [table], opts)
+    assert(response, 'Failed to add tables.')
+  end
+
+  def test_put_table
+    file_name = 'PdfWithTable.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    tables_response = @pdf_api.get_document_tables(file_name, opts)
+    assert(tables_response, 'Failed to read document tables.')
+    table_id = tables_response[0].tables.list[0].id
+
+    table = __draw_table
+
+    response = @pdf_api.put_table(file_name, table_id, table, opts)
+    assert(response, 'Failed to update table.')
+  end
+
+  def __draw_table
+
+    text_state = TextState.new
+    text_state.font = 'Arial'
+    text_state.font_size = 10
+    text_state.foreground_color = Color.new({:A => 0xFF, :R => 0, :G => 0xFF, :B => 0})
+    text_state.background_color = Color.new({:A => 0xFF, :R => 0xFF, :G => 0, :B => 0})
+    text_state.font_style = FontStyles::BOLD
+
+    num_of_cols = 5
+    num_of_rows = 5
+
+    table = Table.new
+    table.rows = Array.new(num_of_rows)
+
+    col_widths = '';
+    (1..num_of_cols).each do
+      col_widths += ' 30'
+    end
+
+    table.column_widths = col_widths
+
+    table.default_cell_text_state = text_state
+
+    border_table_border = GraphInfo.new
+
+    border_table_border.color = Color.new({:A => 0xFF, :R => 0, :G => 0xFF, :B => 0xFF})
+    border_table_border.line_width = 1
+
+    border_info = BorderInfo.new
+    border_info.top = border_table_border
+    border_info.right = border_table_border
+    border_info.bottom = border_table_border
+    border_info.left = border_table_border
+
+    table.default_cell_border = border_info
+    table.top = 100
+
+
+
+    (0..(num_of_rows - 1)).each do |r|
+      row = Row.new
+      row.cells = Array.new(num_of_cols)
+
+      (0..(num_of_rows - 1)).each do |c|
+        cell = Cell.new
+        cell.background_color = Color.new({:A => 0xFF, :R => 0xFF, :G => 0, :B => 0xFF})
+        cell.default_cell_text_state = text_state
+        cell.paragraphs = Array.new(1)
+        cell.paragraphs[0] = TextRect.new({:Text => 'value'})
+
+        # change properties on cell
+
+        if c == 1
+          cell.default_cell_text_state.foreground_color = Color.new({:A => 0xFF, :R => 0xFF, :G => 0, :B => 0xFF})
+
+          # change properties on cell AFTER first clearing and re-adding paragraphs
+        elsif c == 2
+          cell.paragraphs[0] =  TextRect.new({:Text => 'y'})
+          cell.default_cell_text_state.foreground_color = Color.new({:A => 0xFF, :R => 0, :G => 0, :B => 0xFF})
+
+          #change properties on paragraph
+        elsif c == 3
+          cell.paragraphs[0].text_state = text_state
+          cell.paragraphs[0].text_state.foreground_color = Color.new({:A => 0xFF, :R => 0, :G => 0, :B => 0xFF})
+
+          # change properties on paragraph AFTER first clearing and re-adding paragraphs
+        elsif c == 4
+          cell.paragraphs[0] =  TextRect.new({:Text => 'y'})
+          cell.paragraphs[0].text_state = text_state
+          cell.paragraphs[0].text_state.foreground_color =  Color.new({:A => 0xFF, :R => 0, :G => 0, :B => 0xFF})
+        end
+
+        row.cells[c] = cell
+      end
+      table.rows[r] = row
+    end
+    table
+  end
+
+
   # Stamp Annotations Tests
 
   def test_get_document_stamp_annotations
@@ -1453,6 +1569,140 @@ class PdfTests < Minitest::Test
   end
 
 
+  # Header and Footer Tests
+
+  def test_post_document_text_header
+    name = '4pages.pdf'
+    upload_file(name)
+
+    text_state = TextState.new
+    text_state.font_size = 14
+    text_state.font = 'Arial Bold'
+    text_state.foreground_color = Color.new({:A => 0xFF, :R => 0, :G => 0xFF, :B => 0})
+    text_state.background_color = Color.new({:A => 0xFF, :R => 0xFF, :G => 0, :B => 0})
+    text_state.font_style = FontStyles::BOLD
+
+    header = TextHeader.new
+    header.background = true
+    header.left_margin = 1
+    header.right_margin = 2
+    header.top_margin = 20
+    header.horizontal_alignment = HorizontalAlignment::CENTER
+    header.opacity = 1
+    header.rotate = Rotation::NONE
+    header.rotate_angle = 0
+    header.x_indent = 0
+    header.y_indent = 0
+    header.zoom = 1
+    header.text_alignment = HorizontalAlignment::CENTER
+    header.value = 'Header'
+    header.text_state = text_state
+
+    opts = {
+        :folder => @temp_folder,
+        :start_page_number => 2,
+        :end_page_number => 3
+    }
+    response = @pdf_api.post_document_text_header(name, header, opts)
+    assert(response, 'Failed to add text header.')
+  end
+
+  def test_post_document_text_footer
+    name = '4pages.pdf'
+    upload_file(name)
+
+    text_state = TextState.new
+    text_state.font_size = 14
+    text_state.font = 'Arial Bold'
+    text_state.foreground_color = Color.new({:A => 0xFF, :R => 0, :G => 0xFF, :B => 0})
+    text_state.background_color = Color.new({:A => 0xFF, :R => 0xFF, :G => 0, :B => 0})
+    text_state.font_style = FontStyles::BOLD
+
+    footer = TextFooter.new
+    footer.background = true
+    footer.left_margin = 1
+    footer.right_margin = 2
+    footer.bottom_margin = 20
+    footer.horizontal_alignment = HorizontalAlignment::CENTER
+    footer.opacity = 1
+    footer.rotate = Rotation::NONE
+    footer.rotate_angle = 0
+    footer.x_indent = 0
+    footer.y_indent = 0
+    footer.zoom = 1
+    footer.text_alignment = HorizontalAlignment::CENTER
+    footer.value = 'Footer'
+    footer.text_state = text_state
+
+    opts = {
+        :folder => @temp_folder,
+        :start_page_number => 2,
+        :end_page_number => 3
+    }
+    response = @pdf_api.post_document_text_footer(name, footer, opts)
+    assert(response, 'Failed to add text footer.')
+  end
+
+  def test_post_document_image_header
+    name = '4pages.pdf'
+    upload_file(name)
+
+    image = 'Koala.jpg'
+    upload_file(image)
+
+    header = ImageHeader.new
+    header.background = true
+    header.left_margin = 1
+    header.right_margin = 2
+    header.top_margin = 20
+    header.horizontal_alignment = HorizontalAlignment::CENTER
+    header.opacity = 1
+    header.rotate = Rotation::NONE
+    header.rotate_angle = 0
+    header.x_indent = 0
+    header.y_indent = 0
+    header.zoom = 0.1
+    header.file_name = @temp_folder + '/' + image
+
+    opts = {
+        :folder => @temp_folder,
+        :start_page_number => 2,
+        :end_page_number => 3
+    }
+    response = @pdf_api.post_document_image_header(name, header, opts)
+    assert(response, 'Failed to add image header.')
+  end
+
+  def test_post_document_image_footer
+    name = '4pages.pdf'
+    upload_file(name)
+
+    image = 'Koala.jpg'
+    upload_file(image)
+
+    footer = ImageFooter.new
+    footer.background = true
+    footer.left_margin = 1
+    footer.right_margin = 2
+    footer.bottom_margin = 20
+    footer.horizontal_alignment = HorizontalAlignment::CENTER
+    footer.opacity = 1
+    footer.rotate = Rotation::NONE
+    footer.rotate_angle = 0
+    footer.x_indent = 0
+    footer.y_indent = 0
+    footer.zoom = 0.1
+    footer.file_name = @temp_folder + '/' + image
+
+    opts = {
+        :folder => @temp_folder,
+        :start_page_number => 2,
+        :end_page_number => 3
+    }
+    response = @pdf_api.post_document_image_footer(name, footer, opts)
+    assert(response, 'Failed to add image footer.')
+  end
+
   # Text Annotations Tests
 
   def test_get_document_text_annotations
@@ -2450,20 +2700,106 @@ class PdfTests < Minitest::Test
   end
 
 
-  # Bookmarks Tests
+  # Encrypt Decrypt Tests
+
+  def test_put_encrypt_document
+    file_name = '4pages.pdf'
+    upload_file(file_name)
+
+    out_path = @temp_folder + '/' + file_name
+    user_password = 'user $^Password!&'
+    owner_password = 'owner\//? $12^Password!&'
+
+    opts = {
+        :file => ::File.open(@test_data_folder + file_name, 'r') { |io| io.read(io.size) }
+    }
+
+    response = @pdf_api.put_encrypt_document(out_path, Base64.encode64(user_password),
+                                             Base64.encode64(owner_password), CryptoAlgorithm::AE_SX128, opts)
+    assert(response, 'Failed to encrypt document.')
+  end
+
+  def test_post_encrypt_document_in_storage
+    file_name = '4pages.pdf'
+    upload_file(file_name)
+
+    user_password = 'user $^Password!&'
+    owner_password = 'owner\//? $12^Password!&'
+
+    opts = {
+        :folder => @temp_folder
+    }
 
-  def test_get_document_bookmarks
-    file_name = 'PdfWithBookmarks.pdf'
+    response = @pdf_api.post_encrypt_document_in_storage(file_name, Base64.encode64(user_password),
+                                                         Base64.encode64(owner_password), CryptoAlgorithm::AE_SX128, opts)
+    assert(response, 'Failed to encrypt document.')
+  end
+
+  def test_put_decrypt_document
+    file_name = '4pagesEncrypted.pdf'
     upload_file(file_name)
 
+    out_path = @temp_folder + '/' + file_name
+    user_password = 'user $^Password!&'
+
+    opts = {
+        :file => ::File.open(@test_data_folder + file_name, 'r') { |io| io.read(io.size) }
+    }
+
+    response = @pdf_api.put_decrypt_document(out_path, Base64.encode64(user_password), opts)
+    assert(response, 'Failed to decrypt document.')
+  end
+
+  def test_post_decrypt_document_in_storage
+    file_name = '4pagesEncrypted.pdf'
+    upload_file(file_name)
+
+    user_password = 'user $^Password!&'
+
     opts = {
         :folder => @temp_folder
     }
 
-    response = @pdf_api.get_document_bookmarks(file_name, opts)
-    assert(response, 'Failed to read document bookmarks.')
+    response = @pdf_api.post_decrypt_document_in_storage(file_name, Base64.encode64(user_password), opts)
+    assert(response, 'Failed to decrypt document.')
   end
 
+  def test_put_change_password_document
+    file_name = '4pagesEncrypted.pdf'
+    upload_file(file_name)
+
+    out_path = @temp_folder + '/' + file_name
+
+    owner_password = 'owner\//? $12^Password!&'
+    new_user_password = 'user new\//? $12^Password!&'
+    new_owner_password = 'owner new\//? $12^Password!&'
+
+    opts = {
+        :file => ::File.open(@test_data_folder + file_name, 'r') { |io| io.read(io.size) }
+    }
+
+    response = @pdf_api.put_change_password_document(out_path, Base64.encode64(owner_password),
+                                                     Base64.encode64(new_user_password), Base64.encode64(new_owner_password), opts)
+    assert(response, 'Failed to change document password.')
+  end
+
+  def test_post_change_password_document_in_storage
+    file_name = '4pagesEncrypted.pdf'
+    upload_file(file_name)
+
+
+    owner_password = 'owner\//? $12^Password!&'
+    new_user_password = 'user new\//? $12^Password!&'
+    new_owner_password = 'owner new\//? $12^Password!&'
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.post_change_password_document_in_storage(file_name, Base64.encode64(owner_password),
+                                                                 Base64.encode64(new_user_password), Base64.encode64(new_owner_password), opts)
+    assert(response, 'Failed to change document password.')
+  end
 
   # Convert Tests
 
@@ -2942,6 +3278,41 @@ class PdfTests < Minitest::Test
     assert(response, 'Filed to convert PDF to Xml.')
   end
 
+  def test_get_pdf_in_storage_to_xlsx
+    file_name = '4pages.pdf'
+    upload_file(file_name)
+
+    opts = {
+        :folder => @temp_folder
+    }
+
+    response = @pdf_api.get_pdf_in_storage_to_xlsx(file_name, opts)
+    assert(response, 'Filed to convert PDF to XLS.')
+  end
+
+  def test_put_pdf_in_storage_to_xlsx
+    file_name = '4pages.pdf'
+    upload_file(file_name)
+    res_file = 'result.xlsx'
+
+    opts = {
+        :folder => @temp_folder
+    }
+    response = @pdf_api.put_pdf_in_storage_to_xlsx(file_name, @temp_folder + '/' + res_file, opts)
+    assert(response, 'Filed to convert PDF to XLS.')
+  end
+
+  def test_put_pdf_in_request_to_xlsx
+    file_name = '4pages.pdf'
+
+    res_file = 'result.xlsx'
+
+    opts = {
+        :file => ::File.open(@test_data_folder + file_name, 'r') { |io| io.read(io.size) }
+    }
+    response = @pdf_api.put_pdf_in_request_to_xlsx(@temp_folder + '/' + res_file, opts)
+    assert(response, 'Filed to convert PDF to XLS.')
+  end
 
 # Convert to PDF Tests
 
@@ -3606,6 +3977,37 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to delete Stamp.')
   end
 
+  def test_post_document_page_number_stamps
+    name = '4pages.pdf'
+    upload_file(name)
+
+
+    opts = {
+        :folder => @temp_folder,
+        :start_page_number => 2,
+        :end_page_number => 3
+    }
+
+    stamp = PageNumberStamp.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::BOTTOM
+    stamp.opacity = 1
+    stamp.rotate = Rotation::NONE
+    stamp.rotate_angle = 0
+    stamp.x_indent = 0
+    stamp.y_indent = 0
+    stamp.zoom = 1
+    stamp.starting_number = 3
+    stamp.value = 'Page #'
+
+    response = @pdf_api.post_document_page_number_stamps(name, stamp, opts)
+    assert(response, 'Failed to add Page number stamp.')
+  end
 
   # Images Tests