aspose_pdf_cloud 23.2.0 → 23.4.0

data/lib/aspose_pdf_cloud/models/organize_document_request.rb

@@ -0,0 +1,206 @@
+=begin
+--------------------------------------------------------------------------------------------------------------------
+Copyright (c) 2023 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
+  # Documents data for organizing.
+  class OrganizeDocumentRequest
+    # List of document data for organizing.
+    attr_accessor :list
+
+
+    # Attribute mapping from ruby-style variable name to JSON key.
+    def self.attribute_map
+      {
+        :'list' => :'List'
+      }
+    end
+
+    # Attribute type mapping.
+    def self.swagger_types
+      {
+        :'list' => :'Array<OrganizeDocumentData>'
+      }
+    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?(:'List')
+        if (value = attributes[:'List']).is_a?(Array)
+          self.list = value
+        end
+      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 @list.nil?
+        invalid_properties.push("invalid value for 'list', list 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 @list.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 &&
+          list == o.list
+    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
+      [list].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/page_range.rb

@@ -33,8 +33,8 @@ module AsposePdfCloud
     # Attribute mapping from ruby-style variable name to JSON key.
     def self.attribute_map
       {
-        :'from' => :'from',
-        :'to' => :'to'
+        :'from' => :'From',
+        :'to' => :'To'
       }
     end
 
@@ -54,12 +54,12 @@ module AsposePdfCloud
       # convert string to symbol for hash key
       attributes = attributes.each_with_object({}){|(k,v), h| h[k.to_sym] = v}
 
-      if attributes.has_key?(:'from')
-        self.from = attributes[:'from']
+      if attributes.has_key?(:'From')
+        self.from = attributes[:'From']
       end
 
-      if attributes.has_key?(:'to')
-        self.to = attributes[:'to']
+      if attributes.has_key?(:'To')
+        self.to = attributes[:'To']
       end
 
     end

data/lib/aspose_pdf_cloud/version.rb

@@ -20,5 +20,5 @@ SOFTWARE.
 =end
 
 module AsposePdfCloud
-  VERSION = "23.2.0"
+  VERSION = "23.4.0"
 end

data/lib/aspose_pdf_cloud.rb

@@ -92,6 +92,8 @@ require_relative 'aspose_pdf_cloud/models/merge_documents'
 require_relative 'aspose_pdf_cloud/models/object_exist'
 require_relative 'aspose_pdf_cloud/models/optimize_options'
 require_relative 'aspose_pdf_cloud/models/option'
+require_relative 'aspose_pdf_cloud/models/organize_document_data'
+require_relative 'aspose_pdf_cloud/models/organize_document_request'
 require_relative 'aspose_pdf_cloud/models/output_format'
 require_relative 'aspose_pdf_cloud/models/page_layout'
 require_relative 'aspose_pdf_cloud/models/page_mode'

data/test/pdf_tests.rb

@@ -29,7 +29,6 @@ class PdfTests < Minitest::Test
   include MiniTest::Assertions
   include AsposePdfCloud
 
-
   def setup
     servercreds_json = File.read('../../../Settings/servercreds.json')
     creds = JSON.parse(servercreds_json)
@@ -41,17 +40,14 @@ class PdfTests < Minitest::Test
     config.scheme = 'https'
   end
 
-
   def teardown
   end
 
-
   def upload_file(file_name)
     response = @pdf_api.upload_file(@temp_folder + '/' + file_name, ::File.open(@test_data_folder + file_name, 'r') { |io| io.read(io.size) } )
     assert(response, "Failed to upload #{file_name} file.")
   end
 
-
   # Annotations Tests
 
   def test_get_document_annotations
@@ -3821,6 +3817,36 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to update document display properties.')
   end
 
+  def test_post_organize_document
+    file_name = '4pages.pdf'
+    upload_file(file_name)
+    opts = {
+        :folder => @temp_folder
+    }
+    response = @pdf_api.post_organize_document(file_name, '1,4-2', @temp_folder + '/' + file_name, opts)
+    assert(response, 'Failed to organize document.')
+  end
+
+  def test_post_organize_documents
+    file_name1 = '4pages.pdf'
+    upload_file(file_name1)
+    file_name2 = 'marketing.pdf'
+    upload_file(file_name2)
+    data1 = OrganizeDocumentData.new
+    data1.path = @temp_folder + '/' + file_name1
+    data1.pages = '4-2'
+    data2 = OrganizeDocumentData.new
+    data2.path = @temp_folder + '/' + file_name2
+    data2.pages = '2'
+    data3 = OrganizeDocumentData.new
+    data3.path = @temp_folder + '/' + file_name1
+    data3.pages = '3,1'
+    request = OrganizeDocumentRequest.new
+    request.list = [data1, data2, data3]
+    response = @pdf_api.post_organize_documents(request, @temp_folder + '/OrganizeMany.pdf')
+    assert(response, 'Failed to organize documents.')
+  end
+
   # Fields Tests
 
   def test_get_field
@@ -3836,7 +3862,6 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to get document field by name.')
   end
 
-
   def test_get_fields
     file_name = 'PdfWithAcroForm.pdf'
     upload_file(file_name)
@@ -3849,7 +3874,6 @@ class PdfTests < Minitest::Test
     assert(response, 'Failed to get document fields.')
   end
 
-
   def test_post_create_field
     file_name = 'Hello_world.pdf'
     upload_file(file_name)

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: aspose_pdf_cloud
 version: !ruby/object:Gem::Version
-  version: 23.2.0
+  version: 23.4.0
 platform: ruby
 authors:
 - Aspose PDF Cloud
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2023-02-27 00:00:00.000000000 Z
+date: 2023-04-21 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: json
@@ -334,6 +334,8 @@ files:
 - docs/ObjectExist.md
 - docs/OptimizeOptions.md
 - docs/Option.md
+- docs/OrganizeDocumentData.md
+- docs/OrganizeDocumentRequest.md
 - docs/OutputFormat.md
 - docs/Page.md
 - docs/PageLayout.md
@@ -622,6 +624,8 @@ files:
 - lib/aspose_pdf_cloud/models/object_exist.rb
 - lib/aspose_pdf_cloud/models/optimize_options.rb
 - lib/aspose_pdf_cloud/models/option.rb
+- lib/aspose_pdf_cloud/models/organize_document_data.rb
+- lib/aspose_pdf_cloud/models/organize_document_request.rb
 - lib/aspose_pdf_cloud/models/output_format.rb
 - lib/aspose_pdf_cloud/models/page.rb
 - lib/aspose_pdf_cloud/models/page_layout.rb