pki_express 1.3.0 → 1.3.2

data/lib/pki_express/pades_signature_starter.rb

@@ -1,251 +1,251 @@
-module PkiExpress
-  class PadesSignatureStarter < SignatureStarter
-    attr_accessor :suppress_default_visual_representation
-    attr_accessor :custom_signature_field_name, :certification_level
-
-    def initialize(config=PkiExpressConfig.new)
-      super(config)
-      @pdf_to_sign_path = nil
-      @vr_json_path = nil
-      @suppress_default_visual_representation = false
-      @custom_signature_field_name = nil
-      @certification_level = nil
-    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 @custom_signature_field_name
-        args.append('--custom-signature-field-name')
-        args.append(@custom_signature_field_name)
-        # This option can only be used on versions greater than 1.15.0 of the
-        # PKI Express.
-        @version_manager.require_version('1.15')
-      end
-
-      if @certification_level
-        args.append('--certification-level')
-        args.append(@certification_level)
-        # This option can only be used on versions greater than 1.16.0 of the
-        # PKI Express.
-        @version_manager.require_version('1.16')
-      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
+module PkiExpress
+  class PadesSignatureStarter < SignatureStarter
+    attr_accessor :suppress_default_visual_representation
+    attr_accessor :custom_signature_field_name, :certification_level
+
+    def initialize(config=PkiExpressConfig.new)
+      super(config)
+      @pdf_to_sign_path = nil
+      @vr_json_path = nil
+      @suppress_default_visual_representation = false
+      @custom_signature_field_name = nil
+      @certification_level = nil
+    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 @custom_signature_field_name
+        args.append('--custom-signature-field-name')
+        args.append(@custom_signature_field_name)
+        # This option can only be used on versions greater than 1.15.0 of the
+        # PKI Express.
+        @version_manager.require_version('1.15')
+      end
+
+      if @certification_level
+        args.append('--certification-level')
+        args.append(@certification_level)
+        # This option can only be used on versions greater than 1.16.0 of the
+        # PKI Express.
+        @version_manager.require_version('1.16')
+      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