writer.rb in iostreams-1.0.0.beta

- old
+ new

@@ -1,27 +1,32 @@
 require 'open3'
 
 module IOStreams
   module Pgp
-    class Writer
-      # Sign all encrypted files with this users key.
-      # Default: Do not sign encyrpted files.
-      def self.default_signer=(default_signer)
-        @default_signer = default_signer
-      end
+    class Writer < IOStreams::Writer
+      class << self
+        # Sign all encrypted files with this users key.
+        # Default: Do not sign encrypted files.
+        attr_writer :default_signer
 
-      # Passphrase to use to open the private key when signing the file.
-      # Default: None.
-      def self.default_signer_passphrase=(default_signer_passphrase)
-        @default_signer_passphrase = default_signer_passphrase
+        # Passphrase to use to open the private key when signing the file.
+        # Default: None.
+        attr_writer :default_signer_passphrase
+
+        private
+
+        attr_reader :default_signer_passphrase
+        attr_reader :default_signer
+
+        @default_signer_passphrase = nil
+        @default_signer            = nil
       end
 
-      # Write to a PGP / GPG file or stream, encrypting the contents as it is written
+      # Write to a PGP / GPG file, encrypting the contents as it is written.
       #
-      # file_name_or_io: [String|IO]
+      # file_name: [String]
       #   Name of file to write to.
-      #   Or, the IO stream to write the encrypted contents to.
       #
       # recipient: [String]
       #   Email of user for which to encypt the file.
       #
       # signer: [String]
@@ -30,39 +35,25 @@
       #
       # signer_passphrase: [String]
       #   Passphrase to use to open the private key when signing the file.
       #   Default: default_signer_passphrase
       #
-      # binary: [true|false]
-      #   Whether to write binary data.
-      #   Default: true
-      #
       # compression: [:none|:zip|:zlib|:bzip2]
       #   Note: Standard PGP only supports :zip.
       #   :zlib is better than zip.
       #   :bzip2 is best, but uses a lot of memory and is much slower.
       #   Default: :zip
       #
       # compress_level: [Integer]
       #   Compression level
       #   Default: 6
-      def self.open(file_name_or_io, recipient:, signer: default_signer, signer_passphrase: default_signer_passphrase, binary: true, compression: :zip, compress_level: 6, &block)
+      def self.file(file_name, recipient: nil, import_and_trust_key: nil, signer: default_signer, signer_passphrase: default_signer_passphrase, compression: :zip, compress_level: 6, original_file_name: nil)
+        raise(ArgumentError, "Requires either :recipient or :import_and_trust_key") unless recipient || import_and_trust_key
+
+        recipient      = IOStreams::Pgp.import_and_trust(key: import_and_trust_key) if import_and_trust_key
         compress_level = 0 if compression == :none
 
-        if file_name_or_io.is_a?(String)
-          IOStreams::File::Path.mkpath(file_name_or_io)
-          return write_file(file_name_or_io, recipient: recipient, signer: signer, signer_passphrase: signer_passphrase, binary: binary, compression: compression, compress_level: compress_level, &block)
-        end
-
-        # PGP can only work against a file, not a stream, so create temp file.
-        IOStreams::File::Path.temp_file_name('iostreams_pgp') do |temp_file_name|
-          write_file(temp_file_name, recipient: recipient, signer: signer, signer_passphrase: signer_passphrase, binary: binary, compression: compression, compress_level: compress_level, &block)
-          IOStreams.copy(temp_file_name, file_name_or_io, source_options: {streams: []})
-        end
-      end
-
-      def self.write_file(file_name, recipient:, signer: default_signer, signer_passphrase: default_signer_passphrase, binary: true, compression: :zip, compress_level: 6)
         # Write to stdin, with encrypted contents being written to the file
         command = "#{IOStreams::Pgp.executable} --batch --no-tty --yes --encrypt"
         command << " --sign --local-user \"#{signer}\"" if signer
         if signer_passphrase
           command << " --pinentry-mode loopback" if IOStreams::Pgp.pgp_version.to_f >= 2.1
@@ -70,15 +61,15 @@
         end
         command << " -z #{compress_level}" if compress_level != 6
         command << " --compress-algo #{compression}" unless compression == :none
         command << " --recipient \"#{recipient}\" -o \"#{file_name}\""
 
-        IOStreams::Pgp.logger.debug { "IOStreams::Pgp::Writer.open: #{command}" } if IOStreams::Pgp.logger
+        IOStreams::Pgp.logger&.debug { "IOStreams::Pgp::Writer.open: #{command}" }
 
         Open3.popen2e(command) do |stdin, out, waith_thr|
           begin
-            stdin.binmode if binary
+            stdin.binmode
             yield(stdin)
             stdin.close
           rescue Errno::EPIPE
             # Ignore broken pipe because gpg terminates early due to an error
             ::File.delete(file_name) if ::File.exist?(file_name)
@@ -87,22 +78,9 @@
           unless waith_thr.value.success?
             ::File.delete(file_name) if ::File.exist?(file_name)
             raise(Pgp::Failure, "GPG Failed to create encrypted file: #{file_name}: #{out.read.chomp}")
           end
         end
-      end
-
-      private
-
-      @default_signer_passphrase = nil
-      @default_signer            = nil
-
-      def self.default_signer_passphrase
-        @default_signer_passphrase
-      end
-
-      def self.default_signer
-        @default_signer
       end
 
     end
   end
 end