dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/Elements/MsiBarcodeElement.rb

@@ -0,0 +1,79 @@
+module DynamicPDFApi
+  require_relative 'TextBarcodeElement'
+  require_relative 'ElementType'
+
+  #
+  # Represents a MSI Barcode element (also known as Modified Plessey).
+  #
+  class MsiBarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the MsiBarcodeElement class.
+    #
+    # @param value [String] The value of the barcode.
+    # @param placement [String] The placement of the barcode on the page.
+    # @param height [float] The height of the barcode.
+    # @param x_offset [float] The X coordinate of the barcode.
+    # @param y_offset [float] The Y coordinate of the barcode.
+    #
+    def initialize(value,  height, placement= ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      @append_check_digit = nil
+      @height = height
+      super(value, placement, x_offset, y_offset)
+      @_type = ElementType::MSI_BARCODE
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets a value specifying if the check digit should calculated.
+    #
+    attr_accessor :append_check_digit
+    #
+    # Gets or sets the height of the barcode.
+    #
+    attr_accessor :height
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['type'] = 'msiBarcode'
+
+      json_array['appendCheckDigit'] = @append_check_digit unless @append_check_digit.nil?
+
+      json_array['height'] = @height unless @height.nil?
+
+      #----------------TextBarcodeElement---------------------------------
+      json_array['font'] = @_font_name unless @_font_name.nil?
+
+      json_array['textColor'] = @text_color._color_string if !@text_color.nil? && !@text_color._color_string.nil?
+
+      json_array['fontSize'] = @font_size unless @font_size.nil?
+
+      json_array['showText'] = @show_text if @show_text != 'nil'
+
+      #----------------barcodeElement--------------------------------
+
+      json_array['color'] = @color._color_string if !@color.nil? && !@color._color_string.nil?
+
+      json_array['xDimension'] = @x_dimension unless @x_dimension.nil?
+
+      json_array['value'] = @value unless @value.nil?
+
+      # ------------element---------------------
+
+      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?
+
+      # if(@even_pages != nil)
+      json_array['evenPages'] = @even_pages
+
+      # if(@odd_pages != nil)
+      json_array['oddPages'] = @odd_pages
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Elements/PageNumberingElement.rb

@@ -0,0 +1,91 @@
+module DynamicPDFApi
+  require_relative 'Element'
+  require_relative 'ElementType'
+  require_relative '../Font'
+  #
+  # Represents a page numbering label page element.
+  #
+  # This class can be used to add page numbering to a PDF document. The following tokens can be used within
+  # the text of a PageNumberingLabel. They will be replaced with the appropriate value when the PDF is output.
+  # table All tokens except the /%/%PR/%/% token can also contain a numbering style specifier. The numbering
+  # style specifier is placed in parenthesis after the token. table There should be no spaces within a token,
+  # only the token and optional numbering style specifier. This token is invalid /%/%CP ( i )/%/% because
+  # of the extra spaces.Here are some examples of valid tokens: margin-top: 0px
+  #
+  class PageNumberingElement < Element
+    #
+    # Initializes a new instance of the PageNumberingElement class.
+    #
+    # @param text [String] Text to display in the label.
+    # @param placement [String] The placement of the page numbering element on the page.
+    # @param x_offset [float] X coordinate of the label.
+    # @param y_offset [float] Y coordinate of the label.
+    #
+    def initialize(text, placement= ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      @_font_name = nil
+      @color = nil
+      @font_size = nil
+
+      @_text_font = nil
+      @_resource = nil
+      @_type = ElementType::PAGE_NUMBERING
+
+      super(text, placement, x_offset, y_offset)
+      @text = text
+    end
+
+    attr_accessor :_font_name
+
+    #
+    # Gets or sets the Color object to use for the text of the label.
+    #
+    attr_accessor :color
+
+    #
+    # Gets or sets the font size for the text of the label.
+    #
+    attr_accessor :font_size
+
+    #
+    # Gets or sets the text to display in the label.
+    #
+    attr_accessor :text
+
+    #
+    # Gets or sets the Font object to use for the text of the label.
+    #
+    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'] = 'pageNumbering'
+
+      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).gsub('\\\\', '\\').gsub('\"', '"').gsub('\\\r', '\r').gsub('\\\n', '\n').gsub('\\\t', '\t')
+    end
+  end
+end

data/lib/ruby_client/Elements/Pdf417BarcodeElement.rb

@@ -0,0 +1,112 @@
+module DynamicPDFApi
+  require_relative 'Dim2BarcodeElement'
+  require_relative 'ErrorCorrection'
+  require_relative 'ElementType'
+  require_relative 'Compaction'
+
+  #
+  # Represents Pdf417 barcode element.
+  #
+  # This class can be used to generate Pdf417 barcode symbol.
+  #
+  class Pdf417BarcodeElement < Dim2BarcodeElement
+    #
+    # Initializes a new instance of the Pdf417BarcodeElement class.
+    #
+    # @param value [String]|array String to be encoded either as string or byte array.
+    # @param placement [String] The placement of the barcode on the page.
+    # @param columns int [Columns] of the PDF417 barcode.
+    # @param x_offset [float] The X coordinate of the PDF417 barcode.
+    # @param y_offset [float] The Y coordinate of the PDF417 barcode.
+    #
+    def initialize(value,  columns, placement= ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      @columns = nil
+      @y_dimension = nil
+      @process_tilde = false
+      @compact_pdf417 = false
+      @error_correction = nil
+      @compaction = nil
+
+      super(value, placement, x_offset, y_offset)
+      @columns = columns
+      @_type = ElementType::PDF417_BARCODE
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets the columns of the barcode.
+    #
+    attr_accessor :columns
+
+    #
+    # Gets or sets the YDimension of the barcode.
+    #
+    attr_accessor :y_dimension
+
+    #
+    # Gets or Sets a boolean indicating whether to process the tilde character.
+    #
+    attr_accessor :process_tilde
+    #
+    # Gets or sets the Compact Pdf417.
+    #
+    attr_accessor :compact_pdf417
+    #
+    # Gets or sets the error correction level for the PDF417 barcode.
+    #
+    attr_accessor :error_correction
+    #
+    # Gets or sets the type of compaction.
+    #
+    attr_accessor :compaction
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['type'] = 'pdf417Barcode'
+
+      json_array['columns'] = @columns unless @columns.nil?
+
+      json_array['yDimension'] = @y_dimension unless @y_dimension.nil?
+
+      # if(@process_tilde != nil)
+      json_array['processTilde'] = @process_tilde
+
+      # if(@CompactPdf417 != nil)
+      json_array['compactPdf417'] = @compact_pdf417
+
+      json_array['errorCorrection'] = @error_correction unless @error_correction.nil?
+
+      json_array['compaction'] = @compaction unless @compaction.nil?
+
+      #--------------Dim2BarcodeElement------------------------------
+
+      json_array['valueType'] = @_value_type unless @_value_type.nil?
+
+      #----------------barcodeElement--------------------------------
+
+      json_array['color'] = @color._color_string if !@color.nil? && !@color._color_string.nil?
+
+      json_array['xDimension'] = @x_dimension unless @x_dimension.nil?
+
+      json_array['value'] = @value unless @value.nil?
+
+      # ------------element---------------------
+
+      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?
+
+      # if(@even_pages != nil)
+      json_array['evenPages'] = @even_pages
+
+      # if(@odd_pages != nil)
+      json_array['oddPages'] = @odd_pages
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Elements/QrCodeElement.rb

@@ -0,0 +1,77 @@
+module DynamicPDFApi
+  require_relative 'Dim2BarcodeElement'
+  require_relative 'ElementType'
+
+  #
+  #
+  # Represents a QR code barcode element.
+  #
+  # With some of the .Net runtime (example: .Net Core 2.0), the Kanchi encoding will give the error 'No
+  # data is available for encoding 932. For information on defining a custom encoding, see the documentation
+  # for the Encoding.RegisterProvider method.'.
+  #
+  class QrCodeElement < Dim2BarcodeElement
+    #
+    # Initializes a new instance of the QrCodeElement class.
+    #
+    # @param value [String]|array The value of the QR code either as string or byte array.
+    # @param placement [String] The placement of the barcode on the page.
+    # @param x_offset [float] The X coordinate of the QR code.
+    # @param y_offset [float] The Y coordinate of the QR code.
+    #
+    def initialize(value, placement= ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      super(value, placement, x_offset, y_offset)
+      @_type = ElementType::QR_CODE
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets FNC1 mode.
+    #
+    attr_accessor :fnc1
+
+    #
+    # Gets or sets the QR code version.
+    #
+    attr_accessor :version
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['type'] = 'qrCode'
+
+      json_array['fnc1'] = @fnc1 unless @fnc1.nil?
+
+      json_array['version'] = @version unless @version.nil?
+
+      #--------------Dim2BarcodeElement------------------------------
+
+      json_array['valueType'] = @_value_type unless @_value_type.nil?
+
+      #----------------barcodeElement--------------------------------
+
+      json_array['color'] = @color._color_string if !@color.nil? && !@color._color_string.nil?
+
+      json_array['xDimension'] = @x_dimension unless @x_dimension.nil?
+
+      json_array['value'] = @value unless @value.nil?
+
+      # ------------element---------------------
+
+      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?
+
+      # if(@even_pages != nil)
+      json_array['evenPages'] = @even_pages
+
+      # if(@odd_pages != nil)
+      json_array['oddPages'] = @odd_pages
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Elements/QrCodeFnc1.rb

@@ -0,0 +1,22 @@
+module DynamicPDFApi
+  #
+  # The type of FNC1 mode to use.
+  #
+  class QrCodeFnc1
+
+    #
+    # FNC1 Gs1.
+    #
+    GS1 = 'gs1'.freeze
+
+    #
+    # FNC1 Industry.
+    #
+    INDUSTRY = 'industry'.freeze
+
+    #
+    # FNC1 None.
+    #
+    NONE = 'none'.freeze
+  end
+end

data/lib/ruby_client/Elements/RectangleElement.rb

@@ -0,0 +1,109 @@
+module DynamicPDFApi
+  require_relative 'Element'
+  require_relative 'ElementPlacement'
+  require_relative 'ElementType'
+
+  #
+  # Represents a rectangle page element.
+  #
+  # This class can be used to place rectangles of any size or color on a page.
+  #
+  class RectangleElement < Element
+    #
+    # Initializes a new instance of the RectangleElement class.
+    #
+    # @param placement [String] The placement of the rectangle on the page.
+    # @param width [float] Width of the rectangle.
+    # @param height [float] Height of the rectangle.
+    #
+    def initialize(width, height,placement= ElementPlacement::TOP_LEFT)
+      super()
+      @_type = ElementType::RECTANGLE
+      @border_width = nil
+      @corner_radius = nil
+      @border_style = nil
+      @border_color = nil
+      @fill_color = nil
+
+      @placement = placement
+      @width = width
+      @height = height
+    end
+
+    #
+    # Gets or sets the width of the rectangle.
+    #
+    attr_accessor :width
+
+    #
+    # Gets or sets the height of the rectangle.
+    #
+    attr_accessor :height
+
+    #
+    # Gets or sets the border width of the rectangle.
+    #
+    # To force the borders not to appear set the border width to any value 0 or less.
+    #
+    attr_accessor :border_width
+
+    #
+    # Gets or sets the corner radius of the rectangle.
+    #
+    attr_accessor :corner_radius
+    #
+    # Gets or sets the LineStyle object used to specify the border style of the rectangle.
+    #
+    attr_accessor :border_style
+    #
+    # Gets or sets the Color object to use for the border of the rectangle.
+    #
+    attr_accessor :border_color
+    #
+    # Gets or sets the Color object to use for the fill of the rectangle.
+    #
+    # To force no color to appear in the rectangle (only borders) set the fill color to nil (Nothing in Visual
+    # Basic).
+    #
+    attr_accessor :fill_color
+
+    def to_json(_options = {})
+      # 'width':100.0,'height':50.0,'cornerRadius':0.0,'placement':'topCenter','xOffset':0.0,'yOffset':0.0
+      json_array = {}
+      json_array['type'] = 'rectangle'
+
+      json_array['width'] = @width unless @width.nil?
+
+      json_array['height'] = @height unless @height.nil?
+
+      json_array['borderWidth'] = @border_width unless @border_width.nil?
+
+      json_array['cornerRadius'] = @corner_radius unless @corner_radius.nil?
+
+      json_array['fillColor'] = @fill_color._color_string if !@fill_color.nil? && !@fill_color._color_string.nil?
+
+      if !@border_style.nil? && !@border_style._line_style_string.nil?
+        json_array['borderStyle'] = @border_style._line_style_string
+      end
+
+      if !@border_color.nil? && !@border_color._color_string.nil?
+        json_array['borderColor'] =
+          @border_color._color_string
+      end
+
+      # ---------------------------------
+
+      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/StackedGs1DataBarBarcodeElement.rb

@@ -0,0 +1,90 @@
+module DynamicPDFApi
+  require_relative 'TextBarcodeElement'
+  require_relative 'ElementType'
+
+  #
+  # Represents a StackedGS1DataBar barcode element.
+  #
+  # This class can be used to place a StackedGS1DataBar barcode on a page.
+  #
+  class StackedGs1DataBarBarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the StackedGs1DataBarBarcodeElement class.
+    #
+    # @param value [String] The value of the barcode.
+    # @param placement [String] The placement of the barcode on the page.
+    # @param stacked_gs1_data_bar_type [String] The StackedGS1DataBarType of the barcode.
+    # @param row_height [float] The row height of the barcode.
+    # @param x_offset [float] The X coordinate of the barcode.
+    # @param y_offset [float] The Y coordinate of the barcode.
+    #
+    def initialize(value,  stacked_gs1_data_bar_type, row_height, placement= ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      super(value, placement, x_offset, y_offset)
+      @_stacked_gs1_data_bar_type = stacked_gs1_data_bar_type
+      @row_height = row_height
+      @_type = ElementType::STACKED_GS1_DATA_BAR_BARCODE
+    end
+
+    attr_accessor :_type, :_stacked_gs1_data_bar_type
+
+    #
+    # Gets or Sets the segment count of the Expanded Stacked barcode.
+    #
+    # This is used only for the ExpandedStacked Gs1DataBar type.
+    #
+    attr_accessor :expanded_stacked_segment_count
+
+    #
+    # Gets or sets the row height of the barcode.
+    #
+    attr_accessor :row_height
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['type'] = 'stackedGs1DataBarBarcode'
+
+      json_array['stackedGs1DataBarType'] = @_stacked_gs1_data_bar_type unless @_stacked_gs1_data_bar_type.nil?
+
+      unless @expanded_stacked_segment_count.nil?
+        json_array['expandedStackedSegmentCount'] =
+          @expanded_stacked_segment_count
+      end
+
+      json_array['rowHeight'] = @row_height unless @row_height.nil?
+
+      #----------------TextBarcodeElement---------------------------------
+      json_array['font'] = @_font_name unless @_font_name.nil?
+
+      json_array['textColor'] = @text_color._color_string if !@text_color.nil? && !@text_color._color_string.nil?
+
+      json_array['fontSize'] = @font_size unless @font_size.nil?
+
+      json_array['showText'] = @show_text if @show_text != 'nil'
+
+      #----------------barcodeElement--------------------------------
+
+      json_array['color'] = @color._color_string if !@color.nil? && !@color._color_string.nil?
+
+      json_array['xDimension'] = @x_dimension unless @x_dimension.nil?
+
+      json_array['value'] = @value unless @value.nil?
+
+      # ------------element---------------------
+
+      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?
+
+      # if(@even_pages != nil)
+      json_array['evenPages'] = @even_pages
+
+      # if(@odd_pages != nil)
+      json_array['oddPages'] = @odd_pages
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Elements/StackedGs1DataBarType.rb

@@ -0,0 +1,23 @@
+module DynamicPDFApi
+  #
+  #
+  # Represents Stacked GS1 DataBar types.
+  #
+  #
+  class StackedGs1DataBarType
+    #
+    # Stacked type.
+    #
+    STACKED = 'stacked'.freeze
+
+    #
+    # Stacked Omnidirectional type.
+    #
+    STACKED_OMNIDIRECTIONAL = 'stackedOmnidirectional'.freeze
+
+    #
+    # Expanded stacked type.
+    #
+    EXPANDED_STACKED = 'expandedStacked'.freeze
+  end
+end

data/lib/ruby_client/Elements/TextBarcodeElement.rb

@@ -0,0 +1,48 @@
+module DynamicPDFApi
+  require_relative 'BarcodeElement'
+
+  #
+  # Base class from which barcode page elements that display text are derived.
+  #
+  class TextBarcodeElement < BarcodeElement
+    def initialize(value, placement, x_offset, y_offset)
+      @text_color = nil
+      @font_size = nil
+      @show_text = 'nil'
+      @_resource = nil
+      @_text_font = nil
+      @_font_name = nil
+      super(value, placement, x_offset, y_offset)
+    end
+
+    #
+    # Gets or sets the color of the text.
+    #
+    attr_accessor :text_color
+
+    #
+    # Gets or sets the font size to use when displaying the text.
+    #
+    attr_accessor :font_size
+
+    #
+    # Gets or sets a value indicating if the value should be placed as text below the barcode.
+    #
+    attr_accessor :show_text
+
+    attr_accessor :_resource, :_text_font, :_font_name
+
+    #
+    # Gets or sets the font to use when displaying the text.
+    #
+    def font(value)
+      @_text_font = value
+      @_font_name = @_text_font._name
+      @_resource = @_text_font._resource
+    end
+
+    def get_font
+      @_text_font
+    end
+  end
+end