dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/FormFieldInformation.rb

@@ -0,0 +1,45 @@
+module DynamicPDFApi
+  #
+  # Represents the form field information containing the collection of different types of field informations.
+  #
+  class FormFieldInformation
+    def initialize
+      @signature_fields = nil
+      @text_fields = nil
+      @choice_fields = nil
+      @button_fields = nil
+      @push_buttons = nil
+      @multi_select_list_box_fields = nil
+    end
+
+    #
+    # Gets or sets a collection of SignatureFieldInformation.
+    #
+    attr_accessor :signature_fields
+
+    #
+    # Gets or sets a collection of TextFieldInformation.
+    #
+    attr_accessor :text_fields
+
+    #
+    # Gets or sets a collection of ChoiceFieldInformation.
+    #
+    attr_accessor :choice_fields
+
+    #
+    # Gets or sets a collection of ButtonFieldInformation.
+    #
+    attr_accessor :button_fields
+
+    #
+    # Gets or sets a collection of PushButtonInformation.
+    #
+    attr_accessor :push_buttons
+
+    #
+    # Gets or sets a collection of MultiSelectListBoxInformation.
+    #
+    attr_accessor :multi_select_list_box_fields
+  end
+end

data/lib/ruby_client/GoToAction.rb

@@ -0,0 +1,53 @@
+module DynamicPDFApi
+  require_relative 'Action'
+  require_relative 'Input'
+  require_relative 'PageZoom'
+
+  #
+  # Represents a goto action in a PDF document that navigates to a specific page using page number and zoom
+  # options.
+  #
+  class GoToAction < Action
+    #
+    # Initializes a new instance of the GoToAction class using an input to create the PDF, page number, and
+    # a zoom option.
+    #
+    # @param input [Input] Any of the ImageInput, DlexInput, PdfInput or PageInput objects to create PDF.
+    # @param page_offset [int] Page number to navigate.
+    # @param page_zoom [String] PageZoom to display the destination.
+    #
+    def initialize(input, page_offset = 0, page_zoom = PageZoom::FIT_PAGE)
+      super()
+      @_input = input
+      @_input_id = input.id
+      @page_offset = page_offset
+      @page_zoom = page_zoom
+    end
+
+    attr_accessor :_input, :_input_id
+
+    #
+    # Gets or sets page Offset.
+    #
+    attr_accessor :page_offset
+
+    #
+    # Gets or sets PageZoom to display the destination.
+    #
+    attr_accessor :page_zoom
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['input'] = @_input unless @_input.nil?
+
+      json_array['inputID'] = @_input_id unless @_input_id.nil?
+
+      json_array['pageOffset'] = @page_offset unless @page_offset.nil?
+
+      json_array['pageZoom'] = @page_zoom unless @page_zoom.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Grayscale.rb

@@ -0,0 +1,41 @@
+module DynamicPDFApi
+  require_relative "Color"
+
+  #
+  # Represents a grayscale color.
+  #
+  class Grayscale < Color
+    #
+    # Initializes a new instance of the  Grayscale class.
+    #
+    # @param gray_level [float] The gray level for the color.
+    #
+    def initialize(gray_level = 0)
+      super()
+      @gray_level = gray_level
+      @_color_string = "gray(#{gray_level})"
+    end
+
+    def self.create_grayscale(gray_level)
+      gray_scale = Grayscale.new
+      gray_scale._color_string = gray_level
+      gray_scale
+    end
+
+    #
+    # Gets the color black.
+    #
+    def self.black
+      Grayscale.new(0)
+    end
+
+    #
+    # Gets the color white.
+    #
+    def self.white
+      Grayscale.new(1)
+    end
+
+    attr_accessor :_color_string
+  end
+end

data/lib/ruby_client/HtmlInput.rb

@@ -0,0 +1,60 @@
+module DynamicPDFApi
+  require_relative "UnitConverter"
+  #
+  # Represents a html input.
+  #
+  class HtmlInput < ConverterInput
+
+    #
+    # Initializes a new instance of the HtmlInput class.
+    #
+    # @param resource [HtmlResource] The resource of type HtmlResource.
+    # @param base_path [string] The base_path options for the url.
+    # @param size [PageSize] The page size of the output PDF.
+    # @param orientation [PageOrientation] The page orientation of the output PDF.
+    # @param margins [float] The page margins of the output PDF.
+    def initialize(resource, base_path = nil, size = PageSize::LETTER, orientation = PageOrientation::PORTRAIT, margins = nil)
+      super(resource, size, orientation, margins)
+
+      @_type = InputType::HTML
+
+      if (base_path != nil)
+        @base_path = base_path
+      end
+    end
+
+    #
+    # Gets or sets the base path option.
+    #
+    attr_accessor :base_path
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "html"
+
+      json_array["basePath"] = @scale_x unless @scale_x.nil?
+
+      json_array["topMargin"] = @top_margin unless @top_margin.nil?
+
+      json_array["leftMargin"] = @left_margin unless @left_margin.nil?
+
+      json_array["bottomMargin"] = @bottom_margin unless @bottom_margin.nil?
+
+      json_array["rightMargin"] = @right_margin unless @right_margin.nil?
+
+      json_array["pageWidth"] = @page_width unless @page_width.nil?
+
+      json_array["pageHeight"] = @page_height unless @page_height.nil?
+
+      #---------------------------------------------------
+      json_array["templateId"] = @_template_id unless @_template_id.nil?
+
+      json_array["resourceName"] = @resource_name unless @resource_name.nil?
+
+      json_array["id"] = @id unless @id.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/HtmlResource.rb

@@ -0,0 +1,34 @@
+module DynamicPDFApi
+  #
+  # Represents a pdf resource.
+  #
+  class HtmlResource < Resource
+
+    #
+    # Initializes a new instance of the HtmlResource class.
+    #
+    # @param name="html">The input html string.
+    # @param name="resourceName">The name of the resource.
+    def initialize(html, resourceName = nil)
+      @_file_extension = ".html"
+      @_mime_type = "text/html"
+
+      @data = html
+
+      @resource_name = if resource_name.nil?
+          SecureRandom.uuid + @_file_extension
+        else
+          resource_name
+        end
+      _type = ResourceType::HTML
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array["type"] = "html"
+
+      json_array["resourceName"] = @resource_name
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/ImageInfo.rb

@@ -0,0 +1,69 @@
+module DynamicPDFApi
+  require_relative 'Endpoint'
+  require_relative 'ImageResponse'
+
+  #
+  # Represents an image information endpoint.
+  #
+  class ImageInfo < Endpoint
+    #
+    # Initializes a new instance of the ImageInfo class.
+    #
+    # ImageResource resource The image resource of type ImageResource.
+    #
+    def initialize(resource)
+      @_endpoint_name = 'image-info'
+      super()
+      @resource = resource
+    end
+
+    #
+    # Process the image resource to get image's information.
+    #
+    # @return ImageResponse Returns collection of ImageResponse.
+    #
+    def process
+      header = {
+        'Authorization': "Bearer #{@api_key}",
+        'Content-Length': @resource.data.length.to_s,
+        'Expect': '100-continue',
+        'Content-Type': "image/#{@resource._file_extension[1, @resource._file_extension.length - 1]}"
+      }
+      uri = URI.parse("#{@base_url}/v1.0/#{@_endpoint_name}")
+
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+
+      req_options = {
+        use_ssl: uri.scheme == 'https',
+        verify_mode: OpenSSL::SSL::VERIFY_NONE
+
+      }
+
+      request.content_type = "image/#{@resource._file_extension[1, @resource._file_extension.length - 1]}"
+
+      request.body = @resource.data
+
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+      out_data = response.body
+      ret_object = ImageResponse.new(out_data)
+      ret_object.is_successful = false
+      ret_object.status_code = response.code
+      if ret_object.status_code == '200'
+        ret_object.is_successful = true
+      else
+        out_data_json = JSON.parse(out_data)
+        ret_object.error_json = out_data
+        ret_object.error_message = if !out_data_json['message'].nil?
+                                     out_data_json['message']
+                                   else
+                                     "status_code : #{Net::HTTPResponse::CODE_TO_OBJ[ret_object.status_code]}"
+                                   end
+        ret_object.error_id = out_data_json['id']
+      end
+
+      ret_object
+    end
+  end
+end

data/lib/ruby_client/ImageInformation.rb

@@ -0,0 +1,57 @@
+module DynamicPDFApi
+  #
+  # Represents an image information.
+  #
+  class ImageInformation
+    def initialize(_resource)
+      @page_number = nil
+      @width = nil
+      @height = nil
+      @horizontal_dpi = nil
+      @vertical_dpi = nil
+      @number_of_components = nil
+      @bits_per_component = nil
+      @color_space = nil
+    end
+
+    #
+    # Gets page number of the pdf where the image is present.
+    #
+    attr_accessor :page_number
+
+    #
+    # Gets the width of the image.
+    #
+    attr_accessor :width
+
+    #
+    # Gets the height of the image.
+    #
+    attr_accessor :height
+
+    #
+    # Gets the horizontalDpi of the image.
+    #
+    attr_accessor :horizontal_dpi
+
+    #
+    # Gets the verticalDpi of the image.
+    #
+    attr_accessor :vertical_dpi
+
+    #
+    # Gets the number of color components present in the image.
+    #
+    attr_accessor :number_of_components
+
+    #
+    # Gets the bits per component of the image.
+    #
+    attr_accessor :bits_per_component
+
+    #
+    # Gets the color space of the image.
+    #
+    attr_accessor :color_space
+  end
+end

data/lib/ruby_client/ImageInput.rb

@@ -0,0 +1,150 @@
+module DynamicPDFApi
+  require_relative 'Input'
+  require_relative 'ImageResource'
+  require_relative 'InputType'
+  require_relative 'Align'
+  require_relative 'VAlign'
+
+  #
+  # Represents an image input.
+  #
+  class ImageInput < Input
+    #
+    # Initializes a new instance of the ImageInput class.
+    #
+    # @param resource [String]|[ImageResource] The image file path present in cloud resource manager or the ImageResource object to create ImageInput.
+    #
+    def initialize(resource)
+      @_type = InputType::IMAGE
+      @scale_x = nil
+      @scale_y = nil
+      @top_margin = nil
+      @left_margin = nil
+      @bottom_margin = nil
+      @right_margin = nil
+      @page_width = nil
+      @page_height = nil
+      @expand_to_fit = nil
+      @shrink_to_fit = nil
+      @align = Align::CENTER
+      @v_align = VAlign::CENTER
+      @start_page = nil
+      @page_count = nil
+      super(resource)
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets the scaleX of the image.
+    #
+    attr_accessor :scale_x
+
+    #
+    # Gets or sets the scaleY of the image.
+    #
+    attr_accessor :scale_y
+    #
+    # Gets or sets the top margin.
+    #
+    attr_accessor :top_margin
+
+    #
+    # Gets or sets the left margin.
+    #
+    attr_accessor :left_margin
+
+    #
+    # Gets or sets the bottom margin.
+    #
+    attr_accessor :bottom_margin
+
+    #
+    # Gets or sets the right margin.
+    #
+    attr_accessor :right_margin
+
+    #
+    # Gets or sets the page width.
+    #
+    attr_accessor :page_width
+
+    #
+    # Gets or sets the page height.
+    #
+    attr_accessor :page_height
+
+    #
+    # Gets or sets a boolean indicating whether to expand the image.
+    #
+    attr_accessor :expand_to_fit
+
+    #
+    # Gets or sets a boolean indicating whether to shrink the image.
+    #
+    attr_accessor :shrink_to_fit
+
+    #
+    # Gets or sets the horizontal alignment of the image.
+    #
+    attr_accessor :align
+
+    #
+    # Gets or sets the vertical alignment of the image.
+    #
+    attr_accessor :v_align
+
+    #
+    # Gets or sets the start page.
+    #
+    attr_accessor :start_page
+
+    #
+    # Gets or sets the page count.
+    #
+    attr_accessor :page_count
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['type'] = 'image'
+
+      json_array['scaleX'] = @scale_x unless @scale_x.nil?
+
+      json_array['scaleY'] = @scale_y unless @scale_y.nil?
+
+      json_array['topMargin'] = @top_margin unless @top_margin.nil?
+
+      json_array['leftMargin'] = @left_margin unless @left_margin.nil?
+
+      json_array['bottomMargin'] = @bottom_margin unless @bottom_margin.nil?
+
+      json_array['rightMargin'] = @right_margin unless @right_margin.nil?
+
+      json_array['pageWidth'] = @page_width unless @page_width.nil?
+
+      json_array['pageHeight'] = @page_height unless @page_height.nil?
+
+      json_array['expandToFit'] = @expand_to_fit unless @expand_to_fit.nil?
+
+      json_array['shrinkToFit'] = @shrink_to_fit unless @shrink_to_fit.nil?
+
+      json_array['align'] = @align unless @align.nil?
+
+      json_array['vAlign'] = @a_align unless @a_align.nil?
+
+      json_array['startPage'] = @start_page unless @start_page.nil?
+
+      json_array['pageCount'] = @page_count unless @page_count.nil?
+
+      #---------------------------------------------------
+      json_array['templateId'] = @_template_id unless @_template_id.nil?
+
+      json_array['resourceName'] = @resource_name unless @resource_name.nil?
+
+      json_array['id'] = @id unless @id.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/ImageResource.rb

@@ -0,0 +1,89 @@
+module DynamicPDFApi
+  require_relative "Resource"
+  require_relative "ResourceType"
+  require_relative "EndPointException"
+
+  #
+  # Represents an image resource used to create an ImageInput object to create PDF from images.
+  #
+  class ImageResource < Resource
+    #
+    # Initializes a new instance of the ImageResource class.
+    #
+    # @param file [String]|[Stream] The image file path or the byte  of the image file or the stream of the image file.
+    # @param resource_name [String] The name of the resource.
+    #
+    def initialize(file, resource_name = nil)
+      @_type = ResourceType::IMAGE
+      @_mime_type = nil
+      super(file, resource_name)
+    end
+
+    def _file_extension
+      @file_header = @data[0, 16]
+      @file_header = @file_header.bytes
+
+      if ImageResource.is_png_image(@file_header)
+        @_mime_type = "image/png"
+        ".png"
+      elsif ImageResource.is_jpeg_image(@file_header)
+        @_mime_type = "image/jpeg"
+        ".jpeg"
+      elsif ImageResource.is_gif_image(@file_header)
+        @_mime_type = "image/gif"
+        ".gif"
+      elsif ImageResource.is_tiff_image(@file_header)
+        @_mime_type = "image/tiff"
+        ".tiff"
+      elsif ImageResource.is_jpeg2000_image(@file_header)
+        @_mime_type = "image/jpeg"
+        ".jpeg"
+      elsif ImageResource.is_valid_bitmap_image(@file_header)
+        @_mime_type = "image/bmp"
+        ".bmp"
+      else
+        raise "Not supported image type or invalid image."
+      end
+    end
+
+    def self.is_jpeg2000_image(header)
+      (header[0] == 0x00 && header[1] == 0x00 && header[2] == 0x00 && header[3] == 0x0C && header[4] == 0x6A &&
+       header[5] == 0x50 && (header[6] == 0x1A || header[6] == 0x20) && (header[7] == 0x1A || header[7] == 0x20) &&
+       header[8] == 0x0D && header[9] == 0x0A && header[10] == 0x87 && header[11] == 0x0A) ||
+        (header[0] == 0xFF && header[1] == 0x4F && header[2] == 0xFF && header[3] == 0x51 && header[6] == 0x00 && header[7] == 0x00)
+    end
+
+    def self.is_png_image(header)
+      header[0] == 0x89 && header[1] == 0x50 && header[2] == 0x4E && header[3] == 0x47 &&
+        header[4] == 0x0D && header[5] == 0x0A && header[6] == 0x1A && header[7] == 0x0A
+    end
+
+    def self.is_tiff_image(header)
+      (header[0] == 0x49 && header[1] == 0x49 && header[2] == 0x2A && header[3] == 0x00) ||
+        (header[0] == 0x4D && header[1] == 0x4D && header[2] == 0x00 && header[3] == 0x2A)
+    end
+
+    def self.is_gif_image(header)
+      header[0] == 0x47 && header[1] == 0x49 && header[2] == 0x46 && header[3] == 0x38 && (header[4] == 0x37 ||
+                                                                                           header[4] == 0x39) && header[5] == 0x61
+    end
+
+    def self.is_jpeg_image(header)
+      header[0] == 0xFF && header[1] == 0xD8 && header[2] == 0xFF
+    end
+
+    def self.is_valid_bitmap_image(header)
+      header[0] == 0x42 && header[1] == 0x4D
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array["type"] = "image"
+      json_array["align"] = 1
+      json_array["vAlign"] = 1
+
+      json_array["resourceName"] = @resource_name
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/ImageResponse.rb

@@ -0,0 +1,24 @@
+module DynamicPDFApi
+  require_relative 'JsonResponse'
+
+  #
+  # Represents an image response.
+  #
+  class ImageResponse < JsonResponse
+    #
+    # Initializes a new instance of the ImageResponse class.
+    #
+    # @param json_content [String] The image content of the response.
+    #
+    def initialize(json_content = nil)
+      @content = nil
+      super(json_content) unless json_content.nil?
+      @content = JSON.parse(json_content)
+    end
+
+    #
+    # Gets or sets a collection of ImageInformation.
+    #
+    attr_accessor :content
+  end
+end

data/lib/ruby_client/Input.rb

@@ -0,0 +1,53 @@
+module DynamicPDFApi
+  require_relative 'InputType'
+  require_relative 'Resource'
+
+  #
+  # Represents the base class for inputs.
+  #
+  class Input
+    def initialize(resource = nil)
+      @_resources = []
+      @template = nil
+      @_type = nil
+      @_template_id = nil
+
+      if resource.is_a?(String)
+        @resource_name = resource
+      elsif !resource.nil?
+        @_resources << resource
+        @resource_name = resource.resource_name
+      end
+
+      @id = SecureRandom.uuid
+    end
+
+    attr_accessor :_type, :_template_id, :_resources
+
+    #
+    # Gets or sets the resource name.
+    #
+    attr_accessor :resource_name
+
+    #
+    # Gets or sets the id.
+    #
+    attr_accessor :id
+
+    #
+    # Gets or sets the template.
+    #
+    def set_template(template)
+      @template = template
+      @_template_id = template.id
+    end
+
+    def get_template
+      @template
+    end
+
+    def to_json(_options = {})
+      JSON.pretty_generate({})
+    end
+  end
+end