dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/Elements/Dim2BarcodeElement.rb

@@ -0,0 +1,28 @@
+module DynamicPDFApi
+  require 'base64'
+
+  require_relative 'BarcodeElement'
+  require_relative 'ElementPlacement'
+  require_relative 'ValueType'
+
+  #
+  # The base class for 2 dimensional barcode (Aztec, Pdf417, DataMatrixBarcode and QrCode).
+  #
+  class Dim2BarcodeElement < BarcodeElement
+    def initialize(value, placement, x_offset, y_offset)
+      if value.is_a?(String)
+        @_value_type = ValueType::STRING
+        super(value, placement, x_offset, y_offset)
+      else
+        super(value, placement, x_offset, y_offset)
+        @_value_type = ValueType::BASE64_ENCODED_BYTES
+        @value = Base64.encode64(value.pack('C*'))
+        @placement = placement
+        @x_offset = x_offset
+        @y_offset = y_offset
+      end
+    end
+
+    attr_accessor :_value_type
+  end
+end

data/lib/ruby_client/Elements/Element.rb

@@ -0,0 +1,46 @@
+module DynamicPDFApi
+  require_relative 'ElementPlacement'
+
+  #
+  # Base class from which all page elements are derived.
+  #
+  class Element
+    def initialize(value = nil, placement = nil, x_offset = 0, y_offset = 0)
+      @even_pages = false
+      @odd_pages = false
+      @_text_font = nil
+      @_resource = nil
+      @_type = nil
+      @_input_value = value
+      @placement = placement
+      @x_offset = x_offset
+      @y_offset = y_offset
+    end
+    attr_accessor :_type, :_resource, :_input_value, :_text_font
+
+    #
+    # Gets and sets placement of the page element on the page.
+    #
+    attr_accessor :placement
+
+    #
+    # Gets or sets the X coordinate of the page element.
+    #
+    attr_accessor :x_offset
+
+    #
+    # Gets or sets the Y coordinate of the page element.
+    #
+    attr_accessor :y_offset
+
+    #
+    # Gets or sets the boolean value specifying whether the element should be added to even pages or not.
+    #
+    attr_accessor :even_pages
+
+    #
+    # Gets or sets the boolean value specifying whether the element should be added to odd pages or not.
+    #
+    attr_accessor :odd_pages
+  end
+end

data/lib/ruby_client/Elements/ElementPlacement.rb

@@ -0,0 +1,36 @@
+module DynamicPDFApi
+  #
+  # Represents the placement of a page element.
+  #
+  class ElementPlacement
+    #
+    # Represents top left placement.
+    #
+    TOP_LEFT = 'topLeft'.freeze
+
+    #
+    # Represents top center placement.
+    #
+    TOP_CENTER = 'topCenter'.freeze
+
+    #
+    # Represents top right placement.
+    #
+    TOP_RIGHT = 'topRight'.freeze
+
+    #
+    # Represents bottom left placement.
+    #
+    BOTTOM_LEFT = 'bottomLeft'.freeze
+
+    #
+    # Represents bottom center placement.
+    #
+    BOTTOM_CENTER = 'bottomCenter'.freeze
+
+    #
+    # Represents bottom right placement.
+    #
+    BOTTOM_RIGHT = 'bottomRight'.freeze
+  end
+end

data/lib/ruby_client/Elements/ElementType.rb

@@ -0,0 +1,96 @@
+module DynamicPDFApi
+  #
+  # Represents page element type.
+  #
+  class ElementType
+    #
+    # Image element.
+    #
+    IMAGE = "Image".freeze
+
+    #
+    # Text element.
+    #
+    TEXT = "Text".freeze
+
+    #
+    # Page numbering element.
+    #
+    PAGE_NUMBERING = "PageNumbering".freeze
+
+    #
+    # Code 128 barcode element.
+    #
+    CODE128_BARCODE = "Code128Barcode".freeze
+
+    #
+    # Code 39 barcode element.
+    #
+    CODE39_BARCODE = "Code39Barcode".freeze
+
+    #
+    # Code 2 of 5 barcode element.
+    #
+    CODE25_BARCODE = "Code25Barcode".freeze
+
+    #
+    # Code 93 barcode element.
+    #
+    CODE93_BARCODE = "Code93Barcode".freeze
+
+    #
+    # Code 11 barcode element.
+    #
+    CODE11_BARCODE = "Code11Barcode".freeze
+
+    #
+    # GS1 DataBar barcode element.
+    #
+    GS1_DATA_BAR_BARCODE = "Gs1DataBarBarcode".freeze
+
+    #
+    # IATA 25 barcode element.
+    #
+    IATA25_BARCODE = "Iata25Barcode".freeze
+
+    #
+    # MSI barcode element.
+    #
+    MSI_BARCODE = "MsiBarcode".freeze
+
+    #
+    # Stacked GS1 DataBar barcode element.
+    #
+    STACKED_GS1_DATA_BAR_BARCODE = "StackedGs1DataBarBarcode".freeze
+
+    #
+    # Aztec barcode element.
+    #
+    AZTEC_BARCODE = "AztecBarcode".freeze
+
+    #
+    # QR Code barcode element.
+    #
+    QR_CODE = "QrCode".freeze
+
+    #
+    # PDF417 barcode element.
+    #
+    PDF417_BARCODE = "Pdf417Barcode".freeze
+
+    #
+    # Data Matrix barcode element.
+    #
+    DATA_MATRIX_BARCODE = "DataMatrixBarcode".freeze
+
+    #
+    # Rectangle element.
+    #
+    RECTANGLE = "Rectangle".freeze
+
+    #
+    # Line element.
+    #
+    LINE = "Line".freeze
+  end
+end

data/lib/ruby_client/Elements/ErrorCorrection.rb

@@ -0,0 +1,56 @@
+module DynamicPDFApi
+  #
+  # The level of error correction to use in a barcode.
+  #
+  class ErrorCorrection
+    #
+    # Error Correction Level 0.
+    #
+    LEVEL_0 = 'level0'.freeze
+
+    #
+    # Error Correction Level 1.
+    #
+    LEVEL_1 = 'level1'.freeze
+
+    #
+    # Error Correction Level 2.
+    #
+    LEVEL_2 = 'level2'.freeze
+
+    #
+    # Error Correction Level 3.
+    #
+    LEVEL_3 = 'level3'.freeze
+
+    #
+    # Error Correction Level 4.
+    #
+    LEVEL_4 = 'level4'.freeze
+
+    #
+    # Error Correction Level 5.
+    #
+    LEVEL_5 = 'level5'.freeze
+
+    #
+    # Error Correction Level 6.
+    #
+    LEVEL_6 = 'level6'.freeze
+
+    #
+    # Error Correction Level 7.
+    #
+    LEVEL_7 = 'level7'.freeze
+
+    #
+    # Error Correction Level 8.
+    #
+    LEVEL_8 = 'level8'.freeze
+
+    #
+    # Error Correction Auto.
+    #
+    AUTO = 'auto'.freeze
+  end
+end

data/lib/ruby_client/Elements/Gs1DataBarBarcodeElement.rb

@@ -0,0 +1,76 @@
+module DynamicPDFApi
+  require_relative "TextBarcodeElement"
+  require_relative "ElementType"
+
+  #
+  # Represents a GS1DataBar barcode element.
+  #
+  # This class can be used to place a GS1DataBar barcode on a page.
+  #
+  class Gs1DataBarBarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the Gs1DataBarBarcodeElement 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 type [String] The GS1DataBarType 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, type, placement = ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      @_type = ElementType::GS1_DATA_BAR_BARCODE
+      super(value, placement, x_offset, y_offset)
+      @_gs1_data_bar_type = type
+      @height = height
+    end
+
+    attr_accessor :_type, :_gs1_data_bar_type, :height
+
+    #
+    # Gets or sets the height of the barcode.
+    #
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "gs1DataBarBarcode"
+
+      json_array["gs1DataBarType"] = @_gs1_data_bar_type unless @_gs1_data_bar_type.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/Gs1DataBarType.rb

@@ -0,0 +1,22 @@
+module DynamicPDFApi
+  #
+  # Represents GS1 DataBar types.
+  #
+  class Gs1DataBarType
+    #
+    # Omnidirectional GS1 DataBar type.
+    #
+    OMNIDIRECTIONAL = 'omnidirectional'.freeze
+
+    #
+    # Limited GS1 DataBar type.
+    #
+    #
+    LIMITED = 'limited'.freeze
+
+    #
+    # Expanded GS1 DataBar type.
+    #
+    EXPANDED = 'expanded'.freeze
+  end
+end

data/lib/ruby_client/Elements/Iata25BarcodeElement.rb

@@ -0,0 +1,83 @@
+module DynamicPDFApi
+  require_relative 'TextBarcodeElement'
+  require_relative 'ElementType'
+
+  #
+  # Represents an IATA 2 of 5 barcode element.
+  #
+  # This class can be used to place an IATA 2 of 5 barcode on a page.
+  #
+  class Iata25BarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the Iata25BarcodeElement 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::IATA25_BARCODE
+      @include_check_digit = false
+      @height = height
+      super(value, placement, x_offset, y_offset)
+    end
+
+    attr_accessor :_type
+
+    #
+    # Gets or sets a value indicating if the check digit should be added to the value.
+    #
+    attr_accessor :include_check_digit
+
+    #
+    # Gets or sets the height of the barcode.
+    #
+    attr_accessor :height
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array['type'] = 'iata25Barcode'
+
+      # if(@IncludeCheckDigit != nil)
+      json_array['includeCheckDigit'] = @include_check_digit
+
+      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/ImageElement.rb

@@ -0,0 +1,108 @@
+module DynamicPDFApi
+  require_relative 'Element'
+  require_relative 'ElementType'
+
+  #
+  # Represents an image element.
+  #
+  # This class can be used to place images on a page.
+  #
+  class ImageElement < Element
+    #
+    # Initializes a new instance of the ImageElement class.
+    #
+    # @param resource [ImageResource]|[String] ImageResource object containing the image resource or the name of the image resource.
+    # @param placement [String] The placement of the image on the page.
+    # @param x_offset [float] X coordinate of the image.
+    # @param y_offset [float] Y coordinate of the image.
+    #
+    def initialize(resource, placement= ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      super()
+      @_type = ElementType::IMAGE
+      @_resource = nil
+      @_resource_name = nil
+
+      if resource.is_a?(String)
+        @_resource_name = resource
+      else
+        # super()
+        @_resource = resource
+        @_resource_name = resource.resource_name
+      end
+
+      @placement = placement
+      @x_offset = x_offset
+      @y_offset = y_offset
+    end
+
+    #
+    # Initializes a new instance of the ImageElement class.
+    #
+    # @param resourceName [String] The name of the image resource.
+    # @param placement [String] The placement of the image on the page.
+    # @param x_offset [float] X coordinate of the image.
+    # @param y_offset [float] Y coordinate of the image.
+    #
+    # @return ImageElement returns ImageElement object.
+    #
+    def self.create_image_element(resource_name, placement, x_offset = 0, y_offset = 0)
+      image_element = new ImageElement(nil, nil)
+      image_element._resource_name = resource_name
+      image_element.placement = placement
+      image_element.x_offset = x_offset
+      image_element.y_offset = y_offset
+      image_element
+    end
+
+    attr_accessor :_resource_name
+
+    #
+    # Gets or sets the horizontal scale of the image.
+    #
+    attr_accessor :scale_x
+
+    #
+    # Gets or sets the vertical scale of the image.
+    #
+    attr_accessor :scale_y
+
+    #
+    # Gets or sets the maximum height of the image.
+    #
+    attr_accessor :max_height
+
+    #
+    # Gets or sets the maximum width of the image.
+    #
+    attr_accessor :max_width
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'image'
+
+      json_array['resourceName'] = @_resource_name unless @_resource_name.nil?
+
+      json_array['scaleX'] = @scale_x unless @scale_x.nil?
+
+      json_array['scaleY'] = @scale_y unless @scale_y.nil?
+
+      json_array['maxHeight'] = @max_height unless @max_height.nil?
+
+      json_array['maxWidth'] = @max_width unless @max_width.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/LineElement.rb

@@ -0,0 +1,92 @@
+module DynamicPDFApi
+  require_relative "Element"
+  require_relative "ElementPlacement"
+  require_relative "ElementType"
+  require_relative "../LineStyle"
+  #
+  # Represents a line page element.
+  #
+  # This class can be used to place lines of different length, width, color and patterns on a page.
+  #
+  class LineElement < Element
+    #
+    # Initializes a new instance of the LineElement class.
+    #
+    # @param placement [String] The placement of the line on the page.
+    # @param x2_offset [float] X2 coordinate of the line.
+    # @param y2_offset [float] Y2 coordinate of the line.
+    #
+    def initialize(x2_offset, y2_offset, placement = ElementPlacement::TOP_LEFT)
+      super()
+      @color = nil
+      @width = nil
+      @line_style = nil
+      @_type = ElementType::LINE
+
+      @placement = placement
+      @x2_offset = x2_offset
+      @y2_offset = y2_offset
+    end
+
+    #
+    # Gets or sets the Color object to use for the line.
+    #
+    attr_accessor :color
+
+    #
+    # Gets or sets the X2 coordinate of the line.
+    #
+    attr_accessor :x2_offset
+
+    #
+    # Gets or sets the Y2 coordinate of the line.
+    #
+    attr_accessor :y2_offset
+
+    #
+    # Gets or sets the width of the line.
+    #
+    attr_accessor :width
+
+    #
+    # Gets or sets the LineStyle object to use for the style of the line.
+    #
+    attr_accessor :line_style
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array["type"] = "line"
+
+      json_array["color"] = @color._color_string if !@color.nil? && !@color._color_string.nil?
+
+      json_array["xOffset"] = @x_offset unless @x_offset.nil?
+
+      json_array["yOffset"] = @y_offset unless @y_offset.nil?
+
+      json_array["x2Offset"] = @x2_offset unless @x2_offset.nil?
+
+      json_array["y2Offset"] = @y2_offset unless @y2_offset.nil?
+
+      json_array["width"] = @width unless @width.nil?
+
+      if !@line_style.nil? && !@line_style._line_style_string.nil?
+        json_array["lineStyle"] =
+          @line_style._line_style_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/MsiBarcodeCheckDigitMode.rb

@@ -0,0 +1,31 @@
+module DynamicPDFApi
+  #
+  # MSI Barcode check digit modes.
+  #
+  class MsiBarcodeCheckDigitMode
+    #
+    # No check digit.
+    #
+    NONE = 'none'.freeze
+
+    #
+    # check digit of mod 10.
+    #
+    MOD10 = 'mod10'.freeze
+
+    #
+    # check digit of mod 11.
+    #
+    MOD11 = 'mod11'.freeze
+
+    #
+    # check digit of mod 1010.
+    #
+    MOD1010 = 'mod1010'.freeze
+
+    #
+    # check digit of mod 1110.
+    #
+    MOD1110 = 'mod1110'.freeze
+  end
+end