dynamicpdf_api 1.0.0.pre.beta

checksums.yaml

@@ -0,0 +1,7 @@
+---
+SHA256:
+  metadata.gz: 31198d3de33783aad8586d0ee95f309d76af7692a8282071e2c249335ba4773b
+  data.tar.gz: 8916af160d00fbe67d079503948d1823b7c87bb62012e9ce8c316abc4bb291fc
+SHA512:
+  metadata.gz: c861c279b7312834a3f5825eb9a671117d661d7cf430dd648272af99e5b5864c93e435f9ea04d4983fa2e82cc9f93a5ea70353954fd607baa6c7fb19370af7a5
+  data.tar.gz: 010eb606bc82330b73d1974cfca97aaaf21480cdd8e6b674948b499180f5d7af466bfbeca60c50b74c82b55c9fb6e47a6d0ae5629788157585841c7fb943b84c

data/lib/ruby_client/Action.rb

@@ -0,0 +1,15 @@
+module DynamicPDFApi
+  #
+  # Base class representing an action to perform tasks in many places such as in outlines, links, buttons
+  # etc.
+  #
+  # UrlAction and GoToAction are derived from Action.
+  #
+  class Action
+    def initialize; end
+
+    def to_json(_options = {})
+      JSON.pretty_generate({})
+    end
+  end
+end

data/lib/ruby_client/AdditionalResource.rb

@@ -0,0 +1,113 @@
+module DynamicPDFApi
+
+  require_relative 'AdditionalResourceType'
+
+  class AdditionalResource < Resource
+    def initialize(resource, resource_name, resource_type=nil)
+      @default_page_height = 792.0
+      @default_page_width = 612.0
+      @type = ResourceType::LAYOUT_DATA
+
+      if (resource.is_a?(Array)) == true
+        super(resource, resource_name)
+        @type = resource_type
+      else
+        super(resource, resource_name)
+        @type = get_resource_type(resource)
+      end
+    end
+
+    def get_resource_type(resourcePath)
+      @type = ResourceType::PDF
+      file_extension = File.extname(resourcePath).downcase
+      case (file_extension)
+
+      when ".pdf"
+        @type = ResourceType::PDF
+
+      when ".dlex"
+        @type = ResourceType::DLEX
+
+      when ".json"
+        @type = ResourceType::LAYOUT_DATA
+
+      when ".ttf"
+      when ".otf"
+        @type = ResourceType::FONT
+
+      when ".tiff"
+        @type = ResourceType::IMAGE
+      when ".tif"
+        @type = ResourceType::IMAGE
+      when ".png"
+        @type = ResourceType::IMAGE
+      when ".gif"
+        @type = ResourceType::IMAGE
+      when ".jpeg"
+        @type = ResourceType::IMAGE
+      when ".jpg"
+        @type = ResourceType::IMAGE
+      when ".bmp"
+        @type = ResourceType::IMAGE
+
+      when ".html"
+        @type = ResourceType::HTML
+
+      end
+      @type
+    end
+
+    def file_extension=(value)
+      @file_extension = value
+      case (@type)
+
+      when ResourceType::IMAGE
+        @file_header = @data[0, 16]
+        @file_header = @file_header.bytes
+        if (ImageResource.is_png_image(@file_header))
+          @_mime_type = "image/png"
+        elsif (ImageResource.is_jpeg_image(@file_header))
+          @_mime_type = "image/jpeg"
+        elsif (ImageResource.is_gif_image(@file_header))
+          @_mime_type = "image/gif"
+        elsif (ImageResource.is_tiff_image(@file_header))
+          @_mime_type = "image/tiff"
+        elsif (ImageResource.is_jpeg2000_image(@file_header))
+          @_mime_type = "image/jpeg"
+        elsif (ImageResource.is_valid_bitmap_image(@file_header))
+          @_mime_type = "image/bmp"
+        else
+          raise "Not supported image type or invalid image."
+        end
+      when ResourceType::PDF
+        @_mime_type = "application/pdf"
+        ".pdf"
+      when ResourceType::LAYOUT_DATA
+        @_mime_type = "application/json"
+        ".json"
+      when ResourceType::DLEX
+        @_mime_type = "application/xml"
+        ".dlex"
+      when ResourceType::FONT
+        if (Data[0] == 0x4f && Data[1] == 0x54 && Data[2] == 0x54 && Data[3] == 0x4f)
+          @_mime_type = "font/otf"
+          ".otf"
+        elsif (Data[0] == 0x00 && Data[1] == 0x01 && Data[2] == 0x00 && Data[3] == 0x00)
+          @_mime_type = "font/ttf"
+          ".ttf"
+        else
+          raise "Unsupported font"
+        end
+      when ResourceType::Html
+        @_mime_type = "text/html"
+        ".html"
+      end
+      nil
+    end
+
+    attr_accessor :type
+    attr_accessor :_mime_type
+    attr_accessor :default_page_height
+    attr_accessor :default_page_width
+  end
+end

data/lib/ruby_client/AdditionalResourceType.rb

@@ -0,0 +1,27 @@
+module DynamicPDFApi
+  #
+  # Specifies additional resource type.
+  #
+  class AdditionalResourceType
+
+    #
+    # Image resource.
+    #
+    IMAGE = "Image".freeze
+
+    #
+    # Pdf resource.
+    #
+    PDF = "Pdf".freeze
+
+    #
+    # Font resource.
+    #
+    FONT = "Font".freeze
+
+    #
+    # Html resource.
+    #
+    HTML = "Html".freeze
+  end
+end

data/lib/ruby_client/Aes128Security.rb

@@ -0,0 +1,70 @@
+module DynamicPDFApi
+  require_relative 'SecurityType'
+  require_relative 'EncryptDocumentComponents'
+  require_relative 'Security'
+
+  #
+  # Represents AES 128 bit PDF document security.
+  #
+  # AES 128 bit PDF security is compatible with PDF version 1.5 and higher and, Adobe Acrobat Reader version
+  # 7 or higher is needed to open these documents. Older readers will not be able to read documents encrypted
+  # with this security.
+  #
+  class Aes128Security < Security
+    #
+    # Initializes a new instance of the Aes128Security class by taking the owner and user passwords as parameters
+    # to create PDF.
+    #
+    # @param user_password [String] The user password to open the document.
+    # @param owner_password [String] The owner password to open the document.
+    #
+    def initialize(user_password, owner_password)
+      @document_components = nil
+      @_type = SecurityType::AES_128
+      super(user_password, owner_password)
+
+    end
+
+    #
+    # Gets or sets the EncryptDocumentComponents, components of the document to be encrypted. We can encrypt
+    # all the PDF content or the content, excluding the metadata.
+    #
+    attr_accessor :document_components
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'aes128'
+
+      json_array['documentComponents'] = @document_components.downcase unless @document_components.nil?
+
+      #-------------------------------------------
+      json_array['allowCopy'] = @allow_copy unless @allow_copy.nil?
+
+      json_array['allowEdit'] = @allow_edit unless @allow_edit.nil?
+
+      json_array['allowPrint'] = @allow_print unless @allow_print.nil?
+
+      unless @allow_update_annots_and_fields.nil?
+        json_array['allowUpdateAnnotsAndFields'] =
+          @allow_update_annots_and_fields
+      end
+
+      json_array['ownerPassword'] = @owner_password unless @owner_password.nil?
+
+      json_array['userPassword'] = @user_password unless @user_password.nil?
+
+      json_array['allowAccessibility'] = @allow_accessibility unless @allow_accessibility.nil?
+
+      json_array['allowFormFilling'] = @allow_form_filling unless @allow_form_filling.nil?
+
+      unless @allow_high_resolution_printing.nil?
+        json_array['allowHighResolutionPrinting'] =
+          @allow_high_resolution_printing
+      end
+
+      json_array['allowDocumentAssembly'] = @allow_document_assembly unless @allow_document_assembly.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Aes256Security.rb

@@ -0,0 +1,70 @@
+module DynamicPDFApi
+  require_relative 'SecurityType'
+  require_relative 'EncryptDocumentComponents'
+  require_relative 'Security'
+
+  #
+  #
+  # Represents AES 256 bit PDF document security.
+  #
+  # AES 256 bit PDF security is compatible with PDF version 1.5 and higher. This class is FIPS compliant
+  # when used in applications targeting .NET framework v3.5 or higher. Adobe Acrobat Reader version X or
+  # higher is needed to open these documents.
+  #
+  class Aes256Security < Security
+    #
+    # Initializes a new instance of the Aes256Security class by taking the owner and user passwords as parameters
+    # to create PDF.
+    #
+    # @param owner_password [String] The owner password to open the document.
+    # @param user_password [String] The user password to open the document.
+    #
+    def initialize(user_password, owner_password)
+      @document_components = nil
+      @_type = SecurityType::AES_256
+      super(user_password, owner_password)
+    end
+
+    #
+    # Gets or sets the EncryptDocumentComponents, components of the document to be encrypted. We can encrypt
+    # all the PDF content or the content, excluding the metadata.
+    #
+    attr_accessor :document_components
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'aes256'
+
+      json_array['documentComponents'] = @document_components.downcase unless @document_components.nil?
+
+      #-------------------------------------------
+      json_array['allowCopy'] = @allow_copy unless @allow_copy.nil?
+
+      json_array['allowEdit'] = @allow_edit unless @allow_edit.nil?
+
+      json_array['allowPrint'] = @allow_print unless @allow_print.nil?
+
+      unless @allow_update_annots_and_fields.nil?
+        json_array['allowUpdateAnnotsAndFields'] =
+          @allow_update_annots_and_fields
+      end
+
+      json_array['ownerPassword'] = @owner_password unless @owner_password.nil?
+
+      json_array['userPassword'] = @user_password unless @user_password.nil?
+
+      json_array['allowAccessibility'] = @allow_accessibility unless @allow_accessibility.nil?
+
+      json_array['allowFormFilling'] = @allow_form_filling unless @allow_form_filling.nil?
+
+      unless @allow_high_resolution_printing.nil?
+        json_array['allowHighResolutionPrinting'] =
+          @allow_high_resolution_printing
+      end
+
+      json_array['allowDocumentAssembly'] = @allow_document_assembly unless @allow_document_assembly.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Align.rb

@@ -0,0 +1,21 @@
+module DynamicPDFApi
+  #
+  # Specifies horizontal alignment. Center alignment is the default value for alignments.
+  #
+  class Align
+    #
+    # Align left.
+    #
+    LEFT = 'left'.freeze
+
+    #
+    # Align center. This is default.
+    #
+    CENTER = 'center'.freeze
+
+    #
+    # Align right.
+    #
+    RIGHT = 'right'.freeze
+  end
+end

data/lib/ruby_client/ButtonFieldInformation.rb

@@ -0,0 +1,48 @@
+module DynamicPDFApi
+  #
+  # Represents information of a button field.
+  #
+  class ButtonFieldInformation
+    def initialize
+      @name = nil
+      @_type = nil
+      @value = nil
+      @default_value = nil
+      @export_value = nil
+      @export_values = {}
+    end
+
+    #
+    # Gets or Sets the name of the button field.
+    #
+    attr_accessor :name
+
+    #
+    # Gets or sets the type of the button field, ex: RadioButton, CheckBox etc.
+    #
+    attr_accessor :type
+
+    #
+    # Gets or sets the value of the button field.
+    #
+    attr_accessor :value
+
+    #
+    # Gets or Sets the default value of the button field.
+    #
+    attr_accessor :default_value
+
+    #
+    # Gets or Sets the export value. These values will be exported when submitting the form.
+    #
+    # To create a set of mutually exclusive radio buttons (i.e., where only one can be selected at a time),
+    # create the fields with the same name but different export values.
+    #
+    attr_accessor :export_value
+
+    #
+    # Gets the collection of export value.
+    #
+    attr_accessor :export_values
+  end
+end

data/lib/ruby_client/ButtonFieldType.rb

@@ -0,0 +1,16 @@
+module DynamicPDFApi
+  #
+  # Specifies the type of a button field.
+  #
+  class ButtonFieldType
+    #
+    # Represents a Radio Button.
+    #
+    RADIO_BUTTON = 'radioButton'.freeze
+
+    #
+    # Represents a Checkbox.
+    #
+    CHECK_BOX = 'checkBox'.freeze
+  end
+end

data/lib/ruby_client/ChoiceFieldInformation.rb

@@ -0,0 +1,52 @@
+module DynamicPDFApi
+  #
+  # Represents the information of a choice field in interactive forms. A choice field contains several text
+  # items, one or more of which may be selected as the field value.
+  #
+  class ChoiceFieldInformation
+    def initialize
+      @name = nil
+      @_type = nil
+      @value = nil
+      @default_value = nil
+      @export_value = nil
+      @items = {}
+      @item_export_values = {}
+    end
+
+    #
+    # Gets or Sets the name of the choice field.
+    #
+    attr_accessor :name
+
+    #
+    # Gets or sets the ChoiceFieldType. ex: ListBox, ComboBox etc.
+    #
+    attr_accessor :type
+
+    #
+    # Gets or sets the value of the choice field.
+    #
+    attr_accessor :value
+
+    #
+    # Gets or Sets the default value of the choice field.
+    #
+    attr_accessor :default_value
+
+    #
+    # Gets or Sets the export value.
+    #
+    attr_accessor :export_value
+
+    #
+    # Gets the collection of items.
+    #
+    attr_accessor :items
+
+    #
+    # Gets the collection of export values of the items present in the choice field.
+    #
+    attr_accessor :item_export_values
+  end
+end

data/lib/ruby_client/ChoiceFieldType.rb

@@ -0,0 +1,16 @@
+module DynamicPDFApi
+  #
+  # Specifies type of the Choice Field.
+  #
+  class ChoiceFieldType
+    #
+    # Represents a List box.
+    #
+    LIST_BOX = 'listBox'.freeze
+
+    #
+    # Represents a Combo box.
+    #
+    COMBO_BOX = 'comboBox'.freeze
+  end
+end

data/lib/ruby_client/CmykColor.rb

@@ -0,0 +1,47 @@
+module DynamicPDFApi
+  require_relative 'Color'
+
+  #
+  # Represents a CMYK color.
+  #
+  class CmykColor < Color
+    #
+    # Initializes a new instance of the CmykColor class.
+    #
+    # Values must be between 0.0 and 1.0.
+    #
+    # @param cyan [float] The cyan intensity.
+    # @param magenta [float] The magenta intensity.
+    # @param yellow [float] The yellow intensity.
+    # @param black [float] The black intensity.
+    #
+    def initialize(cyan = 0, magenta = 0, yellow = 0, black = 0)
+      super()
+      if cyan < 0.0 || cyan > 1.0 || magenta < 0.0 || magenta > 1.0 || yellow < 0.0 || yellow > 1.0 || black < 0.0 || black > 1.0
+        raise 'CMYK values must be from 0.0 to 1.0.'
+      end
+
+      @_color_string = "cmyk(#{cyan},#{magenta},#{yellow},#{black})"
+      @cyan = cyan
+      @magenta = magenta
+      @yellow = yellow
+      @black = black
+    end
+
+    #
+    # Gets the color black.
+    #
+    def black
+      CmykColor.new(1, 1, 1, 1)
+    end
+
+    #
+    # Gets the color white.
+    #
+    def white
+      CmykColor.new(0, 0, 0, 0)
+    end
+
+    attr_accessor :_color_string
+  end
+end

data/lib/ruby_client/Color.rb

@@ -0,0 +1,12 @@
+module DynamicPDFApi
+  #
+  # Base class representing a color.
+  #
+  class Color
+    def initialize
+      @_color_string = nil
+    end
+
+    attr_accessor :_color_string
+  end
+end

data/lib/ruby_client/ColorSpaceType.rb

@@ -0,0 +1,36 @@
+module DynamicPDFApi
+  #
+  # Specifies Color Space.
+  #
+  class ColorSpaceType
+    #
+    # Represents a Monochrome color space.
+    #
+    MONOCHROME = 'monochrome'.freeze
+
+    #
+    # Represents a Grayscale color space.
+    #
+    GRAYSCALE = 'grayscale'.freeze
+
+    #
+    # Represents an RGB color space.
+    #
+    RGB = 'rGB'.freeze
+
+    #
+    # Represents a CMYK color space.
+    #
+    CMYK = 'cMYK'.freeze
+
+    #
+    # Represents an Indexed color space.
+    #
+    INDEXED = 'indexed'.freeze
+
+    #
+    # Unknown color space.
+    #
+    UNKNOWN = 'unknown'.freeze
+  end
+end

data/lib/ruby_client/ConverterInput.rb

@@ -0,0 +1,100 @@
+module DynamicPDFApi
+require_relative 'Input'
+  #
+  # Represents the base class for inputs.
+  #
+  class ConverterInput < Input
+    def initialize(resource, size, orientation, margins)
+      super(resource)
+      self.page_size = size
+      self.page_orientation = orientation
+
+      if (margins != nil)
+        @top_margin = margins
+        @bottom_margin = margins
+        @right_margin = margins
+        @left_margin = margins
+      end
+    end
+
+    #
+    # 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
+
+    #attr_accessor :page_size
+
+    attr_accessor :_smaller, :_larger
+    #
+    # Gets or sets the page size.
+    #
+    def page_size=(value)
+      @page_size = value
+
+      output_size = UnitConverter.get_paper_size(value)
+
+      @_larger = output_size.larger
+      @_smaller = output_size.smaller
+
+      if @page_orientation == PageOrientation::PORTRAIT
+        @page_height = @_larger
+        @page_width = @_smaller
+      else
+        @page_height = @_smaller
+        @page_width = @_larger
+      end
+    end
+
+    #
+    # Gets or sets page orientation.
+    #
+    def page_orientation=(value)
+      @page_orientation = value
+
+      if @page_width > @page_height
+        @_smaller = @page_height
+        @_larger = @page_width
+      else
+        @_smaller = @page_width
+        @_larger = @page_height
+      end
+
+      if @page_orientation == PageOrientation::PORTRAIT
+        @page_height = @_larger
+        @page_width = @_smaller
+      else
+        @page_height = @_smaller
+        @page_width = @_larger
+      end
+    end
+
+    def to_json(_options = {})
+      JSON.pretty_generate({})
+    end
+  end
+end