dynamicpdf_api 1.0.1 → 1.1.1

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