dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/Elements/Code128BarcodeElement.rb

@@ -0,0 +1,105 @@
+module DynamicPDFApi
+  require_relative "Element"
+  require_relative "ElementType"
+  require_relative "TextBarcodeElement"
+
+  #
+  # Represents a Code 128 barcode element.
+  #
+  # This class can be used to place a Code 128 barcode on a page.
+  #
+  class Code128BarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the Code128BarcodeElement class.
+    #
+    # Code sets can be specified along with data, in order to do this ProcessTilde property needs to be set
+    # to true. Example value: '~BHello ~AWORLD 1~C2345', where ~A, ~B and ~C representing code sets A, B and
+    # C respectively. However if any inline code set has invalid characters it will be shifted to an appropriate
+    # code set.
+    #
+    # @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)
+      @ucc_ean128 = false
+      @process_tilde = false
+      @_type = ElementType::CODE128_BARCODE
+      super(value, placement, x_offset, y_offset)
+      @height = height
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets the height of the barcode.
+    #
+    attr_accessor :height
+
+    #
+    # Gets or sets a boolean representing if the barcode is a UCC / EAN Code 128 barcode.
+    #
+    # If true an FNC1 code will be the first character in the barcode.
+    #
+    attr_accessor :ucc_ean128
+
+    #
+    # Gets or Sets a boolean indicating whether to process the tilde character.
+    #
+    # If true checks for fnc1 (~1) character in the barcode Value and checks for the inline code sets if present
+    # in the data to process. Example value: '~BHello ~AWORLD 1~C2345', where ~A, ~B and ~C representing code
+    # sets A, B and C respectively. However if any inline code set has invalid characters it will be shifted
+    # to an appropriate code set. '\' is used as an escape character to add ~.
+    #
+    attr_accessor :process_tilde
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "code128Barcode"
+
+      json_array["height"] = @height unless @height.nil?
+
+      # if(@ucc_ean128 != nil)
+      json_array["uccEan128"] = @ucc_ean128
+
+      # if(@process_tilde != nil)
+      json_array["processTilde"] = @process_tilde
+
+      #----------------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/Code25BarcodeElement.rb

@@ -0,0 +1,75 @@
+module DynamicPDFApi
+  require_relative "TextBarcodeElement"
+  require_relative "ElementPlacement"
+  require_relative "ElementType"
+
+  #
+  # Represents a Code 2 of 5 barcode element.
+  #
+  # This class can be used to place a Code 2 of 5 barcode on a page.
+  #
+  class Code25BarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the Code25BarcodeElement 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)
+      super(value, placement, x_offset, y_offset)
+      @height = height
+      @_type = ElementType::CODE25_BARCODE
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets the height of the barcode.
+    #
+    attr_accessor :height
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "code25Barcode"
+
+      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/Code39BarcodeElement.rb

@@ -0,0 +1,75 @@
+module DynamicPDFApi
+  require_relative "TextBarcodeElement"
+  require_relative "ElementPlacement"
+  require_relative "ElementType"
+
+  #
+  # Represents a Code 3 of 9 barcode element.
+  #
+  # This class can be used to place a Code 3 of 9 barcode on a page.
+  #
+  class Code39BarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the Code39BarcodeElement 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)
+      @_type = ElementType::CODE39_BARCODE
+      super(value, placement, x_offset, y_offset)
+      @height = height
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets the height of the barcode.
+    #
+    attr_accessor :height
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "code39Barcode"
+
+      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/Code93BarcodeElement.rb

@@ -0,0 +1,75 @@
+module DynamicPDFApi
+  require_relative "TextBarcodeElement"
+  require_relative "ElementPlacement"
+  require_relative "ElementType"
+
+  #
+  # Represents a Code93 barcode element.
+  #
+  # This class can be used to place a Code93 barcode on a page.
+  #
+  class Code93BarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the Code93BarcodeElement 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)
+      @_type = ElementType::CODE93_BARCODE
+      super(value, placement, x_offset, y_offset)
+      @height = height
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets the height of the barcode.
+    #
+    attr_accessor :height
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "code93Barcode"
+
+      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/Compaction.rb

@@ -0,0 +1,26 @@
+module DynamicPDFApi
+  #
+  # The type of Compaction to encode.
+  #
+  class Compaction
+    #
+    # Byte Compaction.
+    #
+    BYTE = "byte".freeze
+
+    #
+    # Text Compaction.
+    #
+    TEXT = "text".freeze
+
+    #
+    # Numeric Compaction.
+    #
+    NUMERIC = "numeric".freeze
+
+    #
+    # All Compactions.
+    #
+    AUTO = "auto".freeze
+  end
+end

data/lib/ruby_client/Elements/DataMatrixBarcodeElement.rb

@@ -0,0 +1,95 @@
+module DynamicPDFApi
+  require_relative "Dim2BarcodeElement"
+  require_relative "ElementPlacement"
+  require_relative "ElementType"
+  require_relative "DataMatrixSymbolSize"
+  require_relative "DataMatrixEncodingType"
+  require_relative "DataMatrixFunctionCharacter"
+
+  #
+  # Represents a Data Matrix  barcode element.
+  #
+  # With some of the .Net runtime (example: .Net Core 2.0), the ECI values 20, 28, 29 and 30 will give the
+  # error 'No data is available for encoding 'code page number'. For information on defining a custom encoding,
+  # see the documentation for the Encoding.RegisterProvider method.'.
+  #
+  class DataMatrixBarcodeElement < Dim2BarcodeElement
+    #
+    # Initializes a new instance of the DataMatrixBarcodeElement class.
+    #
+    # @param value [String]|array The value of the barcode either as string or as byte array.
+    # @param placement [String] The placement of the barcode on the page.
+    # @param x_offset [float] The X coordinate of the barcode.
+    # @param y_offset [float] The Y coordinate of the barcode.
+    # @param symbol_size [String] The symbol size of the barcode.
+    # @param encoding_type [String] The encoding type of the barcode.
+    # @param function_character [String] The def character of the barcode.
+    #
+    def initialize(value, placement = ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0, symbol_size = DataMatrixSymbolSize::AUTO, encoding_type = DataMatrixEncodingType::AUTO, function_character = DataMatrixFunctionCharacter::NONE)
+      @process_tilde = false
+      @_type = ElementType::DATA_MATRIX_BARCODE
+      super(value, placement, x_offset, y_offset)
+      @_data_matrix_symbol_size = symbol_size
+      @_data_matrix_encoding_type = encoding_type
+      @_data_matrix_function_character = function_character
+    end
+
+    attr_accessor :_type, :_data_matrix_symbol_size, :_data_matrix_encoding_type, :_data_matrix_function_character
+
+    #
+    # Gets or sets whether to process tilde character.
+    #
+    # Setting true will check for ~ character and processes it for FNC1 or ECI characters. With some of the
+    # .Net runtime (example: .Net Core 2.0), the ECI values 20, 28, 29 and 30 will give the error 'No data
+    # is available for encoding 'code page number'. For information on defining a custom encoding, see the
+    # documentation for the Encoding.RegisterProvider method.'.
+    #
+    attr_accessor :process_tilde
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "dataMatrixBarcode"
+
+      # if(@process_tilde != nil)
+      json_array["processTilde"] = @process_tilde
+
+      json_array["dataMatrixSymbolSize"] = @_data_matrix_symbol_size unless @_data_matrix_symbol_size.nil?
+
+      json_array["dataMatrixEncodingType"] = @_data_matrix_encoding_type unless @_data_matrix_encoding_type.nil?
+
+      unless @_data_matrix_function_character.nil?
+        json_array["dataMatrixFunctionCharacter"] =
+          @_data_matrix_function_character
+      end
+
+      #--------------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/DataMatrixEncodingType.rb

@@ -0,0 +1,56 @@
+module DynamicPDFApi
+  #
+  # Specifies EncodingType for DataMatrix Barcode.
+  #
+  class DataMatrixEncodingType
+    #
+    # Calculates Encoding based on Value.
+    #
+    AUTO = 'auto'.freeze
+
+    #
+    # Calculates ASCII Encoding based on Value.
+    #
+    AUTO_ASCII = 'autoAscii'.freeze
+
+    #
+    # ASCII Encoding.
+    #
+    ASCII = 'ascii'.freeze
+
+    #
+    # Extended ASCII Encoding.
+    #
+    EXTENDED_ASCII = 'extendedAscii'.freeze
+
+    #
+    # Double digit Encoding.
+    #
+    DOUBLE_DIGIT = 'doubleDigit'.freeze
+
+    #
+    # C40 Encoding.
+    #
+    C40 = 'c40'.freeze
+
+    #
+    # Text Encoding.
+    #
+    TEXT = 'text'.freeze
+
+    #
+    # ANSI X12 Encoding.
+    #
+    ANSI_X12 = 'ansiX12'.freeze
+
+    #
+    # EDIFACT Encoding.
+    #
+    EDIFACT = 'edifact'.freeze
+
+    #
+    # Base256 Encoding.
+    #
+    BASE256 = 'base256'.freeze
+  end
+end

data/lib/ruby_client/Elements/DataMatrixFunctionCharacter.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  #
+  # Specifies the Function Character for a DataMatrix Barcode.
+  #
+  class DataMatrixFunctionCharacter
+    #
+    # Macro 05 Character.
+    #
+    MACRO05 = 'macro05'.freeze
+
+    #
+    # Macro 06 Character.
+    #
+    MACRO06 = 'macro06'.freeze
+
+    #
+    # ReaderProgramming Character.
+    #
+    READER_PROGRAMMING = 'readerProgramming'.freeze
+
+    #
+    # FNC1 Character.
+    #
+    FNC1 = 'fnC1'.freeze
+
+    #
+    # None.
+    #
+    NONE = 'none'.freeze
+  end
+end

data/lib/ruby_client/Elements/DataMatrixSymbolSize.rb

@@ -0,0 +1,161 @@
+module DynamicPDFApi
+  #
+  # Specifies the symbol size of a DataMatrix Barcode.
+  #
+  class DataMatrixSymbolSize
+    #
+    # Calculates symbol size based on the value.
+    #
+    AUTO = 'auto'.freeze
+
+    #
+    # 10 rows by 10 columns.
+    #
+    R10_X_C10 = 'r10xC10'.freeze
+
+    #
+    # 12 rows by 12 columns.
+    #
+    R12_X_C12 = 'r12xC12'.freeze
+
+    #
+    # 14 rows by 14 columns.
+    #
+    R14_X_C14 = 'r14xC14'.freeze
+
+    #
+    # 16 rows by 16 columns.
+    #
+    R16_X_C16 = 'r16xC16'.freeze
+
+    #
+    # 18 rows by 18 columns.
+    #
+    R18_X_C18 = 'r18xC18'.freeze
+
+    #
+    # 20 rows by 20 columns.
+    #
+    R20_X_C20 = 'r20xC20'.freeze
+
+    #
+    # 22 rows by 22 columns.
+    #
+    R22_X_C22 = 'r22xC22'.freeze
+
+    #
+    # 24 rows by 24 columns.
+    #
+    R24_X_C24 = 'r24xC24'.freeze
+
+    #
+    # 26 rows by 26 columns.
+    #
+    R26_X_C26 = 'r26xC26'.freeze
+
+    #
+    # 32 rows by 32 columns.
+    #
+    R32_X_C32 = 'r32xC32'.freeze
+
+    #
+    # 36 rows by 36 columns.
+    #
+    R36_X_C36 = 'r36xC36'.freeze
+
+    #
+    # 40 rows by 40 columns.
+    #
+    R40_X_C40 = 'r40xC40'.freeze
+
+    #
+    # 44 rows by 44 columns.
+    #
+    R44_X_C44 = 'r44xC44'.freeze
+
+    #
+    # 48 rows by 48 columns.
+    #
+    R48_X_C48 = 'r48xC48'.freeze
+
+    #
+    # 52 rows by 52 columns.
+    #
+    R52_X_C52 = 'r52xC52'.freeze
+
+    #
+    # 64 rows by 64 columns.
+    #
+    R64_X_C64 = 'r64xC64'.freeze
+
+    #
+    # 72 rows by 72 columns.
+    #
+    R72_X_C72 = 'r72xC72'.freeze
+
+    #
+    # 80 rows by 80 columns.
+    #
+    R80_X_C80 = 'r80xC80'.freeze
+
+    #
+    # 88 rows by 88 columns.
+    #
+    R88_X_C88 = 'r88xC88'.freeze
+
+    #
+    # 96 rows by 96 columns.
+    #
+    R96_X_C96 = 'r96xC96'.freeze
+
+    #
+    # 104 rows by 104 columns.
+    #
+    R104_X_C104 = 'r104xC104'.freeze
+
+    #
+    # 120 rows by 120 columns.
+    #
+    R120_X_C120 = 'r120xC120'.freeze
+
+    #
+    # 132 rows by 132 columns.
+    #
+    R132_X_C132 = 'r132xC132'.freeze
+
+    #
+    # 144 rows by 144 columns.
+    #
+    R144_X_C144 = 'r144xC144'.freeze
+
+    #
+    # 8 rows by 18 columns.
+    #
+    R8_X_C18 = 'r8xC18'.freeze
+
+    #
+    # 8 rows by 32 columns.
+    #
+    R8_X_C32 = 'r8xC32'.freeze
+
+    #
+    # 12 rows by 26 columns.
+    #
+    R12_X_C26 = 'r12xC26'.freeze
+
+    #
+    # 12 rows by 36 columns.
+    #
+    R12_X_C36 = 'r12xC36'.freeze
+
+    #
+    # 16 rows by 36 columns.
+    #
+    R16_X_C36 = 'r16xC36'.freeze
+
+    #
+    # 16 rows by 48 columns.
+    #
+    R16_X_C48 = 'r16xC48'.freeze
+  end
+end