dynamicpdf_api 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9fb5af3697d5f2c467805e95b675d24789683267a5ec80651bf5979004cdc043
-  data.tar.gz: 1e139dad9f270c8220cf3352cf1d245ee9c2cf18bae881b2503afee3dbdc2c2b
+  metadata.gz: 6f42bc787613e44286e726d180adfc0ea445d5398dfe16cedc82c493fc4ccd1a
+  data.tar.gz: de16d1e726916f97f16113f877b39fae03e86d412af0adbdb993e5a4bfff0ec7
 SHA512:
-  metadata.gz: e6b4c5063f958aafefa406a51840f55d275dca8cc5606ea5febdb393ddd449a84cea3bfdbe02569a5c8c8adc175b2251bb60a66b9e7e83312e0d293a87019e74
-  data.tar.gz: ff5f48259c2cabdff79d4f19bda0419d04fd820ff67e55a2140da9b112a6f110f26a67c08d2354c5ca27594a3b3a7720c65efbd49cb15ba3b96413ecbbaed119
+  metadata.gz: ce716f34048b25deb919ba964523acb9fffc6933e646b8f0286d9995019541284fa2b0be5bf7aaa58ccf6303557ba15e6795306a8634ca01ff43a10805af5720
+  data.tar.gz: 559e545b54529731b213a4a12b47c15717addefd878d447eeba751740f2cef2fc685624396e17564c315be32caaad62efa0fe4179f2510b6557e65d1534b1854

data/lib/ruby_client/Imaging/BmpColorFormat.rb

@@ -0,0 +1,20 @@
+module DynamicPDFApi
+  require_relative 'ColorFormat'
+  require_relative 'ColorFormatType'
+
+  #
+  # Base class for BMP color formats
+  #
+  class BmpColorFormat < ColorFormat
+    #
+    # Creates a new BmpColorFormat object with the given type.
+    #
+    def initialize(type)
+      if type != ColorFormatType::Monochrome
+        @type = ColorFormatType::RGB
+      else
+        @type = type
+      end
+    end
+  end
+end

data/lib/ruby_client/Imaging/BmpImageFormat.rb

@@ -0,0 +1,32 @@
+module DynamicPDFApi
+  require_relative 'ImageFormat'
+  require_relative 'ImageFormatType'
+
+  #
+  # Represents BMP image format with color format.
+  #
+  class BmpImageFormat < ImageFormat
+    attr_accessor :color_format  # Gets or sets the BmpColorFormat for BMP.
+
+    #
+    # Initializes a new instance of the BmpImageFormat class.
+    #
+    def initialize
+      super(ImageFormatType::BMP)
+      @color_format = nil
+    end
+
+    #
+    # Returns a JSON representation of the BmpImageFormat object.
+    #
+    # @return [String] JSON string representing the BmpImageFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'bmp'
+
+      json_array['colorFormat'] = @color_format
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/BmpMonochromeColorFormat.rb

@@ -0,0 +1,37 @@
+module DynamicPDFApi
+  require_relative 'BmpColorFormat'
+  require_relative 'ColorFormatType'
+
+
+  #
+  # Represents monochrome color format for BMP.
+  #
+  class BmpMonochromeColorFormat < BmpColorFormat
+    attr_accessor :black_threshold  # Gets or sets the black threshold for monochrome BMP, ranges from 0-255.
+    attr_accessor :dithering_percent  # Gets or sets the dithering percentage for BMP.
+    attr_accessor :dithering_algorithm  # Gets or sets the dithering algorithm for BMP.
+
+    #
+    # Creates object for monochrome color format for BMP image format.
+    #
+    def initialize
+      super(ColorFormatType::Monochrome)
+      @black_threshold = nil
+      @dithering_percent = nil
+      @dithering_algorithm = nil
+    end
+
+    #
+    # Returns a JSON representation of the BmpMonochromeColorFormat object.
+    #
+    # @return [String] JSON string representing the BmpMonochromeColorFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['blackThreshold'] = @black_threshold
+      json_array['ditheringPercent'] = @dithering_percent
+      json_array['ditheringAlgorithm'] = @dithering_algorithm
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/ColorFormat.rb

@@ -0,0 +1,18 @@
+module DynamicPDFApi
+  #
+  # Base class for all color formats.
+  #
+  class ColorFormat
+    #
+    # Initializes a new instance of ColorFormat.
+    #
+    def initialize
+      @type = nil
+    end
+
+    #
+    # Gets or sets the color format type.
+    #
+    attr_accessor :type
+  end
+end

data/lib/ruby_client/Imaging/ColorFormatType.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  #
+  # Enum representing color formats.
+  #
+  class ColorFormatType
+    #
+    # RGB color format.
+    #
+    RGB = :Rgb.freeze
+
+    #
+    # RGBA color format.
+    #
+    RGBA = :Rgba.freeze
+
+    #
+    # Grayscale color format.
+    #
+    Grayscale = :Grayscale.freeze
+
+    #
+    # Monochrome color format.
+    #
+    Monochrome = :Monochrome.freeze
+
+    #
+    # Indexed color format.
+    #
+    Indexed = :Indexed.freeze
+  end
+end

data/lib/ruby_client/Imaging/CompressionType.rb

@@ -0,0 +1,16 @@
+module DynamicPDFApi
+  #
+  # Enum representing compression types.
+  #
+  class CompressionType
+    #
+    # CCIT Group 3 compression.
+    #
+    CcitGroup3 = :CcitGroup3.freeze
+
+    #
+    # CCIT Group 4 compression.
+    #
+    CcitGroup4 = :CcitGroup4.freeze
+  end
+end

data/lib/ruby_client/Imaging/DitheringAlgorithm.rb

@@ -0,0 +1,21 @@
+module DynamicPDFApi
+  #
+  # Enum representing dithering algorithms.
+  #
+  class DitheringAlgorithm
+    #
+    # Floyd-Steinberg dithering algorithm.
+    #
+    FloydSteinberg = :FloydSteinberg.freeze
+
+    #
+    # Bayer dithering algorithm.
+    #
+    Bayer = :Bayer.freeze
+
+    #
+    # No dithering.
+    #
+    None = :None.freeze
+  end
+end

data/lib/ruby_client/Imaging/DpiImageSize.rb

@@ -0,0 +1,36 @@
+module DynamicPDFApi
+  require_relative "ImageSize"
+  require_relative "ImageSizeType"
+  #
+  # Represents an image size defined by DPI (Dots Per Inch).
+  #
+  class DpiImageSize < ImageSize
+    attr_accessor :horizontal_dpi  # Gets or sets the horizontal DPI (Dots Per Inch) of the image.
+    attr_accessor :vertical_dpi    # Gets or sets the vertical DPI (Dots Per Inch) of the image.
+
+    #
+    # Initializes a new instance of the DpiImageSize class and sets the image size type to DPI.
+    #
+    def initialize
+      super
+      @horizontal_dpi = nil
+      @vertical_dpi = nil
+      @type = ImageSizeType::Dpi
+    end
+
+    #
+    # Returns a JSON representation of the DpiImageSize object.
+    #
+    # @return [String] JSON string representing the DpiImageSize object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'dpi'
+
+      json_array['horizontalDpi'] = @horizontal_dpi
+      json_array['verticalDpi'] = @vertical_dpi
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/FixedImageSize.rb

@@ -0,0 +1,39 @@
+module DynamicPDFApi
+  require_relative "ImageSize"
+  require_relative "ImageSizeType"
+
+
+  #
+  # Represents an image size with fixed dimensions.
+  #
+  class FixedImageSize < ImageSize
+    attr_accessor :width  # Gets or sets the width of the image.
+    attr_accessor :height  # Gets or sets the height of the image.
+    attr_accessor :unit  # Gets or sets the unit of measurement ImageSizeUnit for the width and height.
+
+    #
+    # Initializes a new instance of the FixedImageSize class and sets the image size type to Fixed.
+    #
+    def initialize
+      super()
+      @type = ImageSizeType::Fixed
+      @width = nil
+      @height = nil
+      @unit = nil
+    end
+
+    #
+    # Returns a JSON representation of the FixedImageSize object.
+    #
+    # @return [String] JSON string representing the FixedImageSize object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'fixed'
+      json_array['width'] = @width
+      json_array['height'] = @height
+      json_array['unit'] = @unit
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/GifImageFormat.rb

@@ -0,0 +1,33 @@
+module DynamicPDFApi
+  require_relative "ImageFormatType"
+  require_relative "ImageFormat"
+
+      # Represents GIF image format with dithering properties.
+      #
+      class GifImageFormat < ImageFormat
+        attr_accessor :dithering_percent  # Gets or sets the dithering percentage.
+        attr_accessor :dithering_algorithm  # Gets or sets the dithering algorithm.
+
+        #
+        # Initializes a new instance of the GifImageFormat class and sets the image format type to GIF.
+        #
+        def initialize
+          super(ImageFormatType::GIF)
+          @dithering_percent = nil
+          @dithering_algorithm = nil
+        end
+
+        #
+        # Returns a JSON representation of the GifImageFormat object.
+        #
+        # @return [String] JSON string representing the GifImageFormat object.
+        #
+        def to_json(_options = {})
+          json_array = {}
+          json_array['ditheringPercent'] = @dithering_percent
+          json_array['ditheringAlgorithm'] = @dithering_algorithm
+          json_array['type'] = 'gif'
+          JSON.pretty_generate(json_array)
+        end
+      end
+    end

data/lib/ruby_client/Imaging/ImageFormat.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  #
+  # Base class for image formats.
+  #
+  class ImageFormat
+    #
+    # Gets the image format type.
+    #
+    attr_reader :type
+
+    #
+    # Initializes a new instance of ImageFormat with the specified type.
+    #
+    # @param type [Symbol] The type of the image format.
+    #
+    def initialize(type)
+      @type = type
+    end
+
+    #
+    # Returns a JSON representation of the ImageFormat object.
+    #
+    # @return [String] JSON string representing the ImageFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = @type
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/ImageFormatType.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  #
+  # Enum representing supported image formats.
+  #
+  class ImageFormatType
+    #
+    # JPEG image format.
+    #
+    JPEG = :JPEG.freeze
+
+    #
+    # GIF image format.
+    #
+    GIF = :GIF.freeze
+
+    #
+    # BMP image format.
+    #
+    BMP = :BMP.freeze
+
+    #
+    # PNG image format.
+    #
+    PNG = :PNG.freeze
+
+    #
+    # TIFF image format.
+    #
+    TIFF = :TIFF.freeze
+  end
+end

data/lib/ruby_client/Imaging/ImageSize.rb

@@ -0,0 +1,26 @@
+module DynamicPDFApi
+  #
+  # Base class for image size types.
+  #
+  class ImageSize
+    attr_accessor :type  # Type of the image size.
+
+    #
+    # Initializes a new instance of the ImageSize class.
+    #
+    def initialize
+      @type = nil
+    end
+
+    #
+    # Returns a JSON representation of the ImageSize object.
+    #
+    # @return [String] JSON string representing the ImageSize object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = @type
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/ImageSizeType.rb

@@ -0,0 +1,26 @@
+module DynamicPDFApi
+  #
+  # Enum specifying the type of image size.
+  #
+  class ImageSizeType
+    #
+    # DPI-based image size.
+    #
+    Dpi = :Dpi.freeze
+
+    #
+    # Fixed image size.
+    #
+    Fixed = :Fixed.freeze
+
+    #
+    # Image size that fits within a given maximum size.
+    #
+    Max = :Max.freeze
+
+    #
+    # Percentage-based image size.
+    #
+    Percentage = :Percentage.freeze
+  end
+end

data/lib/ruby_client/Imaging/ImageSizeUnit.rb

@@ -0,0 +1,21 @@
+module DynamicPDFApi
+  #
+  # Specifies the unit of measurement for image size.
+  #
+  class ImageSizeUnit
+    #
+    # Millimeter unit of measurement.
+    #
+    Millimeter = :Millimeter.freeze
+
+    #
+    # Inch unit of measurement.
+    #
+    Inch = :Inch.freeze
+
+    #
+    # Point unit of measurement.
+    #
+    Point = :Point.freeze
+  end
+end

data/lib/ruby_client/Imaging/JpegImageFormat.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  require_relative "ImageFormat"
+  require_relative "ImageFormatType"
+
+  #
+  # Represents JPEG image format with quality.
+  #
+  class JpegImageFormat < ImageFormat
+    attr_accessor :quality  # Gets or sets the quality of the JPEG image.
+
+    #
+    # Initializes a new instance of the JpegImageFormat class.
+    #
+    def initialize
+      super(ImageFormatType::JPEG)
+      @quality = nil
+    end
+
+    #
+    # Returns a JSON representation of the JpegImageFormat object.
+    #
+    # @return [String] JSON string representing the JpegImageFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'jpeg'
+      json_array['quality'] = @quality
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/MaxImageSize.rb

@@ -0,0 +1,38 @@
+module DynamicPDFApi
+  require_relative "ImageSize"
+  require_relative "ImageSizeType"
+
+  #
+  # Represents an image size that fits within a specified maximum width and height.
+  #
+  class MaxImageSize < ImageSize
+    attr_accessor :max_width  # Gets or sets the maximum width of the image.
+    attr_accessor :max_height  # Gets or sets the maximum height of the image.
+    attr_accessor :unit  # Gets or sets the unit of measurement for the maximum width and height.
+
+    #
+    # Initializes a new instance of the MaxImageSize class.
+    #
+    def initialize
+      super()
+      @max_width = nil
+      @max_height = nil
+      @unit = nil
+      @type = ImageSizeType::Max
+    end
+
+    #
+    # Returns a JSON representation of the MaxImageSize object.
+    #
+    # @return [String] JSON string representing the MaxImageSize object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'max'
+      json_array['maxWidth'] = @max_width
+      json_array['maxHeight'] = @max_height
+      json_array['unit'] = @unit
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/PdfImage.rb

@@ -0,0 +1,210 @@
+module DynamicPDFApi
+
+  require "net/http"
+  require "net/https"
+  require "uri"
+  require "json"
+  require "openssl"
+
+  require_relative '..\Endpoint'
+  require_relative '..\PdfResource'
+  require_relative '..\EndPointException'
+  require_relative "PdfImageResponse"
+  require_relative "ImageFormat"
+  require_relative "ImageSize"
+
+  # Represents a PDF Rasterizing endpoint that converts PDF to image.
+  class PdfImage < Endpoint
+
+    #
+    # Represents a PdfResource for converting PDF pages to images.
+    #
+    attr_reader :resource
+
+    #
+    # Gets or sets the starting page number for rasterization.
+    #
+    attr_accessor :start_page_number
+
+    #
+    # Gets or sets the number of pages to rasterize.
+    #
+    attr_accessor :page_count
+
+    #
+    # Gets or sets the image format for rasterization.
+    #
+    attr_accessor :image_format
+
+    #
+    # Gets or sets the size of the rasterized images.
+    #
+    attr_accessor  :image_size
+
+    def initialize(resource)
+      @resource = resource
+      @_endpoint_name = 'pdf-image'
+    end
+
+    def process
+      header = {
+        'authorization': "Bearer #{@api_key}",
+        'Expect': "100-continue",
+      }
+      uri = URI.parse("#{@base_url}/v1.0/#{@_endpoint_name}")
+      params = {}
+      if @start_page_number!=nil
+        params['sp'] = @start_page_number
+        params['pc'] = @page_count
+      end
+
+      # Adding ImageSize parameters if @image_size is present
+      if @image_size
+        case @image_size
+        when DpiImageSize
+          params['is'] = @image_size.type.to_s
+          params['hd'] = @image_size.horizontal_dpi.to_s if @image_size.horizontal_dpi
+          params['vd'] = @image_size.vertical_dpi.to_s if @image_size.vertical_dpi
+        when FixedImageSize
+          params['is'] = @image_size.type.to_s
+          params['ht'] = @image_size.height.to_s if @image_size.height
+          params['wd'] = @image_size.width.to_s if @image_size.width
+          params['ut'] = @image_size.unit.to_s if @image_size.unit
+        when MaxImageSize
+          params['is'] = @image_size.type.to_s
+          params['mh'] = @image_size.max_height.to_s if @image_size.max_height
+          params['mw'] = @image_size.max_width.to_s if @image_size.max_width
+          params['ut'] = @image_size.unit.to_s if @image_size.unit
+        when PercentageImageSize
+          params['is'] = @image_size.type.to_s
+          params['hp'] = @image_size.horizontal_percentage.to_s if @image_size.horizontal_percentage
+          params['vp'] = @image_size.vertical_percentage.to_s if @image_size.vertical_percentage
+        end
+      end
+
+      # Adding ImageFormat parameters if @image_format is present
+      if @image_format
+        case @image_format
+        when GifImageFormat
+          params['if'] = @image_format.type.to_s
+          params['dp'] = @image_format.dithering_percent.to_s if @image_format.dithering_percent
+          params['da'] = @image_format.dithering_algorithm.to_s if @image_format.dithering_algorithm
+        when JpegImageFormat
+          params['if'] = @image_format.type.to_s
+          params['qt'] = @image_format.quality.to_s if @image_format.quality
+        when PngImageFormat
+          params['if'] = @image_format.type.to_s
+          if @image_format.color_format
+            params['cf'] = @image_format.color_format.type.to_s
+            case @image_format.color_format
+            when PngIndexedColorFormat
+              params['da'] = @image_format.color_format.dithering_algorithm.to_s if @image_format.color_format.dithering_algorithm
+              params['dp'] = @image_format.color_format.dithering_percent.to_s if @image_format.color_format.dithering_percent
+              params['qa'] = @image_format.color_format.quantization_algorithm.to_s if @image_format.color_format.quantization_algorithm
+            when PngMonochromeColorFormat
+              params['bt'] = @image_format.color_format.black_threshold.to_s if @image_format.color_format.black_threshold
+              params['da'] = @image_format.color_format.dithering_algorithm.to_s if @image_format.color_format.dithering_algorithm
+              params['dp'] = @image_format.color_format.dithering_percent.to_s if @image_format.color_format.dithering_percent
+            end
+          end
+        when TiffImageFormat
+          params['if'] = @image_format.type.to_s
+          params['mp'] = 'true' if @image_format.multi_page
+          if @image_format.color_format
+            params['cf'] = @image_format.color_format.type.to_s
+            case @image_format.color_format
+            when TiffIndexedColorFormat
+              params['da'] = @image_format.color_format.dithering_algorithm.to_s if @image_format.color_format.dithering_algorithm
+              params['dp'] = @image_format.color_format.dithering_percent.to_s if @image_format.color_format.dithering_percent
+              params['qa'] = @image_format.color_format.quantization_algorithm.to_s if @image_format.color_format.quantization_algorithm
+            when TiffMonochromeColorFormat
+              params['ct'] = @image_format.color_format.compression_type.to_s if @image_format.color_format.compression_type
+              params['bt'] = @image_format.color_format.black_threshold.to_s if @image_format.color_format.black_threshold
+              params['da'] = @image_format.color_format.dithering_algorithm.to_s if @image_format.color_format.dithering_algorithm
+              params['dp'] = @image_format.color_format.dithering_percent.to_s if @image_format.color_format.dithering_percent
+            end
+          end
+        when BmpImageFormat
+          params['if'] = @image_format.type.to_s
+          if @image_format.color_format
+            params['cf'] = @image_format.color_format.type.to_s
+            case @image_format.color_format
+            when BmpMonochromeColorFormat
+              params['bt'] = @image_format.color_format.black_threshold.to_s if @image_format.color_format.black_threshold
+              params['dp'] = @image_format.color_format.dithering_percent.to_s if @image_format.color_format.dithering_percent
+              params['da'] = @image_format.color_format.dithering_algorithm.to_s if @image_format.color_format.dithering_algorithm
+            end
+          end
+        end
+      end
+
+      uri.query = URI.encode_www_form(params)
+
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+      request.set_form_data(params)
+      req_options = {
+        use_ssl: uri.scheme == 'https',
+        verify_mode: OpenSSL::SSL::VERIFY_NONE
+      }
+
+      resource_array = []
+      resource_array << ['pdf', @resource.data, { content_type: @resource._mime_type, filename: @resource.resource_name }] if !@resource.nil?
+
+      request.set_form(resource_array, "multipart/form-data")
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+
+      rasterizer_response = PdfImageResponse.new
+      if @resource == nil
+        raise 'Required a PDF Resource.'
+      end
+      rasterizer_response.status_code = response.code
+      out_data = response.body
+      if rasterizer_response.status_code == "200"
+        pdf_image = JSON.parse(out_data)
+
+        image_type = pdf_image['contentType']
+        rasterizer_response.image_format = image_type.split('/')[1]
+        rasterizer_response.content_type = image_type
+        rasterizer_response.horizontal_dpi = pdf_image['horizontalDpi']
+        rasterizer_response.vertical_dpi = pdf_image['verticalDpi']
+
+        pdf_image['images'].each do |img|
+          image = Image.new
+          image.page_number = img['pageNumber'] || 0
+          image.data = img['data'] || ''
+          image.billed_pages = img['billedPages'] || 0
+          image.width = img['width'] || 0
+          image.height = img['height'] || 0
+          rasterizer_response.images << image
+        end
+
+        rasterizer_response.status_code = response.code
+        rasterizer_response.is_successful = true
+      else
+        rasterizer_response.error_json = out_data
+        rasterizer_response.error_message = if !out_data_json["message"].nil?
+          out_data_json["message"]
+        else
+          "status_code : #{Net::HTTPResponse::CODE_TO_OBJ[rasterizer_response.status_code]}"
+        end
+        rasterizer_response.error_id = out_data_json["id"]
+        rasterizer_response.is_successful = false
+      end
+
+      rasterizer_response
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["startPageNumber"] = @start_page_number unless @start_page_number.nil?
+      json_array["pageCount"] = @page_count unless @page_count.nil?
+      json_array["imageFormat"] = @image_format unless @image_format.nil?
+      json_array["imageSize"] = @image_size unless @image_size.nil?
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/PdfImageResponse.rb

@@ -0,0 +1,40 @@
+module DynamicPDFApi
+  require_relative '..\Response'
+
+  #
+  # Represents a response from the rasterizer operation.
+  #
+  class PdfImageResponse < Response
+
+    attr_accessor :image_format
+
+    attr_accessor :images
+
+    attr_accessor :content_type
+
+    attr_accessor :horizontal_dpi
+
+    attr_accessor :vertical_dpi
+
+    #
+    # Initializes a new instance of the RasterizerResponse class.
+    #
+    def initialize
+      @image_format = nil
+      @images = []
+    end
+  end
+
+  class Image
+    attr_accessor :page_number
+
+    attr_accessor :data
+
+    attr_accessor :billed_pages
+
+    attr_accessor :width
+
+    attr_accessor :height
+
+  end
+end

data/lib/ruby_client/Imaging/PercentageImageSize.rb

@@ -0,0 +1,35 @@
+module DynamicPDFApi
+  require_relative "ImageSize"
+  require_relative "ImageSizeType"
+
+  #
+  # Represents an image size based on percentage scaling.
+  #
+  class PercentageImageSize < ImageSize
+    attr_accessor :horizontal_percentage  # Gets or sets the horizontal scaling percentage.
+    attr_accessor :vertical_percentage  # Gets or sets the vertical scaling percentage.
+
+    #
+    # Initializes a new instance of the PercentageImageSize class.
+    #
+    def initialize
+      super()
+      @horizontal_percentage = nil
+      @vertical_percentage = nil
+      @type = ImageSizeType::Percentage
+    end
+
+    #
+    # Returns a JSON representation of the PercentageImageSize object.
+    #
+    # @return [String] JSON string representing the PercentageImageSize object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'percentage'
+      json_array['horizontalPercentage'] = @horizontal_percentage
+      json_array['verticalPercentage'] = @vertical_percentage
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/PngColorFormat.rb

@@ -0,0 +1,18 @@
+module DynamicPDFApi
+  require_relative 'ColorFormatType'
+  require_relative 'ColorFormat'
+
+  #
+  # Base class for PNG color formats, used for RGB, RGBA, and Grayscale color formats.
+  #
+  class PngColorFormat < ColorFormat
+    #
+    # Initializes a new instance of the PngColorFormat class.
+    #
+    # @param type [ColorFormatType] The color format type.
+    #
+    def initialize(type)
+      @type = type
+    end
+  end
+end

data/lib/ruby_client/Imaging/PngImageFormat.rb

@@ -0,0 +1,33 @@
+module DynamicPDFApi
+
+  require_relative 'ImageFormatType'
+  require_relative 'ImageFormat'
+
+  #
+  # Represents PNG image format with color format.
+  #
+  class PngImageFormat < ImageFormat
+    attr_accessor :color_format  # Gets or sets the PngColorFormat for PNG.
+
+    #
+    # Initializes a new instance of the PngImageFormat class.
+    #
+    def initialize
+      super(ImageFormatType::PNG)
+      @color_format = nil
+    end
+
+    #
+    # Returns a JSON representation of the PngImageFormat object.
+    #
+    # @return [String] JSON string representing the PngImageFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'png'
+
+      json_array['colorFormat'] = @color_format
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/PngIndexedColorFormat.rb

@@ -0,0 +1,32 @@
+module DynamicPDFApi
+  require_relative 'PngColorFormat'
+  require_relative 'ColorFormatType'
+
+  #
+  # Represents indexed color format for PNG.
+  #
+  class PngIndexedColorFormat < PngColorFormat
+    attr_accessor :quantization_algorithm  # Gets or sets the QuantizationAlgorithm for PNG.
+    attr_accessor :dithering_percent       # Gets or sets the dithering percentage for PNG.
+    attr_accessor :dithering_algorithm     # Gets or sets the DitheringAlgorithm for PNG.
+
+    #
+    # Initializes a new instance of the PngIndexedColorFormat class with indexed color format type.
+    #
+    def initialize
+      super(ColorFormatType::Indexed)
+      @quantization_algorithm = nil
+      @dithering_percent = nil
+      @dithering_algorithm = nil
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['quantizationAlgorithm'] = @quantization_algorithm
+      json_array['ditheringPercent'] = @dithering_percent
+      json_array['ditheringAlgorithm'] = @dithering_algorithm
+      JSON.pretty_generate(json_array)
+    end
+
+  end
+end

data/lib/ruby_client/Imaging/PngMonochromeColorFormat.rb

@@ -0,0 +1,23 @@
+module DynamicPDFApi
+  require_relative 'PngColorFormat'
+  require_relative 'ColorFormatType'
+
+  #
+  # Represents monochrome color format for PNG with black threshold.
+  #
+  class PngMonochromeColorFormat < PngColorFormat
+    attr_accessor :black_threshold     # Gets or sets the black threshold for monochrome PNG, ranges from 0-255.
+    attr_accessor :dithering_percent   # Gets or sets the dithering percentage for PNG.
+    attr_accessor :dithering_algorithm # Gets or sets the DitheringAlgorithm for PNG.
+
+    #
+    # Initializes a new instance of the PngMonochromeColorFormat class with monochrome color format type.
+    #
+    def initialize
+      super(ColorFormatType::Monochrome)
+      @black_threshold = nil
+      @dithering_percent = nil
+      @dithering_algorithm = nil
+    end
+  end
+end

data/lib/ruby_client/Imaging/QuantizationAlgorithm.rb

@@ -0,0 +1,26 @@
+module DynamicPDFApi
+  #
+  # Enum representing quantization algorithms.
+  #
+  class QuantizationAlgorithm
+    #
+    # Octree quantization algorithm.
+    #
+    Octree = :Octree.freeze
+
+    #
+    # Web-safe color quantization algorithm.
+    #
+    WebSafe = :WebSafe.freeze
+
+    #
+    # Werner quantization algorithm.
+    #
+    Werner = :Werner.freeze
+
+    #
+    # Wu quantization algorithm.
+    #
+    WU = :WU.freeze
+  end
+end

data/lib/ruby_client/Imaging/TiffColorFormat.rb

@@ -0,0 +1,17 @@
+require_relative "ColorFormat"
+
+module DynamicPDFApi
+  #
+  # Base class for TIFF color formats and used for RGB and Grayscale color formats.
+  #
+  class TiffColorFormat < ColorFormat
+    #
+    # Initializes a new instance of the TiffColorFormat class with the specified color format type.
+    #
+    # @param type [ColorFormatType] The color format type.
+    #
+    def initialize(type)
+      @type = type
+    end
+  end
+end

data/lib/ruby_client/Imaging/TiffImageFormat.rb

@@ -0,0 +1,34 @@
+require_relative "ImageFormat"
+require_relative "ImageFormatType"
+
+module DynamicPDFApi
+  #
+  # Represents TIFF image format with color format.
+  #
+  class TiffImageFormat < ImageFormat
+    attr_accessor :multi_page  # Gets or sets a value indicating whether the TIFF image format supports multiple pages.
+    attr_accessor :color_format  # Gets or sets the color format for TIFF, TiffColorFormat.
+
+    #
+    # Initializes a new instance of the TiffImageFormat class.
+    #
+    def initialize
+      super(ImageFormatType::TIFF)
+      @multi_page = false
+      @color_format = nil
+    end
+
+    #
+    # Returns a JSON representation of the TiffImageFormat object.
+    #
+    # @return [String] JSON string representing the TiffImageFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['multiPage'] = @multi_page
+      json_array['colorFormat'] = @color_format  # Assuming TiffColorFormat has implemented to_json method.
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/TiffIndexedColorFormat.rb

@@ -0,0 +1,37 @@
+require_relative "TiffColorFormat"
+require_relative "ColorFormatType"
+
+module DynamicPDFApi
+  #
+  # Represents indexed color format for TIFF.
+  #
+  class TiffIndexedColorFormat < TiffColorFormat
+    attr_accessor :quantization_algorithm  # Gets or sets the QuantizationAlgorithm for TIFF.
+    attr_accessor :dithering_percent  # Gets or sets the dithering percentage for TIFF.
+    attr_accessor :dithering_algorithm  # Gets or sets the DitheringAlgorithm for TIFF.
+
+    #
+    # Initializes a new instance of the TiffIndexedColorFormat class with indexed color format type.
+    #
+    def initialize
+      super(ColorFormatType::Indexed)
+      @quantization_algorithm = nil
+      @dithering_percent = nil
+      @dithering_algorithm = nil
+    end
+
+    #
+    # Returns a JSON representation of the TiffIndexedColorFormat object.
+    #
+    # @return [String] JSON string representing the TiffIndexedColorFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['quantizationAlgorithm'] = @quantization_algorithm
+      json_array['ditheringPercent'] = @dithering_percent
+      json_array['ditheringAlgorithm'] = @dithering_algorithm
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Imaging/TiffMonochromeColorFormat.rb

@@ -0,0 +1,40 @@
+require_relative "TiffColorFormat"
+require_relative "ColorFormatType"
+
+module DynamicPDFApi
+  #
+  # Represents monochrome color format for TIFF with black threshold and compression type.
+  #
+  class TiffMonochromeColorFormat < TiffColorFormat
+    attr_accessor :black_threshold  # Gets or sets the black threshold for monochrome TIFF.
+    attr_accessor :compression_type  # Gets or sets the CompressionType for monochrome TIFF.
+    attr_accessor :dithering_percent  # Gets or sets the dithering percentage for TIFF.
+    attr_accessor :dithering_algorithm  # Gets or sets the DitheringAlgorithm for TIFF.
+
+    #
+    # Initializes a new instance of the TiffMonochromeColorFormat class with monochrome color format type.
+    #
+    def initialize
+      super(ColorFormatType::Monochrome)
+      @black_threshold = nil
+      @compression_type = nil
+      @dithering_percent = nil
+      @dithering_algorithm = nil
+    end
+
+    #
+    # Returns a JSON representation of the TiffMonochromeColorFormat object.
+    #
+    # @return [String] JSON string representing the TiffMonochromeColorFormat object.
+    #
+    def to_json(_options = {})
+      json_array = {}
+      json_array['blackThreshold'] = @black_threshold
+      json_array['compressionType'] = @compression_type
+      json_array['ditheringPercent'] = @dithering_percent
+      json_array['ditheringAlgorithm'] = @dithering_algorithm
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Outline.rb

@@ -31,8 +31,6 @@ module DynamicPDFApi
         @action = action
       else
         @_from_input_id = input.id
-        input.merge_options = MergeOptions.new if input.merge_options.nil?
-        input.merge_options.out_lines = false
       end
     end
 

data/lib/ruby_client/Pdf.rb

@@ -51,11 +51,30 @@ module DynamicPDFApi
     # <param name="resourceName">The name of the resource.
     def add_additional_resource(resourcePath, resourceName = nil)
       if (resourceName == nil)
-        resourceName = Path.GetFileName(resourcePath)
+        resourceName = File.basename(resourcePath)
       end
+      additional_resource = AdditionalResource.new(resourcePath, resourceName)
+      @resources[resourceName] = additional_resource
+      # @additionalResources << additional_resource
+    end
 
-      resource = AdditionalResource.new(resourcePath, resourceName)
-      @resources.Add(resource)
+    def add_additional_resource_with_resourcedata(resourceData, additionalResourceType, resourceName)
+      type = ResourceType::PDF
+      case (additionalResourceType)
+
+      when AdditionalResourceType::FONT
+        type = ResourceType::FONT
+      when AdditionalResourceType::IMAGE
+        type = ResourceType::IMAGE
+      when AdditionalResourceType::PDF
+        type = ResourceType::PDF
+      when AdditionalResourceType::HTML
+        type = ResourceType::HTML
+      else
+        raise 'This type of resource not allowed'
+      end
+      additional_resource = AdditionalResource.new(resourceData, resourceName, type)
+      @additionalResources << additional_resource
     end
 
     attr_accessor :instructions

data/lib/ruby_client/PdfInstructions.rb

@@ -18,7 +18,7 @@ module DynamicPDFApi
       @_form_fields = []
       @_templates = {}
       @_fonts = {}
-      @_outlines = []
+      @_out_lines = []
       @_inputs = []
       @_security = nil
       @_flatten_all_form_fields = nil
@@ -84,8 +84,8 @@ module DynamicPDFApi
         json_array['formFields'] = @_form_fields
       end
 
-      if(@_outlines.length > 0)
-        json_array['outlines'] = @_outlines
+      if(!@_out_lines._out_lines.empty?)
+        json_array['outlines'] = @_out_lines
       end
       if(indented)
         JSON.pretty_generate(json_array)

data/lib/ruby_client/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module RubyClient
-VERSION = "1.0.1" 
+VERSION = "1.1.0" 
 end

data/lib/ruby_client.rb

@@ -115,6 +115,35 @@ require_relative "ruby_client/Elements/StackedGs1DataBarType.rb"
 require_relative "ruby_client/Elements/TextBarcodeElement.rb"
 require_relative "ruby_client/Elements/TextElement.rb"
 require_relative "ruby_client/Elements/ValueType.rb"
+require_relative "ruby_client/Imaging/ColorFormatType.rb"
+require_relative "ruby_client/Imaging/CompressionType.rb"
+require_relative "ruby_client/Imaging/DitheringAlgorithm.rb"
+require_relative "ruby_client/Imaging/DpiImageSize.rb"
+require_relative "ruby_client/Imaging/FixedImageSize.rb"
+require_relative "ruby_client/Imaging/GifImageFormat.rb"
+require_relative "ruby_client/Imaging/ImageFormat.rb"
+require_relative "ruby_client/Imaging/ImageFormatType.rb"
+require_relative "ruby_client/Imaging/ImageSize.rb"
+require_relative "ruby_client/Imaging/ImageSizeType.rb"
+require_relative "ruby_client/Imaging/ImageSizeUnit.rb"
+require_relative "ruby_client/Imaging/JpegImageFormat.rb"
+require_relative "ruby_client/Imaging/MaxImageSize.rb"
+require_relative "ruby_client/Imaging/PercentageImageSize.rb"
+require_relative "ruby_client/Imaging/PngColorFormat.rb"
+require_relative "ruby_client/Imaging/PngImageFormat.rb"
+require_relative "ruby_client/Imaging/PngIndexedColorFormat.rb"
+require_relative "ruby_client/Imaging/PngMonochromeColorFormat.rb"
+require_relative "ruby_client/Imaging/QuantizationAlgorithm.rb"
+require_relative "ruby_client/Imaging/PdfImage.rb"
+require_relative "ruby_client/Imaging/PdfImageResponse.rb"
+require_relative "ruby_client/Imaging/TiffColorFormat.rb"
+require_relative "ruby_client/Imaging/TiffImageFormat.rb"
+require_relative "ruby_client/Imaging/TiffIndexedColorFormat.rb"
+require_relative "ruby_client/Imaging/TiffMonochromeColorFormat.rb"
+require_relative "ruby_client/Imaging/BmpColorFormat.rb"
+require_relative "ruby_client/Imaging/BmpImageFormat.rb"
+require_relative "ruby_client/Imaging/BmpMonochromeColorFormat.rb"
+require_relative "ruby_client/Imaging/ColorFormat.rb"
 
 module RubyClient
   class Error < StandardError; end

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: dynamicpdf_api
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.1.0
 platform: ruby
 authors:
 - Dynamicpdf
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2024-06-24 00:00:00.000000000 Z
+date: 2024-08-09 00:00:00.000000000 Z
 dependencies: []
 description: A Ruby Client API that uses the DynamicPDF API to create, merge, split,
   form fill, stamp, secure/encrypt PDF documents and convert word/Excel files to PDF.
@@ -91,6 +91,35 @@ files:
 - lib/ruby_client/ImageInput.rb
 - lib/ruby_client/ImageResource.rb
 - lib/ruby_client/ImageResponse.rb
+- lib/ruby_client/Imaging/BmpColorFormat.rb
+- lib/ruby_client/Imaging/BmpImageFormat.rb
+- lib/ruby_client/Imaging/BmpMonochromeColorFormat.rb
+- lib/ruby_client/Imaging/ColorFormat.rb
+- lib/ruby_client/Imaging/ColorFormatType.rb
+- lib/ruby_client/Imaging/CompressionType.rb
+- lib/ruby_client/Imaging/DitheringAlgorithm.rb
+- lib/ruby_client/Imaging/DpiImageSize.rb
+- lib/ruby_client/Imaging/FixedImageSize.rb
+- lib/ruby_client/Imaging/GifImageFormat.rb
+- lib/ruby_client/Imaging/ImageFormat.rb
+- lib/ruby_client/Imaging/ImageFormatType.rb
+- lib/ruby_client/Imaging/ImageSize.rb
+- lib/ruby_client/Imaging/ImageSizeType.rb
+- lib/ruby_client/Imaging/ImageSizeUnit.rb
+- lib/ruby_client/Imaging/JpegImageFormat.rb
+- lib/ruby_client/Imaging/MaxImageSize.rb
+- lib/ruby_client/Imaging/PdfImage.rb
+- lib/ruby_client/Imaging/PdfImageResponse.rb
+- lib/ruby_client/Imaging/PercentageImageSize.rb
+- lib/ruby_client/Imaging/PngColorFormat.rb
+- lib/ruby_client/Imaging/PngImageFormat.rb
+- lib/ruby_client/Imaging/PngIndexedColorFormat.rb
+- lib/ruby_client/Imaging/PngMonochromeColorFormat.rb
+- lib/ruby_client/Imaging/QuantizationAlgorithm.rb
+- lib/ruby_client/Imaging/TiffColorFormat.rb
+- lib/ruby_client/Imaging/TiffImageFormat.rb
+- lib/ruby_client/Imaging/TiffIndexedColorFormat.rb
+- lib/ruby_client/Imaging/TiffMonochromeColorFormat.rb
 - lib/ruby_client/Input.rb
 - lib/ruby_client/InputType.rb
 - lib/ruby_client/JsonResponse.rb