dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/InputType.rb

@@ -0,0 +1,41 @@
+module DynamicPDFApi
+  #
+  # Specifies an input type.
+  #
+  class InputType
+    #
+    # Pdf input.
+    #
+    PDF = "Pdf".freeze
+
+    #
+    # Image input.
+    #
+    IMAGE = "Image".freeze
+
+    #
+    # Dlex input.
+    #
+    DLEX = "Dlex".freeze
+
+    #
+    # Page input.
+    #
+    PAGE = "Page".freeze
+
+    #
+    # Html input.
+    #
+    HTML = "Html".freeze
+
+    #
+    # Word input.
+    #
+    WORD = "Word".freeze
+
+    #
+    # Excel input.
+    #
+    EXCEL = "Excel".freeze
+  end
+end

data/lib/ruby_client/JsonResponse.rb

@@ -0,0 +1,18 @@
+module DynamicPDFApi
+  require_relative 'Response'
+
+  #
+  # Represents the base class for json response.
+  #
+  class JsonResponse < Response
+    def initialize(json_content = nil)
+      super()
+      @json_content = json_content
+    end
+
+    #
+    # Gets the json content.
+    #
+    attr_accessor :json_content
+  end
+end

data/lib/ruby_client/LayoutDataResource.rb

@@ -0,0 +1,48 @@
+module DynamicPDFApi
+  require_relative 'Resource'
+  require_relative 'ResourceType'
+
+  #
+  #
+  # Represents the Layout data resource used to create the PDF reports.
+  #
+  class LayoutDataResource < Resource
+    #
+    # Initializes a new instance of the LayoutDataResource class using the layout data object and a resource
+    # name.
+    #
+    # @param layout [Object]|[String] Serializable object data to create PDF report or the layout data JSON file path.
+    # @param layout_data_resource_name [String] The name for layout data resource.
+    #
+    def initialize(layout = nil, layout_data_resource_name = nil)
+      super()
+      @data = if layout.is_a?(String)
+                Resource._get_file_data(layout)
+              else
+                layout.to_json
+              end
+      @layout_data_resource_name = if layout_data_resource_name.nil?
+                                     "#{SecureRandom.uuid}.json"
+                                   else
+                                     layout_data_resource_name
+                                   end
+
+      @_mime_type = 'application/json'
+      @_type = ResourceType::LAYOUT_DATA
+      @resource_name = @layout_data_resource_name
+    end
+
+    def _file_extension
+      '.json'
+    end
+
+    #
+    # Gets or sets name of the layout data resource.
+    #
+    attr_accessor :layout_data_resource_name
+
+    def to_json(_options = {})
+      JSON.pretty_generate({})
+    end
+  end
+end

data/lib/ruby_client/LineStyle.rb

@@ -0,0 +1,79 @@
+module DynamicPDFApi
+  #
+  # Represents a style of line.
+  #
+  class LineStyle
+    #
+    # Initializes a new instance of the LineStyle class.
+    #
+    # @param line [Array] The array specifying the line style.
+    # @param dash_phase [float] The phase of the line style.
+    #
+    def initialize(line, dash_phase = 0)
+      if line.is_a?(Array)
+        str_line_style = '['
+        (0..(line.length - 1)).each do |i|
+          val = line[i]
+          str_line_style = if i == (line.length - 1)
+                             str_line_style + format('%.2f', val)
+                           else
+                             "#{str_line_style}#{format('%.2f', val)},"
+                           end
+        end
+        str_line_style += ']'
+        str_line_style += format('%.2f', dash_phase) if dash_phase != 0
+        @_line_style_string = str_line_style
+      else
+        @_line_style_string = line
+      end
+    end
+
+    attr_accessor :_line_style_string
+
+    #
+    # Gets a solid line.
+    #
+    def self.solid
+      LineStyle.new('solid')
+    end
+
+    #
+    # Gets a dotted line.
+    #
+    def self.dots
+      LineStyle.new('dots')
+    end
+
+    #
+    # Gets a line with small dashes.
+    #
+    def self.dash_small
+      LineStyle.new('dashSmall')
+    end
+
+    #
+    # Gets a dashed line.
+    #
+    def self.dash
+      LineStyle.new('dash')
+    end
+
+    #
+    # Gets a line with large dashes.
+    #
+    def self.dash_large
+      LineStyle.new('dashLarge')
+    end
+
+    #
+    # Gets a invisible line.
+    #
+    def self.none
+      LineStyle.new('none')
+    end
+
+    def to_json(_options = {})
+      JSON.pretty_generate({})
+    end
+  end
+end

data/lib/ruby_client/MergeOptions.rb

@@ -0,0 +1,135 @@
+module DynamicPDFApi
+  #
+  # Represents different options for merging PDF documents.
+  #
+  class MergeOptions
+    def initialize
+      @document_info = 'nil'
+      @document_java_script = 'nil'
+      @document_properties = 'nil'
+      @embedded_files = 'nil'
+      @form_fields = 'nil'
+      @forms_xfa_data = 'nil'
+      @logical_structure = 'nil'
+      @open_action = 'nil'
+      @optional_content_info = 'nil'
+      @out_lines = 'nil'
+      @output_intent = 'nil'
+      @page_annotations = 'nil'
+      @page_labels_and_sections = 'nil'
+      @root_form_field = 'nil'
+      @xmp_metadata = 'nil'
+    end
+
+    #
+    # Gets or sets a boolean indicating whether to import document information when merging.
+    #
+    attr_accessor :document_info
+
+    #
+    # Gets or sets a boolean indicating whether to import document level JavaScript when merging.
+    #
+    attr_accessor :document_java_script
+
+    #
+    # Gets or sets a boolean indicating whether to import document properties when merging.
+    #
+    attr_accessor :document_properties
+
+    #
+    # Gets or sets a boolean indicating whether to import embedded files when merging.
+    #
+    attr_accessor :embedded_files
+
+    #
+    # Gets or sets a boolean indicating whether to import form fields when merging.
+    #
+    attr_accessor :form_fields
+
+    #
+    # Gets or sets a boolean indicating whether to import XFA form data when merging.
+    #
+    attr_accessor :forms_xfa_data
+
+    #
+    # Gets or sets a boolean indicating whether to import logical structure (tagging information) when merging.
+    #
+    attr_accessor :logical_structure
+
+    #
+    # Gets or sets a boolean indicating whether to import document's opening action (initial page and zoom settings) when merging.
+    #
+    attr_accessor :open_action
+
+    #
+    # Gets or sets a boolean indicating whether to import optional content when merging.
+    #
+    attr_accessor :optional_content_info
+
+    #
+    # Gets or sets a boolean indicating whether to import outlines and bookmarks when merging.
+    #
+    attr_accessor :out_lines
+
+    #
+    # Gets or sets a boolean indicating whether to import OutputIntent when merging.
+    #
+    attr_accessor :output_intent
+
+    #
+    # Gets or sets a boolean indicating whether to import PageAnnotations when merging.
+    #
+    attr_accessor :page_annotations
+
+    #
+    # Gets or sets a boolean indicating whether to import PageLabelsAndSections when merging.
+    #
+    attr_accessor :page_labels_and_sections
+
+    #
+    # Gets or sets the root form field for imported form fields. Useful when merging a PDF repeatedly to have a better contorl on the form field names.
+    #
+    attr_accessor :root_form_field
+
+    #
+    # Gets or sets a boolean indicating whether to import XmpMetadata when merging.
+    #
+    attr_accessor :xmp_metadata
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['documentInfo'] = @document_info if @document_info != 'nil'
+
+      json_array['documentJavaScript'] = @document_java_script if @document_java_script != 'nil'
+
+      json_array['documentProperties'] = @document_properties if @document_properties != 'nil'
+
+      json_array['embeddedFiles'] = @embedded_files if @embedded_files != 'nil'
+
+      json_array['formFields'] = @form_fields if @form_fields != 'nil'
+
+      json_array['formsXfaData'] = @forms_xfa_data if @forms_xfa_data != 'nil'
+
+      json_array['logicalStructure'] = @logical_structure if @logical_structure != 'nil'
+
+      json_array['openAction'] = @open_action if @open_action != 'nil'
+
+      json_array['optionalContentInfo'] = @optional_content_info if @optional_content_info != 'nil'
+
+      json_array['outlines'] = @out_lines if @out_lines != 'nil'
+
+      json_array['outputIntent'] = @output_intent if @output_intent != 'nil'
+
+      json_array['pageAnnotations'] = @page_annotations if @page_annotations != 'nil'
+
+      json_array['pageLabelsAndSections'] = @page_labels_and_sections if @page_labels_and_sections != 'nil'
+
+      json_array['rootFormField'] = @root_form_field if @root_form_field != 'nil'
+
+      json_array['xmpMetadata'] = @xmp_metadata if @xmp_metadata != 'nil'
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/MultiSelectListBoxInformation.rb

@@ -0,0 +1,45 @@
+module DynamicPDFApi
+  #
+  # Represents information of a MultiSelectListBox.
+  #
+  class MultiSelectListBoxInformation
+    def initialize
+      @name = nil
+      @values = {}
+      @default_values = {}
+      @export_values = {}
+      @items = {}
+      @items_export_values = {}
+    end
+
+    #
+    # Gets or Sets the name of a MultiSelectListBox.
+    #
+    attr_accessor :name
+
+    #
+    # Gets or sets a collection of values of the MultiSelectListBox.
+    #
+    attr_accessor :values
+
+    #
+    # Gets or sets a collection of default values of the MultiSelectListBox.
+    #
+    attr_accessor :default_values
+
+    #
+    # Gets or sets a collection of export values of the MultiSelectListBox.
+    #
+    attr_accessor :export_values
+
+    #
+    # Gets or sets a collection of items of the MultiSelectListBox.
+    #
+    attr_accessor :items
+
+    #
+    # Gets or sets a collection of export values of the MultiSelectListBox.
+    #
+    attr_accessor :items_export_values
+  end
+end

data/lib/ruby_client/Outline.rb

@@ -0,0 +1,113 @@
+module DynamicPDFApi
+  require_relative "Action"
+  require_relative "OutlineStyle"
+  # require_relative 'OutlineList'
+
+  autoload :OutlineList, File.join(File.dirname(__FILE__), *%w[OutlineList.rb])
+
+  #
+  # Represents an outline.
+  #
+  class Outline
+    #
+    # Initializes a new instance of the Outline class.
+    #
+    # @param input [PdfInput] The input of type PdfInput .
+    # @param action [Action] Action of the outline.
+    #
+    def initialize(input, action = nil)
+      @_color_name = nil
+      @text = nil
+      @style = nil
+      @expanded = nil
+      @children = nil
+      @action = nil
+      @_from_input_id = nil
+      @color = nil
+
+      @children = OutlineList.new
+      if input.is_a?(String)
+        @text = input
+        @action = action
+      else
+        @_from_input_id = input.id
+        input.merge_options = MergeOptions.new if input.merge_options.nil?
+        input.merge_options.out_lines = false
+      end
+    end
+
+    attr_accessor :_color_name, :_from_input_id
+
+    #
+    # Gets or sets the text of the outline.
+    #
+    attr_accessor :text
+
+    #
+    # Gets or sets the style of the outline.
+    #
+    attr_accessor :style
+
+    #
+    # Gets or sets a value specifying if the outline is expanded.
+    #
+    attr_accessor :expanded
+
+    #
+    # Gets or sets a collection of child outlines.
+    #
+    attr_accessor :children
+    #
+    # Gets or sets the Action of the outline.
+    #
+    attr_accessor :action
+
+    #
+    # Gets or sets the color of the outline.
+    #
+    attr_accessor :color
+
+    #
+    # Gets collection of child outlines.
+    #
+    # @return OutlineList Collection of child outlines.
+    #
+    def _get_children
+      if (@children != nil)
+        @children&._out_lines
+      else
+        nil
+      end
+    end
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "Outline"
+
+      unless @color.nil?
+        color_string = @color._color_string
+        json_array['color'] = color_string unless color_string.nil?
+      end
+
+      json_array["text"] = @text unless @text.nil?
+
+      json_array["linkTo"] = @action unless @action.nil?
+
+      json_array["style"] = @style unless @style.nil?
+
+      json_array["expanded"] = @expanded unless @expanded.nil?
+
+      if !@children.nil? && !@children._out_lines.empty?
+        children_array = []
+        (0..(@children._out_lines.length - 1)).each do |i|
+          children_array << @children._out_lines[i] unless @children._out_lines[i].nil?
+        end
+        json_array["children"] = children_array
+      end
+      json_array["fromInputID"] = @_from_input_id unless @_from_input_id.nil?
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/OutlineList.rb

@@ -0,0 +1,57 @@
+module DynamicPDFApi
+  require_relative 'PageZoom'
+  require_relative 'GoToAction'
+  require_relative 'Outline'
+  require_relative 'PdfInput'
+
+  class OutlineList
+    def initialize
+      @_out_lines = []
+    end
+
+    #
+    # Adds an Outline object to the outline list.
+    #
+    # @param text [String] Text of the outline.
+    # @param input [String]|Input URL the action launches or any of the ImageInput, DlexInput, PdfInput or PageInput objects to create PDF or nil.
+    # @param page_offset [int] Page number to navigate.
+    # @param page_zoom [PageZoom] PageZoom to display the destination.
+    #
+    # @return Outline The Outline object that is created.
+    #
+    def add(text, input = nil, page_offset = 0, page_zoom = PageZoom::FIT_PAGE)
+      if input.nil?
+        out_line = Outline.new(text)
+        @_out_lines << out_line
+        out_line
+      elsif input.is_a?(String)
+        out_line = Outline.new(text, UrlAction.new(input))
+        @_out_lines << out_line
+        out_line
+      elsif input.is_a?(Object)
+        link_to = GoToAction.new(input)
+        link_to.page_offset = page_offset
+        link_to.page_zoom = page_zoom
+        out_line = Outline.new(text, link_to)
+        @_out_lines << out_line
+        out_line
+      end
+    end
+
+    def add_pdf_outlines(pdf_input)
+      @_out_lines << Outline.new(pdf_input)
+    end
+
+    attr_accessor :_out_lines
+
+    def to_json(_options = {})
+      json_array = []
+
+      (0..(@_out_lines.length - 1)).each do |i|
+        json_array << @_out_lines[i] unless @_out_lines[i].nil?
+      end
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/OutlineStyle.rb

@@ -0,0 +1,28 @@
+module DynamicPDFApi
+  #
+  #
+  # Specifies the style of the outline.
+  #
+  #
+  class OutlineStyle
+    #
+    # Bold.
+    #
+    BOLD = 'bold'.freeze
+
+    #
+    # Bold Italic.
+    #
+    BOLD_ITALIC = 'boldItalic'.freeze
+
+    #
+    # Italic.
+    #
+    ITALIC = 'italic'.freeze
+
+    #
+    # Regular.
+    #
+    REGULAR = 'regular'.freeze
+  end
+end

data/lib/ruby_client/OutputSize.rb

@@ -0,0 +1,10 @@
+module DynamicPDFApi
+  class OutputSize
+    def initialize(larger, smaller)
+      @larger = larger
+      @smaller = smaller
+    end
+
+    attr_accessor :larger, :smaller
+  end
+end

data/lib/ruby_client/PageInformation.rb

@@ -0,0 +1,27 @@
+module DynamicPDFApi
+  #
+  # Represents a page information.
+  #
+  class PageInformation
+    def initialize
+      @page_number = nil
+      @width = nil
+      @height = nil
+    end
+
+    #
+    # Gets or sets the page number.
+    #
+    attr_accessor :page_number
+
+    #
+    # Gets or sets the width of the page.
+    #
+    attr_accessor :width
+
+    #
+    # Gets or sets the height of the page.
+    #
+    attr_accessor :height
+  end
+end