dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/Elements/TextElement.rb

@@ -0,0 +1,83 @@
+module DynamicPDFApi
+  require_relative "Element"
+  require_relative "ElementType"
+
+  #
+  # Represents a text element.
+  #
+  # This class can be used to place text on a page.
+  #
+  class TextElement < Element
+    #
+    # Initializes a new instance of the TextElement class.
+    #
+    # @param value [String] Text to display in the text element.
+    # @param placement [String] The placement of the text element on the page.
+    # @param x_offset [float] X coordinate of the text element.
+    # @param y_offset [float] Y coordinate of the text element.
+    #
+    def initialize(value, placement = ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      @_resource = nil
+      @_text_font = nil
+      @_font_name = nil
+
+      @color = nil
+      @font_size = nil
+      @_type = ElementType::TEXT
+      super(value, placement, x_offset, y_offset)
+      @text = value
+    end
+
+    #
+    # Gets or sets the Color object to use for the text of the text element.
+    #
+    attr_accessor :color
+
+    #
+    # Gets or sets the font size for the text of the text element.
+    #
+    attr_accessor :font_size
+
+    #
+    # Gets or sets the text to display in the text element.
+    #
+    attr_accessor :text
+
+    #
+    # Gets or sets the Font object used to specify the font of the text for the text element.
+    #
+    def font(value)
+      @_text_font = value
+      @_font_name = @_text_font._name
+      @_resource = @_text_font._resource
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "text"
+
+      json_array["font"] = @_font_name unless @_font_name.nil?
+
+      json_array["text"] = @text
+
+      json_array["color"] = @color._color_string if !@color.nil? && !@color._color_string.nil?
+
+      json_array["fontSize"] = @font_size unless @font_size.nil?
+
+      # ---------------------------------
+
+      json_array["placement"] = @placement unless @placement.nil?
+
+      json_array["xOffset"] = @x_offset unless @x_offset.nil?
+
+      json_array["yOffset"] = @y_offset unless @y_offset.nil?
+
+      json_array["evenPages"] = @even_pages unless @even_pages.nil?
+
+      json_array["oddPages"] = @odd_pages unless @odd_pages.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Elements/ValueType.rb

@@ -0,0 +1,16 @@
+module DynamicPDFApi
+  #
+  # Represents value type.
+  #
+  class ValueType
+    #
+    # String.
+    #
+    STRING = 'string'.freeze
+
+    #
+    # Base 64 encoded byt e array.
+    #
+    BASE64_ENCODED_BYTES = 'base64EncodedBytes'.freeze
+  end
+end

data/lib/ruby_client/EncryptDocumentComponents.rb

@@ -0,0 +1,16 @@
+module DynamicPDFApi
+  #
+  # Specifies the document components to be encrypted.
+  #
+  class EncryptDocumentComponents
+    #
+    # Encrypts all document contents.
+    #
+    ALL = 'all'
+
+    #
+    # Encrypts all document contents except metadata.
+    #
+    ALL_EXCEPT_METADATA = 'allExceptMetadata'
+  end
+end

data/lib/ruby_client/EndPointException.rb

@@ -0,0 +1,7 @@
+module DynamicPDFApi
+  # Represents the exception that occurs in case of any issues with sending the request.
+
+  class EndPointException < RuntimeError
+
+  end
+end

data/lib/ruby_client/Endpoint.rb

@@ -0,0 +1,38 @@
+module DynamicPDFApi
+  #
+  # Represents the base class for endpoint and has settings for base url, api key and creates a rest request
+  # object.
+  #
+  class Endpoint
+    def initialize
+      @_client = nil
+      @enable_logging = false
+      @api_key = @@default_api_key
+      @base_url = @@default_base_url
+    end
+
+    attr_accessor :_endpoint_name
+
+    #
+    # Gets or sets default base url.
+    #
+    @@default_base_url = 'https://api.dynamicpdf.com'
+
+    #
+    # Gets or sets default api key.
+    #
+    @@default_api_key = nil
+
+    #
+    # Gets or sets base url for the api.
+    #
+    attr_accessor :base_url
+
+    #
+    # Gets or sets api key.
+    #
+    attr_accessor :api_key
+
+    def init; end
+  end
+end

data/lib/ruby_client/EndpointResource.rb

@@ -0,0 +1,7 @@
+module DynamicPDFApi
+  class EndPointResource
+    def initialize
+    @data = []
+    end
+  end
+end

data/lib/ruby_client/ExcelInput.rb

@@ -0,0 +1,49 @@
+module DynamicPDFApi
+  require_relative "PageSize"
+  require_relative "PageOrientation"
+  require_relative "InputType"
+  #
+  # Represents a Excel input.
+  #
+  class ExcelInput < ConverterInput
+
+    #
+    # Initializes a new instance of the ExcelInput"/> class.
+    #
+    # @param name="resource">The resource of type ExcelResource.
+    # @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::EXCEL
+
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "excel"
+
+      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/ExcelResource.rb

@@ -0,0 +1,79 @@
+module DynamicPDFApi
+  require_relative "ResourceType"
+  #
+  # Represents a Excel resource.
+  #
+  class ExcelResource < Resource
+
+    #
+    # Initializes a new instance of the ExcelResource class.
+    #
+    # @param name="filePath">The Excel 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::EXCEL
+      @_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 == ".xls")
+        @mime_type = "application/vnd.ms-excel"
+        ".xls"
+      elsif (inputFileExtension == ".xlsx" && @data[0] == 0x50 && @data[1] == 0x4b)
+        @mime_type = "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"
+        ".xlsx"
+      else
+        raise "Unsupported file type or invalid file extension."
+      end
+    end
+
+    def SetMimeType()
+
+      #  _ = FileExtension
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array["type"] = "excel"
+
+      json_array["resourceName"] = @resource_name
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Font.rb

@@ -0,0 +1,276 @@
+module DynamicPDFApi
+  require_relative "FontResource"
+
+  #
+  # Represents font.
+  #
+  class Font
+    #
+    # Initializes a new instance of the Font class using the font name that is present in the cloud resource
+    # manager.
+    #
+    # @param cloud_resource_name [String] The font name present in the cloud resource manager.
+    #
+    def initialize(cloud_resource_name = nil)
+      @data = {}
+      @_resource = nil
+      @embed = nil
+      @subset = nil
+
+      @resource_name = cloud_resource_name
+      @_name = SecureRandom.uuid
+    end
+
+    def self.create_font(font_resource = nil, resource_name = nil)
+      font = Font.new
+      font._resource = font_resource
+      font.resource_name = resource_name
+
+      font._name = SecureRandom.uuid
+      font
+    end
+
+    attr_accessor :_name, :_resource
+
+    #
+    # Gets or sets a boolean indicating whether to embed the font.
+    #
+    attr_accessor :embed
+
+    #
+    # Gets or sets a boolean indicating whether to subset embed the font.
+    #
+    attr_accessor :subset
+
+    #
+    # Gets or sets a name for the font resource.
+    #
+    attr_accessor :resource_name
+
+    #
+    # Gets the Times Roman core font with Latin 1 encoding.
+    #
+    def self.times_roman
+      @@times_roman = Font.new if @@times_roman.nil?
+
+      @@times_roman._name = "timesRoman"
+      @@times_roman
+    end
+
+    #
+    # Gets the Times Bold core font with Latin 1 encoding.
+    #
+    def self.times_bold
+      @@times_bold = Font.new if @@times_bold.nil?
+
+      @@times_bold._name = "timesBold"
+      @@times_bold
+    end
+
+    #
+    # Gets the Times Italic core font with Latin 1 encoding.
+    #
+    def self.times_italic
+      @@times_italic = Font.new if @@times_italic.nil?
+
+      @@times_italic._name = "timesItalic"
+      @@times_italic
+    end
+
+    #
+    # Gets the Times Bold Italic core font with Latin 1 encoding.
+    #
+    def self.times_bold_italic
+      @@times_bold_italic = Font.new if @@times_bold_italic.nil?
+
+      @@times_bold_italic._name = "timesBoldItalic"
+      @@times_bold_italic
+    end
+
+    #
+    # Gets the Helvetica core font with Latin 1 encoding.
+    #
+    def self.helvetica
+      @@helvetica = Font.new if @@helvetica.nil?
+
+      @@helvetica._name = "helvetica"
+      @@helvetica
+    end
+
+    #
+    # Gets the Helvetica Bold core font with Latin 1 encoding.
+    #
+    def self.helvetica_bold
+      @@helvetica_bold = Font.new if @@helvetica_bold.nil?
+
+      @@helvetica_bold._name = "helveticaBold"
+      @@helvetica_bold
+    end
+
+    #
+    # Gets the Helvetica Oblique core font with Latin 1 encoding.
+    #
+    def self.helvetica_oblique
+      @@helvetica_oblique = Font.new if @@helvetica_oblique.nil?
+
+      @@helvetica_oblique._name = "helveticaOblique"
+      @@helvetica_oblique
+    end
+
+    #
+    # Gets the Helvetica Bold Oblique core font with Latin 1 encoding.
+    #
+    def self.helvetica_bold_oblique
+      @@helvetica_boldOblique = Font.new if @@helvetica_boldOblique.nil?
+
+      @@helvetica_boldOblique._name = "helveticaBoldOblique"
+      @@helvetica_boldOblique
+    end
+
+    #
+    # Gets the Courier core font with Latin 1 encoding.
+    #
+    def self.courier
+      @@courier = Font.new if @@courier.nil?
+
+      @@courier._name = "courier"
+      @@courier
+    end
+
+    #
+    # Gets the Courier Bold core font with Latin 1 encoding.
+    #
+    def self.courier_bold
+      @@courier_bold = Font.new if @@courier_bold.nil?
+
+      @@courier_bold._name = "courierBold"
+      @@courier_bold
+    end
+
+    #
+    # Gets the Courier Oblique core font with Latin 1 encoding.
+    #
+    def self.courier_oblique
+      @@courier_oblique = Font.new if @@courier_oblique.nil?
+
+      @@courier_oblique._name = "courierOblique"
+      @@courier_oblique
+    end
+
+    #
+    # Gets the Courier Bold Oblique core font with Latin 1 encoding.
+    #
+    def self.courier_bold_oblique
+      @@courier_boldOblique = Font.new if @@courier_boldOblique.nil?
+
+      @@courier_boldOblique._name = "courierBoldOblique"
+      @@courier_boldOblique
+    end
+
+    #
+    # Gets the Symbol core font.
+    #
+    def self.symbol
+      @@symbol = Font.new if @@symbol.nil?
+
+      @@symbol._name = "symbol"
+      @@symbol
+    end
+
+    #
+    # Gets the Zapf Dingbats core font.
+    #
+    def self.zapf_dingbats
+      @@zapf_dingbats = Font.new if @@zapf_dingbats.nil?
+
+      @@zapf_dingbats._name = "zapfDingbats"
+      @@zapf_dingbats
+    end
+
+    #
+    # Initializes a new instance of the Font class using the file path of the font and resource name.
+    #
+    # @param file_path [String] The file path of the font file.
+    # @param resource_name [String] The resource name for the font.
+    #
+    def self.from_file(file_path, resource_name = nil)
+      resource = Resource.new(file_path, resource_name)
+      Font.create_font(resource, resource.resource_name)
+    end
+
+    def self.from_stream(_stream, _resource_name = nil)
+      resource = Resource.new(stream, resource_name)
+      Font.create_font(resource, resource.resource_name)
+    end
+
+    def self.get_google_font_text(name, weight, italic)
+      if italic == true
+        name + ":" + weight.to_s + "italic"
+      else
+        name + ":" + weight.to_s
+      end
+    end
+
+    #
+    # Gets the font from the google.
+    #
+    # @param fontName [string] The name of the google font.
+    # @param bold [bold] If true font weight will be taken as 700 otherwise 400.
+    # @param italic [italic] The italic property of the font.
+    # @returns The font object.
+    #
+    def self.google(font_name, bold = nil, italic = false)
+      font = Font.new()
+      if bold == true
+        font._name = Font.get_google_font_text(font_name, 700, italic)
+      elsif (bold.is_a?(Integer) == true)
+        font._name = Font.get_google_font_text(font_name, bold, italic);
+      elsif bold == false
+        font._name = Font.get_google_font_text(font_name, 400, italic);
+      else
+        font._name = font_name;
+      end
+      font
+    end
+
+    #
+    # Gets the font from the global storage.
+    #
+    # @param fontName [string] The name of the font to get from the global storage..
+    # @returns The font object.
+    #
+    def self.global(font_name)
+      font = Font.new()
+      font._name = font_name
+      font
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array["name"] = @_name unless @_name.nil?
+
+      json_array["embed"] = @embed unless @embed.nil?
+
+      json_array["subset"] = @subset unless @subset.nil?
+
+      json_array["resourceName"] = @resource_name unless @resource_name.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+
+    @@times_roman = nil
+    @@times_bold = nil
+    @@times_italic = nil
+    @@times_bold_italic = nil
+    @@helvetica = nil
+    @@helvetica_bold = nil
+    @@helvetica_oblique = nil
+    @@helvetica_boldOblique = nil
+    @@courier = nil
+    @@courier_bold = nil
+    @@courier_oblique = nil
+    @@courier_boldOblique = nil
+    @@symbol = nil
+    @@zapf_dingbats = nil
+  end
+end

data/lib/ruby_client/FontInformation.rb

@@ -0,0 +1,9 @@
+module DynamicPDFApi
+  class FontInformation
+    def initialize(font_name, file_path)
+      @_font_name = font_name
+
+      @_file_path = file_path
+    end
+  end
+end

data/lib/ruby_client/FontResource.rb

@@ -0,0 +1,35 @@
+module DynamicPDFApi
+  require_relative 'Resource'
+  require_relative 'ResourceType'
+
+  class FontResource < Resource
+    def initialize(file, resource_name = nil)
+      @_mime_type = nil
+      @_type = ResourceType::FONT
+      super(file, resource_name)
+    end
+
+    def _file_extension
+      file_header = @data[0, 4]
+      byte_array = file_header.bytes
+
+      if byte_array[0] == 0x4f && byte_array[1] == 0x54 && byte_array[2] == 0x54 && byte_array[3] == 0x4f
+        @_mime_type = 'font/otf'
+        '.otf'
+      elsif byte_array[0] == 0x00 && byte_array[1] == 0x01 && byte_array[2] == 0x00 && byte_array[3] == 0x00
+        @_mime_type = 'font/ttf'
+        '.ttf'
+      else
+        raise 'Unsupported font'
+      end
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['name'] = @name
+      json_array['resourceName'] = @resource_name
+
+      JSON.pretty_generate(@json_array)
+    end
+  end
+end

data/lib/ruby_client/FormField.rb

@@ -0,0 +1,62 @@
+module DynamicPDFApi
+  #
+  #
+  # Represents a form field in the PDF document.
+  #
+  #
+  class FormField
+    #
+    # Initializes a new instance of the FormField class using the name and the value of the form field as parameters.
+    #
+    # @param name [String] The name of the form field.
+    # @param value [String] The value of the form field.
+    #
+    def initialize(name, value = nil)
+      @flatten = nil
+      @remove = nil
+
+      @name = name
+      @value = value
+    end
+
+    #
+    # Gets or sets name of the form field.
+    #
+    attr_accessor :name
+
+    #
+    # Gets or sets value of the form field.
+    #
+    attr_accessor :value
+
+    #
+    # Gets or sets a boolean indicating whether to flatten the form field.
+    #
+    attr_accessor :flatten
+
+    #
+    # Gets or sets a boolean indicating whether to remove the form field.
+    #
+    attr_accessor :remove
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['name'] = @name
+      json_array['value'] = @value
+
+      json_array['flatten'] = if !@flatten.nil?
+                                @flatten
+                              else
+                                false
+                              end
+
+      json_array['remove'] = if !@remove.nil?
+                               @remove
+                             else
+                               false
+                             end
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end