dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/Security.rb

@@ -0,0 +1,73 @@
+module DynamicPDFApi
+  require_relative 'SecurityType'
+
+  #
+  # Base class from which all security classes are derived.
+  #
+  class Security
+    def initialize(user_pwd = nil, owner_pwd = nil)
+      @_user_password = user_pwd
+      @_owner_password = owner_pwd
+      @_allow_copy = nil
+      @_allow_edit = nil
+      @_allow_print = nil
+      @_allow_update_annots_and_fields = nil
+
+      @_allow_accessibility = nil
+      @_allow_form_filling = nil
+      @_allow_high_resolution_printing = nil
+      @_allow_document_assembly = nil
+      @_type = nil
+    end
+
+    #
+    # Gets or sets if text and images can be copied to the clipboard by the user.
+    #
+    attr_accessor :allow_copy
+
+    #
+    # Gets or sets if the document can be edited by the user.
+    #
+    attr_accessor :allow_edit
+
+    #
+    # Gets or sets if the document can be printed by the user.
+    #
+    attr_accessor :allow_print
+
+    #
+    # Gets or sets if annotations and form fields can be added, edited and modified by the user.
+    #
+    attr_accessor :allow_update_annots_and_fields
+
+    #
+    # Gets or sets the owner password.
+    #
+    attr_accessor :owner_password
+
+    #
+    # Gets or sets the user password.
+    #
+    attr_accessor :user_password
+
+    #
+    # Gets or sets if accessibility programs should be able to read the documents text and images for the user.
+    #
+    attr_accessor :allow_accessibility
+
+    #
+    # Gets or sets if form filling should be allowed by the user.
+    #
+    attr_accessor :allow_form_filling
+
+    #
+    # Gets or sets if the document can be printed at a high resolution by the user.
+    #
+    attr_accessor :allow_high_resolution_printing
+
+    #
+    # Gets or sets if the document can be assembled and manipulated by the user.
+    #
+    attr_accessor :allow_document_assembly
+  end
+end

data/lib/ruby_client/SecurityType.rb

@@ -0,0 +1,23 @@
+module DynamicPDFApi
+  #
+  #
+  # Represents different types of the security.
+  #
+  #
+  class SecurityType
+    #
+    # AES 128 bit security.
+    #
+    AES_128 = 'aes128'.freeze
+
+    #
+    # AES 256 bit security.
+    #
+    AES_256 = 'aes256'.freeze
+
+    #
+    # RC4 128 bit security.
+    #
+    RC_4128 = 'aC4128'.freeze
+  end
+end

data/lib/ruby_client/SignatureFieldInformation.rb

@@ -0,0 +1,21 @@
+module DynamicPDFApi
+  #
+  # Represents information of a signature field.
+  #
+  class SignatureFieldInformation
+    def initialize
+      @name = nil
+      @signed = nil
+    end
+
+    #
+    # Gets or Sets the name of a signature field.
+    #
+    attr_accessor :name
+
+    #
+    # Gets or Sets the boolean, indicating the field signed or not.
+    #
+    attr_accessor :signed
+  end
+end

data/lib/ruby_client/Template.rb

@@ -0,0 +1,46 @@
+module DynamicPDFApi
+  #
+  # Represents a document template.
+  #
+  class Template
+    #
+    # Initializes a new instance of the Template class.
+    #
+    # @param id [String] The id string representing id for the template.
+    #
+    def initialize(id)
+      @id = if id.nil?
+              SecureRandom.uuid
+            else
+              id
+            end
+      @elements = []
+    end
+
+    #
+    # Gets or sets the id for the template.
+    #
+    attr_accessor :id
+
+    #
+    # Gets or sets the elements for the template.
+    #
+    attr_accessor :elements
+
+    def to_json(_options = {})
+      elements = []
+      @elements.each do |element|
+        str = element unless element.nil?
+
+        elements << str unless str.nil?
+      end
+
+      json_array = {}
+
+      json_array['id'] = @id
+      json_array['elements'] = @elements
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/TextFieldInformation.rb

@@ -0,0 +1,27 @@
+module DynamicPDFApi
+  #
+  # Represents information of a text field.
+  #
+  class TextFieldInformation
+    def initialize
+      @name = nil
+      @value = nil
+      @default_value = nil
+    end
+
+    #
+    # Gets or Sets the name of the Text field.
+    #
+    attr_accessor :name
+
+    #
+    # Gets or Sets the value of the Text field.
+    #
+    attr_accessor :value
+
+    #
+    # Gets or Sets the default value of the Text field.
+    #
+    attr_accessor :default_value
+  end
+end

data/lib/ruby_client/TextReplace.rb

@@ -0,0 +1,43 @@
+module DynamicPDFApi
+  class TextReplace
+
+    #
+    # Represents the find and replace values and its options.
+    #
+    # @param name="text">Text to find.
+    # @param name="replaceText">Text to replace.
+    # @param name="matchCase">True value will make the search operation case sensitive.
+    def initialize(text, replaceText, matchCase = false)
+      @text = text
+      @replace_text = replaceText
+      @match_case = matchCase
+    end
+
+    #
+    # Gets or sets the Find Text value. This string will be replaced with ReplaceText during conversion.
+    #
+    attr_accessor :text
+
+    #
+    # Gets or sets ReplaceText value.This string will replace the Text during conversion.
+    #
+    attr_accessor :replace_text
+
+    #
+    # If True, the search operation will be case sensitive.
+    #
+    attr_accessor :match_case
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["text"] = @text
+
+      json_array["replaceText"] = @replace_text unless @replace_text.nil?
+
+      json_array["matchCase"] = @match_case unless @match_case.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/UnitConverter.rb

@@ -0,0 +1,111 @@
+require_relative "PageSize"
+
+module DynamicPDFApi
+  #
+  # Represents a html input.
+  #
+  class UnitConverter
+    def initialize
+    end
+
+    #
+    # Method to convert inches to points.
+    #
+    # @param  name="size">Size in inches.
+    # @returns Size in points.
+    def self.inches_to_points(size)
+      size * 72.0
+    end
+
+    #
+    # Method to convert millimeters to points.
+    #
+    # @param  name="size">Size in millimeters.
+    # @returns Size in points.
+    def self.millimeters_to_points(size)
+      size * 2.8346456692913385826771653543307
+    end
+
+    def self.get_paper_size(size)
+      case size
+
+      when PageSize::LETTER
+        @smaller = inches_to_points(8.5)
+        @larger = inches_to_points(11)
+      when PageSize::LEGAL
+        @smaller = inches_to_points(8.5)
+        @larger = inches_to_points(14)
+      when PageSize::EXECUTIVE
+        @smaller = inches_to_points(7.25)
+        @larger = inches_to_points(10.5)
+      when PageSize::TABLOID
+        @smaller = inches_to_points(11)
+        @larger = inches_to_points(17)
+      when PageSize::ENVELOPE10
+        @smaller = inches_to_points(4.125)
+        @larger = inches_to_points(9.5)
+      when PageSize::ENVELOPEMONARCH
+        @smaller = inches_to_points(3.875)
+        @larger = inches_to_points(7.5)
+      when PageSize::FOLIO
+        @smaller = inches_to_points(8.5)
+        @larger = inches_to_points(13)
+      when PageSize::STATEMENT
+        @smaller = inches_to_points(5.5)
+        @larger = inches_to_points(8.5)
+      when PageSize::A4
+        @smaller = millimeters_to_points(210)
+        @larger = millimeters_to_points(297)
+      when PageSize::A5
+        @smaller = millimeters_to_points(148)
+        @larger = millimeters_to_points(210)
+      when PageSize::B4
+        @smaller = millimeters_to_points(250)
+        @larger = millimeters_to_points(353)
+      when PageSize::B5
+        @smaller = millimeters_to_points(176)
+        @larger = millimeters_to_points(250)
+      when PageSize::A3
+        @smaller = millimeters_to_points(297)
+        @larger = millimeters_to_points(420)
+      when PageSize::B3
+        @smaller = millimeters_to_points(353)
+        @larger = millimeters_to_points(500)
+      when PageSize::A6
+        @smaller = millimeters_to_points(105)
+        @larger = millimeters_to_points(148)
+      when PageSize::B5JIS
+        @smaller = millimeters_to_points(182)
+        @larger = millimeters_to_points(257)
+      when PageSize::ENVELOPEDL
+        @smaller = millimeters_to_points(110)
+        @larger = millimeters_to_points(220)
+      when PageSize::ENVELOPEC5
+        @smaller = millimeters_to_points(162)
+        @larger = millimeters_to_points(229)
+      when PageSize::ENVELOPEB5
+        @smaller = millimeters_to_points(176)
+        @larger = millimeters_to_points(250)
+      when PageSize::PRC16K
+        @smaller = millimeters_to_points(146)
+        @larger = millimeters_to_points(215)
+      when PageSize::PRC32K
+        @smaller = millimeters_to_points(97)
+        @larger = millimeters_to_points(151)
+      when PageSize::QUATRO
+        @smaller = millimeters_to_points(215)
+        @larger = millimeters_to_points(275)
+      when PageSize::DOUBLEPOSTCARD
+        @smaller = millimeters_to_points(148.0)
+        @larger = millimeters_to_points(200.0)
+      when PageSize::POSTCARD
+        @smaller = inches_to_points(3.94)
+        @larger = inches_to_points(5.83)
+      else
+        @smaller = inches_to_points(8.5)
+        @larger = inches_to_points(11)
+      end
+      OutputSize.new(@larger, @smaller)
+    end
+  end
+end

data/lib/ruby_client/UrlAction.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  require_relative 'Action'
+
+  #
+  # Represents an action linking to an external URL.
+  #
+  class UrlAction < Action
+    #
+    # Initializes a new instance of the UrlAction class.
+    #
+    # @param url [String]  URL the action launches.
+    #
+    def initialize(url)
+      super()
+      @url = url
+    end
+
+    #
+    # Gets or sets the URL launched by the action.
+    #
+    attr_accessor :url
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['url'] = @url unless @url.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/VAlign.rb

@@ -0,0 +1,21 @@
+module DynamicPDFApi
+  #
+  # Specifies vertical alignment.
+  #
+  class VAlign
+    #
+    # Align top.
+    #
+    TOP = 'top'.freeze
+
+    #
+    # Align center. This is default.
+    #
+    CENTER = 'center'.freeze
+
+    #
+    # Align bottom.
+    #
+    BOTTOM = 'bottom'.freeze
+  end
+end

data/lib/ruby_client/WebColor.rb

@@ -0,0 +1,18 @@
+module DynamicPDFApi
+  require_relative "RgbColor"
+
+  #
+  # Represents an RGB color created using the web hexadecimal convention.
+  #
+  class WebColor < RgbColor
+    #
+    # Initializes a new instance of the WebColor class.
+    #
+    # @param web_hex_string [String] The hexadecimal string representing the color.
+    #
+    def initialize(web_hex_string)
+      super()
+      @_color_string = web_hex_string
+    end
+  end
+end

data/lib/ruby_client/WordInput.rb

@@ -0,0 +1,65 @@
+module DynamicPDFApi
+  require_relative "PageSize"
+  require_relative "PageOrientation"
+  require_relative "InputType"
+  #
+  # Represents a Word input.
+  #
+  class WordInput < ConverterInput
+
+    #
+    # Initializes a new instance of the WordInput"/> class.
+    #
+    # @param name="resource">The resource of type WordResource.
+    # @param name="size">The page size of the output PDF.
+    # @param name="orientation">The page orientation of the output PDF.
+    # @param name="margins">The page margins of the output PDF.
+    def initialize(resource, size = PageSize::LETTER, orientation = PageOrientation::PORTRAIT, margins = nil)
+      super(resource, size, orientation, margins)
+      @_type = InputType::WORD
+
+      @text_replace = Array.new
+    end
+
+    def GetTextReplace
+      if ((@text_replace != nil && @text_replace.Count > 0))
+        @text_replace
+      else
+        nil
+      end
+    end
+
+    #
+    #  Gets or sets the TextReplace object List.
+    #
+    attr_accessor :text_replace
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "word"
+
+      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["textReplace"] = @text_replace unless @text_replace.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/WordResource.rb

@@ -0,0 +1,82 @@
+module DynamicPDFApi
+  require_relative "ResourceType"
+  #
+  # Represents a Word resource.
+  #
+  class WordResource < Resource
+
+    #
+    # Initializes a new instance of the WordResource class.
+    #
+    # @param name="filePath">The Word file path.
+    # @param name="resourceName">The The resource name with file extension.
+    def initialize(file, resourceName = nil)
+      @resource_name = nil
+      @file_extension = nil
+      super(file, resourceName)
+
+      @_type = ResourceType::WORD
+      @_mime_type = nil
+      super(file, resource_name)
+    end
+
+    #
+    # Sets the resource name.
+    #
+    # @remarks The resource name should be specified with a file extension.
+    def resource_name=(value)
+      @resource_name = value
+      if (value == nil || File.extname(value) == nil)
+        raise "Invalid resource name."
+      end
+    end
+
+    attr_accessor :mime_type
+
+    def file_extension=(value)
+      @file_extension = value
+      inputFileExtension = ""
+      if (@resource_name != nil)
+        if (File.extname(value) != nil)
+          inputFileExtension = File.extname(value).ToLower
+        else
+          raise "Invalid resource name."
+        end
+      elsif (FilePath != nil)
+        if (File.extname(FilePath) != nil)
+          inputFileExtension = File.extname(FilePath).ToLower
+        else
+          raise "Invalid file path specified."
+        end
+      else
+        raise "Invalid file path or resource name."
+      end
+
+      if (inputFileExtension == ".doc")
+        @mime_type = "application/msword"
+        ".doc"
+      elsif (inputFileExtension == ".docx" && @data[0] == 0x50 && @data[1] == 0x4b)
+        @mime_type = "application/vnd.openxmlformats-officedocument.wordprocessingml.document"
+        ".docx"
+      elsif (inputFileExtension == ".odt" && @data[0] == 0x50 && @data[1] == 0x4b)
+        @mime_type = "application/vnd.oasis.opendocument.text"
+        ".odt"
+      else
+        raise "Unsupported file type or invalid file extension."
+      end
+    end
+
+    def SetMimeType()
+
+      #  _ = FileExtension
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array["type"] = "word"
+
+      json_array["resourceName"] = @resource_name
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/XmlResponse.rb

@@ -0,0 +1,23 @@
+module DynamicPDFApi
+  require_relative 'Response'
+
+  #
+  # Represents the xml response.
+  #
+  class XmlResponse < Response
+    #
+    # Initializes a new instance of the XmlResponse class.
+    #
+    # @param xml_content [String]  The xml content of the response.
+    #
+    def initialize(xml_content = nil)
+      super()
+      @content = xml_content
+    end
+
+    #
+    # Gets the xml content.
+    #
+    attr_accessor :content
+  end
+end

data/lib/ruby_client/version.rb

@@ -0,0 +1,5 @@
+# frozen_string_literal: true
+
+module RubyClient
+VERSION = "1.0.0-beta" 
+end