pki_express 1.0.0

data/lib/pki_express/pades_horizontal_align.rb

@@ -0,0 +1,9 @@
+module PkiExpress
+  class PadesHorizontalAlign < Enum
+    LEFT = 'Left'
+    CENTER = 'Center'
+    RIGHT = 'Right'
+
+    VALUES = [ LEFT, CENTER, RIGHT ]
+  end
+end

data/lib/pki_express/pades_measurement_units.rb

@@ -0,0 +1,8 @@
+module PkiExpress
+  class PadesMeasurementUnits < Enum
+    CENTIMETERS = 'Centimeters'
+    PDF_POINTS = 'PdfPoints'
+
+    VALUES = [ CENTIMETERS, PDF_POINTS ]
+  end
+end

data/lib/pki_express/pades_page_optimization.rb

@@ -0,0 +1,51 @@
+module PkiExpress
+  class PadesPageOptimization
+    attr_reader :custom_paper_size, :paper_size, :page_orientation
+
+    def initialize(paper_size=nil, custom_paper_size=nil)
+      @page_orientation = PadesPageOrientation::AUTO
+      if custom_paper_size
+        @paper_size = PadesPaperSize::CUSTOM
+        @custom_paper_size = custom_paper_size
+      else
+        @paper_size = paper_size
+      end
+    end
+
+    def custom_paper_size=(value)
+      @custom_paper_size = value
+      @paper_size = PadesPaperSize::CUSTOM
+    end
+
+    def paper_size=(value)
+      unless PadesPaperSize.contains?(value)
+        raise 'The provided "paper_size" is not valid. Try using PadesPaperSize constants'
+      end
+      @paper_size = value
+    end
+
+    def page_orientation=(value)
+      unless PadesPageOrientation.contains?(value)
+        raise 'The provided "page_orientation" is not valid. Try using PadesPageOrientation constants'
+      end
+      @page_orientation = value
+    end
+
+    def to_model
+      custom_paper_size = nil
+      if @paper_size == PadesPaperSize::CUSTOM
+        if @custom_paper_size
+          custom_paper_size = @custom_paper_size&.to_model
+        else
+          raise 'paper_size is set to :custom but no custom_paper_size was set'
+        end
+      end
+
+      {
+          'pageSize': @paper_size,
+          'customPageSize': custom_paper_size,
+          'pageOrientation': @page_orientation,
+      }
+    end
+  end
+end

data/lib/pki_express/pades_page_orientation.rb

@@ -0,0 +1,9 @@
+module PkiExpress
+  class PadesPageOrientation < Enum
+    AUTO = 'Auto'
+    PORTRAIT = 'Portrait'
+    LANDSCAPE = 'Landscape'
+
+    VALUES = [ AUTO, PORTRAIT, LANDSCAPE ]
+  end
+end

data/lib/pki_express/pades_paper_size.rb

@@ -0,0 +1,21 @@
+module PkiExpress
+  class PadesPaperSize < Enum
+    CUSTOM = 'Custom'
+    A0     = 'A0'
+    A1     = 'A1'
+    A2     = 'A2'
+    A3     = 'A3'
+    A4     = 'A4'
+    A5     = 'A5'
+    A6     = 'A6'
+    A7     = 'A7'
+    A8     = 'A8'
+    LETTER = 'Letter'
+    LEGAL  = 'Legal'
+    LEDGER = 'Ledger'
+
+    VALUES = [
+        CUSTOM, A0, A1, A2, A3, A4, A5, A6, A7, A8, LETTER, LEGAL, LEDGER
+    ]
+  end
+end

data/lib/pki_express/pades_signature_starter.rb

@@ -0,0 +1,232 @@
+module PkiExpress
+  class PadesSignatureStarter < SignatureStarter
+    attr_accessor :suppress_default_visual_representation
+
+    def initialize(config=PkiExpressConfig.new)
+      super(config)
+      @pdf_to_sign_path = nil
+      @vr_json_path = nil
+      @suppress_default_visual_representation = false
+    end
+
+    # region The "pdf_to_sign" accessors
+
+    def pdf_to_sign
+      _get_pdf_to_sign
+    end
+
+    def _get_pdf_to_sign
+      unless @pdf_to_sign_path
+        return nil
+      end
+
+      File.read(@pdf_to_sign_path)
+    end
+    private :_get_pdf_to_sign
+
+    def pdf_to_sign=(content_raw)
+      _set_pdf_to_sign(content_raw)
+    end
+
+    def _set_pdf_to_sign(content_raw)
+      unless content_raw
+        raise 'The provided "pdf_to_sign" is not valid'
+      end
+
+      temp_file_path = self.create_temp_file
+      File.open(temp_file_path, 'wb') do |f|
+        f.write(content_raw)
+      end
+      @pdf_to_sign_path = temp_file_path
+    end
+    private :_set_pdf_to_sign
+
+    def pdf_to_sign_base64
+      _get_pdf_to_sign_base64
+    end
+
+    def _get_pdf_to_sign_base64
+      unless @pdf_to_sign_path
+        return nil
+      end
+
+      content = File.read(@pdf_to_sign_path)
+      Base64.encode64(content)
+    end
+    private :_get_pdf_to_sign_base64
+
+    def pdf_to_sign_base64=(content_base64)
+      _set_pdf_to_sign_base64(content_base64)
+    end
+
+    def _set_pdf_to_sign_base64(content_base64)
+      unless content_base64
+        raise 'The provided "pdf_to_sign_base64" is not valid'
+      end
+
+      begin
+        content_raw = Base64.decode64(content_base64)
+      rescue Error
+        raise 'The provided "pdf_to_sign_base64" is not Base64-encoded'
+      end
+
+      _set_pdf_to_sign(content_raw)
+    end
+    private :_set_pdf_to_sign_base64
+
+    def pdf_to_sign_path
+      _get_pdf_to_sign_path
+    end
+
+    def _get_pdf_to_sign_path
+      @pdf_to_sign_path
+    end
+    private :_get_pdf_to_sign_path
+
+    def pdf_to_sign_path=(path)
+      _set_pdf_to_sign_path(path)
+    end
+
+    def _set_pdf_to_sign_path(path)
+      unless path
+        raise 'The provided "pdf_to_sign_path" is not valid'
+      end
+      unless File.exists?(path)
+        raise 'The provided "pdf_to_sign_path" does not exist'
+      end
+      @pdf_to_sign_path = path
+    end
+    private :_set_pdf_to_sign_path
+
+    # endregion
+
+    # region set_visual_representation
+
+    def visual_representation_content_raw
+      _get_visual_representation_content_raw
+    end
+
+    def _get_visual_representation_content_raw
+      unless @vr_json_path
+        return nil
+      end
+
+      File.read(@vr_json_path)
+    end
+    private :_get_visual_representation_content_raw
+
+    def visual_representation_content_raw=(content_raw)
+      _set_visual_representation_content_raw(content_raw)
+    end
+
+    def _set_visual_representation_content_raw(content_raw)
+      unless content_raw
+        raise 'The provided "visual_representation" is not valid'
+      end
+
+      temp_file_path = self.create_temp_file
+      File.open(temp_file_path, 'wb') do |f|
+        f.write(content_raw)
+      end
+      @vr_json_path = temp_file_path
+    end
+    private :_set_visual_representation_content_raw
+
+    def visual_representation_path
+      _get_visual_representation_path
+    end
+
+    def _get_visual_representation_path
+      @vr_json_path
+    end
+    private :_get_visual_representation_path
+
+    def visual_representation_path=(path)
+      _set_visual_representation_path(path)
+    end
+
+    def _set_visual_representation_path(path)
+      unless path
+        raise 'The provided "visual_representation_path" is not valid'
+      end
+      unless File.exists?(path)
+        raise 'The provided "visual_representation_path" does not exist'
+      end
+      @vr_json_path = path
+    end
+    private :_set_visual_representation_path
+
+    def visual_representation
+      _get_visual_representation
+    end
+
+    def _get_visual_representation
+      unless @vr_json_path
+        return nil
+      end
+
+      content =  File.read(@vr_json_path)
+      JSON.parse(content)
+    end
+    private :_get_visual_representation
+
+
+    def visual_representation=(vr)
+      _set_visual_representation(vr)
+    end
+
+    def _set_visual_representation(vr)
+      temp_file_path = self.create_temp_file
+      json = JSON.pretty_generate(vr.to_model)
+      File.open(temp_file_path, 'w') do |f|
+        f.write(json)
+      end
+      @vr_json_path = temp_file_path
+    end
+    private :_set_visual_representation
+
+    # endregion
+
+    def start
+      unless @pdf_to_sign_path
+        raise 'The PDF to be signed was not set'
+      end
+
+      unless @certificate_path
+        raise 'The certificate was not set'
+      end
+
+      # Generate transfer file.
+      transfer_file_id = get_transfer_filename
+
+      args = [
+          @pdf_to_sign_path,
+          @certificate_path,
+          File.expand_path(transfer_file_id, @config.transfer_data_folder),
+      ]
+
+      # Verify and add common options between signers.
+      verify_and_add_common_options(args)
+
+      if @vr_json_path
+        args.append('--visual-rep')
+        args.append(@vr_json_path)
+      end
+
+      if @suppress_default_visual_representation
+        args.append('--suppress-default-visual-rep')
+
+        # This option can only be used on versions greater than 1.13.1 of the
+        # PKI Express.
+        @version_manager.require_version('1.13.1')
+      end
+
+      # Invoke command.
+      result = invoke(Commands::START_PADES, args)
+
+      # Parse output and return model.
+      model = parse_output(result)
+      SignatureStartResult.new(model, transfer_file_id)
+    end
+  end
+end

data/lib/pki_express/pades_size.rb

@@ -0,0 +1,17 @@
+module PkiExpress
+  class PadesSize
+    attr_accessor :width, :height
+
+    def initialize(width, height)
+      @width = width
+      @height = height
+    end
+
+    def to_model
+      {
+          width: @width,
+          height: @height,
+      }
+    end
+  end
+end

data/lib/pki_express/pades_text_horizontal_align.rb

@@ -0,0 +1,8 @@
+module PkiExpress
+  class PadesTextHorizontalAlign < Enum
+    LEFT = 'Left'
+    RIGHT = 'Right'
+
+    VALUES = [ LEFT, RIGHT ]
+  end
+end

data/lib/pki_express/pades_vertical_align.rb

@@ -0,0 +1,9 @@
+module PkiExpress
+  class PadesVerticalAlign < Enum
+    TOP = 'Top'
+    CENTER = 'Center'
+    BOTTOM = 'Bottom'
+
+    VALUES = [ TOP, CENTER, BOTTOM ]
+  end
+end

data/lib/pki_express/pades_visual_auto_positioning.rb

@@ -0,0 +1,22 @@
+module PkiExpress
+  class PadesVisualAutoPositioning < PadesVisualPositioning
+    attr_accessor :container, :signature_rectangle_size, :row_spacing
+
+    def initialize(page_number=nil, measurement_units=nil, container=nil, signature_rectangle_size=nil, row_spacing=nil)
+      super(page_number, measurement_units)
+      @container = container
+      @signature_rectangle_size = signature_rectangle_size
+      @row_spacing = row_spacing
+    end
+
+    def to_model
+      model = super
+      model['auto'] = {
+          'container': @container&.to_model,
+          'signatureRectangleSize': @signature_rectangle_size&.to_model,
+          'rowSpacing': @row_spacing,
+      }
+      model
+    end
+  end
+end

data/lib/pki_express/pades_visual_image.rb

@@ -0,0 +1,52 @@
+module PkiExpress
+  class PadesVisualImage
+    attr_reader :horizontal_align, :vertical_align
+    attr_accessor :opacity, :content, :url,
+                  :mime_type
+
+    def initialize(image_content=nil, image_url = nil, image_mime_type=nil)
+      @opacity = 100
+      @horizontal_align = PadesHorizontalAlign::CENTER
+      @vertical_align = PadesVerticalAlign::CENTER
+      @content = image_content
+      @url = image_url
+      @mime_type = image_mime_type
+    end
+
+    def horizontal_align=(value)
+      unless PadesHorizontalAlign.contains?(value)
+        raise 'The provided "horizontal_align" is not valid. Try using PadesHorizontalAlign constants'
+      end
+
+      @horizontal_align = value
+    end
+
+    def vertical_align=(value)
+      unless PadesVerticalAlign.contains?(value)
+        raise 'The provided "vertical_align" is not valid. Try using PadesVerticalAlign constants'
+      end
+
+      @vertical_align = value
+    end
+
+    def to_model
+      resource_model = {
+          'mimeType': @mime_type,
+      }
+      if @content
+        resource_model['content'] = Base64.encode64(@content)
+      elsif @url
+        resource_model['url'] = @url
+      else
+        raise 'The image content was not set, neither its URL'
+      end
+
+      {
+          resource: resource_model,
+          opacity: @opacity,
+          horizontal_align: @horizontal_align,
+          vertical_align: @vertical_align,
+      }
+    end
+  end
+end