dynamicpdf_api 1.0.0.pre.beta

data/lib/ruby_client/DlexInput.rb

@@ -0,0 +1,61 @@
+module DynamicPDFApi
+  require_relative 'Input'
+  require_relative 'DlexResource'
+  require_relative 'LayoutDataResource'
+  require_relative 'InputType'
+
+  #
+  # Represents a Dlex input.
+  #
+  class DlexInput < Input
+    #
+    # Initializes a new instance of the DlexInput class by posting the DLEX file and the JSON data file from
+    # the client to the API to create the PDF report.
+    #
+    # @param dlex [String]|[DlexResource] The DLEX file path present in the resource manager or the DlexResource file created as per the desired PDF report layout design.
+    # @param layout [String]|[LayoutDataResource] The JSON data file path present in the resource manager used to create the PDF report or the LayoutDataResource file used to create the PDF report.
+    #
+    def initialize(dlex, layout)
+      super()
+      @_resources = []
+      @_type = InputType::DLEX
+
+      if (dlex.is_a?(String)) == true && layout.is_a?(String)
+        # super()
+        @resource_name = dlex
+        @layout_data_resource_name = layout
+      elsif (dlex.is_a?(String)) == true && layout.is_a?(Object)
+        @resource_name = dlex
+        @layout_data_resource_name = layout.layout_data_resource_name
+        @_resources << layout
+      elsif (dlex.is_a?(Object)) == true && layout.is_a?(Object)
+        @resource_name = dlex.resource_name
+        @layout_data_resource_name = layout.layout_data_resource_name
+        # dlex.LayoutDataResourceName=@LayoutDataResourceName
+
+        @_resources << layout
+        @_resources << dlex
+      end
+    end
+
+    #
+    # Gets or sets the name for layout data resource.
+    #
+    attr_accessor :layout_data_resource_name
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'dlex'
+      json_array['layoutDataResourceName'] = @layout_data_resource_name
+
+      #---------------------------------------------------
+      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/DlexLayout.rb

@@ -0,0 +1,135 @@
+module DynamicPDFApi
+  require_relative 'Endpoint'
+  require_relative 'AdditionalResource'
+
+  class DlexLayout < Endpoint
+    #
+    # Initializes a new instance of the DlexLayout class using the DLEX file path present in the cloud environment
+    # and the JSON data for the PDF report.
+    #
+    # @param cloud_dlex_path [String] The DLEX file path present in the resource manager.
+    # @param layout_data [LayoutDataResource] The LayoutDataResource, json data file used to create the PDF report.
+    #
+    def initialize(dlex, layout)
+      @_endpoint_name = 'dlex-layout'
+      @resources= []
+      super()
+      if(dlex.is_a?(String)) == true && layout.is_a?(Object)
+        @dlex_path = dlex
+        @resource = layout
+      elsif (dlex.is_a?(Object)) == true && layout.is_a?(Object)
+        @resources << dlex
+        @resource = layout
+      end
+    end
+
+    #
+    # Adds additional resource to the endpoint.
+    #
+    # <param name="resourcePath">The resource file path.
+    # <param name="resourceName">The name of the resource.
+    def add_additional_resource(resourcePath, resourceName = nil)
+
+        resourceName = File.basename(resourcePath)  if !resourceName.nil?
+
+        additional_resource = AdditionalResource.new(resourcePath, resourceName)
+
+        if additional_resource.type == ResourceType::LAYOUT_DATA
+          raise 'Layout data resources cannot be added to a DlexLayout object.'
+        elsif additional_resource.type == ResourceType::DLEX
+          raise 'Dlex resources cannot be added to a DlexLayout object.'
+        else
+          @resources << additional_resource
+        end
+
+    end
+
+    def add_additional_resource_with_resourcedata(resourceData, additionalResourceType, resourceName)
+      type = ResourceType::PDF
+      case (additionalResourceType)
+
+      when AdditionalResourceType::FONT
+        type = ResourceType::FONT
+      when AdditionalResourceType::IMAGE
+        type = ResourceType::IMAGE
+      when AdditionalResourceType::PDF
+        type = ResourceType::PDF
+      else
+        raise 'This type of resource not allowed'
+      end
+      additional_resource = AdditionalResource.new(resourceData, resourceName, type)
+      @resources << additional_resource
+    end
+
+    attr_accessor :resources
+
+    attr_accessor :resource
+
+    #
+    # Gets or sets the DLEX file path present in the resource manager.
+    #
+    attr_accessor :dlex_path
+
+    #
+    # Process the DLEX and layout data to create PDF report.
+    #
+    # @return PdfResponse Returns collection of PdfResponse tasks.
+    #
+    def process
+      header = {
+        'Authorization': "Bearer #{@api_key}",
+        'Expect': '100-continue'
+      }
+
+      uri = URI.parse("#{@base_url}/v1.0/#{@_endpoint_name}")
+      resource_array = []
+
+      resource_array << ['LayoutData', @resource.data, { content_type: @resource._mime_type, filename: @resource.layout_data_resource_name }] if !@resource.nil?
+
+      resource_array << ['DlexPath', @dlex_path,
+                         { content_type: 'application/octet-stream', filename: '' }] if !@dlex_path.nil?
+                            @resources.each { |field|
+                            data = if !field._file_path.nil?
+                              File.binread(field._file_path)
+                            else
+                              field.data
+                            end
+
+                          resource_array << ["Resource", data,
+                                             { content_type: "application/octet-stream", filename: field.resource_name }]
+                          }
+
+      request = Net::HTTP::Post.new(uri.request_uri, header)
+
+      req_options = {
+        use_ssl: uri.scheme == 'https',
+        verify_mode: OpenSSL::SSL::VERIFY_NONE
+      }
+
+      request.set_form(resource_array, 'multipart/form-data')
+      response = Net::HTTP.start(uri.hostname, uri.port, req_options) do |http|
+        http.request(request)
+      end
+      ret_object = PdfResponse.new
+      ret_object.is_successful = false
+      ret_object.status_code = response.code
+      out_data = response.body
+
+      if !ret_object.nil? && ret_object.status_code == '200' && out_data[0, 4].eql?('%PDF') == true
+        ret_object = PdfResponse.new(out_data)
+        ret_object.is_successful = true
+      else
+        out_data_json = JSON.parse(out_data)
+        ret_object.error_json = out_data
+        ret_object.error_message = if !out_data_json['message'].nil?
+                                     out_data_json['message']
+                                   else
+                                     "status_code : #{Net::HTTPResponse::CODE_TO_OBJ[ret_object.status_code]}"
+                                   end
+        ret_object.error_id = out_data_json['id']
+      end
+
+      ret_object
+    end
+  end
+end

data/lib/ruby_client/DlexResource.rb

@@ -0,0 +1,40 @@
+module DynamicPDFApi
+  require_relative 'Resource'
+  require_relative 'ResourceType'
+
+  #
+  # Represents a Dlex resource object that is created using the DLEX file and a name.
+  #
+  class DlexResource < Resource
+    #
+    # Initializes a new instance of the DlexResource class with DLEX file path and resource name as parameters.
+    #
+    # @param dlex [String]|[Array]|[Stream] The dlex file path or the byte array of the dlex file or the stream of the dlex file.
+    # @param resource_name [String] The name of the resource.
+    #
+    def initialize(dlex, resource_name = nil)
+      @layout_data_resource_name = nil
+      @_type = ResourceType::DLEX
+      @_mime_type = 'application/xml'
+      super(dlex, resource_name)
+    end
+
+    def _file_extension
+      '.dlex'
+    end
+
+    #
+    # Gets or sets name for layout data resource.
+    #
+    attr_accessor :layout_data_resource_name
+
+    def to_json(_options = {})
+      json_array = {}
+      json_array['type'] = 'dlex'
+
+      json_array['layoutDataResourceName'] = @layout_data_resource_name
+      json_array['resourceName'] = @resource_name
+      JSON.pretty_generate(json_array)
+    end
+  end
+end

data/lib/ruby_client/Elements/AztecBarcodeElement.rb

@@ -0,0 +1,113 @@
+# Ruby client api namespace
+module DynamicPDFApi
+  require_relative "Element"
+  require_relative "ElementType"
+  require_relative "AztecSymbolSize"
+  require_relative "BarcodeElement"
+  require_relative "Dim2BarcodeElement"
+
+  #
+  # Represents an Aztec 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 AztecBarcodeElement < Dim2BarcodeElement
+    #
+    # Initializes a new instance of the AztecBarcodeElement class.
+    #
+    # @param value [String]|[array] The value of the barcode 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 barcode.
+    # @param y_offset [float] The Y coordinate of the barcode.
+    #
+    def initialize(value, placement = ElementPlacement::TOP_LEFT, x_offset = 0, y_offset = 0)
+      @_type = ElementType::AZTEC_BARCODE
+      @process_tilde = false
+      @symbol_size = nil
+      @aztec_error_correction = 0
+      @reader_initialization_symbol = false
+      super(value, placement, x_offset, y_offset)
+    end
+
+    attr_accessor :type
+
+    #
+    # Gets or Sets a boolean indicating whether to process tilde symbol in the input.
+    #
+    # 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
+
+    #
+    # Gets or Sets the barcode size, AztecSymbolSize.
+    #
+    attr_accessor :symbol_size
+
+    #
+    # Gets or Sets the error correction value.
+    #
+    # Error correction value may be between 5% to 95%.
+    #
+    attr_accessor :aztec_error_correction
+
+    #
+    # Gets or Sets a boolean representing if the barcode is a reader initialization symbol.
+    #
+    # Setting true will mark the symbol as reader initialization symbol and the size of the symbol should be
+    # one of the following, R15xC15 Compact, R19xC19, R23xC23, R27xC27, R31xC31, R37xC37, R41xC41, R45xC45,
+    # R49xC49, R53xC53, R57xC57, R61xC61, R67xC67, R71xC71, R75xC75, R79xC79, R83xC83, R87xC87, R91xC91, R95xC95,
+    # R101xC101, R105xC105, R109xC109, however it is recommended to set Auto.
+    #
+    attr_accessor :reader_initialization_symbol
+
+    def to_json(_options = {})
+      json_array = {}
+
+      json_array["type"] = "aztecBarcode"
+
+      # if(@processTilde != nil)
+      json_array["processTilde"] = @process_tilde
+
+      json_array["symbolSize"] = @symbol_size unless @symbol_size.nil?
+
+      json_array["aztecErrorCorrection"] = @aztec_error_correction unless @aztec_error_correction.nil?
+
+      # if(@reader_initialization_symbol != nil)
+      json_array["readerInitializationSymbol"] = @reader_initialization_symbol
+
+      #--------------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/AztecSymbolSize.rb

@@ -0,0 +1,206 @@
+module DynamicPDFApi
+  #
+  # Represents Aztec symbol sizes.
+  #
+  class AztecSymbolSize
+    #
+    # Size auto.
+    #
+    AUTO = "auto".freeze
+
+    #
+    # Full size Aztec.
+    #
+    FULL = "full".freeze
+
+    #
+    # Compact size Aztec.
+    #
+    COMPACT = "compact".freeze
+
+    #
+    # Aztec Runes.
+    #
+    RUNE = "rune".freeze
+
+    #
+    # 15 rows by 15 columns, Compact size.
+    #
+    R15_X_C15_COMPACT = "r15xC15Compact".freeze
+
+    #
+    # 19 rows by 19 columns, Compact size.
+    #
+    R19_X_C19_COMPACT = "r19xC19Compact".freeze
+
+    #
+    # 19 rows by 19 columns.
+    #
+    R19_X_C19 = "r19xC19".freeze
+
+    #
+    # 23 rows by 23 columns, Compact size.
+    #
+    R23_X_C23_COMPACT = "r23xC23Compact".freeze
+
+    #
+    # 23 rows by 23 columns.
+    #
+    R23_X_C23 = "r23xC23".freeze
+
+    #
+    # 27 rows by 27 columns, Compact size.
+    #
+    R27_X_C27_COMPACT = "r27xC27Compact".freeze
+
+    #
+    # 27 rows by 27 columns.
+    #
+    R27_X_C27 = "r27xC27".freeze
+
+    #
+    # 31 rows by 31 Column.
+    #
+    R31_X_C31 = "r31xC31".freeze
+
+    #
+    # 37 rows by 37 columns.
+    #
+    R37_X_C37 = "r37xC37".freeze
+
+    #
+    # 41 rows by 41 columns.
+    #
+    R41_X_C41 = "r41xC41".freeze
+
+    #
+    # 45 rows by 45 columns.
+    #
+    R45_X_C45 = "r45xC45".freeze
+
+    #
+    # 49 rows by 49 columns.
+    #
+    R49_X_C49 = "r49xC49".freeze
+
+    #
+    # 53 rows by 53 columns.
+    #
+    R53_X_C53 = "r53xC53".freeze
+
+    #
+    # 57 rows by 57 columns.
+    #
+    R57_X_C57 = "r57xC57".freeze
+
+    #
+    # 61 rows by 61 columns.
+    #
+    R61_X_C61 = "r61xC61".freeze
+
+    #
+    # 67 rows by 67 columns.
+    #
+    R67_X_C67 = "r67xC67".freeze
+
+    #
+    # 71 rows by 71 columns.
+    #
+    R71_X_C71 = "r71xC71".freeze
+
+    #
+    # 75 rows by 75 columns.
+    #
+    R75_X_C75 = "r75xC75".freeze
+
+    #
+    # 79 rows by 79 columns.
+    #
+    R79_X_C79 = "r79xC79".freeze
+
+    #
+    # 83 rows by 83 columns.
+    #
+    R83_X_C83 = "r83xC83".freeze
+
+    #
+    # 87 rows by 87 columns.
+    #
+    R87_X_C87 = "r87xC87".freeze
+
+    #
+    # 91 rows by 91 columns.
+    #
+    R91_X_C91 = "r91xC91".freeze
+
+    #
+    # 95 rows by 95 columns.
+    #
+    R95_X_C95 = "r95xC95".freeze
+
+    #
+    # 101 rows by 101 columns.
+    #
+    R101_X_C101 = "r101xC101".freeze
+
+    #
+    # 105 rows by 105 columns.
+    #
+    R105_X_C105 = "r105xC105".freeze
+
+    #
+    # 109 rows by 109 columns.
+    #
+    R109_X_C109 = "r109xC109".freeze
+
+    #
+    # 113 rows by 113 columns.
+    #
+    R113_X_C113 = "r113xC113".freeze
+
+    #
+    # 117 rows by 117 columns.
+    #
+    R117_X_C117 = "r117xC117".freeze
+
+    #
+    # 121 rows by 121 columns.
+    #
+    R121_X_C121 = "r121xC121".freeze
+
+    #
+    # 125 rows by 125 columns.
+    #
+    R125_X_C125 = "r125xC125".freeze
+
+    #
+    # 131 rows by 131 columns.
+    #
+    R131_X_C131 = "r131xC131".freeze
+
+    #
+    # 135 rows by 135 columns.
+    #
+    R135_X_C135 = "r135xC135".freeze
+
+    #
+    # 139 rows by 139 columns.
+    #
+    R139_X_C139 = "r139xC139".freeze
+
+    #
+    # 143 rows by 143 columns.
+    #
+    R143_X_C143 = "r143xC143".freeze
+
+    #
+    # 147 rows by 147 columns.
+    #
+    R147_X_C147 = "r147xC147".freeze
+
+    #
+    # 151 rows by 151 columns.
+    #
+    R151_X_C151 = "r151xC151".freeze
+  end
+end

data/lib/ruby_client/Elements/BarcodeElement.rb

@@ -0,0 +1,37 @@
+module DynamicPDFApi
+  require_relative "Element"
+  require_relative "ElementPlacement"
+
+  #
+  # Base class from which barcode page elements are derived.
+  #
+  class BarcodeElement < Element
+    def initialize(value, placement, x_offset, y_offset)
+      @color = nil
+      @x_dimension = nil
+
+      super(value, placement, x_offset, y_offset)
+      @value = value
+    end
+
+    attr_accessor :_color_name
+
+    #
+    # Gets or sets the Color of the barcode.
+    #
+    def color=(color_value)
+      @color = color_value
+      @_color_name = @color._color_string
+    end
+
+    #
+    # Gets or sets the XDimension of the barcode.
+    #
+    attr_accessor :x_dimension
+
+    #
+    # Gets or sets the value of the barcode.
+    #
+    attr_accessor :value
+  end
+end

data/lib/ruby_client/Elements/Code11BarcodeElement.rb

@@ -0,0 +1,77 @@
+module DynamicPDFApi
+  require_relative "TextBarcodeElement"
+  require_relative "ElementPlacement"
+  require_relative "ElementType"
+
+  #
+  #
+  # Represents a Code 11 barcode element.
+  #
+  # This class can be used to place a Code 11 barcode on a page.
+  #
+  #
+  class Code11BarcodeElement < TextBarcodeElement
+    #
+    # Initializes a new instance of the Code11BarcodeElement 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::CODE11_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"] = "code11Barcode"
+
+      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(@evenPages != nil)
+      json_array["evenPages"] = @even_pages
+
+      # if(@oddPages != nil)
+      json_array["oddPages"] = @odd_pages
+
+      JSON.pretty_generate(json_array)
+    end
+  end
+end